* frame.el (auto-raise-mode, auto-lower-mode): Doc fix.
[emacs.git] / src / xterm.c
blob063794bae65e8688230ddc56a74acde9e83d92d7
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 #ifdef HAVE_GTK3
97 #include <X11/Xproto.h>
98 #endif
99 #endif
101 #ifdef USE_LUCID
102 #include "../lwlib/xlwmenu.h"
103 #endif
105 #ifdef USE_X_TOOLKIT
106 #if !defined (NO_EDITRES)
107 #define HACK_EDITRES
108 extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
109 #endif /* not NO_EDITRES */
111 /* Include toolkit specific headers for the scroll bar widget. */
113 #ifdef USE_TOOLKIT_SCROLL_BARS
114 #if defined USE_MOTIF
115 #include <Xm/Xm.h> /* for LESSTIF_VERSION */
116 #include <Xm/ScrollBar.h>
117 #else /* !USE_MOTIF i.e. use Xaw */
119 #ifdef HAVE_XAW3D
120 #include <X11/Xaw3d/Simple.h>
121 #include <X11/Xaw3d/Scrollbar.h>
122 #include <X11/Xaw3d/ThreeD.h>
123 #else /* !HAVE_XAW3D */
124 #include <X11/Xaw/Simple.h>
125 #include <X11/Xaw/Scrollbar.h>
126 #endif /* !HAVE_XAW3D */
127 #ifndef XtNpickTop
128 #define XtNpickTop "pickTop"
129 #endif /* !XtNpickTop */
130 #endif /* !USE_MOTIF */
131 #endif /* USE_TOOLKIT_SCROLL_BARS */
133 #endif /* USE_X_TOOLKIT */
135 #ifdef USE_X_TOOLKIT
136 #include "widget.h"
137 #ifndef XtNinitialState
138 #define XtNinitialState "initialState"
139 #endif
140 #endif
142 /* Default to using XIM if available. */
143 #ifdef USE_XIM
144 int use_xim = 1;
145 #else
146 int use_xim = 0; /* configure --without-xim */
147 #endif
151 /* Non-zero means that a HELP_EVENT has been generated since Emacs
152 start. */
154 static int any_help_event_p;
156 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
157 static Lisp_Object last_window;
159 /* This is a chain of structures for all the X displays currently in
160 use. */
162 struct x_display_info *x_display_list;
164 /* This is a list of cons cells, each of the form (NAME
165 . FONT-LIST-CACHE), one for each element of x_display_list and in
166 the same order. NAME is the name of the frame. FONT-LIST-CACHE
167 records previous values returned by x-list-fonts. */
169 Lisp_Object x_display_name_list;
171 /* Frame being updated by update_frame. This is declared in term.c.
172 This is set by update_begin and looked at by all the XT functions.
173 It is zero while not inside an update. In that case, the XT
174 functions assume that `selected_frame' is the frame to apply to. */
176 extern struct frame *updating_frame;
178 /* This is a frame waiting to be auto-raised, within XTread_socket. */
180 static struct frame *pending_autoraise_frame;
182 /* This is a frame waiting for an event matching mask, within XTread_socket. */
184 static struct {
185 struct frame *f;
186 int eventtype;
187 } pending_event_wait;
189 #ifdef USE_X_TOOLKIT
190 /* The application context for Xt use. */
191 XtAppContext Xt_app_con;
192 static String Xt_default_resources[] = {0};
194 /* Non-zero means user is interacting with a toolkit scroll bar. */
196 static int toolkit_scroll_bar_interaction;
197 #endif /* USE_X_TOOLKIT */
199 /* Non-zero timeout value means ignore next mouse click if it arrives
200 before that timeout elapses (i.e. as part of the same sequence of
201 events resulting from clicking on a frame to select it). */
203 static unsigned long ignore_next_mouse_click_timeout;
205 /* Mouse movement.
207 Formerly, we used PointerMotionHintMask (in standard_event_mask)
208 so that we would have to call XQueryPointer after each MotionNotify
209 event to ask for another such event. However, this made mouse tracking
210 slow, and there was a bug that made it eventually stop.
212 Simply asking for MotionNotify all the time seems to work better.
214 In order to avoid asking for motion events and then throwing most
215 of them away or busy-polling the server for mouse positions, we ask
216 the server for pointer motion hints. This means that we get only
217 one event per group of mouse movements. "Groups" are delimited by
218 other kinds of events (focus changes and button clicks, for
219 example), or by XQueryPointer calls; when one of these happens, we
220 get another MotionNotify event the next time the mouse moves. This
221 is at least as efficient as getting motion events when mouse
222 tracking is on, and I suspect only negligibly worse when tracking
223 is off. */
225 /* Where the mouse was last time we reported a mouse event. */
227 static XRectangle last_mouse_glyph;
228 static FRAME_PTR last_mouse_glyph_frame;
229 static Lisp_Object last_mouse_press_frame;
231 /* The scroll bar in which the last X motion event occurred.
233 If the last X motion event occurred in a scroll bar, we set this so
234 XTmouse_position can know whether to report a scroll bar motion or
235 an ordinary motion.
237 If the last X motion event didn't occur in a scroll bar, we set
238 this to Qnil, to tell XTmouse_position to return an ordinary motion
239 event. */
241 static Lisp_Object last_mouse_scroll_bar;
243 /* This is a hack. We would really prefer that XTmouse_position would
244 return the time associated with the position it returns, but there
245 doesn't seem to be any way to wrest the time-stamp from the server
246 along with the position query. So, we just keep track of the time
247 of the last movement we received, and return that in hopes that
248 it's somewhat accurate. */
250 static Time last_mouse_movement_time;
252 /* Time for last user interaction as returned in X events. */
254 static Time last_user_time;
256 /* Incremented by XTread_socket whenever it really tries to read
257 events. */
259 #ifdef __STDC__
260 static int volatile input_signal_count;
261 #else
262 static int input_signal_count;
263 #endif
265 /* Used locally within XTread_socket. */
267 static int x_noop_count;
269 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
271 static Lisp_Object Qvendor_specific_keysyms;
272 static Lisp_Object Qlatin_1;
274 #ifdef USE_GTK
275 /* The name of the Emacs icon file. */
276 static Lisp_Object xg_default_icon_file;
278 /* Used in gtkutil.c. */
279 Lisp_Object Qx_gtk_map_stock;
280 #endif
282 /* Some functions take this as char *, not const char *. */
283 static char emacs_class[] = EMACS_CLASS;
285 enum xembed_info
287 XEMBED_MAPPED = 1 << 0
290 enum xembed_message
292 XEMBED_EMBEDDED_NOTIFY = 0,
293 XEMBED_WINDOW_ACTIVATE = 1,
294 XEMBED_WINDOW_DEACTIVATE = 2,
295 XEMBED_REQUEST_FOCUS = 3,
296 XEMBED_FOCUS_IN = 4,
297 XEMBED_FOCUS_OUT = 5,
298 XEMBED_FOCUS_NEXT = 6,
299 XEMBED_FOCUS_PREV = 7,
301 XEMBED_MODALITY_ON = 10,
302 XEMBED_MODALITY_OFF = 11,
303 XEMBED_REGISTER_ACCELERATOR = 12,
304 XEMBED_UNREGISTER_ACCELERATOR = 13,
305 XEMBED_ACTIVATE_ACCELERATOR = 14
308 /* Used in x_flush. */
310 static int x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
311 static void x_set_window_size_1 (struct frame *, int, int, int);
312 static void x_raise_frame (struct frame *);
313 static void x_lower_frame (struct frame *);
314 static const XColor *x_color_cells (Display *, int *);
315 static void x_update_window_end (struct window *, int, int);
317 static int x_io_error_quitter (Display *);
318 static struct terminal *x_create_terminal (struct x_display_info *);
319 void x_delete_terminal (struct terminal *);
320 static void x_update_end (struct frame *);
321 static void XTframe_up_to_date (struct frame *);
322 static void XTset_terminal_modes (struct terminal *);
323 static void XTreset_terminal_modes (struct terminal *);
324 static void x_clear_frame (struct frame *);
325 static void x_ins_del_lines (struct frame *, int, int) NO_RETURN;
326 static void frame_highlight (struct frame *);
327 static void frame_unhighlight (struct frame *);
328 static void x_new_focus_frame (struct x_display_info *, struct frame *);
329 static void x_focus_changed (int, int, struct x_display_info *,
330 struct frame *, struct input_event *);
331 static void x_detect_focus_change (struct x_display_info *,
332 XEvent *, struct input_event *);
333 static void XTframe_rehighlight (struct frame *);
334 static void x_frame_rehighlight (struct x_display_info *);
335 static void x_draw_hollow_cursor (struct window *, struct glyph_row *);
336 static void x_draw_bar_cursor (struct window *, struct glyph_row *, int,
337 enum text_cursor_kinds);
339 static void x_clip_to_row (struct window *, struct glyph_row *, int, GC);
340 static void x_flush (struct frame *f);
341 static void x_update_begin (struct frame *);
342 static void x_update_window_begin (struct window *);
343 static void x_after_update_window_line (struct glyph_row *);
344 static struct scroll_bar *x_window_to_scroll_bar (Display *, Window);
345 static void x_scroll_bar_report_motion (struct frame **, Lisp_Object *,
346 enum scroll_bar_part *,
347 Lisp_Object *, Lisp_Object *,
348 Time *);
349 static int x_handle_net_wm_state (struct frame *, XPropertyEvent *);
350 static void x_check_fullscreen (struct frame *);
351 static void x_check_expected_move (struct frame *, int, int);
352 static void x_sync_with_move (struct frame *, int, int, int);
353 static int handle_one_xevent (struct x_display_info *, XEvent *,
354 int *, struct input_event *);
355 #ifdef USE_GTK
356 static int x_dispatch_event (XEvent *, Display *);
357 #endif
358 /* Don't declare this NO_RETURN because we want no
359 interference with debugging failing X calls. */
360 static void x_connection_closed (Display *, const char *);
361 static void x_wm_set_window_state (struct frame *, int);
362 static void x_wm_set_icon_pixmap (struct frame *, ptrdiff_t);
363 static void x_initialize (void);
366 /* Flush display of frame F, or of all frames if F is null. */
368 static void
369 x_flush (struct frame *f)
371 /* Don't call XFlush when it is not safe to redisplay; the X
372 connection may be broken. */
373 if (!NILP (Vinhibit_redisplay))
374 return;
376 BLOCK_INPUT;
377 if (f == NULL)
379 Lisp_Object rest, frame;
380 FOR_EACH_FRAME (rest, frame)
381 if (FRAME_X_P (XFRAME (frame)))
382 x_flush (XFRAME (frame));
384 else if (FRAME_X_P (f))
385 XFlush (FRAME_X_DISPLAY (f));
386 UNBLOCK_INPUT;
390 /* Remove calls to XFlush by defining XFlush to an empty replacement.
391 Calls to XFlush should be unnecessary because the X output buffer
392 is flushed automatically as needed by calls to XPending,
393 XNextEvent, or XWindowEvent according to the XFlush man page.
394 XTread_socket calls XPending. Removing XFlush improves
395 performance. */
397 #define XFlush(DISPLAY) (void) 0
400 /***********************************************************************
401 Debugging
402 ***********************************************************************/
404 #if 0
406 /* This is a function useful for recording debugging information about
407 the sequence of occurrences in this file. */
409 struct record
411 char *locus;
412 int type;
415 struct record event_record[100];
417 int event_record_index;
419 void
420 record_event (char *locus, int type)
422 if (event_record_index == sizeof (event_record) / sizeof (struct record))
423 event_record_index = 0;
425 event_record[event_record_index].locus = locus;
426 event_record[event_record_index].type = type;
427 event_record_index++;
430 #endif /* 0 */
434 /* Return the struct x_display_info corresponding to DPY. */
436 struct x_display_info *
437 x_display_info_for_display (Display *dpy)
439 struct x_display_info *dpyinfo;
441 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
442 if (dpyinfo->display == dpy)
443 return dpyinfo;
445 return 0;
448 static Window
449 x_find_topmost_parent (struct frame *f)
451 struct x_output *x = f->output_data.x;
452 Window win = None, wi = x->parent_desc;
453 Display *dpy = FRAME_X_DISPLAY (f);
455 while (wi != FRAME_X_DISPLAY_INFO (f)->root_window)
457 Window root;
458 Window *children;
459 unsigned int nchildren;
461 win = wi;
462 XQueryTree (dpy, win, &root, &wi, &children, &nchildren);
463 XFree (children);
466 return win;
469 #define OPAQUE 0xffffffff
471 void
472 x_set_frame_alpha (struct frame *f)
474 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
475 Display *dpy = FRAME_X_DISPLAY (f);
476 Window win = FRAME_OUTER_WINDOW (f);
477 double alpha = 1.0;
478 double alpha_min = 1.0;
479 unsigned long opac;
480 Window parent;
482 if (dpyinfo->x_highlight_frame == f)
483 alpha = f->alpha[0];
484 else
485 alpha = f->alpha[1];
487 if (FLOATP (Vframe_alpha_lower_limit))
488 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
489 else if (INTEGERP (Vframe_alpha_lower_limit))
490 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
492 if (alpha < 0.0)
493 return;
494 else if (alpha > 1.0)
495 alpha = 1.0;
496 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
497 alpha = alpha_min;
499 opac = alpha * OPAQUE;
501 x_catch_errors (dpy);
503 /* If there is a parent from the window manager, put the property there
504 also, to work around broken window managers that fail to do that.
505 Do this unconditionally as this function is called on reparent when
506 alpha has not changed on the frame. */
508 parent = x_find_topmost_parent (f);
509 if (parent != None)
510 XChangeProperty (dpy, parent, dpyinfo->Xatom_net_wm_window_opacity,
511 XA_CARDINAL, 32, PropModeReplace,
512 (unsigned char *) &opac, 1L);
514 /* return unless necessary */
516 unsigned char *data;
517 Atom actual;
518 int rc, format;
519 unsigned long n, left;
521 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
522 0L, 1L, False, XA_CARDINAL,
523 &actual, &format, &n, &left,
524 &data);
526 if (rc == Success && actual != None)
528 unsigned long value = *(unsigned long *)data;
529 XFree ((void *) data);
530 if (value == opac)
532 x_uncatch_errors ();
533 return;
538 XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
539 XA_CARDINAL, 32, PropModeReplace,
540 (unsigned char *) &opac, 1L);
541 x_uncatch_errors ();
545 x_display_pixel_height (struct x_display_info *dpyinfo)
547 return HeightOfScreen (dpyinfo->screen);
551 x_display_pixel_width (struct x_display_info *dpyinfo)
553 return WidthOfScreen (dpyinfo->screen);
557 /***********************************************************************
558 Starting and ending an update
559 ***********************************************************************/
561 /* Start an update of frame F. This function is installed as a hook
562 for update_begin, i.e. it is called when update_begin is called.
563 This function is called prior to calls to x_update_window_begin for
564 each window being updated. Currently, there is nothing to do here
565 because all interesting stuff is done on a window basis. */
567 static void
568 x_update_begin (struct frame *f)
570 /* Nothing to do. */
574 /* Start update of window W. Set the global variable updated_window
575 to the window being updated and set output_cursor to the cursor
576 position of W. */
578 static void
579 x_update_window_begin (struct window *w)
581 struct frame *f = XFRAME (WINDOW_FRAME (w));
582 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
584 updated_window = w;
585 set_output_cursor (&w->cursor);
587 BLOCK_INPUT;
589 if (f == hlinfo->mouse_face_mouse_frame)
591 /* Don't do highlighting for mouse motion during the update. */
592 hlinfo->mouse_face_defer = 1;
594 /* If F needs to be redrawn, simply forget about any prior mouse
595 highlighting. */
596 if (FRAME_GARBAGED_P (f))
597 hlinfo->mouse_face_window = Qnil;
600 UNBLOCK_INPUT;
604 /* Draw a vertical window border from (x,y0) to (x,y1) */
606 static void
607 x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
609 struct frame *f = XFRAME (WINDOW_FRAME (w));
610 struct face *face;
612 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
613 if (face)
614 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
615 face->foreground);
617 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
618 f->output_data.x->normal_gc, x, y0, x, y1);
621 /* End update of window W (which is equal to updated_window).
623 Draw vertical borders between horizontally adjacent windows, and
624 display W's cursor if CURSOR_ON_P is non-zero.
626 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
627 glyphs in mouse-face were overwritten. In that case we have to
628 make sure that the mouse-highlight is properly redrawn.
630 W may be a menu bar pseudo-window in case we don't have X toolkit
631 support. Such windows don't have a cursor, so don't display it
632 here. */
634 static void
635 x_update_window_end (struct window *w, int cursor_on_p, int mouse_face_overwritten_p)
637 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
639 if (!w->pseudo_window_p)
641 BLOCK_INPUT;
643 if (cursor_on_p)
644 display_and_set_cursor (w, 1, output_cursor.hpos,
645 output_cursor.vpos,
646 output_cursor.x, output_cursor.y);
648 if (draw_window_fringes (w, 1))
649 x_draw_vertical_border (w);
651 UNBLOCK_INPUT;
654 /* If a row with mouse-face was overwritten, arrange for
655 XTframe_up_to_date to redisplay the mouse highlight. */
656 if (mouse_face_overwritten_p)
658 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
659 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
660 hlinfo->mouse_face_window = Qnil;
663 updated_window = NULL;
667 /* End update of frame F. This function is installed as a hook in
668 update_end. */
670 static void
671 x_update_end (struct frame *f)
673 /* Mouse highlight may be displayed again. */
674 MOUSE_HL_INFO (f)->mouse_face_defer = 0;
676 #ifndef XFlush
677 BLOCK_INPUT;
678 XFlush (FRAME_X_DISPLAY (f));
679 UNBLOCK_INPUT;
680 #endif
684 /* This function is called from various places in xdisp.c whenever a
685 complete update has been performed. The global variable
686 updated_window is not available here. */
688 static void
689 XTframe_up_to_date (struct frame *f)
691 if (FRAME_X_P (f))
693 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
695 if (hlinfo->mouse_face_deferred_gc
696 || f == hlinfo->mouse_face_mouse_frame)
698 BLOCK_INPUT;
699 if (hlinfo->mouse_face_mouse_frame)
700 note_mouse_highlight (hlinfo->mouse_face_mouse_frame,
701 hlinfo->mouse_face_mouse_x,
702 hlinfo->mouse_face_mouse_y);
703 hlinfo->mouse_face_deferred_gc = 0;
704 UNBLOCK_INPUT;
710 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
711 arrow bitmaps, or clear the fringes if no bitmaps are required
712 before DESIRED_ROW is made current. The window being updated is
713 found in updated_window. This function It is called from
714 update_window_line only if it is known that there are differences
715 between bitmaps to be drawn between current row and DESIRED_ROW. */
717 static void
718 x_after_update_window_line (struct glyph_row *desired_row)
720 struct window *w = updated_window;
721 struct frame *f;
722 int width, height;
724 xassert (w);
726 if (!desired_row->mode_line_p && !w->pseudo_window_p)
727 desired_row->redraw_fringe_bitmaps_p = 1;
729 /* When a window has disappeared, make sure that no rest of
730 full-width rows stays visible in the internal border. Could
731 check here if updated_window is the leftmost/rightmost window,
732 but I guess it's not worth doing since vertically split windows
733 are almost never used, internal border is rarely set, and the
734 overhead is very small. */
735 if (windows_or_buffers_changed
736 && desired_row->full_width_p
737 && (f = XFRAME (w->frame),
738 width = FRAME_INTERNAL_BORDER_WIDTH (f),
739 width != 0)
740 && (height = desired_row->visible_height,
741 height > 0))
743 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
745 BLOCK_INPUT;
746 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
747 0, y, width, height, False);
748 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
749 FRAME_PIXEL_WIDTH (f) - width,
750 y, width, height, False);
751 UNBLOCK_INPUT;
755 static void
756 x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
758 struct frame *f = XFRAME (WINDOW_FRAME (w));
759 Display *display = FRAME_X_DISPLAY (f);
760 Window window = FRAME_X_WINDOW (f);
761 GC gc = f->output_data.x->normal_gc;
762 struct face *face = p->face;
764 /* Must clip because of partially visible lines. */
765 x_clip_to_row (w, row, -1, gc);
767 if (!p->overlay_p)
769 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
771 /* In case the same realized face is used for fringes and
772 for something displayed in the text (e.g. face `region' on
773 mono-displays, the fill style may have been changed to
774 FillSolid in x_draw_glyph_string_background. */
775 if (face->stipple)
776 XSetFillStyle (display, face->gc, FillOpaqueStippled);
777 else
778 XSetForeground (display, face->gc, face->background);
780 #ifdef USE_TOOLKIT_SCROLL_BARS
781 /* If the fringe is adjacent to the left (right) scroll bar of a
782 leftmost (rightmost, respectively) window, then extend its
783 background to the gap between the fringe and the bar. */
784 if ((WINDOW_LEFTMOST_P (w)
785 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
786 || (WINDOW_RIGHTMOST_P (w)
787 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
789 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
791 if (sb_width > 0)
793 int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
794 int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
795 * FRAME_COLUMN_WIDTH (f));
797 if (bx < 0)
799 /* Bitmap fills the fringe. */
800 if (bar_area_x + bar_area_width == p->x)
801 bx = bar_area_x + sb_width;
802 else if (p->x + p->wd == bar_area_x)
803 bx = bar_area_x;
804 if (bx >= 0)
806 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
808 nx = bar_area_width - sb_width;
809 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
810 row->y));
811 ny = row->visible_height;
814 else
816 if (bar_area_x + bar_area_width == bx)
818 bx = bar_area_x + sb_width;
819 nx += bar_area_width - sb_width;
821 else if (bx + nx == bar_area_x)
822 nx += bar_area_width - sb_width;
826 #endif
827 if (bx >= 0 && nx > 0)
828 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
830 if (!face->stipple)
831 XSetForeground (display, face->gc, face->foreground);
834 if (p->which)
836 char *bits;
837 Pixmap pixmap, clipmask = (Pixmap) 0;
838 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
839 XGCValues gcv;
841 if (p->wd > 8)
842 bits = (char *) (p->bits + p->dh);
843 else
844 bits = (char *) p->bits + p->dh;
846 /* Draw the bitmap. I believe these small pixmaps can be cached
847 by the server. */
848 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
849 (p->cursor_p
850 ? (p->overlay_p ? face->background
851 : f->output_data.x->cursor_pixel)
852 : face->foreground),
853 face->background, depth);
855 if (p->overlay_p)
857 clipmask = XCreatePixmapFromBitmapData (display,
858 FRAME_X_DISPLAY_INFO (f)->root_window,
859 bits, p->wd, p->h,
860 1, 0, 1);
861 gcv.clip_mask = clipmask;
862 gcv.clip_x_origin = p->x;
863 gcv.clip_y_origin = p->y;
864 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
867 XCopyArea (display, pixmap, window, gc, 0, 0,
868 p->wd, p->h, p->x, p->y);
869 XFreePixmap (display, pixmap);
871 if (p->overlay_p)
873 gcv.clip_mask = (Pixmap) 0;
874 XChangeGC (display, gc, GCClipMask, &gcv);
875 XFreePixmap (display, clipmask);
879 XSetClipMask (display, gc, None);
884 /* This is called when starting Emacs and when restarting after
885 suspend. When starting Emacs, no X window is mapped. And nothing
886 must be done to Emacs's own window if it is suspended (though that
887 rarely happens). */
889 static void
890 XTset_terminal_modes (struct terminal *terminal)
894 /* This is called when exiting or suspending Emacs. Exiting will make
895 the X-windows go away, and suspending requires no action. */
897 static void
898 XTreset_terminal_modes (struct terminal *terminal)
903 /***********************************************************************
904 Glyph display
905 ***********************************************************************/
909 static void x_set_glyph_string_clipping (struct glyph_string *);
910 static void x_set_glyph_string_gc (struct glyph_string *);
911 static void x_draw_glyph_string_background (struct glyph_string *,
912 int);
913 static void x_draw_glyph_string_foreground (struct glyph_string *);
914 static void x_draw_composite_glyph_string_foreground (struct glyph_string *);
915 static void x_draw_glyph_string_box (struct glyph_string *);
916 static void x_draw_glyph_string (struct glyph_string *);
917 static void x_delete_glyphs (struct frame *, int) NO_RETURN;
918 static void x_compute_glyph_string_overhangs (struct glyph_string *);
919 static void x_set_cursor_gc (struct glyph_string *);
920 static void x_set_mode_line_face_gc (struct glyph_string *);
921 static void x_set_mouse_face_gc (struct glyph_string *);
922 static int x_alloc_lighter_color (struct frame *, Display *, Colormap,
923 unsigned long *, double, int);
924 static void x_setup_relief_color (struct frame *, struct relief *,
925 double, int, unsigned long);
926 static void x_setup_relief_colors (struct glyph_string *);
927 static void x_draw_image_glyph_string (struct glyph_string *);
928 static void x_draw_image_relief (struct glyph_string *);
929 static void x_draw_image_foreground (struct glyph_string *);
930 static void x_draw_image_foreground_1 (struct glyph_string *, Pixmap);
931 static void x_clear_glyph_string_rect (struct glyph_string *, int,
932 int, int, int);
933 static void x_draw_relief_rect (struct frame *, int, int, int, int,
934 int, int, int, int, int, int,
935 XRectangle *);
936 static void x_draw_box_rect (struct glyph_string *, int, int, int, int,
937 int, int, int, XRectangle *);
938 static void x_scroll_bar_clear (struct frame *);
940 #if GLYPH_DEBUG
941 static void x_check_font (struct frame *, struct font *);
942 #endif
945 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
946 face. */
948 static void
949 x_set_cursor_gc (struct glyph_string *s)
951 if (s->font == FRAME_FONT (s->f)
952 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
953 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
954 && !s->cmp)
955 s->gc = s->f->output_data.x->cursor_gc;
956 else
958 /* Cursor on non-default face: must merge. */
959 XGCValues xgcv;
960 unsigned long mask;
962 xgcv.background = s->f->output_data.x->cursor_pixel;
963 xgcv.foreground = s->face->background;
965 /* If the glyph would be invisible, try a different foreground. */
966 if (xgcv.foreground == xgcv.background)
967 xgcv.foreground = s->face->foreground;
968 if (xgcv.foreground == xgcv.background)
969 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
970 if (xgcv.foreground == xgcv.background)
971 xgcv.foreground = s->face->foreground;
973 /* Make sure the cursor is distinct from text in this face. */
974 if (xgcv.background == s->face->background
975 && xgcv.foreground == s->face->foreground)
977 xgcv.background = s->face->foreground;
978 xgcv.foreground = s->face->background;
981 IF_DEBUG (x_check_font (s->f, s->font));
982 xgcv.graphics_exposures = False;
983 mask = GCForeground | GCBackground | GCGraphicsExposures;
985 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
986 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
987 mask, &xgcv);
988 else
989 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
990 = XCreateGC (s->display, s->window, mask, &xgcv);
992 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
997 /* Set up S->gc of glyph string S for drawing text in mouse face. */
999 static void
1000 x_set_mouse_face_gc (struct glyph_string *s)
1002 int face_id;
1003 struct face *face;
1005 /* What face has to be used last for the mouse face? */
1006 face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
1007 face = FACE_FROM_ID (s->f, face_id);
1008 if (face == NULL)
1009 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
1011 if (s->first_glyph->type == CHAR_GLYPH)
1012 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1013 else
1014 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1015 s->face = FACE_FROM_ID (s->f, face_id);
1016 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1018 if (s->font == s->face->font)
1019 s->gc = s->face->gc;
1020 else
1022 /* Otherwise construct scratch_cursor_gc with values from FACE
1023 except for FONT. */
1024 XGCValues xgcv;
1025 unsigned long mask;
1027 xgcv.background = s->face->background;
1028 xgcv.foreground = s->face->foreground;
1029 xgcv.graphics_exposures = False;
1030 mask = GCForeground | GCBackground | GCGraphicsExposures;
1032 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1033 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1034 mask, &xgcv);
1035 else
1036 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1037 = XCreateGC (s->display, s->window, mask, &xgcv);
1039 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1042 xassert (s->gc != 0);
1046 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1047 Faces to use in the mode line have already been computed when the
1048 matrix was built, so there isn't much to do, here. */
1050 static inline void
1051 x_set_mode_line_face_gc (struct glyph_string *s)
1053 s->gc = s->face->gc;
1057 /* Set S->gc of glyph string S for drawing that glyph string. Set
1058 S->stippled_p to a non-zero value if the face of S has a stipple
1059 pattern. */
1061 static inline void
1062 x_set_glyph_string_gc (struct glyph_string *s)
1064 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1066 if (s->hl == DRAW_NORMAL_TEXT)
1068 s->gc = s->face->gc;
1069 s->stippled_p = s->face->stipple != 0;
1071 else if (s->hl == DRAW_INVERSE_VIDEO)
1073 x_set_mode_line_face_gc (s);
1074 s->stippled_p = s->face->stipple != 0;
1076 else if (s->hl == DRAW_CURSOR)
1078 x_set_cursor_gc (s);
1079 s->stippled_p = 0;
1081 else if (s->hl == DRAW_MOUSE_FACE)
1083 x_set_mouse_face_gc (s);
1084 s->stippled_p = s->face->stipple != 0;
1086 else if (s->hl == DRAW_IMAGE_RAISED
1087 || s->hl == DRAW_IMAGE_SUNKEN)
1089 s->gc = s->face->gc;
1090 s->stippled_p = s->face->stipple != 0;
1092 else
1094 s->gc = s->face->gc;
1095 s->stippled_p = s->face->stipple != 0;
1098 /* GC must have been set. */
1099 xassert (s->gc != 0);
1103 /* Set clipping for output of glyph string S. S may be part of a mode
1104 line or menu if we don't have X toolkit support. */
1106 static inline void
1107 x_set_glyph_string_clipping (struct glyph_string *s)
1109 XRectangle *r = s->clip;
1110 int n = get_glyph_string_clip_rects (s, r, 2);
1112 if (n > 0)
1113 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1114 s->num_clips = n;
1118 /* Set SRC's clipping for output of glyph string DST. This is called
1119 when we are drawing DST's left_overhang or right_overhang only in
1120 the area of SRC. */
1122 static void
1123 x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1125 XRectangle r;
1127 r.x = src->x;
1128 r.width = src->width;
1129 r.y = src->y;
1130 r.height = src->height;
1131 dst->clip[0] = r;
1132 dst->num_clips = 1;
1133 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1137 /* RIF:
1138 Compute left and right overhang of glyph string S. */
1140 static void
1141 x_compute_glyph_string_overhangs (struct glyph_string *s)
1143 if (s->cmp == NULL
1144 && (s->first_glyph->type == CHAR_GLYPH
1145 || s->first_glyph->type == COMPOSITE_GLYPH))
1147 struct font_metrics metrics;
1149 if (s->first_glyph->type == CHAR_GLYPH)
1151 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1152 struct font *font = s->font;
1153 int i;
1155 for (i = 0; i < s->nchars; i++)
1156 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1157 font->driver->text_extents (font, code, s->nchars, &metrics);
1159 else
1161 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1163 composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
1165 s->right_overhang = (metrics.rbearing > metrics.width
1166 ? metrics.rbearing - metrics.width : 0);
1167 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1169 else if (s->cmp)
1171 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1172 s->left_overhang = - s->cmp->lbearing;
1177 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1179 static inline void
1180 x_clear_glyph_string_rect (struct glyph_string *s, int x, int y, int w, int h)
1182 XGCValues xgcv;
1183 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1184 XSetForeground (s->display, s->gc, xgcv.background);
1185 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1186 XSetForeground (s->display, s->gc, xgcv.foreground);
1190 /* Draw the background of glyph_string S. If S->background_filled_p
1191 is non-zero don't draw it. FORCE_P non-zero means draw the
1192 background even if it wouldn't be drawn normally. This is used
1193 when a string preceding S draws into the background of S, or S
1194 contains the first component of a composition. */
1196 static void
1197 x_draw_glyph_string_background (struct glyph_string *s, int force_p)
1199 /* Nothing to do if background has already been drawn or if it
1200 shouldn't be drawn in the first place. */
1201 if (!s->background_filled_p)
1203 int box_line_width = max (s->face->box_line_width, 0);
1205 if (s->stippled_p)
1207 /* Fill background with a stipple pattern. */
1208 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1209 XFillRectangle (s->display, s->window, s->gc, s->x,
1210 s->y + box_line_width,
1211 s->background_width,
1212 s->height - 2 * box_line_width);
1213 XSetFillStyle (s->display, s->gc, FillSolid);
1214 s->background_filled_p = 1;
1216 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1217 || s->font_not_found_p
1218 || s->extends_to_end_of_line_p
1219 || force_p)
1221 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1222 s->background_width,
1223 s->height - 2 * box_line_width);
1224 s->background_filled_p = 1;
1230 /* Draw the foreground of glyph string S. */
1232 static void
1233 x_draw_glyph_string_foreground (struct glyph_string *s)
1235 int i, x;
1237 /* If first glyph of S has a left box line, start drawing the text
1238 of S to the right of that box line. */
1239 if (s->face->box != FACE_NO_BOX
1240 && s->first_glyph->left_box_line_p)
1241 x = s->x + eabs (s->face->box_line_width);
1242 else
1243 x = s->x;
1245 /* Draw characters of S as rectangles if S's font could not be
1246 loaded. */
1247 if (s->font_not_found_p)
1249 for (i = 0; i < s->nchars; ++i)
1251 struct glyph *g = s->first_glyph + i;
1252 XDrawRectangle (s->display, s->window,
1253 s->gc, x, s->y, g->pixel_width - 1,
1254 s->height - 1);
1255 x += g->pixel_width;
1258 else
1260 struct font *font = s->font;
1261 int boff = font->baseline_offset;
1262 int y;
1264 if (font->vertical_centering)
1265 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1267 y = s->ybase - boff;
1268 if (s->for_overlaps
1269 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1270 font->driver->draw (s, 0, s->nchars, x, y, 0);
1271 else
1272 font->driver->draw (s, 0, s->nchars, x, y, 1);
1273 if (s->face->overstrike)
1274 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1278 /* Draw the foreground of composite glyph string S. */
1280 static void
1281 x_draw_composite_glyph_string_foreground (struct glyph_string *s)
1283 int i, j, x;
1284 struct font *font = s->font;
1286 /* If first glyph of S has a left box line, start drawing the text
1287 of S to the right of that box line. */
1288 if (s->face && s->face->box != FACE_NO_BOX
1289 && s->first_glyph->left_box_line_p)
1290 x = s->x + eabs (s->face->box_line_width);
1291 else
1292 x = s->x;
1294 /* S is a glyph string for a composition. S->cmp_from is the index
1295 of the first character drawn for glyphs of this composition.
1296 S->cmp_from == 0 means we are drawing the very first character of
1297 this composition. */
1299 /* Draw a rectangle for the composition if the font for the very
1300 first character of the composition could not be loaded. */
1301 if (s->font_not_found_p)
1303 if (s->cmp_from == 0)
1304 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1305 s->width - 1, s->height - 1);
1307 else if (! s->first_glyph->u.cmp.automatic)
1309 int y = s->ybase;
1311 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1312 /* TAB in a composition means display glyphs with padding
1313 space on the left or right. */
1314 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1316 int xx = x + s->cmp->offsets[j * 2];
1317 int yy = y - s->cmp->offsets[j * 2 + 1];
1319 font->driver->draw (s, j, j + 1, xx, yy, 0);
1320 if (s->face->overstrike)
1321 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1324 else
1326 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1327 Lisp_Object glyph;
1328 int y = s->ybase;
1329 int width = 0;
1331 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1333 glyph = LGSTRING_GLYPH (gstring, i);
1334 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1335 width += LGLYPH_WIDTH (glyph);
1336 else
1338 int xoff, yoff, wadjust;
1340 if (j < i)
1342 font->driver->draw (s, j, i, x, y, 0);
1343 if (s->face->overstrike)
1344 font->driver->draw (s, j, i, x + 1, y, 0);
1345 x += width;
1347 xoff = LGLYPH_XOFF (glyph);
1348 yoff = LGLYPH_YOFF (glyph);
1349 wadjust = LGLYPH_WADJUST (glyph);
1350 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1351 if (s->face->overstrike)
1352 font->driver->draw (s, i, i + 1, x + xoff + 1, y + yoff, 0);
1353 x += wadjust;
1354 j = i + 1;
1355 width = 0;
1358 if (j < i)
1360 font->driver->draw (s, j, i, x, y, 0);
1361 if (s->face->overstrike)
1362 font->driver->draw (s, j, i, x + 1, y, 0);
1368 /* Draw the foreground of glyph string S for glyphless characters. */
1370 static void
1371 x_draw_glyphless_glyph_string_foreground (struct glyph_string *s)
1373 struct glyph *glyph = s->first_glyph;
1374 XChar2b char2b[8];
1375 int x, i, j;
1377 /* If first glyph of S has a left box line, start drawing the text
1378 of S to the right of that box line. */
1379 if (s->face && s->face->box != FACE_NO_BOX
1380 && s->first_glyph->left_box_line_p)
1381 x = s->x + eabs (s->face->box_line_width);
1382 else
1383 x = s->x;
1385 s->char2b = char2b;
1387 for (i = 0; i < s->nchars; i++, glyph++)
1389 char buf[7], *str = NULL;
1390 int len = glyph->u.glyphless.len;
1392 if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_ACRONYM)
1394 if (len > 0
1395 && CHAR_TABLE_P (Vglyphless_char_display)
1396 && (CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display))
1397 >= 1))
1399 Lisp_Object acronym
1400 = (! glyph->u.glyphless.for_no_font
1401 ? CHAR_TABLE_REF (Vglyphless_char_display,
1402 glyph->u.glyphless.ch)
1403 : XCHAR_TABLE (Vglyphless_char_display)->extras[0]);
1404 if (STRINGP (acronym))
1405 str = SSDATA (acronym);
1408 else if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_HEX_CODE)
1410 sprintf ((char *) buf, "%0*X",
1411 glyph->u.glyphless.ch < 0x10000 ? 4 : 6,
1412 glyph->u.glyphless.ch);
1413 str = buf;
1416 if (str)
1418 int upper_len = (len + 1) / 2;
1419 unsigned code;
1421 /* It is assured that all LEN characters in STR is ASCII. */
1422 for (j = 0; j < len; j++)
1424 code = s->font->driver->encode_char (s->font, str[j]);
1425 STORE_XCHAR2B (char2b + j, code >> 8, code & 0xFF);
1427 s->font->driver->draw (s, 0, upper_len,
1428 x + glyph->slice.glyphless.upper_xoff,
1429 s->ybase + glyph->slice.glyphless.upper_yoff,
1431 s->font->driver->draw (s, upper_len, len,
1432 x + glyph->slice.glyphless.lower_xoff,
1433 s->ybase + glyph->slice.glyphless.lower_yoff,
1436 if (glyph->u.glyphless.method != GLYPHLESS_DISPLAY_THIN_SPACE)
1437 XDrawRectangle (s->display, s->window, s->gc,
1438 x, s->ybase - glyph->ascent,
1439 glyph->pixel_width - 1,
1440 glyph->ascent + glyph->descent - 1);
1441 x += glyph->pixel_width;
1445 #ifdef USE_X_TOOLKIT
1447 static struct frame *x_frame_of_widget (Widget);
1448 static Boolean cvt_string_to_pixel (Display *, XrmValue *, Cardinal *,
1449 XrmValue *, XrmValue *, XtPointer *);
1450 static void cvt_pixel_dtor (XtAppContext, XrmValue *, XtPointer,
1451 XrmValue *, Cardinal *);
1454 /* Return the frame on which widget WIDGET is used.. Abort if frame
1455 cannot be determined. */
1457 static struct frame *
1458 x_frame_of_widget (Widget widget)
1460 struct x_display_info *dpyinfo;
1461 Lisp_Object tail;
1462 struct frame *f;
1464 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1466 /* Find the top-level shell of the widget. Note that this function
1467 can be called when the widget is not yet realized, so XtWindow
1468 (widget) == 0. That's the reason we can't simply use
1469 x_any_window_to_frame. */
1470 while (!XtIsTopLevelShell (widget))
1471 widget = XtParent (widget);
1473 /* Look for a frame with that top-level widget. Allocate the color
1474 on that frame to get the right gamma correction value. */
1475 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1476 if (FRAMEP (XCAR (tail))
1477 && (f = XFRAME (XCAR (tail)),
1478 (FRAME_X_P (f)
1479 && f->output_data.nothing != 1
1480 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1481 && f->output_data.x->widget == widget)
1482 return f;
1484 abort ();
1488 #ifdef USE_LUCID
1490 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1491 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1492 If this produces the same color as PIXEL, try a color where all RGB
1493 values have DELTA added. Return the allocated color in *PIXEL.
1494 DISPLAY is the X display, CMAP is the colormap to operate on.
1495 Value is non-zero if successful. */
1498 x_alloc_lighter_color_for_widget (Widget widget, Display *display, Colormap cmap,
1499 unsigned long *pixel, double factor, int delta)
1501 struct frame *f = x_frame_of_widget (widget);
1502 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1505 #endif
1508 /* Structure specifying which arguments should be passed by Xt to
1509 cvt_string_to_pixel. We want the widget's screen and colormap. */
1511 static XtConvertArgRec cvt_string_to_pixel_args[] =
1513 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1514 sizeof (Screen *)},
1515 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1516 sizeof (Colormap)}
1520 /* The address of this variable is returned by
1521 cvt_string_to_pixel. */
1523 static Pixel cvt_string_to_pixel_value;
1526 /* Convert a color name to a pixel color.
1528 DPY is the display we are working on.
1530 ARGS is an array of *NARGS XrmValue structures holding additional
1531 information about the widget for which the conversion takes place.
1532 The contents of this array are determined by the specification
1533 in cvt_string_to_pixel_args.
1535 FROM is a pointer to an XrmValue which points to the color name to
1536 convert. TO is an XrmValue in which to return the pixel color.
1538 CLOSURE_RET is a pointer to user-data, in which we record if
1539 we allocated the color or not.
1541 Value is True if successful, False otherwise. */
1543 static Boolean
1544 cvt_string_to_pixel (Display *dpy, XrmValue *args, Cardinal *nargs,
1545 XrmValue *from, XrmValue *to,
1546 XtPointer *closure_ret)
1548 Screen *screen;
1549 Colormap cmap;
1550 Pixel pixel;
1551 String color_name;
1552 XColor color;
1554 if (*nargs != 2)
1556 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1557 "wrongParameters", "cvt_string_to_pixel",
1558 "XtToolkitError",
1559 "Screen and colormap args required", NULL, NULL);
1560 return False;
1563 screen = *(Screen **) args[0].addr;
1564 cmap = *(Colormap *) args[1].addr;
1565 color_name = (String) from->addr;
1567 if (strcmp (color_name, XtDefaultBackground) == 0)
1569 *closure_ret = (XtPointer) False;
1570 pixel = WhitePixelOfScreen (screen);
1572 else if (strcmp (color_name, XtDefaultForeground) == 0)
1574 *closure_ret = (XtPointer) False;
1575 pixel = BlackPixelOfScreen (screen);
1577 else if (XParseColor (dpy, cmap, color_name, &color)
1578 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1580 pixel = color.pixel;
1581 *closure_ret = (XtPointer) True;
1583 else
1585 String params[1];
1586 Cardinal nparams = 1;
1588 params[0] = color_name;
1589 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1590 "badValue", "cvt_string_to_pixel",
1591 "XtToolkitError", "Invalid color `%s'",
1592 params, &nparams);
1593 return False;
1596 if (to->addr != NULL)
1598 if (to->size < sizeof (Pixel))
1600 to->size = sizeof (Pixel);
1601 return False;
1604 *(Pixel *) to->addr = pixel;
1606 else
1608 cvt_string_to_pixel_value = pixel;
1609 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1612 to->size = sizeof (Pixel);
1613 return True;
1617 /* Free a pixel color which was previously allocated via
1618 cvt_string_to_pixel. This is registered as the destructor
1619 for this type of resource via XtSetTypeConverter.
1621 APP is the application context in which we work.
1623 TO is a pointer to an XrmValue holding the color to free.
1624 CLOSURE is the value we stored in CLOSURE_RET for this color
1625 in cvt_string_to_pixel.
1627 ARGS and NARGS are like for cvt_string_to_pixel. */
1629 static void
1630 cvt_pixel_dtor (XtAppContext app, XrmValuePtr to, XtPointer closure, XrmValuePtr args,
1631 Cardinal *nargs)
1633 if (*nargs != 2)
1635 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1636 "XtToolkitError",
1637 "Screen and colormap arguments required",
1638 NULL, NULL);
1640 else if (closure != NULL)
1642 /* We did allocate the pixel, so free it. */
1643 Screen *screen = *(Screen **) args[0].addr;
1644 Colormap cmap = *(Colormap *) args[1].addr;
1645 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1646 (Pixel *) to->addr, 1);
1651 #endif /* USE_X_TOOLKIT */
1654 /* Value is an array of XColor structures for the contents of the
1655 color map of display DPY. Set *NCELLS to the size of the array.
1656 Note that this probably shouldn't be called for large color maps,
1657 say a 24-bit TrueColor map. */
1659 static const XColor *
1660 x_color_cells (Display *dpy, int *ncells)
1662 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1664 if (dpyinfo->color_cells == NULL)
1666 Screen *screen = dpyinfo->screen;
1667 int ncolor_cells = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1668 int i;
1670 dpyinfo->color_cells = xnmalloc (ncolor_cells,
1671 sizeof *dpyinfo->color_cells);
1672 dpyinfo->ncolor_cells = ncolor_cells;
1674 for (i = 0; i < ncolor_cells; ++i)
1675 dpyinfo->color_cells[i].pixel = i;
1677 XQueryColors (dpy, dpyinfo->cmap,
1678 dpyinfo->color_cells, ncolor_cells);
1681 *ncells = dpyinfo->ncolor_cells;
1682 return dpyinfo->color_cells;
1686 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1687 colors in COLORS. Use cached information, if available. */
1689 void
1690 x_query_colors (struct frame *f, XColor *colors, int ncolors)
1692 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1694 if (dpyinfo->color_cells)
1696 int i;
1697 for (i = 0; i < ncolors; ++i)
1699 unsigned long pixel = colors[i].pixel;
1700 xassert (pixel < dpyinfo->ncolor_cells);
1701 xassert (dpyinfo->color_cells[pixel].pixel == pixel);
1702 colors[i] = dpyinfo->color_cells[pixel];
1705 else
1706 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1710 /* On frame F, translate pixel color to RGB values for the color in
1711 COLOR. Use cached information, if available. */
1713 void
1714 x_query_color (struct frame *f, XColor *color)
1716 x_query_colors (f, color, 1);
1720 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1721 exact match can't be allocated, try the nearest color available.
1722 Value is non-zero if successful. Set *COLOR to the color
1723 allocated. */
1725 static int
1726 x_alloc_nearest_color_1 (Display *dpy, Colormap cmap, XColor *color)
1728 int rc;
1730 rc = XAllocColor (dpy, cmap, color);
1731 if (rc == 0)
1733 /* If we got to this point, the colormap is full, so we're going
1734 to try to get the next closest color. The algorithm used is
1735 a least-squares matching, which is what X uses for closest
1736 color matching with StaticColor visuals. */
1737 int nearest, i;
1738 int max_color_delta = 255;
1739 int max_delta = 3 * max_color_delta;
1740 int nearest_delta = max_delta + 1;
1741 int ncells;
1742 const XColor *cells = x_color_cells (dpy, &ncells);
1744 for (nearest = i = 0; i < ncells; ++i)
1746 int dred = (color->red >> 8) - (cells[i].red >> 8);
1747 int dgreen = (color->green >> 8) - (cells[i].green >> 8);
1748 int dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1749 int delta = dred * dred + dgreen * dgreen + dblue * dblue;
1751 if (delta < nearest_delta)
1753 nearest = i;
1754 nearest_delta = delta;
1758 color->red = cells[nearest].red;
1759 color->green = cells[nearest].green;
1760 color->blue = cells[nearest].blue;
1761 rc = XAllocColor (dpy, cmap, color);
1763 else
1765 /* If allocation succeeded, and the allocated pixel color is not
1766 equal to a cached pixel color recorded earlier, there was a
1767 change in the colormap, so clear the color cache. */
1768 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1769 XColor *cached_color;
1771 if (dpyinfo->color_cells
1772 && (cached_color = &dpyinfo->color_cells[color->pixel],
1773 (cached_color->red != color->red
1774 || cached_color->blue != color->blue
1775 || cached_color->green != color->green)))
1777 xfree (dpyinfo->color_cells);
1778 dpyinfo->color_cells = NULL;
1779 dpyinfo->ncolor_cells = 0;
1783 #ifdef DEBUG_X_COLORS
1784 if (rc)
1785 register_color (color->pixel);
1786 #endif /* DEBUG_X_COLORS */
1788 return rc;
1792 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1793 exact match can't be allocated, try the nearest color available.
1794 Value is non-zero if successful. Set *COLOR to the color
1795 allocated. */
1798 x_alloc_nearest_color (struct frame *f, Colormap cmap, XColor *color)
1800 gamma_correct (f, color);
1801 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1805 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1806 It's necessary to do this instead of just using PIXEL directly to
1807 get color reference counts right. */
1809 unsigned long
1810 x_copy_color (struct frame *f, long unsigned int pixel)
1812 XColor color;
1814 color.pixel = pixel;
1815 BLOCK_INPUT;
1816 x_query_color (f, &color);
1817 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1818 UNBLOCK_INPUT;
1819 #ifdef DEBUG_X_COLORS
1820 register_color (pixel);
1821 #endif
1822 return color.pixel;
1826 /* Brightness beyond which a color won't have its highlight brightness
1827 boosted.
1829 Nominally, highlight colors for `3d' faces are calculated by
1830 brightening an object's color by a constant scale factor, but this
1831 doesn't yield good results for dark colors, so for colors who's
1832 brightness is less than this value (on a scale of 0-65535) have an
1833 use an additional additive factor.
1835 The value here is set so that the default menu-bar/mode-line color
1836 (grey75) will not have its highlights changed at all. */
1837 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1840 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1841 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1842 If this produces the same color as PIXEL, try a color where all RGB
1843 values have DELTA added. Return the allocated color in *PIXEL.
1844 DISPLAY is the X display, CMAP is the colormap to operate on.
1845 Value is non-zero if successful. */
1847 static int
1848 x_alloc_lighter_color (struct frame *f, Display *display, Colormap cmap, long unsigned int *pixel, double factor, int delta)
1850 XColor color, new;
1851 long bright;
1852 int success_p;
1854 /* Get RGB color values. */
1855 color.pixel = *pixel;
1856 x_query_color (f, &color);
1858 /* Change RGB values by specified FACTOR. Avoid overflow! */
1859 xassert (factor >= 0);
1860 new.red = min (0xffff, factor * color.red);
1861 new.green = min (0xffff, factor * color.green);
1862 new.blue = min (0xffff, factor * color.blue);
1864 /* Calculate brightness of COLOR. */
1865 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1867 /* We only boost colors that are darker than
1868 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1869 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1870 /* Make an additive adjustment to NEW, because it's dark enough so
1871 that scaling by FACTOR alone isn't enough. */
1873 /* How far below the limit this color is (0 - 1, 1 being darker). */
1874 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1875 /* The additive adjustment. */
1876 int min_delta = delta * dimness * factor / 2;
1878 if (factor < 1)
1880 new.red = max (0, new.red - min_delta);
1881 new.green = max (0, new.green - min_delta);
1882 new.blue = max (0, new.blue - min_delta);
1884 else
1886 new.red = min (0xffff, min_delta + new.red);
1887 new.green = min (0xffff, min_delta + new.green);
1888 new.blue = min (0xffff, min_delta + new.blue);
1892 /* Try to allocate the color. */
1893 success_p = x_alloc_nearest_color (f, cmap, &new);
1894 if (success_p)
1896 if (new.pixel == *pixel)
1898 /* If we end up with the same color as before, try adding
1899 delta to the RGB values. */
1900 x_free_colors (f, &new.pixel, 1);
1902 new.red = min (0xffff, delta + color.red);
1903 new.green = min (0xffff, delta + color.green);
1904 new.blue = min (0xffff, delta + color.blue);
1905 success_p = x_alloc_nearest_color (f, cmap, &new);
1907 else
1908 success_p = 1;
1909 *pixel = new.pixel;
1912 return success_p;
1916 /* Set up the foreground color for drawing relief lines of glyph
1917 string S. RELIEF is a pointer to a struct relief containing the GC
1918 with which lines will be drawn. Use a color that is FACTOR or
1919 DELTA lighter or darker than the relief's background which is found
1920 in S->f->output_data.x->relief_background. If such a color cannot
1921 be allocated, use DEFAULT_PIXEL, instead. */
1923 static void
1924 x_setup_relief_color (struct frame *f, struct relief *relief, double factor, int delta, long unsigned int default_pixel)
1926 XGCValues xgcv;
1927 struct x_output *di = f->output_data.x;
1928 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1929 unsigned long pixel;
1930 unsigned long background = di->relief_background;
1931 Colormap cmap = FRAME_X_COLORMAP (f);
1932 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1933 Display *dpy = FRAME_X_DISPLAY (f);
1935 xgcv.graphics_exposures = False;
1936 xgcv.line_width = 1;
1938 /* Free previously allocated color. The color cell will be reused
1939 when it has been freed as many times as it was allocated, so this
1940 doesn't affect faces using the same colors. */
1941 if (relief->gc
1942 && relief->allocated_p)
1944 x_free_colors (f, &relief->pixel, 1);
1945 relief->allocated_p = 0;
1948 /* Allocate new color. */
1949 xgcv.foreground = default_pixel;
1950 pixel = background;
1951 if (dpyinfo->n_planes != 1
1952 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1954 relief->allocated_p = 1;
1955 xgcv.foreground = relief->pixel = pixel;
1958 if (relief->gc == 0)
1960 xgcv.stipple = dpyinfo->gray;
1961 mask |= GCStipple;
1962 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1964 else
1965 XChangeGC (dpy, relief->gc, mask, &xgcv);
1969 /* Set up colors for the relief lines around glyph string S. */
1971 static void
1972 x_setup_relief_colors (struct glyph_string *s)
1974 struct x_output *di = s->f->output_data.x;
1975 unsigned long color;
1977 if (s->face->use_box_color_for_shadows_p)
1978 color = s->face->box_color;
1979 else if (s->first_glyph->type == IMAGE_GLYPH
1980 && s->img->pixmap
1981 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
1982 color = IMAGE_BACKGROUND (s->img, s->f, 0);
1983 else
1985 XGCValues xgcv;
1987 /* Get the background color of the face. */
1988 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
1989 color = xgcv.background;
1992 if (di->white_relief.gc == 0
1993 || color != di->relief_background)
1995 di->relief_background = color;
1996 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
1997 WHITE_PIX_DEFAULT (s->f));
1998 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
1999 BLACK_PIX_DEFAULT (s->f));
2004 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
2005 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
2006 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
2007 relief. LEFT_P non-zero means draw a relief on the left side of
2008 the rectangle. RIGHT_P non-zero means draw a relief on the right
2009 side of the rectangle. CLIP_RECT is the clipping rectangle to use
2010 when drawing. */
2012 static void
2013 x_draw_relief_rect (struct frame *f,
2014 int left_x, int top_y, int right_x, int bottom_y, int width,
2015 int raised_p, int top_p, int bot_p, int left_p, int right_p,
2016 XRectangle *clip_rect)
2018 Display *dpy = FRAME_X_DISPLAY (f);
2019 Window window = FRAME_X_WINDOW (f);
2020 int i;
2021 GC gc;
2023 if (raised_p)
2024 gc = f->output_data.x->white_relief.gc;
2025 else
2026 gc = f->output_data.x->black_relief.gc;
2027 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2029 /* This code is more complicated than it has to be, because of two
2030 minor hacks to make the boxes look nicer: (i) if width > 1, draw
2031 the outermost line using the black relief. (ii) Omit the four
2032 corner pixels. */
2034 /* Top. */
2035 if (top_p)
2037 if (width == 1)
2038 XDrawLine (dpy, window, gc,
2039 left_x + (left_p ? 1 : 0), top_y,
2040 right_x + (right_p ? 0 : 1), top_y);
2042 for (i = 1; i < width; ++i)
2043 XDrawLine (dpy, window, gc,
2044 left_x + i * left_p, top_y + i,
2045 right_x + 1 - i * right_p, top_y + i);
2048 /* Left. */
2049 if (left_p)
2051 if (width == 1)
2052 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2054 XClearArea (dpy, window, left_x, top_y, 1, 1, False);
2055 XClearArea (dpy, window, left_x, bottom_y, 1, 1, False);
2057 for (i = (width > 1 ? 1 : 0); i < width; ++i)
2058 XDrawLine (dpy, window, gc,
2059 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
2062 XSetClipMask (dpy, gc, None);
2063 if (raised_p)
2064 gc = f->output_data.x->black_relief.gc;
2065 else
2066 gc = f->output_data.x->white_relief.gc;
2067 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2069 if (width > 1)
2071 /* Outermost top line. */
2072 if (top_p)
2073 XDrawLine (dpy, window, gc,
2074 left_x + (left_p ? 1 : 0), top_y,
2075 right_x + (right_p ? 0 : 1), top_y);
2077 /* Outermost left line. */
2078 if (left_p)
2079 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2082 /* Bottom. */
2083 if (bot_p)
2085 XDrawLine (dpy, window, gc,
2086 left_x + (left_p ? 1 : 0), bottom_y,
2087 right_x + (right_p ? 0 : 1), bottom_y);
2088 for (i = 1; i < width; ++i)
2089 XDrawLine (dpy, window, gc,
2090 left_x + i * left_p, bottom_y - i,
2091 right_x + 1 - i * right_p, bottom_y - i);
2094 /* Right. */
2095 if (right_p)
2097 XClearArea (dpy, window, right_x, top_y, 1, 1, False);
2098 XClearArea (dpy, window, right_x, bottom_y, 1, 1, False);
2099 for (i = 0; i < width; ++i)
2100 XDrawLine (dpy, window, gc,
2101 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
2104 XSetClipMask (dpy, gc, None);
2108 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2109 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2110 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2111 left side of the rectangle. RIGHT_P non-zero means draw a line
2112 on the right side of the rectangle. CLIP_RECT is the clipping
2113 rectangle to use when drawing. */
2115 static void
2116 x_draw_box_rect (struct glyph_string *s,
2117 int left_x, int top_y, int right_x, int bottom_y, int width,
2118 int left_p, int right_p, XRectangle *clip_rect)
2120 XGCValues xgcv;
2122 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2123 XSetForeground (s->display, s->gc, s->face->box_color);
2124 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2126 /* Top. */
2127 XFillRectangle (s->display, s->window, s->gc,
2128 left_x, top_y, right_x - left_x + 1, width);
2130 /* Left. */
2131 if (left_p)
2132 XFillRectangle (s->display, s->window, s->gc,
2133 left_x, top_y, width, bottom_y - top_y + 1);
2135 /* Bottom. */
2136 XFillRectangle (s->display, s->window, s->gc,
2137 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2139 /* Right. */
2140 if (right_p)
2141 XFillRectangle (s->display, s->window, s->gc,
2142 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2144 XSetForeground (s->display, s->gc, xgcv.foreground);
2145 XSetClipMask (s->display, s->gc, None);
2149 /* Draw a box around glyph string S. */
2151 static void
2152 x_draw_glyph_string_box (struct glyph_string *s)
2154 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2155 int left_p, right_p;
2156 struct glyph *last_glyph;
2157 XRectangle clip_rect;
2159 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2160 ? WINDOW_RIGHT_EDGE_X (s->w)
2161 : window_box_right (s->w, s->area));
2163 /* The glyph that may have a right box line. */
2164 last_glyph = (s->cmp || s->img
2165 ? s->first_glyph
2166 : s->first_glyph + s->nchars - 1);
2168 width = eabs (s->face->box_line_width);
2169 raised_p = s->face->box == FACE_RAISED_BOX;
2170 left_x = s->x;
2171 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2172 ? last_x - 1
2173 : min (last_x, s->x + s->background_width) - 1);
2174 top_y = s->y;
2175 bottom_y = top_y + s->height - 1;
2177 left_p = (s->first_glyph->left_box_line_p
2178 || (s->hl == DRAW_MOUSE_FACE
2179 && (s->prev == NULL
2180 || s->prev->hl != s->hl)));
2181 right_p = (last_glyph->right_box_line_p
2182 || (s->hl == DRAW_MOUSE_FACE
2183 && (s->next == NULL
2184 || s->next->hl != s->hl)));
2186 get_glyph_string_clip_rect (s, &clip_rect);
2188 if (s->face->box == FACE_SIMPLE_BOX)
2189 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2190 left_p, right_p, &clip_rect);
2191 else
2193 x_setup_relief_colors (s);
2194 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2195 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2200 /* Draw foreground of image glyph string S. */
2202 static void
2203 x_draw_image_foreground (struct glyph_string *s)
2205 int x = s->x;
2206 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2208 /* If first glyph of S has a left box line, start drawing it to the
2209 right of that line. */
2210 if (s->face->box != FACE_NO_BOX
2211 && s->first_glyph->left_box_line_p
2212 && s->slice.x == 0)
2213 x += eabs (s->face->box_line_width);
2215 /* If there is a margin around the image, adjust x- and y-position
2216 by that margin. */
2217 if (s->slice.x == 0)
2218 x += s->img->hmargin;
2219 if (s->slice.y == 0)
2220 y += s->img->vmargin;
2222 if (s->img->pixmap)
2224 if (s->img->mask)
2226 /* We can't set both a clip mask and use XSetClipRectangles
2227 because the latter also sets a clip mask. We also can't
2228 trust on the shape extension to be available
2229 (XShapeCombineRegion). So, compute the rectangle to draw
2230 manually. */
2231 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2232 | GCFunction);
2233 XGCValues xgcv;
2234 XRectangle clip_rect, image_rect, r;
2236 xgcv.clip_mask = s->img->mask;
2237 xgcv.clip_x_origin = x;
2238 xgcv.clip_y_origin = y;
2239 xgcv.function = GXcopy;
2240 XChangeGC (s->display, s->gc, mask, &xgcv);
2242 get_glyph_string_clip_rect (s, &clip_rect);
2243 image_rect.x = x;
2244 image_rect.y = y;
2245 image_rect.width = s->slice.width;
2246 image_rect.height = s->slice.height;
2247 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2248 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2249 s->slice.x + r.x - x, s->slice.y + r.y - y,
2250 r.width, r.height, r.x, r.y);
2252 else
2254 XRectangle clip_rect, image_rect, r;
2256 get_glyph_string_clip_rect (s, &clip_rect);
2257 image_rect.x = x;
2258 image_rect.y = y;
2259 image_rect.width = s->slice.width;
2260 image_rect.height = s->slice.height;
2261 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2262 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2263 s->slice.x + r.x - x, s->slice.y + r.y - y,
2264 r.width, r.height, r.x, r.y);
2266 /* When the image has a mask, we can expect that at
2267 least part of a mouse highlight or a block cursor will
2268 be visible. If the image doesn't have a mask, make
2269 a block cursor visible by drawing a rectangle around
2270 the image. I believe it's looking better if we do
2271 nothing here for mouse-face. */
2272 if (s->hl == DRAW_CURSOR)
2274 int relief = s->img->relief;
2275 if (relief < 0) relief = -relief;
2276 XDrawRectangle (s->display, s->window, s->gc,
2277 x - relief, y - relief,
2278 s->slice.width + relief*2 - 1,
2279 s->slice.height + relief*2 - 1);
2283 else
2284 /* Draw a rectangle if image could not be loaded. */
2285 XDrawRectangle (s->display, s->window, s->gc, x, y,
2286 s->slice.width - 1, s->slice.height - 1);
2290 /* Draw a relief around the image glyph string S. */
2292 static void
2293 x_draw_image_relief (struct glyph_string *s)
2295 int x0, y0, x1, y1, thick, raised_p, extra;
2296 XRectangle r;
2297 int x = s->x;
2298 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2300 /* If first glyph of S has a left box line, start drawing it to the
2301 right of that line. */
2302 if (s->face->box != FACE_NO_BOX
2303 && s->first_glyph->left_box_line_p
2304 && s->slice.x == 0)
2305 x += eabs (s->face->box_line_width);
2307 /* If there is a margin around the image, adjust x- and y-position
2308 by that margin. */
2309 if (s->slice.x == 0)
2310 x += s->img->hmargin;
2311 if (s->slice.y == 0)
2312 y += s->img->vmargin;
2314 if (s->hl == DRAW_IMAGE_SUNKEN
2315 || s->hl == DRAW_IMAGE_RAISED)
2317 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2318 raised_p = s->hl == DRAW_IMAGE_RAISED;
2320 else
2322 thick = eabs (s->img->relief);
2323 raised_p = s->img->relief > 0;
2326 extra = s->face->id == TOOL_BAR_FACE_ID
2327 ? XINT (Vtool_bar_button_margin) : 0;
2329 x0 = x - thick - extra;
2330 y0 = y - thick - extra;
2331 x1 = x + s->slice.width + thick - 1 + extra;
2332 y1 = y + s->slice.height + thick - 1 + extra;
2334 x_setup_relief_colors (s);
2335 get_glyph_string_clip_rect (s, &r);
2336 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2337 s->slice.y == 0,
2338 s->slice.y + s->slice.height == s->img->height,
2339 s->slice.x == 0,
2340 s->slice.x + s->slice.width == s->img->width,
2341 &r);
2345 /* Draw the foreground of image glyph string S to PIXMAP. */
2347 static void
2348 x_draw_image_foreground_1 (struct glyph_string *s, Pixmap pixmap)
2350 int x = 0;
2351 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2353 /* If first glyph of S has a left box line, start drawing it to the
2354 right of that line. */
2355 if (s->face->box != FACE_NO_BOX
2356 && s->first_glyph->left_box_line_p
2357 && s->slice.x == 0)
2358 x += eabs (s->face->box_line_width);
2360 /* If there is a margin around the image, adjust x- and y-position
2361 by that margin. */
2362 if (s->slice.x == 0)
2363 x += s->img->hmargin;
2364 if (s->slice.y == 0)
2365 y += s->img->vmargin;
2367 if (s->img->pixmap)
2369 if (s->img->mask)
2371 /* We can't set both a clip mask and use XSetClipRectangles
2372 because the latter also sets a clip mask. We also can't
2373 trust on the shape extension to be available
2374 (XShapeCombineRegion). So, compute the rectangle to draw
2375 manually. */
2376 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2377 | GCFunction);
2378 XGCValues xgcv;
2380 xgcv.clip_mask = s->img->mask;
2381 xgcv.clip_x_origin = x - s->slice.x;
2382 xgcv.clip_y_origin = y - s->slice.y;
2383 xgcv.function = GXcopy;
2384 XChangeGC (s->display, s->gc, mask, &xgcv);
2386 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2387 s->slice.x, s->slice.y,
2388 s->slice.width, s->slice.height, x, y);
2389 XSetClipMask (s->display, s->gc, None);
2391 else
2393 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2394 s->slice.x, s->slice.y,
2395 s->slice.width, s->slice.height, x, y);
2397 /* When the image has a mask, we can expect that at
2398 least part of a mouse highlight or a block cursor will
2399 be visible. If the image doesn't have a mask, make
2400 a block cursor visible by drawing a rectangle around
2401 the image. I believe it's looking better if we do
2402 nothing here for mouse-face. */
2403 if (s->hl == DRAW_CURSOR)
2405 int r = s->img->relief;
2406 if (r < 0) r = -r;
2407 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2408 s->slice.width + r*2 - 1,
2409 s->slice.height + r*2 - 1);
2413 else
2414 /* Draw a rectangle if image could not be loaded. */
2415 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2416 s->slice.width - 1, s->slice.height - 1);
2420 /* Draw part of the background of glyph string S. X, Y, W, and H
2421 give the rectangle to draw. */
2423 static void
2424 x_draw_glyph_string_bg_rect (struct glyph_string *s, int x, int y, int w, int h)
2426 if (s->stippled_p)
2428 /* Fill background with a stipple pattern. */
2429 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2430 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2431 XSetFillStyle (s->display, s->gc, FillSolid);
2433 else
2434 x_clear_glyph_string_rect (s, x, y, w, h);
2438 /* Draw image glyph string S.
2440 s->y
2441 s->x +-------------------------
2442 | s->face->box
2444 | +-------------------------
2445 | | s->img->margin
2447 | | +-------------------
2448 | | | the image
2452 static void
2453 x_draw_image_glyph_string (struct glyph_string *s)
2455 int box_line_hwidth = eabs (s->face->box_line_width);
2456 int box_line_vwidth = max (s->face->box_line_width, 0);
2457 int height;
2458 Pixmap pixmap = None;
2460 height = s->height;
2461 if (s->slice.y == 0)
2462 height -= box_line_vwidth;
2463 if (s->slice.y + s->slice.height >= s->img->height)
2464 height -= box_line_vwidth;
2466 /* Fill background with face under the image. Do it only if row is
2467 taller than image or if image has a clip mask to reduce
2468 flickering. */
2469 s->stippled_p = s->face->stipple != 0;
2470 if (height > s->slice.height
2471 || s->img->hmargin
2472 || s->img->vmargin
2473 || s->img->mask
2474 || s->img->pixmap == 0
2475 || s->width != s->background_width)
2477 if (s->img->mask)
2479 /* Create a pixmap as large as the glyph string. Fill it
2480 with the background color. Copy the image to it, using
2481 its mask. Copy the temporary pixmap to the display. */
2482 Screen *screen = FRAME_X_SCREEN (s->f);
2483 int depth = DefaultDepthOfScreen (screen);
2485 /* Create a pixmap as large as the glyph string. */
2486 pixmap = XCreatePixmap (s->display, s->window,
2487 s->background_width,
2488 s->height, depth);
2490 /* Don't clip in the following because we're working on the
2491 pixmap. */
2492 XSetClipMask (s->display, s->gc, None);
2494 /* Fill the pixmap with the background color/stipple. */
2495 if (s->stippled_p)
2497 /* Fill background with a stipple pattern. */
2498 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2499 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2500 XFillRectangle (s->display, pixmap, s->gc,
2501 0, 0, s->background_width, s->height);
2502 XSetFillStyle (s->display, s->gc, FillSolid);
2503 XSetTSOrigin (s->display, s->gc, 0, 0);
2505 else
2507 XGCValues xgcv;
2508 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2509 &xgcv);
2510 XSetForeground (s->display, s->gc, xgcv.background);
2511 XFillRectangle (s->display, pixmap, s->gc,
2512 0, 0, s->background_width, s->height);
2513 XSetForeground (s->display, s->gc, xgcv.foreground);
2516 else
2518 int x = s->x;
2519 int y = s->y;
2521 if (s->first_glyph->left_box_line_p
2522 && s->slice.x == 0)
2523 x += box_line_hwidth;
2525 if (s->slice.y == 0)
2526 y += box_line_vwidth;
2528 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2531 s->background_filled_p = 1;
2534 /* Draw the foreground. */
2535 if (pixmap != None)
2537 x_draw_image_foreground_1 (s, pixmap);
2538 x_set_glyph_string_clipping (s);
2539 XCopyArea (s->display, pixmap, s->window, s->gc,
2540 0, 0, s->background_width, s->height, s->x, s->y);
2541 XFreePixmap (s->display, pixmap);
2543 else
2544 x_draw_image_foreground (s);
2546 /* If we must draw a relief around the image, do it. */
2547 if (s->img->relief
2548 || s->hl == DRAW_IMAGE_RAISED
2549 || s->hl == DRAW_IMAGE_SUNKEN)
2550 x_draw_image_relief (s);
2554 /* Draw stretch glyph string S. */
2556 static void
2557 x_draw_stretch_glyph_string (struct glyph_string *s)
2559 xassert (s->first_glyph->type == STRETCH_GLYPH);
2561 if (s->hl == DRAW_CURSOR
2562 && !x_stretch_cursor_p)
2564 /* If `x-stretch-cursor' is nil, don't draw a block cursor as
2565 wide as the stretch glyph. */
2566 int width, background_width = s->background_width;
2567 int x = s->x;
2569 if (!s->row->reversed_p)
2571 int left_x = window_box_left_offset (s->w, TEXT_AREA);
2573 if (x < left_x)
2575 background_width -= left_x - x;
2576 x = left_x;
2579 else
2581 /* In R2L rows, draw the cursor on the right edge of the
2582 stretch glyph. */
2583 int right_x = window_box_right_offset (s->w, TEXT_AREA);
2585 if (x + background_width > right_x)
2586 background_width -= x - right_x;
2587 x += background_width;
2589 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2590 if (s->row->reversed_p)
2591 x -= width;
2593 /* Draw cursor. */
2594 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2596 /* Clear rest using the GC of the original non-cursor face. */
2597 if (width < background_width)
2599 int y = s->y;
2600 int w = background_width - width, h = s->height;
2601 XRectangle r;
2602 GC gc;
2604 if (!s->row->reversed_p)
2605 x += width;
2606 else
2607 x = s->x;
2608 if (s->row->mouse_face_p
2609 && cursor_in_mouse_face_p (s->w))
2611 x_set_mouse_face_gc (s);
2612 gc = s->gc;
2614 else
2615 gc = s->face->gc;
2617 get_glyph_string_clip_rect (s, &r);
2618 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2620 if (s->face->stipple)
2622 /* Fill background with a stipple pattern. */
2623 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2624 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2625 XSetFillStyle (s->display, gc, FillSolid);
2627 else
2629 XGCValues xgcv;
2630 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2631 XSetForeground (s->display, gc, xgcv.background);
2632 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2633 XSetForeground (s->display, gc, xgcv.foreground);
2637 else if (!s->background_filled_p)
2639 int background_width = s->background_width;
2640 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2642 /* Don't draw into left margin, fringe or scrollbar area
2643 except for header line and mode line. */
2644 if (x < left_x && !s->row->mode_line_p)
2646 background_width -= left_x - x;
2647 x = left_x;
2649 if (background_width > 0)
2650 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2653 s->background_filled_p = 1;
2657 /* Draw glyph string S. */
2659 static void
2660 x_draw_glyph_string (struct glyph_string *s)
2662 int relief_drawn_p = 0;
2664 /* If S draws into the background of its successors, draw the
2665 background of the successors first so that S can draw into it.
2666 This makes S->next use XDrawString instead of XDrawImageString. */
2667 if (s->next && s->right_overhang && !s->for_overlaps)
2669 int width;
2670 struct glyph_string *next;
2672 for (width = 0, next = s->next;
2673 next && width < s->right_overhang;
2674 width += next->width, next = next->next)
2675 if (next->first_glyph->type != IMAGE_GLYPH)
2677 x_set_glyph_string_gc (next);
2678 x_set_glyph_string_clipping (next);
2679 if (next->first_glyph->type == STRETCH_GLYPH)
2680 x_draw_stretch_glyph_string (next);
2681 else
2682 x_draw_glyph_string_background (next, 1);
2683 next->num_clips = 0;
2687 /* Set up S->gc, set clipping and draw S. */
2688 x_set_glyph_string_gc (s);
2690 /* Draw relief (if any) in advance for char/composition so that the
2691 glyph string can be drawn over it. */
2692 if (!s->for_overlaps
2693 && s->face->box != FACE_NO_BOX
2694 && (s->first_glyph->type == CHAR_GLYPH
2695 || s->first_glyph->type == COMPOSITE_GLYPH))
2698 x_set_glyph_string_clipping (s);
2699 x_draw_glyph_string_background (s, 1);
2700 x_draw_glyph_string_box (s);
2701 x_set_glyph_string_clipping (s);
2702 relief_drawn_p = 1;
2704 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2705 && !s->clip_tail
2706 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2707 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2708 /* We must clip just this glyph. left_overhang part has already
2709 drawn when s->prev was drawn, and right_overhang part will be
2710 drawn later when s->next is drawn. */
2711 x_set_glyph_string_clipping_exactly (s, s);
2712 else
2713 x_set_glyph_string_clipping (s);
2715 switch (s->first_glyph->type)
2717 case IMAGE_GLYPH:
2718 x_draw_image_glyph_string (s);
2719 break;
2721 case STRETCH_GLYPH:
2722 x_draw_stretch_glyph_string (s);
2723 break;
2725 case CHAR_GLYPH:
2726 if (s->for_overlaps)
2727 s->background_filled_p = 1;
2728 else
2729 x_draw_glyph_string_background (s, 0);
2730 x_draw_glyph_string_foreground (s);
2731 break;
2733 case COMPOSITE_GLYPH:
2734 if (s->for_overlaps || (s->cmp_from > 0
2735 && ! s->first_glyph->u.cmp.automatic))
2736 s->background_filled_p = 1;
2737 else
2738 x_draw_glyph_string_background (s, 1);
2739 x_draw_composite_glyph_string_foreground (s);
2740 break;
2742 case GLYPHLESS_GLYPH:
2743 if (s->for_overlaps)
2744 s->background_filled_p = 1;
2745 else
2746 x_draw_glyph_string_background (s, 1);
2747 x_draw_glyphless_glyph_string_foreground (s);
2748 break;
2750 default:
2751 abort ();
2754 if (!s->for_overlaps)
2756 /* Draw underline. */
2757 if (s->face->underline_p)
2759 unsigned long thickness, position;
2760 int y;
2762 if (s->prev && s->prev->face->underline_p)
2764 /* We use the same underline style as the previous one. */
2765 thickness = s->prev->underline_thickness;
2766 position = s->prev->underline_position;
2768 else
2770 /* Get the underline thickness. Default is 1 pixel. */
2771 if (s->font && s->font->underline_thickness > 0)
2772 thickness = s->font->underline_thickness;
2773 else
2774 thickness = 1;
2775 if (x_underline_at_descent_line)
2776 position = (s->height - thickness) - (s->ybase - s->y);
2777 else
2779 /* Get the underline position. This is the recommended
2780 vertical offset in pixels from the baseline to the top of
2781 the underline. This is a signed value according to the
2782 specs, and its default is
2784 ROUND ((maximum descent) / 2), with
2785 ROUND(x) = floor (x + 0.5) */
2787 if (x_use_underline_position_properties
2788 && s->font && s->font->underline_position >= 0)
2789 position = s->font->underline_position;
2790 else if (s->font)
2791 position = (s->font->descent + 1) / 2;
2792 else
2793 position = underline_minimum_offset;
2795 position = max (position, underline_minimum_offset);
2797 /* Check the sanity of thickness and position. We should
2798 avoid drawing underline out of the current line area. */
2799 if (s->y + s->height <= s->ybase + position)
2800 position = (s->height - 1) - (s->ybase - s->y);
2801 if (s->y + s->height < s->ybase + position + thickness)
2802 thickness = (s->y + s->height) - (s->ybase + position);
2803 s->underline_thickness = thickness;
2804 s->underline_position = position;
2805 y = s->ybase + position;
2806 if (s->face->underline_defaulted_p)
2807 XFillRectangle (s->display, s->window, s->gc,
2808 s->x, y, s->width, thickness);
2809 else
2811 XGCValues xgcv;
2812 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2813 XSetForeground (s->display, s->gc, s->face->underline_color);
2814 XFillRectangle (s->display, s->window, s->gc,
2815 s->x, y, s->width, thickness);
2816 XSetForeground (s->display, s->gc, xgcv.foreground);
2820 /* Draw overline. */
2821 if (s->face->overline_p)
2823 unsigned long dy = 0, h = 1;
2825 if (s->face->overline_color_defaulted_p)
2826 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2827 s->width, h);
2828 else
2830 XGCValues xgcv;
2831 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2832 XSetForeground (s->display, s->gc, s->face->overline_color);
2833 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2834 s->width, h);
2835 XSetForeground (s->display, s->gc, xgcv.foreground);
2839 /* Draw strike-through. */
2840 if (s->face->strike_through_p)
2842 unsigned long h = 1;
2843 unsigned long dy = (s->height - h) / 2;
2845 if (s->face->strike_through_color_defaulted_p)
2846 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2847 s->width, h);
2848 else
2850 XGCValues xgcv;
2851 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2852 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2853 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2854 s->width, h);
2855 XSetForeground (s->display, s->gc, xgcv.foreground);
2859 /* Draw relief if not yet drawn. */
2860 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2861 x_draw_glyph_string_box (s);
2863 if (s->prev)
2865 struct glyph_string *prev;
2867 for (prev = s->prev; prev; prev = prev->prev)
2868 if (prev->hl != s->hl
2869 && prev->x + prev->width + prev->right_overhang > s->x)
2871 /* As prev was drawn while clipped to its own area, we
2872 must draw the right_overhang part using s->hl now. */
2873 enum draw_glyphs_face save = prev->hl;
2875 prev->hl = s->hl;
2876 x_set_glyph_string_gc (prev);
2877 x_set_glyph_string_clipping_exactly (s, prev);
2878 if (prev->first_glyph->type == CHAR_GLYPH)
2879 x_draw_glyph_string_foreground (prev);
2880 else
2881 x_draw_composite_glyph_string_foreground (prev);
2882 XSetClipMask (prev->display, prev->gc, None);
2883 prev->hl = save;
2884 prev->num_clips = 0;
2888 if (s->next)
2890 struct glyph_string *next;
2892 for (next = s->next; next; next = next->next)
2893 if (next->hl != s->hl
2894 && next->x - next->left_overhang < s->x + s->width)
2896 /* As next will be drawn while clipped to its own area,
2897 we must draw the left_overhang part using s->hl now. */
2898 enum draw_glyphs_face save = next->hl;
2900 next->hl = s->hl;
2901 x_set_glyph_string_gc (next);
2902 x_set_glyph_string_clipping_exactly (s, next);
2903 if (next->first_glyph->type == CHAR_GLYPH)
2904 x_draw_glyph_string_foreground (next);
2905 else
2906 x_draw_composite_glyph_string_foreground (next);
2907 XSetClipMask (next->display, next->gc, None);
2908 next->hl = save;
2909 next->num_clips = 0;
2914 /* Reset clipping. */
2915 XSetClipMask (s->display, s->gc, None);
2916 s->num_clips = 0;
2919 /* Shift display to make room for inserted glyphs. */
2921 static void
2922 x_shift_glyphs_for_insert (struct frame *f, int x, int y, int width, int height, int shift_by)
2924 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2925 f->output_data.x->normal_gc,
2926 x, y, width, height,
2927 x + shift_by, y);
2930 /* Delete N glyphs at the nominal cursor position. Not implemented
2931 for X frames. */
2933 static void
2934 x_delete_glyphs (struct frame *f, register int n)
2936 abort ();
2940 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2941 If they are <= 0, this is probably an error. */
2943 void
2944 x_clear_area (Display *dpy, Window window, int x, int y, int width, int height, int exposures)
2946 xassert (width > 0 && height > 0);
2947 XClearArea (dpy, window, x, y, width, height, exposures);
2951 /* Clear an entire frame. */
2953 static void
2954 x_clear_frame (struct frame *f)
2956 /* Clearing the frame will erase any cursor, so mark them all as no
2957 longer visible. */
2958 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2959 output_cursor.hpos = output_cursor.vpos = 0;
2960 output_cursor.x = -1;
2962 /* We don't set the output cursor here because there will always
2963 follow an explicit cursor_to. */
2964 BLOCK_INPUT;
2966 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
2968 /* We have to clear the scroll bars. If we have changed colors or
2969 something like that, then they should be notified. */
2970 x_scroll_bar_clear (f);
2972 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
2973 /* Make sure scroll bars are redrawn. As they aren't redrawn by
2974 redisplay, do it here. */
2975 if (FRAME_GTK_WIDGET (f))
2976 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
2977 #endif
2979 XFlush (FRAME_X_DISPLAY (f));
2981 UNBLOCK_INPUT;
2986 /* Invert the middle quarter of the frame for .15 sec. */
2988 /* We use the select system call to do the waiting, so we have to make
2989 sure it's available. If it isn't, we just won't do visual bells. */
2991 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
2994 /* Subtract the `struct timeval' values X and Y, storing the result in
2995 *RESULT. Return 1 if the difference is negative, otherwise 0. */
2997 static int
2998 timeval_subtract (struct timeval *result, struct timeval x, struct timeval y)
3000 /* Perform the carry for the later subtraction by updating y. This
3001 is safer because on some systems the tv_sec member is unsigned. */
3002 if (x.tv_usec < y.tv_usec)
3004 int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
3005 y.tv_usec -= 1000000 * nsec;
3006 y.tv_sec += nsec;
3009 if (x.tv_usec - y.tv_usec > 1000000)
3011 int nsec = (y.tv_usec - x.tv_usec) / 1000000;
3012 y.tv_usec += 1000000 * nsec;
3013 y.tv_sec -= nsec;
3016 /* Compute the time remaining to wait. tv_usec is certainly
3017 positive. */
3018 result->tv_sec = x.tv_sec - y.tv_sec;
3019 result->tv_usec = x.tv_usec - y.tv_usec;
3021 /* Return indication of whether the result should be considered
3022 negative. */
3023 return x.tv_sec < y.tv_sec;
3026 static void
3027 XTflash (struct frame *f)
3029 BLOCK_INPUT;
3032 #ifdef USE_GTK
3033 /* Use Gdk routines to draw. This way, we won't draw over scroll bars
3034 when the scroll bars and the edit widget share the same X window. */
3035 GdkWindow *window = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
3036 #ifdef HAVE_GTK3
3037 cairo_t *cr = gdk_cairo_create (window);
3038 cairo_set_source_rgb (cr, 1, 1, 1);
3039 cairo_set_operator (cr, CAIRO_OPERATOR_DIFFERENCE);
3040 #define XFillRectangle(d, win, gc, x, y, w, h) \
3041 do { \
3042 cairo_rectangle (cr, x, y, w, h); \
3043 cairo_fill (cr); \
3045 while (0)
3046 #else /* ! HAVE_GTK3 */
3047 GdkGCValues vals;
3048 GdkGC *gc;
3049 vals.foreground.pixel = (FRAME_FOREGROUND_PIXEL (f)
3050 ^ FRAME_BACKGROUND_PIXEL (f));
3051 vals.function = GDK_XOR;
3052 gc = gdk_gc_new_with_values (window,
3053 &vals, GDK_GC_FUNCTION | GDK_GC_FOREGROUND);
3054 #define XFillRectangle(d, win, gc, x, y, w, h) \
3055 gdk_draw_rectangle (window, gc, TRUE, x, y, w, h)
3056 #endif /* ! HAVE_GTK3 */
3057 #else /* ! USE_GTK */
3058 GC gc;
3060 /* Create a GC that will use the GXxor function to flip foreground
3061 pixels into background pixels. */
3063 XGCValues values;
3065 values.function = GXxor;
3066 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3067 ^ FRAME_BACKGROUND_PIXEL (f));
3069 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3070 GCFunction | GCForeground, &values);
3072 #endif
3074 /* Get the height not including a menu bar widget. */
3075 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3076 /* Height of each line to flash. */
3077 int flash_height = FRAME_LINE_HEIGHT (f);
3078 /* These will be the left and right margins of the rectangles. */
3079 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3080 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3082 int width;
3084 /* Don't flash the area between a scroll bar and the frame
3085 edge it is next to. */
3086 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3088 case vertical_scroll_bar_left:
3089 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3090 break;
3092 case vertical_scroll_bar_right:
3093 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3094 break;
3096 default:
3097 break;
3100 width = flash_right - flash_left;
3102 /* If window is tall, flash top and bottom line. */
3103 if (height > 3 * FRAME_LINE_HEIGHT (f))
3105 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3106 flash_left,
3107 (FRAME_INTERNAL_BORDER_WIDTH (f)
3108 + FRAME_TOP_MARGIN_HEIGHT (f)),
3109 width, flash_height);
3110 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3111 flash_left,
3112 (height - flash_height
3113 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3114 width, flash_height);
3117 else
3118 /* If it is short, flash it all. */
3119 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3120 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3121 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3123 x_flush (f);
3126 struct timeval wakeup;
3128 EMACS_GET_TIME (wakeup);
3130 /* Compute time to wait until, propagating carry from usecs. */
3131 wakeup.tv_usec += 150000;
3132 wakeup.tv_sec += (wakeup.tv_usec / 1000000);
3133 wakeup.tv_usec %= 1000000;
3135 /* Keep waiting until past the time wakeup or any input gets
3136 available. */
3137 while (! detect_input_pending ())
3139 struct timeval current;
3140 struct timeval timeout;
3142 EMACS_GET_TIME (current);
3144 /* Break if result would be negative. */
3145 if (timeval_subtract (&current, wakeup, current))
3146 break;
3148 /* How long `select' should wait. */
3149 timeout.tv_sec = 0;
3150 timeout.tv_usec = 10000;
3152 /* Try to wait that long--but we might wake up sooner. */
3153 select (0, NULL, NULL, NULL, &timeout);
3157 /* If window is tall, flash top and bottom line. */
3158 if (height > 3 * FRAME_LINE_HEIGHT (f))
3160 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3161 flash_left,
3162 (FRAME_INTERNAL_BORDER_WIDTH (f)
3163 + FRAME_TOP_MARGIN_HEIGHT (f)),
3164 width, flash_height);
3165 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3166 flash_left,
3167 (height - flash_height
3168 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3169 width, flash_height);
3171 else
3172 /* If it is short, flash it all. */
3173 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3174 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3175 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3177 #ifdef USE_GTK
3178 #ifdef HAVE_GTK3
3179 cairo_destroy (cr);
3180 #else
3181 g_object_unref (G_OBJECT (gc));
3182 #endif
3183 #undef XFillRectangle
3184 #else
3185 XFreeGC (FRAME_X_DISPLAY (f), gc);
3186 #endif
3187 x_flush (f);
3191 UNBLOCK_INPUT;
3194 #endif /* defined (HAVE_TIMEVAL) && defined (HAVE_SELECT) */
3197 static void
3198 XTtoggle_invisible_pointer (FRAME_PTR f, int invisible)
3200 BLOCK_INPUT;
3201 if (invisible)
3203 if (FRAME_X_DISPLAY_INFO (f)->invisible_cursor != 0)
3204 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3205 FRAME_X_DISPLAY_INFO (f)->invisible_cursor);
3207 else
3208 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3209 f->output_data.x->current_cursor);
3210 f->pointer_invisible = invisible;
3211 UNBLOCK_INPUT;
3215 /* Make audible bell. */
3217 static void
3218 XTring_bell (struct frame *f)
3220 if (FRAME_X_DISPLAY (f))
3222 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
3223 if (visible_bell)
3224 XTflash (f);
3225 else
3226 #endif
3228 BLOCK_INPUT;
3229 XBell (FRAME_X_DISPLAY (f), 0);
3230 XFlush (FRAME_X_DISPLAY (f));
3231 UNBLOCK_INPUT;
3237 /* Specify how many text lines, from the top of the window,
3238 should be affected by insert-lines and delete-lines operations.
3239 This, and those operations, are used only within an update
3240 that is bounded by calls to x_update_begin and x_update_end. */
3242 static void
3243 XTset_terminal_window (struct frame *f, int n)
3245 /* This function intentionally left blank. */
3250 /***********************************************************************
3251 Line Dance
3252 ***********************************************************************/
3254 /* Perform an insert-lines or delete-lines operation, inserting N
3255 lines or deleting -N lines at vertical position VPOS. */
3257 static void
3258 x_ins_del_lines (struct frame *f, int vpos, int n)
3260 abort ();
3264 /* Scroll part of the display as described by RUN. */
3266 static void
3267 x_scroll_run (struct window *w, struct run *run)
3269 struct frame *f = XFRAME (w->frame);
3270 int x, y, width, height, from_y, to_y, bottom_y;
3272 /* Get frame-relative bounding box of the text display area of W,
3273 without mode lines. Include in this box the left and right
3274 fringe of W. */
3275 window_box (w, -1, &x, &y, &width, &height);
3277 #ifdef USE_TOOLKIT_SCROLL_BARS
3278 /* If the fringe is adjacent to the left (right) scroll bar of a
3279 leftmost (rightmost, respectively) window, then extend its
3280 background to the gap between the fringe and the bar. */
3281 if ((WINDOW_LEFTMOST_P (w)
3282 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
3283 || (WINDOW_RIGHTMOST_P (w)
3284 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
3286 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
3288 if (sb_width > 0)
3290 int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
3291 int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
3292 * FRAME_COLUMN_WIDTH (f));
3294 if (bar_area_x + bar_area_width == x)
3296 x = bar_area_x + sb_width;
3297 width += bar_area_width - sb_width;
3299 else if (x + width == bar_area_x)
3300 width += bar_area_width - sb_width;
3303 #endif
3305 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3306 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3307 bottom_y = y + height;
3309 if (to_y < from_y)
3311 /* Scrolling up. Make sure we don't copy part of the mode
3312 line at the bottom. */
3313 if (from_y + run->height > bottom_y)
3314 height = bottom_y - from_y;
3315 else
3316 height = run->height;
3318 else
3320 /* Scolling down. Make sure we don't copy over the mode line.
3321 at the bottom. */
3322 if (to_y + run->height > bottom_y)
3323 height = bottom_y - to_y;
3324 else
3325 height = run->height;
3328 BLOCK_INPUT;
3330 /* Cursor off. Will be switched on again in x_update_window_end. */
3331 updated_window = w;
3332 x_clear_cursor (w);
3334 XCopyArea (FRAME_X_DISPLAY (f),
3335 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3336 f->output_data.x->normal_gc,
3337 x, from_y,
3338 width, height,
3339 x, to_y);
3341 UNBLOCK_INPUT;
3346 /***********************************************************************
3347 Exposure Events
3348 ***********************************************************************/
3351 static void
3352 frame_highlight (struct frame *f)
3354 /* We used to only do this if Vx_no_window_manager was non-nil, but
3355 the ICCCM (section 4.1.6) says that the window's border pixmap
3356 and border pixel are window attributes which are "private to the
3357 client", so we can always change it to whatever we want. */
3358 BLOCK_INPUT;
3359 /* I recently started to get errors in this XSetWindowBorder, depending on
3360 the window-manager in use, tho something more is at play since I've been
3361 using that same window-manager binary for ever. Let's not crash just
3362 because of this (bug#9310). */
3363 x_catch_errors (FRAME_X_DISPLAY (f));
3364 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3365 f->output_data.x->border_pixel);
3366 x_uncatch_errors ();
3367 UNBLOCK_INPUT;
3368 x_update_cursor (f, 1);
3369 x_set_frame_alpha (f);
3372 static void
3373 frame_unhighlight (struct frame *f)
3375 /* We used to only do this if Vx_no_window_manager was non-nil, but
3376 the ICCCM (section 4.1.6) says that the window's border pixmap
3377 and border pixel are window attributes which are "private to the
3378 client", so we can always change it to whatever we want. */
3379 BLOCK_INPUT;
3380 /* Same as above for XSetWindowBorder (bug#9310). */
3381 x_catch_errors (FRAME_X_DISPLAY (f));
3382 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3383 f->output_data.x->border_tile);
3384 x_uncatch_errors ();
3385 UNBLOCK_INPUT;
3386 x_update_cursor (f, 1);
3387 x_set_frame_alpha (f);
3390 /* The focus has changed. Update the frames as necessary to reflect
3391 the new situation. Note that we can't change the selected frame
3392 here, because the Lisp code we are interrupting might become confused.
3393 Each event gets marked with the frame in which it occurred, so the
3394 Lisp code can tell when the switch took place by examining the events. */
3396 static void
3397 x_new_focus_frame (struct x_display_info *dpyinfo, struct frame *frame)
3399 struct frame *old_focus = dpyinfo->x_focus_frame;
3401 if (frame != dpyinfo->x_focus_frame)
3403 /* Set this before calling other routines, so that they see
3404 the correct value of x_focus_frame. */
3405 dpyinfo->x_focus_frame = frame;
3407 if (old_focus && old_focus->auto_lower)
3408 x_lower_frame (old_focus);
3410 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3411 pending_autoraise_frame = dpyinfo->x_focus_frame;
3412 else
3413 pending_autoraise_frame = 0;
3416 x_frame_rehighlight (dpyinfo);
3419 /* Handle FocusIn and FocusOut state changes for FRAME.
3420 If FRAME has focus and there exists more than one frame, puts
3421 a FOCUS_IN_EVENT into *BUFP. */
3423 static void
3424 x_focus_changed (int type, int state, struct x_display_info *dpyinfo, struct frame *frame, struct input_event *bufp)
3426 if (type == FocusIn)
3428 if (dpyinfo->x_focus_event_frame != frame)
3430 x_new_focus_frame (dpyinfo, frame);
3431 dpyinfo->x_focus_event_frame = frame;
3433 /* Don't stop displaying the initial startup message
3434 for a switch-frame event we don't need. */
3435 if (NILP (Vterminal_frame)
3436 && CONSP (Vframe_list)
3437 && !NILP (XCDR (Vframe_list)))
3439 bufp->kind = FOCUS_IN_EVENT;
3440 XSETFRAME (bufp->frame_or_window, frame);
3444 frame->output_data.x->focus_state |= state;
3446 #ifdef HAVE_X_I18N
3447 if (FRAME_XIC (frame))
3448 XSetICFocus (FRAME_XIC (frame));
3449 #endif
3451 else if (type == FocusOut)
3453 frame->output_data.x->focus_state &= ~state;
3455 if (dpyinfo->x_focus_event_frame == frame)
3457 dpyinfo->x_focus_event_frame = 0;
3458 x_new_focus_frame (dpyinfo, 0);
3461 #ifdef HAVE_X_I18N
3462 if (FRAME_XIC (frame))
3463 XUnsetICFocus (FRAME_XIC (frame));
3464 #endif
3465 if (frame->pointer_invisible)
3466 XTtoggle_invisible_pointer (frame, 0);
3470 /* The focus may have changed. Figure out if it is a real focus change,
3471 by checking both FocusIn/Out and Enter/LeaveNotify events.
3473 Returns FOCUS_IN_EVENT event in *BUFP. */
3475 static void
3476 x_detect_focus_change (struct x_display_info *dpyinfo, XEvent *event, struct input_event *bufp)
3478 struct frame *frame;
3480 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3481 if (! frame)
3482 return;
3484 switch (event->type)
3486 case EnterNotify:
3487 case LeaveNotify:
3489 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3490 int focus_state
3491 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3493 if (event->xcrossing.detail != NotifyInferior
3494 && event->xcrossing.focus
3495 && ! (focus_state & FOCUS_EXPLICIT))
3496 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3497 FOCUS_IMPLICIT,
3498 dpyinfo, frame, bufp);
3500 break;
3502 case FocusIn:
3503 case FocusOut:
3504 x_focus_changed (event->type,
3505 (event->xfocus.detail == NotifyPointer ?
3506 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3507 dpyinfo, frame, bufp);
3508 break;
3510 case ClientMessage:
3511 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3513 enum xembed_message msg = event->xclient.data.l[1];
3514 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3515 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3517 break;
3522 #if defined HAVE_MENUS && !defined USE_X_TOOLKIT && !defined USE_GTK
3523 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3525 void
3526 x_mouse_leave (struct x_display_info *dpyinfo)
3528 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3530 #endif
3532 /* The focus has changed, or we have redirected a frame's focus to
3533 another frame (this happens when a frame uses a surrogate
3534 mini-buffer frame). Shift the highlight as appropriate.
3536 The FRAME argument doesn't necessarily have anything to do with which
3537 frame is being highlighted or un-highlighted; we only use it to find
3538 the appropriate X display info. */
3540 static void
3541 XTframe_rehighlight (struct frame *frame)
3543 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3546 static void
3547 x_frame_rehighlight (struct x_display_info *dpyinfo)
3549 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3551 if (dpyinfo->x_focus_frame)
3553 dpyinfo->x_highlight_frame
3554 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3555 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3556 : dpyinfo->x_focus_frame);
3557 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3559 FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
3560 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3563 else
3564 dpyinfo->x_highlight_frame = 0;
3566 if (dpyinfo->x_highlight_frame != old_highlight)
3568 if (old_highlight)
3569 frame_unhighlight (old_highlight);
3570 if (dpyinfo->x_highlight_frame)
3571 frame_highlight (dpyinfo->x_highlight_frame);
3577 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3579 /* Initialize mode_switch_bit and modifier_meaning. */
3580 static void
3581 x_find_modifier_meanings (struct x_display_info *dpyinfo)
3583 int min_code, max_code;
3584 KeySym *syms;
3585 int syms_per_code;
3586 XModifierKeymap *mods;
3588 dpyinfo->meta_mod_mask = 0;
3589 dpyinfo->shift_lock_mask = 0;
3590 dpyinfo->alt_mod_mask = 0;
3591 dpyinfo->super_mod_mask = 0;
3592 dpyinfo->hyper_mod_mask = 0;
3594 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3596 syms = XGetKeyboardMapping (dpyinfo->display,
3597 min_code, max_code - min_code + 1,
3598 &syms_per_code);
3599 mods = XGetModifierMapping (dpyinfo->display);
3601 /* Scan the modifier table to see which modifier bits the Meta and
3602 Alt keysyms are on. */
3604 int row, col; /* The row and column in the modifier table. */
3605 int found_alt_or_meta;
3607 for (row = 3; row < 8; row++)
3609 found_alt_or_meta = 0;
3610 for (col = 0; col < mods->max_keypermod; col++)
3612 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3614 /* Zeroes are used for filler. Skip them. */
3615 if (code == 0)
3616 continue;
3618 /* Are any of this keycode's keysyms a meta key? */
3620 int code_col;
3622 for (code_col = 0; code_col < syms_per_code; code_col++)
3624 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3626 switch (sym)
3628 case XK_Meta_L:
3629 case XK_Meta_R:
3630 found_alt_or_meta = 1;
3631 dpyinfo->meta_mod_mask |= (1 << row);
3632 break;
3634 case XK_Alt_L:
3635 case XK_Alt_R:
3636 found_alt_or_meta = 1;
3637 dpyinfo->alt_mod_mask |= (1 << row);
3638 break;
3640 case XK_Hyper_L:
3641 case XK_Hyper_R:
3642 if (!found_alt_or_meta)
3643 dpyinfo->hyper_mod_mask |= (1 << row);
3644 code_col = syms_per_code;
3645 col = mods->max_keypermod;
3646 break;
3648 case XK_Super_L:
3649 case XK_Super_R:
3650 if (!found_alt_or_meta)
3651 dpyinfo->super_mod_mask |= (1 << row);
3652 code_col = syms_per_code;
3653 col = mods->max_keypermod;
3654 break;
3656 case XK_Shift_Lock:
3657 /* Ignore this if it's not on the lock modifier. */
3658 if (!found_alt_or_meta && ((1 << row) == LockMask))
3659 dpyinfo->shift_lock_mask = LockMask;
3660 code_col = syms_per_code;
3661 col = mods->max_keypermod;
3662 break;
3670 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3671 if (! dpyinfo->meta_mod_mask)
3673 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3674 dpyinfo->alt_mod_mask = 0;
3677 /* If some keys are both alt and meta,
3678 make them just meta, not alt. */
3679 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3681 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3684 XFree ((char *) syms);
3685 XFreeModifiermap (mods);
3688 /* Convert between the modifier bits X uses and the modifier bits
3689 Emacs uses. */
3691 EMACS_INT
3692 x_x_to_emacs_modifiers (struct x_display_info *dpyinfo, int state)
3694 EMACS_INT mod_meta = meta_modifier;
3695 EMACS_INT mod_alt = alt_modifier;
3696 EMACS_INT mod_hyper = hyper_modifier;
3697 EMACS_INT mod_super = super_modifier;
3698 Lisp_Object tem;
3700 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3701 if (INTEGERP (tem)) mod_alt = XINT (tem);
3702 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3703 if (INTEGERP (tem)) mod_meta = XINT (tem);
3704 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3705 if (INTEGERP (tem)) mod_hyper = XINT (tem);
3706 tem = Fget (Vx_super_keysym, Qmodifier_value);
3707 if (INTEGERP (tem)) mod_super = XINT (tem);
3710 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3711 | ((state & ControlMask) ? ctrl_modifier : 0)
3712 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3713 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3714 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3715 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3718 static int
3719 x_emacs_to_x_modifiers (struct x_display_info *dpyinfo, EMACS_INT state)
3721 int mod_meta = meta_modifier;
3722 int mod_alt = alt_modifier;
3723 int mod_hyper = hyper_modifier;
3724 int mod_super = super_modifier;
3726 Lisp_Object tem;
3728 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3729 if (INTEGERP (tem)) mod_alt = XINT (tem);
3730 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3731 if (INTEGERP (tem)) mod_meta = XINT (tem);
3732 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3733 if (INTEGERP (tem)) mod_hyper = XINT (tem);
3734 tem = Fget (Vx_super_keysym, Qmodifier_value);
3735 if (INTEGERP (tem)) mod_super = XINT (tem);
3738 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3739 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3740 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3741 | ((state & shift_modifier) ? ShiftMask : 0)
3742 | ((state & ctrl_modifier) ? ControlMask : 0)
3743 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3746 /* Convert a keysym to its name. */
3748 char *
3749 x_get_keysym_name (int keysym)
3751 char *value;
3753 BLOCK_INPUT;
3754 value = XKeysymToString (keysym);
3755 UNBLOCK_INPUT;
3757 return value;
3762 /* Mouse clicks and mouse movement. Rah. */
3764 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3766 If the event is a button press, then note that we have grabbed
3767 the mouse. */
3769 static Lisp_Object
3770 construct_mouse_click (struct input_event *result, XButtonEvent *event, struct frame *f)
3772 /* Make the event type NO_EVENT; we'll change that when we decide
3773 otherwise. */
3774 result->kind = MOUSE_CLICK_EVENT;
3775 result->code = event->button - Button1;
3776 result->timestamp = event->time;
3777 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3778 event->state)
3779 | (event->type == ButtonRelease
3780 ? up_modifier
3781 : down_modifier));
3783 XSETINT (result->x, event->x);
3784 XSETINT (result->y, event->y);
3785 XSETFRAME (result->frame_or_window, f);
3786 result->arg = Qnil;
3787 return Qnil;
3791 /* Function to report a mouse movement to the mainstream Emacs code.
3792 The input handler calls this.
3794 We have received a mouse movement event, which is given in *event.
3795 If the mouse is over a different glyph than it was last time, tell
3796 the mainstream emacs code by setting mouse_moved. If not, ask for
3797 another motion event, so we can check again the next time it moves. */
3799 static XMotionEvent last_mouse_motion_event;
3800 static Lisp_Object last_mouse_motion_frame;
3802 static int
3803 note_mouse_movement (FRAME_PTR frame, XMotionEvent *event)
3805 last_mouse_movement_time = event->time;
3806 last_mouse_motion_event = *event;
3807 XSETFRAME (last_mouse_motion_frame, frame);
3809 if (!FRAME_X_OUTPUT (frame))
3810 return 0;
3812 if (event->window != FRAME_X_WINDOW (frame))
3814 frame->mouse_moved = 1;
3815 last_mouse_scroll_bar = Qnil;
3816 note_mouse_highlight (frame, -1, -1);
3817 last_mouse_glyph_frame = 0;
3818 return 1;
3822 /* Has the mouse moved off the glyph it was on at the last sighting? */
3823 if (frame != last_mouse_glyph_frame
3824 || event->x < last_mouse_glyph.x
3825 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3826 || event->y < last_mouse_glyph.y
3827 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3829 frame->mouse_moved = 1;
3830 last_mouse_scroll_bar = Qnil;
3831 note_mouse_highlight (frame, event->x, event->y);
3832 /* Remember which glyph we're now on. */
3833 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3834 last_mouse_glyph_frame = frame;
3835 return 1;
3838 return 0;
3842 /************************************************************************
3843 Mouse Face
3844 ************************************************************************/
3846 static void
3847 redo_mouse_highlight (void)
3849 if (!NILP (last_mouse_motion_frame)
3850 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3851 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3852 last_mouse_motion_event.x,
3853 last_mouse_motion_event.y);
3858 /* Return the current position of the mouse.
3859 *FP should be a frame which indicates which display to ask about.
3861 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3862 and *PART to the frame, window, and scroll bar part that the mouse
3863 is over. Set *X and *Y to the portion and whole of the mouse's
3864 position on the scroll bar.
3866 If the mouse movement started elsewhere, set *FP to the frame the
3867 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3868 the mouse is over.
3870 Set *TIMESTAMP to the server time-stamp for the time at which the mouse
3871 was at this position.
3873 Don't store anything if we don't have a valid set of values to report.
3875 This clears the mouse_moved flag, so we can wait for the next mouse
3876 movement. */
3878 static void
3879 XTmouse_position (FRAME_PTR *fp, int insist, Lisp_Object *bar_window,
3880 enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
3881 Time *timestamp)
3883 FRAME_PTR f1;
3885 BLOCK_INPUT;
3887 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3888 x_scroll_bar_report_motion (fp, bar_window, part, x, y, timestamp);
3889 else
3891 Window root;
3892 int root_x, root_y;
3894 Window dummy_window;
3895 int dummy;
3897 Lisp_Object frame, tail;
3899 /* Clear the mouse-moved flag for every frame on this display. */
3900 FOR_EACH_FRAME (tail, frame)
3901 if (FRAME_X_P (XFRAME (frame))
3902 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3903 XFRAME (frame)->mouse_moved = 0;
3905 last_mouse_scroll_bar = Qnil;
3907 /* Figure out which root window we're on. */
3908 XQueryPointer (FRAME_X_DISPLAY (*fp),
3909 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3911 /* The root window which contains the pointer. */
3912 &root,
3914 /* Trash which we can't trust if the pointer is on
3915 a different screen. */
3916 &dummy_window,
3918 /* The position on that root window. */
3919 &root_x, &root_y,
3921 /* More trash we can't trust. */
3922 &dummy, &dummy,
3924 /* Modifier keys and pointer buttons, about which
3925 we don't care. */
3926 (unsigned int *) &dummy);
3928 /* Now we have a position on the root; find the innermost window
3929 containing the pointer. */
3931 Window win, child;
3932 int win_x, win_y;
3933 int parent_x = 0, parent_y = 0;
3935 win = root;
3937 /* XTranslateCoordinates can get errors if the window
3938 structure is changing at the same time this function
3939 is running. So at least we must not crash from them. */
3941 x_catch_errors (FRAME_X_DISPLAY (*fp));
3943 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3944 && FRAME_LIVE_P (last_mouse_frame))
3946 /* If mouse was grabbed on a frame, give coords for that frame
3947 even if the mouse is now outside it. */
3948 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3950 /* From-window, to-window. */
3951 root, FRAME_X_WINDOW (last_mouse_frame),
3953 /* From-position, to-position. */
3954 root_x, root_y, &win_x, &win_y,
3956 /* Child of win. */
3957 &child);
3958 f1 = last_mouse_frame;
3960 else
3962 while (1)
3964 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3966 /* From-window, to-window. */
3967 root, win,
3969 /* From-position, to-position. */
3970 root_x, root_y, &win_x, &win_y,
3972 /* Child of win. */
3973 &child);
3975 if (child == None || child == win)
3976 break;
3977 #ifdef USE_GTK
3978 /* We don't wan't to know the innermost window. We
3979 want the edit window. For non-Gtk+ the innermost
3980 window is the edit window. For Gtk+ it might not
3981 be. It might be the tool bar for example. */
3982 if (x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win))
3983 break;
3984 #endif
3985 win = child;
3986 parent_x = win_x;
3987 parent_y = win_y;
3990 /* Now we know that:
3991 win is the innermost window containing the pointer
3992 (XTC says it has no child containing the pointer),
3993 win_x and win_y are the pointer's position in it
3994 (XTC did this the last time through), and
3995 parent_x and parent_y are the pointer's position in win's parent.
3996 (They are what win_x and win_y were when win was child.
3997 If win is the root window, it has no parent, and
3998 parent_{x,y} are invalid, but that's okay, because we'll
3999 never use them in that case.) */
4001 #ifdef USE_GTK
4002 /* We don't wan't to know the innermost window. We
4003 want the edit window. */
4004 f1 = x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
4005 #else
4006 /* Is win one of our frames? */
4007 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
4008 #endif
4010 #ifdef USE_X_TOOLKIT
4011 /* If we end up with the menu bar window, say it's not
4012 on the frame. */
4013 if (f1 != NULL
4014 && f1->output_data.x->menubar_widget
4015 && win == XtWindow (f1->output_data.x->menubar_widget))
4016 f1 = NULL;
4017 #endif /* USE_X_TOOLKIT */
4020 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
4021 f1 = 0;
4023 x_uncatch_errors ();
4025 /* If not, is it one of our scroll bars? */
4026 if (! f1)
4028 struct scroll_bar *bar;
4030 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
4032 if (bar)
4034 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4035 win_x = parent_x;
4036 win_y = parent_y;
4040 if (f1 == 0 && insist > 0)
4041 f1 = SELECTED_FRAME ();
4043 if (f1)
4045 /* Ok, we found a frame. Store all the values.
4046 last_mouse_glyph is a rectangle used to reduce the
4047 generation of mouse events. To not miss any motion
4048 events, we must divide the frame into rectangles of the
4049 size of the smallest character that could be displayed
4050 on it, i.e. into the same rectangles that matrices on
4051 the frame are divided into. */
4053 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
4054 last_mouse_glyph_frame = f1;
4056 *bar_window = Qnil;
4057 *part = 0;
4058 *fp = f1;
4059 XSETINT (*x, win_x);
4060 XSETINT (*y, win_y);
4061 *timestamp = last_mouse_movement_time;
4066 UNBLOCK_INPUT;
4071 /***********************************************************************
4072 Scroll bars
4073 ***********************************************************************/
4075 /* Scroll bar support. */
4077 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
4078 manages it.
4079 This can be called in GC, so we have to make sure to strip off mark
4080 bits. */
4082 static struct scroll_bar *
4083 x_window_to_scroll_bar (Display *display, Window window_id)
4085 Lisp_Object tail;
4087 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
4088 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
4089 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
4091 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4093 Lisp_Object frame, bar, condemned;
4095 frame = XCAR (tail);
4096 /* All elements of Vframe_list should be frames. */
4097 if (! FRAMEP (frame))
4098 abort ();
4100 if (! FRAME_X_P (XFRAME (frame)))
4101 continue;
4103 /* Scan this frame's scroll bar list for a scroll bar with the
4104 right window ID. */
4105 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4106 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4107 /* This trick allows us to search both the ordinary and
4108 condemned scroll bar lists with one loop. */
4109 ! NILP (bar) || (bar = condemned,
4110 condemned = Qnil,
4111 ! NILP (bar));
4112 bar = XSCROLL_BAR (bar)->next)
4113 if (XSCROLL_BAR (bar)->x_window == window_id &&
4114 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4115 return XSCROLL_BAR (bar);
4118 return NULL;
4122 #if defined USE_LUCID
4124 /* Return the Lucid menu bar WINDOW is part of. Return null
4125 if WINDOW is not part of a menu bar. */
4127 static Widget
4128 x_window_to_menu_bar (Window window)
4130 Lisp_Object tail;
4132 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4134 if (FRAME_X_P (XFRAME (XCAR (tail))))
4136 Lisp_Object frame = XCAR (tail);
4137 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4139 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4140 return menu_bar;
4144 return NULL;
4147 #endif /* USE_LUCID */
4150 /************************************************************************
4151 Toolkit scroll bars
4152 ************************************************************************/
4154 #ifdef USE_TOOLKIT_SCROLL_BARS
4156 static void x_scroll_bar_to_input_event (XEvent *, struct input_event *);
4157 static void x_send_scroll_bar_event (Lisp_Object, int, int, int);
4158 static void x_create_toolkit_scroll_bar (struct frame *,
4159 struct scroll_bar *);
4160 static void x_set_toolkit_scroll_bar_thumb (struct scroll_bar *,
4161 int, int, int);
4164 /* Lisp window being scrolled. Set when starting to interact with
4165 a toolkit scroll bar, reset to nil when ending the interaction. */
4167 static Lisp_Object window_being_scrolled;
4169 /* Last scroll bar part sent in xm_scroll_callback. */
4171 static int last_scroll_bar_part;
4173 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4174 that movements of 1/20 of the screen size are mapped to up/down. */
4176 #ifndef USE_GTK
4177 /* Id of action hook installed for scroll bars. */
4179 static XtActionHookId action_hook_id;
4181 static Boolean xaw3d_arrow_scroll;
4183 /* Whether the drag scrolling maintains the mouse at the top of the
4184 thumb. If not, resizing the thumb needs to be done more carefully
4185 to avoid jerkiness. */
4187 static Boolean xaw3d_pick_top;
4189 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4190 bars are used.. The hook is responsible for detecting when
4191 the user ends an interaction with the scroll bar, and generates
4192 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4194 static void
4195 xt_action_hook (Widget widget, XtPointer client_data, String action_name,
4196 XEvent *event, String *params, Cardinal *num_params)
4198 int scroll_bar_p;
4199 const char *end_action;
4201 #ifdef USE_MOTIF
4202 scroll_bar_p = XmIsScrollBar (widget);
4203 end_action = "Release";
4204 #else /* !USE_MOTIF i.e. use Xaw */
4205 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4206 end_action = "EndScroll";
4207 #endif /* USE_MOTIF */
4209 if (scroll_bar_p
4210 && strcmp (action_name, end_action) == 0
4211 && WINDOWP (window_being_scrolled))
4213 struct window *w;
4215 x_send_scroll_bar_event (window_being_scrolled,
4216 scroll_bar_end_scroll, 0, 0);
4217 w = XWINDOW (window_being_scrolled);
4219 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4221 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4222 /* The thumb size is incorrect while dragging: fix it. */
4223 set_vertical_scroll_bar (w);
4225 window_being_scrolled = Qnil;
4226 last_scroll_bar_part = -1;
4228 /* Xt timeouts no longer needed. */
4229 toolkit_scroll_bar_interaction = 0;
4232 #endif /* not USE_GTK */
4234 /* A vector of windows used for communication between
4235 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4237 static struct window **scroll_bar_windows;
4238 static ptrdiff_t scroll_bar_windows_size;
4241 /* Send a client message with message type Xatom_Scrollbar for a
4242 scroll action to the frame of WINDOW. PART is a value identifying
4243 the part of the scroll bar that was clicked on. PORTION is the
4244 amount to scroll of a whole of WHOLE. */
4246 static void
4247 x_send_scroll_bar_event (Lisp_Object window, int part, int portion, int whole)
4249 XEvent event;
4250 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4251 struct window *w = XWINDOW (window);
4252 struct frame *f = XFRAME (w->frame);
4253 ptrdiff_t i;
4255 BLOCK_INPUT;
4257 /* Construct a ClientMessage event to send to the frame. */
4258 ev->type = ClientMessage;
4259 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4260 ev->display = FRAME_X_DISPLAY (f);
4261 ev->window = FRAME_X_WINDOW (f);
4262 ev->format = 32;
4264 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4265 not enough to store a pointer or Lisp_Object on a 64 bit system.
4266 So, store the window in scroll_bar_windows and pass the index
4267 into that array in the event. */
4268 for (i = 0; i < scroll_bar_windows_size; ++i)
4269 if (scroll_bar_windows[i] == NULL)
4270 break;
4272 if (i == scroll_bar_windows_size)
4274 ptrdiff_t old_nbytes =
4275 scroll_bar_windows_size * sizeof *scroll_bar_windows;
4276 ptrdiff_t nbytes;
4277 enum { XClientMessageEvent_MAX = 0x7fffffff };
4278 scroll_bar_windows =
4279 xpalloc (scroll_bar_windows, &scroll_bar_windows_size, 1,
4280 XClientMessageEvent_MAX, sizeof *scroll_bar_windows);
4281 nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4282 memset (&scroll_bar_windows[i], 0, nbytes - old_nbytes);
4285 scroll_bar_windows[i] = w;
4286 ev->data.l[0] = (long) i;
4287 ev->data.l[1] = (long) part;
4288 ev->data.l[2] = (long) 0;
4289 ev->data.l[3] = (long) portion;
4290 ev->data.l[4] = (long) whole;
4292 /* Make Xt timeouts work while the scroll bar is active. */
4293 #ifdef USE_X_TOOLKIT
4294 toolkit_scroll_bar_interaction = 1;
4295 x_activate_timeout_atimer ();
4296 #endif
4298 /* Setting the event mask to zero means that the message will
4299 be sent to the client that created the window, and if that
4300 window no longer exists, no event will be sent. */
4301 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4302 UNBLOCK_INPUT;
4306 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4307 in *IEVENT. */
4309 static void
4310 x_scroll_bar_to_input_event (XEvent *event, struct input_event *ievent)
4312 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4313 Lisp_Object window;
4314 struct window *w;
4316 w = scroll_bar_windows[ev->data.l[0]];
4317 scroll_bar_windows[ev->data.l[0]] = NULL;
4319 XSETWINDOW (window, w);
4321 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4322 ievent->frame_or_window = window;
4323 ievent->arg = Qnil;
4324 #ifdef USE_GTK
4325 ievent->timestamp = CurrentTime;
4326 #else
4327 ievent->timestamp =
4328 XtLastTimestampProcessed (FRAME_X_DISPLAY (XFRAME (w->frame)));
4329 #endif
4330 ievent->part = ev->data.l[1];
4331 ievent->code = ev->data.l[2];
4332 ievent->x = make_number ((int) ev->data.l[3]);
4333 ievent->y = make_number ((int) ev->data.l[4]);
4334 ievent->modifiers = 0;
4338 #ifdef USE_MOTIF
4340 /* Minimum and maximum values used for Motif scroll bars. */
4342 #define XM_SB_MAX 10000000
4345 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4346 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4347 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4349 static void
4350 xm_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4352 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4353 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4354 int part = -1, whole = 0, portion = 0;
4356 switch (cs->reason)
4358 case XmCR_DECREMENT:
4359 bar->dragging = Qnil;
4360 part = scroll_bar_up_arrow;
4361 break;
4363 case XmCR_INCREMENT:
4364 bar->dragging = Qnil;
4365 part = scroll_bar_down_arrow;
4366 break;
4368 case XmCR_PAGE_DECREMENT:
4369 bar->dragging = Qnil;
4370 part = scroll_bar_above_handle;
4371 break;
4373 case XmCR_PAGE_INCREMENT:
4374 bar->dragging = Qnil;
4375 part = scroll_bar_below_handle;
4376 break;
4378 case XmCR_TO_TOP:
4379 bar->dragging = Qnil;
4380 part = scroll_bar_to_top;
4381 break;
4383 case XmCR_TO_BOTTOM:
4384 bar->dragging = Qnil;
4385 part = scroll_bar_to_bottom;
4386 break;
4388 case XmCR_DRAG:
4390 int slider_size;
4392 /* Get the slider size. */
4393 BLOCK_INPUT;
4394 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4395 UNBLOCK_INPUT;
4397 whole = XM_SB_MAX - slider_size;
4398 portion = min (cs->value, whole);
4399 part = scroll_bar_handle;
4400 bar->dragging = make_number (cs->value);
4402 break;
4404 case XmCR_VALUE_CHANGED:
4405 break;
4408 if (part >= 0)
4410 window_being_scrolled = bar->window;
4411 last_scroll_bar_part = part;
4412 x_send_scroll_bar_event (bar->window, part, portion, whole);
4416 #elif defined USE_GTK
4418 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4419 bar widget. DATA is a pointer to the scroll_bar structure. */
4421 static gboolean
4422 xg_scroll_callback (GtkRange *range,
4423 GtkScrollType scroll,
4424 gdouble value,
4425 gpointer user_data)
4427 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4428 gdouble position;
4429 int part = -1, whole = 0, portion = 0;
4430 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (range));
4431 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (range), XG_FRAME_DATA);
4433 if (xg_ignore_gtk_scrollbar) return FALSE;
4434 position = gtk_adjustment_get_value (adj);
4437 switch (scroll)
4439 case GTK_SCROLL_JUMP:
4440 /* Buttons 1 2 or 3 must be grabbed. */
4441 if (FRAME_X_DISPLAY_INFO (f)->grabbed != 0
4442 && FRAME_X_DISPLAY_INFO (f)->grabbed < (1 << 4))
4444 part = scroll_bar_handle;
4445 whole = gtk_adjustment_get_upper (adj) -
4446 gtk_adjustment_get_page_size (adj);
4447 portion = min ((int)position, whole);
4448 bar->dragging = make_number ((int)portion);
4450 break;
4451 case GTK_SCROLL_STEP_BACKWARD:
4452 part = scroll_bar_up_arrow;
4453 bar->dragging = Qnil;
4454 break;
4455 case GTK_SCROLL_STEP_FORWARD:
4456 part = scroll_bar_down_arrow;
4457 bar->dragging = Qnil;
4458 break;
4459 case GTK_SCROLL_PAGE_BACKWARD:
4460 part = scroll_bar_above_handle;
4461 bar->dragging = Qnil;
4462 break;
4463 case GTK_SCROLL_PAGE_FORWARD:
4464 part = scroll_bar_below_handle;
4465 bar->dragging = Qnil;
4466 break;
4469 if (part >= 0)
4471 window_being_scrolled = bar->window;
4472 last_scroll_bar_part = part;
4473 x_send_scroll_bar_event (bar->window, part, portion, whole);
4476 return FALSE;
4479 /* Callback for button release. Sets dragging to Qnil when dragging is done. */
4481 static gboolean
4482 xg_end_scroll_callback (GtkWidget *widget,
4483 GdkEventButton *event,
4484 gpointer user_data)
4486 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4487 bar->dragging = Qnil;
4488 if (WINDOWP (window_being_scrolled))
4490 x_send_scroll_bar_event (window_being_scrolled,
4491 scroll_bar_end_scroll, 0, 0);
4492 window_being_scrolled = Qnil;
4495 return FALSE;
4499 #else /* not USE_GTK and not USE_MOTIF */
4501 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4502 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4503 scroll bar struct. CALL_DATA is a pointer to a float saying where
4504 the thumb is. */
4506 static void
4507 xaw_jump_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4509 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4510 float top = *(float *) call_data;
4511 float shown;
4512 int whole, portion, height;
4513 int part;
4515 /* Get the size of the thumb, a value between 0 and 1. */
4516 BLOCK_INPUT;
4517 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4518 UNBLOCK_INPUT;
4520 whole = 10000000;
4521 portion = shown < 1 ? top * whole : 0;
4523 if (shown < 1 && (eabs (top + shown - 1) < 1.0/height))
4524 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4525 the bottom, so we force the scrolling whenever we see that we're
4526 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4527 we try to ensure that we always stay two pixels away from the
4528 bottom). */
4529 part = scroll_bar_down_arrow;
4530 else
4531 part = scroll_bar_handle;
4533 window_being_scrolled = bar->window;
4534 bar->dragging = make_number (portion);
4535 last_scroll_bar_part = part;
4536 x_send_scroll_bar_event (bar->window, part, portion, whole);
4540 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4541 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4542 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4543 the scroll bar. CALL_DATA is an integer specifying the action that
4544 has taken place. Its magnitude is in the range 0..height of the
4545 scroll bar. Negative values mean scroll towards buffer start.
4546 Values < height of scroll bar mean line-wise movement. */
4548 static void
4549 xaw_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
4551 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4552 /* The position really is stored cast to a pointer. */
4553 int position = (long) call_data;
4554 Dimension height;
4555 int part;
4557 /* Get the height of the scroll bar. */
4558 BLOCK_INPUT;
4559 XtVaGetValues (widget, XtNheight, &height, NULL);
4560 UNBLOCK_INPUT;
4562 if (eabs (position) >= height)
4563 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4565 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4566 it maps line-movement to call_data = max(5, height/20). */
4567 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4568 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4569 else
4570 part = scroll_bar_move_ratio;
4572 window_being_scrolled = bar->window;
4573 bar->dragging = Qnil;
4574 last_scroll_bar_part = part;
4575 x_send_scroll_bar_event (bar->window, part, position, height);
4578 #endif /* not USE_GTK and not USE_MOTIF */
4580 #define SCROLL_BAR_NAME "verticalScrollBar"
4582 /* Create the widget for scroll bar BAR on frame F. Record the widget
4583 and X window of the scroll bar in BAR. */
4585 #ifdef USE_GTK
4586 static void
4587 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4589 const char *scroll_bar_name = SCROLL_BAR_NAME;
4591 BLOCK_INPUT;
4592 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4593 G_CALLBACK (xg_end_scroll_callback),
4594 scroll_bar_name);
4595 UNBLOCK_INPUT;
4598 #else /* not USE_GTK */
4600 static void
4601 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
4603 Window xwindow;
4604 Widget widget;
4605 Arg av[20];
4606 int ac = 0;
4607 char const *scroll_bar_name = SCROLL_BAR_NAME;
4608 unsigned long pixel;
4610 BLOCK_INPUT;
4612 #ifdef USE_MOTIF
4613 /* Set resources. Create the widget. */
4614 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4615 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4616 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4617 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4618 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4619 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4620 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4622 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4623 if (pixel != -1)
4625 XtSetArg (av[ac], XmNforeground, pixel);
4626 ++ac;
4629 pixel = f->output_data.x->scroll_bar_background_pixel;
4630 if (pixel != -1)
4632 XtSetArg (av[ac], XmNbackground, pixel);
4633 ++ac;
4636 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4637 scroll_bar_name, av, ac);
4639 /* Add one callback for everything that can happen. */
4640 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4641 (XtPointer) bar);
4642 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4643 (XtPointer) bar);
4644 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4645 (XtPointer) bar);
4646 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4647 (XtPointer) bar);
4648 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4649 (XtPointer) bar);
4650 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4651 (XtPointer) bar);
4652 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4653 (XtPointer) bar);
4655 /* Realize the widget. Only after that is the X window created. */
4656 XtRealizeWidget (widget);
4658 /* Set the cursor to an arrow. I didn't find a resource to do that.
4659 And I'm wondering why it hasn't an arrow cursor by default. */
4660 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4661 f->output_data.x->nontext_cursor);
4663 #else /* !USE_MOTIF i.e. use Xaw */
4665 /* Set resources. Create the widget. The background of the
4666 Xaw3d scroll bar widget is a little bit light for my taste.
4667 We don't alter it here to let users change it according
4668 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4669 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4670 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4671 /* For smoother scrolling with Xaw3d -sm */
4672 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4674 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4675 if (pixel != -1)
4677 XtSetArg (av[ac], XtNforeground, pixel);
4678 ++ac;
4681 pixel = f->output_data.x->scroll_bar_background_pixel;
4682 if (pixel != -1)
4684 XtSetArg (av[ac], XtNbackground, pixel);
4685 ++ac;
4688 /* Top/bottom shadow colors. */
4690 /* Allocate them, if necessary. */
4691 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4693 pixel = f->output_data.x->scroll_bar_background_pixel;
4694 if (pixel != -1)
4696 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4697 FRAME_X_COLORMAP (f),
4698 &pixel, 1.2, 0x8000))
4699 pixel = -1;
4700 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4703 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4705 pixel = f->output_data.x->scroll_bar_background_pixel;
4706 if (pixel != -1)
4708 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4709 FRAME_X_COLORMAP (f),
4710 &pixel, 0.6, 0x4000))
4711 pixel = -1;
4712 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4716 #ifdef XtNbeNiceToColormap
4717 /* Tell the toolkit about them. */
4718 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4719 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4720 /* We tried to allocate a color for the top/bottom shadow, and
4721 failed, so tell Xaw3d to use dithering instead. */
4722 /* But only if we have a small colormap. Xaw3d can allocate nice
4723 colors itself. */
4725 XtSetArg (av[ac], XtNbeNiceToColormap,
4726 DefaultDepthOfScreen (FRAME_X_SCREEN (f)) < 16);
4727 ++ac;
4729 else
4730 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4731 be more consistent with other emacs 3d colors, and since Xaw3d is
4732 not good at dealing with allocation failure. */
4734 /* This tells Xaw3d to use real colors instead of dithering for
4735 the shadows. */
4736 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4737 ++ac;
4739 /* Specify the colors. */
4740 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4741 if (pixel != -1)
4743 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4744 ++ac;
4746 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4747 if (pixel != -1)
4749 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4750 ++ac;
4753 #endif
4755 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4756 f->output_data.x->edit_widget, av, ac);
4759 char const *initial = "";
4760 char const *val = initial;
4761 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4762 #ifdef XtNarrowScrollbars
4763 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4764 #endif
4765 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4766 if (xaw3d_arrow_scroll || val == initial)
4767 { /* ARROW_SCROLL */
4768 xaw3d_arrow_scroll = True;
4769 /* Isn't that just a personal preference ? --Stef */
4770 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4774 /* Define callbacks. */
4775 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4776 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4777 (XtPointer) bar);
4779 /* Realize the widget. Only after that is the X window created. */
4780 XtRealizeWidget (widget);
4782 #endif /* !USE_MOTIF */
4784 /* Install an action hook that lets us detect when the user
4785 finishes interacting with a scroll bar. */
4786 if (action_hook_id == 0)
4787 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4789 /* Remember X window and widget in the scroll bar vector. */
4790 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4791 xwindow = XtWindow (widget);
4792 bar->x_window = xwindow;
4794 UNBLOCK_INPUT;
4796 #endif /* not USE_GTK */
4799 /* Set the thumb size and position of scroll bar BAR. We are currently
4800 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4802 #ifdef USE_GTK
4803 static void
4804 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position, int whole)
4806 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4809 #else /* not USE_GTK */
4810 static void
4811 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position,
4812 int whole)
4814 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4815 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4816 float top, shown;
4818 BLOCK_INPUT;
4820 #ifdef USE_MOTIF
4822 /* We use an estimate of 30 chars per line rather than the real
4823 `portion' value. This has the disadvantage that the thumb size
4824 is not very representative, but it makes our life a lot easier.
4825 Otherwise, we have to constantly adjust the thumb size, which
4826 we can't always do quickly enough: while dragging, the size of
4827 the thumb might prevent the user from dragging the thumb all the
4828 way to the end. but Motif and some versions of Xaw3d don't allow
4829 updating the thumb size while dragging. Also, even if we can update
4830 its size, the update will often happen too late.
4831 If you don't believe it, check out revision 1.650 of xterm.c to see
4832 what hoops we were going through and the still poor behavior we got. */
4833 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4834 /* When the thumb is at the bottom, position == whole.
4835 So we need to increase `whole' to make space for the thumb. */
4836 whole += portion;
4838 if (whole <= 0)
4839 top = 0, shown = 1;
4840 else
4842 top = (float) position / whole;
4843 shown = (float) portion / whole;
4846 if (NILP (bar->dragging))
4848 int size, value;
4850 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4851 is the scroll bar's maximum and MIN is the scroll bar's minimum
4852 value. */
4853 size = shown * XM_SB_MAX;
4854 size = min (size, XM_SB_MAX);
4855 size = max (size, 1);
4857 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4858 value = top * XM_SB_MAX;
4859 value = min (value, XM_SB_MAX - size);
4861 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4863 #else /* !USE_MOTIF i.e. use Xaw */
4865 if (whole == 0)
4866 top = 0, shown = 1;
4867 else
4869 top = (float) position / whole;
4870 shown = (float) portion / whole;
4874 float old_top, old_shown;
4875 Dimension height;
4876 XtVaGetValues (widget,
4877 XtNtopOfThumb, &old_top,
4878 XtNshown, &old_shown,
4879 XtNheight, &height,
4880 NULL);
4882 /* Massage the top+shown values. */
4883 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4884 top = max (0, min (1, top));
4885 else
4886 top = old_top;
4887 /* Keep two pixels available for moving the thumb down. */
4888 shown = max (0, min (1 - top - (2.0 / height), shown));
4890 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4891 check that your system's configuration file contains a define
4892 for `NARROWPROTO'. See s/freebsd.h for an example. */
4893 if (top != old_top || shown != old_shown)
4895 if (NILP (bar->dragging))
4896 XawScrollbarSetThumb (widget, top, shown);
4897 else
4899 /* Try to make the scrolling a tad smoother. */
4900 if (!xaw3d_pick_top)
4901 shown = min (shown, old_shown);
4903 XawScrollbarSetThumb (widget, top, shown);
4907 #endif /* !USE_MOTIF */
4909 UNBLOCK_INPUT;
4911 #endif /* not USE_GTK */
4913 #endif /* USE_TOOLKIT_SCROLL_BARS */
4917 /************************************************************************
4918 Scroll bars, general
4919 ************************************************************************/
4921 /* Create a scroll bar and return the scroll bar vector for it. W is
4922 the Emacs window on which to create the scroll bar. TOP, LEFT,
4923 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4924 scroll bar. */
4926 static struct scroll_bar *
4927 x_scroll_bar_create (struct window *w, int top, int left, int width, int height)
4929 struct frame *f = XFRAME (w->frame);
4930 struct scroll_bar *bar
4931 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4933 BLOCK_INPUT;
4935 #ifdef USE_TOOLKIT_SCROLL_BARS
4936 x_create_toolkit_scroll_bar (f, bar);
4937 #else /* not USE_TOOLKIT_SCROLL_BARS */
4939 XSetWindowAttributes a;
4940 unsigned long mask;
4941 Window window;
4943 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4944 if (a.background_pixel == -1)
4945 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4947 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4948 | ButtonMotionMask | PointerMotionHintMask
4949 | ExposureMask);
4950 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4952 mask = (CWBackPixel | CWEventMask | CWCursor);
4954 /* Clear the area of W that will serve as a scroll bar. This is
4955 for the case that a window has been split horizontally. In
4956 this case, no clear_frame is generated to reduce flickering. */
4957 if (width > 0 && height > 0)
4958 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4959 left, top, width,
4960 window_box_height (w), False);
4962 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4963 /* Position and size of scroll bar. */
4964 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4965 top,
4966 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4967 height,
4968 /* Border width, depth, class, and visual. */
4970 CopyFromParent,
4971 CopyFromParent,
4972 CopyFromParent,
4973 /* Attributes. */
4974 mask, &a);
4975 bar->x_window = window;
4977 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4979 XSETWINDOW (bar->window, w);
4980 bar->top = top;
4981 bar->left = left;
4982 bar->width = width;
4983 bar->height = height;
4984 bar->start = 0;
4985 bar->end = 0;
4986 bar->dragging = Qnil;
4987 bar->fringe_extended_p = 0;
4989 /* Add bar to its frame's list of scroll bars. */
4990 bar->next = FRAME_SCROLL_BARS (f);
4991 bar->prev = Qnil;
4992 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4993 if (!NILP (bar->next))
4994 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4996 /* Map the window/widget. */
4997 #ifdef USE_TOOLKIT_SCROLL_BARS
4999 #ifdef USE_GTK
5000 xg_update_scrollbar_pos (f,
5001 bar->x_window,
5002 top,
5003 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5004 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5005 max (height, 1));
5006 #else /* not USE_GTK */
5007 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
5008 XtConfigureWidget (scroll_bar,
5009 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5010 top,
5011 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5012 max (height, 1), 0);
5013 XtMapWidget (scroll_bar);
5014 #endif /* not USE_GTK */
5016 #else /* not USE_TOOLKIT_SCROLL_BARS */
5017 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
5018 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5020 UNBLOCK_INPUT;
5021 return bar;
5025 #ifndef USE_TOOLKIT_SCROLL_BARS
5027 /* Draw BAR's handle in the proper position.
5029 If the handle is already drawn from START to END, don't bother
5030 redrawing it, unless REBUILD is non-zero; in that case, always
5031 redraw it. (REBUILD is handy for drawing the handle after expose
5032 events.)
5034 Normally, we want to constrain the start and end of the handle to
5035 fit inside its rectangle, but if the user is dragging the scroll
5036 bar handle, we want to let them drag it down all the way, so that
5037 the bar's top is as far down as it goes; otherwise, there's no way
5038 to move to the very end of the buffer. */
5040 static void
5041 x_scroll_bar_set_handle (struct scroll_bar *bar, int start, int end, int rebuild)
5043 int dragging = ! NILP (bar->dragging);
5044 Window w = bar->x_window;
5045 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5046 GC gc = f->output_data.x->normal_gc;
5048 /* If the display is already accurate, do nothing. */
5049 if (! rebuild
5050 && start == bar->start
5051 && end == bar->end)
5052 return;
5054 BLOCK_INPUT;
5057 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
5058 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5059 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5061 /* Make sure the values are reasonable, and try to preserve
5062 the distance between start and end. */
5064 int length = end - start;
5066 if (start < 0)
5067 start = 0;
5068 else if (start > top_range)
5069 start = top_range;
5070 end = start + length;
5072 if (end < start)
5073 end = start;
5074 else if (end > top_range && ! dragging)
5075 end = top_range;
5078 /* Store the adjusted setting in the scroll bar. */
5079 bar->start = start;
5080 bar->end = end;
5082 /* Clip the end position, just for display. */
5083 if (end > top_range)
5084 end = top_range;
5086 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
5087 below top positions, to make sure the handle is always at least
5088 that many pixels tall. */
5089 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
5091 /* Draw the empty space above the handle. Note that we can't clear
5092 zero-height areas; that means "clear to end of window." */
5093 if (0 < start)
5094 x_clear_area (FRAME_X_DISPLAY (f), w,
5095 /* x, y, width, height, and exposures. */
5096 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5097 VERTICAL_SCROLL_BAR_TOP_BORDER,
5098 inside_width, start,
5099 False);
5101 /* Change to proper foreground color if one is specified. */
5102 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5103 XSetForeground (FRAME_X_DISPLAY (f), gc,
5104 f->output_data.x->scroll_bar_foreground_pixel);
5106 /* Draw the handle itself. */
5107 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5108 /* x, y, width, height */
5109 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5110 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5111 inside_width, end - start);
5113 /* Restore the foreground color of the GC if we changed it above. */
5114 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5115 XSetForeground (FRAME_X_DISPLAY (f), gc,
5116 FRAME_FOREGROUND_PIXEL (f));
5118 /* Draw the empty space below the handle. Note that we can't
5119 clear zero-height areas; that means "clear to end of window." */
5120 if (end < inside_height)
5121 x_clear_area (FRAME_X_DISPLAY (f), w,
5122 /* x, y, width, height, and exposures. */
5123 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5124 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5125 inside_width, inside_height - end,
5126 False);
5130 UNBLOCK_INPUT;
5133 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5135 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5136 nil. */
5138 static void
5139 x_scroll_bar_remove (struct scroll_bar *bar)
5141 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5142 BLOCK_INPUT;
5144 #ifdef USE_TOOLKIT_SCROLL_BARS
5145 #ifdef USE_GTK
5146 xg_remove_scroll_bar (f, bar->x_window);
5147 #else /* not USE_GTK */
5148 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5149 #endif /* not USE_GTK */
5150 #else
5151 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5152 #endif
5154 /* Disassociate this scroll bar from its window. */
5155 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
5157 UNBLOCK_INPUT;
5161 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5162 that we are displaying PORTION characters out of a total of WHOLE
5163 characters, starting at POSITION. If WINDOW has no scroll bar,
5164 create one. */
5166 static void
5167 XTset_vertical_scroll_bar (struct window *w, int portion, int whole, int position)
5169 struct frame *f = XFRAME (w->frame);
5170 struct scroll_bar *bar;
5171 int top, height, left, sb_left, width, sb_width;
5172 int window_y, window_height;
5173 #ifdef USE_TOOLKIT_SCROLL_BARS
5174 int fringe_extended_p;
5175 #endif
5177 /* Get window dimensions. */
5178 window_box (w, -1, 0, &window_y, 0, &window_height);
5179 top = window_y;
5180 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5181 height = window_height;
5183 /* Compute the left edge of the scroll bar area. */
5184 left = WINDOW_SCROLL_BAR_AREA_X (w);
5186 /* Compute the width of the scroll bar which might be less than
5187 the width of the area reserved for the scroll bar. */
5188 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5189 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5190 else
5191 sb_width = width;
5193 /* Compute the left edge of the scroll bar. */
5194 #ifdef USE_TOOLKIT_SCROLL_BARS
5195 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5196 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5197 else
5198 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5199 #else
5200 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5201 sb_left = left + width - sb_width;
5202 else
5203 sb_left = left;
5204 #endif
5206 #ifdef USE_TOOLKIT_SCROLL_BARS
5207 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5208 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5209 && WINDOW_LEFT_FRINGE_WIDTH (w)
5210 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5211 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5212 else
5213 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5214 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5215 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5216 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5217 #endif
5219 /* Does the scroll bar exist yet? */
5220 if (NILP (w->vertical_scroll_bar))
5222 if (width > 0 && height > 0)
5224 BLOCK_INPUT;
5225 #ifdef USE_TOOLKIT_SCROLL_BARS
5226 if (fringe_extended_p)
5227 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5228 sb_left, top, sb_width, height, False);
5229 else
5230 #endif
5231 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5232 left, top, width, height, False);
5233 UNBLOCK_INPUT;
5236 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5238 else
5240 /* It may just need to be moved and resized. */
5241 unsigned int mask = 0;
5243 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5245 BLOCK_INPUT;
5247 if (sb_left != bar->left)
5248 mask |= CWX;
5249 if (top != bar->top)
5250 mask |= CWY;
5251 if (sb_width != bar->width)
5252 mask |= CWWidth;
5253 if (height != bar->height)
5254 mask |= CWHeight;
5256 #ifdef USE_TOOLKIT_SCROLL_BARS
5258 /* Move/size the scroll bar widget. */
5259 if (mask || bar->fringe_extended_p != fringe_extended_p)
5261 /* Since toolkit scroll bars are smaller than the space reserved
5262 for them on the frame, we have to clear "under" them. */
5263 if (width > 0 && height > 0)
5265 if (fringe_extended_p)
5266 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5267 sb_left, top, sb_width, height, False);
5268 else
5269 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5270 left, top, width, height, False);
5272 #ifdef USE_GTK
5273 xg_update_scrollbar_pos (f,
5274 bar->x_window,
5275 top,
5276 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5277 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5278 max (height, 1));
5279 #else /* not USE_GTK */
5280 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5281 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5282 top,
5283 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5284 max (height, 1), 0);
5285 #endif /* not USE_GTK */
5287 #else /* not USE_TOOLKIT_SCROLL_BARS */
5289 /* Clear areas not covered by the scroll bar because of
5290 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5291 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5293 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5294 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5295 height, False);
5296 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5297 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5298 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5299 height, False);
5302 /* Clear areas not covered by the scroll bar because it's not as
5303 wide as the area reserved for it. This makes sure a
5304 previous mode line display is cleared after C-x 2 C-x 1, for
5305 example. */
5307 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5308 int rest = area_width - sb_width;
5309 if (rest > 0 && height > 0)
5311 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5312 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5313 left + area_width - rest, top,
5314 rest, height, False);
5315 else
5316 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5317 left, top, rest, height, False);
5321 /* Move/size the scroll bar window. */
5322 if (mask)
5324 XWindowChanges wc;
5326 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5327 wc.y = top;
5328 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5329 wc.height = height;
5330 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5331 mask, &wc);
5334 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5336 /* Remember new settings. */
5337 bar->left = sb_left;
5338 bar->top = top;
5339 bar->width = sb_width;
5340 bar->height = height;
5342 UNBLOCK_INPUT;
5345 #ifdef USE_TOOLKIT_SCROLL_BARS
5346 bar->fringe_extended_p = fringe_extended_p;
5348 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5349 #else /* not USE_TOOLKIT_SCROLL_BARS */
5350 /* Set the scroll bar's current state, unless we're currently being
5351 dragged. */
5352 if (NILP (bar->dragging))
5354 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5356 if (whole == 0)
5357 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5358 else
5360 int start = ((double) position * top_range) / whole;
5361 int end = ((double) (position + portion) * top_range) / whole;
5362 x_scroll_bar_set_handle (bar, start, end, 0);
5365 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5367 XSETVECTOR (w->vertical_scroll_bar, bar);
5371 /* The following three hooks are used when we're doing a thorough
5372 redisplay of the frame. We don't explicitly know which scroll bars
5373 are going to be deleted, because keeping track of when windows go
5374 away is a real pain - "Can you say set-window-configuration, boys
5375 and girls?" Instead, we just assert at the beginning of redisplay
5376 that *all* scroll bars are to be removed, and then save a scroll bar
5377 from the fiery pit when we actually redisplay its window. */
5379 /* Arrange for all scroll bars on FRAME to be removed at the next call
5380 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5381 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5383 static void
5384 XTcondemn_scroll_bars (FRAME_PTR frame)
5386 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5387 while (! NILP (FRAME_SCROLL_BARS (frame)))
5389 Lisp_Object bar;
5390 bar = FRAME_SCROLL_BARS (frame);
5391 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5392 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5393 XSCROLL_BAR (bar)->prev = Qnil;
5394 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5395 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5396 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5401 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5402 Note that WINDOW isn't necessarily condemned at all. */
5404 static void
5405 XTredeem_scroll_bar (struct window *window)
5407 struct scroll_bar *bar;
5408 struct frame *f;
5410 /* We can't redeem this window's scroll bar if it doesn't have one. */
5411 if (NILP (window->vertical_scroll_bar))
5412 abort ();
5414 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5416 /* Unlink it from the condemned list. */
5417 f = XFRAME (WINDOW_FRAME (window));
5418 if (NILP (bar->prev))
5420 /* If the prev pointer is nil, it must be the first in one of
5421 the lists. */
5422 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5423 /* It's not condemned. Everything's fine. */
5424 return;
5425 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5426 window->vertical_scroll_bar))
5427 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5428 else
5429 /* If its prev pointer is nil, it must be at the front of
5430 one or the other! */
5431 abort ();
5433 else
5434 XSCROLL_BAR (bar->prev)->next = bar->next;
5436 if (! NILP (bar->next))
5437 XSCROLL_BAR (bar->next)->prev = bar->prev;
5439 bar->next = FRAME_SCROLL_BARS (f);
5440 bar->prev = Qnil;
5441 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5442 if (! NILP (bar->next))
5443 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5446 /* Remove all scroll bars on FRAME that haven't been saved since the
5447 last call to `*condemn_scroll_bars_hook'. */
5449 static void
5450 XTjudge_scroll_bars (FRAME_PTR f)
5452 Lisp_Object bar, next;
5454 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5456 /* Clear out the condemned list now so we won't try to process any
5457 more events on the hapless scroll bars. */
5458 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5460 for (; ! NILP (bar); bar = next)
5462 struct scroll_bar *b = XSCROLL_BAR (bar);
5464 x_scroll_bar_remove (b);
5466 next = b->next;
5467 b->next = b->prev = Qnil;
5470 /* Now there should be no references to the condemned scroll bars,
5471 and they should get garbage-collected. */
5475 #ifndef USE_TOOLKIT_SCROLL_BARS
5476 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5477 is a no-op when using toolkit scroll bars.
5479 This may be called from a signal handler, so we have to ignore GC
5480 mark bits. */
5482 static void
5483 x_scroll_bar_expose (struct scroll_bar *bar, XEvent *event)
5485 Window w = bar->x_window;
5486 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5487 GC gc = f->output_data.x->normal_gc;
5488 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5490 BLOCK_INPUT;
5492 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5494 /* Switch to scroll bar foreground color. */
5495 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5496 XSetForeground (FRAME_X_DISPLAY (f), gc,
5497 f->output_data.x->scroll_bar_foreground_pixel);
5499 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5500 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5502 /* x, y, width, height */
5503 0, 0,
5504 bar->width - 1 - width_trim - width_trim,
5505 bar->height - 1);
5507 /* Restore the foreground color of the GC if we changed it above. */
5508 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5509 XSetForeground (FRAME_X_DISPLAY (f), gc,
5510 FRAME_FOREGROUND_PIXEL (f));
5512 UNBLOCK_INPUT;
5515 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5517 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5518 is set to something other than NO_EVENT, it is enqueued.
5520 This may be called from a signal handler, so we have to ignore GC
5521 mark bits. */
5524 static void
5525 x_scroll_bar_handle_click (struct scroll_bar *bar, XEvent *event, struct input_event *emacs_event)
5527 if (! WINDOWP (bar->window))
5528 abort ();
5530 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5531 emacs_event->code = event->xbutton.button - Button1;
5532 emacs_event->modifiers
5533 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5534 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5535 event->xbutton.state)
5536 | (event->type == ButtonRelease
5537 ? up_modifier
5538 : down_modifier));
5539 emacs_event->frame_or_window = bar->window;
5540 emacs_event->arg = Qnil;
5541 emacs_event->timestamp = event->xbutton.time;
5543 int top_range
5544 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5545 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5547 if (y < 0) y = 0;
5548 if (y > top_range) y = top_range;
5550 if (y < bar->start)
5551 emacs_event->part = scroll_bar_above_handle;
5552 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5553 emacs_event->part = scroll_bar_handle;
5554 else
5555 emacs_event->part = scroll_bar_below_handle;
5557 #ifndef USE_TOOLKIT_SCROLL_BARS
5558 /* If the user has released the handle, set it to its final position. */
5559 if (event->type == ButtonRelease
5560 && ! NILP (bar->dragging))
5562 int new_start = y - XINT (bar->dragging);
5563 int new_end = new_start + bar->end - bar->start;
5565 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5566 bar->dragging = Qnil;
5568 #endif
5570 XSETINT (emacs_event->x, y);
5571 XSETINT (emacs_event->y, top_range);
5575 #ifndef USE_TOOLKIT_SCROLL_BARS
5577 /* Handle some mouse motion while someone is dragging the scroll bar.
5579 This may be called from a signal handler, so we have to ignore GC
5580 mark bits. */
5582 static void
5583 x_scroll_bar_note_movement (struct scroll_bar *bar, XEvent *event)
5585 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5587 last_mouse_movement_time = event->xmotion.time;
5589 f->mouse_moved = 1;
5590 XSETVECTOR (last_mouse_scroll_bar, bar);
5592 /* If we're dragging the bar, display it. */
5593 if (! NILP (bar->dragging))
5595 /* Where should the handle be now? */
5596 int new_start = event->xmotion.y - XINT (bar->dragging);
5598 if (new_start != bar->start)
5600 int new_end = new_start + bar->end - bar->start;
5602 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5607 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5609 /* Return information to the user about the current position of the mouse
5610 on the scroll bar. */
5612 static void
5613 x_scroll_bar_report_motion (FRAME_PTR *fp, Lisp_Object *bar_window,
5614 enum scroll_bar_part *part, Lisp_Object *x,
5615 Lisp_Object *y, Time *timestamp)
5617 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5618 Window w = bar->x_window;
5619 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5620 int win_x, win_y;
5621 Window dummy_window;
5622 int dummy_coord;
5623 unsigned int dummy_mask;
5625 BLOCK_INPUT;
5627 /* Get the mouse's position relative to the scroll bar window, and
5628 report that. */
5629 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5631 /* Root, child, root x and root y. */
5632 &dummy_window, &dummy_window,
5633 &dummy_coord, &dummy_coord,
5635 /* Position relative to scroll bar. */
5636 &win_x, &win_y,
5638 /* Mouse buttons and modifier keys. */
5639 &dummy_mask))
5641 else
5643 int top_range
5644 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5646 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5648 if (! NILP (bar->dragging))
5649 win_y -= XINT (bar->dragging);
5651 if (win_y < 0)
5652 win_y = 0;
5653 if (win_y > top_range)
5654 win_y = top_range;
5656 *fp = f;
5657 *bar_window = bar->window;
5659 if (! NILP (bar->dragging))
5660 *part = scroll_bar_handle;
5661 else if (win_y < bar->start)
5662 *part = scroll_bar_above_handle;
5663 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5664 *part = scroll_bar_handle;
5665 else
5666 *part = scroll_bar_below_handle;
5668 XSETINT (*x, win_y);
5669 XSETINT (*y, top_range);
5671 f->mouse_moved = 0;
5672 last_mouse_scroll_bar = Qnil;
5675 *timestamp = last_mouse_movement_time;
5677 UNBLOCK_INPUT;
5681 /* The screen has been cleared so we may have changed foreground or
5682 background colors, and the scroll bars may need to be redrawn.
5683 Clear out the scroll bars, and ask for expose events, so we can
5684 redraw them. */
5686 static void
5687 x_scroll_bar_clear (FRAME_PTR f)
5689 #ifndef USE_TOOLKIT_SCROLL_BARS
5690 Lisp_Object bar;
5692 /* We can have scroll bars even if this is 0,
5693 if we just turned off scroll bar mode.
5694 But in that case we should not clear them. */
5695 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5696 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5697 bar = XSCROLL_BAR (bar)->next)
5698 XClearArea (FRAME_X_DISPLAY (f),
5699 XSCROLL_BAR (bar)->x_window,
5700 0, 0, 0, 0, True);
5701 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5705 /* The main X event-reading loop - XTread_socket. */
5707 /* This holds the state XLookupString needs to implement dead keys
5708 and other tricks known as "compose processing". _X Window System_
5709 says that a portable program can't use this, but Stephen Gildea assures
5710 me that letting the compiler initialize it to zeros will work okay.
5712 This must be defined outside of XTread_socket, for the same reasons
5713 given for enter_timestamp, above. */
5715 static XComposeStatus compose_status;
5717 /* Record the last 100 characters stored
5718 to help debug the loss-of-chars-during-GC problem. */
5720 static int temp_index;
5721 static short temp_buffer[100];
5723 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5724 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5725 temp_index = 0; \
5726 temp_buffer[temp_index++] = (keysym)
5728 /* Set this to nonzero to fake an "X I/O error"
5729 on a particular display. */
5731 static struct x_display_info *XTread_socket_fake_io_error;
5733 /* When we find no input here, we occasionally do a no-op command
5734 to verify that the X server is still running and we can still talk with it.
5735 We try all the open displays, one by one.
5736 This variable is used for cycling thru the displays. */
5738 static struct x_display_info *next_noop_dpyinfo;
5740 #if defined USE_X_TOOLKIT || defined USE_GTK
5741 #define SET_SAVED_BUTTON_EVENT \
5742 do \
5744 if (f->output_data.x->saved_menu_event == 0) \
5745 f->output_data.x->saved_menu_event \
5746 = (XEvent *) xmalloc (sizeof (XEvent)); \
5747 *f->output_data.x->saved_menu_event = event; \
5748 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5749 XSETFRAME (inev.ie.frame_or_window, f); \
5751 while (0)
5752 #endif
5754 enum
5756 X_EVENT_NORMAL,
5757 X_EVENT_GOTO_OUT,
5758 X_EVENT_DROP
5761 /* Filter events for the current X input method.
5762 DPYINFO is the display this event is for.
5763 EVENT is the X event to filter.
5765 Returns non-zero if the event was filtered, caller shall not process
5766 this event further.
5767 Returns zero if event is wasn't filtered. */
5769 #ifdef HAVE_X_I18N
5770 static int
5771 x_filter_event (struct x_display_info *dpyinfo, XEvent *event)
5773 /* XFilterEvent returns non-zero if the input method has
5774 consumed the event. We pass the frame's X window to
5775 XFilterEvent because that's the one for which the IC
5776 was created. */
5778 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5779 event->xclient.window);
5781 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5783 #endif
5785 #ifdef USE_GTK
5786 static int current_count;
5787 static int current_finish;
5788 static struct input_event *current_hold_quit;
5790 /* This is the filter function invoked by the GTK event loop.
5791 It is invoked before the XEvent is translated to a GdkEvent,
5792 so we have a chance to act on the event before GTK. */
5793 static GdkFilterReturn
5794 event_handler_gdk (GdkXEvent *gxev, GdkEvent *ev, gpointer data)
5796 XEvent *xev = (XEvent *) gxev;
5798 BLOCK_INPUT;
5799 if (current_count >= 0)
5801 struct x_display_info *dpyinfo;
5803 dpyinfo = x_display_info_for_display (xev->xany.display);
5805 #ifdef HAVE_X_I18N
5806 /* Filter events for the current X input method.
5807 GTK calls XFilterEvent but not for key press and release,
5808 so we do it here. */
5809 if ((xev->type == KeyPress || xev->type == KeyRelease)
5810 && dpyinfo
5811 && x_filter_event (dpyinfo, xev))
5813 UNBLOCK_INPUT;
5814 return GDK_FILTER_REMOVE;
5816 #endif
5818 if (! dpyinfo)
5819 current_finish = X_EVENT_NORMAL;
5820 else
5821 current_count +=
5822 handle_one_xevent (dpyinfo, xev, &current_finish,
5823 current_hold_quit);
5825 else
5826 current_finish = x_dispatch_event (xev, xev->xany.display);
5828 UNBLOCK_INPUT;
5830 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5831 return GDK_FILTER_REMOVE;
5833 return GDK_FILTER_CONTINUE;
5835 #endif /* USE_GTK */
5838 static void xembed_send_message (struct frame *f, Time,
5839 enum xembed_message,
5840 long detail, long data1, long data2);
5842 /* Handles the XEvent EVENT on display DPYINFO.
5844 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5845 *FINISH is zero if caller should continue reading events.
5846 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5848 We return the number of characters stored into the buffer. */
5850 static int
5851 handle_one_xevent (struct x_display_info *dpyinfo, XEvent *eventptr,
5852 int *finish, struct input_event *hold_quit)
5854 union {
5855 struct input_event ie;
5856 struct selection_input_event sie;
5857 } inev;
5858 int count = 0;
5859 int do_help = 0;
5860 ptrdiff_t nbytes = 0;
5861 struct frame *f = NULL;
5862 struct coding_system coding;
5863 XEvent event = *eventptr;
5864 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
5865 USE_SAFE_ALLOCA;
5867 *finish = X_EVENT_NORMAL;
5869 EVENT_INIT (inev.ie);
5870 inev.ie.kind = NO_EVENT;
5871 inev.ie.arg = Qnil;
5873 if (pending_event_wait.eventtype == event.type)
5874 pending_event_wait.eventtype = 0; /* Indicates we got it. */
5876 switch (event.type)
5878 case ClientMessage:
5880 if (event.xclient.message_type
5881 == dpyinfo->Xatom_wm_protocols
5882 && event.xclient.format == 32)
5884 if (event.xclient.data.l[0]
5885 == dpyinfo->Xatom_wm_take_focus)
5887 /* Use x_any_window_to_frame because this
5888 could be the shell widget window
5889 if the frame has no title bar. */
5890 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5891 #ifdef HAVE_X_I18N
5892 /* Not quite sure this is needed -pd */
5893 if (f && FRAME_XIC (f))
5894 XSetICFocus (FRAME_XIC (f));
5895 #endif
5896 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5897 instructs the WM to set the input focus automatically for
5898 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5899 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5900 it has set the focus. So, XSetInputFocus below is not
5901 needed.
5903 The call to XSetInputFocus below has also caused trouble. In
5904 cases where the XSetInputFocus done by the WM and the one
5905 below are temporally close (on a fast machine), the call
5906 below can generate additional FocusIn events which confuse
5907 Emacs. */
5909 /* Since we set WM_TAKE_FOCUS, we must call
5910 XSetInputFocus explicitly. But not if f is null,
5911 since that might be an event for a deleted frame. */
5912 if (f)
5914 Display *d = event.xclient.display;
5915 /* Catch and ignore errors, in case window has been
5916 iconified by a window manager such as GWM. */
5917 x_catch_errors (d);
5918 XSetInputFocus (d, event.xclient.window,
5919 /* The ICCCM says this is
5920 the only valid choice. */
5921 RevertToParent,
5922 event.xclient.data.l[1]);
5923 /* This is needed to detect the error
5924 if there is an error. */
5925 XSync (d, False);
5926 x_uncatch_errors ();
5928 /* Not certain about handling scroll bars here */
5929 #endif /* 0 */
5930 goto done;
5933 if (event.xclient.data.l[0]
5934 == dpyinfo->Xatom_wm_save_yourself)
5936 /* Save state modify the WM_COMMAND property to
5937 something which can reinstate us. This notifies
5938 the session manager, who's looking for such a
5939 PropertyNotify. Can restart processing when
5940 a keyboard or mouse event arrives. */
5941 /* If we have a session manager, don't set this.
5942 KDE will then start two Emacsen, one for the
5943 session manager and one for this. */
5944 #ifdef HAVE_X_SM
5945 if (! x_session_have_connection ())
5946 #endif
5948 f = x_top_window_to_frame (dpyinfo,
5949 event.xclient.window);
5950 /* This is just so we only give real data once
5951 for a single Emacs process. */
5952 if (f == SELECTED_FRAME ())
5953 XSetCommand (FRAME_X_DISPLAY (f),
5954 event.xclient.window,
5955 initial_argv, initial_argc);
5956 else if (f)
5957 XSetCommand (FRAME_X_DISPLAY (f),
5958 event.xclient.window,
5959 0, 0);
5961 goto done;
5964 if (event.xclient.data.l[0]
5965 == dpyinfo->Xatom_wm_delete_window)
5967 f = x_any_window_to_frame (dpyinfo,
5968 event.xclient.window);
5969 if (!f)
5970 goto OTHER; /* May be a dialog that is to be removed */
5972 inev.ie.kind = DELETE_WINDOW_EVENT;
5973 XSETFRAME (inev.ie.frame_or_window, f);
5974 goto done;
5977 goto done;
5980 if (event.xclient.message_type
5981 == dpyinfo->Xatom_wm_configure_denied)
5983 goto done;
5986 if (event.xclient.message_type
5987 == dpyinfo->Xatom_wm_window_moved)
5989 int new_x, new_y;
5990 f = x_window_to_frame (dpyinfo, event.xclient.window);
5992 new_x = event.xclient.data.s[0];
5993 new_y = event.xclient.data.s[1];
5995 if (f)
5997 f->left_pos = new_x;
5998 f->top_pos = new_y;
6000 goto done;
6003 #ifdef HACK_EDITRES
6004 if (event.xclient.message_type
6005 == dpyinfo->Xatom_editres)
6007 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6008 if (f)
6009 _XEditResCheckMessages (f->output_data.x->widget, NULL,
6010 &event, NULL);
6011 goto done;
6013 #endif /* HACK_EDITRES */
6015 if ((event.xclient.message_type
6016 == dpyinfo->Xatom_DONE)
6017 || (event.xclient.message_type
6018 == dpyinfo->Xatom_PAGE))
6020 /* Ghostview job completed. Kill it. We could
6021 reply with "Next" if we received "Page", but we
6022 currently never do because we are interested in
6023 images, only, which should have 1 page. */
6024 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
6025 f = x_window_to_frame (dpyinfo, event.xclient.window);
6026 if (!f)
6027 goto OTHER;
6028 x_kill_gs_process (pixmap, f);
6029 expose_frame (f, 0, 0, 0, 0);
6030 goto done;
6033 #ifdef USE_TOOLKIT_SCROLL_BARS
6034 /* Scroll bar callbacks send a ClientMessage from which
6035 we construct an input_event. */
6036 if (event.xclient.message_type
6037 == dpyinfo->Xatom_Scrollbar)
6039 x_scroll_bar_to_input_event (&event, &inev.ie);
6040 *finish = X_EVENT_GOTO_OUT;
6041 goto done;
6043 #endif /* USE_TOOLKIT_SCROLL_BARS */
6045 /* XEmbed messages from the embedder (if any). */
6046 if (event.xclient.message_type
6047 == dpyinfo->Xatom_XEMBED)
6049 enum xembed_message msg = event.xclient.data.l[1];
6050 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
6051 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6053 *finish = X_EVENT_GOTO_OUT;
6054 goto done;
6057 xft_settings_event (dpyinfo, &event);
6059 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6060 if (!f)
6061 goto OTHER;
6062 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
6063 *finish = X_EVENT_DROP;
6065 break;
6067 case SelectionNotify:
6068 last_user_time = event.xselection.time;
6069 #ifdef USE_X_TOOLKIT
6070 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
6071 goto OTHER;
6072 #endif /* not USE_X_TOOLKIT */
6073 x_handle_selection_notify (&event.xselection);
6074 break;
6076 case SelectionClear: /* Someone has grabbed ownership. */
6077 last_user_time = event.xselectionclear.time;
6078 #ifdef USE_X_TOOLKIT
6079 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6080 goto OTHER;
6081 #endif /* USE_X_TOOLKIT */
6083 XSelectionClearEvent *eventp = &(event.xselectionclear);
6085 inev.ie.kind = SELECTION_CLEAR_EVENT;
6086 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6087 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6088 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6089 inev.ie.frame_or_window = Qnil;
6091 break;
6093 case SelectionRequest: /* Someone wants our selection. */
6094 last_user_time = event.xselectionrequest.time;
6095 #ifdef USE_X_TOOLKIT
6096 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6097 goto OTHER;
6098 #endif /* USE_X_TOOLKIT */
6100 XSelectionRequestEvent *eventp = &(event.xselectionrequest);
6102 inev.ie.kind = SELECTION_REQUEST_EVENT;
6103 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6104 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6105 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6106 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6107 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6108 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6109 inev.ie.frame_or_window = Qnil;
6111 break;
6113 case PropertyNotify:
6114 last_user_time = event.xproperty.time;
6115 f = x_top_window_to_frame (dpyinfo, event.xproperty.window);
6116 if (f && event.xproperty.atom == dpyinfo->Xatom_net_wm_state)
6117 if (x_handle_net_wm_state (f, &event.xproperty) && f->iconified)
6119 /* Gnome shell does not iconify us when C-z is pressed. It hides
6120 the frame. So if our state says we aren't hidden anymore,
6121 treat it as deiconified. */
6122 if (! f->async_iconified)
6123 SET_FRAME_GARBAGED (f);
6124 f->async_visible = 1;
6125 f->async_iconified = 0;
6126 f->output_data.x->has_been_visible = 1;
6127 inev.ie.kind = DEICONIFY_EVENT;
6128 XSETFRAME (inev.ie.frame_or_window, f);
6131 x_handle_property_notify (&event.xproperty);
6132 xft_settings_event (dpyinfo, &event);
6133 goto OTHER;
6135 case ReparentNotify:
6136 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6137 if (f)
6139 int x, y;
6140 f->output_data.x->parent_desc = event.xreparent.parent;
6141 x_real_positions (f, &x, &y);
6142 f->left_pos = x;
6143 f->top_pos = y;
6145 /* Perhaps reparented due to a WM restart. Reset this. */
6146 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6147 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6149 x_set_frame_alpha (f);
6151 goto OTHER;
6153 case Expose:
6154 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6155 if (f)
6157 #ifdef USE_GTK
6158 /* This seems to be needed for GTK 2.6. */
6159 x_clear_area (event.xexpose.display,
6160 event.xexpose.window,
6161 event.xexpose.x, event.xexpose.y,
6162 event.xexpose.width, event.xexpose.height,
6163 FALSE);
6164 #endif
6165 if (f->async_visible == 0)
6167 f->async_visible = 1;
6168 f->async_iconified = 0;
6169 f->output_data.x->has_been_visible = 1;
6170 SET_FRAME_GARBAGED (f);
6172 else
6173 expose_frame (f,
6174 event.xexpose.x, event.xexpose.y,
6175 event.xexpose.width, event.xexpose.height);
6177 else
6179 #ifndef USE_TOOLKIT_SCROLL_BARS
6180 struct scroll_bar *bar;
6181 #endif
6182 #if defined USE_LUCID
6183 /* Submenus of the Lucid menu bar aren't widgets
6184 themselves, so there's no way to dispatch events
6185 to them. Recognize this case separately. */
6187 Widget widget
6188 = x_window_to_menu_bar (event.xexpose.window);
6189 if (widget)
6190 xlwmenu_redisplay (widget);
6192 #endif /* USE_LUCID */
6194 #ifdef USE_TOOLKIT_SCROLL_BARS
6195 /* Dispatch event to the widget. */
6196 goto OTHER;
6197 #else /* not USE_TOOLKIT_SCROLL_BARS */
6198 bar = x_window_to_scroll_bar (event.xexpose.display,
6199 event.xexpose.window);
6201 if (bar)
6202 x_scroll_bar_expose (bar, &event);
6203 #ifdef USE_X_TOOLKIT
6204 else
6205 goto OTHER;
6206 #endif /* USE_X_TOOLKIT */
6207 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6209 break;
6211 case GraphicsExpose: /* This occurs when an XCopyArea's
6212 source area was obscured or not
6213 available. */
6214 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6215 if (f)
6217 expose_frame (f,
6218 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6219 event.xgraphicsexpose.width,
6220 event.xgraphicsexpose.height);
6222 #ifdef USE_X_TOOLKIT
6223 else
6224 goto OTHER;
6225 #endif /* USE_X_TOOLKIT */
6226 break;
6228 case NoExpose: /* This occurs when an XCopyArea's
6229 source area was completely
6230 available. */
6231 break;
6233 case UnmapNotify:
6234 /* Redo the mouse-highlight after the tooltip has gone. */
6235 if (event.xmap.window == tip_window)
6237 tip_window = 0;
6238 redo_mouse_highlight ();
6241 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6242 if (f) /* F may no longer exist if
6243 the frame was deleted. */
6245 /* While a frame is unmapped, display generation is
6246 disabled; you don't want to spend time updating a
6247 display that won't ever be seen. */
6248 f->async_visible = 0;
6249 /* We can't distinguish, from the event, whether the window
6250 has become iconified or invisible. So assume, if it
6251 was previously visible, than now it is iconified.
6252 But x_make_frame_invisible clears both
6253 the visible flag and the iconified flag;
6254 and that way, we know the window is not iconified now. */
6255 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6257 f->async_iconified = 1;
6259 inev.ie.kind = ICONIFY_EVENT;
6260 XSETFRAME (inev.ie.frame_or_window, f);
6263 goto OTHER;
6265 case MapNotify:
6266 if (event.xmap.window == tip_window)
6267 /* The tooltip has been drawn already. Avoid
6268 the SET_FRAME_GARBAGED below. */
6269 goto OTHER;
6271 /* We use x_top_window_to_frame because map events can
6272 come for sub-windows and they don't mean that the
6273 frame is visible. */
6274 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6275 if (f)
6277 /* wait_reading_process_output will notice this and update
6278 the frame's display structures.
6279 If we where iconified, we should not set garbaged,
6280 because that stops redrawing on Expose events. This looks
6281 bad if we are called from a recursive event loop
6282 (x_dispatch_event), for example when a dialog is up. */
6283 if (! f->async_iconified)
6284 SET_FRAME_GARBAGED (f);
6286 /* Check if fullscreen was specified before we where mapped the
6287 first time, i.e. from the command line. */
6288 if (!f->output_data.x->has_been_visible)
6289 x_check_fullscreen (f);
6291 f->async_visible = 1;
6292 f->async_iconified = 0;
6293 f->output_data.x->has_been_visible = 1;
6295 if (f->iconified)
6297 inev.ie.kind = DEICONIFY_EVENT;
6298 XSETFRAME (inev.ie.frame_or_window, f);
6300 else if (! NILP (Vframe_list)
6301 && ! NILP (XCDR (Vframe_list)))
6302 /* Force a redisplay sooner or later
6303 to update the frame titles
6304 in case this is the second frame. */
6305 record_asynch_buffer_change ();
6307 #ifdef USE_GTK
6308 xg_frame_resized (f, -1, -1);
6309 #endif
6311 goto OTHER;
6313 case KeyPress:
6315 last_user_time = event.xkey.time;
6316 ignore_next_mouse_click_timeout = 0;
6318 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6319 /* Dispatch KeyPress events when in menu. */
6320 if (popup_activated ())
6321 goto OTHER;
6322 #endif
6324 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6326 /* If mouse-highlight is an integer, input clears out
6327 mouse highlighting. */
6328 if (!hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6329 && (f == 0
6330 || !EQ (f->tool_bar_window, hlinfo->mouse_face_window)))
6332 clear_mouse_face (hlinfo);
6333 hlinfo->mouse_face_hidden = 1;
6336 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6337 if (f == 0)
6339 /* Scroll bars consume key events, but we want
6340 the keys to go to the scroll bar's frame. */
6341 Widget widget = XtWindowToWidget (dpyinfo->display,
6342 event.xkey.window);
6343 if (widget && XmIsScrollBar (widget))
6345 widget = XtParent (widget);
6346 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6349 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6351 if (f != 0)
6353 KeySym keysym, orig_keysym;
6354 /* al%imercury@uunet.uu.net says that making this 81
6355 instead of 80 fixed a bug whereby meta chars made
6356 his Emacs hang.
6358 It seems that some version of XmbLookupString has
6359 a bug of not returning XBufferOverflow in
6360 status_return even if the input is too long to
6361 fit in 81 bytes. So, we must prepare sufficient
6362 bytes for copy_buffer. 513 bytes (256 chars for
6363 two-byte character set) seems to be a fairly good
6364 approximation. -- 2000.8.10 handa@etl.go.jp */
6365 unsigned char copy_buffer[513];
6366 unsigned char *copy_bufptr = copy_buffer;
6367 int copy_bufsiz = sizeof (copy_buffer);
6368 int modifiers;
6369 Lisp_Object coding_system = Qlatin_1;
6370 Lisp_Object c;
6372 #ifdef USE_GTK
6373 /* Don't pass keys to GTK. A Tab will shift focus to the
6374 tool bar in GTK 2.4. Keys will still go to menus and
6375 dialogs because in that case popup_activated is TRUE
6376 (see above). */
6377 *finish = X_EVENT_DROP;
6378 #endif
6380 event.xkey.state
6381 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6382 extra_keyboard_modifiers);
6383 modifiers = event.xkey.state;
6385 /* This will have to go some day... */
6387 /* make_lispy_event turns chars into control chars.
6388 Don't do it here because XLookupString is too eager. */
6389 event.xkey.state &= ~ControlMask;
6390 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6391 | dpyinfo->super_mod_mask
6392 | dpyinfo->hyper_mod_mask
6393 | dpyinfo->alt_mod_mask);
6395 /* In case Meta is ComposeCharacter,
6396 clear its status. According to Markus Ehrnsperger
6397 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6398 this enables ComposeCharacter to work whether or
6399 not it is combined with Meta. */
6400 if (modifiers & dpyinfo->meta_mod_mask)
6401 memset (&compose_status, 0, sizeof (compose_status));
6403 #ifdef HAVE_X_I18N
6404 if (FRAME_XIC (f))
6406 Status status_return;
6408 coding_system = Vlocale_coding_system;
6409 nbytes = XmbLookupString (FRAME_XIC (f),
6410 &event.xkey, (char *) copy_bufptr,
6411 copy_bufsiz, &keysym,
6412 &status_return);
6413 if (status_return == XBufferOverflow)
6415 copy_bufsiz = nbytes + 1;
6416 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6417 nbytes = XmbLookupString (FRAME_XIC (f),
6418 &event.xkey, (char *) copy_bufptr,
6419 copy_bufsiz, &keysym,
6420 &status_return);
6422 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6423 if (status_return == XLookupNone)
6424 break;
6425 else if (status_return == XLookupChars)
6427 keysym = NoSymbol;
6428 modifiers = 0;
6430 else if (status_return != XLookupKeySym
6431 && status_return != XLookupBoth)
6432 abort ();
6434 else
6435 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6436 copy_bufsiz, &keysym,
6437 &compose_status);
6438 #else
6439 nbytes = XLookupString (&event.xkey, (char *) copy_bufptr,
6440 copy_bufsiz, &keysym,
6441 &compose_status);
6442 #endif
6444 /* If not using XIM/XIC, and a compose sequence is in progress,
6445 we break here. Otherwise, chars_matched is always 0. */
6446 if (compose_status.chars_matched > 0 && nbytes == 0)
6447 break;
6449 memset (&compose_status, 0, sizeof (compose_status));
6450 orig_keysym = keysym;
6452 /* Common for all keysym input events. */
6453 XSETFRAME (inev.ie.frame_or_window, f);
6454 inev.ie.modifiers
6455 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6456 inev.ie.timestamp = event.xkey.time;
6458 /* First deal with keysyms which have defined
6459 translations to characters. */
6460 if (keysym >= 32 && keysym < 128)
6461 /* Avoid explicitly decoding each ASCII character. */
6463 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6464 inev.ie.code = keysym;
6465 goto done_keysym;
6468 /* Keysyms directly mapped to Unicode characters. */
6469 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6471 if (keysym < 0x01000080)
6472 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6473 else
6474 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6475 inev.ie.code = keysym & 0xFFFFFF;
6476 goto done_keysym;
6479 /* Now non-ASCII. */
6480 if (HASH_TABLE_P (Vx_keysym_table)
6481 && (NATNUMP (c = Fgethash (make_number (keysym),
6482 Vx_keysym_table,
6483 Qnil))))
6485 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6486 ? ASCII_KEYSTROKE_EVENT
6487 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6488 inev.ie.code = XFASTINT (c);
6489 goto done_keysym;
6492 /* Random non-modifier sorts of keysyms. */
6493 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6494 || keysym == XK_Delete
6495 #ifdef XK_ISO_Left_Tab
6496 || (keysym >= XK_ISO_Left_Tab
6497 && keysym <= XK_ISO_Enter)
6498 #endif
6499 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6500 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6501 #ifdef HPUX
6502 /* This recognizes the "extended function
6503 keys". It seems there's no cleaner way.
6504 Test IsModifierKey to avoid handling
6505 mode_switch incorrectly. */
6506 || (XK_Select <= keysym && keysym < XK_KP_Space)
6507 #endif
6508 #ifdef XK_dead_circumflex
6509 || orig_keysym == XK_dead_circumflex
6510 #endif
6511 #ifdef XK_dead_grave
6512 || orig_keysym == XK_dead_grave
6513 #endif
6514 #ifdef XK_dead_tilde
6515 || orig_keysym == XK_dead_tilde
6516 #endif
6517 #ifdef XK_dead_diaeresis
6518 || orig_keysym == XK_dead_diaeresis
6519 #endif
6520 #ifdef XK_dead_macron
6521 || orig_keysym == XK_dead_macron
6522 #endif
6523 #ifdef XK_dead_degree
6524 || orig_keysym == XK_dead_degree
6525 #endif
6526 #ifdef XK_dead_acute
6527 || orig_keysym == XK_dead_acute
6528 #endif
6529 #ifdef XK_dead_cedilla
6530 || orig_keysym == XK_dead_cedilla
6531 #endif
6532 #ifdef XK_dead_breve
6533 || orig_keysym == XK_dead_breve
6534 #endif
6535 #ifdef XK_dead_ogonek
6536 || orig_keysym == XK_dead_ogonek
6537 #endif
6538 #ifdef XK_dead_caron
6539 || orig_keysym == XK_dead_caron
6540 #endif
6541 #ifdef XK_dead_doubleacute
6542 || orig_keysym == XK_dead_doubleacute
6543 #endif
6544 #ifdef XK_dead_abovedot
6545 || orig_keysym == XK_dead_abovedot
6546 #endif
6547 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6548 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6549 /* Any "vendor-specific" key is ok. */
6550 || (orig_keysym & (1 << 28))
6551 || (keysym != NoSymbol && nbytes == 0))
6552 && ! (IsModifierKey (orig_keysym)
6553 /* The symbols from XK_ISO_Lock
6554 to XK_ISO_Last_Group_Lock
6555 don't have real modifiers but
6556 should be treated similarly to
6557 Mode_switch by Emacs. */
6558 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6559 || (XK_ISO_Lock <= orig_keysym
6560 && orig_keysym <= XK_ISO_Last_Group_Lock)
6561 #endif
6564 STORE_KEYSYM_FOR_DEBUG (keysym);
6565 /* make_lispy_event will convert this to a symbolic
6566 key. */
6567 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6568 inev.ie.code = keysym;
6569 goto done_keysym;
6572 { /* Raw bytes, not keysym. */
6573 ptrdiff_t i;
6574 int nchars, len;
6576 for (i = 0, nchars = 0; i < nbytes; i++)
6578 if (ASCII_BYTE_P (copy_bufptr[i]))
6579 nchars++;
6580 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6583 if (nchars < nbytes)
6585 /* Decode the input data. */
6587 /* The input should be decoded with `coding_system'
6588 which depends on which X*LookupString function
6589 we used just above and the locale. */
6590 setup_coding_system (coding_system, &coding);
6591 coding.src_multibyte = 0;
6592 coding.dst_multibyte = 1;
6593 /* The input is converted to events, thus we can't
6594 handle composition. Anyway, there's no XIM that
6595 gives us composition information. */
6596 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6598 SAFE_NALLOCA (coding.destination, MAX_MULTIBYTE_LENGTH,
6599 nbytes);
6600 coding.dst_bytes = MAX_MULTIBYTE_LENGTH * nbytes;
6601 coding.mode |= CODING_MODE_LAST_BLOCK;
6602 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6603 nbytes = coding.produced;
6604 nchars = coding.produced_char;
6605 copy_bufptr = coding.destination;
6608 /* Convert the input data to a sequence of
6609 character events. */
6610 for (i = 0; i < nbytes; i += len)
6612 int ch;
6613 if (nchars == nbytes)
6614 ch = copy_bufptr[i], len = 1;
6615 else
6616 ch = STRING_CHAR_AND_LENGTH (copy_bufptr + i, len);
6617 inev.ie.kind = (SINGLE_BYTE_CHAR_P (ch)
6618 ? ASCII_KEYSTROKE_EVENT
6619 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6620 inev.ie.code = ch;
6621 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6624 count += nchars;
6626 inev.ie.kind = NO_EVENT; /* Already stored above. */
6628 if (keysym == NoSymbol)
6629 break;
6632 done_keysym:
6633 #ifdef HAVE_X_I18N
6634 /* Don't dispatch this event since XtDispatchEvent calls
6635 XFilterEvent, and two calls in a row may freeze the
6636 client. */
6637 break;
6638 #else
6639 goto OTHER;
6640 #endif
6642 case KeyRelease:
6643 last_user_time = event.xkey.time;
6644 #ifdef HAVE_X_I18N
6645 /* Don't dispatch this event since XtDispatchEvent calls
6646 XFilterEvent, and two calls in a row may freeze the
6647 client. */
6648 break;
6649 #else
6650 goto OTHER;
6651 #endif
6653 case EnterNotify:
6654 last_user_time = event.xcrossing.time;
6655 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6657 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6659 if (f && x_mouse_click_focus_ignore_position)
6660 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6662 /* EnterNotify counts as mouse movement,
6663 so update things that depend on mouse position. */
6664 if (f && !f->output_data.x->hourglass_p)
6665 note_mouse_movement (f, &event.xmotion);
6666 #ifdef USE_GTK
6667 /* We may get an EnterNotify on the buttons in the toolbar. In that
6668 case we moved out of any highlighted area and need to note this. */
6669 if (!f && last_mouse_glyph_frame)
6670 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6671 #endif
6672 goto OTHER;
6674 case FocusIn:
6675 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6676 goto OTHER;
6678 case LeaveNotify:
6679 last_user_time = event.xcrossing.time;
6680 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6682 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6683 if (f)
6685 if (f == hlinfo->mouse_face_mouse_frame)
6687 /* If we move outside the frame, then we're
6688 certainly no longer on any text in the frame. */
6689 clear_mouse_face (hlinfo);
6690 hlinfo->mouse_face_mouse_frame = 0;
6693 /* Generate a nil HELP_EVENT to cancel a help-echo.
6694 Do it only if there's something to cancel.
6695 Otherwise, the startup message is cleared when
6696 the mouse leaves the frame. */
6697 if (any_help_event_p)
6698 do_help = -1;
6700 #ifdef USE_GTK
6701 /* See comment in EnterNotify above */
6702 else if (last_mouse_glyph_frame)
6703 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6704 #endif
6705 goto OTHER;
6707 case FocusOut:
6708 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6709 goto OTHER;
6711 case MotionNotify:
6713 last_user_time = event.xmotion.time;
6714 previous_help_echo_string = help_echo_string;
6715 help_echo_string = Qnil;
6717 if (dpyinfo->grabbed && last_mouse_frame
6718 && FRAME_LIVE_P (last_mouse_frame))
6719 f = last_mouse_frame;
6720 else
6721 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6723 if (hlinfo->mouse_face_hidden)
6725 hlinfo->mouse_face_hidden = 0;
6726 clear_mouse_face (hlinfo);
6729 #ifdef USE_GTK
6730 if (f && xg_event_is_for_scrollbar (f, &event))
6731 f = 0;
6732 #endif
6733 if (f)
6736 /* Generate SELECT_WINDOW_EVENTs when needed.
6737 Don't let popup menus influence things (bug#1261). */
6738 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6740 Lisp_Object window;
6742 window = window_from_coordinates (f,
6743 event.xmotion.x, event.xmotion.y,
6744 0, 0);
6746 /* Window will be selected only when it is not selected now and
6747 last mouse movement event was not in it. Minibuffer window
6748 will be selected only when it is active. */
6749 if (WINDOWP (window)
6750 && !EQ (window, last_window)
6751 && !EQ (window, selected_window)
6752 /* For click-to-focus window managers
6753 create event iff we don't leave the
6754 selected frame. */
6755 && (focus_follows_mouse
6756 || (EQ (XWINDOW (window)->frame,
6757 XWINDOW (selected_window)->frame))))
6759 inev.ie.kind = SELECT_WINDOW_EVENT;
6760 inev.ie.frame_or_window = window;
6763 last_window=window;
6765 if (!note_mouse_movement (f, &event.xmotion))
6766 help_echo_string = previous_help_echo_string;
6768 else
6770 #ifndef USE_TOOLKIT_SCROLL_BARS
6771 struct scroll_bar *bar
6772 = x_window_to_scroll_bar (event.xmotion.display,
6773 event.xmotion.window);
6775 if (bar)
6776 x_scroll_bar_note_movement (bar, &event);
6777 #endif /* USE_TOOLKIT_SCROLL_BARS */
6779 /* If we move outside the frame, then we're
6780 certainly no longer on any text in the frame. */
6781 clear_mouse_face (hlinfo);
6784 /* If the contents of the global variable help_echo_string
6785 has changed, generate a HELP_EVENT. */
6786 if (!NILP (help_echo_string)
6787 || !NILP (previous_help_echo_string))
6788 do_help = 1;
6789 goto OTHER;
6792 case ConfigureNotify:
6793 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6794 #ifdef USE_GTK
6795 if (!f
6796 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6797 && event.xconfigure.window == FRAME_X_WINDOW (f))
6799 xg_frame_resized (f, event.xconfigure.width,
6800 event.xconfigure.height);
6801 f = 0;
6803 #endif
6804 if (f)
6806 #ifndef USE_X_TOOLKIT
6807 #ifndef USE_GTK
6808 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6809 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6811 /* In the toolkit version, change_frame_size
6812 is called by the code that handles resizing
6813 of the EmacsFrame widget. */
6815 /* Even if the number of character rows and columns has
6816 not changed, the font size may have changed, so we need
6817 to check the pixel dimensions as well. */
6818 if (columns != FRAME_COLS (f)
6819 || rows != FRAME_LINES (f)
6820 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6821 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6823 change_frame_size (f, rows, columns, 0, 1, 0);
6824 SET_FRAME_GARBAGED (f);
6825 cancel_mouse_face (f);
6828 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6829 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6830 #endif /* not USE_GTK */
6831 #endif
6833 #ifdef USE_GTK
6834 /* GTK creates windows but doesn't map them.
6835 Only get real positions when mapped. */
6836 if (FRAME_GTK_OUTER_WIDGET (f)
6837 && gtk_widget_get_mapped (FRAME_GTK_OUTER_WIDGET (f)))
6838 #endif
6840 x_real_positions (f, &f->left_pos, &f->top_pos);
6843 #ifdef HAVE_X_I18N
6844 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6845 xic_set_statusarea (f);
6846 #endif
6849 goto OTHER;
6851 case ButtonRelease:
6852 case ButtonPress:
6854 /* If we decide we want to generate an event to be seen
6855 by the rest of Emacs, we put it here. */
6856 int tool_bar_p = 0;
6858 memset (&compose_status, 0, sizeof (compose_status));
6859 last_mouse_glyph_frame = 0;
6860 last_user_time = event.xbutton.time;
6862 if (dpyinfo->grabbed
6863 && last_mouse_frame
6864 && FRAME_LIVE_P (last_mouse_frame))
6865 f = last_mouse_frame;
6866 else
6867 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6869 #ifdef USE_GTK
6870 if (f && xg_event_is_for_scrollbar (f, &event))
6871 f = 0;
6872 #endif
6873 if (f)
6875 /* Is this in the tool-bar? */
6876 if (WINDOWP (f->tool_bar_window)
6877 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6879 Lisp_Object window;
6880 int x = event.xbutton.x;
6881 int y = event.xbutton.y;
6883 window = window_from_coordinates (f, x, y, 0, 1);
6884 tool_bar_p = EQ (window, f->tool_bar_window);
6886 if (tool_bar_p && event.xbutton.button < 4)
6888 handle_tool_bar_click (f, x, y,
6889 event.xbutton.type == ButtonPress,
6890 x_x_to_emacs_modifiers (dpyinfo,
6891 event.xbutton.state));
6895 if (!tool_bar_p)
6896 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6897 if (! popup_activated ())
6898 #endif
6900 if (ignore_next_mouse_click_timeout)
6902 if (event.type == ButtonPress
6903 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6905 ignore_next_mouse_click_timeout = 0;
6906 construct_mouse_click (&inev.ie, &event.xbutton, f);
6908 if (event.type == ButtonRelease)
6909 ignore_next_mouse_click_timeout = 0;
6911 else
6912 construct_mouse_click (&inev.ie, &event.xbutton, f);
6914 if (FRAME_X_EMBEDDED_P (f))
6915 xembed_send_message (f, event.xbutton.time,
6916 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6918 else
6920 struct scroll_bar *bar
6921 = x_window_to_scroll_bar (event.xbutton.display,
6922 event.xbutton.window);
6924 #ifdef USE_TOOLKIT_SCROLL_BARS
6925 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6926 scroll bars. */
6927 if (bar && event.xbutton.state & ControlMask)
6929 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6930 *finish = X_EVENT_DROP;
6932 #else /* not USE_TOOLKIT_SCROLL_BARS */
6933 if (bar)
6934 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6935 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6938 if (event.type == ButtonPress)
6940 dpyinfo->grabbed |= (1 << event.xbutton.button);
6941 last_mouse_frame = f;
6943 if (!tool_bar_p)
6944 last_tool_bar_item = -1;
6946 else
6947 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6949 /* Ignore any mouse motion that happened before this event;
6950 any subsequent mouse-movement Emacs events should reflect
6951 only motion after the ButtonPress/Release. */
6952 if (f != 0)
6953 f->mouse_moved = 0;
6955 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6956 f = x_menubar_window_to_frame (dpyinfo, &event);
6957 /* For a down-event in the menu bar,
6958 don't pass it to Xt right now.
6959 Instead, save it away
6960 and we will pass it to Xt from kbd_buffer_get_event.
6961 That way, we can run some Lisp code first. */
6962 if (! popup_activated ()
6963 #ifdef USE_GTK
6964 /* Gtk+ menus only react to the first three buttons. */
6965 && event.xbutton.button < 3
6966 #endif
6967 && f && event.type == ButtonPress
6968 /* Verify the event is really within the menu bar
6969 and not just sent to it due to grabbing. */
6970 && event.xbutton.x >= 0
6971 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6972 && event.xbutton.y >= 0
6973 && event.xbutton.y < f->output_data.x->menubar_height
6974 && event.xbutton.same_screen)
6976 SET_SAVED_BUTTON_EVENT;
6977 XSETFRAME (last_mouse_press_frame, f);
6978 *finish = X_EVENT_DROP;
6980 else if (event.type == ButtonPress)
6982 last_mouse_press_frame = Qnil;
6983 goto OTHER;
6985 else
6986 goto OTHER;
6987 #endif /* USE_X_TOOLKIT || USE_GTK */
6989 break;
6991 case CirculateNotify:
6992 goto OTHER;
6994 case CirculateRequest:
6995 goto OTHER;
6997 case VisibilityNotify:
6998 goto OTHER;
7000 case MappingNotify:
7001 /* Someone has changed the keyboard mapping - update the
7002 local cache. */
7003 switch (event.xmapping.request)
7005 case MappingModifier:
7006 x_find_modifier_meanings (dpyinfo);
7007 /* This is meant to fall through. */
7008 case MappingKeyboard:
7009 XRefreshKeyboardMapping (&event.xmapping);
7011 goto OTHER;
7013 case DestroyNotify:
7014 xft_settings_event (dpyinfo, &event);
7015 break;
7017 default:
7018 OTHER:
7019 #ifdef USE_X_TOOLKIT
7020 BLOCK_INPUT;
7021 if (*finish != X_EVENT_DROP)
7022 XtDispatchEvent (&event);
7023 UNBLOCK_INPUT;
7024 #endif /* USE_X_TOOLKIT */
7025 break;
7028 done:
7029 if (inev.ie.kind != NO_EVENT)
7031 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
7032 count++;
7035 if (do_help
7036 && !(hold_quit && hold_quit->kind != NO_EVENT))
7038 Lisp_Object frame;
7040 if (f)
7041 XSETFRAME (frame, f);
7042 else
7043 frame = Qnil;
7045 if (do_help > 0)
7047 any_help_event_p = 1;
7048 gen_help_event (help_echo_string, frame, help_echo_window,
7049 help_echo_object, help_echo_pos);
7051 else
7053 help_echo_string = Qnil;
7054 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
7056 count++;
7059 SAFE_FREE ();
7060 *eventptr = event;
7061 return count;
7064 #if defined USE_GTK || defined USE_X_TOOLKIT
7066 /* Handles the XEvent EVENT on display DISPLAY.
7067 This is used for event loops outside the normal event handling,
7068 i.e. looping while a popup menu or a dialog is posted.
7070 Returns the value handle_one_xevent sets in the finish argument. */
7072 x_dispatch_event (XEvent *event, Display *display)
7074 struct x_display_info *dpyinfo;
7075 int finish = X_EVENT_NORMAL;
7077 dpyinfo = x_display_info_for_display (display);
7079 if (dpyinfo)
7080 handle_one_xevent (dpyinfo, event, &finish, 0);
7082 return finish;
7084 #endif
7087 /* Read events coming from the X server.
7088 This routine is called by the SIGIO handler.
7089 We return as soon as there are no more events to be read.
7091 We return the number of characters stored into the buffer,
7092 thus pretending to be `read' (except the characters we store
7093 in the keyboard buffer can be multibyte, so are not necessarily
7094 C chars).
7096 EXPECTED is nonzero if the caller knows input is available. */
7098 static int
7099 XTread_socket (struct terminal *terminal, int expected, struct input_event *hold_quit)
7101 int count = 0;
7102 int event_found = 0;
7104 if (interrupt_input_blocked)
7106 interrupt_input_pending = 1;
7107 #ifdef SYNC_INPUT
7108 pending_signals = 1;
7109 #endif
7110 return -1;
7113 interrupt_input_pending = 0;
7114 #ifdef SYNC_INPUT
7115 pending_signals = pending_atimers;
7116 #endif
7117 BLOCK_INPUT;
7119 /* So people can tell when we have read the available input. */
7120 input_signal_count++;
7122 ++handling_signal;
7124 /* For debugging, this gives a way to fake an I/O error. */
7125 if (terminal->display_info.x == XTread_socket_fake_io_error)
7127 XTread_socket_fake_io_error = 0;
7128 x_io_error_quitter (terminal->display_info.x->display);
7131 #ifndef USE_GTK
7132 while (XPending (terminal->display_info.x->display))
7134 int finish;
7135 XEvent event;
7137 XNextEvent (terminal->display_info.x->display, &event);
7139 #ifdef HAVE_X_I18N
7140 /* Filter events for the current X input method. */
7141 if (x_filter_event (terminal->display_info.x, &event))
7142 continue;
7143 #endif
7144 event_found = 1;
7146 count += handle_one_xevent (terminal->display_info.x,
7147 &event, &finish, hold_quit);
7149 if (finish == X_EVENT_GOTO_OUT)
7150 goto out;
7153 out:;
7155 #else /* USE_GTK */
7157 /* For GTK we must use the GTK event loop. But XEvents gets passed
7158 to our filter function above, and then to the big event switch.
7159 We use a bunch of globals to communicate with our filter function,
7160 that is kind of ugly, but it works.
7162 There is no way to do one display at the time, GTK just does events
7163 from all displays. */
7165 while (gtk_events_pending ())
7167 current_count = count;
7168 current_hold_quit = hold_quit;
7170 gtk_main_iteration ();
7172 count = current_count;
7173 current_count = -1;
7174 current_hold_quit = 0;
7176 if (current_finish == X_EVENT_GOTO_OUT)
7177 break;
7179 #endif /* USE_GTK */
7181 /* On some systems, an X bug causes Emacs to get no more events
7182 when the window is destroyed. Detect that. (1994.) */
7183 if (! event_found)
7185 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7186 One XNOOP in 100 loops will make Emacs terminate.
7187 B. Bretthauer, 1994 */
7188 x_noop_count++;
7189 if (x_noop_count >= 100)
7191 x_noop_count=0;
7193 if (next_noop_dpyinfo == 0)
7194 next_noop_dpyinfo = x_display_list;
7196 XNoOp (next_noop_dpyinfo->display);
7198 /* Each time we get here, cycle through the displays now open. */
7199 next_noop_dpyinfo = next_noop_dpyinfo->next;
7203 /* If the focus was just given to an auto-raising frame,
7204 raise it now. */
7205 /* ??? This ought to be able to handle more than one such frame. */
7206 if (pending_autoraise_frame)
7208 x_raise_frame (pending_autoraise_frame);
7209 pending_autoraise_frame = 0;
7212 --handling_signal;
7213 UNBLOCK_INPUT;
7215 return count;
7221 /***********************************************************************
7222 Text Cursor
7223 ***********************************************************************/
7225 /* Set clipping for output in glyph row ROW. W is the window in which
7226 we operate. GC is the graphics context to set clipping in.
7228 ROW may be a text row or, e.g., a mode line. Text rows must be
7229 clipped to the interior of the window dedicated to text display,
7230 mode lines must be clipped to the whole window. */
7232 static void
7233 x_clip_to_row (struct window *w, struct glyph_row *row, int area, GC gc)
7235 struct frame *f = XFRAME (WINDOW_FRAME (w));
7236 XRectangle clip_rect;
7237 int window_x, window_y, window_width;
7239 window_box (w, area, &window_x, &window_y, &window_width, 0);
7241 clip_rect.x = window_x;
7242 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7243 clip_rect.y = max (clip_rect.y, window_y);
7244 clip_rect.width = window_width;
7245 clip_rect.height = row->visible_height;
7247 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7251 /* Draw a hollow box cursor on window W in glyph row ROW. */
7253 static void
7254 x_draw_hollow_cursor (struct window *w, struct glyph_row *row)
7256 struct frame *f = XFRAME (WINDOW_FRAME (w));
7257 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7258 Display *dpy = FRAME_X_DISPLAY (f);
7259 int x, y, wd, h;
7260 XGCValues xgcv;
7261 struct glyph *cursor_glyph;
7262 GC gc;
7264 /* Get the glyph the cursor is on. If we can't tell because
7265 the current matrix is invalid or such, give up. */
7266 cursor_glyph = get_phys_cursor_glyph (w);
7267 if (cursor_glyph == NULL)
7268 return;
7270 /* Compute frame-relative coordinates for phys cursor. */
7271 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7272 wd = w->phys_cursor_width;
7274 /* The foreground of cursor_gc is typically the same as the normal
7275 background color, which can cause the cursor box to be invisible. */
7276 xgcv.foreground = f->output_data.x->cursor_pixel;
7277 if (dpyinfo->scratch_cursor_gc)
7278 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7279 else
7280 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7281 GCForeground, &xgcv);
7282 gc = dpyinfo->scratch_cursor_gc;
7284 /* Set clipping, draw the rectangle, and reset clipping again. */
7285 x_clip_to_row (w, row, TEXT_AREA, gc);
7286 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7287 XSetClipMask (dpy, gc, None);
7291 /* Draw a bar cursor on window W in glyph row ROW.
7293 Implementation note: One would like to draw a bar cursor with an
7294 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7295 Unfortunately, I didn't find a font yet that has this property set.
7296 --gerd. */
7298 static void
7299 x_draw_bar_cursor (struct window *w, struct glyph_row *row, int width, enum text_cursor_kinds kind)
7301 struct frame *f = XFRAME (w->frame);
7302 struct glyph *cursor_glyph;
7304 /* If cursor is out of bounds, don't draw garbage. This can happen
7305 in mini-buffer windows when switching between echo area glyphs
7306 and mini-buffer. */
7307 cursor_glyph = get_phys_cursor_glyph (w);
7308 if (cursor_glyph == NULL)
7309 return;
7311 /* If on an image, draw like a normal cursor. That's usually better
7312 visible than drawing a bar, esp. if the image is large so that
7313 the bar might not be in the window. */
7314 if (cursor_glyph->type == IMAGE_GLYPH)
7316 struct glyph_row *r;
7317 r = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7318 draw_phys_cursor_glyph (w, r, DRAW_CURSOR);
7320 else
7322 Display *dpy = FRAME_X_DISPLAY (f);
7323 Window window = FRAME_X_WINDOW (f);
7324 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7325 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7326 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7327 XGCValues xgcv;
7329 /* If the glyph's background equals the color we normally draw
7330 the bars cursor in, the bar cursor in its normal color is
7331 invisible. Use the glyph's foreground color instead in this
7332 case, on the assumption that the glyph's colors are chosen so
7333 that the glyph is legible. */
7334 if (face->background == f->output_data.x->cursor_pixel)
7335 xgcv.background = xgcv.foreground = face->foreground;
7336 else
7337 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7338 xgcv.graphics_exposures = 0;
7340 if (gc)
7341 XChangeGC (dpy, gc, mask, &xgcv);
7342 else
7344 gc = XCreateGC (dpy, window, mask, &xgcv);
7345 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7348 x_clip_to_row (w, row, TEXT_AREA, gc);
7350 if (kind == BAR_CURSOR)
7352 int x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x);
7354 if (width < 0)
7355 width = FRAME_CURSOR_WIDTH (f);
7356 width = min (cursor_glyph->pixel_width, width);
7358 w->phys_cursor_width = width;
7360 /* If the character under cursor is R2L, draw the bar cursor
7361 on the right of its glyph, rather than on the left. */
7362 if ((cursor_glyph->resolved_level & 1) != 0)
7363 x += cursor_glyph->pixel_width - width;
7365 XFillRectangle (dpy, window, gc, x,
7366 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7367 width, row->height);
7369 else
7371 int dummy_x, dummy_y, dummy_h;
7373 if (width < 0)
7374 width = row->height;
7376 width = min (row->height, width);
7378 get_phys_cursor_geometry (w, row, cursor_glyph, &dummy_x,
7379 &dummy_y, &dummy_h);
7381 XFillRectangle (dpy, window, gc,
7382 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7383 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7384 row->height - width),
7385 w->phys_cursor_width, width);
7388 XSetClipMask (dpy, gc, None);
7393 /* RIF: Define cursor CURSOR on frame F. */
7395 static void
7396 x_define_frame_cursor (struct frame *f, Cursor cursor)
7398 if (!f->pointer_invisible
7399 && f->output_data.x->current_cursor != cursor)
7400 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7401 f->output_data.x->current_cursor = cursor;
7405 /* RIF: Clear area on frame F. */
7407 static void
7408 x_clear_frame_area (struct frame *f, int x, int y, int width, int height)
7410 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7411 x, y, width, height, False);
7412 #ifdef USE_GTK
7413 /* Must queue a redraw, because scroll bars might have been cleared. */
7414 if (FRAME_GTK_WIDGET (f))
7415 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
7416 #endif
7420 /* RIF: Draw cursor on window W. */
7422 static void
7423 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)
7425 struct frame *f = XFRAME (WINDOW_FRAME (w));
7427 if (on_p)
7429 w->phys_cursor_type = cursor_type;
7430 w->phys_cursor_on_p = 1;
7432 if (glyph_row->exact_window_width_line_p
7433 && (glyph_row->reversed_p
7434 ? (w->phys_cursor.hpos < 0)
7435 : (w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])))
7437 glyph_row->cursor_in_fringe_p = 1;
7438 draw_fringe_bitmap (w, glyph_row, glyph_row->reversed_p);
7440 else
7442 switch (cursor_type)
7444 case HOLLOW_BOX_CURSOR:
7445 x_draw_hollow_cursor (w, glyph_row);
7446 break;
7448 case FILLED_BOX_CURSOR:
7449 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7450 break;
7452 case BAR_CURSOR:
7453 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7454 break;
7456 case HBAR_CURSOR:
7457 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7458 break;
7460 case NO_CURSOR:
7461 w->phys_cursor_width = 0;
7462 break;
7464 default:
7465 abort ();
7469 #ifdef HAVE_X_I18N
7470 if (w == XWINDOW (f->selected_window))
7471 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7472 xic_set_preeditarea (w, x, y);
7473 #endif
7476 #ifndef XFlush
7477 XFlush (FRAME_X_DISPLAY (f));
7478 #endif
7482 /* Icons. */
7484 /* Make the x-window of frame F use the gnu icon bitmap. */
7487 x_bitmap_icon (struct frame *f, Lisp_Object file)
7489 ptrdiff_t bitmap_id;
7491 if (FRAME_X_WINDOW (f) == 0)
7492 return 1;
7494 /* Free up our existing icon bitmap and mask if any. */
7495 if (f->output_data.x->icon_bitmap > 0)
7496 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7497 f->output_data.x->icon_bitmap = 0;
7499 if (STRINGP (file))
7501 #ifdef USE_GTK
7502 /* Use gtk_window_set_icon_from_file () if available,
7503 It's not restricted to bitmaps */
7504 if (xg_set_icon (f, file))
7505 return 0;
7506 #endif /* USE_GTK */
7507 bitmap_id = x_create_bitmap_from_file (f, file);
7508 x_create_bitmap_mask (f, bitmap_id);
7510 else
7512 /* Create the GNU bitmap and mask if necessary. */
7513 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7515 ptrdiff_t rc = -1;
7517 #ifdef USE_GTK
7519 if (xg_set_icon (f, xg_default_icon_file)
7520 || xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7521 return 0;
7523 #elif defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7525 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7526 if (rc != -1)
7527 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7529 #endif
7531 /* If all else fails, use the (black and white) xbm image. */
7532 if (rc == -1)
7534 rc = x_create_bitmap_from_data (f, (char *) gnu_xbm_bits,
7535 gnu_xbm_width, gnu_xbm_height);
7536 if (rc == -1)
7537 return 1;
7539 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7540 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7544 /* The first time we create the GNU bitmap and mask,
7545 this increments the ref-count one extra time.
7546 As a result, the GNU bitmap and mask are never freed.
7547 That way, we don't have to worry about allocating it again. */
7548 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7550 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7553 x_wm_set_icon_pixmap (f, bitmap_id);
7554 f->output_data.x->icon_bitmap = bitmap_id;
7556 return 0;
7560 /* Make the x-window of frame F use a rectangle with text.
7561 Use ICON_NAME as the text. */
7564 x_text_icon (struct frame *f, const char *icon_name)
7566 if (FRAME_X_WINDOW (f) == 0)
7567 return 1;
7570 XTextProperty text;
7571 text.value = (unsigned char *) icon_name;
7572 text.encoding = XA_STRING;
7573 text.format = 8;
7574 text.nitems = strlen (icon_name);
7575 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7578 if (f->output_data.x->icon_bitmap > 0)
7579 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7580 f->output_data.x->icon_bitmap = 0;
7581 x_wm_set_icon_pixmap (f, 0);
7583 return 0;
7586 #define X_ERROR_MESSAGE_SIZE 200
7588 /* If non-nil, this should be a string.
7589 It means catch X errors and store the error message in this string.
7591 The reason we use a stack is that x_catch_error/x_uncatch_error can
7592 be called from a signal handler.
7595 struct x_error_message_stack {
7596 char string[X_ERROR_MESSAGE_SIZE];
7597 Display *dpy;
7598 struct x_error_message_stack *prev;
7600 static struct x_error_message_stack *x_error_message;
7602 /* An X error handler which stores the error message in
7603 *x_error_message. This is called from x_error_handler if
7604 x_catch_errors is in effect. */
7606 static void
7607 x_error_catcher (Display *display, XErrorEvent *event)
7609 XGetErrorText (display, event->error_code,
7610 x_error_message->string,
7611 X_ERROR_MESSAGE_SIZE);
7614 /* Begin trapping X errors for display DPY. Actually we trap X errors
7615 for all displays, but DPY should be the display you are actually
7616 operating on.
7618 After calling this function, X protocol errors no longer cause
7619 Emacs to exit; instead, they are recorded in the string
7620 stored in *x_error_message.
7622 Calling x_check_errors signals an Emacs error if an X error has
7623 occurred since the last call to x_catch_errors or x_check_errors.
7625 Calling x_uncatch_errors resumes the normal error handling. */
7627 void
7628 x_catch_errors (Display *dpy)
7630 struct x_error_message_stack *data = xmalloc (sizeof (*data));
7632 /* Make sure any errors from previous requests have been dealt with. */
7633 XSync (dpy, False);
7635 data->dpy = dpy;
7636 data->string[0] = 0;
7637 data->prev = x_error_message;
7638 x_error_message = data;
7641 /* Undo the last x_catch_errors call.
7642 DPY should be the display that was passed to x_catch_errors. */
7644 void
7645 x_uncatch_errors (void)
7647 struct x_error_message_stack *tmp;
7649 BLOCK_INPUT;
7651 /* The display may have been closed before this function is called.
7652 Check if it is still open before calling XSync. */
7653 if (x_display_info_for_display (x_error_message->dpy) != 0)
7654 XSync (x_error_message->dpy, False);
7656 tmp = x_error_message;
7657 x_error_message = x_error_message->prev;
7658 xfree (tmp);
7659 UNBLOCK_INPUT;
7662 /* If any X protocol errors have arrived since the last call to
7663 x_catch_errors or x_check_errors, signal an Emacs error using
7664 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7666 void
7667 x_check_errors (Display *dpy, const char *format)
7669 /* Make sure to catch any errors incurred so far. */
7670 XSync (dpy, False);
7672 if (x_error_message->string[0])
7674 char string[X_ERROR_MESSAGE_SIZE];
7675 memcpy (string, x_error_message->string, X_ERROR_MESSAGE_SIZE);
7676 x_uncatch_errors ();
7677 error (format, string);
7681 /* Nonzero if we had any X protocol errors
7682 since we did x_catch_errors on DPY. */
7685 x_had_errors_p (Display *dpy)
7687 /* Make sure to catch any errors incurred so far. */
7688 XSync (dpy, False);
7690 return x_error_message->string[0] != 0;
7693 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7695 void
7696 x_clear_errors (Display *dpy)
7698 x_error_message->string[0] = 0;
7701 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7702 * idea. --lorentey */
7703 /* Close off all unclosed x_catch_errors calls. */
7705 void
7706 x_fully_uncatch_errors (void)
7708 while (x_error_message)
7709 x_uncatch_errors ();
7711 #endif
7713 #if 0
7714 static unsigned int x_wire_count;
7715 x_trace_wire (void)
7717 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7719 #endif /* ! 0 */
7722 /* Handle SIGPIPE, which can happen when the connection to a server
7723 simply goes away. SIGPIPE is handled by x_connection_signal.
7724 Don't need to do anything, because the write which caused the
7725 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7726 which will do the appropriate cleanup for us. */
7728 static void
7729 x_connection_signal (int signalnum) /* If we don't have an argument, */
7730 /* some compilers complain in signal calls. */
7732 #ifdef USG
7733 /* USG systems forget handlers when they are used;
7734 must reestablish each time */
7735 signal (signalnum, x_connection_signal);
7736 #endif /* USG */
7740 /************************************************************************
7741 Handling X errors
7742 ************************************************************************/
7744 /* Error message passed to x_connection_closed. */
7746 static char *error_msg;
7748 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7749 the text of an error message that lead to the connection loss. */
7751 static void
7752 x_connection_closed (Display *dpy, const char *error_message)
7754 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7755 Lisp_Object frame, tail;
7756 int idx = SPECPDL_INDEX ();
7758 error_msg = (char *) alloca (strlen (error_message) + 1);
7759 strcpy (error_msg, error_message);
7760 handling_signal = 0;
7762 /* Inhibit redisplay while frames are being deleted. */
7763 specbind (Qinhibit_redisplay, Qt);
7765 if (dpyinfo)
7767 /* Protect display from being closed when we delete the last
7768 frame on it. */
7769 dpyinfo->reference_count++;
7770 dpyinfo->terminal->reference_count++;
7773 /* First delete frames whose mini-buffers are on frames
7774 that are on the dead display. */
7775 FOR_EACH_FRAME (tail, frame)
7777 Lisp_Object minibuf_frame;
7778 minibuf_frame
7779 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7780 if (FRAME_X_P (XFRAME (frame))
7781 && FRAME_X_P (XFRAME (minibuf_frame))
7782 && ! EQ (frame, minibuf_frame)
7783 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7784 delete_frame (frame, Qnoelisp);
7787 /* Now delete all remaining frames on the dead display.
7788 We are now sure none of these is used as the mini-buffer
7789 for another frame that we need to delete. */
7790 FOR_EACH_FRAME (tail, frame)
7791 if (FRAME_X_P (XFRAME (frame))
7792 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7794 /* Set this to t so that delete_frame won't get confused
7795 trying to find a replacement. */
7796 KVAR (FRAME_KBOARD (XFRAME (frame)), Vdefault_minibuffer_frame) = Qt;
7797 delete_frame (frame, Qnoelisp);
7800 /* If DPYINFO is null, this means we didn't open the display in the
7801 first place, so don't try to close it. */
7802 if (dpyinfo)
7804 /* We can not call XtCloseDisplay here because it calls XSync.
7805 XSync inside the error handler apparently hangs Emacs. On
7806 current Xt versions, this isn't needed either. */
7807 #ifdef USE_GTK
7808 /* A long-standing GTK bug prevents proper disconnect handling
7809 (https://bugzilla.gnome.org/show_bug.cgi?id=85715). Once,
7810 the resulting Glib error message loop filled a user's disk.
7811 To avoid this, kill Emacs unconditionally on disconnect. */
7812 shut_down_emacs (0, 0, Qnil);
7813 fprintf (stderr, "%s\n\
7814 When compiled with GTK, Emacs cannot recover from X disconnects.\n\
7815 This is a GTK bug: https://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
7816 For details, see etc/PROBLEMS.\n",
7817 error_msg);
7818 abort ();
7819 #endif /* USE_GTK */
7821 /* Indicate that this display is dead. */
7822 dpyinfo->display = 0;
7824 dpyinfo->reference_count--;
7825 dpyinfo->terminal->reference_count--;
7826 if (dpyinfo->reference_count != 0)
7827 /* We have just closed all frames on this display. */
7828 abort ();
7831 Lisp_Object tmp;
7832 XSETTERMINAL (tmp, dpyinfo->terminal);
7833 Fdelete_terminal (tmp, Qnoelisp);
7837 if (terminal_list == 0)
7839 fprintf (stderr, "%s\n", error_msg);
7840 Fkill_emacs (make_number (70));
7841 /* NOTREACHED */
7844 /* Ordinary stack unwind doesn't deal with these. */
7845 #ifdef SIGIO
7846 sigunblock (sigmask (SIGIO));
7847 #endif
7848 sigunblock (sigmask (SIGALRM));
7849 TOTALLY_UNBLOCK_INPUT;
7851 unbind_to (idx, Qnil);
7852 clear_waiting_for_input ();
7854 /* Tell GCC not to suggest attribute 'noreturn' for this function. */
7855 IF_LINT (if (! terminal_list) return; )
7857 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7858 longjmp), because returning from this function would get us back into
7859 Xlib's code which will directly call `exit'. */
7860 error ("%s", error_msg);
7863 /* We specifically use it before defining it, so that gcc doesn't inline it,
7864 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7865 static void x_error_quitter (Display *, XErrorEvent *);
7867 /* This is the first-level handler for X protocol errors.
7868 It calls x_error_quitter or x_error_catcher. */
7870 static int
7871 x_error_handler (Display *display, XErrorEvent *event)
7873 #ifdef HAVE_GTK3
7874 if (event->error_code == BadMatch
7875 && event->request_code == X_SetInputFocus
7876 && event->minor_code == 0)
7878 return 0;
7880 #endif
7882 if (x_error_message)
7883 x_error_catcher (display, event);
7884 else
7885 x_error_quitter (display, event);
7886 return 0;
7889 /* This is the usual handler for X protocol errors.
7890 It kills all frames on the display that we got the error for.
7891 If that was the only one, it prints an error message and kills Emacs. */
7893 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7895 /* On older GCC versions, just putting x_error_quitter
7896 after x_error_handler prevents inlining into the former. */
7898 static void NO_INLINE
7899 x_error_quitter (Display *display, XErrorEvent *event)
7901 char buf[256], buf1[356];
7903 /* Ignore BadName errors. They can happen because of fonts
7904 or colors that are not defined. */
7906 if (event->error_code == BadName)
7907 return;
7909 /* Note that there is no real way portable across R3/R4 to get the
7910 original error handler. */
7912 XGetErrorText (display, event->error_code, buf, sizeof (buf));
7913 sprintf (buf1, "X protocol error: %s on protocol request %d",
7914 buf, event->request_code);
7915 x_connection_closed (display, buf1);
7919 /* This is the handler for X IO errors, always.
7920 It kills all frames on the display that we lost touch with.
7921 If that was the only one, it prints an error message and kills Emacs. */
7923 static int
7924 x_io_error_quitter (Display *display)
7926 char buf[256];
7928 snprintf (buf, sizeof buf, "Connection lost to X server `%s'",
7929 DisplayString (display));
7930 x_connection_closed (display, buf);
7931 return 0;
7934 /* Changing the font of the frame. */
7936 /* Give frame F the font FONT-OBJECT as its default font. The return
7937 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
7938 frame. If it is negative, generate a new fontset from
7939 FONT-OBJECT. */
7941 Lisp_Object
7942 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
7944 struct font *font = XFONT_OBJECT (font_object);
7946 if (fontset < 0)
7947 fontset = fontset_from_font (font_object);
7948 FRAME_FONTSET (f) = fontset;
7949 if (FRAME_FONT (f) == font)
7950 /* This font is already set in frame F. There's nothing more to
7951 do. */
7952 return font_object;
7954 FRAME_FONT (f) = font;
7955 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7956 FRAME_COLUMN_WIDTH (f) = font->average_width;
7957 FRAME_SPACE_WIDTH (f) = font->space_width;
7958 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
7960 compute_fringe_widths (f, 1);
7962 /* Compute the scroll bar width in character columns. */
7963 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7965 int wid = FRAME_COLUMN_WIDTH (f);
7966 FRAME_CONFIG_SCROLL_BAR_COLS (f)
7967 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
7969 else
7971 int wid = FRAME_COLUMN_WIDTH (f);
7972 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7975 if (FRAME_X_WINDOW (f) != 0)
7977 /* Don't change the size of a tip frame; there's no point in
7978 doing it because it's done in Fx_show_tip, and it leads to
7979 problems because the tip frame has no widget. */
7980 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
7981 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7984 #ifdef HAVE_X_I18N
7985 if (FRAME_XIC (f)
7986 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
7988 BLOCK_INPUT;
7989 xic_set_xfontset (f, SSDATA (fontset_ascii (fontset)));
7990 UNBLOCK_INPUT;
7992 #endif
7994 return font_object;
7998 /***********************************************************************
7999 X Input Methods
8000 ***********************************************************************/
8002 #ifdef HAVE_X_I18N
8004 #ifdef HAVE_X11R6
8006 /* XIM destroy callback function, which is called whenever the
8007 connection to input method XIM dies. CLIENT_DATA contains a
8008 pointer to the x_display_info structure corresponding to XIM. */
8010 static void
8011 xim_destroy_callback (XIM xim, XPointer client_data, XPointer call_data)
8013 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
8014 Lisp_Object frame, tail;
8016 BLOCK_INPUT;
8018 /* No need to call XDestroyIC.. */
8019 FOR_EACH_FRAME (tail, frame)
8021 struct frame *f = XFRAME (frame);
8022 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
8024 FRAME_XIC (f) = NULL;
8025 xic_free_xfontset (f);
8029 /* No need to call XCloseIM. */
8030 dpyinfo->xim = NULL;
8031 XFree (dpyinfo->xim_styles);
8032 UNBLOCK_INPUT;
8035 #endif /* HAVE_X11R6 */
8037 #ifdef HAVE_X11R6
8038 /* This isn't prototyped in OSF 5.0 or 5.1a. */
8039 extern char *XSetIMValues (XIM, ...);
8040 #endif
8042 /* Open the connection to the XIM server on display DPYINFO.
8043 RESOURCE_NAME is the resource name Emacs uses. */
8045 static void
8046 xim_open_dpy (struct x_display_info *dpyinfo, char *resource_name)
8048 XIM xim;
8050 #ifdef HAVE_XIM
8051 if (use_xim)
8053 if (dpyinfo->xim)
8054 XCloseIM (dpyinfo->xim);
8055 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8056 emacs_class);
8057 dpyinfo->xim = xim;
8059 if (xim)
8061 #ifdef HAVE_X11R6
8062 XIMCallback destroy;
8063 #endif
8065 /* Get supported styles and XIM values. */
8066 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8068 #ifdef HAVE_X11R6
8069 destroy.callback = xim_destroy_callback;
8070 destroy.client_data = (XPointer)dpyinfo;
8071 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8072 #endif
8076 else
8077 #endif /* HAVE_XIM */
8078 dpyinfo->xim = NULL;
8082 #ifdef HAVE_X11R6_XIM
8084 /* XIM instantiate callback function, which is called whenever an XIM
8085 server is available. DISPLAY is the display of the XIM.
8086 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8087 when the callback was registered. */
8089 static void
8090 xim_instantiate_callback (Display *display, XPointer client_data, XPointer call_data)
8092 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8093 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8095 /* We don't support multiple XIM connections. */
8096 if (dpyinfo->xim)
8097 return;
8099 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8101 /* Create XIC for the existing frames on the same display, as long
8102 as they have no XIC. */
8103 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8105 Lisp_Object tail, frame;
8107 BLOCK_INPUT;
8108 FOR_EACH_FRAME (tail, frame)
8110 struct frame *f = XFRAME (frame);
8112 if (FRAME_X_P (f)
8113 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8114 if (FRAME_XIC (f) == NULL)
8116 create_frame_xic (f);
8117 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8118 xic_set_statusarea (f);
8119 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8121 struct window *w = XWINDOW (f->selected_window);
8122 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8127 UNBLOCK_INPUT;
8131 #endif /* HAVE_X11R6_XIM */
8134 /* Open a connection to the XIM server on display DPYINFO.
8135 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8136 connection only at the first time. On X11R6, open the connection
8137 in the XIM instantiate callback function. */
8139 static void
8140 xim_initialize (struct x_display_info *dpyinfo, char *resource_name)
8142 dpyinfo->xim = NULL;
8143 #ifdef HAVE_XIM
8144 if (use_xim)
8146 #ifdef HAVE_X11R6_XIM
8147 struct xim_inst_t *xim_inst;
8148 ptrdiff_t len;
8150 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
8151 dpyinfo->xim_callback_data = xim_inst;
8152 xim_inst->dpyinfo = dpyinfo;
8153 len = strlen (resource_name);
8154 xim_inst->resource_name = (char *) xmalloc (len + 1);
8155 memcpy (xim_inst->resource_name, resource_name, len + 1);
8156 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8157 resource_name, emacs_class,
8158 xim_instantiate_callback,
8159 /* This is XPointer in XFree86
8160 but (XPointer *) on Tru64, at
8161 least, hence the configure test. */
8162 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8163 #else /* not HAVE_X11R6_XIM */
8164 xim_open_dpy (dpyinfo, resource_name);
8165 #endif /* not HAVE_X11R6_XIM */
8167 #endif /* HAVE_XIM */
8171 /* Close the connection to the XIM server on display DPYINFO. */
8173 static void
8174 xim_close_dpy (struct x_display_info *dpyinfo)
8176 #ifdef HAVE_XIM
8177 if (use_xim)
8179 #ifdef HAVE_X11R6_XIM
8180 if (dpyinfo->display)
8181 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8182 NULL, emacs_class,
8183 xim_instantiate_callback, NULL);
8184 xfree (dpyinfo->xim_callback_data->resource_name);
8185 xfree (dpyinfo->xim_callback_data);
8186 #endif /* HAVE_X11R6_XIM */
8187 if (dpyinfo->display)
8188 XCloseIM (dpyinfo->xim);
8189 dpyinfo->xim = NULL;
8190 XFree (dpyinfo->xim_styles);
8192 #endif /* HAVE_XIM */
8195 #endif /* not HAVE_X11R6_XIM */
8199 /* Calculate the absolute position in frame F
8200 from its current recorded position values and gravity. */
8202 static void
8203 x_calc_absolute_position (struct frame *f)
8205 int flags = f->size_hint_flags;
8207 /* We have nothing to do if the current position
8208 is already for the top-left corner. */
8209 if (! ((flags & XNegative) || (flags & YNegative)))
8210 return;
8212 /* Treat negative positions as relative to the leftmost bottommost
8213 position that fits on the screen. */
8214 if (flags & XNegative)
8215 f->left_pos = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
8216 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8219 int height = FRAME_PIXEL_HEIGHT (f);
8221 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8222 /* Something is fishy here. When using Motif, starting Emacs with
8223 `-g -0-0', the frame appears too low by a few pixels.
8225 This seems to be so because initially, while Emacs is starting,
8226 the column widget's height and the frame's pixel height are
8227 different. The column widget's height is the right one. In
8228 later invocations, when Emacs is up, the frame's pixel height
8229 is right, though.
8231 It's not obvious where the initial small difference comes from.
8232 2000-12-01, gerd. */
8234 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8235 #endif
8237 if (flags & YNegative)
8238 f->top_pos = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
8239 - height + f->top_pos;
8242 /* The left_pos and top_pos
8243 are now relative to the top and left screen edges,
8244 so the flags should correspond. */
8245 f->size_hint_flags &= ~ (XNegative | YNegative);
8248 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8249 to really change the position, and 0 when calling from
8250 x_make_frame_visible (in that case, XOFF and YOFF are the current
8251 position values). It is -1 when calling from x_set_frame_parameters,
8252 which means, do adjust for borders but don't change the gravity. */
8254 void
8255 x_set_offset (struct frame *f, register int xoff, register int yoff, int change_gravity)
8257 int modified_top, modified_left;
8259 if (change_gravity > 0)
8261 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8262 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8264 f->top_pos = yoff;
8265 f->left_pos = xoff;
8266 f->size_hint_flags &= ~ (XNegative | YNegative);
8267 if (xoff < 0)
8268 f->size_hint_flags |= XNegative;
8269 if (yoff < 0)
8270 f->size_hint_flags |= YNegative;
8271 f->win_gravity = NorthWestGravity;
8273 x_calc_absolute_position (f);
8275 BLOCK_INPUT;
8276 x_wm_set_size_hint (f, (long) 0, 0);
8278 modified_left = f->left_pos;
8279 modified_top = f->top_pos;
8281 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8283 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8284 than the WM decorations. So we use the calculated offset instead
8285 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8286 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8287 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8290 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8291 modified_left, modified_top);
8293 x_sync_with_move (f, f->left_pos, f->top_pos,
8294 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8295 ? 1 : 0);
8297 /* change_gravity is non-zero when this function is called from Lisp to
8298 programmatically move a frame. In that case, we call
8299 x_check_expected_move to discover if we have a "Type A" or "Type B"
8300 window manager, and, for a "Type A" window manager, adjust the position
8301 of the frame.
8303 We call x_check_expected_move if a programmatic move occurred, and
8304 either the window manager type (A/B) is unknown or it is Type A but we
8305 need to compute the top/left offset adjustment for this frame. */
8307 if (change_gravity != 0 &&
8308 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8309 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8310 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8311 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8312 x_check_expected_move (f, modified_left, modified_top);
8314 UNBLOCK_INPUT;
8317 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8318 on the root window for frame F contains ATOMNAME.
8319 This is how a WM check shall be done according to the Window Manager
8320 Specification/Extended Window Manager Hints at
8321 http://freedesktop.org/wiki/Specifications/wm-spec. */
8323 static int
8324 wm_supports (struct frame *f, Atom want_atom)
8326 Atom actual_type;
8327 unsigned long actual_size, bytes_remaining;
8328 int i, rc, actual_format;
8329 Window wmcheck_window;
8330 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8331 Window target_window = dpyinfo->root_window;
8332 long max_len = 65536;
8333 Display *dpy = FRAME_X_DISPLAY (f);
8334 unsigned char *tmp_data = NULL;
8335 Atom target_type = XA_WINDOW;
8337 BLOCK_INPUT;
8339 x_catch_errors (dpy);
8340 rc = XGetWindowProperty (dpy, target_window,
8341 dpyinfo->Xatom_net_supporting_wm_check,
8342 0, max_len, False, target_type,
8343 &actual_type, &actual_format, &actual_size,
8344 &bytes_remaining, &tmp_data);
8346 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8348 if (tmp_data) XFree (tmp_data);
8349 x_uncatch_errors ();
8350 UNBLOCK_INPUT;
8351 return 0;
8354 wmcheck_window = *(Window *) tmp_data;
8355 XFree (tmp_data);
8357 /* Check if window exists. */
8358 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8359 x_sync (f);
8360 if (x_had_errors_p (dpy))
8362 x_uncatch_errors ();
8363 UNBLOCK_INPUT;
8364 return 0;
8367 if (dpyinfo->net_supported_window != wmcheck_window)
8369 /* Window changed, reload atoms */
8370 if (dpyinfo->net_supported_atoms != NULL)
8371 XFree (dpyinfo->net_supported_atoms);
8372 dpyinfo->net_supported_atoms = NULL;
8373 dpyinfo->nr_net_supported_atoms = 0;
8374 dpyinfo->net_supported_window = 0;
8376 target_type = XA_ATOM;
8377 tmp_data = NULL;
8378 rc = XGetWindowProperty (dpy, target_window,
8379 dpyinfo->Xatom_net_supported,
8380 0, max_len, False, target_type,
8381 &actual_type, &actual_format, &actual_size,
8382 &bytes_remaining, &tmp_data);
8384 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8386 if (tmp_data) XFree (tmp_data);
8387 x_uncatch_errors ();
8388 UNBLOCK_INPUT;
8389 return 0;
8392 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8393 dpyinfo->nr_net_supported_atoms = actual_size;
8394 dpyinfo->net_supported_window = wmcheck_window;
8397 rc = 0;
8399 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8400 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8402 x_uncatch_errors ();
8403 UNBLOCK_INPUT;
8405 return rc;
8408 static void
8409 set_wm_state (Lisp_Object frame, int add, Atom atom, Atom value)
8411 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (frame));
8413 x_send_client_event (frame, make_number (0), frame,
8414 dpyinfo->Xatom_net_wm_state,
8415 make_number (32),
8416 /* 1 = add, 0 = remove */
8417 Fcons
8418 (make_number (add ? 1 : 0),
8419 Fcons
8420 (make_fixnum_or_float (atom),
8421 value != 0
8422 ? Fcons (make_fixnum_or_float (value), Qnil)
8423 : Qnil)));
8426 void
8427 x_set_sticky (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
8429 Lisp_Object frame;
8430 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8432 XSETFRAME (frame, f);
8434 set_wm_state (frame, NILP (new_value) ? 0 : 1,
8435 dpyinfo->Xatom_net_wm_state_sticky, None);
8438 /* Return the current _NET_WM_STATE.
8439 SIZE_STATE is set to one of the FULLSCREEN_* values.
8440 STICKY is set to 1 if the sticky state is set, 0 if not.
8442 Return non-zero if we are not hidden, zero if we are. */
8444 static int
8445 get_current_wm_state (struct frame *f,
8446 Window window,
8447 int *size_state,
8448 int *sticky)
8450 Atom actual_type;
8451 unsigned long actual_size, bytes_remaining;
8452 int i, rc, actual_format, is_hidden = 0;
8453 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8454 long max_len = 65536;
8455 Display *dpy = FRAME_X_DISPLAY (f);
8456 unsigned char *tmp_data = NULL;
8457 Atom target_type = XA_ATOM;
8459 *sticky = 0;
8460 *size_state = FULLSCREEN_NONE;
8462 BLOCK_INPUT;
8463 x_catch_errors (dpy);
8464 rc = XGetWindowProperty (dpy, window, dpyinfo->Xatom_net_wm_state,
8465 0, max_len, False, target_type,
8466 &actual_type, &actual_format, &actual_size,
8467 &bytes_remaining, &tmp_data);
8469 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
8471 if (tmp_data) XFree (tmp_data);
8472 x_uncatch_errors ();
8473 UNBLOCK_INPUT;
8474 return ! f->iconified;
8477 x_uncatch_errors ();
8479 for (i = 0; i < actual_size; ++i)
8481 Atom a = ((Atom*)tmp_data)[i];
8482 if (a == dpyinfo->Xatom_net_wm_state_hidden)
8483 is_hidden = 1;
8484 else if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
8486 if (*size_state == FULLSCREEN_HEIGHT)
8487 *size_state = FULLSCREEN_MAXIMIZED;
8488 else
8489 *size_state = FULLSCREEN_WIDTH;
8491 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
8493 if (*size_state == FULLSCREEN_WIDTH)
8494 *size_state = FULLSCREEN_MAXIMIZED;
8495 else
8496 *size_state = FULLSCREEN_HEIGHT;
8498 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen)
8499 *size_state = FULLSCREEN_BOTH;
8500 else if (a == dpyinfo->Xatom_net_wm_state_sticky)
8501 *sticky = 1;
8504 if (tmp_data) XFree (tmp_data);
8505 UNBLOCK_INPUT;
8506 return ! is_hidden;
8509 /* Do fullscreen as specified in extended window manager hints */
8511 static int
8512 do_ewmh_fullscreen (struct frame *f)
8514 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8515 int have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state);
8516 int cur, dummy;
8518 (void)get_current_wm_state (f, FRAME_OUTER_WINDOW (f), &cur, &dummy);
8520 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8521 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8522 if (!have_net_atom)
8523 have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state_fullscreen);
8525 if (have_net_atom && cur != f->want_fullscreen)
8527 Lisp_Object frame;
8529 XSETFRAME (frame, f);
8531 /* Keep number of calls to set_wm_state as low as possible.
8532 Some window managers, or possible Gtk+, hangs when too many
8533 are sent at once. */
8534 switch (f->want_fullscreen)
8536 case FULLSCREEN_BOTH:
8537 if (cur == FULLSCREEN_WIDTH || cur == FULLSCREEN_MAXIMIZED
8538 || cur == FULLSCREEN_HEIGHT)
8539 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8540 dpyinfo->Xatom_net_wm_state_maximized_vert);
8541 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8542 break;
8543 case FULLSCREEN_WIDTH:
8544 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_HEIGHT
8545 || cur == FULLSCREEN_MAXIMIZED)
8546 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8547 dpyinfo->Xatom_net_wm_state_maximized_vert);
8548 if (cur != FULLSCREEN_MAXIMIZED)
8549 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz, None);
8550 break;
8551 case FULLSCREEN_HEIGHT:
8552 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_WIDTH
8553 || cur == FULLSCREEN_MAXIMIZED)
8554 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen,
8555 dpyinfo->Xatom_net_wm_state_maximized_horz);
8556 if (cur != FULLSCREEN_MAXIMIZED)
8557 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_vert, None);
8558 break;
8559 case FULLSCREEN_MAXIMIZED:
8560 if (cur == FULLSCREEN_BOTH)
8561 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8562 set_wm_state (frame, 1, dpyinfo->Xatom_net_wm_state_maximized_horz,
8563 dpyinfo->Xatom_net_wm_state_maximized_vert);
8564 break;
8565 case FULLSCREEN_NONE:
8566 if (cur == FULLSCREEN_BOTH)
8567 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_fullscreen, None);
8568 else
8569 set_wm_state (frame, 0, dpyinfo->Xatom_net_wm_state_maximized_horz,
8570 dpyinfo->Xatom_net_wm_state_maximized_vert);
8573 f->want_fullscreen = FULLSCREEN_NONE;
8577 return have_net_atom;
8580 static void
8581 XTfullscreen_hook (FRAME_PTR f)
8583 if (f->async_visible)
8585 BLOCK_INPUT;
8586 x_check_fullscreen (f);
8587 x_sync (f);
8588 UNBLOCK_INPUT;
8593 static int
8594 x_handle_net_wm_state (struct frame *f, XPropertyEvent *event)
8596 int value = FULLSCREEN_NONE;
8597 Lisp_Object lval;
8598 int sticky = 0;
8599 int not_hidden = get_current_wm_state (f, event->window, &value, &sticky);
8601 lval = Qnil;
8602 switch (value)
8604 case FULLSCREEN_WIDTH:
8605 lval = Qfullwidth;
8606 break;
8607 case FULLSCREEN_HEIGHT:
8608 lval = Qfullheight;
8609 break;
8610 case FULLSCREEN_BOTH:
8611 lval = Qfullboth;
8612 break;
8613 case FULLSCREEN_MAXIMIZED:
8614 lval = Qmaximized;
8615 break;
8618 store_frame_param (f, Qfullscreen, lval);
8619 store_frame_param (f, Qsticky, sticky ? Qt : Qnil);
8621 return not_hidden;
8624 /* Check if we need to resize the frame due to a fullscreen request.
8625 If so needed, resize the frame. */
8626 static void
8627 x_check_fullscreen (struct frame *f)
8629 if (do_ewmh_fullscreen (f))
8630 return;
8632 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
8633 return; /* Only fullscreen without WM or with EWM hints (above). */
8635 /* Setting fullscreen to nil doesn't do anything. We could save the
8636 last non-fullscreen size and restore it, but it seems like a
8637 lot of work for this unusual case (no window manager running). */
8639 if (f->want_fullscreen != FULLSCREEN_NONE)
8641 int width = FRAME_PIXEL_WIDTH (f), height = FRAME_PIXEL_HEIGHT (f);
8642 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8644 switch (f->want_fullscreen)
8646 /* No difference between these two when there is no WM */
8647 case FULLSCREEN_BOTH:
8648 case FULLSCREEN_MAXIMIZED:
8649 width = x_display_pixel_width (dpyinfo);
8650 height = x_display_pixel_height (dpyinfo);
8651 break;
8652 case FULLSCREEN_WIDTH:
8653 width = x_display_pixel_width (dpyinfo);
8654 break;
8655 case FULLSCREEN_HEIGHT:
8656 height = x_display_pixel_height (dpyinfo);
8659 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8660 width, height);
8664 /* This function is called by x_set_offset to determine whether the window
8665 manager interfered with the positioning of the frame. Type A window
8666 managers position the surrounding window manager decorations a small
8667 amount above and left of the user-supplied position. Type B window
8668 managers position the surrounding window manager decorations at the
8669 user-specified position. If we detect a Type A window manager, we
8670 compensate by moving the window right and down by the proper amount. */
8672 static void
8673 x_check_expected_move (struct frame *f, int expected_left, int expected_top)
8675 int current_left = 0, current_top = 0;
8677 /* x_real_positions returns the left and top offsets of the outermost
8678 window manager window around the frame. */
8680 x_real_positions (f, &current_left, &current_top);
8682 if (current_left != expected_left || current_top != expected_top)
8684 /* It's a "Type A" window manager. */
8686 int adjusted_left;
8687 int adjusted_top;
8689 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8690 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8691 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8693 /* Now fix the mispositioned frame's location. */
8695 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8696 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8698 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8699 adjusted_left, adjusted_top);
8701 x_sync_with_move (f, expected_left, expected_top, 0);
8703 else
8704 /* It's a "Type B" window manager. We don't have to adjust the
8705 frame's position. */
8707 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8711 /* Wait for XGetGeometry to return up-to-date position information for a
8712 recently-moved frame. Call this immediately after calling XMoveWindow.
8713 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8714 frame has been moved to, so we use a fuzzy position comparison instead
8715 of an exact comparison. */
8717 static void
8718 x_sync_with_move (struct frame *f, int left, int top, int fuzzy)
8720 int count = 0;
8722 while (count++ < 50)
8724 int current_left = 0, current_top = 0;
8726 /* In theory, this call to XSync only needs to happen once, but in
8727 practice, it doesn't seem to work, hence the need for the surrounding
8728 loop. */
8730 XSync (FRAME_X_DISPLAY (f), False);
8731 x_real_positions (f, &current_left, &current_top);
8733 if (fuzzy)
8735 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8736 pixels. */
8738 if (eabs (current_left - left) <= 10
8739 && eabs (current_top - top) <= 40)
8740 return;
8742 else if (current_left == left && current_top == top)
8743 return;
8746 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8747 will then return up-to-date position info. */
8749 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8753 /* Wait for an event on frame F matching EVENTTYPE. */
8754 void
8755 x_wait_for_event (struct frame *f, int eventtype)
8757 int level = interrupt_input_blocked;
8759 SELECT_TYPE fds;
8760 EMACS_TIME tmo, tmo_at, time_now;
8761 int fd = ConnectionNumber (FRAME_X_DISPLAY (f));
8763 pending_event_wait.f = f;
8764 pending_event_wait.eventtype = eventtype;
8766 /* Set timeout to 0.1 second. Hopefully not noticeable.
8767 Maybe it should be configurable. */
8768 EMACS_SET_SECS_USECS (tmo, 0, 100000);
8769 EMACS_GET_TIME (tmo_at);
8770 EMACS_ADD_TIME (tmo_at, tmo_at, tmo);
8772 while (pending_event_wait.eventtype)
8774 interrupt_input_pending = 1;
8775 TOTALLY_UNBLOCK_INPUT;
8776 /* XTread_socket is called after unblock. */
8777 BLOCK_INPUT;
8778 interrupt_input_blocked = level;
8780 FD_ZERO (&fds);
8781 FD_SET (fd, &fds);
8783 EMACS_GET_TIME (time_now);
8784 EMACS_SUB_TIME (tmo, tmo_at, time_now);
8786 if (EMACS_TIME_NEG_P (tmo) || select (fd+1, &fds, NULL, NULL, &tmo) == 0)
8787 break; /* Timeout */
8789 pending_event_wait.f = 0;
8790 pending_event_wait.eventtype = 0;
8794 /* Change the size of frame F's X window to COLS/ROWS in the case F
8795 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8796 top-left-corner window gravity for this size change and subsequent
8797 size changes. Otherwise we leave the window gravity unchanged. */
8799 static void
8800 x_set_window_size_1 (struct frame *f, int change_gravity, int cols, int rows)
8802 int pixelwidth, pixelheight;
8804 check_frame_size (f, &rows, &cols);
8805 f->scroll_bar_actual_width
8806 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8808 : FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f));
8810 compute_fringe_widths (f, 0);
8812 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
8813 + FRAME_TOOLBAR_WIDTH (f);
8814 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
8815 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
8817 if (change_gravity) f->win_gravity = NorthWestGravity;
8818 x_wm_set_size_hint (f, (long) 0, 0);
8819 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8820 pixelwidth, pixelheight);
8823 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8824 receive in the ConfigureNotify event; if we get what we asked
8825 for, then the event won't cause the screen to become garbaged, so
8826 we have to make sure to do it here. */
8827 SET_FRAME_GARBAGED (f);
8829 /* Now, strictly speaking, we can't be sure that this is accurate,
8830 but the window manager will get around to dealing with the size
8831 change request eventually, and we'll hear how it went when the
8832 ConfigureNotify event gets here.
8834 We could just not bother storing any of this information here,
8835 and let the ConfigureNotify event set everything up, but that
8836 might be kind of confusing to the Lisp code, since size changes
8837 wouldn't be reported in the frame parameters until some random
8838 point in the future when the ConfigureNotify event arrives.
8840 We pass 1 for DELAY since we can't run Lisp code inside of
8841 a BLOCK_INPUT. */
8843 /* But the ConfigureNotify may in fact never arrive, and then this is
8844 not right if the frame is visible. Instead wait (with timeout)
8845 for the ConfigureNotify. */
8846 if (f->async_visible)
8847 x_wait_for_event (f, ConfigureNotify);
8848 else
8850 change_frame_size (f, rows, cols, 0, 1, 0);
8851 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8852 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8853 x_sync (f);
8858 /* Call this to change the size of frame F's x-window.
8859 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8860 for this size change and subsequent size changes.
8861 Otherwise we leave the window gravity unchanged. */
8863 void
8864 x_set_window_size (struct frame *f, int change_gravity, int cols, int rows)
8866 BLOCK_INPUT;
8868 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8870 int r, c;
8872 /* When the frame is maximized/fullscreen or running under for
8873 example Xmonad, x_set_window_size_1 will be a no-op.
8874 In that case, the right thing to do is extend rows/cols to
8875 the current frame size. We do that first if x_set_window_size_1
8876 turns out to not be a no-op (there is no way to know).
8877 The size will be adjusted again if the frame gets a
8878 ConfigureNotify event as a result of x_set_window_size. */
8879 int pixelh = FRAME_PIXEL_HEIGHT (f);
8880 #ifdef USE_X_TOOLKIT
8881 /* The menu bar is not part of text lines. The tool bar
8882 is however. */
8883 pixelh -= FRAME_MENUBAR_HEIGHT (f);
8884 #endif
8885 r = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelh);
8886 /* Update f->scroll_bar_actual_width because it is used in
8887 FRAME_PIXEL_WIDTH_TO_TEXT_COLS. */
8888 f->scroll_bar_actual_width
8889 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
8890 c = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, FRAME_PIXEL_WIDTH (f));
8891 change_frame_size (f, r, c, 0, 1, 0);
8894 #ifdef USE_GTK
8895 if (FRAME_GTK_WIDGET (f))
8896 xg_frame_set_char_size (f, cols, rows);
8897 else
8898 x_set_window_size_1 (f, change_gravity, cols, rows);
8899 #else /* not USE_GTK */
8901 x_set_window_size_1 (f, change_gravity, cols, rows);
8903 #endif /* not USE_GTK */
8905 /* If cursor was outside the new size, mark it as off. */
8906 mark_window_cursors_off (XWINDOW (f->root_window));
8908 /* Clear out any recollection of where the mouse highlighting was,
8909 since it might be in a place that's outside the new frame size.
8910 Actually checking whether it is outside is a pain in the neck,
8911 so don't try--just let the highlighting be done afresh with new size. */
8912 cancel_mouse_face (f);
8914 UNBLOCK_INPUT;
8917 /* Mouse warping. */
8919 void
8920 x_set_mouse_position (struct frame *f, int x, int y)
8922 int pix_x, pix_y;
8924 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8925 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8927 if (pix_x < 0) pix_x = 0;
8928 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8930 if (pix_y < 0) pix_y = 0;
8931 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8933 BLOCK_INPUT;
8935 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8936 0, 0, 0, 0, pix_x, pix_y);
8937 UNBLOCK_INPUT;
8940 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8942 void
8943 x_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
8945 BLOCK_INPUT;
8947 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8948 0, 0, 0, 0, pix_x, pix_y);
8949 UNBLOCK_INPUT;
8952 /* Raise frame F. */
8954 void
8955 x_raise_frame (struct frame *f)
8957 BLOCK_INPUT;
8958 if (f->async_visible)
8959 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8961 XFlush (FRAME_X_DISPLAY (f));
8962 UNBLOCK_INPUT;
8965 /* Lower frame F. */
8967 static void
8968 x_lower_frame (struct frame *f)
8970 if (f->async_visible)
8972 BLOCK_INPUT;
8973 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8974 XFlush (FRAME_X_DISPLAY (f));
8975 UNBLOCK_INPUT;
8979 /* Activate frame with Extended Window Manager Hints */
8981 void
8982 x_ewmh_activate_frame (FRAME_PTR f)
8984 /* See Window Manager Specification/Extended Window Manager Hints at
8985 http://freedesktop.org/wiki/Specifications/wm-spec */
8987 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8988 if (f->async_visible && wm_supports (f, dpyinfo->Xatom_net_active_window))
8990 Lisp_Object frame;
8991 XSETFRAME (frame, f);
8992 x_send_client_event (frame, make_number (0), frame,
8993 dpyinfo->Xatom_net_active_window,
8994 make_number (32),
8995 Fcons (make_number (1),
8996 Fcons (make_number (last_user_time),
8997 Qnil)));
9001 static void
9002 XTframe_raise_lower (FRAME_PTR f, int raise_flag)
9004 if (raise_flag)
9005 x_raise_frame (f);
9006 else
9007 x_lower_frame (f);
9010 /* XEmbed implementation. */
9012 #if defined USE_X_TOOLKIT || ! defined USE_GTK
9014 /* XEmbed implementation. */
9016 #define XEMBED_VERSION 0
9018 static void
9019 xembed_set_info (struct frame *f, enum xembed_info flags)
9021 unsigned long data[2];
9022 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9024 data[0] = XEMBED_VERSION;
9025 data[1] = flags;
9027 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9028 dpyinfo->Xatom_XEMBED_INFO, dpyinfo->Xatom_XEMBED_INFO,
9029 32, PropModeReplace, (unsigned char *) data, 2);
9031 #endif /* defined USE_X_TOOLKIT || ! defined USE_GTK */
9033 static void
9034 xembed_send_message (struct frame *f, Time t, enum xembed_message msg,
9035 long int detail, long int data1, long int data2)
9037 XEvent event;
9039 event.xclient.type = ClientMessage;
9040 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
9041 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
9042 event.xclient.format = 32;
9043 event.xclient.data.l[0] = t;
9044 event.xclient.data.l[1] = msg;
9045 event.xclient.data.l[2] = detail;
9046 event.xclient.data.l[3] = data1;
9047 event.xclient.data.l[4] = data2;
9049 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9050 False, NoEventMask, &event);
9051 XSync (FRAME_X_DISPLAY (f), False);
9054 /* Change of visibility. */
9056 /* This tries to wait until the frame is really visible.
9057 However, if the window manager asks the user where to position
9058 the frame, this will return before the user finishes doing that.
9059 The frame will not actually be visible at that time,
9060 but it will become visible later when the window manager
9061 finishes with it. */
9063 void
9064 x_make_frame_visible (struct frame *f)
9066 Lisp_Object type;
9067 int original_top, original_left;
9068 int retry_count = 2;
9070 retry:
9072 BLOCK_INPUT;
9074 type = x_icon_type (f);
9075 if (!NILP (type))
9076 x_bitmap_icon (f, type);
9078 if (! FRAME_VISIBLE_P (f))
9080 /* We test FRAME_GARBAGED_P here to make sure we don't
9081 call x_set_offset a second time
9082 if we get to x_make_frame_visible a second time
9083 before the window gets really visible. */
9084 if (! FRAME_ICONIFIED_P (f)
9085 && ! FRAME_X_EMBEDDED_P (f)
9086 && ! f->output_data.x->asked_for_visible)
9087 x_set_offset (f, f->left_pos, f->top_pos, 0);
9089 f->output_data.x->asked_for_visible = 1;
9091 if (! EQ (Vx_no_window_manager, Qt))
9092 x_wm_set_window_state (f, NormalState);
9093 #ifdef USE_X_TOOLKIT
9094 if (FRAME_X_EMBEDDED_P (f))
9095 xembed_set_info (f, XEMBED_MAPPED);
9096 else
9098 /* This was XtPopup, but that did nothing for an iconified frame. */
9099 XtMapWidget (f->output_data.x->widget);
9101 #else /* not USE_X_TOOLKIT */
9102 #ifdef USE_GTK
9103 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9104 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9105 #else
9106 if (FRAME_X_EMBEDDED_P (f))
9107 xembed_set_info (f, XEMBED_MAPPED);
9108 else
9109 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9110 #endif /* not USE_GTK */
9111 #endif /* not USE_X_TOOLKIT */
9114 XFlush (FRAME_X_DISPLAY (f));
9116 /* Synchronize to ensure Emacs knows the frame is visible
9117 before we do anything else. We do this loop with input not blocked
9118 so that incoming events are handled. */
9120 Lisp_Object frame;
9121 int count;
9122 /* This must be before UNBLOCK_INPUT
9123 since events that arrive in response to the actions above
9124 will set it when they are handled. */
9125 int previously_visible = f->output_data.x->has_been_visible;
9127 original_left = f->left_pos;
9128 original_top = f->top_pos;
9130 /* This must come after we set COUNT. */
9131 UNBLOCK_INPUT;
9133 /* We unblock here so that arriving X events are processed. */
9135 /* Now move the window back to where it was "supposed to be".
9136 But don't do it if the gravity is negative.
9137 When the gravity is negative, this uses a position
9138 that is 3 pixels too low. Perhaps that's really the border width.
9140 Don't do this if the window has never been visible before,
9141 because the window manager may choose the position
9142 and we don't want to override it. */
9144 if (! FRAME_VISIBLE_P (f)
9145 && ! FRAME_ICONIFIED_P (f)
9146 && ! FRAME_X_EMBEDDED_P (f)
9147 && f->win_gravity == NorthWestGravity
9148 && previously_visible)
9150 Drawable rootw;
9151 int x, y;
9152 unsigned int width, height, border, depth;
9154 BLOCK_INPUT;
9156 /* On some window managers (such as FVWM) moving an existing
9157 window, even to the same place, causes the window manager
9158 to introduce an offset. This can cause the window to move
9159 to an unexpected location. Check the geometry (a little
9160 slow here) and then verify that the window is in the right
9161 place. If the window is not in the right place, move it
9162 there, and take the potential window manager hit. */
9163 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9164 &rootw, &x, &y, &width, &height, &border, &depth);
9166 if (original_left != x || original_top != y)
9167 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9168 original_left, original_top);
9170 UNBLOCK_INPUT;
9173 XSETFRAME (frame, f);
9175 /* Wait until the frame is visible. Process X events until a
9176 MapNotify event has been seen, or until we think we won't get a
9177 MapNotify at all.. */
9178 for (count = input_signal_count + 10;
9179 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9181 /* Force processing of queued events. */
9182 x_sync (f);
9184 /* Machines that do polling rather than SIGIO have been
9185 observed to go into a busy-wait here. So we'll fake an
9186 alarm signal to let the handler know that there's something
9187 to be read. We used to raise a real alarm, but it seems
9188 that the handler isn't always enabled here. This is
9189 probably a bug. */
9190 if (input_polling_used ())
9192 /* It could be confusing if a real alarm arrives while
9193 processing the fake one. Turn it off and let the
9194 handler reset it. */
9195 int old_poll_suppress_count = poll_suppress_count;
9196 poll_suppress_count = 1;
9197 poll_for_input_1 ();
9198 poll_suppress_count = old_poll_suppress_count;
9201 /* See if a MapNotify event has been processed. */
9202 FRAME_SAMPLE_VISIBILITY (f);
9205 /* 2000-09-28: In
9207 (let ((f (selected-frame)))
9208 (iconify-frame f)
9209 (raise-frame f))
9211 the frame is not raised with various window managers on
9212 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9213 unknown reason, the call to XtMapWidget is completely ignored.
9214 Mapping the widget a second time works. */
9216 if (!FRAME_VISIBLE_P (f) && --retry_count != 0)
9217 goto retry;
9221 /* Change from mapped state to withdrawn state. */
9223 /* Make the frame visible (mapped and not iconified). */
9225 void
9226 x_make_frame_invisible (struct frame *f)
9228 Window window;
9230 /* Use the frame's outermost window, not the one we normally draw on. */
9231 window = FRAME_OUTER_WINDOW (f);
9233 /* Don't keep the highlight on an invisible frame. */
9234 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9235 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9237 BLOCK_INPUT;
9239 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9240 that the current position of the window is user-specified, rather than
9241 program-specified, so that when the window is mapped again, it will be
9242 placed at the same location, without forcing the user to position it
9243 by hand again (they have already done that once for this window.) */
9244 x_wm_set_size_hint (f, (long) 0, 1);
9246 #ifdef USE_GTK
9247 if (FRAME_GTK_OUTER_WIDGET (f))
9248 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9249 else
9250 #else
9251 if (FRAME_X_EMBEDDED_P (f))
9252 xembed_set_info (f, 0);
9253 else
9254 #endif
9257 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9258 DefaultScreen (FRAME_X_DISPLAY (f))))
9260 UNBLOCK_INPUT_RESIGNAL;
9261 error ("Can't notify window manager of window withdrawal");
9265 /* We can't distinguish this from iconification
9266 just by the event that we get from the server.
9267 So we can't win using the usual strategy of letting
9268 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9269 and synchronize with the server to make sure we agree. */
9270 f->visible = 0;
9271 FRAME_ICONIFIED_P (f) = 0;
9272 f->async_visible = 0;
9273 f->async_iconified = 0;
9275 x_sync (f);
9277 UNBLOCK_INPUT;
9280 /* Change window state from mapped to iconified. */
9282 void
9283 x_iconify_frame (struct frame *f)
9285 #ifdef USE_X_TOOLKIT
9286 int result;
9287 #endif
9288 Lisp_Object type;
9290 /* Don't keep the highlight on an invisible frame. */
9291 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9292 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9294 if (f->async_iconified)
9295 return;
9297 BLOCK_INPUT;
9299 FRAME_SAMPLE_VISIBILITY (f);
9301 type = x_icon_type (f);
9302 if (!NILP (type))
9303 x_bitmap_icon (f, type);
9305 #if defined (USE_GTK)
9306 if (FRAME_GTK_OUTER_WIDGET (f))
9308 if (! FRAME_VISIBLE_P (f))
9309 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9311 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9312 f->iconified = 1;
9313 f->visible = 1;
9314 f->async_iconified = 1;
9315 f->async_visible = 0;
9316 UNBLOCK_INPUT;
9317 return;
9319 #endif
9321 #ifdef USE_X_TOOLKIT
9323 if (! FRAME_VISIBLE_P (f))
9325 if (! EQ (Vx_no_window_manager, Qt))
9326 x_wm_set_window_state (f, IconicState);
9327 /* This was XtPopup, but that did nothing for an iconified frame. */
9328 XtMapWidget (f->output_data.x->widget);
9329 /* The server won't give us any event to indicate
9330 that an invisible frame was changed to an icon,
9331 so we have to record it here. */
9332 f->iconified = 1;
9333 f->visible = 1;
9334 f->async_iconified = 1;
9335 f->async_visible = 0;
9336 UNBLOCK_INPUT;
9337 return;
9340 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9341 XtWindow (f->output_data.x->widget),
9342 DefaultScreen (FRAME_X_DISPLAY (f)));
9343 UNBLOCK_INPUT;
9345 if (!result)
9346 error ("Can't notify window manager of iconification");
9348 f->async_iconified = 1;
9349 f->async_visible = 0;
9352 BLOCK_INPUT;
9353 XFlush (FRAME_X_DISPLAY (f));
9354 UNBLOCK_INPUT;
9355 #else /* not USE_X_TOOLKIT */
9357 /* Make sure the X server knows where the window should be positioned,
9358 in case the user deiconifies with the window manager. */
9359 if (! FRAME_VISIBLE_P (f)
9360 && ! FRAME_ICONIFIED_P (f)
9361 && ! FRAME_X_EMBEDDED_P (f))
9362 x_set_offset (f, f->left_pos, f->top_pos, 0);
9364 /* Since we don't know which revision of X we're running, we'll use both
9365 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9367 /* X11R4: send a ClientMessage to the window manager using the
9368 WM_CHANGE_STATE type. */
9370 XEvent msg;
9372 msg.xclient.window = FRAME_X_WINDOW (f);
9373 msg.xclient.type = ClientMessage;
9374 msg.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9375 msg.xclient.format = 32;
9376 msg.xclient.data.l[0] = IconicState;
9378 if (! XSendEvent (FRAME_X_DISPLAY (f),
9379 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9380 False,
9381 SubstructureRedirectMask | SubstructureNotifyMask,
9382 &msg))
9384 UNBLOCK_INPUT_RESIGNAL;
9385 error ("Can't notify window manager of iconification");
9389 /* X11R3: set the initial_state field of the window manager hints to
9390 IconicState. */
9391 x_wm_set_window_state (f, IconicState);
9393 if (!FRAME_VISIBLE_P (f))
9395 /* If the frame was withdrawn, before, we must map it. */
9396 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9399 f->async_iconified = 1;
9400 f->async_visible = 0;
9402 XFlush (FRAME_X_DISPLAY (f));
9403 UNBLOCK_INPUT;
9404 #endif /* not USE_X_TOOLKIT */
9408 /* Free X resources of frame F. */
9410 void
9411 x_free_frame_resources (struct frame *f)
9413 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9414 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
9415 #ifdef USE_X_TOOLKIT
9416 Lisp_Object bar;
9417 struct scroll_bar *b;
9418 #endif
9420 BLOCK_INPUT;
9422 /* If a display connection is dead, don't try sending more
9423 commands to the X server. */
9424 if (dpyinfo->display)
9426 /* We must free faces before destroying windows because some
9427 font-driver (e.g. xft) access a window while finishing a
9428 face. */
9429 if (FRAME_FACE_CACHE (f))
9430 free_frame_faces (f);
9432 if (f->output_data.x->icon_desc)
9433 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9435 #ifdef USE_X_TOOLKIT
9436 /* Explicitly destroy the scroll bars of the frame. Without
9437 this, we get "BadDrawable" errors from the toolkit later on,
9438 presumably from expose events generated for the disappearing
9439 toolkit scroll bars. */
9440 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9442 b = XSCROLL_BAR (bar);
9443 x_scroll_bar_remove (b);
9445 #endif
9447 #ifdef HAVE_X_I18N
9448 if (FRAME_XIC (f))
9449 free_frame_xic (f);
9450 #endif
9452 #ifdef USE_X_TOOLKIT
9453 if (f->output_data.x->widget)
9455 XtDestroyWidget (f->output_data.x->widget);
9456 f->output_data.x->widget = NULL;
9458 /* Tooltips don't have widgets, only a simple X window, even if
9459 we are using a toolkit. */
9460 else if (FRAME_X_WINDOW (f))
9461 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9463 free_frame_menubar (f);
9464 #else /* !USE_X_TOOLKIT */
9466 #ifdef USE_GTK
9467 xg_free_frame_widgets (f);
9468 #endif /* USE_GTK */
9470 if (FRAME_X_WINDOW (f))
9471 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9472 #endif /* !USE_X_TOOLKIT */
9474 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9475 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9476 unload_color (f, f->output_data.x->cursor_pixel);
9477 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9478 unload_color (f, f->output_data.x->border_pixel);
9479 unload_color (f, f->output_data.x->mouse_pixel);
9481 if (f->output_data.x->scroll_bar_background_pixel != -1)
9482 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9483 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9484 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9485 #ifdef USE_TOOLKIT_SCROLL_BARS
9486 /* Scrollbar shadow colors. */
9487 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9488 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9489 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9490 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9491 #endif /* USE_TOOLKIT_SCROLL_BARS */
9492 if (f->output_data.x->white_relief.allocated_p)
9493 unload_color (f, f->output_data.x->white_relief.pixel);
9494 if (f->output_data.x->black_relief.allocated_p)
9495 unload_color (f, f->output_data.x->black_relief.pixel);
9497 x_free_gcs (f);
9498 XFlush (FRAME_X_DISPLAY (f));
9501 xfree (f->output_data.x->saved_menu_event);
9502 xfree (f->output_data.x);
9503 f->output_data.x = NULL;
9505 if (f == dpyinfo->x_focus_frame)
9506 dpyinfo->x_focus_frame = 0;
9507 if (f == dpyinfo->x_focus_event_frame)
9508 dpyinfo->x_focus_event_frame = 0;
9509 if (f == dpyinfo->x_highlight_frame)
9510 dpyinfo->x_highlight_frame = 0;
9512 if (f == hlinfo->mouse_face_mouse_frame)
9514 hlinfo->mouse_face_beg_row
9515 = hlinfo->mouse_face_beg_col = -1;
9516 hlinfo->mouse_face_end_row
9517 = hlinfo->mouse_face_end_col = -1;
9518 hlinfo->mouse_face_window = Qnil;
9519 hlinfo->mouse_face_deferred_gc = 0;
9520 hlinfo->mouse_face_mouse_frame = 0;
9523 UNBLOCK_INPUT;
9527 /* Destroy the X window of frame F. */
9529 static void
9530 x_destroy_window (struct frame *f)
9532 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9534 /* If a display connection is dead, don't try sending more
9535 commands to the X server. */
9536 if (dpyinfo->display != 0)
9537 x_free_frame_resources (f);
9539 dpyinfo->reference_count--;
9543 /* Setting window manager hints. */
9545 /* Set the normal size hints for the window manager, for frame F.
9546 FLAGS is the flags word to use--or 0 meaning preserve the flags
9547 that the window now has.
9548 If USER_POSITION is nonzero, we set the USPosition
9549 flag (this is useful when FLAGS is 0).
9550 The GTK version is in gtkutils.c */
9552 #ifndef USE_GTK
9553 void
9554 x_wm_set_size_hint (struct frame *f, long flags, int user_position)
9556 XSizeHints size_hints;
9557 Window window = FRAME_OUTER_WINDOW (f);
9559 /* Setting PMaxSize caused various problems. */
9560 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9562 size_hints.x = f->left_pos;
9563 size_hints.y = f->top_pos;
9565 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9566 size_hints.width = FRAME_PIXEL_WIDTH (f);
9568 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9569 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9570 size_hints.max_width = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
9571 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9572 size_hints.max_height = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
9573 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9575 /* Calculate the base and minimum sizes. */
9577 int base_width, base_height;
9578 int min_rows = 0, min_cols = 0;
9580 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9581 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9583 check_frame_size (f, &min_rows, &min_cols);
9585 /* The window manager uses the base width hints to calculate the
9586 current number of rows and columns in the frame while
9587 resizing; min_width and min_height aren't useful for this
9588 purpose, since they might not give the dimensions for a
9589 zero-row, zero-column frame.
9591 We use the base_width and base_height members if we have
9592 them; otherwise, we set the min_width and min_height members
9593 to the size for a zero x zero frame. */
9595 size_hints.flags |= PBaseSize;
9596 size_hints.base_width = base_width;
9597 size_hints.base_height = base_height + FRAME_MENUBAR_HEIGHT (f);
9598 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9599 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9602 /* If we don't need the old flags, we don't need the old hint at all. */
9603 if (flags)
9605 size_hints.flags |= flags;
9606 goto no_read;
9610 XSizeHints hints; /* Sometimes I hate X Windows... */
9611 long supplied_return;
9612 int value;
9614 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9615 &supplied_return);
9617 if (flags)
9618 size_hints.flags |= flags;
9619 else
9621 if (value == 0)
9622 hints.flags = 0;
9623 if (hints.flags & PSize)
9624 size_hints.flags |= PSize;
9625 if (hints.flags & PPosition)
9626 size_hints.flags |= PPosition;
9627 if (hints.flags & USPosition)
9628 size_hints.flags |= USPosition;
9629 if (hints.flags & USSize)
9630 size_hints.flags |= USSize;
9634 no_read:
9636 #ifdef PWinGravity
9637 size_hints.win_gravity = f->win_gravity;
9638 size_hints.flags |= PWinGravity;
9640 if (user_position)
9642 size_hints.flags &= ~ PPosition;
9643 size_hints.flags |= USPosition;
9645 #endif /* PWinGravity */
9647 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9649 #endif /* not USE_GTK */
9651 /* Used for IconicState or NormalState */
9653 static void
9654 x_wm_set_window_state (struct frame *f, int state)
9656 #ifdef USE_X_TOOLKIT
9657 Arg al[1];
9659 XtSetArg (al[0], XtNinitialState, state);
9660 XtSetValues (f->output_data.x->widget, al, 1);
9661 #else /* not USE_X_TOOLKIT */
9662 Window window = FRAME_X_WINDOW (f);
9664 f->output_data.x->wm_hints.flags |= StateHint;
9665 f->output_data.x->wm_hints.initial_state = state;
9667 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9668 #endif /* not USE_X_TOOLKIT */
9671 static void
9672 x_wm_set_icon_pixmap (struct frame *f, ptrdiff_t pixmap_id)
9674 Pixmap icon_pixmap, icon_mask;
9676 #if !defined USE_X_TOOLKIT && !defined USE_GTK
9677 Window window = FRAME_OUTER_WINDOW (f);
9678 #endif
9680 if (pixmap_id > 0)
9682 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9683 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9684 icon_mask = x_bitmap_mask (f, pixmap_id);
9685 f->output_data.x->wm_hints.icon_mask = icon_mask;
9687 else
9689 /* It seems there is no way to turn off use of an icon
9690 pixmap. */
9691 return;
9695 #ifdef USE_GTK
9697 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9698 return;
9701 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9704 Arg al[1];
9705 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9706 XtSetValues (f->output_data.x->widget, al, 1);
9707 XtSetArg (al[0], XtNiconMask, icon_mask);
9708 XtSetValues (f->output_data.x->widget, al, 1);
9711 #else /* not USE_X_TOOLKIT && not USE_GTK */
9713 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9714 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9716 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9719 void
9720 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
9722 Window window = FRAME_OUTER_WINDOW (f);
9724 f->output_data.x->wm_hints.flags |= IconPositionHint;
9725 f->output_data.x->wm_hints.icon_x = icon_x;
9726 f->output_data.x->wm_hints.icon_y = icon_y;
9728 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9732 /***********************************************************************
9733 Fonts
9734 ***********************************************************************/
9736 #if GLYPH_DEBUG
9738 /* Check that FONT is valid on frame F. It is if it can be found in F's
9739 font table. */
9741 static void
9742 x_check_font (struct frame *f, struct font *font)
9744 xassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9745 if (font->driver->check)
9746 xassert (font->driver->check (f, font) == 0);
9749 #endif /* GLYPH_DEBUG != 0 */
9752 /***********************************************************************
9753 Initialization
9754 ***********************************************************************/
9756 #ifdef USE_X_TOOLKIT
9757 static XrmOptionDescRec emacs_options[] = {
9758 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9759 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9761 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9762 XrmoptionSepArg, NULL},
9763 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9765 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9766 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9767 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9768 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9769 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9770 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9771 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9774 /* Whether atimer for Xt timeouts is activated or not. */
9776 static int x_timeout_atimer_activated_flag;
9778 #endif /* USE_X_TOOLKIT */
9780 static int x_initialized;
9782 /* Test whether two display-name strings agree up to the dot that separates
9783 the screen number from the server number. */
9784 static int
9785 same_x_server (const char *name1, const char *name2)
9787 int seen_colon = 0;
9788 const char *system_name = SSDATA (Vsystem_name);
9789 ptrdiff_t system_name_length = SBYTES (Vsystem_name);
9790 ptrdiff_t length_until_period = 0;
9792 while (system_name[length_until_period] != 0
9793 && system_name[length_until_period] != '.')
9794 length_until_period++;
9796 /* Treat `unix' like an empty host name. */
9797 if (! strncmp (name1, "unix:", 5))
9798 name1 += 4;
9799 if (! strncmp (name2, "unix:", 5))
9800 name2 += 4;
9801 /* Treat this host's name like an empty host name. */
9802 if (! strncmp (name1, system_name, system_name_length)
9803 && name1[system_name_length] == ':')
9804 name1 += system_name_length;
9805 if (! strncmp (name2, system_name, system_name_length)
9806 && name2[system_name_length] == ':')
9807 name2 += system_name_length;
9808 /* Treat this host's domainless name like an empty host name. */
9809 if (! strncmp (name1, system_name, length_until_period)
9810 && name1[length_until_period] == ':')
9811 name1 += length_until_period;
9812 if (! strncmp (name2, system_name, length_until_period)
9813 && name2[length_until_period] == ':')
9814 name2 += length_until_period;
9816 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9818 if (*name1 == ':')
9819 seen_colon = 1;
9820 if (seen_colon && *name1 == '.')
9821 return 1;
9823 return (seen_colon
9824 && (*name1 == '.' || *name1 == '\0')
9825 && (*name2 == '.' || *name2 == '\0'));
9828 /* Count number of set bits in mask and number of bits to shift to
9829 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9830 to 5. */
9831 static void
9832 get_bits_and_offset (long unsigned int mask, int *bits, int *offset)
9834 int nr = 0;
9835 int off = 0;
9837 while (!(mask & 1))
9839 off++;
9840 mask >>= 1;
9843 while (mask & 1)
9845 nr++;
9846 mask >>= 1;
9849 *offset = off;
9850 *bits = nr;
9853 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9854 But don't permanently open it, just test its availability. */
9857 x_display_ok (const char *display)
9859 int dpy_ok = 1;
9860 Display *dpy;
9862 dpy = XOpenDisplay (display);
9863 if (dpy)
9864 XCloseDisplay (dpy);
9865 else
9866 dpy_ok = 0;
9867 return dpy_ok;
9870 #ifdef USE_GTK
9871 static void
9872 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
9873 const gchar *msg, gpointer user_data)
9875 if (!strstr (msg, "g_set_prgname"))
9876 fprintf (stderr, "%s-WARNING **: %s\n", log_domain, msg);
9878 #endif
9880 /* Open a connection to X display DISPLAY_NAME, and return
9881 the structure that describes the open display.
9882 If we cannot contact the display, return null. */
9884 struct x_display_info *
9885 x_term_init (Lisp_Object display_name, char *xrm_option, char *resource_name)
9887 int connection;
9888 Display *dpy;
9889 struct terminal *terminal;
9890 struct x_display_info *dpyinfo;
9891 XrmDatabase xrdb;
9892 Mouse_HLInfo *hlinfo;
9893 ptrdiff_t lim;
9895 BLOCK_INPUT;
9897 if (!x_initialized)
9899 x_initialize ();
9900 ++x_initialized;
9903 if (! x_display_ok (SSDATA (display_name)))
9904 error ("Display %s can't be opened", SSDATA (display_name));
9906 #ifdef USE_GTK
9908 #define NUM_ARGV 10
9909 int argc;
9910 char *argv[NUM_ARGV];
9911 char **argv2 = argv;
9912 guint id;
9914 if (x_initialized++ > 1)
9916 xg_display_open (SSDATA (display_name), &dpy);
9918 else
9920 static char display_opt[] = "--display";
9921 static char name_opt[] = "--name";
9923 for (argc = 0; argc < NUM_ARGV; ++argc)
9924 argv[argc] = 0;
9926 argc = 0;
9927 argv[argc++] = initial_argv[0];
9929 if (! NILP (display_name))
9931 argv[argc++] = display_opt;
9932 argv[argc++] = SSDATA (display_name);
9935 argv[argc++] = name_opt;
9936 argv[argc++] = resource_name;
9938 XSetLocaleModifiers ("");
9940 /* Emacs can only handle core input events, so make sure
9941 Gtk doesn't use Xinput or Xinput2 extensions. */
9943 static char fix_events[] = "GDK_CORE_DEVICE_EVENTS=1";
9944 putenv (fix_events);
9947 /* Work around GLib bug that outputs a faulty warning. See
9948 https://bugzilla.gnome.org/show_bug.cgi?id=563627. */
9949 id = g_log_set_handler ("GLib", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
9950 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
9951 gtk_init (&argc, &argv2);
9952 g_log_remove_handler ("GLib", id);
9954 /* gtk_init does set_locale. We must fix locale after calling it. */
9955 fixup_locale ();
9956 xg_initialize ();
9958 dpy = DEFAULT_GDK_DISPLAY ();
9960 /* NULL window -> events for all windows go to our function */
9961 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
9963 #if GTK_MAJOR_VERSION <= 2 && GTK_MINOR_VERSION <= 90
9964 /* Load our own gtkrc if it exists. */
9966 const char *file = "~/.emacs.d/gtkrc";
9967 Lisp_Object s, abs_file;
9969 s = make_string (file, strlen (file));
9970 abs_file = Fexpand_file_name (s, Qnil);
9972 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
9973 gtk_rc_parse (SSDATA (abs_file));
9975 #endif
9977 XSetErrorHandler (x_error_handler);
9978 XSetIOErrorHandler (x_io_error_quitter);
9981 #else /* not USE_GTK */
9982 #ifdef USE_X_TOOLKIT
9983 /* weiner@footloose.sps.mot.com reports that this causes
9984 errors with X11R5:
9985 X protocol error: BadAtom (invalid Atom parameter)
9986 on protocol request 18skiloaf.
9987 So let's not use it until R6. */
9988 #ifdef HAVE_X11XTR6
9989 XtSetLanguageProc (NULL, NULL, NULL);
9990 #endif
9993 int argc = 0;
9994 char *argv[3];
9996 argv[0] = "";
9997 argc = 1;
9998 if (xrm_option)
10000 argv[argc++] = "-xrm";
10001 argv[argc++] = xrm_option;
10003 turn_on_atimers (0);
10004 dpy = XtOpenDisplay (Xt_app_con, SSDATA (display_name),
10005 resource_name, EMACS_CLASS,
10006 emacs_options, XtNumber (emacs_options),
10007 &argc, argv);
10008 turn_on_atimers (1);
10010 #ifdef HAVE_X11XTR6
10011 /* I think this is to compensate for XtSetLanguageProc. */
10012 fixup_locale ();
10013 #endif
10016 #else /* not USE_X_TOOLKIT */
10017 XSetLocaleModifiers ("");
10018 dpy = XOpenDisplay (SSDATA (display_name));
10019 #endif /* not USE_X_TOOLKIT */
10020 #endif /* not USE_GTK*/
10022 /* Detect failure. */
10023 if (dpy == 0)
10025 UNBLOCK_INPUT;
10026 return 0;
10029 /* We have definitely succeeded. Record the new connection. */
10031 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
10032 memset (dpyinfo, 0, sizeof *dpyinfo);
10033 hlinfo = &dpyinfo->mouse_highlight;
10035 terminal = x_create_terminal (dpyinfo);
10038 struct x_display_info *share;
10039 Lisp_Object tail;
10041 for (share = x_display_list, tail = x_display_name_list; share;
10042 share = share->next, tail = XCDR (tail))
10043 if (same_x_server (SSDATA (XCAR (XCAR (tail))),
10044 SSDATA (display_name)))
10045 break;
10046 if (share)
10047 terminal->kboard = share->terminal->kboard;
10048 else
10050 terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
10051 init_kboard (terminal->kboard);
10052 KVAR (terminal->kboard, Vwindow_system) = Qx;
10054 /* Add the keyboard to the list before running Lisp code (via
10055 Qvendor_specific_keysyms below), since these are not traced
10056 via terminals but only through all_kboards. */
10057 terminal->kboard->next_kboard = all_kboards;
10058 all_kboards = terminal->kboard;
10060 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10062 char *vendor = ServerVendor (dpy);
10064 /* Protect terminal from GC before removing it from the
10065 list of terminals. */
10066 struct gcpro gcpro1;
10067 Lisp_Object gcpro_term;
10068 XSETTERMINAL (gcpro_term, terminal);
10069 GCPRO1 (gcpro_term);
10071 /* Temporarily hide the partially initialized terminal. */
10072 terminal_list = terminal->next_terminal;
10073 UNBLOCK_INPUT;
10074 KVAR (terminal->kboard, Vsystem_key_alist)
10075 = call1 (Qvendor_specific_keysyms,
10076 vendor ? build_string (vendor) : empty_unibyte_string);
10077 BLOCK_INPUT;
10078 terminal->next_terminal = terminal_list;
10079 terminal_list = terminal;
10080 UNGCPRO;
10083 /* Don't let the initial kboard remain current longer than necessary.
10084 That would cause problems if a file loaded on startup tries to
10085 prompt in the mini-buffer. */
10086 if (current_kboard == initial_kboard)
10087 current_kboard = terminal->kboard;
10089 terminal->kboard->reference_count++;
10092 /* Put this display on the chain. */
10093 dpyinfo->next = x_display_list;
10094 x_display_list = dpyinfo;
10096 /* Put it on x_display_name_list as well, to keep them parallel. */
10097 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10098 x_display_name_list);
10099 dpyinfo->name_list_element = XCAR (x_display_name_list);
10101 dpyinfo->display = dpy;
10103 /* Set the name of the terminal. */
10104 terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
10105 strncpy (terminal->name, SSDATA (display_name), SBYTES (display_name));
10106 terminal->name[SBYTES (display_name)] = 0;
10108 #if 0
10109 XSetAfterFunction (x_current_display, x_trace_wire);
10110 #endif /* ! 0 */
10112 lim = min (PTRDIFF_MAX, SIZE_MAX) - sizeof "@";
10113 if (lim - SBYTES (Vinvocation_name) < SBYTES (Vsystem_name))
10114 memory_full (SIZE_MAX);
10115 dpyinfo->x_id_name
10116 = (char *) xmalloc (SBYTES (Vinvocation_name)
10117 + SBYTES (Vsystem_name)
10118 + 2);
10119 strcat (strcat (strcpy (dpyinfo->x_id_name, SSDATA (Vinvocation_name)), "@"),
10120 SSDATA (Vsystem_name));
10122 /* Figure out which modifier bits mean what. */
10123 x_find_modifier_meanings (dpyinfo);
10125 /* Get the scroll bar cursor. */
10126 #ifdef USE_GTK
10127 /* We must create a GTK cursor, it is required for GTK widgets. */
10128 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10129 #endif /* USE_GTK */
10131 dpyinfo->vertical_scroll_bar_cursor
10132 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10134 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10135 resource_name, EMACS_CLASS);
10136 #ifdef HAVE_XRMSETDATABASE
10137 XrmSetDatabase (dpyinfo->display, xrdb);
10138 #else
10139 dpyinfo->display->db = xrdb;
10140 #endif
10141 /* Put the rdb where we can find it in a way that works on
10142 all versions. */
10143 dpyinfo->xrdb = xrdb;
10145 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10146 DefaultScreen (dpyinfo->display));
10147 select_visual (dpyinfo);
10148 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10149 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10150 dpyinfo->client_leader_window = 0;
10151 dpyinfo->grabbed = 0;
10152 dpyinfo->reference_count = 0;
10153 dpyinfo->icon_bitmap_id = -1;
10154 dpyinfo->n_fonts = 0;
10155 dpyinfo->bitmaps = 0;
10156 dpyinfo->bitmaps_size = 0;
10157 dpyinfo->bitmaps_last = 0;
10158 dpyinfo->scratch_cursor_gc = 0;
10159 hlinfo->mouse_face_mouse_frame = 0;
10160 hlinfo->mouse_face_deferred_gc = 0;
10161 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
10162 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
10163 hlinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10164 hlinfo->mouse_face_window = Qnil;
10165 hlinfo->mouse_face_overlay = Qnil;
10166 hlinfo->mouse_face_mouse_x = hlinfo->mouse_face_mouse_y = 0;
10167 hlinfo->mouse_face_defer = 0;
10168 hlinfo->mouse_face_hidden = 0;
10169 dpyinfo->x_focus_frame = 0;
10170 dpyinfo->x_focus_event_frame = 0;
10171 dpyinfo->x_highlight_frame = 0;
10172 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10174 /* See if we can construct pixel values from RGB values. */
10175 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10176 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10178 if (dpyinfo->visual->class == TrueColor)
10180 get_bits_and_offset (dpyinfo->visual->red_mask,
10181 &dpyinfo->red_bits, &dpyinfo->red_offset);
10182 get_bits_and_offset (dpyinfo->visual->blue_mask,
10183 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10184 get_bits_and_offset (dpyinfo->visual->green_mask,
10185 &dpyinfo->green_bits, &dpyinfo->green_offset);
10188 /* See if a private colormap is requested. */
10189 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10191 if (dpyinfo->visual->class == PseudoColor)
10193 Lisp_Object value;
10194 value = display_x_get_resource (dpyinfo,
10195 build_string ("privateColormap"),
10196 build_string ("PrivateColormap"),
10197 Qnil, Qnil);
10198 if (STRINGP (value)
10199 && (!strcmp (SSDATA (value), "true")
10200 || !strcmp (SSDATA (value), "on")))
10201 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10204 else
10205 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10206 dpyinfo->visual, AllocNone);
10208 #ifdef HAVE_XFT
10210 /* If we are using Xft, check dpi value in X resources.
10211 It is better we use it as well, since Xft will use it, as will all
10212 Gnome applications. If our real DPI is smaller or larger than the
10213 one Xft uses, our font will look smaller or larger than other
10214 for other applications, even if it is the same font name (monospace-10
10215 for example). */
10216 char *v = XGetDefault (dpyinfo->display, "Xft", "dpi");
10217 double d;
10218 if (v != NULL && sscanf (v, "%lf", &d) == 1)
10219 dpyinfo->resy = dpyinfo->resx = d;
10221 #endif
10223 if (dpyinfo->resy < 1)
10225 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10226 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10227 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10228 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10229 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10230 pixels = DisplayWidth (dpyinfo->display, screen_number);
10231 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10232 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10233 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10237 const struct
10239 const char *name;
10240 Atom *atom;
10241 } atom_refs[] = {
10242 { "WM_PROTOCOLS", &dpyinfo->Xatom_wm_protocols },
10243 { "WM_TAKE_FOCUS", &dpyinfo->Xatom_wm_take_focus },
10244 { "WM_SAVE_YOURSELF", &dpyinfo->Xatom_wm_save_yourself },
10245 { "WM_DELETE_WINDOW", &dpyinfo->Xatom_wm_delete_window },
10246 { "WM_CHANGE_STATE", &dpyinfo->Xatom_wm_change_state },
10247 { "WM_CONFIGURE_DENIED", &dpyinfo->Xatom_wm_configure_denied },
10248 { "WM_MOVED", &dpyinfo->Xatom_wm_window_moved },
10249 { "WM_CLIENT_LEADER", &dpyinfo->Xatom_wm_client_leader },
10250 { "Editres", &dpyinfo->Xatom_editres },
10251 { "CLIPBOARD", &dpyinfo->Xatom_CLIPBOARD },
10252 { "TIMESTAMP", &dpyinfo->Xatom_TIMESTAMP },
10253 { "TEXT", &dpyinfo->Xatom_TEXT },
10254 { "COMPOUND_TEXT", &dpyinfo->Xatom_COMPOUND_TEXT },
10255 { "UTF8_STRING", &dpyinfo->Xatom_UTF8_STRING },
10256 { "DELETE", &dpyinfo->Xatom_DELETE },
10257 { "MULTIPLE", &dpyinfo->Xatom_MULTIPLE },
10258 { "INCR", &dpyinfo->Xatom_INCR },
10259 { "_EMACS_TMP_", &dpyinfo->Xatom_EMACS_TMP },
10260 { "TARGETS", &dpyinfo->Xatom_TARGETS },
10261 { "NULL", &dpyinfo->Xatom_NULL },
10262 { "ATOM", &dpyinfo->Xatom_ATOM },
10263 { "ATOM_PAIR", &dpyinfo->Xatom_ATOM_PAIR },
10264 { "CLIPBOARD_MANAGER", &dpyinfo->Xatom_CLIPBOARD_MANAGER },
10265 { "_XEMBED_INFO", &dpyinfo->Xatom_XEMBED_INFO },
10266 /* For properties of font. */
10267 { "PIXEL_SIZE", &dpyinfo->Xatom_PIXEL_SIZE },
10268 { "AVERAGE_WIDTH", &dpyinfo->Xatom_AVERAGE_WIDTH },
10269 { "_MULE_BASELINE_OFFSET", &dpyinfo->Xatom_MULE_BASELINE_OFFSET },
10270 { "_MULE_RELATIVE_COMPOSE", &dpyinfo->Xatom_MULE_RELATIVE_COMPOSE },
10271 { "_MULE_DEFAULT_ASCENT", &dpyinfo->Xatom_MULE_DEFAULT_ASCENT },
10272 /* Ghostscript support. */
10273 { "DONE", &dpyinfo->Xatom_DONE },
10274 { "PAGE", &dpyinfo->Xatom_PAGE },
10275 { "SCROLLBAR", &dpyinfo->Xatom_Scrollbar },
10276 { "_XEMBED", &dpyinfo->Xatom_XEMBED },
10277 /* EWMH */
10278 { "_NET_WM_STATE", &dpyinfo->Xatom_net_wm_state },
10279 { "_NET_WM_STATE_FULLSCREEN", &dpyinfo->Xatom_net_wm_state_fullscreen },
10280 { "_NET_WM_STATE_MAXIMIZED_HORZ",
10281 &dpyinfo->Xatom_net_wm_state_maximized_horz },
10282 { "_NET_WM_STATE_MAXIMIZED_VERT",
10283 &dpyinfo->Xatom_net_wm_state_maximized_vert },
10284 { "_NET_WM_STATE_STICKY", &dpyinfo->Xatom_net_wm_state_sticky },
10285 { "_NET_WM_STATE_HIDDEN", &dpyinfo->Xatom_net_wm_state_hidden },
10286 { "_NET_WM_WINDOW_TYPE", &dpyinfo->Xatom_net_window_type },
10287 { "_NET_WM_WINDOW_TYPE_TOOLTIP",
10288 &dpyinfo->Xatom_net_window_type_tooltip },
10289 { "_NET_WM_ICON_NAME", &dpyinfo->Xatom_net_wm_icon_name },
10290 { "_NET_WM_NAME", &dpyinfo->Xatom_net_wm_name },
10291 { "_NET_SUPPORTED", &dpyinfo->Xatom_net_supported },
10292 { "_NET_SUPPORTING_WM_CHECK", &dpyinfo->Xatom_net_supporting_wm_check },
10293 { "_NET_WM_WINDOW_OPACITY", &dpyinfo->Xatom_net_wm_window_opacity },
10294 { "_NET_ACTIVE_WINDOW", &dpyinfo->Xatom_net_active_window },
10295 { "_NET_FRAME_EXTENTS", &dpyinfo->Xatom_net_frame_extents },
10296 /* Session management */
10297 { "SM_CLIENT_ID", &dpyinfo->Xatom_SM_CLIENT_ID },
10298 { "_XSETTINGS_SETTINGS", &dpyinfo->Xatom_xsettings_prop },
10299 { "MANAGER", &dpyinfo->Xatom_xsettings_mgr },
10302 int i;
10303 const int atom_count = sizeof (atom_refs) / sizeof (atom_refs[0]);
10304 /* 1 for _XSETTINGS_SN */
10305 const int total_atom_count = 1 + atom_count;
10306 Atom *atoms_return = xmalloc (sizeof (Atom) * total_atom_count);
10307 char **atom_names = xmalloc (sizeof (char *) * total_atom_count);
10308 char xsettings_atom_name[64];
10310 for (i = 0; i < atom_count; i++)
10311 atom_names[i] = (char *) atom_refs[i].name;
10313 /* Build _XSETTINGS_SN atom name */
10314 snprintf (xsettings_atom_name, sizeof (xsettings_atom_name),
10315 "_XSETTINGS_S%d", XScreenNumberOfScreen (dpyinfo->screen));
10316 atom_names[i] = xsettings_atom_name;
10318 XInternAtoms (dpyinfo->display, atom_names, total_atom_count,
10319 False, atoms_return);
10321 for (i = 0; i < atom_count; i++)
10322 *atom_refs[i].atom = atoms_return[i];
10324 /* Manual copy of last atom */
10325 dpyinfo->Xatom_xsettings_sel = atoms_return[i];
10327 xfree (atom_names);
10328 xfree (atoms_return);
10331 dpyinfo->x_dnd_atoms_size = 8;
10332 dpyinfo->x_dnd_atoms_length = 0;
10333 dpyinfo->x_dnd_atoms = xmalloc (sizeof (*dpyinfo->x_dnd_atoms)
10334 * dpyinfo->x_dnd_atoms_size);
10336 dpyinfo->net_supported_atoms = NULL;
10337 dpyinfo->nr_net_supported_atoms = 0;
10338 dpyinfo->net_supported_window = 0;
10340 connection = ConnectionNumber (dpyinfo->display);
10341 dpyinfo->connection = connection;
10344 dpyinfo->gray
10345 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10346 gray_bitmap_bits,
10347 gray_bitmap_width, gray_bitmap_height,
10348 1, 0, 1);
10351 #ifdef HAVE_X_I18N
10352 xim_initialize (dpyinfo, resource_name);
10353 #endif
10355 xsettings_initialize (dpyinfo);
10357 /* This is only needed for distinguishing keyboard and process input. */
10358 if (connection != 0)
10359 add_keyboard_wait_descriptor (connection);
10361 #ifdef F_SETOWN
10362 fcntl (connection, F_SETOWN, getpid ());
10363 #endif /* ! defined (F_SETOWN) */
10365 #ifdef SIGIO
10366 if (interrupt_input)
10367 init_sigio (connection);
10368 #endif /* ! defined (SIGIO) */
10370 #ifdef USE_LUCID
10372 XrmValue d, fr, to;
10373 Font font;
10375 dpy = dpyinfo->display;
10376 d.addr = (XPointer)&dpy;
10377 d.size = sizeof (Display *);
10378 fr.addr = XtDefaultFont;
10379 fr.size = sizeof (XtDefaultFont);
10380 to.size = sizeof (Font *);
10381 to.addr = (XPointer)&font;
10382 x_catch_errors (dpy);
10383 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10384 abort ();
10385 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10386 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10387 x_uncatch_errors ();
10389 #endif
10391 /* See if we should run in synchronous mode. This is useful
10392 for debugging X code. */
10394 Lisp_Object value;
10395 value = display_x_get_resource (dpyinfo,
10396 build_string ("synchronous"),
10397 build_string ("Synchronous"),
10398 Qnil, Qnil);
10399 if (STRINGP (value)
10400 && (!strcmp (SSDATA (value), "true")
10401 || !strcmp (SSDATA (value), "on")))
10402 XSynchronize (dpyinfo->display, True);
10406 Lisp_Object value;
10407 value = display_x_get_resource (dpyinfo,
10408 build_string ("useXIM"),
10409 build_string ("UseXIM"),
10410 Qnil, Qnil);
10411 #ifdef USE_XIM
10412 if (STRINGP (value)
10413 && (!strcmp (SSDATA (value), "false")
10414 || !strcmp (SSDATA (value), "off")))
10415 use_xim = 0;
10416 #else
10417 if (STRINGP (value)
10418 && (!strcmp (SSDATA (value), "true")
10419 || !strcmp (SSDATA (value), "on")))
10420 use_xim = 1;
10421 #endif
10424 #ifdef HAVE_X_SM
10425 /* Only do this for the very first display in the Emacs session.
10426 Ignore X session management when Emacs was first started on a
10427 tty. */
10428 if (terminal->id == 1)
10429 x_session_initialize (dpyinfo);
10430 #endif
10432 UNBLOCK_INPUT;
10434 return dpyinfo;
10437 /* Get rid of display DPYINFO, deleting all frames on it,
10438 and without sending any more commands to the X server. */
10440 static void
10441 x_delete_display (struct x_display_info *dpyinfo)
10443 struct terminal *t;
10445 /* Close all frames and delete the generic struct terminal for this
10446 X display. */
10447 for (t = terminal_list; t; t = t->next_terminal)
10448 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10450 #ifdef HAVE_X_SM
10451 /* Close X session management when we close its display. */
10452 if (t->id == 1 && x_session_have_connection ())
10453 x_session_close ();
10454 #endif
10455 delete_terminal (t);
10456 break;
10459 delete_keyboard_wait_descriptor (dpyinfo->connection);
10461 /* Discard this display from x_display_name_list and x_display_list.
10462 We can't use Fdelq because that can quit. */
10463 if (! NILP (x_display_name_list)
10464 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10465 x_display_name_list = XCDR (x_display_name_list);
10466 else
10468 Lisp_Object tail;
10470 tail = x_display_name_list;
10471 while (CONSP (tail) && CONSP (XCDR (tail)))
10473 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10475 XSETCDR (tail, XCDR (XCDR (tail)));
10476 break;
10478 tail = XCDR (tail);
10482 if (next_noop_dpyinfo == dpyinfo)
10483 next_noop_dpyinfo = dpyinfo->next;
10485 if (x_display_list == dpyinfo)
10486 x_display_list = dpyinfo->next;
10487 else
10489 struct x_display_info *tail;
10491 for (tail = x_display_list; tail; tail = tail->next)
10492 if (tail->next == dpyinfo)
10493 tail->next = tail->next->next;
10496 xfree (dpyinfo->x_id_name);
10497 xfree (dpyinfo->x_dnd_atoms);
10498 xfree (dpyinfo->color_cells);
10499 xfree (dpyinfo);
10502 #ifdef USE_X_TOOLKIT
10504 /* Atimer callback function for TIMER. Called every 0.1s to process
10505 Xt timeouts, if needed. We must avoid calling XtAppPending as
10506 much as possible because that function does an implicit XFlush
10507 that slows us down. */
10509 static void
10510 x_process_timeouts (struct atimer *timer)
10512 BLOCK_INPUT;
10513 x_timeout_atimer_activated_flag = 0;
10514 if (toolkit_scroll_bar_interaction || popup_activated ())
10516 while (XtAppPending (Xt_app_con) & XtIMTimer)
10517 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10518 /* Reactivate the atimer for next time. */
10519 x_activate_timeout_atimer ();
10521 UNBLOCK_INPUT;
10524 /* Install an asynchronous timer that processes Xt timeout events
10525 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10526 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10527 function whenever these variables are set. This is necessary
10528 because some widget sets use timeouts internally, for example the
10529 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10530 processed, these widgets don't behave normally. */
10532 void
10533 x_activate_timeout_atimer (void)
10535 BLOCK_INPUT;
10536 if (!x_timeout_atimer_activated_flag)
10538 EMACS_TIME interval;
10540 EMACS_SET_SECS_USECS (interval, 0, 100000);
10541 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10542 x_timeout_atimer_activated_flag = 1;
10544 UNBLOCK_INPUT;
10547 #endif /* USE_X_TOOLKIT */
10550 /* Set up use of X before we make the first connection. */
10552 extern frame_parm_handler x_frame_parm_handlers[];
10554 static struct redisplay_interface x_redisplay_interface =
10556 x_frame_parm_handlers,
10557 x_produce_glyphs,
10558 x_write_glyphs,
10559 x_insert_glyphs,
10560 x_clear_end_of_line,
10561 x_scroll_run,
10562 x_after_update_window_line,
10563 x_update_window_begin,
10564 x_update_window_end,
10565 x_cursor_to,
10566 x_flush,
10567 #ifdef XFlush
10568 x_flush,
10569 #else
10570 0, /* flush_display_optional */
10571 #endif
10572 x_clear_window_mouse_face,
10573 x_get_glyph_overhangs,
10574 x_fix_overlapping_area,
10575 x_draw_fringe_bitmap,
10576 0, /* define_fringe_bitmap */
10577 0, /* destroy_fringe_bitmap */
10578 x_compute_glyph_string_overhangs,
10579 x_draw_glyph_string,
10580 x_define_frame_cursor,
10581 x_clear_frame_area,
10582 x_draw_window_cursor,
10583 x_draw_vertical_window_border,
10584 x_shift_glyphs_for_insert
10588 /* This function is called when the last frame on a display is deleted. */
10589 void
10590 x_delete_terminal (struct terminal *terminal)
10592 struct x_display_info *dpyinfo = terminal->display_info.x;
10594 /* Protect against recursive calls. delete_frame in
10595 delete_terminal calls us back when it deletes our last frame. */
10596 if (!terminal->name)
10597 return;
10599 BLOCK_INPUT;
10600 #ifdef HAVE_X_I18N
10601 /* We must close our connection to the XIM server before closing the
10602 X display. */
10603 if (dpyinfo->xim)
10604 xim_close_dpy (dpyinfo);
10605 #endif
10607 /* If called from x_connection_closed, the display may already be closed
10608 and dpyinfo->display was set to 0 to indicate that. */
10609 if (dpyinfo->display)
10611 x_destroy_all_bitmaps (dpyinfo);
10612 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10614 /* Whether or not XCloseDisplay destroys the associated resource
10615 database depends on the version of libX11. To avoid both
10616 crash and memory leak, we dissociate the database from the
10617 display and then destroy dpyinfo->xrdb ourselves.
10619 Unfortunately, the above strategy does not work in some
10620 situations due to a bug in newer versions of libX11: because
10621 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
10622 dpy->db is NULL, XCloseDisplay destroys the associated
10623 database whereas it has not been created by XGetDefault
10624 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
10625 don't destroy the database here in order to avoid the crash
10626 in the above situations for now, though that may cause memory
10627 leaks in other situations. */
10628 #if 0
10629 #ifdef HAVE_XRMSETDATABASE
10630 XrmSetDatabase (dpyinfo->display, NULL);
10631 #else
10632 dpyinfo->display->db = NULL;
10633 #endif
10634 /* We used to call XrmDestroyDatabase from x_delete_display, but
10635 some older versions of libX11 crash if we call it after
10636 closing all the displays. */
10637 XrmDestroyDatabase (dpyinfo->xrdb);
10638 #endif
10640 #ifdef USE_GTK
10641 xg_display_close (dpyinfo->display);
10642 #else
10643 #ifdef USE_X_TOOLKIT
10644 XtCloseDisplay (dpyinfo->display);
10645 #else
10646 XCloseDisplay (dpyinfo->display);
10647 #endif
10648 #endif /* ! USE_GTK */
10651 /* Mark as dead. */
10652 dpyinfo->display = NULL;
10653 x_delete_display (dpyinfo);
10654 UNBLOCK_INPUT;
10657 /* Create a struct terminal, initialize it with the X11 specific
10658 functions and make DISPLAY->TERMINAL point to it. */
10660 static struct terminal *
10661 x_create_terminal (struct x_display_info *dpyinfo)
10663 struct terminal *terminal;
10665 terminal = create_terminal ();
10667 terminal->type = output_x_window;
10668 terminal->display_info.x = dpyinfo;
10669 dpyinfo->terminal = terminal;
10671 /* kboard is initialized in x_term_init. */
10673 terminal->clear_frame_hook = x_clear_frame;
10674 terminal->ins_del_lines_hook = x_ins_del_lines;
10675 terminal->delete_glyphs_hook = x_delete_glyphs;
10676 terminal->ring_bell_hook = XTring_bell;
10677 terminal->toggle_invisible_pointer_hook = XTtoggle_invisible_pointer;
10678 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10679 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10680 terminal->update_begin_hook = x_update_begin;
10681 terminal->update_end_hook = x_update_end;
10682 terminal->set_terminal_window_hook = XTset_terminal_window;
10683 terminal->read_socket_hook = XTread_socket;
10684 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10685 terminal->mouse_position_hook = XTmouse_position;
10686 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10687 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10688 terminal->fullscreen_hook = XTfullscreen_hook;
10689 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10690 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10691 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10692 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10694 terminal->delete_frame_hook = x_destroy_window;
10695 terminal->delete_terminal_hook = x_delete_terminal;
10697 terminal->rif = &x_redisplay_interface;
10698 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10699 terminal->char_ins_del_ok = 1;
10700 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10701 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10702 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10703 off the bottom. */
10705 return terminal;
10708 void
10709 x_initialize (void)
10711 baud_rate = 19200;
10713 x_noop_count = 0;
10714 last_tool_bar_item = -1;
10715 any_help_event_p = 0;
10716 ignore_next_mouse_click_timeout = 0;
10718 #ifdef USE_GTK
10719 current_count = -1;
10720 #endif
10722 /* Try to use interrupt input; if we can't, then start polling. */
10723 Fset_input_interrupt_mode (Qt);
10725 #ifdef USE_X_TOOLKIT
10726 XtToolkitInitialize ();
10728 Xt_app_con = XtCreateApplicationContext ();
10730 /* Register a converter from strings to pixels, which uses
10731 Emacs' color allocation infrastructure. */
10732 XtAppSetTypeConverter (Xt_app_con,
10733 XtRString, XtRPixel, cvt_string_to_pixel,
10734 cvt_string_to_pixel_args,
10735 XtNumber (cvt_string_to_pixel_args),
10736 XtCacheByDisplay, cvt_pixel_dtor);
10738 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10739 #endif
10741 #ifdef USE_TOOLKIT_SCROLL_BARS
10742 #ifndef USE_GTK
10743 xaw3d_arrow_scroll = False;
10744 xaw3d_pick_top = True;
10745 #endif
10746 #endif
10748 pending_autoraise_frame = 0;
10749 pending_event_wait.f = 0;
10750 pending_event_wait.eventtype = 0;
10752 /* Note that there is no real way portable across R3/R4 to get the
10753 original error handler. */
10754 XSetErrorHandler (x_error_handler);
10755 XSetIOErrorHandler (x_io_error_quitter);
10757 signal (SIGPIPE, x_connection_signal);
10759 xgselect_initialize ();
10763 void
10764 syms_of_xterm (void)
10766 x_error_message = NULL;
10768 staticpro (&x_display_name_list);
10769 x_display_name_list = Qnil;
10771 staticpro (&last_mouse_scroll_bar);
10772 last_mouse_scroll_bar = Qnil;
10774 DEFSYM (Qvendor_specific_keysyms, "vendor-specific-keysyms");
10775 DEFSYM (Qlatin_1, "latin-1");
10777 staticpro (&last_mouse_press_frame);
10778 last_mouse_press_frame = Qnil;
10780 #ifdef USE_GTK
10781 xg_default_icon_file = make_pure_c_string ("icons/hicolor/scalable/apps/emacs.svg");
10782 staticpro (&xg_default_icon_file);
10784 DEFSYM (Qx_gtk_map_stock, "x-gtk-map-stock");
10785 #endif
10787 DEFVAR_BOOL ("x-use-underline-position-properties",
10788 x_use_underline_position_properties,
10789 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
10790 A value of nil means ignore them. If you encounter fonts with bogus
10791 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10792 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10793 to override the font's UNDERLINE_POSITION for small font display
10794 sizes. */);
10795 x_use_underline_position_properties = 1;
10797 DEFVAR_BOOL ("x-underline-at-descent-line",
10798 x_underline_at_descent_line,
10799 doc: /* *Non-nil means to draw the underline at the same place as the descent line.
10800 A value of nil means to draw the underline according to the value of the
10801 variable `x-use-underline-position-properties', which is usually at the
10802 baseline level. The default value is nil. */);
10803 x_underline_at_descent_line = 0;
10805 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10806 x_mouse_click_focus_ignore_position,
10807 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10808 This variable is only used when the window manager requires that you
10809 click on a frame to select it (give it focus). In that case, a value
10810 of nil, means that the selected window and cursor position changes to
10811 reflect the mouse click position, while a non-nil value means that the
10812 selected window or cursor position is preserved. */);
10813 x_mouse_click_focus_ignore_position = 0;
10815 DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
10816 doc: /* Which toolkit scroll bars Emacs uses, if any.
10817 A value of nil means Emacs doesn't use toolkit scroll bars.
10818 With the X Window system, the value is a symbol describing the
10819 X toolkit. Possible values are: gtk, motif, xaw, or xaw3d.
10820 With MS Windows, the value is t. */);
10821 #ifdef USE_TOOLKIT_SCROLL_BARS
10822 #ifdef USE_MOTIF
10823 Vx_toolkit_scroll_bars = intern_c_string ("motif");
10824 #elif defined HAVE_XAW3D
10825 Vx_toolkit_scroll_bars = intern_c_string ("xaw3d");
10826 #elif USE_GTK
10827 Vx_toolkit_scroll_bars = intern_c_string ("gtk");
10828 #else
10829 Vx_toolkit_scroll_bars = intern_c_string ("xaw");
10830 #endif
10831 #else
10832 Vx_toolkit_scroll_bars = Qnil;
10833 #endif
10835 staticpro (&last_mouse_motion_frame);
10836 last_mouse_motion_frame = Qnil;
10838 Qmodifier_value = intern_c_string ("modifier-value");
10839 Qalt = intern_c_string ("alt");
10840 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10841 Qhyper = intern_c_string ("hyper");
10842 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10843 Qmeta = intern_c_string ("meta");
10844 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10845 Qsuper = intern_c_string ("super");
10846 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10848 DEFVAR_LISP ("x-alt-keysym", Vx_alt_keysym,
10849 doc: /* Which keys Emacs uses for the alt modifier.
10850 This should be one of the symbols `alt', `hyper', `meta', `super'.
10851 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10852 is nil, which is the same as `alt'. */);
10853 Vx_alt_keysym = Qnil;
10855 DEFVAR_LISP ("x-hyper-keysym", Vx_hyper_keysym,
10856 doc: /* Which keys Emacs uses for the hyper modifier.
10857 This should be one of the symbols `alt', `hyper', `meta', `super'.
10858 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10859 default is nil, which is the same as `hyper'. */);
10860 Vx_hyper_keysym = Qnil;
10862 DEFVAR_LISP ("x-meta-keysym", Vx_meta_keysym,
10863 doc: /* Which keys Emacs uses for the meta modifier.
10864 This should be one of the symbols `alt', `hyper', `meta', `super'.
10865 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10866 default is nil, which is the same as `meta'. */);
10867 Vx_meta_keysym = Qnil;
10869 DEFVAR_LISP ("x-super-keysym", Vx_super_keysym,
10870 doc: /* Which keys Emacs uses for the super modifier.
10871 This should be one of the symbols `alt', `hyper', `meta', `super'.
10872 For example, `super' means use the Super_L and Super_R keysyms. The
10873 default is nil, which is the same as `super'. */);
10874 Vx_super_keysym = Qnil;
10876 DEFVAR_LISP ("x-keysym-table", Vx_keysym_table,
10877 doc: /* Hash table of character codes indexed by X keysym codes. */);
10878 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10879 make_float (DEFAULT_REHASH_SIZE),
10880 make_float (DEFAULT_REHASH_THRESHOLD),
10881 Qnil, Qnil, Qnil);
10884 #endif /* HAVE_X_WINDOWS */