Add 2011 to FSF/AIST copyright years.
[emacs.git] / src / xterm.c
blob4b1fe20c7a2f02aa98695e318641c3f7b7214e45
1 /* X Communication module for terminals which understand the X protocol.
2 Copyright (C) 1989, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
3 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New display code by Gerd Moellmann <gerd@gnu.org>. */
22 /* Xt features made by Fred Pierresteguy. */
24 #include <config.h>
26 /* On 4.3 these lose if they come after xterm.h. */
27 /* Putting these at the beginning seems to be standard for other .c files. */
28 #include <signal.h>
30 #include <stdio.h>
31 #include <setjmp.h>
33 #ifdef HAVE_X_WINDOWS
35 #include "lisp.h"
36 #include "blockinput.h"
38 /* Need syssignal.h for various externs and definitions that may be required
39 by some configurations for calls to signal later in this source file. */
40 #include "syssignal.h"
42 /* This may include sys/types.h, and that somehow loses
43 if this is not done before the other system files. */
44 #include "xterm.h"
45 #include <X11/cursorfont.h>
47 /* Load sys/types.h if not already loaded.
48 In some systems loading it twice is suicidal. */
49 #ifndef makedev
50 #include <sys/types.h>
51 #endif /* makedev */
53 #ifdef BSD_SYSTEM
54 #include <sys/ioctl.h>
55 #endif /* ! defined (BSD_SYSTEM) */
57 #include "systime.h"
59 #ifndef INCLUDED_FCNTL
60 #include <fcntl.h>
61 #endif
62 #include <ctype.h>
63 #include <errno.h>
64 #include <setjmp.h>
65 #include <sys/stat.h>
66 /* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed. */
67 /* #include <sys/param.h> */
69 #include "charset.h"
70 #include "character.h"
71 #include "coding.h"
72 #include "frame.h"
73 #include "dispextern.h"
74 #include "fontset.h"
75 #include "termhooks.h"
76 #include "termopts.h"
77 #include "termchar.h"
78 #include "emacs-icon.h"
79 #include "disptab.h"
80 #include "buffer.h"
81 #include "window.h"
82 #include "keyboard.h"
83 #include "intervals.h"
84 #include "process.h"
85 #include "atimer.h"
86 #include "keymap.h"
87 #include "font.h"
88 #include "fontset.h"
89 #include "xsettings.h"
90 #include "xgselect.h"
91 #include "sysselect.h"
93 #ifdef USE_X_TOOLKIT
94 #include <X11/Shell.h>
95 #endif
97 #ifdef HAVE_SYS_TIME_H
98 #include <sys/time.h>
99 #endif
100 #ifdef HAVE_UNISTD_H
101 #include <unistd.h>
102 #endif
104 #ifdef USE_GTK
105 #include "gtkutil.h"
106 #endif
108 #ifdef USE_LUCID
109 extern int xlwmenu_window_p P_ ((Widget w, Window window));
110 extern void xlwmenu_redisplay P_ ((Widget));
111 #endif
113 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
115 extern void free_frame_menubar P_ ((struct frame *));
116 #endif
118 #ifdef USE_X_TOOLKIT
119 #if !defined(NO_EDITRES)
120 #define HACK_EDITRES
121 extern void _XEditResCheckMessages ();
122 #endif /* not NO_EDITRES */
124 /* Include toolkit specific headers for the scroll bar widget. */
126 #ifdef USE_TOOLKIT_SCROLL_BARS
127 #if defined USE_MOTIF
128 #include <Xm/Xm.h> /* for LESSTIF_VERSION */
129 #include <Xm/ScrollBar.h>
130 #else /* !USE_MOTIF i.e. use Xaw */
132 #ifdef HAVE_XAW3D
133 #include <X11/Xaw3d/Simple.h>
134 #include <X11/Xaw3d/Scrollbar.h>
135 #include <X11/Xaw3d/ThreeD.h>
136 #else /* !HAVE_XAW3D */
137 #include <X11/Xaw/Simple.h>
138 #include <X11/Xaw/Scrollbar.h>
139 #endif /* !HAVE_XAW3D */
140 #ifndef XtNpickTop
141 #define XtNpickTop "pickTop"
142 #endif /* !XtNpickTop */
143 #endif /* !USE_MOTIF */
144 #endif /* USE_TOOLKIT_SCROLL_BARS */
146 #endif /* USE_X_TOOLKIT */
148 #ifdef USE_X_TOOLKIT
149 #include "widget.h"
150 #ifndef XtNinitialState
151 #define XtNinitialState "initialState"
152 #endif
153 #endif
155 /* Default to using XIM if available. */
156 #ifdef USE_XIM
157 int use_xim = 1;
158 #else
159 int use_xim = 0; /* configure --without-xim */
160 #endif
164 /* Non-nil means Emacs uses toolkit scroll bars. */
166 Lisp_Object Vx_toolkit_scroll_bars;
168 /* Non-zero means that a HELP_EVENT has been generated since Emacs
169 start. */
171 static int any_help_event_p;
173 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
174 static Lisp_Object last_window;
176 /* Non-zero means make use of UNDERLINE_POSITION font properties. */
178 int x_use_underline_position_properties;
180 /* Non-zero means to draw the underline at the same place as the descent line. */
182 int x_underline_at_descent_line;
184 /* This is a chain of structures for all the X displays currently in
185 use. */
187 struct x_display_info *x_display_list;
189 /* This is a list of cons cells, each of the form (NAME
190 . FONT-LIST-CACHE), one for each element of x_display_list and in
191 the same order. NAME is the name of the frame. FONT-LIST-CACHE
192 records previous values returned by x-list-fonts. */
194 Lisp_Object x_display_name_list;
196 /* Frame being updated by update_frame. This is declared in term.c.
197 This is set by update_begin and looked at by all the XT functions.
198 It is zero while not inside an update. In that case, the XT
199 functions assume that `selected_frame' is the frame to apply to. */
201 extern struct frame *updating_frame;
203 /* This is a frame waiting to be auto-raised, within XTread_socket. */
205 static struct frame *pending_autoraise_frame;
207 /* This is a frame waiting for an event matching mask, within XTread_socket. */
209 static struct {
210 struct frame *f;
211 int eventtype;
212 } pending_event_wait;
214 #ifdef USE_X_TOOLKIT
215 /* The application context for Xt use. */
216 XtAppContext Xt_app_con;
217 static String Xt_default_resources[] = {0};
218 #endif /* USE_X_TOOLKIT */
220 /* Non-zero means user is interacting with a toolkit scroll bar. */
222 static int toolkit_scroll_bar_interaction;
224 /* Non-zero means to not move point as a result of clicking on a
225 frame to focus it (when focus-follows-mouse is nil). */
227 int x_mouse_click_focus_ignore_position;
229 /* Non-zero timeout value means ignore next mouse click if it arrives
230 before that timeout elapses (i.e. as part of the same sequence of
231 events resulting from clicking on a frame to select it). */
233 static unsigned long ignore_next_mouse_click_timeout;
235 /* Mouse movement.
237 Formerly, we used PointerMotionHintMask (in standard_event_mask)
238 so that we would have to call XQueryPointer after each MotionNotify
239 event to ask for another such event. However, this made mouse tracking
240 slow, and there was a bug that made it eventually stop.
242 Simply asking for MotionNotify all the time seems to work better.
244 In order to avoid asking for motion events and then throwing most
245 of them away or busy-polling the server for mouse positions, we ask
246 the server for pointer motion hints. This means that we get only
247 one event per group of mouse movements. "Groups" are delimited by
248 other kinds of events (focus changes and button clicks, for
249 example), or by XQueryPointer calls; when one of these happens, we
250 get another MotionNotify event the next time the mouse moves. This
251 is at least as efficient as getting motion events when mouse
252 tracking is on, and I suspect only negligibly worse when tracking
253 is off. */
255 /* Where the mouse was last time we reported a mouse event. */
257 static XRectangle last_mouse_glyph;
258 static FRAME_PTR last_mouse_glyph_frame;
259 static Lisp_Object last_mouse_press_frame;
261 /* The scroll bar in which the last X motion event occurred.
263 If the last X motion event occurred in a scroll bar, we set this so
264 XTmouse_position can know whether to report a scroll bar motion or
265 an ordinary motion.
267 If the last X motion event didn't occur in a scroll bar, we set
268 this to Qnil, to tell XTmouse_position to return an ordinary motion
269 event. */
271 static Lisp_Object last_mouse_scroll_bar;
273 /* This is a hack. We would really prefer that XTmouse_position would
274 return the time associated with the position it returns, but there
275 doesn't seem to be any way to wrest the time-stamp from the server
276 along with the position query. So, we just keep track of the time
277 of the last movement we received, and return that in hopes that
278 it's somewhat accurate. */
280 static Time last_mouse_movement_time;
282 /* Time for last user interaction as returned in X events. */
284 static Time last_user_time;
286 /* Incremented by XTread_socket whenever it really tries to read
287 events. */
289 #ifdef __STDC__
290 static int volatile input_signal_count;
291 #else
292 static int input_signal_count;
293 #endif
295 /* Used locally within XTread_socket. */
297 static int x_noop_count;
299 /* Initial values of argv and argc. */
301 extern char **initial_argv;
302 extern int initial_argc;
304 extern Lisp_Object Vcommand_line_args, Vsystem_name;
306 /* Tells if a window manager is present or not. */
308 extern Lisp_Object Vx_no_window_manager;
310 extern Lisp_Object Qeql;
312 extern int errno;
314 /* A mask of extra modifier bits to put into every keyboard char. */
316 extern EMACS_INT extra_keyboard_modifiers;
318 /* The keysyms to use for the various modifiers. */
320 Lisp_Object Vx_alt_keysym, Vx_hyper_keysym, Vx_meta_keysym, Vx_super_keysym;
321 Lisp_Object Vx_keysym_table;
322 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
324 static Lisp_Object Qvendor_specific_keysyms;
325 static Lisp_Object Qlatin_1;
327 #ifdef USE_GTK
328 /* The name of the Emacs icon file. */
329 static Lisp_Object xg_default_icon_file;
331 /* Used in gtkutil.c. */
332 Lisp_Object Qx_gtk_map_stock;
333 #endif
335 /* Used in x_flush. */
337 extern Lisp_Object Vinhibit_redisplay;
339 extern XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
340 extern int x_bitmap_mask P_ ((FRAME_PTR, int));
342 static int x_alloc_nearest_color_1 P_ ((Display *, Colormap, XColor *));
343 static void x_set_window_size_1 P_ ((struct frame *, int, int, int));
344 static const XColor *x_color_cells P_ ((Display *, int *));
345 static void x_update_window_end P_ ((struct window *, int, int));
347 static int x_io_error_quitter P_ ((Display *));
348 static struct terminal *x_create_terminal P_ ((struct x_display_info *));
349 void x_delete_terminal P_ ((struct terminal *));
350 static void x_update_end P_ ((struct frame *));
351 static void XTframe_up_to_date P_ ((struct frame *));
352 static void XTset_terminal_modes P_ ((struct terminal *));
353 static void XTreset_terminal_modes P_ ((struct terminal *));
354 static void x_clear_frame P_ ((struct frame *));
355 static void frame_highlight P_ ((struct frame *));
356 static void frame_unhighlight P_ ((struct frame *));
357 static void x_new_focus_frame P_ ((struct x_display_info *, struct frame *));
358 static void x_focus_changed P_ ((int, int, struct x_display_info *,
359 struct frame *, struct input_event *));
360 static void x_detect_focus_change P_ ((struct x_display_info *,
361 XEvent *, struct input_event *));
362 static void XTframe_rehighlight P_ ((struct frame *));
363 static void x_frame_rehighlight P_ ((struct x_display_info *));
364 static void x_draw_hollow_cursor P_ ((struct window *, struct glyph_row *));
365 static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int,
366 enum text_cursor_kinds));
368 static void x_clip_to_row P_ ((struct window *, struct glyph_row *, int, GC));
369 static void x_flush P_ ((struct frame *f));
370 static void x_update_begin P_ ((struct frame *));
371 static void x_update_window_begin P_ ((struct window *));
372 static void x_after_update_window_line P_ ((struct glyph_row *));
373 static struct scroll_bar *x_window_to_scroll_bar P_ ((Display *, Window));
374 static void x_scroll_bar_report_motion P_ ((struct frame **, Lisp_Object *,
375 enum scroll_bar_part *,
376 Lisp_Object *, Lisp_Object *,
377 unsigned long *));
378 static void x_handle_net_wm_state P_ ((struct frame *, XPropertyEvent *));
379 static void x_check_fullscreen P_ ((struct frame *));
380 static void x_check_expected_move P_ ((struct frame *, int, int));
381 static void x_sync_with_move P_ ((struct frame *, int, int, int));
382 static int handle_one_xevent P_ ((struct x_display_info *, XEvent *,
383 int *, struct input_event *));
384 /* Don't declare this NO_RETURN because we want no
385 interference with debugging failing X calls. */
386 static SIGTYPE x_connection_closed P_ ((Display *, char *));
389 /* Flush display of frame F, or of all frames if F is null. */
391 static void
392 x_flush (f)
393 struct frame *f;
395 /* Don't call XFlush when it is not safe to redisplay; the X
396 connection may be broken. */
397 if (!NILP (Vinhibit_redisplay))
398 return;
400 BLOCK_INPUT;
401 if (f == NULL)
403 Lisp_Object rest, frame;
404 FOR_EACH_FRAME (rest, frame)
405 if (FRAME_X_P (XFRAME (frame)))
406 x_flush (XFRAME (frame));
408 else if (FRAME_X_P (f))
409 XFlush (FRAME_X_DISPLAY (f));
410 UNBLOCK_INPUT;
414 /* Remove calls to XFlush by defining XFlush to an empty replacement.
415 Calls to XFlush should be unnecessary because the X output buffer
416 is flushed automatically as needed by calls to XPending,
417 XNextEvent, or XWindowEvent according to the XFlush man page.
418 XTread_socket calls XPending. Removing XFlush improves
419 performance. */
421 #define XFlush(DISPLAY) (void) 0
424 /***********************************************************************
425 Debugging
426 ***********************************************************************/
428 #if 0
430 /* This is a function useful for recording debugging information about
431 the sequence of occurrences in this file. */
433 struct record
435 char *locus;
436 int type;
439 struct record event_record[100];
441 int event_record_index;
443 record_event (locus, type)
444 char *locus;
445 int type;
447 if (event_record_index == sizeof (event_record) / sizeof (struct record))
448 event_record_index = 0;
450 event_record[event_record_index].locus = locus;
451 event_record[event_record_index].type = type;
452 event_record_index++;
455 #endif /* 0 */
459 /* Return the struct x_display_info corresponding to DPY. */
461 struct x_display_info *
462 x_display_info_for_display (dpy)
463 Display *dpy;
465 struct x_display_info *dpyinfo;
467 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
468 if (dpyinfo->display == dpy)
469 return dpyinfo;
471 return 0;
474 #define OPAQUE 0xffffffff
475 #define OPACITY "_NET_WM_WINDOW_OPACITY"
477 void
478 x_set_frame_alpha (f)
479 struct frame *f;
481 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
482 Display *dpy = FRAME_X_DISPLAY (f);
483 Window win = FRAME_OUTER_WINDOW (f);
484 double alpha = 1.0;
485 double alpha_min = 1.0;
486 unsigned long opac;
488 if (FRAME_X_DISPLAY_INFO (f)->root_window != FRAME_X_OUTPUT (f)->parent_desc)
489 /* Since the WM decoration lies under the FRAME_OUTER_WINDOW,
490 we must treat the former instead of the latter. */
491 win = FRAME_X_OUTPUT(f)->parent_desc;
493 if (dpyinfo->x_highlight_frame == f)
494 alpha = f->alpha[0];
495 else
496 alpha = f->alpha[1];
498 if (FLOATP (Vframe_alpha_lower_limit))
499 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
500 else if (INTEGERP (Vframe_alpha_lower_limit))
501 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
503 if (alpha < 0.0)
504 return;
505 else if (alpha > 1.0)
506 alpha = 1.0;
507 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
508 alpha = alpha_min;
510 opac = alpha * OPAQUE;
512 /* return unless necessary */
514 unsigned char *data;
515 Atom actual;
516 int rc, format;
517 unsigned long n, left;
519 x_catch_errors (dpy);
520 rc = XGetWindowProperty(dpy, win, XInternAtom(dpy, OPACITY, False),
521 0L, 1L, False, XA_CARDINAL,
522 &actual, &format, &n, &left,
523 &data);
525 if (rc == Success && actual != None)
526 if (*(unsigned long *)data == opac)
528 XFree ((void *) data);
529 x_uncatch_errors ();
530 return;
532 else
533 XFree ((void *) data);
534 x_uncatch_errors ();
537 x_catch_errors (dpy);
538 XChangeProperty (dpy, win, XInternAtom (dpy, OPACITY, False),
539 XA_CARDINAL, 32, PropModeReplace,
540 (unsigned char *) &opac, 1L);
541 x_uncatch_errors ();
545 x_display_pixel_height (dpyinfo)
546 struct x_display_info *dpyinfo;
548 return HeightOfScreen (dpyinfo->screen);
552 x_display_pixel_width (dpyinfo)
553 struct x_display_info *dpyinfo;
555 return WidthOfScreen (dpyinfo->screen);
559 /***********************************************************************
560 Starting and ending an update
561 ***********************************************************************/
563 /* Start an update of frame F. This function is installed as a hook
564 for update_begin, i.e. it is called when update_begin is called.
565 This function is called prior to calls to x_update_window_begin for
566 each window being updated. Currently, there is nothing to do here
567 because all interesting stuff is done on a window basis. */
569 static void
570 x_update_begin (f)
571 struct frame *f;
573 /* Nothing to do. */
577 /* Start update of window W. Set the global variable updated_window
578 to the window being updated and set output_cursor to the cursor
579 position of W. */
581 static void
582 x_update_window_begin (w)
583 struct window *w;
585 struct frame *f = XFRAME (WINDOW_FRAME (w));
586 struct x_display_info *display_info = FRAME_X_DISPLAY_INFO (f);
588 updated_window = w;
589 set_output_cursor (&w->cursor);
591 BLOCK_INPUT;
593 if (f == display_info->mouse_face_mouse_frame)
595 /* Don't do highlighting for mouse motion during the update. */
596 display_info->mouse_face_defer = 1;
598 /* If F needs to be redrawn, simply forget about any prior mouse
599 highlighting. */
600 if (FRAME_GARBAGED_P (f))
601 display_info->mouse_face_window = Qnil;
604 UNBLOCK_INPUT;
608 /* Draw a vertical window border from (x,y0) to (x,y1) */
610 static void
611 x_draw_vertical_window_border (w, x, y0, y1)
612 struct window *w;
613 int x, y0, y1;
615 struct frame *f = XFRAME (WINDOW_FRAME (w));
616 struct face *face;
618 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
619 if (face)
620 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
621 face->foreground);
623 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
624 f->output_data.x->normal_gc, x, y0, x, y1);
627 /* End update of window W (which is equal to updated_window).
629 Draw vertical borders between horizontally adjacent windows, and
630 display W's cursor if CURSOR_ON_P is non-zero.
632 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
633 glyphs in mouse-face were overwritten. In that case we have to
634 make sure that the mouse-highlight is properly redrawn.
636 W may be a menu bar pseudo-window in case we don't have X toolkit
637 support. Such windows don't have a cursor, so don't display it
638 here. */
640 static void
641 x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
642 struct window *w;
643 int cursor_on_p, mouse_face_overwritten_p;
645 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
647 if (!w->pseudo_window_p)
649 BLOCK_INPUT;
651 if (cursor_on_p)
652 display_and_set_cursor (w, 1, output_cursor.hpos,
653 output_cursor.vpos,
654 output_cursor.x, output_cursor.y);
656 if (draw_window_fringes (w, 1))
657 x_draw_vertical_border (w);
659 UNBLOCK_INPUT;
662 /* If a row with mouse-face was overwritten, arrange for
663 XTframe_up_to_date to redisplay the mouse highlight. */
664 if (mouse_face_overwritten_p)
666 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
667 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
668 dpyinfo->mouse_face_window = Qnil;
671 updated_window = NULL;
675 /* End update of frame F. This function is installed as a hook in
676 update_end. */
678 static void
679 x_update_end (f)
680 struct frame *f;
682 /* Mouse highlight may be displayed again. */
683 FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
685 #ifndef XFlush
686 BLOCK_INPUT;
687 XFlush (FRAME_X_DISPLAY (f));
688 UNBLOCK_INPUT;
689 #endif
693 /* This function is called from various places in xdisp.c whenever a
694 complete update has been performed. The global variable
695 updated_window is not available here. */
697 static void
698 XTframe_up_to_date (f)
699 struct frame *f;
701 if (FRAME_X_P (f))
703 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
705 if (dpyinfo->mouse_face_deferred_gc
706 || f == dpyinfo->mouse_face_mouse_frame)
708 BLOCK_INPUT;
709 if (dpyinfo->mouse_face_mouse_frame)
710 note_mouse_highlight (dpyinfo->mouse_face_mouse_frame,
711 dpyinfo->mouse_face_mouse_x,
712 dpyinfo->mouse_face_mouse_y);
713 dpyinfo->mouse_face_deferred_gc = 0;
714 UNBLOCK_INPUT;
720 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
721 arrow bitmaps, or clear the fringes if no bitmaps are required
722 before DESIRED_ROW is made current. The window being updated is
723 found in updated_window. This function It is called from
724 update_window_line only if it is known that there are differences
725 between bitmaps to be drawn between current row and DESIRED_ROW. */
727 static void
728 x_after_update_window_line (desired_row)
729 struct glyph_row *desired_row;
731 struct window *w = updated_window;
732 struct frame *f;
733 int width, height;
735 xassert (w);
737 if (!desired_row->mode_line_p && !w->pseudo_window_p)
738 desired_row->redraw_fringe_bitmaps_p = 1;
740 /* When a window has disappeared, make sure that no rest of
741 full-width rows stays visible in the internal border. Could
742 check here if updated_window is the leftmost/rightmost window,
743 but I guess it's not worth doing since vertically split windows
744 are almost never used, internal border is rarely set, and the
745 overhead is very small. */
746 if (windows_or_buffers_changed
747 && desired_row->full_width_p
748 && (f = XFRAME (w->frame),
749 width = FRAME_INTERNAL_BORDER_WIDTH (f),
750 width != 0)
751 && (height = desired_row->visible_height,
752 height > 0))
754 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
756 BLOCK_INPUT;
757 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
758 0, y, width, height, False);
759 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
760 FRAME_PIXEL_WIDTH (f) - width,
761 y, width, height, False);
762 UNBLOCK_INPUT;
766 static void
767 x_draw_fringe_bitmap (w, row, p)
768 struct window *w;
769 struct glyph_row *row;
770 struct draw_fringe_bitmap_params *p;
772 struct frame *f = XFRAME (WINDOW_FRAME (w));
773 Display *display = FRAME_X_DISPLAY (f);
774 Window window = FRAME_X_WINDOW (f);
775 GC gc = f->output_data.x->normal_gc;
776 struct face *face = p->face;
778 /* Must clip because of partially visible lines. */
779 x_clip_to_row (w, row, -1, gc);
781 if (!p->overlay_p)
783 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
785 /* In case the same realized face is used for fringes and
786 for something displayed in the text (e.g. face `region' on
787 mono-displays, the fill style may have been changed to
788 FillSolid in x_draw_glyph_string_background. */
789 if (face->stipple)
790 XSetFillStyle (display, face->gc, FillOpaqueStippled);
791 else
792 XSetForeground (display, face->gc, face->background);
794 #ifdef USE_TOOLKIT_SCROLL_BARS
795 /* If the fringe is adjacent to the left (right) scroll bar of a
796 leftmost (rightmost, respectively) window, then extend its
797 background to the gap between the fringe and the bar. */
798 if ((WINDOW_LEFTMOST_P (w)
799 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
800 || (WINDOW_RIGHTMOST_P (w)
801 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
803 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
805 if (sb_width > 0)
807 int left = WINDOW_SCROLL_BAR_AREA_X (w);
808 int width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
809 * FRAME_COLUMN_WIDTH (f));
811 if (bx < 0)
813 /* Bitmap fills the fringe. */
814 if (left + width == p->x)
815 bx = left + sb_width;
816 else if (p->x + p->wd == left)
817 bx = left;
818 if (bx >= 0)
820 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
822 nx = width - sb_width;
823 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
824 row->y));
825 ny = row->visible_height;
828 else
830 if (left + width == bx)
832 bx = left + sb_width;
833 nx += width - sb_width;
835 else if (bx + nx == left)
836 nx += width - sb_width;
840 #endif
841 if (bx >= 0 && nx > 0)
842 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
844 if (!face->stipple)
845 XSetForeground (display, face->gc, face->foreground);
848 if (p->which)
850 unsigned char *bits;
851 Pixmap pixmap, clipmask = (Pixmap) 0;
852 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
853 XGCValues gcv;
855 if (p->wd > 8)
856 bits = (unsigned char *)(p->bits + p->dh);
857 else
858 bits = (unsigned char *)p->bits + p->dh;
860 /* Draw the bitmap. I believe these small pixmaps can be cached
861 by the server. */
862 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
863 (p->cursor_p
864 ? (p->overlay_p ? face->background
865 : f->output_data.x->cursor_pixel)
866 : face->foreground),
867 face->background, depth);
869 if (p->overlay_p)
871 clipmask = XCreatePixmapFromBitmapData (display,
872 FRAME_X_DISPLAY_INFO (f)->root_window,
873 bits, p->wd, p->h,
874 1, 0, 1);
875 gcv.clip_mask = clipmask;
876 gcv.clip_x_origin = p->x;
877 gcv.clip_y_origin = p->y;
878 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
881 XCopyArea (display, pixmap, window, gc, 0, 0,
882 p->wd, p->h, p->x, p->y);
883 XFreePixmap (display, pixmap);
885 if (p->overlay_p)
887 gcv.clip_mask = (Pixmap) 0;
888 XChangeGC (display, gc, GCClipMask, &gcv);
889 XFreePixmap (display, clipmask);
893 XSetClipMask (display, gc, None);
898 /* This is called when starting Emacs and when restarting after
899 suspend. When starting Emacs, no X window is mapped. And nothing
900 must be done to Emacs's own window if it is suspended (though that
901 rarely happens). */
903 static void
904 XTset_terminal_modes (struct terminal *terminal)
908 /* This is called when exiting or suspending Emacs. Exiting will make
909 the X-windows go away, and suspending requires no action. */
911 static void
912 XTreset_terminal_modes (struct terminal *terminal)
917 /***********************************************************************
918 Glyph display
919 ***********************************************************************/
923 static void x_set_glyph_string_clipping P_ ((struct glyph_string *));
924 static void x_set_glyph_string_gc P_ ((struct glyph_string *));
925 static void x_draw_glyph_string_background P_ ((struct glyph_string *,
926 int));
927 static void x_draw_glyph_string_foreground P_ ((struct glyph_string *));
928 static void x_draw_composite_glyph_string_foreground P_ ((struct glyph_string *));
929 static void x_draw_glyph_string_box P_ ((struct glyph_string *));
930 static void x_draw_glyph_string P_ ((struct glyph_string *));
931 static void x_compute_glyph_string_overhangs P_ ((struct glyph_string *));
932 static void x_set_cursor_gc P_ ((struct glyph_string *));
933 static void x_set_mode_line_face_gc P_ ((struct glyph_string *));
934 static void x_set_mouse_face_gc P_ ((struct glyph_string *));
935 static int x_alloc_lighter_color P_ ((struct frame *, Display *, Colormap,
936 unsigned long *, double, int));
937 static void x_setup_relief_color P_ ((struct frame *, struct relief *,
938 double, int, unsigned long));
939 static void x_setup_relief_colors P_ ((struct glyph_string *));
940 static void x_draw_image_glyph_string P_ ((struct glyph_string *));
941 static void x_draw_image_relief P_ ((struct glyph_string *));
942 static void x_draw_image_foreground P_ ((struct glyph_string *));
943 static void x_draw_image_foreground_1 P_ ((struct glyph_string *, Pixmap));
944 static void x_clear_glyph_string_rect P_ ((struct glyph_string *, int,
945 int, int, int));
946 static void x_draw_relief_rect P_ ((struct frame *, int, int, int, int,
947 int, int, int, int, int, int,
948 XRectangle *));
949 static void x_draw_box_rect P_ ((struct glyph_string *, int, int, int, int,
950 int, int, int, XRectangle *));
952 #if GLYPH_DEBUG
953 static void x_check_font P_ ((struct frame *, struct font *));
954 #endif
957 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
958 face. */
960 static void
961 x_set_cursor_gc (s)
962 struct glyph_string *s;
964 if (s->font == FRAME_FONT (s->f)
965 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
966 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
967 && !s->cmp)
968 s->gc = s->f->output_data.x->cursor_gc;
969 else
971 /* Cursor on non-default face: must merge. */
972 XGCValues xgcv;
973 unsigned long mask;
975 xgcv.background = s->f->output_data.x->cursor_pixel;
976 xgcv.foreground = s->face->background;
978 /* If the glyph would be invisible, try a different foreground. */
979 if (xgcv.foreground == xgcv.background)
980 xgcv.foreground = s->face->foreground;
981 if (xgcv.foreground == xgcv.background)
982 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
983 if (xgcv.foreground == xgcv.background)
984 xgcv.foreground = s->face->foreground;
986 /* Make sure the cursor is distinct from text in this face. */
987 if (xgcv.background == s->face->background
988 && xgcv.foreground == s->face->foreground)
990 xgcv.background = s->face->foreground;
991 xgcv.foreground = s->face->background;
994 IF_DEBUG (x_check_font (s->f, s->font));
995 xgcv.graphics_exposures = False;
996 mask = GCForeground | GCBackground | GCGraphicsExposures;
998 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
999 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1000 mask, &xgcv);
1001 else
1002 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1003 = XCreateGC (s->display, s->window, mask, &xgcv);
1005 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1010 /* Set up S->gc of glyph string S for drawing text in mouse face. */
1012 static void
1013 x_set_mouse_face_gc (s)
1014 struct glyph_string *s;
1016 int face_id;
1017 struct face *face;
1019 /* What face has to be used last for the mouse face? */
1020 face_id = FRAME_X_DISPLAY_INFO (s->f)->mouse_face_face_id;
1021 face = FACE_FROM_ID (s->f, face_id);
1022 if (face == NULL)
1023 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
1025 if (s->first_glyph->type == CHAR_GLYPH)
1026 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1027 else
1028 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1029 s->face = FACE_FROM_ID (s->f, face_id);
1030 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1032 if (s->font == s->face->font)
1033 s->gc = s->face->gc;
1034 else
1036 /* Otherwise construct scratch_cursor_gc with values from FACE
1037 except for FONT. */
1038 XGCValues xgcv;
1039 unsigned long mask;
1041 xgcv.background = s->face->background;
1042 xgcv.foreground = s->face->foreground;
1043 xgcv.graphics_exposures = False;
1044 mask = GCForeground | GCBackground | GCGraphicsExposures;
1046 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1047 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1048 mask, &xgcv);
1049 else
1050 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1051 = XCreateGC (s->display, s->window, mask, &xgcv);
1053 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1056 xassert (s->gc != 0);
1060 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1061 Faces to use in the mode line have already been computed when the
1062 matrix was built, so there isn't much to do, here. */
1064 static INLINE void
1065 x_set_mode_line_face_gc (s)
1066 struct glyph_string *s;
1068 s->gc = s->face->gc;
1072 /* Set S->gc of glyph string S for drawing that glyph string. Set
1073 S->stippled_p to a non-zero value if the face of S has a stipple
1074 pattern. */
1076 static INLINE void
1077 x_set_glyph_string_gc (s)
1078 struct glyph_string *s;
1080 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1082 if (s->hl == DRAW_NORMAL_TEXT)
1084 s->gc = s->face->gc;
1085 s->stippled_p = s->face->stipple != 0;
1087 else if (s->hl == DRAW_INVERSE_VIDEO)
1089 x_set_mode_line_face_gc (s);
1090 s->stippled_p = s->face->stipple != 0;
1092 else if (s->hl == DRAW_CURSOR)
1094 x_set_cursor_gc (s);
1095 s->stippled_p = 0;
1097 else if (s->hl == DRAW_MOUSE_FACE)
1099 x_set_mouse_face_gc (s);
1100 s->stippled_p = s->face->stipple != 0;
1102 else if (s->hl == DRAW_IMAGE_RAISED
1103 || s->hl == DRAW_IMAGE_SUNKEN)
1105 s->gc = s->face->gc;
1106 s->stippled_p = s->face->stipple != 0;
1108 else
1110 s->gc = s->face->gc;
1111 s->stippled_p = s->face->stipple != 0;
1114 /* GC must have been set. */
1115 xassert (s->gc != 0);
1119 /* Set clipping for output of glyph string S. S may be part of a mode
1120 line or menu if we don't have X toolkit support. */
1122 static INLINE void
1123 x_set_glyph_string_clipping (s)
1124 struct glyph_string *s;
1126 XRectangle *r = s->clip;
1127 int n = get_glyph_string_clip_rects (s, r, 2);
1129 if (n > 0)
1130 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1131 s->num_clips = n;
1135 /* Set SRC's clipping for output of glyph string DST. This is called
1136 when we are drawing DST's left_overhang or right_overhang only in
1137 the area of SRC. */
1139 static void
1140 x_set_glyph_string_clipping_exactly (src, dst)
1141 struct glyph_string *src, *dst;
1143 XRectangle r;
1145 r.x = src->x;
1146 r.width = src->width;
1147 r.y = src->y;
1148 r.height = src->height;
1149 dst->clip[0] = r;
1150 dst->num_clips = 1;
1151 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1155 /* RIF:
1156 Compute left and right overhang of glyph string S. */
1158 static void
1159 x_compute_glyph_string_overhangs (s)
1160 struct glyph_string *s;
1162 if (s->cmp == NULL
1163 && (s->first_glyph->type == CHAR_GLYPH
1164 || s->first_glyph->type == COMPOSITE_GLYPH))
1166 struct font_metrics metrics;
1168 if (s->first_glyph->type == CHAR_GLYPH)
1170 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1171 struct font *font = s->font;
1172 int i;
1174 for (i = 0; i < s->nchars; i++)
1175 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1176 font->driver->text_extents (font, code, s->nchars, &metrics);
1178 else
1180 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1182 composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
1184 s->right_overhang = (metrics.rbearing > metrics.width
1185 ? metrics.rbearing - metrics.width : 0);
1186 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1188 else if (s->cmp)
1190 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1191 s->left_overhang = - s->cmp->lbearing;
1196 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1198 static INLINE void
1199 x_clear_glyph_string_rect (s, x, y, w, h)
1200 struct glyph_string *s;
1201 int x, y, w, h;
1203 XGCValues xgcv;
1204 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1205 XSetForeground (s->display, s->gc, xgcv.background);
1206 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1207 XSetForeground (s->display, s->gc, xgcv.foreground);
1211 /* Draw the background of glyph_string S. If S->background_filled_p
1212 is non-zero don't draw it. FORCE_P non-zero means draw the
1213 background even if it wouldn't be drawn normally. This is used
1214 when a string preceding S draws into the background of S, or S
1215 contains the first component of a composition. */
1217 static void
1218 x_draw_glyph_string_background (s, force_p)
1219 struct glyph_string *s;
1220 int force_p;
1222 /* Nothing to do if background has already been drawn or if it
1223 shouldn't be drawn in the first place. */
1224 if (!s->background_filled_p)
1226 int box_line_width = max (s->face->box_line_width, 0);
1228 if (s->stippled_p)
1230 /* Fill background with a stipple pattern. */
1231 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1232 XFillRectangle (s->display, s->window, s->gc, s->x,
1233 s->y + box_line_width,
1234 s->background_width,
1235 s->height - 2 * box_line_width);
1236 XSetFillStyle (s->display, s->gc, FillSolid);
1237 s->background_filled_p = 1;
1239 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1240 || s->font_not_found_p
1241 || s->extends_to_end_of_line_p
1242 || force_p)
1244 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1245 s->background_width,
1246 s->height - 2 * box_line_width);
1247 s->background_filled_p = 1;
1253 /* Draw the foreground of glyph string S. */
1255 static void
1256 x_draw_glyph_string_foreground (s)
1257 struct glyph_string *s;
1259 int i, x;
1261 /* If first glyph of S has a left box line, start drawing the text
1262 of S to the right of that box line. */
1263 if (s->face->box != FACE_NO_BOX
1264 && s->first_glyph->left_box_line_p)
1265 x = s->x + eabs (s->face->box_line_width);
1266 else
1267 x = s->x;
1269 /* Draw characters of S as rectangles if S's font could not be
1270 loaded. */
1271 if (s->font_not_found_p)
1273 for (i = 0; i < s->nchars; ++i)
1275 struct glyph *g = s->first_glyph + i;
1276 XDrawRectangle (s->display, s->window,
1277 s->gc, x, s->y, g->pixel_width - 1,
1278 s->height - 1);
1279 x += g->pixel_width;
1282 else
1284 struct font *font = s->font;
1285 int boff = font->baseline_offset;
1286 int y;
1288 if (font->vertical_centering)
1289 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1291 y = s->ybase - boff;
1292 if (s->for_overlaps
1293 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1294 font->driver->draw (s, 0, s->nchars, x, y, 0);
1295 else
1296 font->driver->draw (s, 0, s->nchars, x, y, 1);
1297 if (s->face->overstrike)
1298 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1302 /* Draw the foreground of composite glyph string S. */
1304 static void
1305 x_draw_composite_glyph_string_foreground (s)
1306 struct glyph_string *s;
1308 int i, j, x;
1309 struct font *font = s->font;
1311 /* If first glyph of S has a left box line, start drawing the text
1312 of S to the right of that box line. */
1313 if (s->face && s->face->box != FACE_NO_BOX
1314 && s->first_glyph->left_box_line_p)
1315 x = s->x + eabs (s->face->box_line_width);
1316 else
1317 x = s->x;
1319 /* S is a glyph string for a composition. S->cmp_from is the index
1320 of the first character drawn for glyphs of this composition.
1321 S->cmp_from == 0 means we are drawing the very first character of
1322 this composition. */
1324 /* Draw a rectangle for the composition if the font for the very
1325 first character of the composition could not be loaded. */
1326 if (s->font_not_found_p)
1328 if (s->cmp_from == 0)
1329 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1330 s->width - 1, s->height - 1);
1332 else if (! s->first_glyph->u.cmp.automatic)
1334 int y = s->ybase;
1336 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1337 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1339 int xx = x + s->cmp->offsets[j * 2];
1340 int yy = y - s->cmp->offsets[j * 2 + 1];
1342 font->driver->draw (s, j, j + 1, xx, yy, 0);
1343 if (s->face->overstrike)
1344 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1347 else
1349 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1350 Lisp_Object glyph;
1351 int y = s->ybase;
1352 int width = 0;
1354 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1356 glyph = LGSTRING_GLYPH (gstring, i);
1357 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1358 width += LGLYPH_WIDTH (glyph);
1359 else
1361 int xoff, yoff, wadjust;
1363 if (j < i)
1365 font->driver->draw (s, j, i, x, y, 0);
1366 if (s->face->overstrike)
1367 font->driver->draw (s, j, i, x + 1, y, 0);
1368 x += width;
1370 xoff = LGLYPH_XOFF (glyph);
1371 yoff = LGLYPH_YOFF (glyph);
1372 wadjust = LGLYPH_WADJUST (glyph);
1373 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1374 if (s->face->overstrike)
1375 font->driver->draw (s, i, i + 1, x + xoff + 1, y + yoff, 0);
1376 x += wadjust;
1377 j = i + 1;
1378 width = 0;
1381 if (j < i)
1383 font->driver->draw (s, j, i, x, y, 0);
1384 if (s->face->overstrike)
1385 font->driver->draw (s, j, i, x + 1, y, 0);
1391 #ifdef USE_X_TOOLKIT
1393 static struct frame *x_frame_of_widget P_ ((Widget));
1394 static Boolean cvt_string_to_pixel P_ ((Display *, XrmValue *, Cardinal *,
1395 XrmValue *, XrmValue *, XtPointer *));
1396 static void cvt_pixel_dtor P_ ((XtAppContext, XrmValue *, XtPointer,
1397 XrmValue *, Cardinal *));
1400 /* Return the frame on which widget WIDGET is used.. Abort if frame
1401 cannot be determined. */
1403 static struct frame *
1404 x_frame_of_widget (widget)
1405 Widget widget;
1407 struct x_display_info *dpyinfo;
1408 Lisp_Object tail;
1409 struct frame *f;
1411 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1413 /* Find the top-level shell of the widget. Note that this function
1414 can be called when the widget is not yet realized, so XtWindow
1415 (widget) == 0. That's the reason we can't simply use
1416 x_any_window_to_frame. */
1417 while (!XtIsTopLevelShell (widget))
1418 widget = XtParent (widget);
1420 /* Look for a frame with that top-level widget. Allocate the color
1421 on that frame to get the right gamma correction value. */
1422 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1423 if (FRAMEP (XCAR (tail))
1424 && (f = XFRAME (XCAR (tail)),
1425 (FRAME_X_P (f)
1426 && f->output_data.nothing != 1
1427 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1428 && f->output_data.x->widget == widget)
1429 return f;
1431 abort ();
1435 /* Allocate the color COLOR->pixel on the screen and display of
1436 widget WIDGET in colormap CMAP. If an exact match cannot be
1437 allocated, try the nearest color available. Value is non-zero
1438 if successful. This is called from lwlib. */
1441 x_alloc_nearest_color_for_widget (widget, cmap, color)
1442 Widget widget;
1443 Colormap cmap;
1444 XColor *color;
1446 struct frame *f = x_frame_of_widget (widget);
1447 return x_alloc_nearest_color (f, cmap, color);
1451 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1452 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1453 If this produces the same color as PIXEL, try a color where all RGB
1454 values have DELTA added. Return the allocated color in *PIXEL.
1455 DISPLAY is the X display, CMAP is the colormap to operate on.
1456 Value is non-zero if successful. */
1459 x_alloc_lighter_color_for_widget (widget, display, cmap, pixel, factor, delta)
1460 Widget widget;
1461 Display *display;
1462 Colormap cmap;
1463 unsigned long *pixel;
1464 double factor;
1465 int delta;
1467 struct frame *f = x_frame_of_widget (widget);
1468 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1472 /* Structure specifying which arguments should be passed by Xt to
1473 cvt_string_to_pixel. We want the widget's screen and colormap. */
1475 static XtConvertArgRec cvt_string_to_pixel_args[] =
1477 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1478 sizeof (Screen *)},
1479 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1480 sizeof (Colormap)}
1484 /* The address of this variable is returned by
1485 cvt_string_to_pixel. */
1487 static Pixel cvt_string_to_pixel_value;
1490 /* Convert a color name to a pixel color.
1492 DPY is the display we are working on.
1494 ARGS is an array of *NARGS XrmValue structures holding additional
1495 information about the widget for which the conversion takes place.
1496 The contents of this array are determined by the specification
1497 in cvt_string_to_pixel_args.
1499 FROM is a pointer to an XrmValue which points to the color name to
1500 convert. TO is an XrmValue in which to return the pixel color.
1502 CLOSURE_RET is a pointer to user-data, in which we record if
1503 we allocated the color or not.
1505 Value is True if successful, False otherwise. */
1507 static Boolean
1508 cvt_string_to_pixel (dpy, args, nargs, from, to, closure_ret)
1509 Display *dpy;
1510 XrmValue *args;
1511 Cardinal *nargs;
1512 XrmValue *from, *to;
1513 XtPointer *closure_ret;
1515 Screen *screen;
1516 Colormap cmap;
1517 Pixel pixel;
1518 String color_name;
1519 XColor color;
1521 if (*nargs != 2)
1523 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1524 "wrongParameters", "cvt_string_to_pixel",
1525 "XtToolkitError",
1526 "Screen and colormap args required", NULL, NULL);
1527 return False;
1530 screen = *(Screen **) args[0].addr;
1531 cmap = *(Colormap *) args[1].addr;
1532 color_name = (String) from->addr;
1534 if (strcmp (color_name, XtDefaultBackground) == 0)
1536 *closure_ret = (XtPointer) False;
1537 pixel = WhitePixelOfScreen (screen);
1539 else if (strcmp (color_name, XtDefaultForeground) == 0)
1541 *closure_ret = (XtPointer) False;
1542 pixel = BlackPixelOfScreen (screen);
1544 else if (XParseColor (dpy, cmap, color_name, &color)
1545 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1547 pixel = color.pixel;
1548 *closure_ret = (XtPointer) True;
1550 else
1552 String params[1];
1553 Cardinal nparams = 1;
1555 params[0] = color_name;
1556 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1557 "badValue", "cvt_string_to_pixel",
1558 "XtToolkitError", "Invalid color `%s'",
1559 params, &nparams);
1560 return False;
1563 if (to->addr != NULL)
1565 if (to->size < sizeof (Pixel))
1567 to->size = sizeof (Pixel);
1568 return False;
1571 *(Pixel *) to->addr = pixel;
1573 else
1575 cvt_string_to_pixel_value = pixel;
1576 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1579 to->size = sizeof (Pixel);
1580 return True;
1584 /* Free a pixel color which was previously allocated via
1585 cvt_string_to_pixel. This is registered as the destructor
1586 for this type of resource via XtSetTypeConverter.
1588 APP is the application context in which we work.
1590 TO is a pointer to an XrmValue holding the color to free.
1591 CLOSURE is the value we stored in CLOSURE_RET for this color
1592 in cvt_string_to_pixel.
1594 ARGS and NARGS are like for cvt_string_to_pixel. */
1596 static void
1597 cvt_pixel_dtor (app, to, closure, args, nargs)
1598 XtAppContext app;
1599 XrmValuePtr to;
1600 XtPointer closure;
1601 XrmValuePtr args;
1602 Cardinal *nargs;
1604 if (*nargs != 2)
1606 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1607 "XtToolkitError",
1608 "Screen and colormap arguments required",
1609 NULL, NULL);
1611 else if (closure != NULL)
1613 /* We did allocate the pixel, so free it. */
1614 Screen *screen = *(Screen **) args[0].addr;
1615 Colormap cmap = *(Colormap *) args[1].addr;
1616 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1617 (Pixel *) to->addr, 1);
1622 #endif /* USE_X_TOOLKIT */
1625 /* Value is an array of XColor structures for the contents of the
1626 color map of display DPY. Set *NCELLS to the size of the array.
1627 Note that this probably shouldn't be called for large color maps,
1628 say a 24-bit TrueColor map. */
1630 static const XColor *
1631 x_color_cells (dpy, ncells)
1632 Display *dpy;
1633 int *ncells;
1635 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1637 if (dpyinfo->color_cells == NULL)
1639 Screen *screen = dpyinfo->screen;
1640 int i;
1642 dpyinfo->ncolor_cells
1643 = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1644 dpyinfo->color_cells
1645 = (XColor *) xmalloc (dpyinfo->ncolor_cells
1646 * sizeof *dpyinfo->color_cells);
1648 for (i = 0; i < dpyinfo->ncolor_cells; ++i)
1649 dpyinfo->color_cells[i].pixel = i;
1651 XQueryColors (dpy, dpyinfo->cmap,
1652 dpyinfo->color_cells, dpyinfo->ncolor_cells);
1655 *ncells = dpyinfo->ncolor_cells;
1656 return dpyinfo->color_cells;
1660 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1661 colors in COLORS. Use cached information, if available. */
1663 void
1664 x_query_colors (f, colors, ncolors)
1665 struct frame *f;
1666 XColor *colors;
1667 int ncolors;
1669 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1671 if (dpyinfo->color_cells)
1673 int i;
1674 for (i = 0; i < ncolors; ++i)
1676 unsigned long pixel = colors[i].pixel;
1677 xassert (pixel < dpyinfo->ncolor_cells);
1678 xassert (dpyinfo->color_cells[pixel].pixel == pixel);
1679 colors[i] = dpyinfo->color_cells[pixel];
1682 else
1683 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1687 /* On frame F, translate pixel color to RGB values for the color in
1688 COLOR. Use cached information, if available. */
1690 void
1691 x_query_color (f, color)
1692 struct frame *f;
1693 XColor *color;
1695 x_query_colors (f, color, 1);
1699 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1700 exact match can't be allocated, try the nearest color available.
1701 Value is non-zero if successful. Set *COLOR to the color
1702 allocated. */
1704 static int
1705 x_alloc_nearest_color_1 (dpy, cmap, color)
1706 Display *dpy;
1707 Colormap cmap;
1708 XColor *color;
1710 int rc;
1712 rc = XAllocColor (dpy, cmap, color);
1713 if (rc == 0)
1715 /* If we got to this point, the colormap is full, so we're going
1716 to try to get the next closest color. The algorithm used is
1717 a least-squares matching, which is what X uses for closest
1718 color matching with StaticColor visuals. */
1719 int nearest, i;
1720 unsigned long nearest_delta = ~0;
1721 int ncells;
1722 const XColor *cells = x_color_cells (dpy, &ncells);
1724 for (nearest = i = 0; i < ncells; ++i)
1726 long dred = (color->red >> 8) - (cells[i].red >> 8);
1727 long dgreen = (color->green >> 8) - (cells[i].green >> 8);
1728 long dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1729 unsigned long delta = dred * dred + dgreen * dgreen + dblue * dblue;
1731 if (delta < nearest_delta)
1733 nearest = i;
1734 nearest_delta = delta;
1738 color->red = cells[nearest].red;
1739 color->green = cells[nearest].green;
1740 color->blue = cells[nearest].blue;
1741 rc = XAllocColor (dpy, cmap, color);
1743 else
1745 /* If allocation succeeded, and the allocated pixel color is not
1746 equal to a cached pixel color recorded earlier, there was a
1747 change in the colormap, so clear the color cache. */
1748 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1749 XColor *cached_color;
1751 if (dpyinfo->color_cells
1752 && (cached_color = &dpyinfo->color_cells[color->pixel],
1753 (cached_color->red != color->red
1754 || cached_color->blue != color->blue
1755 || cached_color->green != color->green)))
1757 xfree (dpyinfo->color_cells);
1758 dpyinfo->color_cells = NULL;
1759 dpyinfo->ncolor_cells = 0;
1763 #ifdef DEBUG_X_COLORS
1764 if (rc)
1765 register_color (color->pixel);
1766 #endif /* DEBUG_X_COLORS */
1768 return rc;
1772 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1773 exact match can't be allocated, try the nearest color available.
1774 Value is non-zero if successful. Set *COLOR to the color
1775 allocated. */
1778 x_alloc_nearest_color (f, cmap, color)
1779 struct frame *f;
1780 Colormap cmap;
1781 XColor *color;
1783 gamma_correct (f, color);
1784 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1788 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1789 It's necessary to do this instead of just using PIXEL directly to
1790 get color reference counts right. */
1792 unsigned long
1793 x_copy_color (f, pixel)
1794 struct frame *f;
1795 unsigned long pixel;
1797 XColor color;
1799 color.pixel = pixel;
1800 BLOCK_INPUT;
1801 x_query_color (f, &color);
1802 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1803 UNBLOCK_INPUT;
1804 #ifdef DEBUG_X_COLORS
1805 register_color (pixel);
1806 #endif
1807 return color.pixel;
1811 /* Allocate color PIXEL on display DPY. PIXEL must already be allocated.
1812 It's necessary to do this instead of just using PIXEL directly to
1813 get color reference counts right. */
1815 unsigned long
1816 x_copy_dpy_color (dpy, cmap, pixel)
1817 Display *dpy;
1818 Colormap cmap;
1819 unsigned long pixel;
1821 XColor color;
1823 color.pixel = pixel;
1824 BLOCK_INPUT;
1825 XQueryColor (dpy, cmap, &color);
1826 XAllocColor (dpy, cmap, &color);
1827 UNBLOCK_INPUT;
1828 #ifdef DEBUG_X_COLORS
1829 register_color (pixel);
1830 #endif
1831 return color.pixel;
1835 /* Brightness beyond which a color won't have its highlight brightness
1836 boosted.
1838 Nominally, highlight colors for `3d' faces are calculated by
1839 brightening an object's color by a constant scale factor, but this
1840 doesn't yield good results for dark colors, so for colors who's
1841 brightness is less than this value (on a scale of 0-65535) have an
1842 use an additional additive factor.
1844 The value here is set so that the default menu-bar/mode-line color
1845 (grey75) will not have its highlights changed at all. */
1846 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1849 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1850 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1851 If this produces the same color as PIXEL, try a color where all RGB
1852 values have DELTA added. Return the allocated color in *PIXEL.
1853 DISPLAY is the X display, CMAP is the colormap to operate on.
1854 Value is non-zero if successful. */
1856 static int
1857 x_alloc_lighter_color (f, display, cmap, pixel, factor, delta)
1858 struct frame *f;
1859 Display *display;
1860 Colormap cmap;
1861 unsigned long *pixel;
1862 double factor;
1863 int delta;
1865 XColor color, new;
1866 long bright;
1867 int success_p;
1869 /* Get RGB color values. */
1870 color.pixel = *pixel;
1871 x_query_color (f, &color);
1873 /* Change RGB values by specified FACTOR. Avoid overflow! */
1874 xassert (factor >= 0);
1875 new.red = min (0xffff, factor * color.red);
1876 new.green = min (0xffff, factor * color.green);
1877 new.blue = min (0xffff, factor * color.blue);
1879 /* Calculate brightness of COLOR. */
1880 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1882 /* We only boost colors that are darker than
1883 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1884 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1885 /* Make an additive adjustment to NEW, because it's dark enough so
1886 that scaling by FACTOR alone isn't enough. */
1888 /* How far below the limit this color is (0 - 1, 1 being darker). */
1889 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1890 /* The additive adjustment. */
1891 int min_delta = delta * dimness * factor / 2;
1893 if (factor < 1)
1895 new.red = max (0, new.red - min_delta);
1896 new.green = max (0, new.green - min_delta);
1897 new.blue = max (0, new.blue - min_delta);
1899 else
1901 new.red = min (0xffff, min_delta + new.red);
1902 new.green = min (0xffff, min_delta + new.green);
1903 new.blue = min (0xffff, min_delta + new.blue);
1907 /* Try to allocate the color. */
1908 success_p = x_alloc_nearest_color (f, cmap, &new);
1909 if (success_p)
1911 if (new.pixel == *pixel)
1913 /* If we end up with the same color as before, try adding
1914 delta to the RGB values. */
1915 x_free_colors (f, &new.pixel, 1);
1917 new.red = min (0xffff, delta + color.red);
1918 new.green = min (0xffff, delta + color.green);
1919 new.blue = min (0xffff, delta + color.blue);
1920 success_p = x_alloc_nearest_color (f, cmap, &new);
1922 else
1923 success_p = 1;
1924 *pixel = new.pixel;
1927 return success_p;
1931 /* Set up the foreground color for drawing relief lines of glyph
1932 string S. RELIEF is a pointer to a struct relief containing the GC
1933 with which lines will be drawn. Use a color that is FACTOR or
1934 DELTA lighter or darker than the relief's background which is found
1935 in S->f->output_data.x->relief_background. If such a color cannot
1936 be allocated, use DEFAULT_PIXEL, instead. */
1938 static void
1939 x_setup_relief_color (f, relief, factor, delta, default_pixel)
1940 struct frame *f;
1941 struct relief *relief;
1942 double factor;
1943 int delta;
1944 unsigned long default_pixel;
1946 XGCValues xgcv;
1947 struct x_output *di = f->output_data.x;
1948 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1949 unsigned long pixel;
1950 unsigned long background = di->relief_background;
1951 Colormap cmap = FRAME_X_COLORMAP (f);
1952 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1953 Display *dpy = FRAME_X_DISPLAY (f);
1955 xgcv.graphics_exposures = False;
1956 xgcv.line_width = 1;
1958 /* Free previously allocated color. The color cell will be reused
1959 when it has been freed as many times as it was allocated, so this
1960 doesn't affect faces using the same colors. */
1961 if (relief->gc
1962 && relief->allocated_p)
1964 x_free_colors (f, &relief->pixel, 1);
1965 relief->allocated_p = 0;
1968 /* Allocate new color. */
1969 xgcv.foreground = default_pixel;
1970 pixel = background;
1971 if (dpyinfo->n_planes != 1
1972 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1974 relief->allocated_p = 1;
1975 xgcv.foreground = relief->pixel = pixel;
1978 if (relief->gc == 0)
1980 xgcv.stipple = dpyinfo->gray;
1981 mask |= GCStipple;
1982 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1984 else
1985 XChangeGC (dpy, relief->gc, mask, &xgcv);
1989 /* Set up colors for the relief lines around glyph string S. */
1991 static void
1992 x_setup_relief_colors (s)
1993 struct glyph_string *s;
1995 struct x_output *di = s->f->output_data.x;
1996 unsigned long color;
1998 if (s->face->use_box_color_for_shadows_p)
1999 color = s->face->box_color;
2000 else if (s->first_glyph->type == IMAGE_GLYPH
2001 && s->img->pixmap
2002 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2003 color = IMAGE_BACKGROUND (s->img, s->f, 0);
2004 else
2006 XGCValues xgcv;
2008 /* Get the background color of the face. */
2009 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
2010 color = xgcv.background;
2013 if (di->white_relief.gc == 0
2014 || color != di->relief_background)
2016 di->relief_background = color;
2017 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
2018 WHITE_PIX_DEFAULT (s->f));
2019 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
2020 BLACK_PIX_DEFAULT (s->f));
2025 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
2026 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
2027 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
2028 relief. LEFT_P non-zero means draw a relief on the left side of
2029 the rectangle. RIGHT_P non-zero means draw a relief on the right
2030 side of the rectangle. CLIP_RECT is the clipping rectangle to use
2031 when drawing. */
2033 static void
2034 x_draw_relief_rect (f, left_x, top_y, right_x, bottom_y, width,
2035 raised_p, top_p, bot_p, left_p, right_p, clip_rect)
2036 struct frame *f;
2037 int left_x, top_y, right_x, bottom_y, width;
2038 int top_p, bot_p, left_p, right_p, raised_p;
2039 XRectangle *clip_rect;
2041 Display *dpy = FRAME_X_DISPLAY (f);
2042 Window window = FRAME_X_WINDOW (f);
2043 int i;
2044 GC gc;
2046 if (raised_p)
2047 gc = f->output_data.x->white_relief.gc;
2048 else
2049 gc = f->output_data.x->black_relief.gc;
2050 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2052 /* Top. */
2053 if (top_p)
2054 for (i = 0; i < width; ++i)
2055 XDrawLine (dpy, window, gc,
2056 left_x + i * left_p, top_y + i,
2057 right_x + 1 - i * right_p, top_y + i);
2059 /* Left. */
2060 if (left_p)
2061 for (i = 0; i < width; ++i)
2062 XDrawLine (dpy, window, gc,
2063 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
2065 XSetClipMask (dpy, gc, None);
2066 if (raised_p)
2067 gc = f->output_data.x->black_relief.gc;
2068 else
2069 gc = f->output_data.x->white_relief.gc;
2070 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2072 /* Bottom. */
2073 if (bot_p)
2074 for (i = 0; i < width; ++i)
2075 XDrawLine (dpy, window, gc,
2076 left_x + i * left_p, bottom_y - i,
2077 right_x + 1 - i * right_p, bottom_y - i);
2079 /* Right. */
2080 if (right_p)
2081 for (i = 0; i < width; ++i)
2082 XDrawLine (dpy, window, gc,
2083 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
2085 XSetClipMask (dpy, gc, None);
2089 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2090 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2091 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2092 left side of the rectangle. RIGHT_P non-zero means draw a line
2093 on the right side of the rectangle. CLIP_RECT is the clipping
2094 rectangle to use when drawing. */
2096 static void
2097 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2098 left_p, right_p, clip_rect)
2099 struct glyph_string *s;
2100 int left_x, top_y, right_x, bottom_y, width, left_p, right_p;
2101 XRectangle *clip_rect;
2103 XGCValues xgcv;
2105 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2106 XSetForeground (s->display, s->gc, s->face->box_color);
2107 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2109 /* Top. */
2110 XFillRectangle (s->display, s->window, s->gc,
2111 left_x, top_y, right_x - left_x + 1, width);
2113 /* Left. */
2114 if (left_p)
2115 XFillRectangle (s->display, s->window, s->gc,
2116 left_x, top_y, width, bottom_y - top_y + 1);
2118 /* Bottom. */
2119 XFillRectangle (s->display, s->window, s->gc,
2120 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2122 /* Right. */
2123 if (right_p)
2124 XFillRectangle (s->display, s->window, s->gc,
2125 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2127 XSetForeground (s->display, s->gc, xgcv.foreground);
2128 XSetClipMask (s->display, s->gc, None);
2132 /* Draw a box around glyph string S. */
2134 static void
2135 x_draw_glyph_string_box (s)
2136 struct glyph_string *s;
2138 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2139 int left_p, right_p;
2140 struct glyph *last_glyph;
2141 XRectangle clip_rect;
2143 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2144 ? WINDOW_RIGHT_EDGE_X (s->w)
2145 : window_box_right (s->w, s->area));
2147 /* The glyph that may have a right box line. */
2148 last_glyph = (s->cmp || s->img
2149 ? s->first_glyph
2150 : s->first_glyph + s->nchars - 1);
2152 width = eabs (s->face->box_line_width);
2153 raised_p = s->face->box == FACE_RAISED_BOX;
2154 left_x = s->x;
2155 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2156 ? last_x - 1
2157 : min (last_x, s->x + s->background_width) - 1);
2158 top_y = s->y;
2159 bottom_y = top_y + s->height - 1;
2161 left_p = (s->first_glyph->left_box_line_p
2162 || (s->hl == DRAW_MOUSE_FACE
2163 && (s->prev == NULL
2164 || s->prev->hl != s->hl)));
2165 right_p = (last_glyph->right_box_line_p
2166 || (s->hl == DRAW_MOUSE_FACE
2167 && (s->next == NULL
2168 || s->next->hl != s->hl)));
2170 get_glyph_string_clip_rect (s, &clip_rect);
2172 if (s->face->box == FACE_SIMPLE_BOX)
2173 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2174 left_p, right_p, &clip_rect);
2175 else
2177 x_setup_relief_colors (s);
2178 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2179 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2184 /* Draw foreground of image glyph string S. */
2186 static void
2187 x_draw_image_foreground (s)
2188 struct glyph_string *s;
2190 int x = s->x;
2191 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2193 /* If first glyph of S has a left box line, start drawing it to the
2194 right of that line. */
2195 if (s->face->box != FACE_NO_BOX
2196 && s->first_glyph->left_box_line_p
2197 && s->slice.x == 0)
2198 x += eabs (s->face->box_line_width);
2200 /* If there is a margin around the image, adjust x- and y-position
2201 by that margin. */
2202 if (s->slice.x == 0)
2203 x += s->img->hmargin;
2204 if (s->slice.y == 0)
2205 y += s->img->vmargin;
2207 if (s->img->pixmap)
2209 if (s->img->mask)
2211 /* We can't set both a clip mask and use XSetClipRectangles
2212 because the latter also sets a clip mask. We also can't
2213 trust on the shape extension to be available
2214 (XShapeCombineRegion). So, compute the rectangle to draw
2215 manually. */
2216 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2217 | GCFunction);
2218 XGCValues xgcv;
2219 XRectangle clip_rect, image_rect, r;
2221 xgcv.clip_mask = s->img->mask;
2222 xgcv.clip_x_origin = x;
2223 xgcv.clip_y_origin = y;
2224 xgcv.function = GXcopy;
2225 XChangeGC (s->display, s->gc, mask, &xgcv);
2227 get_glyph_string_clip_rect (s, &clip_rect);
2228 image_rect.x = x;
2229 image_rect.y = y;
2230 image_rect.width = s->slice.width;
2231 image_rect.height = s->slice.height;
2232 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2233 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2234 s->slice.x + r.x - x, s->slice.y + r.y - y,
2235 r.width, r.height, r.x, r.y);
2237 else
2239 XRectangle clip_rect, image_rect, r;
2241 get_glyph_string_clip_rect (s, &clip_rect);
2242 image_rect.x = x;
2243 image_rect.y = y;
2244 image_rect.width = s->slice.width;
2245 image_rect.height = s->slice.height;
2246 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2247 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2248 s->slice.x + r.x - x, s->slice.y + r.y - y,
2249 r.width, r.height, r.x, r.y);
2251 /* When the image has a mask, we can expect that at
2252 least part of a mouse highlight or a block cursor will
2253 be visible. If the image doesn't have a mask, make
2254 a block cursor visible by drawing a rectangle around
2255 the image. I believe it's looking better if we do
2256 nothing here for mouse-face. */
2257 if (s->hl == DRAW_CURSOR)
2259 int r = s->img->relief;
2260 if (r < 0) r = -r;
2261 XDrawRectangle (s->display, s->window, s->gc,
2262 x - r, y - r,
2263 s->slice.width + r*2 - 1,
2264 s->slice.height + r*2 - 1);
2268 else
2269 /* Draw a rectangle if image could not be loaded. */
2270 XDrawRectangle (s->display, s->window, s->gc, x, y,
2271 s->slice.width - 1, s->slice.height - 1);
2275 /* Draw a relief around the image glyph string S. */
2277 static void
2278 x_draw_image_relief (s)
2279 struct glyph_string *s;
2281 int x0, y0, x1, y1, thick, raised_p;
2282 XRectangle r;
2283 int x = s->x;
2284 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2286 /* If first glyph of S has a left box line, start drawing it to the
2287 right of that line. */
2288 if (s->face->box != FACE_NO_BOX
2289 && s->first_glyph->left_box_line_p
2290 && s->slice.x == 0)
2291 x += eabs (s->face->box_line_width);
2293 /* If there is a margin around the image, adjust x- and y-position
2294 by that margin. */
2295 if (s->slice.x == 0)
2296 x += s->img->hmargin;
2297 if (s->slice.y == 0)
2298 y += s->img->vmargin;
2300 if (s->hl == DRAW_IMAGE_SUNKEN
2301 || s->hl == DRAW_IMAGE_RAISED)
2303 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2304 raised_p = s->hl == DRAW_IMAGE_RAISED;
2306 else
2308 thick = eabs (s->img->relief);
2309 raised_p = s->img->relief > 0;
2312 x0 = x - thick;
2313 y0 = y - thick;
2314 x1 = x + s->slice.width + thick - 1;
2315 y1 = y + s->slice.height + thick - 1;
2317 x_setup_relief_colors (s);
2318 get_glyph_string_clip_rect (s, &r);
2319 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2320 s->slice.y == 0,
2321 s->slice.y + s->slice.height == s->img->height,
2322 s->slice.x == 0,
2323 s->slice.x + s->slice.width == s->img->width,
2324 &r);
2328 /* Draw the foreground of image glyph string S to PIXMAP. */
2330 static void
2331 x_draw_image_foreground_1 (s, pixmap)
2332 struct glyph_string *s;
2333 Pixmap pixmap;
2335 int x = 0;
2336 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2338 /* If first glyph of S has a left box line, start drawing it to the
2339 right of that line. */
2340 if (s->face->box != FACE_NO_BOX
2341 && s->first_glyph->left_box_line_p
2342 && s->slice.x == 0)
2343 x += eabs (s->face->box_line_width);
2345 /* If there is a margin around the image, adjust x- and y-position
2346 by that margin. */
2347 if (s->slice.x == 0)
2348 x += s->img->hmargin;
2349 if (s->slice.y == 0)
2350 y += s->img->vmargin;
2352 if (s->img->pixmap)
2354 if (s->img->mask)
2356 /* We can't set both a clip mask and use XSetClipRectangles
2357 because the latter also sets a clip mask. We also can't
2358 trust on the shape extension to be available
2359 (XShapeCombineRegion). So, compute the rectangle to draw
2360 manually. */
2361 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2362 | GCFunction);
2363 XGCValues xgcv;
2365 xgcv.clip_mask = s->img->mask;
2366 xgcv.clip_x_origin = x - s->slice.x;
2367 xgcv.clip_y_origin = y - s->slice.y;
2368 xgcv.function = GXcopy;
2369 XChangeGC (s->display, s->gc, mask, &xgcv);
2371 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2372 s->slice.x, s->slice.y,
2373 s->slice.width, s->slice.height, x, y);
2374 XSetClipMask (s->display, s->gc, None);
2376 else
2378 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2379 s->slice.x, s->slice.y,
2380 s->slice.width, s->slice.height, x, y);
2382 /* When the image has a mask, we can expect that at
2383 least part of a mouse highlight or a block cursor will
2384 be visible. If the image doesn't have a mask, make
2385 a block cursor visible by drawing a rectangle around
2386 the image. I believe it's looking better if we do
2387 nothing here for mouse-face. */
2388 if (s->hl == DRAW_CURSOR)
2390 int r = s->img->relief;
2391 if (r < 0) r = -r;
2392 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2393 s->slice.width + r*2 - 1,
2394 s->slice.height + r*2 - 1);
2398 else
2399 /* Draw a rectangle if image could not be loaded. */
2400 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2401 s->slice.width - 1, s->slice.height - 1);
2405 /* Draw part of the background of glyph string S. X, Y, W, and H
2406 give the rectangle to draw. */
2408 static void
2409 x_draw_glyph_string_bg_rect (s, x, y, w, h)
2410 struct glyph_string *s;
2411 int x, y, w, h;
2413 if (s->stippled_p)
2415 /* Fill background with a stipple pattern. */
2416 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2417 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2418 XSetFillStyle (s->display, s->gc, FillSolid);
2420 else
2421 x_clear_glyph_string_rect (s, x, y, w, h);
2425 /* Draw image glyph string S.
2427 s->y
2428 s->x +-------------------------
2429 | s->face->box
2431 | +-------------------------
2432 | | s->img->margin
2434 | | +-------------------
2435 | | | the image
2439 static void
2440 x_draw_image_glyph_string (s)
2441 struct glyph_string *s;
2443 int box_line_hwidth = eabs (s->face->box_line_width);
2444 int box_line_vwidth = max (s->face->box_line_width, 0);
2445 int height;
2446 Pixmap pixmap = None;
2448 height = s->height;
2449 if (s->slice.y == 0)
2450 height -= box_line_vwidth;
2451 if (s->slice.y + s->slice.height >= s->img->height)
2452 height -= box_line_vwidth;
2454 /* Fill background with face under the image. Do it only if row is
2455 taller than image or if image has a clip mask to reduce
2456 flickering. */
2457 s->stippled_p = s->face->stipple != 0;
2458 if (height > s->slice.height
2459 || s->img->hmargin
2460 || s->img->vmargin
2461 || s->img->mask
2462 || s->img->pixmap == 0
2463 || s->width != s->background_width)
2465 if (s->img->mask)
2467 /* Create a pixmap as large as the glyph string. Fill it
2468 with the background color. Copy the image to it, using
2469 its mask. Copy the temporary pixmap to the display. */
2470 Screen *screen = FRAME_X_SCREEN (s->f);
2471 int depth = DefaultDepthOfScreen (screen);
2473 /* Create a pixmap as large as the glyph string. */
2474 pixmap = XCreatePixmap (s->display, s->window,
2475 s->background_width,
2476 s->height, depth);
2478 /* Don't clip in the following because we're working on the
2479 pixmap. */
2480 XSetClipMask (s->display, s->gc, None);
2482 /* Fill the pixmap with the background color/stipple. */
2483 if (s->stippled_p)
2485 /* Fill background with a stipple pattern. */
2486 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2487 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2488 XFillRectangle (s->display, pixmap, s->gc,
2489 0, 0, s->background_width, s->height);
2490 XSetFillStyle (s->display, s->gc, FillSolid);
2491 XSetTSOrigin (s->display, s->gc, 0, 0);
2493 else
2495 XGCValues xgcv;
2496 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2497 &xgcv);
2498 XSetForeground (s->display, s->gc, xgcv.background);
2499 XFillRectangle (s->display, pixmap, s->gc,
2500 0, 0, s->background_width, s->height);
2501 XSetForeground (s->display, s->gc, xgcv.foreground);
2504 else
2506 int x = s->x;
2507 int y = s->y;
2509 if (s->first_glyph->left_box_line_p
2510 && s->slice.x == 0)
2511 x += box_line_hwidth;
2513 if (s->slice.y == 0)
2514 y += box_line_vwidth;
2516 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2519 s->background_filled_p = 1;
2522 /* Draw the foreground. */
2523 if (pixmap != None)
2525 x_draw_image_foreground_1 (s, pixmap);
2526 x_set_glyph_string_clipping (s);
2527 XCopyArea (s->display, pixmap, s->window, s->gc,
2528 0, 0, s->background_width, s->height, s->x, s->y);
2529 XFreePixmap (s->display, pixmap);
2531 else
2532 x_draw_image_foreground (s);
2534 /* If we must draw a relief around the image, do it. */
2535 if (s->img->relief
2536 || s->hl == DRAW_IMAGE_RAISED
2537 || s->hl == DRAW_IMAGE_SUNKEN)
2538 x_draw_image_relief (s);
2542 /* Draw stretch glyph string S. */
2544 static void
2545 x_draw_stretch_glyph_string (s)
2546 struct glyph_string *s;
2548 xassert (s->first_glyph->type == STRETCH_GLYPH);
2550 if (s->hl == DRAW_CURSOR
2551 && !x_stretch_cursor_p)
2553 /* If `x-stretch-block-cursor' is nil, don't draw a block cursor
2554 as wide as the stretch glyph. */
2555 int width, background_width = s->background_width;
2556 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2558 if (x < left_x)
2560 background_width -= left_x - x;
2561 x = left_x;
2563 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2565 /* Draw cursor. */
2566 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2568 /* Clear rest using the GC of the original non-cursor face. */
2569 if (width < background_width)
2571 int y = s->y;
2572 int w = background_width - width, h = s->height;
2573 XRectangle r;
2574 GC gc;
2576 x += width;
2577 if (s->row->mouse_face_p
2578 && cursor_in_mouse_face_p (s->w))
2580 x_set_mouse_face_gc (s);
2581 gc = s->gc;
2583 else
2584 gc = s->face->gc;
2586 get_glyph_string_clip_rect (s, &r);
2587 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2589 if (s->face->stipple)
2591 /* Fill background with a stipple pattern. */
2592 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2593 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2594 XSetFillStyle (s->display, gc, FillSolid);
2596 else
2598 XGCValues xgcv;
2599 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2600 XSetForeground (s->display, gc, xgcv.background);
2601 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2602 XSetForeground (s->display, gc, xgcv.foreground);
2606 else if (!s->background_filled_p)
2608 int background_width = s->background_width;
2609 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2611 /* Don't draw into left margin, fringe or scrollbar area
2612 except for header line and mode line. */
2613 if (x < left_x && !s->row->mode_line_p)
2615 background_width -= left_x - x;
2616 x = left_x;
2618 if (background_width > 0)
2619 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2622 s->background_filled_p = 1;
2626 /* Draw glyph string S. */
2628 static void
2629 x_draw_glyph_string (s)
2630 struct glyph_string *s;
2632 int relief_drawn_p = 0;
2634 /* If S draws into the background of its successors, draw the
2635 background of the successors first so that S can draw into it.
2636 This makes S->next use XDrawString instead of XDrawImageString. */
2637 if (s->next && s->right_overhang && !s->for_overlaps)
2639 int width;
2640 struct glyph_string *next;
2642 for (width = 0, next = s->next;
2643 next && width < s->right_overhang;
2644 width += next->width, next = next->next)
2645 if (next->first_glyph->type != IMAGE_GLYPH)
2647 x_set_glyph_string_gc (next);
2648 x_set_glyph_string_clipping (next);
2649 if (next->first_glyph->type == STRETCH_GLYPH)
2650 x_draw_stretch_glyph_string (next);
2651 else
2652 x_draw_glyph_string_background (next, 1);
2653 next->num_clips = 0;
2657 /* Set up S->gc, set clipping and draw S. */
2658 x_set_glyph_string_gc (s);
2660 /* Draw relief (if any) in advance for char/composition so that the
2661 glyph string can be drawn over it. */
2662 if (!s->for_overlaps
2663 && s->face->box != FACE_NO_BOX
2664 && (s->first_glyph->type == CHAR_GLYPH
2665 || s->first_glyph->type == COMPOSITE_GLYPH))
2668 x_set_glyph_string_clipping (s);
2669 x_draw_glyph_string_background (s, 1);
2670 x_draw_glyph_string_box (s);
2671 x_set_glyph_string_clipping (s);
2672 relief_drawn_p = 1;
2674 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2675 && !s->clip_tail
2676 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2677 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2678 /* We must clip just this glyph. left_overhang part has already
2679 drawn when s->prev was drawn, and right_overhang part will be
2680 drawn later when s->next is drawn. */
2681 x_set_glyph_string_clipping_exactly (s, s);
2682 else
2683 x_set_glyph_string_clipping (s);
2685 switch (s->first_glyph->type)
2687 case IMAGE_GLYPH:
2688 x_draw_image_glyph_string (s);
2689 break;
2691 case STRETCH_GLYPH:
2692 x_draw_stretch_glyph_string (s);
2693 break;
2695 case CHAR_GLYPH:
2696 if (s->for_overlaps)
2697 s->background_filled_p = 1;
2698 else
2699 x_draw_glyph_string_background (s, 0);
2700 x_draw_glyph_string_foreground (s);
2701 break;
2703 case COMPOSITE_GLYPH:
2704 if (s->for_overlaps || (s->cmp_from > 0
2705 && ! s->first_glyph->u.cmp.automatic))
2706 s->background_filled_p = 1;
2707 else
2708 x_draw_glyph_string_background (s, 1);
2709 x_draw_composite_glyph_string_foreground (s);
2710 break;
2712 default:
2713 abort ();
2716 if (!s->for_overlaps)
2718 /* Draw underline. */
2719 if (s->face->underline_p)
2721 unsigned long thickness, position;
2722 int y;
2724 if (s->prev && s->prev->face->underline_p)
2726 /* We use the same underline style as the previous one. */
2727 thickness = s->prev->underline_thickness;
2728 position = s->prev->underline_position;
2730 else
2732 /* Get the underline thickness. Default is 1 pixel. */
2733 if (s->font && s->font->underline_thickness > 0)
2734 thickness = s->font->underline_thickness;
2735 else
2736 thickness = 1;
2737 if (x_underline_at_descent_line)
2738 position = (s->height - thickness) - (s->ybase - s->y);
2739 else
2741 /* Get the underline position. This is the recommended
2742 vertical offset in pixels from the baseline to the top of
2743 the underline. This is a signed value according to the
2744 specs, and its default is
2746 ROUND ((maximum descent) / 2), with
2747 ROUND(x) = floor (x + 0.5) */
2749 if (x_use_underline_position_properties
2750 && s->font && s->font->underline_position >= 0)
2751 position = s->font->underline_position;
2752 else if (s->font)
2753 position = (s->font->descent + 1) / 2;
2754 else
2755 position = underline_minimum_offset;
2757 position = max (position, underline_minimum_offset);
2759 /* Check the sanity of thickness and position. We should
2760 avoid drawing underline out of the current line area. */
2761 if (s->y + s->height <= s->ybase + position)
2762 position = (s->height - 1) - (s->ybase - s->y);
2763 if (s->y + s->height < s->ybase + position + thickness)
2764 thickness = (s->y + s->height) - (s->ybase + position);
2765 s->underline_thickness = thickness;
2766 s->underline_position = position;
2767 y = s->ybase + position;
2768 if (s->face->underline_defaulted_p)
2769 XFillRectangle (s->display, s->window, s->gc,
2770 s->x, y, s->width, thickness);
2771 else
2773 XGCValues xgcv;
2774 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2775 XSetForeground (s->display, s->gc, s->face->underline_color);
2776 XFillRectangle (s->display, s->window, s->gc,
2777 s->x, y, s->width, thickness);
2778 XSetForeground (s->display, s->gc, xgcv.foreground);
2782 /* Draw overline. */
2783 if (s->face->overline_p)
2785 unsigned long dy = 0, h = 1;
2787 if (s->face->overline_color_defaulted_p)
2788 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2789 s->width, h);
2790 else
2792 XGCValues xgcv;
2793 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2794 XSetForeground (s->display, s->gc, s->face->overline_color);
2795 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2796 s->width, h);
2797 XSetForeground (s->display, s->gc, xgcv.foreground);
2801 /* Draw strike-through. */
2802 if (s->face->strike_through_p)
2804 unsigned long h = 1;
2805 unsigned long dy = (s->height - h) / 2;
2807 if (s->face->strike_through_color_defaulted_p)
2808 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2809 s->width, h);
2810 else
2812 XGCValues xgcv;
2813 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2814 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2815 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2816 s->width, h);
2817 XSetForeground (s->display, s->gc, xgcv.foreground);
2821 /* Draw relief if not yet drawn. */
2822 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2823 x_draw_glyph_string_box (s);
2825 if (s->prev)
2827 struct glyph_string *prev;
2829 for (prev = s->prev; prev; prev = prev->prev)
2830 if (prev->hl != s->hl
2831 && prev->x + prev->width + prev->right_overhang > s->x)
2833 /* As prev was drawn while clipped to its own area, we
2834 must draw the right_overhang part using s->hl now. */
2835 enum draw_glyphs_face save = prev->hl;
2837 prev->hl = s->hl;
2838 x_set_glyph_string_gc (prev);
2839 x_set_glyph_string_clipping_exactly (s, prev);
2840 if (prev->first_glyph->type == CHAR_GLYPH)
2841 x_draw_glyph_string_foreground (prev);
2842 else
2843 x_draw_composite_glyph_string_foreground (prev);
2844 XSetClipMask (prev->display, prev->gc, None);
2845 prev->hl = save;
2846 prev->num_clips = 0;
2850 if (s->next)
2852 struct glyph_string *next;
2854 for (next = s->next; next; next = next->next)
2855 if (next->hl != s->hl
2856 && next->x - next->left_overhang < s->x + s->width)
2858 /* As next will be drawn while clipped to its own area,
2859 we must draw the left_overhang part using s->hl now. */
2860 enum draw_glyphs_face save = next->hl;
2862 next->hl = s->hl;
2863 x_set_glyph_string_gc (next);
2864 x_set_glyph_string_clipping_exactly (s, next);
2865 if (next->first_glyph->type == CHAR_GLYPH)
2866 x_draw_glyph_string_foreground (next);
2867 else
2868 x_draw_composite_glyph_string_foreground (next);
2869 XSetClipMask (next->display, next->gc, None);
2870 next->hl = save;
2871 next->num_clips = 0;
2876 /* Reset clipping. */
2877 XSetClipMask (s->display, s->gc, None);
2878 s->num_clips = 0;
2881 /* Shift display to make room for inserted glyphs. */
2883 void
2884 x_shift_glyphs_for_insert (f, x, y, width, height, shift_by)
2885 struct frame *f;
2886 int x, y, width, height, shift_by;
2888 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2889 f->output_data.x->normal_gc,
2890 x, y, width, height,
2891 x + shift_by, y);
2894 /* Delete N glyphs at the nominal cursor position. Not implemented
2895 for X frames. */
2897 static void
2898 x_delete_glyphs (f, n)
2899 struct frame *f;
2900 register int n;
2902 abort ();
2906 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2907 If they are <= 0, this is probably an error. */
2909 void
2910 x_clear_area (dpy, window, x, y, width, height, exposures)
2911 Display *dpy;
2912 Window window;
2913 int x, y;
2914 int width, height;
2915 int exposures;
2917 xassert (width > 0 && height > 0);
2918 XClearArea (dpy, window, x, y, width, height, exposures);
2922 /* Clear an entire frame. */
2924 static void
2925 x_clear_frame (struct frame *f)
2927 /* Clearing the frame will erase any cursor, so mark them all as no
2928 longer visible. */
2929 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2930 output_cursor.hpos = output_cursor.vpos = 0;
2931 output_cursor.x = -1;
2933 /* We don't set the output cursor here because there will always
2934 follow an explicit cursor_to. */
2935 BLOCK_INPUT;
2936 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
2938 /* We have to clear the scroll bars, too. If we have changed
2939 colors or something like that, then they should be notified. */
2940 x_scroll_bar_clear (f);
2942 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
2943 /* Make sure scroll bars are redrawn. As they aren't redrawn by
2944 redisplay, do it here. */
2945 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
2946 #endif
2948 XFlush (FRAME_X_DISPLAY (f));
2950 UNBLOCK_INPUT;
2955 /* Invert the middle quarter of the frame for .15 sec. */
2957 /* We use the select system call to do the waiting, so we have to make
2958 sure it's available. If it isn't, we just won't do visual bells. */
2960 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
2963 /* Subtract the `struct timeval' values X and Y, storing the result in
2964 *RESULT. Return 1 if the difference is negative, otherwise 0. */
2966 static int
2967 timeval_subtract (result, x, y)
2968 struct timeval *result, x, y;
2970 /* Perform the carry for the later subtraction by updating y. This
2971 is safer because on some systems the tv_sec member is unsigned. */
2972 if (x.tv_usec < y.tv_usec)
2974 int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
2975 y.tv_usec -= 1000000 * nsec;
2976 y.tv_sec += nsec;
2979 if (x.tv_usec - y.tv_usec > 1000000)
2981 int nsec = (y.tv_usec - x.tv_usec) / 1000000;
2982 y.tv_usec += 1000000 * nsec;
2983 y.tv_sec -= nsec;
2986 /* Compute the time remaining to wait. tv_usec is certainly
2987 positive. */
2988 result->tv_sec = x.tv_sec - y.tv_sec;
2989 result->tv_usec = x.tv_usec - y.tv_usec;
2991 /* Return indication of whether the result should be considered
2992 negative. */
2993 return x.tv_sec < y.tv_sec;
2996 void
2997 XTflash (f)
2998 struct frame *f;
3000 BLOCK_INPUT;
3003 #ifdef USE_GTK
3004 /* Use Gdk routines to draw. This way, we won't draw over scroll bars
3005 when the scroll bars and the edit widget share the same X window. */
3006 GdkGCValues vals;
3007 GdkGC *gc;
3008 vals.foreground.pixel = (FRAME_FOREGROUND_PIXEL (f)
3009 ^ FRAME_BACKGROUND_PIXEL (f));
3010 vals.function = GDK_XOR;
3011 gc = gdk_gc_new_with_values (FRAME_GTK_WIDGET (f)->window,
3012 &vals,
3013 GDK_GC_FUNCTION
3014 | GDK_GC_FOREGROUND);
3015 #define XFillRectangle(d, win, gc, x, y, w, h) \
3016 gdk_draw_rectangle (FRAME_GTK_WIDGET (f)->window, \
3017 gc, TRUE, x, y, w, h)
3018 #else
3019 GC gc;
3021 /* Create a GC that will use the GXxor function to flip foreground
3022 pixels into background pixels. */
3024 XGCValues values;
3026 values.function = GXxor;
3027 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3028 ^ FRAME_BACKGROUND_PIXEL (f));
3030 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3031 GCFunction | GCForeground, &values);
3033 #endif
3035 /* Get the height not including a menu bar widget. */
3036 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3037 /* Height of each line to flash. */
3038 int flash_height = FRAME_LINE_HEIGHT (f);
3039 /* These will be the left and right margins of the rectangles. */
3040 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3041 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3043 int width;
3045 /* Don't flash the area between a scroll bar and the frame
3046 edge it is next to. */
3047 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3049 case vertical_scroll_bar_left:
3050 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3051 break;
3053 case vertical_scroll_bar_right:
3054 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3055 break;
3057 default:
3058 break;
3061 width = flash_right - flash_left;
3063 /* If window is tall, flash top and bottom line. */
3064 if (height > 3 * FRAME_LINE_HEIGHT (f))
3066 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3067 flash_left,
3068 (FRAME_INTERNAL_BORDER_WIDTH (f)
3069 + FRAME_TOP_MARGIN_HEIGHT (f)),
3070 width, flash_height);
3071 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3072 flash_left,
3073 (height - flash_height
3074 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3075 width, flash_height);
3078 else
3079 /* If it is short, flash it all. */
3080 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3081 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3082 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3084 x_flush (f);
3087 struct timeval wakeup;
3089 EMACS_GET_TIME (wakeup);
3091 /* Compute time to wait until, propagating carry from usecs. */
3092 wakeup.tv_usec += 150000;
3093 wakeup.tv_sec += (wakeup.tv_usec / 1000000);
3094 wakeup.tv_usec %= 1000000;
3096 /* Keep waiting until past the time wakeup or any input gets
3097 available. */
3098 while (! detect_input_pending ())
3100 struct timeval current;
3101 struct timeval timeout;
3103 EMACS_GET_TIME (current);
3105 /* Break if result would be negative. */
3106 if (timeval_subtract (&current, wakeup, current))
3107 break;
3109 /* How long `select' should wait. */
3110 timeout.tv_sec = 0;
3111 timeout.tv_usec = 10000;
3113 /* Try to wait that long--but we might wake up sooner. */
3114 select (0, NULL, NULL, NULL, &timeout);
3118 /* If window is tall, flash top and bottom line. */
3119 if (height > 3 * FRAME_LINE_HEIGHT (f))
3121 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3122 flash_left,
3123 (FRAME_INTERNAL_BORDER_WIDTH (f)
3124 + FRAME_TOP_MARGIN_HEIGHT (f)),
3125 width, flash_height);
3126 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3127 flash_left,
3128 (height - flash_height
3129 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3130 width, flash_height);
3132 else
3133 /* If it is short, flash it all. */
3134 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3135 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3136 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3138 #ifdef USE_GTK
3139 g_object_unref (G_OBJECT (gc));
3140 #undef XFillRectangle
3141 #else
3142 XFreeGC (FRAME_X_DISPLAY (f), gc);
3143 #endif
3144 x_flush (f);
3148 UNBLOCK_INPUT;
3151 #endif /* defined (HAVE_TIMEVAL) && defined (HAVE_SELECT) */
3154 static void
3155 XTtoggle_invisible_pointer (f, invisible)
3156 FRAME_PTR f;
3157 int invisible;
3159 BLOCK_INPUT;
3160 if (invisible)
3162 if (FRAME_X_DISPLAY_INFO (f)->invisible_cursor != 0)
3163 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3164 FRAME_X_DISPLAY_INFO (f)->invisible_cursor);
3166 else
3167 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3168 f->output_data.x->current_cursor);
3169 f->pointer_invisible = invisible;
3170 UNBLOCK_INPUT;
3174 /* Make audible bell. */
3176 void
3177 XTring_bell ()
3179 struct frame *f = SELECTED_FRAME ();
3181 if (FRAME_X_DISPLAY (f))
3183 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
3184 if (visible_bell)
3185 XTflash (f);
3186 else
3187 #endif
3189 BLOCK_INPUT;
3190 XBell (FRAME_X_DISPLAY (f), 0);
3191 XFlush (FRAME_X_DISPLAY (f));
3192 UNBLOCK_INPUT;
3198 /* Specify how many text lines, from the top of the window,
3199 should be affected by insert-lines and delete-lines operations.
3200 This, and those operations, are used only within an update
3201 that is bounded by calls to x_update_begin and x_update_end. */
3203 static void
3204 XTset_terminal_window (n)
3205 register int n;
3207 /* This function intentionally left blank. */
3212 /***********************************************************************
3213 Line Dance
3214 ***********************************************************************/
3216 /* Perform an insert-lines or delete-lines operation, inserting N
3217 lines or deleting -N lines at vertical position VPOS. */
3219 static void
3220 x_ins_del_lines (f, vpos, n)
3221 struct frame *f;
3222 int vpos, n;
3224 abort ();
3228 /* Scroll part of the display as described by RUN. */
3230 static void
3231 x_scroll_run (w, run)
3232 struct window *w;
3233 struct run *run;
3235 struct frame *f = XFRAME (w->frame);
3236 int x, y, width, height, from_y, to_y, bottom_y;
3238 /* Get frame-relative bounding box of the text display area of W,
3239 without mode lines. Include in this box the left and right
3240 fringe of W. */
3241 window_box (w, -1, &x, &y, &width, &height);
3243 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3244 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3245 bottom_y = y + height;
3247 if (to_y < from_y)
3249 /* Scrolling up. Make sure we don't copy part of the mode
3250 line at the bottom. */
3251 if (from_y + run->height > bottom_y)
3252 height = bottom_y - from_y;
3253 else
3254 height = run->height;
3256 else
3258 /* Scolling down. Make sure we don't copy over the mode line.
3259 at the bottom. */
3260 if (to_y + run->height > bottom_y)
3261 height = bottom_y - to_y;
3262 else
3263 height = run->height;
3266 BLOCK_INPUT;
3268 /* Cursor off. Will be switched on again in x_update_window_end. */
3269 updated_window = w;
3270 x_clear_cursor (w);
3272 XCopyArea (FRAME_X_DISPLAY (f),
3273 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3274 f->output_data.x->normal_gc,
3275 x, from_y,
3276 width, height,
3277 x, to_y);
3279 UNBLOCK_INPUT;
3284 /***********************************************************************
3285 Exposure Events
3286 ***********************************************************************/
3289 static void
3290 frame_highlight (f)
3291 struct frame *f;
3293 /* We used to only do this if Vx_no_window_manager was non-nil, but
3294 the ICCCM (section 4.1.6) says that the window's border pixmap
3295 and border pixel are window attributes which are "private to the
3296 client", so we can always change it to whatever we want. */
3297 BLOCK_INPUT;
3298 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3299 f->output_data.x->border_pixel);
3300 UNBLOCK_INPUT;
3301 x_update_cursor (f, 1);
3302 x_set_frame_alpha (f);
3305 static void
3306 frame_unhighlight (f)
3307 struct frame *f;
3309 /* We used to only do this if Vx_no_window_manager was non-nil, but
3310 the ICCCM (section 4.1.6) says that the window's border pixmap
3311 and border pixel are window attributes which are "private to the
3312 client", so we can always change it to whatever we want. */
3313 BLOCK_INPUT;
3314 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3315 f->output_data.x->border_tile);
3316 UNBLOCK_INPUT;
3317 x_update_cursor (f, 1);
3318 x_set_frame_alpha (f);
3321 /* The focus has changed. Update the frames as necessary to reflect
3322 the new situation. Note that we can't change the selected frame
3323 here, because the Lisp code we are interrupting might become confused.
3324 Each event gets marked with the frame in which it occurred, so the
3325 Lisp code can tell when the switch took place by examining the events. */
3327 static void
3328 x_new_focus_frame (dpyinfo, frame)
3329 struct x_display_info *dpyinfo;
3330 struct frame *frame;
3332 struct frame *old_focus = dpyinfo->x_focus_frame;
3334 if (frame != dpyinfo->x_focus_frame)
3336 /* Set this before calling other routines, so that they see
3337 the correct value of x_focus_frame. */
3338 dpyinfo->x_focus_frame = frame;
3340 if (old_focus && old_focus->auto_lower)
3341 x_lower_frame (old_focus);
3343 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3344 pending_autoraise_frame = dpyinfo->x_focus_frame;
3345 else
3346 pending_autoraise_frame = 0;
3349 x_frame_rehighlight (dpyinfo);
3352 /* Handle FocusIn and FocusOut state changes for FRAME.
3353 If FRAME has focus and there exists more than one frame, puts
3354 a FOCUS_IN_EVENT into *BUFP. */
3356 static void
3357 x_focus_changed (type, state, dpyinfo, frame, bufp)
3358 int type;
3359 int state;
3360 struct x_display_info *dpyinfo;
3361 struct frame *frame;
3362 struct input_event *bufp;
3364 if (type == FocusIn)
3366 if (dpyinfo->x_focus_event_frame != frame)
3368 x_new_focus_frame (dpyinfo, frame);
3369 dpyinfo->x_focus_event_frame = frame;
3371 /* Don't stop displaying the initial startup message
3372 for a switch-frame event we don't need. */
3373 if (NILP (Vterminal_frame)
3374 && CONSP (Vframe_list)
3375 && !NILP (XCDR (Vframe_list)))
3377 bufp->kind = FOCUS_IN_EVENT;
3378 XSETFRAME (bufp->frame_or_window, frame);
3382 frame->output_data.x->focus_state |= state;
3384 #ifdef HAVE_X_I18N
3385 if (FRAME_XIC (frame))
3386 XSetICFocus (FRAME_XIC (frame));
3387 #endif
3389 else if (type == FocusOut)
3391 frame->output_data.x->focus_state &= ~state;
3393 if (dpyinfo->x_focus_event_frame == frame)
3395 dpyinfo->x_focus_event_frame = 0;
3396 x_new_focus_frame (dpyinfo, 0);
3399 #ifdef HAVE_X_I18N
3400 if (FRAME_XIC (frame))
3401 XUnsetICFocus (FRAME_XIC (frame));
3402 #endif
3403 if (frame->pointer_invisible)
3404 XTtoggle_invisible_pointer (frame, 0);
3408 /* The focus may have changed. Figure out if it is a real focus change,
3409 by checking both FocusIn/Out and Enter/LeaveNotify events.
3411 Returns FOCUS_IN_EVENT event in *BUFP. */
3413 static void
3414 x_detect_focus_change (dpyinfo, event, bufp)
3415 struct x_display_info *dpyinfo;
3416 XEvent *event;
3417 struct input_event *bufp;
3419 struct frame *frame;
3421 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3422 if (! frame)
3423 return;
3425 switch (event->type)
3427 case EnterNotify:
3428 case LeaveNotify:
3430 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3431 int focus_state
3432 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3434 if (event->xcrossing.detail != NotifyInferior
3435 && event->xcrossing.focus
3436 && ! (focus_state & FOCUS_EXPLICIT))
3437 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3438 FOCUS_IMPLICIT,
3439 dpyinfo, frame, bufp);
3441 break;
3443 case FocusIn:
3444 case FocusOut:
3445 x_focus_changed (event->type,
3446 (event->xfocus.detail == NotifyPointer ?
3447 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3448 dpyinfo, frame, bufp);
3449 break;
3451 case ClientMessage:
3452 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3454 enum xembed_message msg = event->xclient.data.l[1];
3455 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3456 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3458 break;
3463 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3465 void
3466 x_mouse_leave (dpyinfo)
3467 struct x_display_info *dpyinfo;
3469 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3472 /* The focus has changed, or we have redirected a frame's focus to
3473 another frame (this happens when a frame uses a surrogate
3474 mini-buffer frame). Shift the highlight as appropriate.
3476 The FRAME argument doesn't necessarily have anything to do with which
3477 frame is being highlighted or un-highlighted; we only use it to find
3478 the appropriate X display info. */
3480 static void
3481 XTframe_rehighlight (frame)
3482 struct frame *frame;
3484 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3487 static void
3488 x_frame_rehighlight (dpyinfo)
3489 struct x_display_info *dpyinfo;
3491 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3493 if (dpyinfo->x_focus_frame)
3495 dpyinfo->x_highlight_frame
3496 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3497 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3498 : dpyinfo->x_focus_frame);
3499 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3501 FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
3502 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3505 else
3506 dpyinfo->x_highlight_frame = 0;
3508 if (dpyinfo->x_highlight_frame != old_highlight)
3510 if (old_highlight)
3511 frame_unhighlight (old_highlight);
3512 if (dpyinfo->x_highlight_frame)
3513 frame_highlight (dpyinfo->x_highlight_frame);
3519 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3521 /* Initialize mode_switch_bit and modifier_meaning. */
3522 static void
3523 x_find_modifier_meanings (dpyinfo)
3524 struct x_display_info *dpyinfo;
3526 int min_code, max_code;
3527 KeySym *syms;
3528 int syms_per_code;
3529 XModifierKeymap *mods;
3531 dpyinfo->meta_mod_mask = 0;
3532 dpyinfo->shift_lock_mask = 0;
3533 dpyinfo->alt_mod_mask = 0;
3534 dpyinfo->super_mod_mask = 0;
3535 dpyinfo->hyper_mod_mask = 0;
3537 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3539 syms = XGetKeyboardMapping (dpyinfo->display,
3540 min_code, max_code - min_code + 1,
3541 &syms_per_code);
3542 mods = XGetModifierMapping (dpyinfo->display);
3544 /* Scan the modifier table to see which modifier bits the Meta and
3545 Alt keysyms are on. */
3547 int row, col; /* The row and column in the modifier table. */
3548 int found_alt_or_meta;
3550 for (row = 3; row < 8; row++)
3552 found_alt_or_meta = 0;
3553 for (col = 0; col < mods->max_keypermod; col++)
3555 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3557 /* Zeroes are used for filler. Skip them. */
3558 if (code == 0)
3559 continue;
3561 /* Are any of this keycode's keysyms a meta key? */
3563 int code_col;
3565 for (code_col = 0; code_col < syms_per_code; code_col++)
3567 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3569 switch (sym)
3571 case XK_Meta_L:
3572 case XK_Meta_R:
3573 found_alt_or_meta = 1;
3574 dpyinfo->meta_mod_mask |= (1 << row);
3575 break;
3577 case XK_Alt_L:
3578 case XK_Alt_R:
3579 found_alt_or_meta = 1;
3580 dpyinfo->alt_mod_mask |= (1 << row);
3581 break;
3583 case XK_Hyper_L:
3584 case XK_Hyper_R:
3585 if (!found_alt_or_meta)
3586 dpyinfo->hyper_mod_mask |= (1 << row);
3587 code_col = syms_per_code;
3588 col = mods->max_keypermod;
3589 break;
3591 case XK_Super_L:
3592 case XK_Super_R:
3593 if (!found_alt_or_meta)
3594 dpyinfo->super_mod_mask |= (1 << row);
3595 code_col = syms_per_code;
3596 col = mods->max_keypermod;
3597 break;
3599 case XK_Shift_Lock:
3600 /* Ignore this if it's not on the lock modifier. */
3601 if (!found_alt_or_meta && ((1 << row) == LockMask))
3602 dpyinfo->shift_lock_mask = LockMask;
3603 code_col = syms_per_code;
3604 col = mods->max_keypermod;
3605 break;
3613 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3614 if (! dpyinfo->meta_mod_mask)
3616 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3617 dpyinfo->alt_mod_mask = 0;
3620 /* If some keys are both alt and meta,
3621 make them just meta, not alt. */
3622 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3624 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3627 XFree ((char *) syms);
3628 XFreeModifiermap (mods);
3631 /* Convert between the modifier bits X uses and the modifier bits
3632 Emacs uses. */
3634 unsigned int
3635 x_x_to_emacs_modifiers (dpyinfo, state)
3636 struct x_display_info *dpyinfo;
3637 unsigned int state;
3639 EMACS_UINT mod_meta = meta_modifier;
3640 EMACS_UINT mod_alt = alt_modifier;
3641 EMACS_UINT mod_hyper = hyper_modifier;
3642 EMACS_UINT mod_super = super_modifier;
3643 Lisp_Object tem;
3645 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3646 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3647 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3648 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3649 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3650 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3651 tem = Fget (Vx_super_keysym, Qmodifier_value);
3652 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3655 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3656 | ((state & ControlMask) ? ctrl_modifier : 0)
3657 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3658 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3659 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3660 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3663 static unsigned int
3664 x_emacs_to_x_modifiers (dpyinfo, state)
3665 struct x_display_info *dpyinfo;
3666 unsigned int state;
3668 EMACS_UINT mod_meta = meta_modifier;
3669 EMACS_UINT mod_alt = alt_modifier;
3670 EMACS_UINT mod_hyper = hyper_modifier;
3671 EMACS_UINT mod_super = super_modifier;
3673 Lisp_Object tem;
3675 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3676 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3677 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3678 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3679 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3680 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3681 tem = Fget (Vx_super_keysym, Qmodifier_value);
3682 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3685 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3686 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3687 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3688 | ((state & shift_modifier) ? ShiftMask : 0)
3689 | ((state & ctrl_modifier) ? ControlMask : 0)
3690 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3693 /* Convert a keysym to its name. */
3695 char *
3696 x_get_keysym_name (keysym)
3697 KeySym keysym;
3699 char *value;
3701 BLOCK_INPUT;
3702 value = XKeysymToString (keysym);
3703 UNBLOCK_INPUT;
3705 return value;
3710 /* Mouse clicks and mouse movement. Rah. */
3712 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3714 If the event is a button press, then note that we have grabbed
3715 the mouse. */
3717 static Lisp_Object
3718 construct_mouse_click (result, event, f)
3719 struct input_event *result;
3720 XButtonEvent *event;
3721 struct frame *f;
3723 /* Make the event type NO_EVENT; we'll change that when we decide
3724 otherwise. */
3725 result->kind = MOUSE_CLICK_EVENT;
3726 result->code = event->button - Button1;
3727 result->timestamp = event->time;
3728 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3729 event->state)
3730 | (event->type == ButtonRelease
3731 ? up_modifier
3732 : down_modifier));
3734 XSETINT (result->x, event->x);
3735 XSETINT (result->y, event->y);
3736 XSETFRAME (result->frame_or_window, f);
3737 result->arg = Qnil;
3738 return Qnil;
3742 /* Function to report a mouse movement to the mainstream Emacs code.
3743 The input handler calls this.
3745 We have received a mouse movement event, which is given in *event.
3746 If the mouse is over a different glyph than it was last time, tell
3747 the mainstream emacs code by setting mouse_moved. If not, ask for
3748 another motion event, so we can check again the next time it moves. */
3750 static XMotionEvent last_mouse_motion_event;
3751 static Lisp_Object last_mouse_motion_frame;
3753 static int
3754 note_mouse_movement (frame, event)
3755 FRAME_PTR frame;
3756 XMotionEvent *event;
3758 last_mouse_movement_time = event->time;
3759 last_mouse_motion_event = *event;
3760 XSETFRAME (last_mouse_motion_frame, frame);
3762 if (!FRAME_X_OUTPUT (frame))
3763 return 0;
3765 if (event->window != FRAME_X_WINDOW (frame))
3767 frame->mouse_moved = 1;
3768 last_mouse_scroll_bar = Qnil;
3769 note_mouse_highlight (frame, -1, -1);
3770 last_mouse_glyph_frame = 0;
3771 return 1;
3775 /* Has the mouse moved off the glyph it was on at the last sighting? */
3776 if (frame != last_mouse_glyph_frame
3777 || event->x < last_mouse_glyph.x
3778 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3779 || event->y < last_mouse_glyph.y
3780 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3782 frame->mouse_moved = 1;
3783 last_mouse_scroll_bar = Qnil;
3784 note_mouse_highlight (frame, event->x, event->y);
3785 /* Remember which glyph we're now on. */
3786 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3787 last_mouse_glyph_frame = frame;
3788 return 1;
3791 return 0;
3795 /************************************************************************
3796 Mouse Face
3797 ************************************************************************/
3799 static void
3800 redo_mouse_highlight ()
3802 if (!NILP (last_mouse_motion_frame)
3803 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3804 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3805 last_mouse_motion_event.x,
3806 last_mouse_motion_event.y);
3811 /* Return the current position of the mouse.
3812 *FP should be a frame which indicates which display to ask about.
3814 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3815 and *PART to the frame, window, and scroll bar part that the mouse
3816 is over. Set *X and *Y to the portion and whole of the mouse's
3817 position on the scroll bar.
3819 If the mouse movement started elsewhere, set *FP to the frame the
3820 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3821 the mouse is over.
3823 Set *TIME to the server time-stamp for the time at which the mouse
3824 was at this position.
3826 Don't store anything if we don't have a valid set of values to report.
3828 This clears the mouse_moved flag, so we can wait for the next mouse
3829 movement. */
3831 static void
3832 XTmouse_position (fp, insist, bar_window, part, x, y, time)
3833 FRAME_PTR *fp;
3834 int insist;
3835 Lisp_Object *bar_window;
3836 enum scroll_bar_part *part;
3837 Lisp_Object *x, *y;
3838 unsigned long *time;
3840 FRAME_PTR f1;
3842 BLOCK_INPUT;
3844 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3845 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time);
3846 else
3848 Window root;
3849 int root_x, root_y;
3851 Window dummy_window;
3852 int dummy;
3854 Lisp_Object frame, tail;
3856 /* Clear the mouse-moved flag for every frame on this display. */
3857 FOR_EACH_FRAME (tail, frame)
3858 if (FRAME_X_P (XFRAME (frame))
3859 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3860 XFRAME (frame)->mouse_moved = 0;
3862 last_mouse_scroll_bar = Qnil;
3864 /* Figure out which root window we're on. */
3865 XQueryPointer (FRAME_X_DISPLAY (*fp),
3866 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3868 /* The root window which contains the pointer. */
3869 &root,
3871 /* Trash which we can't trust if the pointer is on
3872 a different screen. */
3873 &dummy_window,
3875 /* The position on that root window. */
3876 &root_x, &root_y,
3878 /* More trash we can't trust. */
3879 &dummy, &dummy,
3881 /* Modifier keys and pointer buttons, about which
3882 we don't care. */
3883 (unsigned int *) &dummy);
3885 /* Now we have a position on the root; find the innermost window
3886 containing the pointer. */
3888 Window win, child;
3889 int win_x, win_y;
3890 int parent_x = 0, parent_y = 0;
3892 win = root;
3894 /* XTranslateCoordinates can get errors if the window
3895 structure is changing at the same time this function
3896 is running. So at least we must not crash from them. */
3898 x_catch_errors (FRAME_X_DISPLAY (*fp));
3900 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3901 && FRAME_LIVE_P (last_mouse_frame))
3903 /* If mouse was grabbed on a frame, give coords for that frame
3904 even if the mouse is now outside it. */
3905 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3907 /* From-window, to-window. */
3908 root, FRAME_X_WINDOW (last_mouse_frame),
3910 /* From-position, to-position. */
3911 root_x, root_y, &win_x, &win_y,
3913 /* Child of win. */
3914 &child);
3915 f1 = last_mouse_frame;
3917 else
3919 while (1)
3921 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3923 /* From-window, to-window. */
3924 root, win,
3926 /* From-position, to-position. */
3927 root_x, root_y, &win_x, &win_y,
3929 /* Child of win. */
3930 &child);
3932 if (child == None || child == win)
3933 break;
3934 #ifdef USE_GTK
3935 /* We don't wan't to know the innermost window. We
3936 want the edit window. For non-Gtk+ the innermost
3937 window is the edit window. For Gtk+ it might not
3938 be. It might be the tool bar for example. */
3939 if (x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win))
3940 break;
3941 #endif
3942 win = child;
3943 parent_x = win_x;
3944 parent_y = win_y;
3947 /* Now we know that:
3948 win is the innermost window containing the pointer
3949 (XTC says it has no child containing the pointer),
3950 win_x and win_y are the pointer's position in it
3951 (XTC did this the last time through), and
3952 parent_x and parent_y are the pointer's position in win's parent.
3953 (They are what win_x and win_y were when win was child.
3954 If win is the root window, it has no parent, and
3955 parent_{x,y} are invalid, but that's okay, because we'll
3956 never use them in that case.) */
3958 #ifdef USE_GTK
3959 /* We don't wan't to know the innermost window. We
3960 want the edit window. */
3961 f1 = x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3962 #else
3963 /* Is win one of our frames? */
3964 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3965 #endif
3967 #ifdef USE_X_TOOLKIT
3968 /* If we end up with the menu bar window, say it's not
3969 on the frame. */
3970 if (f1 != NULL
3971 && f1->output_data.x->menubar_widget
3972 && win == XtWindow (f1->output_data.x->menubar_widget))
3973 f1 = NULL;
3974 #endif /* USE_X_TOOLKIT */
3977 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
3978 f1 = 0;
3980 x_uncatch_errors ();
3982 /* If not, is it one of our scroll bars? */
3983 if (! f1)
3985 struct scroll_bar *bar;
3987 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
3989 if (bar)
3991 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3992 win_x = parent_x;
3993 win_y = parent_y;
3997 if (f1 == 0 && insist > 0)
3998 f1 = SELECTED_FRAME ();
4000 if (f1)
4002 /* Ok, we found a frame. Store all the values.
4003 last_mouse_glyph is a rectangle used to reduce the
4004 generation of mouse events. To not miss any motion
4005 events, we must divide the frame into rectangles of the
4006 size of the smallest character that could be displayed
4007 on it, i.e. into the same rectangles that matrices on
4008 the frame are divided into. */
4010 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
4011 last_mouse_glyph_frame = f1;
4013 *bar_window = Qnil;
4014 *part = 0;
4015 *fp = f1;
4016 XSETINT (*x, win_x);
4017 XSETINT (*y, win_y);
4018 *time = last_mouse_movement_time;
4023 UNBLOCK_INPUT;
4028 /***********************************************************************
4029 Scroll bars
4030 ***********************************************************************/
4032 /* Scroll bar support. */
4034 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
4035 manages it.
4036 This can be called in GC, so we have to make sure to strip off mark
4037 bits. */
4039 static struct scroll_bar *
4040 x_window_to_scroll_bar (display, window_id)
4041 Display *display;
4042 Window window_id;
4044 Lisp_Object tail;
4046 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
4047 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
4048 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
4050 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4052 Lisp_Object frame, bar, condemned;
4054 frame = XCAR (tail);
4055 /* All elements of Vframe_list should be frames. */
4056 if (! FRAMEP (frame))
4057 abort ();
4059 if (! FRAME_X_P (XFRAME (frame)))
4060 continue;
4062 /* Scan this frame's scroll bar list for a scroll bar with the
4063 right window ID. */
4064 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4065 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4066 /* This trick allows us to search both the ordinary and
4067 condemned scroll bar lists with one loop. */
4068 ! NILP (bar) || (bar = condemned,
4069 condemned = Qnil,
4070 ! NILP (bar));
4071 bar = XSCROLL_BAR (bar)->next)
4072 if (XSCROLL_BAR (bar)->x_window == window_id &&
4073 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4074 return XSCROLL_BAR (bar);
4077 return 0;
4081 #if defined USE_LUCID
4083 /* Return the Lucid menu bar WINDOW is part of. Return null
4084 if WINDOW is not part of a menu bar. */
4086 static Widget
4087 x_window_to_menu_bar (window)
4088 Window window;
4090 Lisp_Object tail;
4092 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4094 if (FRAME_X_P (XFRAME (XCAR (tail))))
4096 Lisp_Object frame = XCAR (tail);
4097 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4099 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4100 return menu_bar;
4104 return NULL;
4107 #endif /* USE_LUCID */
4110 /************************************************************************
4111 Toolkit scroll bars
4112 ************************************************************************/
4114 #ifdef USE_TOOLKIT_SCROLL_BARS
4116 static void x_scroll_bar_to_input_event P_ ((XEvent *, struct input_event *));
4117 static void x_send_scroll_bar_event P_ ((Lisp_Object, int, int, int));
4118 static void x_create_toolkit_scroll_bar P_ ((struct frame *,
4119 struct scroll_bar *));
4120 static void x_set_toolkit_scroll_bar_thumb P_ ((struct scroll_bar *,
4121 int, int, int));
4124 /* Lisp window being scrolled. Set when starting to interact with
4125 a toolkit scroll bar, reset to nil when ending the interaction. */
4127 static Lisp_Object window_being_scrolled;
4129 /* Last scroll bar part sent in xm_scroll_callback. */
4131 static int last_scroll_bar_part;
4133 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4134 that movements of 1/20 of the screen size are mapped to up/down. */
4136 #ifndef USE_GTK
4137 /* Id of action hook installed for scroll bars. */
4139 static XtActionHookId action_hook_id;
4141 static Boolean xaw3d_arrow_scroll;
4143 /* Whether the drag scrolling maintains the mouse at the top of the
4144 thumb. If not, resizing the thumb needs to be done more carefully
4145 to avoid jerkyness. */
4147 static Boolean xaw3d_pick_top;
4149 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4150 bars are used.. The hook is responsible for detecting when
4151 the user ends an interaction with the scroll bar, and generates
4152 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4154 static void
4155 xt_action_hook (widget, client_data, action_name, event, params,
4156 num_params)
4157 Widget widget;
4158 XtPointer client_data;
4159 String action_name;
4160 XEvent *event;
4161 String *params;
4162 Cardinal *num_params;
4164 int scroll_bar_p;
4165 char *end_action;
4167 #ifdef USE_MOTIF
4168 scroll_bar_p = XmIsScrollBar (widget);
4169 end_action = "Release";
4170 #else /* !USE_MOTIF i.e. use Xaw */
4171 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4172 end_action = "EndScroll";
4173 #endif /* USE_MOTIF */
4175 if (scroll_bar_p
4176 && strcmp (action_name, end_action) == 0
4177 && WINDOWP (window_being_scrolled))
4179 struct window *w;
4181 x_send_scroll_bar_event (window_being_scrolled,
4182 scroll_bar_end_scroll, 0, 0);
4183 w = XWINDOW (window_being_scrolled);
4185 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4187 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4188 /* The thumb size is incorrect while dragging: fix it. */
4189 set_vertical_scroll_bar (w);
4191 window_being_scrolled = Qnil;
4192 last_scroll_bar_part = -1;
4194 /* Xt timeouts no longer needed. */
4195 toolkit_scroll_bar_interaction = 0;
4198 #endif /* not USE_GTK */
4200 /* A vector of windows used for communication between
4201 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4203 static struct window **scroll_bar_windows;
4204 static int scroll_bar_windows_size;
4207 /* Send a client message with message type Xatom_Scrollbar for a
4208 scroll action to the frame of WINDOW. PART is a value identifying
4209 the part of the scroll bar that was clicked on. PORTION is the
4210 amount to scroll of a whole of WHOLE. */
4212 static void
4213 x_send_scroll_bar_event (window, part, portion, whole)
4214 Lisp_Object window;
4215 int part, portion, whole;
4217 XEvent event;
4218 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4219 struct window *w = XWINDOW (window);
4220 struct frame *f = XFRAME (w->frame);
4221 int i;
4223 BLOCK_INPUT;
4225 /* Construct a ClientMessage event to send to the frame. */
4226 ev->type = ClientMessage;
4227 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4228 ev->display = FRAME_X_DISPLAY (f);
4229 ev->window = FRAME_X_WINDOW (f);
4230 ev->format = 32;
4232 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4233 not enough to store a pointer or Lisp_Object on a 64 bit system.
4234 So, store the window in scroll_bar_windows and pass the index
4235 into that array in the event. */
4236 for (i = 0; i < scroll_bar_windows_size; ++i)
4237 if (scroll_bar_windows[i] == NULL)
4238 break;
4240 if (i == scroll_bar_windows_size)
4242 int new_size = max (10, 2 * scroll_bar_windows_size);
4243 size_t nbytes = new_size * sizeof *scroll_bar_windows;
4244 size_t old_nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4246 scroll_bar_windows = (struct window **) xrealloc (scroll_bar_windows,
4247 nbytes);
4248 bzero (&scroll_bar_windows[i], nbytes - old_nbytes);
4249 scroll_bar_windows_size = new_size;
4252 scroll_bar_windows[i] = w;
4253 ev->data.l[0] = (long) i;
4254 ev->data.l[1] = (long) part;
4255 ev->data.l[2] = (long) 0;
4256 ev->data.l[3] = (long) portion;
4257 ev->data.l[4] = (long) whole;
4259 /* Make Xt timeouts work while the scroll bar is active. */
4260 toolkit_scroll_bar_interaction = 1;
4261 #ifdef USE_X_TOOLKIT
4262 x_activate_timeout_atimer ();
4263 #endif
4265 /* Setting the event mask to zero means that the message will
4266 be sent to the client that created the window, and if that
4267 window no longer exists, no event will be sent. */
4268 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4269 UNBLOCK_INPUT;
4273 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4274 in *IEVENT. */
4276 static void
4277 x_scroll_bar_to_input_event (event, ievent)
4278 XEvent *event;
4279 struct input_event *ievent;
4281 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4282 Lisp_Object window;
4283 struct frame *f;
4284 struct window *w;
4286 w = scroll_bar_windows[ev->data.l[0]];
4287 scroll_bar_windows[ev->data.l[0]] = NULL;
4289 XSETWINDOW (window, w);
4290 f = XFRAME (w->frame);
4292 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4293 ievent->frame_or_window = window;
4294 ievent->arg = Qnil;
4295 #ifdef USE_GTK
4296 ievent->timestamp = CurrentTime;
4297 #else
4298 ievent->timestamp = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
4299 #endif
4300 ievent->part = ev->data.l[1];
4301 ievent->code = ev->data.l[2];
4302 ievent->x = make_number ((int) ev->data.l[3]);
4303 ievent->y = make_number ((int) ev->data.l[4]);
4304 ievent->modifiers = 0;
4308 #ifdef USE_MOTIF
4310 /* Minimum and maximum values used for Motif scroll bars. */
4312 #define XM_SB_MAX 10000000
4315 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4316 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4317 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4319 static void
4320 xm_scroll_callback (widget, client_data, call_data)
4321 Widget widget;
4322 XtPointer client_data, call_data;
4324 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4325 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4326 int part = -1, whole = 0, portion = 0;
4328 switch (cs->reason)
4330 case XmCR_DECREMENT:
4331 bar->dragging = Qnil;
4332 part = scroll_bar_up_arrow;
4333 break;
4335 case XmCR_INCREMENT:
4336 bar->dragging = Qnil;
4337 part = scroll_bar_down_arrow;
4338 break;
4340 case XmCR_PAGE_DECREMENT:
4341 bar->dragging = Qnil;
4342 part = scroll_bar_above_handle;
4343 break;
4345 case XmCR_PAGE_INCREMENT:
4346 bar->dragging = Qnil;
4347 part = scroll_bar_below_handle;
4348 break;
4350 case XmCR_TO_TOP:
4351 bar->dragging = Qnil;
4352 part = scroll_bar_to_top;
4353 break;
4355 case XmCR_TO_BOTTOM:
4356 bar->dragging = Qnil;
4357 part = scroll_bar_to_bottom;
4358 break;
4360 case XmCR_DRAG:
4362 int slider_size;
4364 /* Get the slider size. */
4365 BLOCK_INPUT;
4366 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4367 UNBLOCK_INPUT;
4369 whole = XM_SB_MAX - slider_size;
4370 portion = min (cs->value, whole);
4371 part = scroll_bar_handle;
4372 bar->dragging = make_number (cs->value);
4374 break;
4376 case XmCR_VALUE_CHANGED:
4377 break;
4380 if (part >= 0)
4382 window_being_scrolled = bar->window;
4383 last_scroll_bar_part = part;
4384 x_send_scroll_bar_event (bar->window, part, portion, whole);
4388 #elif defined USE_GTK
4390 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4391 bar widget. DATA is a pointer to the scroll_bar structure. */
4393 static gboolean
4394 xg_scroll_callback (GtkRange *range,
4395 GtkScrollType scroll,
4396 gdouble value,
4397 gpointer user_data)
4399 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4400 gdouble position;
4401 int part = -1, whole = 0, portion = 0;
4402 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (range));
4403 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (range), XG_FRAME_DATA);
4405 if (xg_ignore_gtk_scrollbar) return FALSE;
4406 position = gtk_adjustment_get_value (adj);
4409 switch (scroll)
4411 case GTK_SCROLL_JUMP:
4412 /* Buttons 1 2 or 3 must be grabbed. */
4413 if (FRAME_X_DISPLAY_INFO (f)->grabbed != 0
4414 && FRAME_X_DISPLAY_INFO (f)->grabbed < (1 << 4))
4416 part = scroll_bar_handle;
4417 whole = adj->upper - adj->page_size;
4418 portion = min ((int)position, whole);
4419 bar->dragging = make_number ((int)portion);
4421 break;
4422 case GTK_SCROLL_STEP_BACKWARD:
4423 part = scroll_bar_up_arrow;
4424 bar->dragging = Qnil;
4425 break;
4426 case GTK_SCROLL_STEP_FORWARD:
4427 part = scroll_bar_down_arrow;
4428 bar->dragging = Qnil;
4429 break;
4430 case GTK_SCROLL_PAGE_BACKWARD:
4431 part = scroll_bar_above_handle;
4432 bar->dragging = Qnil;
4433 break;
4434 case GTK_SCROLL_PAGE_FORWARD:
4435 part = scroll_bar_below_handle;
4436 bar->dragging = Qnil;
4437 break;
4440 if (part >= 0)
4442 window_being_scrolled = bar->window;
4443 last_scroll_bar_part = part;
4444 x_send_scroll_bar_event (bar->window, part, portion, whole);
4447 return FALSE;
4450 /* Callback for button release. Sets dragging to Qnil when dragging is done. */
4452 static gboolean
4453 xg_end_scroll_callback (GtkWidget *widget,
4454 GdkEventButton *event,
4455 gpointer user_data)
4457 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4458 bar->dragging = Qnil;
4459 if (WINDOWP (window_being_scrolled))
4461 x_send_scroll_bar_event (window_being_scrolled,
4462 scroll_bar_end_scroll, 0, 0);
4463 window_being_scrolled = Qnil;
4466 return FALSE;
4470 #else /* not USE_GTK and not USE_MOTIF */
4472 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4473 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4474 scroll bar struct. CALL_DATA is a pointer to a float saying where
4475 the thumb is. */
4477 static void
4478 xaw_jump_callback (widget, client_data, call_data)
4479 Widget widget;
4480 XtPointer client_data, call_data;
4482 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4483 float top = *(float *) call_data;
4484 float shown;
4485 int whole, portion, height;
4486 int part;
4488 /* Get the size of the thumb, a value between 0 and 1. */
4489 BLOCK_INPUT;
4490 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4491 UNBLOCK_INPUT;
4493 whole = 10000000;
4494 portion = shown < 1 ? top * whole : 0;
4496 if (shown < 1 && (eabs (top + shown - 1) < 1.0/height))
4497 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4498 the bottom, so we force the scrolling whenever we see that we're
4499 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4500 we try to ensure that we always stay two pixels away from the
4501 bottom). */
4502 part = scroll_bar_down_arrow;
4503 else
4504 part = scroll_bar_handle;
4506 window_being_scrolled = bar->window;
4507 bar->dragging = make_number (portion);
4508 last_scroll_bar_part = part;
4509 x_send_scroll_bar_event (bar->window, part, portion, whole);
4513 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4514 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4515 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4516 the scroll bar. CALL_DATA is an integer specifying the action that
4517 has taken place. Its magnitude is in the range 0..height of the
4518 scroll bar. Negative values mean scroll towards buffer start.
4519 Values < height of scroll bar mean line-wise movement. */
4521 static void
4522 xaw_scroll_callback (widget, client_data, call_data)
4523 Widget widget;
4524 XtPointer client_data, call_data;
4526 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4527 /* The position really is stored cast to a pointer. */
4528 int position = (long) call_data;
4529 Dimension height;
4530 int part;
4532 /* Get the height of the scroll bar. */
4533 BLOCK_INPUT;
4534 XtVaGetValues (widget, XtNheight, &height, NULL);
4535 UNBLOCK_INPUT;
4537 if (eabs (position) >= height)
4538 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4540 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4541 it maps line-movement to call_data = max(5, height/20). */
4542 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4543 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4544 else
4545 part = scroll_bar_move_ratio;
4547 window_being_scrolled = bar->window;
4548 bar->dragging = Qnil;
4549 last_scroll_bar_part = part;
4550 x_send_scroll_bar_event (bar->window, part, position, height);
4553 #endif /* not USE_GTK and not USE_MOTIF */
4555 #define SCROLL_BAR_NAME "verticalScrollBar"
4557 /* Create the widget for scroll bar BAR on frame F. Record the widget
4558 and X window of the scroll bar in BAR. */
4560 #ifdef USE_GTK
4561 static void
4562 x_create_toolkit_scroll_bar (f, bar)
4563 struct frame *f;
4564 struct scroll_bar *bar;
4566 char *scroll_bar_name = SCROLL_BAR_NAME;
4568 BLOCK_INPUT;
4569 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4570 G_CALLBACK (xg_end_scroll_callback),
4571 scroll_bar_name);
4572 UNBLOCK_INPUT;
4575 #else /* not USE_GTK */
4577 static void
4578 x_create_toolkit_scroll_bar (f, bar)
4579 struct frame *f;
4580 struct scroll_bar *bar;
4582 Window xwindow;
4583 Widget widget;
4584 Arg av[20];
4585 int ac = 0;
4586 char *scroll_bar_name = SCROLL_BAR_NAME;
4587 unsigned long pixel;
4589 BLOCK_INPUT;
4591 #ifdef USE_MOTIF
4592 /* Set resources. Create the widget. */
4593 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4594 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4595 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4596 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4597 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4598 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4599 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4601 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4602 if (pixel != -1)
4604 XtSetArg (av[ac], XmNforeground, pixel);
4605 ++ac;
4608 pixel = f->output_data.x->scroll_bar_background_pixel;
4609 if (pixel != -1)
4611 XtSetArg (av[ac], XmNbackground, pixel);
4612 ++ac;
4615 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4616 scroll_bar_name, av, ac);
4618 /* Add one callback for everything that can happen. */
4619 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4620 (XtPointer) bar);
4621 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4622 (XtPointer) bar);
4623 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4624 (XtPointer) bar);
4625 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4626 (XtPointer) bar);
4627 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4628 (XtPointer) bar);
4629 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4630 (XtPointer) bar);
4631 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4632 (XtPointer) bar);
4634 /* Realize the widget. Only after that is the X window created. */
4635 XtRealizeWidget (widget);
4637 /* Set the cursor to an arrow. I didn't find a resource to do that.
4638 And I'm wondering why it hasn't an arrow cursor by default. */
4639 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4640 f->output_data.x->nontext_cursor);
4642 #else /* !USE_MOTIF i.e. use Xaw */
4644 /* Set resources. Create the widget. The background of the
4645 Xaw3d scroll bar widget is a little bit light for my taste.
4646 We don't alter it here to let users change it according
4647 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4648 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4649 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4650 /* For smoother scrolling with Xaw3d -sm */
4651 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4653 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4654 if (pixel != -1)
4656 XtSetArg (av[ac], XtNforeground, pixel);
4657 ++ac;
4660 pixel = f->output_data.x->scroll_bar_background_pixel;
4661 if (pixel != -1)
4663 XtSetArg (av[ac], XtNbackground, pixel);
4664 ++ac;
4667 /* Top/bottom shadow colors. */
4669 /* Allocate them, if necessary. */
4670 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4672 pixel = f->output_data.x->scroll_bar_background_pixel;
4673 if (pixel != -1)
4675 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4676 FRAME_X_COLORMAP (f),
4677 &pixel, 1.2, 0x8000))
4678 pixel = -1;
4679 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4682 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4684 pixel = f->output_data.x->scroll_bar_background_pixel;
4685 if (pixel != -1)
4687 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4688 FRAME_X_COLORMAP (f),
4689 &pixel, 0.6, 0x4000))
4690 pixel = -1;
4691 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4695 #ifdef XtNbeNiceToColormap
4696 /* Tell the toolkit about them. */
4697 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4698 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4699 /* We tried to allocate a color for the top/bottom shadow, and
4700 failed, so tell Xaw3d to use dithering instead. */
4702 XtSetArg (av[ac], XtNbeNiceToColormap, True);
4703 ++ac;
4705 else
4706 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4707 be more consistent with other emacs 3d colors, and since Xaw3d is
4708 not good at dealing with allocation failure. */
4710 /* This tells Xaw3d to use real colors instead of dithering for
4711 the shadows. */
4712 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4713 ++ac;
4715 /* Specify the colors. */
4716 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4717 if (pixel != -1)
4719 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4720 ++ac;
4722 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4723 if (pixel != -1)
4725 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4726 ++ac;
4729 #endif
4731 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4732 f->output_data.x->edit_widget, av, ac);
4735 char *initial = "";
4736 char *val = initial;
4737 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4738 #ifdef XtNarrowScrollbars
4739 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4740 #endif
4741 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4742 if (xaw3d_arrow_scroll || val == initial)
4743 { /* ARROW_SCROLL */
4744 xaw3d_arrow_scroll = True;
4745 /* Isn't that just a personal preference ? --Stef */
4746 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4750 /* Define callbacks. */
4751 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4752 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4753 (XtPointer) bar);
4755 /* Realize the widget. Only after that is the X window created. */
4756 XtRealizeWidget (widget);
4758 #endif /* !USE_MOTIF */
4760 /* Install an action hook that lets us detect when the user
4761 finishes interacting with a scroll bar. */
4762 if (action_hook_id == 0)
4763 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4765 /* Remember X window and widget in the scroll bar vector. */
4766 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4767 xwindow = XtWindow (widget);
4768 bar->x_window = xwindow;
4770 UNBLOCK_INPUT;
4772 #endif /* not USE_GTK */
4775 /* Set the thumb size and position of scroll bar BAR. We are currently
4776 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4778 #ifdef USE_GTK
4779 static void
4780 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4781 struct scroll_bar *bar;
4782 int portion, position, whole;
4784 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4787 #else /* not USE_GTK */
4788 static void
4789 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4790 struct scroll_bar *bar;
4791 int portion, position, whole;
4793 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4794 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4795 float top, shown;
4797 BLOCK_INPUT;
4799 #ifdef USE_MOTIF
4801 /* We use an estimate of 30 chars per line rather than the real
4802 `portion' value. This has the disadvantage that the thumb size
4803 is not very representative, but it makes our life a lot easier.
4804 Otherwise, we have to constantly adjust the thumb size, which
4805 we can't always do quickly enough: while dragging, the size of
4806 the thumb might prevent the user from dragging the thumb all the
4807 way to the end. but Motif and some versions of Xaw3d don't allow
4808 updating the thumb size while dragging. Also, even if we can update
4809 its size, the update will often happen too late.
4810 If you don't believe it, check out revision 1.650 of xterm.c to see
4811 what hoops we were going through and the still poor behavior we got. */
4812 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4813 /* When the thumb is at the bottom, position == whole.
4814 So we need to increase `whole' to make space for the thumb. */
4815 whole += portion;
4817 if (whole <= 0)
4818 top = 0, shown = 1;
4819 else
4821 top = (float) position / whole;
4822 shown = (float) portion / whole;
4825 if (NILP (bar->dragging))
4827 int size, value;
4829 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4830 is the scroll bar's maximum and MIN is the scroll bar's minimum
4831 value. */
4832 size = shown * XM_SB_MAX;
4833 size = min (size, XM_SB_MAX);
4834 size = max (size, 1);
4836 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4837 value = top * XM_SB_MAX;
4838 value = min (value, XM_SB_MAX - size);
4840 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4842 #else /* !USE_MOTIF i.e. use Xaw */
4844 if (whole == 0)
4845 top = 0, shown = 1;
4846 else
4848 top = (float) position / whole;
4849 shown = (float) portion / whole;
4853 float old_top, old_shown;
4854 Dimension height;
4855 XtVaGetValues (widget,
4856 XtNtopOfThumb, &old_top,
4857 XtNshown, &old_shown,
4858 XtNheight, &height,
4859 NULL);
4861 /* Massage the top+shown values. */
4862 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4863 top = max (0, min (1, top));
4864 else
4865 top = old_top;
4866 /* Keep two pixels available for moving the thumb down. */
4867 shown = max (0, min (1 - top - (2.0 / height), shown));
4869 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4870 check that your system's configuration file contains a define
4871 for `NARROWPROTO'. See s/freebsd.h for an example. */
4872 if (top != old_top || shown != old_shown)
4874 if (NILP (bar->dragging))
4875 XawScrollbarSetThumb (widget, top, shown);
4876 else
4878 /* Try to make the scrolling a tad smoother. */
4879 if (!xaw3d_pick_top)
4880 shown = min (shown, old_shown);
4882 XawScrollbarSetThumb (widget, top, shown);
4886 #endif /* !USE_MOTIF */
4888 UNBLOCK_INPUT;
4890 #endif /* not USE_GTK */
4892 #endif /* USE_TOOLKIT_SCROLL_BARS */
4896 /************************************************************************
4897 Scroll bars, general
4898 ************************************************************************/
4900 /* Create a scroll bar and return the scroll bar vector for it. W is
4901 the Emacs window on which to create the scroll bar. TOP, LEFT,
4902 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4903 scroll bar. */
4905 static struct scroll_bar *
4906 x_scroll_bar_create (w, top, left, width, height)
4907 struct window *w;
4908 int top, left, width, height;
4910 struct frame *f = XFRAME (w->frame);
4911 struct scroll_bar *bar
4912 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4914 BLOCK_INPUT;
4916 #ifdef USE_TOOLKIT_SCROLL_BARS
4917 x_create_toolkit_scroll_bar (f, bar);
4918 #else /* not USE_TOOLKIT_SCROLL_BARS */
4920 XSetWindowAttributes a;
4921 unsigned long mask;
4922 Window window;
4924 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4925 if (a.background_pixel == -1)
4926 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4928 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4929 | ButtonMotionMask | PointerMotionHintMask
4930 | ExposureMask);
4931 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4933 mask = (CWBackPixel | CWEventMask | CWCursor);
4935 /* Clear the area of W that will serve as a scroll bar. This is
4936 for the case that a window has been split horizontally. In
4937 this case, no clear_frame is generated to reduce flickering. */
4938 if (width > 0 && height > 0)
4939 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4940 left, top, width,
4941 window_box_height (w), False);
4943 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4944 /* Position and size of scroll bar. */
4945 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4946 top,
4947 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4948 height,
4949 /* Border width, depth, class, and visual. */
4951 CopyFromParent,
4952 CopyFromParent,
4953 CopyFromParent,
4954 /* Attributes. */
4955 mask, &a);
4956 bar->x_window = window;
4958 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4960 XSETWINDOW (bar->window, w);
4961 bar->top = top;
4962 bar->left = left;
4963 bar->width = width;
4964 bar->height = height;
4965 bar->start = 0;
4966 bar->end = 0;
4967 bar->dragging = Qnil;
4968 bar->fringe_extended_p = 0;
4970 /* Add bar to its frame's list of scroll bars. */
4971 bar->next = FRAME_SCROLL_BARS (f);
4972 bar->prev = Qnil;
4973 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4974 if (!NILP (bar->next))
4975 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4977 /* Map the window/widget. */
4978 #ifdef USE_TOOLKIT_SCROLL_BARS
4980 #ifdef USE_GTK
4981 xg_update_scrollbar_pos (f,
4982 bar->x_window,
4983 top,
4984 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4985 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4986 max (height, 1));
4987 xg_show_scroll_bar (bar->x_window);
4988 #else /* not USE_GTK */
4989 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4990 XtConfigureWidget (scroll_bar,
4991 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4992 top,
4993 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4994 max (height, 1), 0);
4995 XtMapWidget (scroll_bar);
4996 #endif /* not USE_GTK */
4998 #else /* not USE_TOOLKIT_SCROLL_BARS */
4999 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
5000 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5002 UNBLOCK_INPUT;
5003 return bar;
5007 #ifndef USE_TOOLKIT_SCROLL_BARS
5009 /* Draw BAR's handle in the proper position.
5011 If the handle is already drawn from START to END, don't bother
5012 redrawing it, unless REBUILD is non-zero; in that case, always
5013 redraw it. (REBUILD is handy for drawing the handle after expose
5014 events.)
5016 Normally, we want to constrain the start and end of the handle to
5017 fit inside its rectangle, but if the user is dragging the scroll
5018 bar handle, we want to let them drag it down all the way, so that
5019 the bar's top is as far down as it goes; otherwise, there's no way
5020 to move to the very end of the buffer. */
5022 static void
5023 x_scroll_bar_set_handle (bar, start, end, rebuild)
5024 struct scroll_bar *bar;
5025 int start, end;
5026 int rebuild;
5028 int dragging = ! NILP (bar->dragging);
5029 Window w = bar->x_window;
5030 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5031 GC gc = f->output_data.x->normal_gc;
5033 /* If the display is already accurate, do nothing. */
5034 if (! rebuild
5035 && start == bar->start
5036 && end == bar->end)
5037 return;
5039 BLOCK_INPUT;
5042 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
5043 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5044 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5046 /* Make sure the values are reasonable, and try to preserve
5047 the distance between start and end. */
5049 int length = end - start;
5051 if (start < 0)
5052 start = 0;
5053 else if (start > top_range)
5054 start = top_range;
5055 end = start + length;
5057 if (end < start)
5058 end = start;
5059 else if (end > top_range && ! dragging)
5060 end = top_range;
5063 /* Store the adjusted setting in the scroll bar. */
5064 bar->start = start;
5065 bar->end = end;
5067 /* Clip the end position, just for display. */
5068 if (end > top_range)
5069 end = top_range;
5071 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
5072 below top positions, to make sure the handle is always at least
5073 that many pixels tall. */
5074 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
5076 /* Draw the empty space above the handle. Note that we can't clear
5077 zero-height areas; that means "clear to end of window." */
5078 if (0 < start)
5079 x_clear_area (FRAME_X_DISPLAY (f), w,
5080 /* x, y, width, height, and exposures. */
5081 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5082 VERTICAL_SCROLL_BAR_TOP_BORDER,
5083 inside_width, start,
5084 False);
5086 /* Change to proper foreground color if one is specified. */
5087 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5088 XSetForeground (FRAME_X_DISPLAY (f), gc,
5089 f->output_data.x->scroll_bar_foreground_pixel);
5091 /* Draw the handle itself. */
5092 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5093 /* x, y, width, height */
5094 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5095 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5096 inside_width, end - start);
5098 /* Restore the foreground color of the GC if we changed it above. */
5099 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5100 XSetForeground (FRAME_X_DISPLAY (f), gc,
5101 FRAME_FOREGROUND_PIXEL (f));
5103 /* Draw the empty space below the handle. Note that we can't
5104 clear zero-height areas; that means "clear to end of window." */
5105 if (end < inside_height)
5106 x_clear_area (FRAME_X_DISPLAY (f), w,
5107 /* x, y, width, height, and exposures. */
5108 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5109 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5110 inside_width, inside_height - end,
5111 False);
5115 UNBLOCK_INPUT;
5118 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5120 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5121 nil. */
5123 static void
5124 x_scroll_bar_remove (bar)
5125 struct scroll_bar *bar;
5127 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5128 BLOCK_INPUT;
5130 #ifdef USE_TOOLKIT_SCROLL_BARS
5131 #ifdef USE_GTK
5132 xg_remove_scroll_bar (f, bar->x_window);
5133 #else /* not USE_GTK */
5134 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5135 #endif /* not USE_GTK */
5136 #else
5137 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5138 #endif
5140 /* Disassociate this scroll bar from its window. */
5141 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
5143 UNBLOCK_INPUT;
5147 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5148 that we are displaying PORTION characters out of a total of WHOLE
5149 characters, starting at POSITION. If WINDOW has no scroll bar,
5150 create one. */
5152 static void
5153 XTset_vertical_scroll_bar (w, portion, whole, position)
5154 struct window *w;
5155 int portion, whole, position;
5157 struct frame *f = XFRAME (w->frame);
5158 struct scroll_bar *bar;
5159 int top, height, left, sb_left, width, sb_width;
5160 int window_y, window_height;
5161 #ifdef USE_TOOLKIT_SCROLL_BARS
5162 int fringe_extended_p;
5163 #endif
5165 /* Get window dimensions. */
5166 window_box (w, -1, 0, &window_y, 0, &window_height);
5167 top = window_y;
5168 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5169 height = window_height;
5171 /* Compute the left edge of the scroll bar area. */
5172 left = WINDOW_SCROLL_BAR_AREA_X (w);
5174 /* Compute the width of the scroll bar which might be less than
5175 the width of the area reserved for the scroll bar. */
5176 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5177 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5178 else
5179 sb_width = width;
5181 /* Compute the left edge of the scroll bar. */
5182 #ifdef USE_TOOLKIT_SCROLL_BARS
5183 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5184 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5185 else
5186 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5187 #else
5188 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5189 sb_left = left + width - sb_width;
5190 else
5191 sb_left = left;
5192 #endif
5194 #ifdef USE_TOOLKIT_SCROLL_BARS
5195 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5196 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5197 && WINDOW_LEFT_FRINGE_WIDTH (w)
5198 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5199 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5200 else
5201 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5202 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5203 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5204 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5205 #endif
5207 /* Does the scroll bar exist yet? */
5208 if (NILP (w->vertical_scroll_bar))
5210 if (width > 0 && height > 0)
5212 BLOCK_INPUT;
5213 #ifdef USE_TOOLKIT_SCROLL_BARS
5214 if (fringe_extended_p)
5215 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5216 sb_left, top, sb_width, height, False);
5217 else
5218 #endif
5219 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5220 left, top, width, height, False);
5221 UNBLOCK_INPUT;
5224 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5226 else
5228 /* It may just need to be moved and resized. */
5229 unsigned int mask = 0;
5231 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5233 BLOCK_INPUT;
5235 if (sb_left != bar->left)
5236 mask |= CWX;
5237 if (top != bar->top)
5238 mask |= CWY;
5239 if (sb_width != bar->width)
5240 mask |= CWWidth;
5241 if (height != bar->height)
5242 mask |= CWHeight;
5244 #ifdef USE_TOOLKIT_SCROLL_BARS
5246 /* Move/size the scroll bar widget. */
5247 if (mask || bar->fringe_extended_p != fringe_extended_p)
5249 /* Since toolkit scroll bars are smaller than the space reserved
5250 for them on the frame, we have to clear "under" them. */
5251 if (width > 0 && height > 0)
5253 if (fringe_extended_p)
5254 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5255 sb_left, top, sb_width, height, False);
5256 else
5257 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5258 left, top, width, height, False);
5260 #ifdef USE_GTK
5261 xg_update_scrollbar_pos (f,
5262 bar->x_window,
5263 top,
5264 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5265 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5266 max (height, 1));
5267 #else /* not USE_GTK */
5268 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5269 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5270 top,
5271 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5272 max (height, 1), 0);
5273 #endif /* not USE_GTK */
5275 #else /* not USE_TOOLKIT_SCROLL_BARS */
5277 /* Clear areas not covered by the scroll bar because of
5278 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5279 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5281 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5282 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5283 height, False);
5284 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5285 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5286 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5287 height, False);
5290 /* Clear areas not covered by the scroll bar because it's not as
5291 wide as the area reserved for it. This makes sure a
5292 previous mode line display is cleared after C-x 2 C-x 1, for
5293 example. */
5295 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5296 int rest = area_width - sb_width;
5297 if (rest > 0 && height > 0)
5299 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5300 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5301 left + area_width - rest, top,
5302 rest, height, False);
5303 else
5304 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5305 left, top, rest, height, False);
5309 /* Move/size the scroll bar window. */
5310 if (mask)
5312 XWindowChanges wc;
5314 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5315 wc.y = top;
5316 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5317 wc.height = height;
5318 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5319 mask, &wc);
5322 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5324 /* Remember new settings. */
5325 bar->left = sb_left;
5326 bar->top = top;
5327 bar->width = sb_width;
5328 bar->height = height;
5330 UNBLOCK_INPUT;
5333 #ifdef USE_TOOLKIT_SCROLL_BARS
5334 bar->fringe_extended_p = fringe_extended_p;
5336 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5337 #else /* not USE_TOOLKIT_SCROLL_BARS */
5338 /* Set the scroll bar's current state, unless we're currently being
5339 dragged. */
5340 if (NILP (bar->dragging))
5342 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5344 if (whole == 0)
5345 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5346 else
5348 int start = ((double) position * top_range) / whole;
5349 int end = ((double) (position + portion) * top_range) / whole;
5350 x_scroll_bar_set_handle (bar, start, end, 0);
5353 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5355 XSETVECTOR (w->vertical_scroll_bar, bar);
5359 /* The following three hooks are used when we're doing a thorough
5360 redisplay of the frame. We don't explicitly know which scroll bars
5361 are going to be deleted, because keeping track of when windows go
5362 away is a real pain - "Can you say set-window-configuration, boys
5363 and girls?" Instead, we just assert at the beginning of redisplay
5364 that *all* scroll bars are to be removed, and then save a scroll bar
5365 from the fiery pit when we actually redisplay its window. */
5367 /* Arrange for all scroll bars on FRAME to be removed at the next call
5368 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5369 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5371 static void
5372 XTcondemn_scroll_bars (frame)
5373 FRAME_PTR frame;
5375 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5376 while (! NILP (FRAME_SCROLL_BARS (frame)))
5378 Lisp_Object bar;
5379 bar = FRAME_SCROLL_BARS (frame);
5380 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5381 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5382 XSCROLL_BAR (bar)->prev = Qnil;
5383 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5384 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5385 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5390 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5391 Note that WINDOW isn't necessarily condemned at all. */
5393 static void
5394 XTredeem_scroll_bar (window)
5395 struct window *window;
5397 struct scroll_bar *bar;
5398 struct frame *f;
5400 /* We can't redeem this window's scroll bar if it doesn't have one. */
5401 if (NILP (window->vertical_scroll_bar))
5402 abort ();
5404 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5406 /* Unlink it from the condemned list. */
5407 f = XFRAME (WINDOW_FRAME (window));
5408 if (NILP (bar->prev))
5410 /* If the prev pointer is nil, it must be the first in one of
5411 the lists. */
5412 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5413 /* It's not condemned. Everything's fine. */
5414 return;
5415 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5416 window->vertical_scroll_bar))
5417 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5418 else
5419 /* If its prev pointer is nil, it must be at the front of
5420 one or the other! */
5421 abort ();
5423 else
5424 XSCROLL_BAR (bar->prev)->next = bar->next;
5426 if (! NILP (bar->next))
5427 XSCROLL_BAR (bar->next)->prev = bar->prev;
5429 bar->next = FRAME_SCROLL_BARS (f);
5430 bar->prev = Qnil;
5431 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5432 if (! NILP (bar->next))
5433 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5436 /* Remove all scroll bars on FRAME that haven't been saved since the
5437 last call to `*condemn_scroll_bars_hook'. */
5439 static void
5440 XTjudge_scroll_bars (f)
5441 FRAME_PTR f;
5443 Lisp_Object bar, next;
5445 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5447 /* Clear out the condemned list now so we won't try to process any
5448 more events on the hapless scroll bars. */
5449 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5451 for (; ! NILP (bar); bar = next)
5453 struct scroll_bar *b = XSCROLL_BAR (bar);
5455 x_scroll_bar_remove (b);
5457 next = b->next;
5458 b->next = b->prev = Qnil;
5461 /* Now there should be no references to the condemned scroll bars,
5462 and they should get garbage-collected. */
5466 #ifndef USE_TOOLKIT_SCROLL_BARS
5467 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5468 is a no-op when using toolkit scroll bars.
5470 This may be called from a signal handler, so we have to ignore GC
5471 mark bits. */
5473 static void
5474 x_scroll_bar_expose (bar, event)
5475 struct scroll_bar *bar;
5476 XEvent *event;
5478 Window w = bar->x_window;
5479 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5480 GC gc = f->output_data.x->normal_gc;
5481 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5483 BLOCK_INPUT;
5485 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5487 /* Switch to scroll bar foreground color. */
5488 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5489 XSetForeground (FRAME_X_DISPLAY (f), gc,
5490 f->output_data.x->scroll_bar_foreground_pixel);
5492 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5493 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5495 /* x, y, width, height */
5496 0, 0,
5497 bar->width - 1 - width_trim - width_trim,
5498 bar->height - 1);
5500 /* Restore the foreground color of the GC if we changed it above. */
5501 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5502 XSetForeground (FRAME_X_DISPLAY (f), gc,
5503 FRAME_FOREGROUND_PIXEL (f));
5505 UNBLOCK_INPUT;
5508 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5510 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5511 is set to something other than NO_EVENT, it is enqueued.
5513 This may be called from a signal handler, so we have to ignore GC
5514 mark bits. */
5517 static void
5518 x_scroll_bar_handle_click (bar, event, emacs_event)
5519 struct scroll_bar *bar;
5520 XEvent *event;
5521 struct input_event *emacs_event;
5523 if (! WINDOWP (bar->window))
5524 abort ();
5526 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5527 emacs_event->code = event->xbutton.button - Button1;
5528 emacs_event->modifiers
5529 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5530 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5531 event->xbutton.state)
5532 | (event->type == ButtonRelease
5533 ? up_modifier
5534 : down_modifier));
5535 emacs_event->frame_or_window = bar->window;
5536 emacs_event->arg = Qnil;
5537 emacs_event->timestamp = event->xbutton.time;
5539 int top_range
5540 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5541 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5543 if (y < 0) y = 0;
5544 if (y > top_range) y = top_range;
5546 if (y < bar->start)
5547 emacs_event->part = scroll_bar_above_handle;
5548 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5549 emacs_event->part = scroll_bar_handle;
5550 else
5551 emacs_event->part = scroll_bar_below_handle;
5553 #ifndef USE_TOOLKIT_SCROLL_BARS
5554 /* If the user has released the handle, set it to its final position. */
5555 if (event->type == ButtonRelease
5556 && ! NILP (bar->dragging))
5558 int new_start = y - XINT (bar->dragging);
5559 int new_end = new_start + bar->end - bar->start;
5561 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5562 bar->dragging = Qnil;
5564 #endif
5566 XSETINT (emacs_event->x, y);
5567 XSETINT (emacs_event->y, top_range);
5571 #ifndef USE_TOOLKIT_SCROLL_BARS
5573 /* Handle some mouse motion while someone is dragging the scroll bar.
5575 This may be called from a signal handler, so we have to ignore GC
5576 mark bits. */
5578 static void
5579 x_scroll_bar_note_movement (bar, event)
5580 struct scroll_bar *bar;
5581 XEvent *event;
5583 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5585 last_mouse_movement_time = event->xmotion.time;
5587 f->mouse_moved = 1;
5588 XSETVECTOR (last_mouse_scroll_bar, bar);
5590 /* If we're dragging the bar, display it. */
5591 if (! NILP (bar->dragging))
5593 /* Where should the handle be now? */
5594 int new_start = event->xmotion.y - XINT (bar->dragging);
5596 if (new_start != bar->start)
5598 int new_end = new_start + bar->end - bar->start;
5600 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5605 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5607 /* Return information to the user about the current position of the mouse
5608 on the scroll bar. */
5610 static void
5611 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time)
5612 FRAME_PTR *fp;
5613 Lisp_Object *bar_window;
5614 enum scroll_bar_part *part;
5615 Lisp_Object *x, *y;
5616 unsigned long *time;
5618 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5619 Window w = bar->x_window;
5620 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5621 int win_x, win_y;
5622 Window dummy_window;
5623 int dummy_coord;
5624 unsigned int dummy_mask;
5626 BLOCK_INPUT;
5628 /* Get the mouse's position relative to the scroll bar window, and
5629 report that. */
5630 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5632 /* Root, child, root x and root y. */
5633 &dummy_window, &dummy_window,
5634 &dummy_coord, &dummy_coord,
5636 /* Position relative to scroll bar. */
5637 &win_x, &win_y,
5639 /* Mouse buttons and modifier keys. */
5640 &dummy_mask))
5642 else
5644 int top_range
5645 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5647 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5649 if (! NILP (bar->dragging))
5650 win_y -= XINT (bar->dragging);
5652 if (win_y < 0)
5653 win_y = 0;
5654 if (win_y > top_range)
5655 win_y = top_range;
5657 *fp = f;
5658 *bar_window = bar->window;
5660 if (! NILP (bar->dragging))
5661 *part = scroll_bar_handle;
5662 else if (win_y < bar->start)
5663 *part = scroll_bar_above_handle;
5664 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5665 *part = scroll_bar_handle;
5666 else
5667 *part = scroll_bar_below_handle;
5669 XSETINT (*x, win_y);
5670 XSETINT (*y, top_range);
5672 f->mouse_moved = 0;
5673 last_mouse_scroll_bar = Qnil;
5676 *time = last_mouse_movement_time;
5678 UNBLOCK_INPUT;
5682 /* The screen has been cleared so we may have changed foreground or
5683 background colors, and the scroll bars may need to be redrawn.
5684 Clear out the scroll bars, and ask for expose events, so we can
5685 redraw them. */
5687 void
5688 x_scroll_bar_clear (f)
5689 FRAME_PTR f;
5691 #ifndef USE_TOOLKIT_SCROLL_BARS
5692 Lisp_Object bar;
5694 /* We can have scroll bars even if this is 0,
5695 if we just turned off scroll bar mode.
5696 But in that case we should not clear them. */
5697 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5698 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5699 bar = XSCROLL_BAR (bar)->next)
5700 XClearArea (FRAME_X_DISPLAY (f),
5701 XSCROLL_BAR (bar)->x_window,
5702 0, 0, 0, 0, True);
5703 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5707 /* The main X event-reading loop - XTread_socket. */
5709 /* This holds the state XLookupString needs to implement dead keys
5710 and other tricks known as "compose processing". _X Window System_
5711 says that a portable program can't use this, but Stephen Gildea assures
5712 me that letting the compiler initialize it to zeros will work okay.
5714 This must be defined outside of XTread_socket, for the same reasons
5715 given for enter_timestamp, above. */
5717 static XComposeStatus compose_status;
5719 /* Record the last 100 characters stored
5720 to help debug the loss-of-chars-during-GC problem. */
5722 static int temp_index;
5723 static short temp_buffer[100];
5725 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5726 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5727 temp_index = 0; \
5728 temp_buffer[temp_index++] = (keysym)
5730 /* Set this to nonzero to fake an "X I/O error"
5731 on a particular display. */
5733 struct x_display_info *XTread_socket_fake_io_error;
5735 /* When we find no input here, we occasionally do a no-op command
5736 to verify that the X server is still running and we can still talk with it.
5737 We try all the open displays, one by one.
5738 This variable is used for cycling thru the displays. */
5740 static struct x_display_info *next_noop_dpyinfo;
5742 #define SET_SAVED_MENU_EVENT(size) \
5743 do \
5745 if (f->output_data.x->saved_menu_event == 0) \
5746 f->output_data.x->saved_menu_event \
5747 = (XEvent *) xmalloc (sizeof (XEvent)); \
5748 bcopy (&event, f->output_data.x->saved_menu_event, size); \
5749 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5750 XSETFRAME (inev.ie.frame_or_window, f); \
5752 while (0)
5754 #define SET_SAVED_BUTTON_EVENT SET_SAVED_MENU_EVENT (sizeof (XButtonEvent))
5755 #define SET_SAVED_KEY_EVENT SET_SAVED_MENU_EVENT (sizeof (XKeyEvent))
5758 enum
5760 X_EVENT_NORMAL,
5761 X_EVENT_GOTO_OUT,
5762 X_EVENT_DROP
5765 /* Filter events for the current X input method.
5766 DPYINFO is the display this event is for.
5767 EVENT is the X event to filter.
5769 Returns non-zero if the event was filtered, caller shall not process
5770 this event further.
5771 Returns zero if event is wasn't filtered. */
5773 #ifdef HAVE_X_I18N
5774 static int
5775 x_filter_event (dpyinfo, event)
5776 struct x_display_info *dpyinfo;
5777 XEvent *event;
5779 /* XFilterEvent returns non-zero if the input method has
5780 consumed the event. We pass the frame's X window to
5781 XFilterEvent because that's the one for which the IC
5782 was created. */
5784 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5785 event->xclient.window);
5787 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5789 #endif
5791 #ifdef USE_GTK
5792 static int current_count;
5793 static int current_finish;
5794 static struct input_event *current_hold_quit;
5796 /* This is the filter function invoked by the GTK event loop.
5797 It is invoked before the XEvent is translated to a GdkEvent,
5798 so we have a chance to act on the event before GTK. */
5799 static GdkFilterReturn
5800 event_handler_gdk (gxev, ev, data)
5801 GdkXEvent *gxev;
5802 GdkEvent *ev;
5803 gpointer data;
5805 XEvent *xev = (XEvent *) gxev;
5807 BLOCK_INPUT;
5808 if (current_count >= 0)
5810 struct x_display_info *dpyinfo;
5812 dpyinfo = x_display_info_for_display (xev->xany.display);
5814 #ifdef HAVE_X_I18N
5815 /* Filter events for the current X input method.
5816 GTK calls XFilterEvent but not for key press and release,
5817 so we do it here. */
5818 if ((xev->type == KeyPress || xev->type == KeyRelease)
5819 && dpyinfo
5820 && x_filter_event (dpyinfo, xev))
5822 UNBLOCK_INPUT;
5823 return GDK_FILTER_REMOVE;
5825 #endif
5827 if (! dpyinfo)
5828 current_finish = X_EVENT_NORMAL;
5829 else
5830 current_count +=
5831 handle_one_xevent (dpyinfo, xev, &current_finish,
5832 current_hold_quit);
5834 else
5835 current_finish = x_dispatch_event (xev, xev->xany.display);
5837 UNBLOCK_INPUT;
5839 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5840 return GDK_FILTER_REMOVE;
5842 return GDK_FILTER_CONTINUE;
5844 #endif /* USE_GTK */
5847 /* Handles the XEvent EVENT on display DPYINFO.
5849 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5850 *FINISH is zero if caller should continue reading events.
5851 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5853 We return the number of characters stored into the buffer. */
5855 static int
5856 handle_one_xevent (dpyinfo, eventp, finish, hold_quit)
5857 struct x_display_info *dpyinfo;
5858 XEvent *eventp;
5859 int *finish;
5860 struct input_event *hold_quit;
5862 union {
5863 struct input_event ie;
5864 struct selection_input_event sie;
5865 } inev;
5866 int count = 0;
5867 int do_help = 0;
5868 int nbytes = 0;
5869 struct frame *f = NULL;
5870 struct coding_system coding;
5871 XEvent event = *eventp;
5873 *finish = X_EVENT_NORMAL;
5875 EVENT_INIT (inev.ie);
5876 inev.ie.kind = NO_EVENT;
5877 inev.ie.arg = Qnil;
5879 if (pending_event_wait.eventtype == event.type)
5880 pending_event_wait.eventtype = 0; /* Indicates we got it. */
5882 switch (event.type)
5884 case ClientMessage:
5886 if (event.xclient.message_type
5887 == dpyinfo->Xatom_wm_protocols
5888 && event.xclient.format == 32)
5890 if (event.xclient.data.l[0]
5891 == dpyinfo->Xatom_wm_take_focus)
5893 /* Use x_any_window_to_frame because this
5894 could be the shell widget window
5895 if the frame has no title bar. */
5896 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5897 #ifdef HAVE_X_I18N
5898 /* Not quite sure this is needed -pd */
5899 if (f && FRAME_XIC (f))
5900 XSetICFocus (FRAME_XIC (f));
5901 #endif
5902 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5903 instructs the WM to set the input focus automatically for
5904 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5905 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5906 it has set the focus. So, XSetInputFocus below is not
5907 needed.
5909 The call to XSetInputFocus below has also caused trouble. In
5910 cases where the XSetInputFocus done by the WM and the one
5911 below are temporally close (on a fast machine), the call
5912 below can generate additional FocusIn events which confuse
5913 Emacs. */
5915 /* Since we set WM_TAKE_FOCUS, we must call
5916 XSetInputFocus explicitly. But not if f is null,
5917 since that might be an event for a deleted frame. */
5918 if (f)
5920 Display *d = event.xclient.display;
5921 /* Catch and ignore errors, in case window has been
5922 iconified by a window manager such as GWM. */
5923 x_catch_errors (d);
5924 XSetInputFocus (d, event.xclient.window,
5925 /* The ICCCM says this is
5926 the only valid choice. */
5927 RevertToParent,
5928 event.xclient.data.l[1]);
5929 /* This is needed to detect the error
5930 if there is an error. */
5931 XSync (d, False);
5932 x_uncatch_errors ();
5934 /* Not certain about handling scroll bars here */
5935 #endif /* 0 */
5936 goto done;
5939 if (event.xclient.data.l[0]
5940 == dpyinfo->Xatom_wm_save_yourself)
5942 /* Save state modify the WM_COMMAND property to
5943 something which can reinstate us. This notifies
5944 the session manager, who's looking for such a
5945 PropertyNotify. Can restart processing when
5946 a keyboard or mouse event arrives. */
5947 /* If we have a session manager, don't set this.
5948 KDE will then start two Emacsen, one for the
5949 session manager and one for this. */
5950 #ifdef HAVE_X_SM
5951 if (! x_session_have_connection ())
5952 #endif
5954 f = x_top_window_to_frame (dpyinfo,
5955 event.xclient.window);
5956 /* This is just so we only give real data once
5957 for a single Emacs process. */
5958 if (f == SELECTED_FRAME ())
5959 XSetCommand (FRAME_X_DISPLAY (f),
5960 event.xclient.window,
5961 initial_argv, initial_argc);
5962 else if (f)
5963 XSetCommand (FRAME_X_DISPLAY (f),
5964 event.xclient.window,
5965 0, 0);
5967 goto done;
5970 if (event.xclient.data.l[0]
5971 == dpyinfo->Xatom_wm_delete_window)
5973 f = x_any_window_to_frame (dpyinfo,
5974 event.xclient.window);
5975 if (!f)
5976 goto OTHER; /* May be a dialog that is to be removed */
5978 inev.ie.kind = DELETE_WINDOW_EVENT;
5979 XSETFRAME (inev.ie.frame_or_window, f);
5980 goto done;
5983 goto done;
5986 if (event.xclient.message_type
5987 == dpyinfo->Xatom_wm_configure_denied)
5989 goto done;
5992 if (event.xclient.message_type
5993 == dpyinfo->Xatom_wm_window_moved)
5995 int new_x, new_y;
5996 f = x_window_to_frame (dpyinfo, event.xclient.window);
5998 new_x = event.xclient.data.s[0];
5999 new_y = event.xclient.data.s[1];
6001 if (f)
6003 f->left_pos = new_x;
6004 f->top_pos = new_y;
6006 goto done;
6009 #ifdef HACK_EDITRES
6010 if (event.xclient.message_type
6011 == dpyinfo->Xatom_editres)
6013 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6014 if (f)
6015 _XEditResCheckMessages (f->output_data.x->widget, NULL,
6016 &event, NULL);
6017 goto done;
6019 #endif /* HACK_EDITRES */
6021 if ((event.xclient.message_type
6022 == dpyinfo->Xatom_DONE)
6023 || (event.xclient.message_type
6024 == dpyinfo->Xatom_PAGE))
6026 /* Ghostview job completed. Kill it. We could
6027 reply with "Next" if we received "Page", but we
6028 currently never do because we are interested in
6029 images, only, which should have 1 page. */
6030 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
6031 f = x_window_to_frame (dpyinfo, event.xclient.window);
6032 if (!f)
6033 goto OTHER;
6034 x_kill_gs_process (pixmap, f);
6035 expose_frame (f, 0, 0, 0, 0);
6036 goto done;
6039 #ifdef USE_TOOLKIT_SCROLL_BARS
6040 /* Scroll bar callbacks send a ClientMessage from which
6041 we construct an input_event. */
6042 if (event.xclient.message_type
6043 == dpyinfo->Xatom_Scrollbar)
6045 x_scroll_bar_to_input_event (&event, &inev.ie);
6046 *finish = X_EVENT_GOTO_OUT;
6047 goto done;
6049 #endif /* USE_TOOLKIT_SCROLL_BARS */
6051 /* XEmbed messages from the embedder (if any). */
6052 if (event.xclient.message_type
6053 == dpyinfo->Xatom_XEMBED)
6055 enum xembed_message msg = event.xclient.data.l[1];
6056 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
6057 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6059 *finish = X_EVENT_GOTO_OUT;
6060 goto done;
6063 xft_settings_event (dpyinfo, &event);
6065 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6066 if (!f)
6067 goto OTHER;
6068 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
6069 *finish = X_EVENT_DROP;
6071 break;
6073 case SelectionNotify:
6074 last_user_time = event.xselection.time;
6075 #ifdef USE_X_TOOLKIT
6076 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
6077 goto OTHER;
6078 #endif /* not USE_X_TOOLKIT */
6079 x_handle_selection_notify (&event.xselection);
6080 break;
6082 case SelectionClear: /* Someone has grabbed ownership. */
6083 last_user_time = event.xselectionclear.time;
6084 #ifdef USE_X_TOOLKIT
6085 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6086 goto OTHER;
6087 #endif /* USE_X_TOOLKIT */
6089 XSelectionClearEvent *eventp = (XSelectionClearEvent *) &event;
6091 inev.ie.kind = SELECTION_CLEAR_EVENT;
6092 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6093 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6094 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6095 inev.ie.frame_or_window = Qnil;
6097 break;
6099 case SelectionRequest: /* Someone wants our selection. */
6100 last_user_time = event.xselectionrequest.time;
6101 #ifdef USE_X_TOOLKIT
6102 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6103 goto OTHER;
6104 #endif /* USE_X_TOOLKIT */
6106 XSelectionRequestEvent *eventp
6107 = (XSelectionRequestEvent *) &event;
6109 inev.ie.kind = SELECTION_REQUEST_EVENT;
6110 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6111 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6112 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6113 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6114 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6115 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6116 inev.ie.frame_or_window = Qnil;
6118 break;
6120 case PropertyNotify:
6121 last_user_time = event.xproperty.time;
6122 f = x_top_window_to_frame (dpyinfo, event.xproperty.window);
6123 if (f && event.xproperty.atom == dpyinfo->Xatom_net_wm_state)
6124 x_handle_net_wm_state (f, &event.xproperty);
6126 x_handle_property_notify (&event.xproperty);
6127 xft_settings_event (dpyinfo, &event);
6128 goto OTHER;
6130 case ReparentNotify:
6131 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6132 if (f)
6134 int x, y;
6135 f->output_data.x->parent_desc = event.xreparent.parent;
6136 x_real_positions (f, &x, &y);
6137 f->left_pos = x;
6138 f->top_pos = y;
6140 /* Perhaps reparented due to a WM restart. Reset this. */
6141 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6142 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6144 goto OTHER;
6146 case Expose:
6147 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6148 if (f)
6150 #ifdef USE_GTK
6151 /* This seems to be needed for GTK 2.6. */
6152 x_clear_area (event.xexpose.display,
6153 event.xexpose.window,
6154 event.xexpose.x, event.xexpose.y,
6155 event.xexpose.width, event.xexpose.height,
6156 FALSE);
6157 #endif
6158 if (f->async_visible == 0)
6160 f->async_visible = 1;
6161 f->async_iconified = 0;
6162 f->output_data.x->has_been_visible = 1;
6163 SET_FRAME_GARBAGED (f);
6165 else
6166 expose_frame (f,
6167 event.xexpose.x, event.xexpose.y,
6168 event.xexpose.width, event.xexpose.height);
6170 else
6172 #ifndef USE_TOOLKIT_SCROLL_BARS
6173 struct scroll_bar *bar;
6174 #endif
6175 #if defined USE_LUCID
6176 /* Submenus of the Lucid menu bar aren't widgets
6177 themselves, so there's no way to dispatch events
6178 to them. Recognize this case separately. */
6180 Widget widget
6181 = x_window_to_menu_bar (event.xexpose.window);
6182 if (widget)
6183 xlwmenu_redisplay (widget);
6185 #endif /* USE_LUCID */
6187 #ifdef USE_TOOLKIT_SCROLL_BARS
6188 /* Dispatch event to the widget. */
6189 goto OTHER;
6190 #else /* not USE_TOOLKIT_SCROLL_BARS */
6191 bar = x_window_to_scroll_bar (event.xexpose.display,
6192 event.xexpose.window);
6194 if (bar)
6195 x_scroll_bar_expose (bar, &event);
6196 #ifdef USE_X_TOOLKIT
6197 else
6198 goto OTHER;
6199 #endif /* USE_X_TOOLKIT */
6200 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6202 break;
6204 case GraphicsExpose: /* This occurs when an XCopyArea's
6205 source area was obscured or not
6206 available. */
6207 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6208 if (f)
6210 expose_frame (f,
6211 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6212 event.xgraphicsexpose.width,
6213 event.xgraphicsexpose.height);
6215 #ifdef USE_X_TOOLKIT
6216 else
6217 goto OTHER;
6218 #endif /* USE_X_TOOLKIT */
6219 break;
6221 case NoExpose: /* This occurs when an XCopyArea's
6222 source area was completely
6223 available. */
6224 break;
6226 case UnmapNotify:
6227 /* Redo the mouse-highlight after the tooltip has gone. */
6228 if (event.xmap.window == tip_window)
6230 tip_window = 0;
6231 redo_mouse_highlight ();
6234 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6235 if (f) /* F may no longer exist if
6236 the frame was deleted. */
6238 /* While a frame is unmapped, display generation is
6239 disabled; you don't want to spend time updating a
6240 display that won't ever be seen. */
6241 f->async_visible = 0;
6242 /* We can't distinguish, from the event, whether the window
6243 has become iconified or invisible. So assume, if it
6244 was previously visible, than now it is iconified.
6245 But x_make_frame_invisible clears both
6246 the visible flag and the iconified flag;
6247 and that way, we know the window is not iconified now. */
6248 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6250 f->async_iconified = 1;
6252 inev.ie.kind = ICONIFY_EVENT;
6253 XSETFRAME (inev.ie.frame_or_window, f);
6256 goto OTHER;
6258 case MapNotify:
6259 if (event.xmap.window == tip_window)
6260 /* The tooltip has been drawn already. Avoid
6261 the SET_FRAME_GARBAGED below. */
6262 goto OTHER;
6264 /* We use x_top_window_to_frame because map events can
6265 come for sub-windows and they don't mean that the
6266 frame is visible. */
6267 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6268 if (f)
6270 /* wait_reading_process_output will notice this and update
6271 the frame's display structures.
6272 If we where iconified, we should not set garbaged,
6273 because that stops redrawing on Expose events. This looks
6274 bad if we are called from a recursive event loop
6275 (x_dispatch_event), for example when a dialog is up. */
6276 if (! f->async_iconified)
6277 SET_FRAME_GARBAGED (f);
6279 /* Check if fullscreen was specified before we where mapped the
6280 first time, i.e. from the command line. */
6281 if (!f->output_data.x->has_been_visible)
6282 x_check_fullscreen (f);
6284 f->async_visible = 1;
6285 f->async_iconified = 0;
6286 f->output_data.x->has_been_visible = 1;
6288 if (f->iconified)
6290 inev.ie.kind = DEICONIFY_EVENT;
6291 XSETFRAME (inev.ie.frame_or_window, f);
6293 else if (! NILP (Vframe_list)
6294 && ! NILP (XCDR (Vframe_list)))
6295 /* Force a redisplay sooner or later
6296 to update the frame titles
6297 in case this is the second frame. */
6298 record_asynch_buffer_change ();
6300 #ifdef USE_GTK
6301 xg_frame_resized (f, -1, -1);
6302 #endif
6304 goto OTHER;
6306 case KeyPress:
6308 last_user_time = event.xkey.time;
6309 ignore_next_mouse_click_timeout = 0;
6311 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6312 /* Dispatch KeyPress events when in menu. */
6313 if (popup_activated ())
6314 goto OTHER;
6315 #endif
6317 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6319 /* If mouse-highlight is an integer, input clears out
6320 mouse highlighting. */
6321 if (!dpyinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6322 && (f == 0
6323 || !EQ (f->tool_bar_window, dpyinfo->mouse_face_window)))
6325 clear_mouse_face (dpyinfo);
6326 dpyinfo->mouse_face_hidden = 1;
6329 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6330 if (f == 0)
6332 /* Scroll bars consume key events, but we want
6333 the keys to go to the scroll bar's frame. */
6334 Widget widget = XtWindowToWidget (dpyinfo->display,
6335 event.xkey.window);
6336 if (widget && XmIsScrollBar (widget))
6338 widget = XtParent (widget);
6339 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6342 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6344 if (f != 0)
6346 KeySym keysym, orig_keysym;
6347 /* al%imercury@uunet.uu.net says that making this 81
6348 instead of 80 fixed a bug whereby meta chars made
6349 his Emacs hang.
6351 It seems that some version of XmbLookupString has
6352 a bug of not returning XBufferOverflow in
6353 status_return even if the input is too long to
6354 fit in 81 bytes. So, we must prepare sufficient
6355 bytes for copy_buffer. 513 bytes (256 chars for
6356 two-byte character set) seems to be a fairly good
6357 approximation. -- 2000.8.10 handa@etl.go.jp */
6358 unsigned char copy_buffer[513];
6359 unsigned char *copy_bufptr = copy_buffer;
6360 int copy_bufsiz = sizeof (copy_buffer);
6361 int modifiers;
6362 Lisp_Object coding_system = Qlatin_1;
6363 Lisp_Object c;
6365 #ifdef USE_GTK
6366 /* Don't pass keys to GTK. A Tab will shift focus to the
6367 tool bar in GTK 2.4. Keys will still go to menus and
6368 dialogs because in that case popup_activated is TRUE
6369 (see above). */
6370 *finish = X_EVENT_DROP;
6371 #endif
6373 event.xkey.state
6374 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6375 extra_keyboard_modifiers);
6376 modifiers = event.xkey.state;
6378 /* This will have to go some day... */
6380 /* make_lispy_event turns chars into control chars.
6381 Don't do it here because XLookupString is too eager. */
6382 event.xkey.state &= ~ControlMask;
6383 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6384 | dpyinfo->super_mod_mask
6385 | dpyinfo->hyper_mod_mask
6386 | dpyinfo->alt_mod_mask);
6388 /* In case Meta is ComposeCharacter,
6389 clear its status. According to Markus Ehrnsperger
6390 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6391 this enables ComposeCharacter to work whether or
6392 not it is combined with Meta. */
6393 if (modifiers & dpyinfo->meta_mod_mask)
6394 bzero (&compose_status, sizeof (compose_status));
6396 #ifdef HAVE_X_I18N
6397 if (FRAME_XIC (f))
6399 Status status_return;
6401 coding_system = Vlocale_coding_system;
6402 nbytes = XmbLookupString (FRAME_XIC (f),
6403 &event.xkey, copy_bufptr,
6404 copy_bufsiz, &keysym,
6405 &status_return);
6406 if (status_return == XBufferOverflow)
6408 copy_bufsiz = nbytes + 1;
6409 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6410 nbytes = XmbLookupString (FRAME_XIC (f),
6411 &event.xkey, copy_bufptr,
6412 copy_bufsiz, &keysym,
6413 &status_return);
6415 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6416 if (status_return == XLookupNone)
6417 break;
6418 else if (status_return == XLookupChars)
6420 keysym = NoSymbol;
6421 modifiers = 0;
6423 else if (status_return != XLookupKeySym
6424 && status_return != XLookupBoth)
6425 abort ();
6427 else
6428 nbytes = XLookupString (&event.xkey, copy_bufptr,
6429 copy_bufsiz, &keysym,
6430 &compose_status);
6431 #else
6432 nbytes = XLookupString (&event.xkey, copy_bufptr,
6433 copy_bufsiz, &keysym,
6434 &compose_status);
6435 #endif
6437 /* If not using XIM/XIC, and a compose sequence is in progress,
6438 we break here. Otherwise, chars_matched is always 0. */
6439 if (compose_status.chars_matched > 0 && nbytes == 0)
6440 break;
6442 bzero (&compose_status, sizeof (compose_status));
6443 orig_keysym = keysym;
6445 /* Common for all keysym input events. */
6446 XSETFRAME (inev.ie.frame_or_window, f);
6447 inev.ie.modifiers
6448 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6449 inev.ie.timestamp = event.xkey.time;
6451 /* First deal with keysyms which have defined
6452 translations to characters. */
6453 if (keysym >= 32 && keysym < 128)
6454 /* Avoid explicitly decoding each ASCII character. */
6456 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6457 inev.ie.code = keysym;
6458 goto done_keysym;
6461 /* Keysyms directly mapped to Unicode characters. */
6462 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6464 if (keysym < 0x01000080)
6465 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6466 else
6467 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6468 inev.ie.code = keysym & 0xFFFFFF;
6469 goto done_keysym;
6472 /* Now non-ASCII. */
6473 if (HASH_TABLE_P (Vx_keysym_table)
6474 && (NATNUMP (c = Fgethash (make_number (keysym),
6475 Vx_keysym_table,
6476 Qnil))))
6478 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6479 ? ASCII_KEYSTROKE_EVENT
6480 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6481 inev.ie.code = XFASTINT (c);
6482 goto done_keysym;
6485 /* Random non-modifier sorts of keysyms. */
6486 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6487 || keysym == XK_Delete
6488 #ifdef XK_ISO_Left_Tab
6489 || (keysym >= XK_ISO_Left_Tab
6490 && keysym <= XK_ISO_Enter)
6491 #endif
6492 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6493 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6494 #ifdef HPUX
6495 /* This recognizes the "extended function
6496 keys". It seems there's no cleaner way.
6497 Test IsModifierKey to avoid handling
6498 mode_switch incorrectly. */
6499 || ((unsigned) (keysym) >= XK_Select
6500 && (unsigned)(keysym) < XK_KP_Space)
6501 #endif
6502 #ifdef XK_dead_circumflex
6503 || orig_keysym == XK_dead_circumflex
6504 #endif
6505 #ifdef XK_dead_grave
6506 || orig_keysym == XK_dead_grave
6507 #endif
6508 #ifdef XK_dead_tilde
6509 || orig_keysym == XK_dead_tilde
6510 #endif
6511 #ifdef XK_dead_diaeresis
6512 || orig_keysym == XK_dead_diaeresis
6513 #endif
6514 #ifdef XK_dead_macron
6515 || orig_keysym == XK_dead_macron
6516 #endif
6517 #ifdef XK_dead_degree
6518 || orig_keysym == XK_dead_degree
6519 #endif
6520 #ifdef XK_dead_acute
6521 || orig_keysym == XK_dead_acute
6522 #endif
6523 #ifdef XK_dead_cedilla
6524 || orig_keysym == XK_dead_cedilla
6525 #endif
6526 #ifdef XK_dead_breve
6527 || orig_keysym == XK_dead_breve
6528 #endif
6529 #ifdef XK_dead_ogonek
6530 || orig_keysym == XK_dead_ogonek
6531 #endif
6532 #ifdef XK_dead_caron
6533 || orig_keysym == XK_dead_caron
6534 #endif
6535 #ifdef XK_dead_doubleacute
6536 || orig_keysym == XK_dead_doubleacute
6537 #endif
6538 #ifdef XK_dead_abovedot
6539 || orig_keysym == XK_dead_abovedot
6540 #endif
6541 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6542 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6543 /* Any "vendor-specific" key is ok. */
6544 || (orig_keysym & (1 << 28))
6545 || (keysym != NoSymbol && nbytes == 0))
6546 && ! (IsModifierKey (orig_keysym)
6547 /* The symbols from XK_ISO_Lock
6548 to XK_ISO_Last_Group_Lock
6549 don't have real modifiers but
6550 should be treated similarly to
6551 Mode_switch by Emacs. */
6552 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6553 || ((unsigned)(orig_keysym)
6554 >= XK_ISO_Lock
6555 && (unsigned)(orig_keysym)
6556 <= XK_ISO_Last_Group_Lock)
6557 #endif
6560 STORE_KEYSYM_FOR_DEBUG (keysym);
6561 /* make_lispy_event will convert this to a symbolic
6562 key. */
6563 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6564 inev.ie.code = keysym;
6565 goto done_keysym;
6568 { /* Raw bytes, not keysym. */
6569 register int i;
6570 register int c;
6571 int nchars, len;
6573 for (i = 0, nchars = 0; i < nbytes; i++)
6575 if (ASCII_BYTE_P (copy_bufptr[i]))
6576 nchars++;
6577 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6580 if (nchars < nbytes)
6582 /* Decode the input data. */
6583 int require;
6584 unsigned char *p;
6586 /* The input should be decoded with `coding_system'
6587 which depends on which X*LookupString function
6588 we used just above and the locale. */
6589 setup_coding_system (coding_system, &coding);
6590 coding.src_multibyte = 0;
6591 coding.dst_multibyte = 1;
6592 /* The input is converted to events, thus we can't
6593 handle composition. Anyway, there's no XIM that
6594 gives us composition information. */
6595 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6597 require = MAX_MULTIBYTE_LENGTH * nbytes;
6598 coding.destination = alloca (require);
6599 coding.dst_bytes = require;
6600 coding.mode |= CODING_MODE_LAST_BLOCK;
6601 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6602 nbytes = coding.produced;
6603 nchars = coding.produced_char;
6604 copy_bufptr = coding.destination;
6607 /* Convert the input data to a sequence of
6608 character events. */
6609 for (i = 0; i < nbytes; i += len)
6611 if (nchars == nbytes)
6612 c = copy_bufptr[i], len = 1;
6613 else
6614 c = STRING_CHAR_AND_LENGTH (copy_bufptr + i, len);
6615 inev.ie.kind = (SINGLE_BYTE_CHAR_P (c)
6616 ? ASCII_KEYSTROKE_EVENT
6617 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6618 inev.ie.code = c;
6619 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6622 count += nchars;
6624 inev.ie.kind = NO_EVENT; /* Already stored above. */
6626 if (keysym == NoSymbol)
6627 break;
6630 done_keysym:
6631 #ifdef HAVE_X_I18N
6632 /* Don't dispatch this event since XtDispatchEvent calls
6633 XFilterEvent, and two calls in a row may freeze the
6634 client. */
6635 break;
6636 #else
6637 goto OTHER;
6638 #endif
6640 case KeyRelease:
6641 last_user_time = event.xkey.time;
6642 #ifdef HAVE_X_I18N
6643 /* Don't dispatch this event since XtDispatchEvent calls
6644 XFilterEvent, and two calls in a row may freeze the
6645 client. */
6646 break;
6647 #else
6648 goto OTHER;
6649 #endif
6651 case EnterNotify:
6652 last_user_time = event.xcrossing.time;
6653 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6655 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6657 if (f && x_mouse_click_focus_ignore_position)
6658 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6660 /* EnterNotify counts as mouse movement,
6661 so update things that depend on mouse position. */
6662 if (f && !f->output_data.x->hourglass_p)
6663 note_mouse_movement (f, &event.xmotion);
6664 #ifdef USE_GTK
6665 /* We may get an EnterNotify on the buttons in the toolbar. In that
6666 case we moved out of any highlighted area and need to note this. */
6667 if (!f && last_mouse_glyph_frame)
6668 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6669 #endif
6670 goto OTHER;
6672 case FocusIn:
6673 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6674 goto OTHER;
6676 case LeaveNotify:
6677 last_user_time = event.xcrossing.time;
6678 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6680 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6681 if (f)
6683 if (f == dpyinfo->mouse_face_mouse_frame)
6685 /* If we move outside the frame, then we're
6686 certainly no longer on any text in the frame. */
6687 clear_mouse_face (dpyinfo);
6688 dpyinfo->mouse_face_mouse_frame = 0;
6691 /* Generate a nil HELP_EVENT to cancel a help-echo.
6692 Do it only if there's something to cancel.
6693 Otherwise, the startup message is cleared when
6694 the mouse leaves the frame. */
6695 if (any_help_event_p)
6696 do_help = -1;
6698 #ifdef USE_GTK
6699 /* See comment in EnterNotify above */
6700 else if (last_mouse_glyph_frame)
6701 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6702 #endif
6703 goto OTHER;
6705 case FocusOut:
6706 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6707 goto OTHER;
6709 case MotionNotify:
6711 last_user_time = event.xmotion.time;
6712 previous_help_echo_string = help_echo_string;
6713 help_echo_string = Qnil;
6715 if (dpyinfo->grabbed && last_mouse_frame
6716 && FRAME_LIVE_P (last_mouse_frame))
6717 f = last_mouse_frame;
6718 else
6719 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6721 if (dpyinfo->mouse_face_hidden)
6723 dpyinfo->mouse_face_hidden = 0;
6724 clear_mouse_face (dpyinfo);
6727 #ifdef USE_GTK
6728 if (f && xg_event_is_for_scrollbar (f, &event))
6729 f = 0;
6730 #endif
6731 if (f)
6734 /* Generate SELECT_WINDOW_EVENTs when needed.
6735 Don't let popup menus influence things (bug#1261). */
6736 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6738 Lisp_Object window;
6740 window = window_from_coordinates (f,
6741 event.xmotion.x, event.xmotion.y,
6742 0, 0, 0, 0);
6744 /* Window will be selected only when it is not selected now and
6745 last mouse movement event was not in it. Minibuffer window
6746 will be selected only when it is active. */
6747 if (WINDOWP (window)
6748 && !EQ (window, last_window)
6749 && !EQ (window, selected_window)
6750 /* For click-to-focus window managers
6751 create event iff we don't leave the
6752 selected frame. */
6753 && (focus_follows_mouse
6754 || (EQ (XWINDOW (window)->frame,
6755 XWINDOW (selected_window)->frame))))
6757 inev.ie.kind = SELECT_WINDOW_EVENT;
6758 inev.ie.frame_or_window = window;
6761 last_window=window;
6763 if (!note_mouse_movement (f, &event.xmotion))
6764 help_echo_string = previous_help_echo_string;
6766 else
6768 #ifndef USE_TOOLKIT_SCROLL_BARS
6769 struct scroll_bar *bar
6770 = x_window_to_scroll_bar (event.xmotion.display,
6771 event.xmotion.window);
6773 if (bar)
6774 x_scroll_bar_note_movement (bar, &event);
6775 #endif /* USE_TOOLKIT_SCROLL_BARS */
6777 /* If we move outside the frame, then we're
6778 certainly no longer on any text in the frame. */
6779 clear_mouse_face (dpyinfo);
6782 /* If the contents of the global variable help_echo_string
6783 has changed, generate a HELP_EVENT. */
6784 if (!NILP (help_echo_string)
6785 || !NILP (previous_help_echo_string))
6786 do_help = 1;
6787 goto OTHER;
6790 case ConfigureNotify:
6791 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6792 #ifdef USE_GTK
6793 if (!f
6794 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6795 && event.xconfigure.window == FRAME_X_WINDOW (f))
6797 xg_frame_resized (f, event.xconfigure.width,
6798 event.xconfigure.height);
6799 f = 0;
6801 #endif
6802 if (f)
6804 #ifndef USE_X_TOOLKIT
6805 #ifndef USE_GTK
6806 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6807 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6809 /* In the toolkit version, change_frame_size
6810 is called by the code that handles resizing
6811 of the EmacsFrame widget. */
6813 /* Even if the number of character rows and columns has
6814 not changed, the font size may have changed, so we need
6815 to check the pixel dimensions as well. */
6816 if (columns != FRAME_COLS (f)
6817 || rows != FRAME_LINES (f)
6818 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6819 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6821 change_frame_size (f, rows, columns, 0, 1, 0);
6822 SET_FRAME_GARBAGED (f);
6823 cancel_mouse_face (f);
6826 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6827 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6828 #endif /* not USE_GTK */
6829 #endif
6831 #ifdef USE_GTK
6832 /* GTK creates windows but doesn't map them.
6833 Only get real positions when mapped. */
6834 if (FRAME_GTK_OUTER_WIDGET (f)
6835 && GTK_WIDGET_MAPPED (FRAME_GTK_OUTER_WIDGET (f)))
6836 #endif
6838 x_real_positions (f, &f->left_pos, &f->top_pos);
6841 #ifdef HAVE_X_I18N
6842 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6843 xic_set_statusarea (f);
6844 #endif
6847 goto OTHER;
6849 case ButtonRelease:
6850 case ButtonPress:
6852 /* If we decide we want to generate an event to be seen
6853 by the rest of Emacs, we put it here. */
6854 int tool_bar_p = 0;
6856 bzero (&compose_status, sizeof (compose_status));
6857 last_mouse_glyph_frame = 0;
6858 last_user_time = event.xbutton.time;
6860 if (dpyinfo->grabbed
6861 && last_mouse_frame
6862 && FRAME_LIVE_P (last_mouse_frame))
6863 f = last_mouse_frame;
6864 else
6865 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6867 #ifdef USE_GTK
6868 if (f && xg_event_is_for_scrollbar (f, &event))
6869 f = 0;
6870 #endif
6871 if (f)
6873 /* Is this in the tool-bar? */
6874 if (WINDOWP (f->tool_bar_window)
6875 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6877 Lisp_Object window;
6878 int x = event.xbutton.x;
6879 int y = event.xbutton.y;
6881 window = window_from_coordinates (f, x, y, 0, 0, 0, 1);
6882 tool_bar_p = EQ (window, f->tool_bar_window);
6884 if (tool_bar_p && event.xbutton.button < 4)
6886 handle_tool_bar_click (f, x, y,
6887 event.xbutton.type == ButtonPress,
6888 x_x_to_emacs_modifiers (dpyinfo,
6889 event.xbutton.state));
6893 if (!tool_bar_p)
6894 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6895 if (! popup_activated ())
6896 #endif
6898 if (ignore_next_mouse_click_timeout)
6900 if (event.type == ButtonPress
6901 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6903 ignore_next_mouse_click_timeout = 0;
6904 construct_mouse_click (&inev.ie, &event.xbutton, f);
6906 if (event.type == ButtonRelease)
6907 ignore_next_mouse_click_timeout = 0;
6909 else
6910 construct_mouse_click (&inev.ie, &event.xbutton, f);
6912 if (FRAME_X_EMBEDDED_P (f))
6913 xembed_send_message (f, event.xbutton.time,
6914 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6916 else
6918 struct scroll_bar *bar
6919 = x_window_to_scroll_bar (event.xbutton.display,
6920 event.xbutton.window);
6922 #ifdef USE_TOOLKIT_SCROLL_BARS
6923 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6924 scroll bars. */
6925 if (bar && event.xbutton.state & ControlMask)
6927 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6928 *finish = X_EVENT_DROP;
6930 #else /* not USE_TOOLKIT_SCROLL_BARS */
6931 if (bar)
6932 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6933 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6936 if (event.type == ButtonPress)
6938 dpyinfo->grabbed |= (1 << event.xbutton.button);
6939 last_mouse_frame = f;
6941 if (!tool_bar_p)
6942 last_tool_bar_item = -1;
6944 else
6945 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6947 /* Ignore any mouse motion that happened before this event;
6948 any subsequent mouse-movement Emacs events should reflect
6949 only motion after the ButtonPress/Release. */
6950 if (f != 0)
6951 f->mouse_moved = 0;
6953 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6954 f = x_menubar_window_to_frame (dpyinfo, &event);
6955 /* For a down-event in the menu bar,
6956 don't pass it to Xt right now.
6957 Instead, save it away
6958 and we will pass it to Xt from kbd_buffer_get_event.
6959 That way, we can run some Lisp code first. */
6960 if (
6961 #ifdef USE_GTK
6962 ! popup_activated ()
6963 /* Gtk+ menus only react to the first three buttons. */
6964 && 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 #ifdef USE_GTK
6979 *finish = X_EVENT_DROP;
6980 #endif
6982 else if (event.type == ButtonPress)
6984 last_mouse_press_frame = Qnil;
6985 goto OTHER;
6988 #ifdef USE_MOTIF /* This should do not harm for Lucid,
6989 but I am trying to be cautious. */
6990 else if (event.type == ButtonRelease)
6992 if (!NILP (last_mouse_press_frame))
6994 f = XFRAME (last_mouse_press_frame);
6995 if (f->output_data.x)
6996 SET_SAVED_BUTTON_EVENT;
6998 else
6999 goto OTHER;
7001 #endif /* USE_MOTIF */
7002 else
7003 goto OTHER;
7004 #endif /* USE_X_TOOLKIT || USE_GTK */
7006 break;
7008 case CirculateNotify:
7009 goto OTHER;
7011 case CirculateRequest:
7012 goto OTHER;
7014 case VisibilityNotify:
7015 goto OTHER;
7017 case MappingNotify:
7018 /* Someone has changed the keyboard mapping - update the
7019 local cache. */
7020 switch (event.xmapping.request)
7022 case MappingModifier:
7023 x_find_modifier_meanings (dpyinfo);
7024 /* This is meant to fall through. */
7025 case MappingKeyboard:
7026 XRefreshKeyboardMapping (&event.xmapping);
7028 goto OTHER;
7030 case DestroyNotify:
7031 xft_settings_event (dpyinfo, &event);
7032 break;
7034 default:
7035 OTHER:
7036 #ifdef USE_X_TOOLKIT
7037 BLOCK_INPUT;
7038 if (*finish != X_EVENT_DROP)
7039 XtDispatchEvent (&event);
7040 UNBLOCK_INPUT;
7041 #endif /* USE_X_TOOLKIT */
7042 break;
7045 done:
7046 if (inev.ie.kind != NO_EVENT)
7048 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
7049 count++;
7052 if (do_help
7053 && !(hold_quit && hold_quit->kind != NO_EVENT))
7055 Lisp_Object frame;
7057 if (f)
7058 XSETFRAME (frame, f);
7059 else
7060 frame = Qnil;
7062 if (do_help > 0)
7064 any_help_event_p = 1;
7065 gen_help_event (help_echo_string, frame, help_echo_window,
7066 help_echo_object, help_echo_pos);
7068 else
7070 help_echo_string = Qnil;
7071 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
7073 count++;
7076 *eventp = event;
7077 return count;
7081 /* Handles the XEvent EVENT on display DISPLAY.
7082 This is used for event loops outside the normal event handling,
7083 i.e. looping while a popup menu or a dialog is posted.
7085 Returns the value handle_one_xevent sets in the finish argument. */
7087 x_dispatch_event (event, display)
7088 XEvent *event;
7089 Display *display;
7091 struct x_display_info *dpyinfo;
7092 int finish = X_EVENT_NORMAL;
7094 dpyinfo = x_display_info_for_display (display);
7096 if (dpyinfo)
7097 handle_one_xevent (dpyinfo, event, &finish, 0);
7099 return finish;
7103 /* Read events coming from the X server.
7104 This routine is called by the SIGIO handler.
7105 We return as soon as there are no more events to be read.
7107 We return the number of characters stored into the buffer,
7108 thus pretending to be `read' (except the characters we store
7109 in the keyboard buffer can be multibyte, so are not necessarily
7110 C chars).
7112 EXPECTED is nonzero if the caller knows input is available. */
7114 static int
7115 XTread_socket (terminal, expected, hold_quit)
7116 struct terminal *terminal;
7117 int expected;
7118 struct input_event *hold_quit;
7120 int count = 0;
7121 XEvent event;
7122 int event_found = 0;
7124 if (interrupt_input_blocked)
7126 interrupt_input_pending = 1;
7127 #ifdef SYNC_INPUT
7128 pending_signals = 1;
7129 #endif
7130 return -1;
7133 interrupt_input_pending = 0;
7134 #ifdef SYNC_INPUT
7135 pending_signals = pending_atimers;
7136 #endif
7137 BLOCK_INPUT;
7139 /* So people can tell when we have read the available input. */
7140 input_signal_count++;
7142 ++handling_signal;
7144 #ifdef HAVE_X_SM
7145 /* Only check session manager input for the primary display. */
7146 if (terminal->id == 1 && x_session_have_connection ())
7148 struct input_event inev;
7149 BLOCK_INPUT;
7150 /* We don't need to EVENT_INIT (inev) here, as
7151 x_session_check_input copies an entire input_event. */
7152 if (x_session_check_input (&inev))
7154 kbd_buffer_store_event_hold (&inev, hold_quit);
7155 count++;
7157 UNBLOCK_INPUT;
7159 #endif
7161 /* For debugging, this gives a way to fake an I/O error. */
7162 if (terminal->display_info.x == XTread_socket_fake_io_error)
7164 XTread_socket_fake_io_error = 0;
7165 x_io_error_quitter (terminal->display_info.x->display);
7168 #ifndef USE_GTK
7169 while (XPending (terminal->display_info.x->display))
7171 int finish;
7173 XNextEvent (terminal->display_info.x->display, &event);
7175 #ifdef HAVE_X_I18N
7176 /* Filter events for the current X input method. */
7177 if (x_filter_event (terminal->display_info.x, &event))
7178 continue;
7179 #endif
7180 event_found = 1;
7182 count += handle_one_xevent (terminal->display_info.x,
7183 &event, &finish, hold_quit);
7185 if (finish == X_EVENT_GOTO_OUT)
7186 goto out;
7189 #else /* USE_GTK */
7191 /* For GTK we must use the GTK event loop. But XEvents gets passed
7192 to our filter function above, and then to the big event switch.
7193 We use a bunch of globals to communicate with our filter function,
7194 that is kind of ugly, but it works.
7196 There is no way to do one display at the time, GTK just does events
7197 from all displays. */
7199 while (gtk_events_pending ())
7201 current_count = count;
7202 current_hold_quit = hold_quit;
7204 gtk_main_iteration ();
7206 count = current_count;
7207 current_count = -1;
7208 current_hold_quit = 0;
7210 if (current_finish == X_EVENT_GOTO_OUT)
7211 break;
7213 #endif /* USE_GTK */
7215 out:;
7217 /* On some systems, an X bug causes Emacs to get no more events
7218 when the window is destroyed. Detect that. (1994.) */
7219 if (! event_found)
7221 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7222 One XNOOP in 100 loops will make Emacs terminate.
7223 B. Bretthauer, 1994 */
7224 x_noop_count++;
7225 if (x_noop_count >= 100)
7227 x_noop_count=0;
7229 if (next_noop_dpyinfo == 0)
7230 next_noop_dpyinfo = x_display_list;
7232 XNoOp (next_noop_dpyinfo->display);
7234 /* Each time we get here, cycle through the displays now open. */
7235 next_noop_dpyinfo = next_noop_dpyinfo->next;
7239 /* If the focus was just given to an auto-raising frame,
7240 raise it now. */
7241 /* ??? This ought to be able to handle more than one such frame. */
7242 if (pending_autoraise_frame)
7244 x_raise_frame (pending_autoraise_frame);
7245 pending_autoraise_frame = 0;
7248 --handling_signal;
7249 UNBLOCK_INPUT;
7251 return count;
7257 /***********************************************************************
7258 Text Cursor
7259 ***********************************************************************/
7261 /* Set clipping for output in glyph row ROW. W is the window in which
7262 we operate. GC is the graphics context to set clipping in.
7264 ROW may be a text row or, e.g., a mode line. Text rows must be
7265 clipped to the interior of the window dedicated to text display,
7266 mode lines must be clipped to the whole window. */
7268 static void
7269 x_clip_to_row (w, row, area, gc)
7270 struct window *w;
7271 struct glyph_row *row;
7272 int area;
7273 GC gc;
7275 struct frame *f = XFRAME (WINDOW_FRAME (w));
7276 XRectangle clip_rect;
7277 int window_x, window_y, window_width;
7279 window_box (w, area, &window_x, &window_y, &window_width, 0);
7281 clip_rect.x = window_x;
7282 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7283 clip_rect.y = max (clip_rect.y, window_y);
7284 clip_rect.width = window_width;
7285 clip_rect.height = row->visible_height;
7287 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7291 /* Draw a hollow box cursor on window W in glyph row ROW. */
7293 static void
7294 x_draw_hollow_cursor (w, row)
7295 struct window *w;
7296 struct glyph_row *row;
7298 struct frame *f = XFRAME (WINDOW_FRAME (w));
7299 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7300 Display *dpy = FRAME_X_DISPLAY (f);
7301 int x, y, wd, h;
7302 XGCValues xgcv;
7303 struct glyph *cursor_glyph;
7304 GC gc;
7306 /* Get the glyph the cursor is on. If we can't tell because
7307 the current matrix is invalid or such, give up. */
7308 cursor_glyph = get_phys_cursor_glyph (w);
7309 if (cursor_glyph == NULL)
7310 return;
7312 /* Compute frame-relative coordinates for phys cursor. */
7313 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7314 wd = w->phys_cursor_width;
7316 /* The foreground of cursor_gc is typically the same as the normal
7317 background color, which can cause the cursor box to be invisible. */
7318 xgcv.foreground = f->output_data.x->cursor_pixel;
7319 if (dpyinfo->scratch_cursor_gc)
7320 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7321 else
7322 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7323 GCForeground, &xgcv);
7324 gc = dpyinfo->scratch_cursor_gc;
7326 /* Set clipping, draw the rectangle, and reset clipping again. */
7327 x_clip_to_row (w, row, TEXT_AREA, gc);
7328 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7329 XSetClipMask (dpy, gc, None);
7333 /* Draw a bar cursor on window W in glyph row ROW.
7335 Implementation note: One would like to draw a bar cursor with an
7336 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7337 Unfortunately, I didn't find a font yet that has this property set.
7338 --gerd. */
7340 static void
7341 x_draw_bar_cursor (w, row, width, kind)
7342 struct window *w;
7343 struct glyph_row *row;
7344 int width;
7345 enum text_cursor_kinds kind;
7347 struct frame *f = XFRAME (w->frame);
7348 struct glyph *cursor_glyph;
7350 /* If cursor is out of bounds, don't draw garbage. This can happen
7351 in mini-buffer windows when switching between echo area glyphs
7352 and mini-buffer. */
7353 cursor_glyph = get_phys_cursor_glyph (w);
7354 if (cursor_glyph == NULL)
7355 return;
7357 /* If on an image, draw like a normal cursor. That's usually better
7358 visible than drawing a bar, esp. if the image is large so that
7359 the bar might not be in the window. */
7360 if (cursor_glyph->type == IMAGE_GLYPH)
7362 struct glyph_row *row;
7363 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7364 draw_phys_cursor_glyph (w, row, DRAW_CURSOR);
7366 else
7368 Display *dpy = FRAME_X_DISPLAY (f);
7369 Window window = FRAME_X_WINDOW (f);
7370 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7371 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7372 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7373 XGCValues xgcv;
7375 /* If the glyph's background equals the color we normally draw
7376 the bars cursor in, the bar cursor in its normal color is
7377 invisible. Use the glyph's foreground color instead in this
7378 case, on the assumption that the glyph's colors are chosen so
7379 that the glyph is legible. */
7380 if (face->background == f->output_data.x->cursor_pixel)
7381 xgcv.background = xgcv.foreground = face->foreground;
7382 else
7383 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7384 xgcv.graphics_exposures = 0;
7386 if (gc)
7387 XChangeGC (dpy, gc, mask, &xgcv);
7388 else
7390 gc = XCreateGC (dpy, window, mask, &xgcv);
7391 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7394 x_clip_to_row (w, row, TEXT_AREA, gc);
7396 if (kind == BAR_CURSOR)
7398 if (width < 0)
7399 width = FRAME_CURSOR_WIDTH (f);
7400 width = min (cursor_glyph->pixel_width, width);
7402 w->phys_cursor_width = width;
7404 XFillRectangle (dpy, window, gc,
7405 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7406 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7407 width, row->height);
7409 else
7411 int dummy_x, dummy_y, dummy_h;
7413 if (width < 0)
7414 width = row->height;
7416 width = min (row->height, width);
7418 get_phys_cursor_geometry (w, row, cursor_glyph, &dummy_x,
7419 &dummy_y, &dummy_h);
7421 XFillRectangle (dpy, window, gc,
7422 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7423 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7424 row->height - width),
7425 w->phys_cursor_width, width);
7428 XSetClipMask (dpy, gc, None);
7433 /* RIF: Define cursor CURSOR on frame F. */
7435 static void
7436 x_define_frame_cursor (f, cursor)
7437 struct frame *f;
7438 Cursor cursor;
7440 if (!f->pointer_invisible
7441 && f->output_data.x->current_cursor != cursor)
7442 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7443 f->output_data.x->current_cursor = cursor;
7447 /* RIF: Clear area on frame F. */
7449 static void
7450 x_clear_frame_area (f, x, y, width, height)
7451 struct frame *f;
7452 int x, y, width, height;
7454 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7455 x, y, width, height, False);
7456 #ifdef USE_GTK
7457 /* Must queue a redraw, because scroll bars might have been cleared. */
7458 if (FRAME_GTK_WIDGET (f))
7459 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
7460 #endif
7464 /* RIF: Draw cursor on window W. */
7466 static void
7467 x_draw_window_cursor (w, glyph_row, x, y, cursor_type, cursor_width, on_p, active_p)
7468 struct window *w;
7469 struct glyph_row *glyph_row;
7470 int x, y;
7471 int cursor_type, cursor_width;
7472 int on_p, active_p;
7474 struct frame *f = XFRAME (WINDOW_FRAME (w));
7476 if (on_p)
7478 w->phys_cursor_type = cursor_type;
7479 w->phys_cursor_on_p = 1;
7481 if (glyph_row->exact_window_width_line_p
7482 && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
7484 glyph_row->cursor_in_fringe_p = 1;
7485 draw_fringe_bitmap (w, glyph_row, 0);
7487 else
7488 switch (cursor_type)
7490 case HOLLOW_BOX_CURSOR:
7491 x_draw_hollow_cursor (w, glyph_row);
7492 break;
7494 case FILLED_BOX_CURSOR:
7495 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7496 break;
7498 case BAR_CURSOR:
7499 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7500 break;
7502 case HBAR_CURSOR:
7503 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7504 break;
7506 case NO_CURSOR:
7507 w->phys_cursor_width = 0;
7508 break;
7510 default:
7511 abort ();
7514 #ifdef HAVE_X_I18N
7515 if (w == XWINDOW (f->selected_window))
7516 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7517 xic_set_preeditarea (w, x, y);
7518 #endif
7521 #ifndef XFlush
7522 XFlush (FRAME_X_DISPLAY (f));
7523 #endif
7527 /* Icons. */
7529 /* Make the x-window of frame F use the gnu icon bitmap. */
7532 x_bitmap_icon (f, file)
7533 struct frame *f;
7534 Lisp_Object file;
7536 int bitmap_id;
7538 if (FRAME_X_WINDOW (f) == 0)
7539 return 1;
7541 /* Free up our existing icon bitmap and mask if any. */
7542 if (f->output_data.x->icon_bitmap > 0)
7543 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7544 f->output_data.x->icon_bitmap = 0;
7546 if (STRINGP (file))
7548 #ifdef USE_GTK
7549 /* Use gtk_window_set_icon_from_file () if available,
7550 It's not restricted to bitmaps */
7551 if (xg_set_icon (f, file))
7552 return 0;
7553 #endif /* USE_GTK */
7554 bitmap_id = x_create_bitmap_from_file (f, file);
7555 x_create_bitmap_mask (f, bitmap_id);
7557 else
7559 /* Create the GNU bitmap and mask if necessary. */
7560 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7562 int rc = -1;
7564 #ifdef USE_GTK
7566 if (xg_set_icon (f, xg_default_icon_file)
7567 || xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7568 return 0;
7570 #elif defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7572 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7573 if (rc != -1)
7574 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7576 #endif
7578 /* If all else fails, use the (black and white) xbm image. */
7579 if (rc == -1)
7581 rc = x_create_bitmap_from_data (f, gnu_xbm_bits,
7582 gnu_xbm_width, gnu_xbm_height);
7583 if (rc == -1)
7584 return 1;
7586 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7587 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7591 /* The first time we create the GNU bitmap and mask,
7592 this increments the ref-count one extra time.
7593 As a result, the GNU bitmap and mask are never freed.
7594 That way, we don't have to worry about allocating it again. */
7595 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7597 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7600 x_wm_set_icon_pixmap (f, bitmap_id);
7601 f->output_data.x->icon_bitmap = bitmap_id;
7603 return 0;
7607 /* Make the x-window of frame F use a rectangle with text.
7608 Use ICON_NAME as the text. */
7611 x_text_icon (f, icon_name)
7612 struct frame *f;
7613 char *icon_name;
7615 if (FRAME_X_WINDOW (f) == 0)
7616 return 1;
7619 XTextProperty text;
7620 text.value = (unsigned char *) icon_name;
7621 text.encoding = XA_STRING;
7622 text.format = 8;
7623 text.nitems = strlen (icon_name);
7624 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7627 if (f->output_data.x->icon_bitmap > 0)
7628 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7629 f->output_data.x->icon_bitmap = 0;
7630 x_wm_set_icon_pixmap (f, 0);
7632 return 0;
7635 #define X_ERROR_MESSAGE_SIZE 200
7637 /* If non-nil, this should be a string.
7638 It means catch X errors and store the error message in this string.
7640 The reason we use a stack is that x_catch_error/x_uncatch_error can
7641 be called from a signal handler.
7644 struct x_error_message_stack {
7645 char string[X_ERROR_MESSAGE_SIZE];
7646 Display *dpy;
7647 struct x_error_message_stack *prev;
7649 static struct x_error_message_stack *x_error_message;
7651 /* An X error handler which stores the error message in
7652 *x_error_message. This is called from x_error_handler if
7653 x_catch_errors is in effect. */
7655 static void
7656 x_error_catcher (display, error)
7657 Display *display;
7658 XErrorEvent *error;
7660 XGetErrorText (display, error->error_code,
7661 x_error_message->string,
7662 X_ERROR_MESSAGE_SIZE);
7665 /* Begin trapping X errors for display DPY. Actually we trap X errors
7666 for all displays, but DPY should be the display you are actually
7667 operating on.
7669 After calling this function, X protocol errors no longer cause
7670 Emacs to exit; instead, they are recorded in the string
7671 stored in *x_error_message.
7673 Calling x_check_errors signals an Emacs error if an X error has
7674 occurred since the last call to x_catch_errors or x_check_errors.
7676 Calling x_uncatch_errors resumes the normal error handling. */
7678 void x_check_errors ();
7680 void
7681 x_catch_errors (dpy)
7682 Display *dpy;
7684 struct x_error_message_stack *data = xmalloc (sizeof (*data));
7686 /* Make sure any errors from previous requests have been dealt with. */
7687 XSync (dpy, False);
7689 data->dpy = dpy;
7690 data->string[0] = 0;
7691 data->prev = x_error_message;
7692 x_error_message = data;
7695 /* Undo the last x_catch_errors call.
7696 DPY should be the display that was passed to x_catch_errors. */
7698 void
7699 x_uncatch_errors ()
7701 struct x_error_message_stack *tmp;
7703 BLOCK_INPUT;
7705 /* The display may have been closed before this function is called.
7706 Check if it is still open before calling XSync. */
7707 if (x_display_info_for_display (x_error_message->dpy) != 0)
7708 XSync (x_error_message->dpy, False);
7710 tmp = x_error_message;
7711 x_error_message = x_error_message->prev;
7712 xfree (tmp);
7713 UNBLOCK_INPUT;
7716 /* If any X protocol errors have arrived since the last call to
7717 x_catch_errors or x_check_errors, signal an Emacs error using
7718 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7720 void
7721 x_check_errors (dpy, format)
7722 Display *dpy;
7723 char *format;
7725 /* Make sure to catch any errors incurred so far. */
7726 XSync (dpy, False);
7728 if (x_error_message->string[0])
7730 char string[X_ERROR_MESSAGE_SIZE];
7731 bcopy (x_error_message->string, string, X_ERROR_MESSAGE_SIZE);
7732 x_uncatch_errors ();
7733 error (format, string);
7737 /* Nonzero if we had any X protocol errors
7738 since we did x_catch_errors on DPY. */
7741 x_had_errors_p (dpy)
7742 Display *dpy;
7744 /* Make sure to catch any errors incurred so far. */
7745 XSync (dpy, False);
7747 return x_error_message->string[0] != 0;
7750 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7752 void
7753 x_clear_errors (dpy)
7754 Display *dpy;
7756 x_error_message->string[0] = 0;
7759 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7760 * idea. --lorentey */
7761 /* Close off all unclosed x_catch_errors calls. */
7763 void
7764 x_fully_uncatch_errors ()
7766 while (x_error_message)
7767 x_uncatch_errors ();
7769 #endif
7771 /* Nonzero if x_catch_errors has been done and not yet canceled. */
7774 x_catching_errors ()
7776 return x_error_message != 0;
7779 #if 0
7780 static unsigned int x_wire_count;
7781 x_trace_wire ()
7783 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7785 #endif /* ! 0 */
7788 /* Handle SIGPIPE, which can happen when the connection to a server
7789 simply goes away. SIGPIPE is handled by x_connection_signal.
7790 Don't need to do anything, because the write which caused the
7791 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7792 which will do the appropriate cleanup for us. */
7794 static SIGTYPE
7795 x_connection_signal (signalnum) /* If we don't have an argument, */
7796 int signalnum; /* some compilers complain in signal calls. */
7798 #ifdef USG
7799 /* USG systems forget handlers when they are used;
7800 must reestablish each time */
7801 signal (signalnum, x_connection_signal);
7802 #endif /* USG */
7806 /************************************************************************
7807 Handling X errors
7808 ************************************************************************/
7810 /* Error message passed to x_connection_closed. */
7812 static char *error_msg;
7814 /* Function installed as fatal_error_signal_hook in
7815 x_connection_closed. Print the X error message, and exit normally,
7816 instead of dumping core when XtCloseDisplay fails. */
7818 static void
7819 x_fatal_error_signal ()
7821 fprintf (stderr, "%s\n", error_msg);
7822 exit (70);
7825 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7826 the text of an error message that lead to the connection loss. */
7828 static SIGTYPE
7829 x_connection_closed (dpy, error_message)
7830 Display *dpy;
7831 char *error_message;
7833 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7834 Lisp_Object frame, tail;
7835 int index = SPECPDL_INDEX ();
7837 error_msg = (char *) alloca (strlen (error_message) + 1);
7838 strcpy (error_msg, error_message);
7839 handling_signal = 0;
7841 /* Prevent being called recursively because of an error condition
7842 below. Otherwise, we might end up with printing ``can't find per
7843 display information'' in the recursive call instead of printing
7844 the original message here. */
7845 x_catch_errors (dpy);
7847 /* Inhibit redisplay while frames are being deleted. */
7848 specbind (Qinhibit_redisplay, Qt);
7850 if (dpyinfo)
7852 /* Protect display from being closed when we delete the last
7853 frame on it. */
7854 dpyinfo->reference_count++;
7855 dpyinfo->terminal->reference_count++;
7858 /* First delete frames whose mini-buffers are on frames
7859 that are on the dead display. */
7860 FOR_EACH_FRAME (tail, frame)
7862 Lisp_Object minibuf_frame;
7863 minibuf_frame
7864 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7865 if (FRAME_X_P (XFRAME (frame))
7866 && FRAME_X_P (XFRAME (minibuf_frame))
7867 && ! EQ (frame, minibuf_frame)
7868 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7869 delete_frame (frame, Qnoelisp);
7872 /* Now delete all remaining frames on the dead display.
7873 We are now sure none of these is used as the mini-buffer
7874 for another frame that we need to delete. */
7875 FOR_EACH_FRAME (tail, frame)
7876 if (FRAME_X_P (XFRAME (frame))
7877 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7879 /* Set this to t so that delete_frame won't get confused
7880 trying to find a replacement. */
7881 FRAME_KBOARD (XFRAME (frame))->Vdefault_minibuffer_frame = Qt;
7882 delete_frame (frame, Qnoelisp);
7885 /* If DPYINFO is null, this means we didn't open the display in the
7886 first place, so don't try to close it. */
7887 if (dpyinfo)
7889 #ifdef USE_X_TOOLKIT
7890 /* We have to close the display to inform Xt that it doesn't
7891 exist anymore. If we don't, Xt will continue to wait for
7892 events from the display. As a consequence, a sequence of
7894 M-x make-frame-on-display RET :1 RET
7895 ...kill the new frame, so that we get an IO error...
7896 M-x make-frame-on-display RET :1 RET
7898 will indefinitely wait in Xt for events for display `:1',
7899 opened in the first call to make-frame-on-display.
7901 Closing the display is reported to lead to a bus error on
7902 OpenWindows in certain situations. I suspect that is a bug
7903 in OpenWindows. I don't know how to circumvent it here. */
7904 extern void (*fatal_error_signal_hook) P_ ((void));
7905 fatal_error_signal_hook = x_fatal_error_signal;
7906 XtCloseDisplay (dpy);
7907 fatal_error_signal_hook = NULL;
7908 #endif /* USE_X_TOOLKIT */
7910 #ifdef USE_GTK
7911 /* A long-standing GTK bug prevents proper disconnect handling
7912 (https://bugzilla.gnome.org/show_bug.cgi?id=85715). Once,
7913 the resulting Glib error message loop filled a user's disk.
7914 To avoid this, kill Emacs unconditionally on disconnect. */
7915 shut_down_emacs (0, 0, Qnil);
7916 fprintf (stderr, "%s\n\
7917 When compiled with GTK, Emacs cannot recover from X disconnects.\n\
7918 This is a GTK bug: https://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
7919 For details, see etc/PROBLEMS.\n",
7920 error_msg);
7921 abort ();
7922 #endif /* USE_GTK */
7924 /* Indicate that this display is dead. */
7925 dpyinfo->display = 0;
7927 dpyinfo->reference_count--;
7928 dpyinfo->terminal->reference_count--;
7929 if (dpyinfo->reference_count != 0)
7930 /* We have just closed all frames on this display. */
7931 abort ();
7934 Lisp_Object tmp;
7935 XSETTERMINAL (tmp, dpyinfo->terminal);
7936 Fdelete_terminal (tmp, Qnoelisp);
7940 x_uncatch_errors ();
7942 if (terminal_list == 0)
7944 fprintf (stderr, "%s\n", error_msg);
7945 shut_down_emacs (0, 0, Qnil);
7946 exit (70);
7949 /* Ordinary stack unwind doesn't deal with these. */
7950 #ifdef SIGIO
7951 sigunblock (sigmask (SIGIO));
7952 #endif
7953 sigunblock (sigmask (SIGALRM));
7954 TOTALLY_UNBLOCK_INPUT;
7956 unbind_to (index, Qnil);
7957 clear_waiting_for_input ();
7958 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7959 longjmp), because returning from this function would get us back into
7960 Xlib's code which will directly call `exit'. */
7961 error ("%s", error_msg);
7964 /* We specifically use it before defining it, so that gcc doesn't inline it,
7965 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7966 static void x_error_quitter P_ ((Display *, XErrorEvent *));
7968 /* This is the first-level handler for X protocol errors.
7969 It calls x_error_quitter or x_error_catcher. */
7971 static int
7972 x_error_handler (display, error)
7973 Display *display;
7974 XErrorEvent *error;
7976 if (x_error_message)
7977 x_error_catcher (display, error);
7978 else
7979 x_error_quitter (display, error);
7980 return 0;
7983 /* This is the usual handler for X protocol errors.
7984 It kills all frames on the display that we got the error for.
7985 If that was the only one, it prints an error message and kills Emacs. */
7987 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7989 #if __GNUC__ >= 3 /* On GCC 3.0 we might get a warning. */
7990 #define NO_INLINE __attribute__((noinline))
7991 #else
7992 #define NO_INLINE
7993 #endif
7995 /* Some versions of GNU/Linux define noinline in their headers. */
7997 #ifdef noinline
7998 #undef noinline
7999 #endif
8001 /* On older GCC versions, just putting x_error_quitter
8002 after x_error_handler prevents inlining into the former. */
8004 static void NO_INLINE
8005 x_error_quitter (display, error)
8006 Display *display;
8007 XErrorEvent *error;
8009 char buf[256], buf1[356];
8011 /* Ignore BadName errors. They can happen because of fonts
8012 or colors that are not defined. */
8014 if (error->error_code == BadName)
8015 return;
8017 /* Note that there is no real way portable across R3/R4 to get the
8018 original error handler. */
8020 XGetErrorText (display, error->error_code, buf, sizeof (buf));
8021 sprintf (buf1, "X protocol error: %s on protocol request %d",
8022 buf, error->request_code);
8023 x_connection_closed (display, buf1);
8027 /* This is the handler for X IO errors, always.
8028 It kills all frames on the display that we lost touch with.
8029 If that was the only one, it prints an error message and kills Emacs. */
8031 static int
8032 x_io_error_quitter (display)
8033 Display *display;
8035 char buf[256];
8037 sprintf (buf, "Connection lost to X server `%s'", DisplayString (display));
8038 x_connection_closed (display, buf);
8039 return 0;
8042 /* Changing the font of the frame. */
8044 /* Give frame F the font FONT-OBJECT as its default font. The return
8045 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
8046 frame. If it is negative, generate a new fontset from
8047 FONT-OBJECT. */
8049 Lisp_Object
8050 x_new_font (f, font_object, fontset)
8051 struct frame *f;
8052 Lisp_Object font_object;
8053 int fontset;
8055 struct font *font = XFONT_OBJECT (font_object);
8057 if (fontset < 0)
8058 fontset = fontset_from_font (font_object);
8059 FRAME_FONTSET (f) = fontset;
8060 if (FRAME_FONT (f) == font)
8061 /* This font is already set in frame F. There's nothing more to
8062 do. */
8063 return font_object;
8065 FRAME_FONT (f) = font;
8066 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
8067 FRAME_COLUMN_WIDTH (f) = font->average_width;
8068 FRAME_SPACE_WIDTH (f) = font->space_width;
8069 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
8071 compute_fringe_widths (f, 1);
8073 /* Compute the scroll bar width in character columns. */
8074 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
8076 int wid = FRAME_COLUMN_WIDTH (f);
8077 FRAME_CONFIG_SCROLL_BAR_COLS (f)
8078 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
8080 else
8082 int wid = FRAME_COLUMN_WIDTH (f);
8083 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
8086 if (FRAME_X_WINDOW (f) != 0)
8088 /* Don't change the size of a tip frame; there's no point in
8089 doing it because it's done in Fx_show_tip, and it leads to
8090 problems because the tip frame has no widget. */
8091 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8092 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
8095 #ifdef HAVE_X_I18N
8096 if (FRAME_XIC (f)
8097 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
8099 BLOCK_INPUT;
8100 xic_set_xfontset (f, SDATA (fontset_ascii (fontset)));
8101 UNBLOCK_INPUT;
8103 #endif
8105 return font_object;
8109 /***********************************************************************
8110 X Input Methods
8111 ***********************************************************************/
8113 #ifdef HAVE_X_I18N
8115 #ifdef HAVE_X11R6
8117 /* XIM destroy callback function, which is called whenever the
8118 connection to input method XIM dies. CLIENT_DATA contains a
8119 pointer to the x_display_info structure corresponding to XIM. */
8121 static void
8122 xim_destroy_callback (xim, client_data, call_data)
8123 XIM xim;
8124 XPointer client_data;
8125 XPointer call_data;
8127 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
8128 Lisp_Object frame, tail;
8130 BLOCK_INPUT;
8132 /* No need to call XDestroyIC.. */
8133 FOR_EACH_FRAME (tail, frame)
8135 struct frame *f = XFRAME (frame);
8136 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
8138 FRAME_XIC (f) = NULL;
8139 xic_free_xfontset (f);
8143 /* No need to call XCloseIM. */
8144 dpyinfo->xim = NULL;
8145 XFree (dpyinfo->xim_styles);
8146 UNBLOCK_INPUT;
8149 #endif /* HAVE_X11R6 */
8151 #ifdef HAVE_X11R6
8152 /* This isn't prototyped in OSF 5.0 or 5.1a. */
8153 extern char *XSetIMValues P_ ((XIM, ...));
8154 #endif
8156 /* Open the connection to the XIM server on display DPYINFO.
8157 RESOURCE_NAME is the resource name Emacs uses. */
8159 static void
8160 xim_open_dpy (dpyinfo, resource_name)
8161 struct x_display_info *dpyinfo;
8162 char *resource_name;
8164 XIM xim;
8166 #ifdef HAVE_XIM
8167 if (use_xim)
8169 if (dpyinfo->xim)
8170 XCloseIM (dpyinfo->xim);
8171 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8172 EMACS_CLASS);
8173 dpyinfo->xim = xim;
8175 if (xim)
8177 #ifdef HAVE_X11R6
8178 XIMCallback destroy;
8179 #endif
8181 /* Get supported styles and XIM values. */
8182 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8184 #ifdef HAVE_X11R6
8185 destroy.callback = xim_destroy_callback;
8186 destroy.client_data = (XPointer)dpyinfo;
8187 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8188 #endif
8192 else
8193 #endif /* HAVE_XIM */
8194 dpyinfo->xim = NULL;
8198 #ifdef HAVE_X11R6_XIM
8200 /* XIM instantiate callback function, which is called whenever an XIM
8201 server is available. DISPLAY is the display of the XIM.
8202 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8203 when the callback was registered. */
8205 static void
8206 xim_instantiate_callback (display, client_data, call_data)
8207 Display *display;
8208 XPointer client_data;
8209 XPointer call_data;
8211 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8212 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8214 /* We don't support multiple XIM connections. */
8215 if (dpyinfo->xim)
8216 return;
8218 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8220 /* Create XIC for the existing frames on the same display, as long
8221 as they have no XIC. */
8222 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8224 Lisp_Object tail, frame;
8226 BLOCK_INPUT;
8227 FOR_EACH_FRAME (tail, frame)
8229 struct frame *f = XFRAME (frame);
8231 if (FRAME_X_P (f)
8232 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8233 if (FRAME_XIC (f) == NULL)
8235 create_frame_xic (f);
8236 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8237 xic_set_statusarea (f);
8238 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8240 struct window *w = XWINDOW (f->selected_window);
8241 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8246 UNBLOCK_INPUT;
8250 #endif /* HAVE_X11R6_XIM */
8253 /* Open a connection to the XIM server on display DPYINFO.
8254 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8255 connection only at the first time. On X11R6, open the connection
8256 in the XIM instantiate callback function. */
8258 static void
8259 xim_initialize (dpyinfo, resource_name)
8260 struct x_display_info *dpyinfo;
8261 char *resource_name;
8263 dpyinfo->xim = NULL;
8264 #ifdef HAVE_XIM
8265 if (use_xim)
8267 #ifdef HAVE_X11R6_XIM
8268 struct xim_inst_t *xim_inst;
8269 int len;
8271 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
8272 dpyinfo->xim_callback_data = xim_inst;
8273 xim_inst->dpyinfo = dpyinfo;
8274 len = strlen (resource_name);
8275 xim_inst->resource_name = (char *) xmalloc (len + 1);
8276 bcopy (resource_name, xim_inst->resource_name, len + 1);
8277 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8278 resource_name, EMACS_CLASS,
8279 xim_instantiate_callback,
8280 /* This is XPointer in XFree86
8281 but (XPointer *) on Tru64, at
8282 least, hence the configure test. */
8283 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8284 #else /* not HAVE_X11R6_XIM */
8285 xim_open_dpy (dpyinfo, resource_name);
8286 #endif /* not HAVE_X11R6_XIM */
8288 #endif /* HAVE_XIM */
8292 /* Close the connection to the XIM server on display DPYINFO. */
8294 static void
8295 xim_close_dpy (dpyinfo)
8296 struct x_display_info *dpyinfo;
8298 #ifdef HAVE_XIM
8299 if (use_xim)
8301 #ifdef HAVE_X11R6_XIM
8302 if (dpyinfo->display)
8303 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8304 NULL, EMACS_CLASS,
8305 xim_instantiate_callback, NULL);
8306 xfree (dpyinfo->xim_callback_data->resource_name);
8307 xfree (dpyinfo->xim_callback_data);
8308 #endif /* HAVE_X11R6_XIM */
8309 if (dpyinfo->display)
8310 XCloseIM (dpyinfo->xim);
8311 dpyinfo->xim = NULL;
8312 XFree (dpyinfo->xim_styles);
8314 #endif /* HAVE_XIM */
8317 #endif /* not HAVE_X11R6_XIM */
8321 /* Calculate the absolute position in frame F
8322 from its current recorded position values and gravity. */
8324 void
8325 x_calc_absolute_position (f)
8326 struct frame *f;
8328 int flags = f->size_hint_flags;
8330 /* We have nothing to do if the current position
8331 is already for the top-left corner. */
8332 if (! ((flags & XNegative) || (flags & YNegative)))
8333 return;
8335 /* Treat negative positions as relative to the leftmost bottommost
8336 position that fits on the screen. */
8337 if (flags & XNegative)
8338 f->left_pos = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
8339 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8342 int height = FRAME_PIXEL_HEIGHT (f);
8344 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8345 /* Something is fishy here. When using Motif, starting Emacs with
8346 `-g -0-0', the frame appears too low by a few pixels.
8348 This seems to be so because initially, while Emacs is starting,
8349 the column widget's height and the frame's pixel height are
8350 different. The column widget's height is the right one. In
8351 later invocations, when Emacs is up, the frame's pixel height
8352 is right, though.
8354 It's not obvious where the initial small difference comes from.
8355 2000-12-01, gerd. */
8357 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8358 #endif
8360 if (flags & YNegative)
8361 f->top_pos = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
8362 - height + f->top_pos;
8365 /* The left_pos and top_pos
8366 are now relative to the top and left screen edges,
8367 so the flags should correspond. */
8368 f->size_hint_flags &= ~ (XNegative | YNegative);
8371 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8372 to really change the position, and 0 when calling from
8373 x_make_frame_visible (in that case, XOFF and YOFF are the current
8374 position values). It is -1 when calling from x_set_frame_parameters,
8375 which means, do adjust for borders but don't change the gravity. */
8377 void
8378 x_set_offset (f, xoff, yoff, change_gravity)
8379 struct frame *f;
8380 register int xoff, yoff;
8381 int change_gravity;
8383 int modified_top, modified_left;
8385 if (change_gravity > 0)
8387 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8388 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8390 f->top_pos = yoff;
8391 f->left_pos = xoff;
8392 f->size_hint_flags &= ~ (XNegative | YNegative);
8393 if (xoff < 0)
8394 f->size_hint_flags |= XNegative;
8395 if (yoff < 0)
8396 f->size_hint_flags |= YNegative;
8397 f->win_gravity = NorthWestGravity;
8399 x_calc_absolute_position (f);
8401 BLOCK_INPUT;
8402 x_wm_set_size_hint (f, (long) 0, 0);
8404 modified_left = f->left_pos;
8405 modified_top = f->top_pos;
8407 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8409 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8410 than the WM decorations. So we use the calculated offset instead
8411 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8412 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8413 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8416 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8417 modified_left, modified_top);
8419 x_sync_with_move (f, f->left_pos, f->top_pos,
8420 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8421 ? 1 : 0);
8423 /* change_gravity is non-zero when this function is called from Lisp to
8424 programmatically move a frame. In that case, we call
8425 x_check_expected_move to discover if we have a "Type A" or "Type B"
8426 window manager, and, for a "Type A" window manager, adjust the position
8427 of the frame.
8429 We call x_check_expected_move if a programmatic move occurred, and
8430 either the window manager type (A/B) is unknown or it is Type A but we
8431 need to compute the top/left offset adjustment for this frame. */
8433 if (change_gravity != 0 &&
8434 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8435 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8436 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8437 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8438 x_check_expected_move (f, modified_left, modified_top);
8440 UNBLOCK_INPUT;
8443 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8444 on the root window for frame F contains ATOMNAME.
8445 This is how a WM check shall be done according to the Window Manager
8446 Specification/Extended Window Manager Hints at
8447 http://freedesktop.org/wiki/Specifications/wm-spec. */
8449 static int
8450 wm_supports (f, atomname)
8451 struct frame *f;
8452 const char *atomname;
8454 Atom actual_type;
8455 unsigned long actual_size, bytes_remaining;
8456 int i, rc, actual_format;
8457 Atom prop_atom;
8458 Window wmcheck_window;
8459 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8460 Window target_window = dpyinfo->root_window;
8461 long max_len = 65536;
8462 Display *dpy = FRAME_X_DISPLAY (f);
8463 unsigned char *tmp_data = NULL;
8464 Atom target_type = XA_WINDOW;
8465 Atom want_atom;
8467 BLOCK_INPUT;
8469 prop_atom = XInternAtom (dpy, "_NET_SUPPORTING_WM_CHECK", False);
8471 x_catch_errors (dpy);
8472 rc = XGetWindowProperty (dpy, target_window,
8473 prop_atom, 0, max_len, False, target_type,
8474 &actual_type, &actual_format, &actual_size,
8475 &bytes_remaining, &tmp_data);
8477 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8479 if (tmp_data) XFree (tmp_data);
8480 x_uncatch_errors ();
8481 UNBLOCK_INPUT;
8482 return 0;
8485 wmcheck_window = *(Window *) tmp_data;
8486 XFree (tmp_data);
8488 /* Check if window exists. */
8489 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8490 x_sync (f);
8491 if (x_had_errors_p (dpy))
8493 x_uncatch_errors ();
8494 UNBLOCK_INPUT;
8495 return 0;
8498 if (dpyinfo->net_supported_window != wmcheck_window)
8500 /* Window changed, reload atoms */
8501 if (dpyinfo->net_supported_atoms != NULL)
8502 XFree (dpyinfo->net_supported_atoms);
8503 dpyinfo->net_supported_atoms = NULL;
8504 dpyinfo->nr_net_supported_atoms = 0;
8505 dpyinfo->net_supported_window = 0;
8507 target_type = XA_ATOM;
8508 prop_atom = XInternAtom (dpy, "_NET_SUPPORTED", False);
8509 tmp_data = NULL;
8510 rc = XGetWindowProperty (dpy, target_window,
8511 prop_atom, 0, max_len, False, target_type,
8512 &actual_type, &actual_format, &actual_size,
8513 &bytes_remaining, &tmp_data);
8515 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8517 if (tmp_data) XFree (tmp_data);
8518 x_uncatch_errors ();
8519 UNBLOCK_INPUT;
8520 return 0;
8523 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8524 dpyinfo->nr_net_supported_atoms = actual_size;
8525 dpyinfo->net_supported_window = wmcheck_window;
8528 rc = 0;
8529 want_atom = XInternAtom (dpy, atomname, False);
8531 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8532 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8534 x_uncatch_errors ();
8535 UNBLOCK_INPUT;
8537 return rc;
8540 static void
8541 set_wm_state (frame, add, what, what2)
8542 Lisp_Object frame;
8543 int add;
8544 const char *what;
8545 const char *what2;
8547 const char *atom = "_NET_WM_STATE";
8548 Fx_send_client_event (frame, make_number (0), frame,
8549 make_unibyte_string (atom, strlen (atom)),
8550 make_number (32),
8551 /* 1 = add, 0 = remove */
8552 Fcons
8553 (make_number (add ? 1 : 0),
8554 Fcons
8555 (make_unibyte_string (what, strlen (what)),
8556 what2 != 0
8557 ? Fcons (make_unibyte_string (what2, strlen (what2)),
8558 Qnil)
8559 : Qnil)));
8562 void
8563 x_set_sticky (f, new_value, old_value)
8564 struct frame *f;
8565 Lisp_Object new_value, old_value;
8567 Lisp_Object frame;
8569 XSETFRAME (frame, f);
8570 set_wm_state (frame, NILP (new_value) ? 0 : 1,
8571 "_NET_WM_STATE_STICKY", NULL);
8574 /* Return the current _NET_WM_STATE.
8575 SIZE_STATE is set to one of the FULLSCREEN_* values.
8576 STICKY is set to 1 if the sticky state is set, 0 if not. */
8578 static void
8579 get_current_vm_state (struct frame *f,
8580 Window window,
8581 int *size_state,
8582 int *sticky)
8584 Atom actual_type;
8585 unsigned long actual_size, bytes_remaining;
8586 int i, rc, actual_format;
8587 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8588 long max_len = 65536;
8589 Display *dpy = FRAME_X_DISPLAY (f);
8590 unsigned char *tmp_data = NULL;
8591 Atom target_type = XA_ATOM;
8593 *sticky = 0;
8594 *size_state = FULLSCREEN_NONE;
8596 BLOCK_INPUT;
8597 x_catch_errors (dpy);
8598 rc = XGetWindowProperty (dpy, window, dpyinfo->Xatom_net_wm_state,
8599 0, max_len, False, target_type,
8600 &actual_type, &actual_format, &actual_size,
8601 &bytes_remaining, &tmp_data);
8603 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
8605 if (tmp_data) XFree (tmp_data);
8606 x_uncatch_errors ();
8607 UNBLOCK_INPUT;
8608 return;
8611 x_uncatch_errors ();
8613 for (i = 0; i < actual_size; ++i)
8615 Atom a = ((Atom*)tmp_data)[i];
8616 if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
8618 if (*size_state == FULLSCREEN_HEIGHT)
8619 *size_state = FULLSCREEN_MAXIMIZED;
8620 else
8621 *size_state = FULLSCREEN_WIDTH;
8623 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
8625 if (*size_state == FULLSCREEN_WIDTH)
8626 *size_state = FULLSCREEN_MAXIMIZED;
8627 else
8628 *size_state = FULLSCREEN_HEIGHT;
8630 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen_atom)
8631 *size_state = FULLSCREEN_BOTH;
8632 else if (a == dpyinfo->Xatom_net_wm_state_sticky)
8633 *sticky = 1;
8636 if (tmp_data) XFree (tmp_data);
8637 UNBLOCK_INPUT;
8640 /* Do fullscreen as specified in extended window manager hints */
8642 static int
8643 do_ewmh_fullscreen (f)
8644 struct frame *f;
8646 int have_net_atom = wm_supports (f, "_NET_WM_STATE");
8647 Lisp_Object lval = get_frame_param (f, Qfullscreen);
8648 int cur, dummy;
8650 get_current_vm_state (f, FRAME_OUTER_WINDOW (f), &cur, &dummy);
8652 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8653 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8654 if (!have_net_atom)
8655 have_net_atom = wm_supports (f, "_NET_WM_STATE_FULLSCREEN");
8657 if (have_net_atom && cur != f->want_fullscreen)
8659 Lisp_Object frame;
8660 const char *fs = "_NET_WM_STATE_FULLSCREEN";
8661 const char *fw = "_NET_WM_STATE_MAXIMIZED_HORZ";
8662 const char *fh = "_NET_WM_STATE_MAXIMIZED_VERT";
8664 XSETFRAME (frame, f);
8666 /* Keep number of calls to set_wm_state as low as possible.
8667 Some window managers, or possible Gtk+, hangs when too many
8668 are sent at once. */
8669 switch (f->want_fullscreen)
8671 case FULLSCREEN_BOTH:
8672 if (cur == FULLSCREEN_WIDTH || cur == FULLSCREEN_MAXIMIZED
8673 || cur == FULLSCREEN_HEIGHT)
8674 set_wm_state (frame, 0, fw, fh);
8675 set_wm_state (frame, 1, fs, NULL);
8676 break;
8677 case FULLSCREEN_WIDTH:
8678 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_HEIGHT
8679 || cur == FULLSCREEN_MAXIMIZED)
8680 set_wm_state (frame, 0, fs, fh);
8681 if (cur != FULLSCREEN_MAXIMIZED)
8682 set_wm_state (frame, 1, fw, NULL);
8683 break;
8684 case FULLSCREEN_HEIGHT:
8685 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_WIDTH
8686 || cur == FULLSCREEN_MAXIMIZED)
8687 set_wm_state (frame, 0, fs, fw);
8688 if (cur != FULLSCREEN_MAXIMIZED)
8689 set_wm_state (frame, 1, fh, NULL);
8690 break;
8691 case FULLSCREEN_MAXIMIZED:
8692 if (cur == FULLSCREEN_BOTH)
8693 set_wm_state (frame, 0, fs, NULL);
8694 set_wm_state (frame, 1, fw, fh);
8695 break;
8696 case FULLSCREEN_NONE:
8697 if (cur == FULLSCREEN_BOTH)
8698 set_wm_state (frame, 0, fs, NULL);
8699 else
8700 set_wm_state (frame, 0, fw, fh);
8703 f->want_fullscreen = FULLSCREEN_NONE;
8707 return have_net_atom;
8710 static void
8711 XTfullscreen_hook (f)
8712 FRAME_PTR f;
8714 if (f->async_visible)
8716 BLOCK_INPUT;
8717 x_check_fullscreen (f);
8718 x_sync (f);
8719 UNBLOCK_INPUT;
8724 static void
8725 x_handle_net_wm_state (f, event)
8726 struct frame *f;
8727 XPropertyEvent *event;
8729 int value = FULLSCREEN_NONE;
8730 Lisp_Object lval;
8731 int sticky = 0;
8733 get_current_vm_state (f, event->window, &value, &sticky);
8734 lval = Qnil;
8735 switch (value)
8737 case FULLSCREEN_WIDTH:
8738 lval = Qfullwidth;
8739 break;
8740 case FULLSCREEN_HEIGHT:
8741 lval = Qfullheight;
8742 break;
8743 case FULLSCREEN_BOTH:
8744 lval = Qfullboth;
8745 break;
8746 case FULLSCREEN_MAXIMIZED:
8747 lval = Qmaximized;
8748 break;
8751 store_frame_param (f, Qfullscreen, lval);
8752 store_frame_param (f, Qsticky, sticky ? Qt : Qnil);
8755 /* Check if we need to resize the frame due to a fullscreen request.
8756 If so needed, resize the frame. */
8757 static void
8758 x_check_fullscreen (f)
8759 struct frame *f;
8761 if (do_ewmh_fullscreen (f))
8762 return;
8764 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
8765 return; /* Only fullscreen without WM or with EWM hints (above). */
8767 /* Setting fullscreen to nil doesn't do anything. We could save the
8768 last non-fullscreen size and restore it, but it seems like a
8769 lot of work for this unusual case (no window manager running). */
8771 if (f->want_fullscreen != FULLSCREEN_NONE)
8773 int width = FRAME_PIXEL_WIDTH (f), height = FRAME_PIXEL_HEIGHT (f);
8774 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8776 switch (f->want_fullscreen)
8778 /* No difference between these two when there is no WM */
8779 case FULLSCREEN_BOTH:
8780 case FULLSCREEN_MAXIMIZED:
8781 width = x_display_pixel_width (dpyinfo);
8782 height = x_display_pixel_height (dpyinfo);
8783 break;
8784 case FULLSCREEN_WIDTH:
8785 width = x_display_pixel_width (dpyinfo);
8786 break;
8787 case FULLSCREEN_HEIGHT:
8788 height = x_display_pixel_height (dpyinfo);
8791 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8792 width, height);
8796 /* This function is called by x_set_offset to determine whether the window
8797 manager interfered with the positioning of the frame. Type A window
8798 managers position the surrounding window manager decorations a small
8799 amount above and left of the user-supplied position. Type B window
8800 managers position the surrounding window manager decorations at the
8801 user-specified position. If we detect a Type A window manager, we
8802 compensate by moving the window right and down by the proper amount. */
8804 static void
8805 x_check_expected_move (f, expected_left, expected_top)
8806 struct frame *f;
8807 int expected_left;
8808 int expected_top;
8810 int current_left = 0, current_top = 0;
8812 /* x_real_positions returns the left and top offsets of the outermost
8813 window manager window around the frame. */
8815 x_real_positions (f, &current_left, &current_top);
8817 if (current_left != expected_left || current_top != expected_top)
8819 /* It's a "Type A" window manager. */
8821 int adjusted_left;
8822 int adjusted_top;
8824 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8825 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8826 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8828 /* Now fix the mispositioned frame's location. */
8830 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8831 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8833 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8834 adjusted_left, adjusted_top);
8836 x_sync_with_move (f, expected_left, expected_top, 0);
8838 else
8839 /* It's a "Type B" window manager. We don't have to adjust the
8840 frame's position. */
8842 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8846 /* Wait for XGetGeometry to return up-to-date position information for a
8847 recently-moved frame. Call this immediately after calling XMoveWindow.
8848 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8849 frame has been moved to, so we use a fuzzy position comparison instead
8850 of an exact comparison. */
8852 static void
8853 x_sync_with_move (f, left, top, fuzzy)
8854 struct frame *f;
8855 int left, top, fuzzy;
8857 int count = 0;
8859 while (count++ < 50)
8861 int current_left = 0, current_top = 0;
8863 /* In theory, this call to XSync only needs to happen once, but in
8864 practice, it doesn't seem to work, hence the need for the surrounding
8865 loop. */
8867 XSync (FRAME_X_DISPLAY (f), False);
8868 x_real_positions (f, &current_left, &current_top);
8870 if (fuzzy)
8872 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8873 pixels. */
8875 if (eabs (current_left - left) <= 10
8876 && eabs (current_top - top) <= 40)
8877 return;
8879 else if (current_left == left && current_top == top)
8880 return;
8883 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8884 will then return up-to-date position info. */
8886 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8890 /* Wait for an event on frame F matching EVENTTYPE. */
8891 void
8892 x_wait_for_event (f, eventtype)
8893 struct frame *f;
8894 int eventtype;
8896 int level = interrupt_input_blocked;
8898 SELECT_TYPE fds;
8899 EMACS_TIME tmo, tmo_at, time_now;
8900 int fd = ConnectionNumber (FRAME_X_DISPLAY (f));
8902 pending_event_wait.f = f;
8903 pending_event_wait.eventtype = eventtype;
8905 /* Set timeout to 0.1 second. Hopefully not noticable.
8906 Maybe it should be configurable. */
8907 EMACS_SET_SECS_USECS (tmo, 0, 100000);
8908 EMACS_GET_TIME (tmo_at);
8909 EMACS_ADD_TIME (tmo_at, tmo_at, tmo);
8911 while (pending_event_wait.eventtype)
8913 interrupt_input_pending = 1;
8914 TOTALLY_UNBLOCK_INPUT;
8915 /* XTread_socket is called after unblock. */
8916 BLOCK_INPUT;
8917 interrupt_input_blocked = level;
8919 FD_ZERO (&fds);
8920 FD_SET (fd, &fds);
8922 EMACS_GET_TIME (time_now);
8923 EMACS_SUB_TIME (tmo, tmo_at, time_now);
8925 if (EMACS_TIME_NEG_P (tmo) || select (fd+1, &fds, NULL, NULL, &tmo) == 0)
8926 break; /* Timeout */
8928 pending_event_wait.f = 0;
8929 pending_event_wait.eventtype = 0;
8933 /* Change the size of frame F's X window to COLS/ROWS in the case F
8934 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8935 top-left-corner window gravity for this size change and subsequent
8936 size changes. Otherwise we leave the window gravity unchanged. */
8938 static void
8939 x_set_window_size_1 (f, change_gravity, cols, rows)
8940 struct frame *f;
8941 int change_gravity;
8942 int cols, rows;
8944 int pixelwidth, pixelheight;
8946 check_frame_size (f, &rows, &cols);
8947 f->scroll_bar_actual_width
8948 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8950 : FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0
8951 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)
8952 : (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)));
8954 compute_fringe_widths (f, 0);
8956 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols);
8957 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
8958 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f);
8960 if (change_gravity) f->win_gravity = NorthWestGravity;
8961 x_wm_set_size_hint (f, (long) 0, 0);
8962 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8963 pixelwidth, pixelheight);
8966 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8967 receive in the ConfigureNotify event; if we get what we asked
8968 for, then the event won't cause the screen to become garbaged, so
8969 we have to make sure to do it here. */
8970 SET_FRAME_GARBAGED (f);
8972 /* Now, strictly speaking, we can't be sure that this is accurate,
8973 but the window manager will get around to dealing with the size
8974 change request eventually, and we'll hear how it went when the
8975 ConfigureNotify event gets here.
8977 We could just not bother storing any of this information here,
8978 and let the ConfigureNotify event set everything up, but that
8979 might be kind of confusing to the Lisp code, since size changes
8980 wouldn't be reported in the frame parameters until some random
8981 point in the future when the ConfigureNotify event arrives.
8983 We pass 1 for DELAY since we can't run Lisp code inside of
8984 a BLOCK_INPUT. */
8986 /* But the ConfigureNotify may in fact never arrive, and then this is
8987 not right if the frame is visible. Instead wait (with timeout)
8988 for the ConfigureNotify. */
8989 if (f->async_visible)
8990 x_wait_for_event (f, ConfigureNotify);
8991 else
8993 change_frame_size (f, rows, cols, 0, 1, 0);
8994 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8995 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8996 x_sync (f);
9001 /* Call this to change the size of frame F's x-window.
9002 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
9003 for this size change and subsequent size changes.
9004 Otherwise we leave the window gravity unchanged. */
9006 void
9007 x_set_window_size (f, change_gravity, cols, rows)
9008 struct frame *f;
9009 int change_gravity;
9010 int cols, rows;
9012 BLOCK_INPUT;
9014 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
9016 int r, c;
9018 /* When the frame is maximized/fullscreen or running under for
9019 example Xmonad, x_set_window_size_1 will be a no-op.
9020 In that case, the right thing to do is extend rows/cols to
9021 the current frame size. We do that first if x_set_window_size_1
9022 turns out to not be a no-op (there is no way to know).
9023 The size will be adjusted again if the frame gets a
9024 ConfigureNotify event as a result of x_set_window_size. */
9025 int pixelh = FRAME_PIXEL_HEIGHT (f);
9026 #ifdef USE_X_TOOLKIT
9027 /* The menu bar is not part of text lines. The tool bar
9028 is however. */
9029 pixelh -= FRAME_MENUBAR_HEIGHT (f);
9030 #endif
9031 r = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelh);
9032 /* Update f->scroll_bar_actual_width because it is used in
9033 FRAME_PIXEL_WIDTH_TO_TEXT_COLS. */
9034 f->scroll_bar_actual_width
9035 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
9036 c = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, FRAME_PIXEL_WIDTH (f));
9037 change_frame_size (f, r, c, 0, 1, 0);
9040 #ifdef USE_GTK
9041 if (FRAME_GTK_WIDGET (f))
9042 xg_frame_set_char_size (f, cols, rows);
9043 else
9044 x_set_window_size_1 (f, change_gravity, cols, rows);
9045 #else /* not USE_GTK */
9047 x_set_window_size_1 (f, change_gravity, cols, rows);
9049 #endif /* not USE_GTK */
9051 /* If cursor was outside the new size, mark it as off. */
9052 mark_window_cursors_off (XWINDOW (f->root_window));
9054 /* Clear out any recollection of where the mouse highlighting was,
9055 since it might be in a place that's outside the new frame size.
9056 Actually checking whether it is outside is a pain in the neck,
9057 so don't try--just let the highlighting be done afresh with new size. */
9058 cancel_mouse_face (f);
9060 UNBLOCK_INPUT;
9063 /* Mouse warping. */
9065 void
9066 x_set_mouse_position (f, x, y)
9067 struct frame *f;
9068 int x, y;
9070 int pix_x, pix_y;
9072 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
9073 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
9075 if (pix_x < 0) pix_x = 0;
9076 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
9078 if (pix_y < 0) pix_y = 0;
9079 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
9081 BLOCK_INPUT;
9083 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
9084 0, 0, 0, 0, pix_x, pix_y);
9085 UNBLOCK_INPUT;
9088 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
9090 void
9091 x_set_mouse_pixel_position (f, pix_x, pix_y)
9092 struct frame *f;
9093 int pix_x, pix_y;
9095 BLOCK_INPUT;
9097 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
9098 0, 0, 0, 0, pix_x, pix_y);
9099 UNBLOCK_INPUT;
9102 /* focus shifting, raising and lowering. */
9104 void
9105 x_focus_on_frame (f)
9106 struct frame *f;
9108 #if 0
9109 /* I don't think that the ICCCM allows programs to do things like this
9110 without the interaction of the window manager. Whatever you end up
9111 doing with this code, do it to x_unfocus_frame too. */
9112 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
9113 RevertToPointerRoot, CurrentTime);
9114 #endif /* ! 0 */
9117 void
9118 x_unfocus_frame (f)
9119 struct frame *f;
9121 #if 0
9122 /* Look at the remarks in x_focus_on_frame. */
9123 if (FRAME_X_DISPLAY_INFO (f)->x_focus_frame == f)
9124 XSetInputFocus (FRAME_X_DISPLAY (f), PointerRoot,
9125 RevertToPointerRoot, CurrentTime);
9126 #endif /* ! 0 */
9129 /* Raise frame F. */
9131 void
9132 x_raise_frame (f)
9133 struct frame *f;
9135 BLOCK_INPUT;
9136 if (f->async_visible)
9137 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
9139 XFlush (FRAME_X_DISPLAY (f));
9140 UNBLOCK_INPUT;
9143 /* Lower frame F. */
9145 void
9146 x_lower_frame (f)
9147 struct frame *f;
9149 if (f->async_visible)
9151 BLOCK_INPUT;
9152 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
9153 XFlush (FRAME_X_DISPLAY (f));
9154 UNBLOCK_INPUT;
9158 /* Activate frame with Extended Window Manager Hints */
9160 void
9161 x_ewmh_activate_frame (f)
9162 FRAME_PTR f;
9164 /* See Window Manager Specification/Extended Window Manager Hints at
9165 http://freedesktop.org/wiki/Specifications/wm-spec */
9167 const char *atom = "_NET_ACTIVE_WINDOW";
9168 if (f->async_visible && wm_supports (f, atom))
9170 Lisp_Object frame;
9171 XSETFRAME (frame, f);
9172 Fx_send_client_event (frame, make_number (0), frame,
9173 make_unibyte_string (atom, strlen (atom)),
9174 make_number (32),
9175 Fcons (make_number (1),
9176 Fcons (make_number (last_user_time),
9177 Qnil)));
9181 static void
9182 XTframe_raise_lower (f, raise_flag)
9183 FRAME_PTR f;
9184 int raise_flag;
9186 if (raise_flag)
9187 x_raise_frame (f);
9188 else
9189 x_lower_frame (f);
9192 /* XEmbed implementation. */
9194 void
9195 xembed_set_info (f, flags)
9196 struct frame *f;
9197 enum xembed_info flags;
9199 Atom atom;
9200 unsigned long data[2];
9202 atom = XInternAtom (FRAME_X_DISPLAY (f), "_XEMBED_INFO", False);
9204 data[0] = XEMBED_VERSION;
9205 data[1] = flags;
9207 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), atom, atom,
9208 32, PropModeReplace, (unsigned char *) data, 2);
9211 void
9212 xembed_send_message (f, time, message, detail, data1, data2)
9213 struct frame *f;
9214 Time time;
9215 enum xembed_message message;
9216 long detail;
9217 long data1;
9218 long data2;
9220 XEvent event;
9222 event.xclient.type = ClientMessage;
9223 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
9224 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
9225 event.xclient.format = 32;
9226 event.xclient.data.l[0] = time;
9227 event.xclient.data.l[1] = message;
9228 event.xclient.data.l[2] = detail;
9229 event.xclient.data.l[3] = data1;
9230 event.xclient.data.l[4] = data2;
9232 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9233 False, NoEventMask, &event);
9234 XSync (FRAME_X_DISPLAY (f), False);
9237 /* Change of visibility. */
9239 /* This tries to wait until the frame is really visible.
9240 However, if the window manager asks the user where to position
9241 the frame, this will return before the user finishes doing that.
9242 The frame will not actually be visible at that time,
9243 but it will become visible later when the window manager
9244 finishes with it. */
9246 void
9247 x_make_frame_visible (f)
9248 struct frame *f;
9250 Lisp_Object type;
9251 int original_top, original_left;
9252 int retry_count = 2;
9254 retry:
9256 BLOCK_INPUT;
9258 type = x_icon_type (f);
9259 if (!NILP (type))
9260 x_bitmap_icon (f, type);
9262 if (! FRAME_VISIBLE_P (f))
9264 /* We test FRAME_GARBAGED_P here to make sure we don't
9265 call x_set_offset a second time
9266 if we get to x_make_frame_visible a second time
9267 before the window gets really visible. */
9268 if (! FRAME_ICONIFIED_P (f)
9269 && ! FRAME_X_EMBEDDED_P (f)
9270 && ! f->output_data.x->asked_for_visible)
9271 x_set_offset (f, f->left_pos, f->top_pos, 0);
9273 f->output_data.x->asked_for_visible = 1;
9275 if (! EQ (Vx_no_window_manager, Qt))
9276 x_wm_set_window_state (f, NormalState);
9277 #ifdef USE_X_TOOLKIT
9278 if (FRAME_X_EMBEDDED_P (f))
9279 xembed_set_info (f, XEMBED_MAPPED);
9280 else
9282 /* This was XtPopup, but that did nothing for an iconified frame. */
9283 XtMapWidget (f->output_data.x->widget);
9285 #else /* not USE_X_TOOLKIT */
9286 #ifdef USE_GTK
9287 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9288 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9289 #else
9290 if (FRAME_X_EMBEDDED_P (f))
9291 xembed_set_info (f, XEMBED_MAPPED);
9292 else
9293 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9294 #endif /* not USE_GTK */
9295 #endif /* not USE_X_TOOLKIT */
9298 XFlush (FRAME_X_DISPLAY (f));
9300 /* Synchronize to ensure Emacs knows the frame is visible
9301 before we do anything else. We do this loop with input not blocked
9302 so that incoming events are handled. */
9304 Lisp_Object frame;
9305 int count;
9306 /* This must be before UNBLOCK_INPUT
9307 since events that arrive in response to the actions above
9308 will set it when they are handled. */
9309 int previously_visible = f->output_data.x->has_been_visible;
9311 original_left = f->left_pos;
9312 original_top = f->top_pos;
9314 /* This must come after we set COUNT. */
9315 UNBLOCK_INPUT;
9317 /* We unblock here so that arriving X events are processed. */
9319 /* Now move the window back to where it was "supposed to be".
9320 But don't do it if the gravity is negative.
9321 When the gravity is negative, this uses a position
9322 that is 3 pixels too low. Perhaps that's really the border width.
9324 Don't do this if the window has never been visible before,
9325 because the window manager may choose the position
9326 and we don't want to override it. */
9328 if (! FRAME_VISIBLE_P (f)
9329 && ! FRAME_ICONIFIED_P (f)
9330 && ! FRAME_X_EMBEDDED_P (f)
9331 && f->win_gravity == NorthWestGravity
9332 && previously_visible)
9334 Drawable rootw;
9335 int x, y;
9336 unsigned int width, height, border, depth;
9338 BLOCK_INPUT;
9340 /* On some window managers (such as FVWM) moving an existing
9341 window, even to the same place, causes the window manager
9342 to introduce an offset. This can cause the window to move
9343 to an unexpected location. Check the geometry (a little
9344 slow here) and then verify that the window is in the right
9345 place. If the window is not in the right place, move it
9346 there, and take the potential window manager hit. */
9347 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9348 &rootw, &x, &y, &width, &height, &border, &depth);
9350 if (original_left != x || original_top != y)
9351 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9352 original_left, original_top);
9354 UNBLOCK_INPUT;
9357 XSETFRAME (frame, f);
9359 /* Wait until the frame is visible. Process X events until a
9360 MapNotify event has been seen, or until we think we won't get a
9361 MapNotify at all.. */
9362 for (count = input_signal_count + 10;
9363 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9365 /* Force processing of queued events. */
9366 x_sync (f);
9368 /* Machines that do polling rather than SIGIO have been
9369 observed to go into a busy-wait here. So we'll fake an
9370 alarm signal to let the handler know that there's something
9371 to be read. We used to raise a real alarm, but it seems
9372 that the handler isn't always enabled here. This is
9373 probably a bug. */
9374 if (input_polling_used ())
9376 /* It could be confusing if a real alarm arrives while
9377 processing the fake one. Turn it off and let the
9378 handler reset it. */
9379 extern void poll_for_input_1 P_ ((void));
9380 int old_poll_suppress_count = poll_suppress_count;
9381 poll_suppress_count = 1;
9382 poll_for_input_1 ();
9383 poll_suppress_count = old_poll_suppress_count;
9386 /* See if a MapNotify event has been processed. */
9387 FRAME_SAMPLE_VISIBILITY (f);
9390 /* 2000-09-28: In
9392 (let ((f (selected-frame)))
9393 (iconify-frame f)
9394 (raise-frame f))
9396 the frame is not raised with various window managers on
9397 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9398 unknown reason, the call to XtMapWidget is completely ignored.
9399 Mapping the widget a second time works. */
9401 if (!FRAME_VISIBLE_P (f) && --retry_count > 0)
9402 goto retry;
9406 /* Change from mapped state to withdrawn state. */
9408 /* Make the frame visible (mapped and not iconified). */
9410 void
9411 x_make_frame_invisible (f)
9412 struct frame *f;
9414 Window window;
9416 /* Use the frame's outermost window, not the one we normally draw on. */
9417 window = FRAME_OUTER_WINDOW (f);
9419 /* Don't keep the highlight on an invisible frame. */
9420 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9421 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9423 BLOCK_INPUT;
9425 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9426 that the current position of the window is user-specified, rather than
9427 program-specified, so that when the window is mapped again, it will be
9428 placed at the same location, without forcing the user to position it
9429 by hand again (they have already done that once for this window.) */
9430 x_wm_set_size_hint (f, (long) 0, 1);
9432 #ifdef USE_GTK
9433 if (FRAME_GTK_OUTER_WIDGET (f))
9434 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9435 else
9436 #else
9437 if (FRAME_X_EMBEDDED_P (f))
9438 xembed_set_info (f, 0);
9439 else
9440 #endif
9443 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9444 DefaultScreen (FRAME_X_DISPLAY (f))))
9446 UNBLOCK_INPUT_RESIGNAL;
9447 error ("Can't notify window manager of window withdrawal");
9451 /* We can't distinguish this from iconification
9452 just by the event that we get from the server.
9453 So we can't win using the usual strategy of letting
9454 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9455 and synchronize with the server to make sure we agree. */
9456 f->visible = 0;
9457 FRAME_ICONIFIED_P (f) = 0;
9458 f->async_visible = 0;
9459 f->async_iconified = 0;
9461 x_sync (f);
9463 UNBLOCK_INPUT;
9466 /* Change window state from mapped to iconified. */
9468 void
9469 x_iconify_frame (f)
9470 struct frame *f;
9472 int result;
9473 Lisp_Object type;
9475 /* Don't keep the highlight on an invisible frame. */
9476 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9477 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9479 if (f->async_iconified)
9480 return;
9482 BLOCK_INPUT;
9484 FRAME_SAMPLE_VISIBILITY (f);
9486 type = x_icon_type (f);
9487 if (!NILP (type))
9488 x_bitmap_icon (f, type);
9490 #ifdef USE_GTK
9491 if (FRAME_GTK_OUTER_WIDGET (f))
9493 if (! FRAME_VISIBLE_P (f))
9494 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9496 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9497 f->iconified = 1;
9498 f->visible = 1;
9499 f->async_iconified = 1;
9500 f->async_visible = 0;
9501 UNBLOCK_INPUT;
9502 return;
9504 #endif
9506 #ifdef USE_X_TOOLKIT
9508 if (! FRAME_VISIBLE_P (f))
9510 if (! EQ (Vx_no_window_manager, Qt))
9511 x_wm_set_window_state (f, IconicState);
9512 /* This was XtPopup, but that did nothing for an iconified frame. */
9513 XtMapWidget (f->output_data.x->widget);
9514 /* The server won't give us any event to indicate
9515 that an invisible frame was changed to an icon,
9516 so we have to record it here. */
9517 f->iconified = 1;
9518 f->visible = 1;
9519 f->async_iconified = 1;
9520 f->async_visible = 0;
9521 UNBLOCK_INPUT;
9522 return;
9525 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9526 XtWindow (f->output_data.x->widget),
9527 DefaultScreen (FRAME_X_DISPLAY (f)));
9528 UNBLOCK_INPUT;
9530 if (!result)
9531 error ("Can't notify window manager of iconification");
9533 f->async_iconified = 1;
9534 f->async_visible = 0;
9537 BLOCK_INPUT;
9538 XFlush (FRAME_X_DISPLAY (f));
9539 UNBLOCK_INPUT;
9540 #else /* not USE_X_TOOLKIT */
9542 /* Make sure the X server knows where the window should be positioned,
9543 in case the user deiconifies with the window manager. */
9544 if (! FRAME_VISIBLE_P (f)
9545 && ! FRAME_ICONIFIED_P (f)
9546 && ! FRAME_X_EMBEDDED_P (f))
9547 x_set_offset (f, f->left_pos, f->top_pos, 0);
9549 /* Since we don't know which revision of X we're running, we'll use both
9550 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9552 /* X11R4: send a ClientMessage to the window manager using the
9553 WM_CHANGE_STATE type. */
9555 XEvent message;
9557 message.xclient.window = FRAME_X_WINDOW (f);
9558 message.xclient.type = ClientMessage;
9559 message.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9560 message.xclient.format = 32;
9561 message.xclient.data.l[0] = IconicState;
9563 if (! XSendEvent (FRAME_X_DISPLAY (f),
9564 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9565 False,
9566 SubstructureRedirectMask | SubstructureNotifyMask,
9567 &message))
9569 UNBLOCK_INPUT_RESIGNAL;
9570 error ("Can't notify window manager of iconification");
9574 /* X11R3: set the initial_state field of the window manager hints to
9575 IconicState. */
9576 x_wm_set_window_state (f, IconicState);
9578 if (!FRAME_VISIBLE_P (f))
9580 /* If the frame was withdrawn, before, we must map it. */
9581 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9584 f->async_iconified = 1;
9585 f->async_visible = 0;
9587 XFlush (FRAME_X_DISPLAY (f));
9588 UNBLOCK_INPUT;
9589 #endif /* not USE_X_TOOLKIT */
9593 /* Free X resources of frame F. */
9595 void
9596 x_free_frame_resources (f)
9597 struct frame *f;
9599 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9600 Lisp_Object bar;
9601 struct scroll_bar *b;
9603 BLOCK_INPUT;
9605 /* If a display connection is dead, don't try sending more
9606 commands to the X server. */
9607 if (dpyinfo->display)
9609 /* We must free faces before destroying windows because some
9610 font-driver (e.g. xft) access a window while finishing a
9611 face. */
9612 if (FRAME_FACE_CACHE (f))
9613 free_frame_faces (f);
9615 if (f->output_data.x->icon_desc)
9616 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9618 #ifdef USE_X_TOOLKIT
9619 /* Explicitly destroy the scroll bars of the frame. Without
9620 this, we get "BadDrawable" errors from the toolkit later on,
9621 presumably from expose events generated for the disappearing
9622 toolkit scroll bars. */
9623 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9625 b = XSCROLL_BAR (bar);
9626 x_scroll_bar_remove (b);
9628 #endif
9630 #ifdef HAVE_X_I18N
9631 if (FRAME_XIC (f))
9632 free_frame_xic (f);
9633 #endif
9635 #ifdef USE_X_TOOLKIT
9636 if (f->output_data.x->widget)
9638 XtDestroyWidget (f->output_data.x->widget);
9639 f->output_data.x->widget = NULL;
9641 /* Tooltips don't have widgets, only a simple X window, even if
9642 we are using a toolkit. */
9643 else if (FRAME_X_WINDOW (f))
9644 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9646 free_frame_menubar (f);
9647 #else /* !USE_X_TOOLKIT */
9649 #ifdef USE_GTK
9650 /* In the GTK version, tooltips are normal X
9651 frames. We must check and free both types. */
9652 if (FRAME_GTK_OUTER_WIDGET (f))
9654 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
9655 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow below */
9656 FRAME_GTK_OUTER_WIDGET (f) = 0;
9658 #endif /* USE_GTK */
9660 if (FRAME_X_WINDOW (f))
9661 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9662 #endif /* !USE_X_TOOLKIT */
9664 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9665 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9666 unload_color (f, f->output_data.x->cursor_pixel);
9667 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9668 unload_color (f, f->output_data.x->border_pixel);
9669 unload_color (f, f->output_data.x->mouse_pixel);
9671 if (f->output_data.x->scroll_bar_background_pixel != -1)
9672 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9673 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9674 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9675 #ifdef USE_TOOLKIT_SCROLL_BARS
9676 /* Scrollbar shadow colors. */
9677 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9678 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9679 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9680 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9681 #endif /* USE_TOOLKIT_SCROLL_BARS */
9682 if (f->output_data.x->white_relief.allocated_p)
9683 unload_color (f, f->output_data.x->white_relief.pixel);
9684 if (f->output_data.x->black_relief.allocated_p)
9685 unload_color (f, f->output_data.x->black_relief.pixel);
9687 x_free_gcs (f);
9688 XFlush (FRAME_X_DISPLAY (f));
9691 xfree (f->output_data.x->saved_menu_event);
9692 xfree (f->output_data.x);
9693 f->output_data.x = NULL;
9695 if (f == dpyinfo->x_focus_frame)
9696 dpyinfo->x_focus_frame = 0;
9697 if (f == dpyinfo->x_focus_event_frame)
9698 dpyinfo->x_focus_event_frame = 0;
9699 if (f == dpyinfo->x_highlight_frame)
9700 dpyinfo->x_highlight_frame = 0;
9702 if (f == dpyinfo->mouse_face_mouse_frame)
9704 dpyinfo->mouse_face_beg_row
9705 = dpyinfo->mouse_face_beg_col = -1;
9706 dpyinfo->mouse_face_end_row
9707 = dpyinfo->mouse_face_end_col = -1;
9708 dpyinfo->mouse_face_window = Qnil;
9709 dpyinfo->mouse_face_deferred_gc = 0;
9710 dpyinfo->mouse_face_mouse_frame = 0;
9713 UNBLOCK_INPUT;
9717 /* Destroy the X window of frame F. */
9719 void
9720 x_destroy_window (f)
9721 struct frame *f;
9723 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9725 /* If a display connection is dead, don't try sending more
9726 commands to the X server. */
9727 if (dpyinfo->display != 0)
9728 x_free_frame_resources (f);
9730 dpyinfo->reference_count--;
9734 /* Setting window manager hints. */
9736 /* Set the normal size hints for the window manager, for frame F.
9737 FLAGS is the flags word to use--or 0 meaning preserve the flags
9738 that the window now has.
9739 If USER_POSITION is nonzero, we set the USPosition
9740 flag (this is useful when FLAGS is 0).
9741 The GTK version is in gtkutils.c */
9743 #ifndef USE_GTK
9744 void
9745 x_wm_set_size_hint (f, flags, user_position)
9746 struct frame *f;
9747 long flags;
9748 int user_position;
9750 XSizeHints size_hints;
9751 Window window = FRAME_OUTER_WINDOW (f);
9753 /* Setting PMaxSize caused various problems. */
9754 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9756 size_hints.x = f->left_pos;
9757 size_hints.y = f->top_pos;
9759 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9760 size_hints.width = FRAME_PIXEL_WIDTH (f);
9762 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9763 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9764 size_hints.max_width = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
9765 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9766 size_hints.max_height = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
9767 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9769 /* Calculate the base and minimum sizes. */
9771 int base_width, base_height;
9772 int min_rows = 0, min_cols = 0;
9774 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9775 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9777 check_frame_size (f, &min_rows, &min_cols);
9779 /* The window manager uses the base width hints to calculate the
9780 current number of rows and columns in the frame while
9781 resizing; min_width and min_height aren't useful for this
9782 purpose, since they might not give the dimensions for a
9783 zero-row, zero-column frame.
9785 We use the base_width and base_height members if we have
9786 them; otherwise, we set the min_width and min_height members
9787 to the size for a zero x zero frame. */
9789 size_hints.flags |= PBaseSize;
9790 size_hints.base_width = base_width;
9791 size_hints.base_height = base_height + FRAME_MENUBAR_HEIGHT (f);
9792 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9793 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9796 /* If we don't need the old flags, we don't need the old hint at all. */
9797 if (flags)
9799 size_hints.flags |= flags;
9800 goto no_read;
9804 XSizeHints hints; /* Sometimes I hate X Windows... */
9805 long supplied_return;
9806 int value;
9808 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9809 &supplied_return);
9811 if (flags)
9812 size_hints.flags |= flags;
9813 else
9815 if (value == 0)
9816 hints.flags = 0;
9817 if (hints.flags & PSize)
9818 size_hints.flags |= PSize;
9819 if (hints.flags & PPosition)
9820 size_hints.flags |= PPosition;
9821 if (hints.flags & USPosition)
9822 size_hints.flags |= USPosition;
9823 if (hints.flags & USSize)
9824 size_hints.flags |= USSize;
9828 no_read:
9830 #ifdef PWinGravity
9831 size_hints.win_gravity = f->win_gravity;
9832 size_hints.flags |= PWinGravity;
9834 if (user_position)
9836 size_hints.flags &= ~ PPosition;
9837 size_hints.flags |= USPosition;
9839 #endif /* PWinGravity */
9841 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9843 #endif /* not USE_GTK */
9845 /* Used for IconicState or NormalState */
9847 void
9848 x_wm_set_window_state (f, state)
9849 struct frame *f;
9850 int state;
9852 #ifdef USE_X_TOOLKIT
9853 Arg al[1];
9855 XtSetArg (al[0], XtNinitialState, state);
9856 XtSetValues (f->output_data.x->widget, al, 1);
9857 #else /* not USE_X_TOOLKIT */
9858 Window window = FRAME_X_WINDOW (f);
9860 f->output_data.x->wm_hints.flags |= StateHint;
9861 f->output_data.x->wm_hints.initial_state = state;
9863 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9864 #endif /* not USE_X_TOOLKIT */
9867 void
9868 x_wm_set_icon_pixmap (f, pixmap_id)
9869 struct frame *f;
9870 int pixmap_id;
9872 Pixmap icon_pixmap, icon_mask;
9874 #if !defined USE_X_TOOLKIT && !defined USE_GTK
9875 Window window = FRAME_OUTER_WINDOW (f);
9876 #endif
9878 if (pixmap_id > 0)
9880 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9881 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9882 icon_mask = x_bitmap_mask (f, pixmap_id);
9883 f->output_data.x->wm_hints.icon_mask = icon_mask;
9885 else
9887 /* It seems there is no way to turn off use of an icon
9888 pixmap. */
9889 return;
9893 #ifdef USE_GTK
9895 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9896 return;
9899 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9902 Arg al[1];
9903 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9904 XtSetValues (f->output_data.x->widget, al, 1);
9905 XtSetArg (al[0], XtNiconMask, icon_mask);
9906 XtSetValues (f->output_data.x->widget, al, 1);
9909 #else /* not USE_X_TOOLKIT && not USE_GTK */
9911 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9912 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9914 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9917 void
9918 x_wm_set_icon_position (f, icon_x, icon_y)
9919 struct frame *f;
9920 int icon_x, icon_y;
9922 Window window = FRAME_OUTER_WINDOW (f);
9924 f->output_data.x->wm_hints.flags |= IconPositionHint;
9925 f->output_data.x->wm_hints.icon_x = icon_x;
9926 f->output_data.x->wm_hints.icon_y = icon_y;
9928 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9932 /***********************************************************************
9933 Fonts
9934 ***********************************************************************/
9936 #if GLYPH_DEBUG
9938 /* Check that FONT is valid on frame F. It is if it can be found in F's
9939 font table. */
9941 static void
9942 x_check_font (f, font)
9943 struct frame *f;
9944 struct font *font;
9946 Lisp_Object frame;
9948 xassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9949 if (font->driver->check)
9950 xassert (font->driver->check (f, font) == 0);
9953 #endif /* GLYPH_DEBUG != 0 */
9956 /***********************************************************************
9957 Initialization
9958 ***********************************************************************/
9960 #ifdef USE_X_TOOLKIT
9961 static XrmOptionDescRec emacs_options[] = {
9962 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9963 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9965 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9966 XrmoptionSepArg, NULL},
9967 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9969 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9970 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9971 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9972 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9973 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9974 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9975 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9978 /* Whether atimer for Xt timeouts is activated or not. */
9980 static int x_timeout_atimer_activated_flag;
9982 #endif /* USE_X_TOOLKIT */
9984 static int x_initialized;
9986 #ifdef HAVE_X_SM
9987 static int x_session_initialized;
9988 #endif
9990 /* Test whether two display-name strings agree up to the dot that separates
9991 the screen number from the server number. */
9992 static int
9993 same_x_server (name1, name2)
9994 const char *name1, *name2;
9996 int seen_colon = 0;
9997 const unsigned char *system_name = SDATA (Vsystem_name);
9998 int system_name_length = strlen (system_name);
9999 int length_until_period = 0;
10001 while (system_name[length_until_period] != 0
10002 && system_name[length_until_period] != '.')
10003 length_until_period++;
10005 /* Treat `unix' like an empty host name. */
10006 if (! strncmp (name1, "unix:", 5))
10007 name1 += 4;
10008 if (! strncmp (name2, "unix:", 5))
10009 name2 += 4;
10010 /* Treat this host's name like an empty host name. */
10011 if (! strncmp (name1, system_name, system_name_length)
10012 && name1[system_name_length] == ':')
10013 name1 += system_name_length;
10014 if (! strncmp (name2, system_name, system_name_length)
10015 && name2[system_name_length] == ':')
10016 name2 += system_name_length;
10017 /* Treat this host's domainless name like an empty host name. */
10018 if (! strncmp (name1, system_name, length_until_period)
10019 && name1[length_until_period] == ':')
10020 name1 += length_until_period;
10021 if (! strncmp (name2, system_name, length_until_period)
10022 && name2[length_until_period] == ':')
10023 name2 += length_until_period;
10025 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
10027 if (*name1 == ':')
10028 seen_colon++;
10029 if (seen_colon && *name1 == '.')
10030 return 1;
10032 return (seen_colon
10033 && (*name1 == '.' || *name1 == '\0')
10034 && (*name2 == '.' || *name2 == '\0'));
10037 /* Count number of set bits in mask and number of bits to shift to
10038 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
10039 to 5. */
10040 static void
10041 get_bits_and_offset (mask, bits, offset)
10042 unsigned long mask;
10043 int *bits;
10044 int *offset;
10046 int nr = 0;
10047 int off = 0;
10049 while (!(mask & 1))
10051 off++;
10052 mask >>= 1;
10055 while (mask & 1)
10057 nr++;
10058 mask >>= 1;
10061 *offset = off;
10062 *bits = nr;
10065 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
10066 But don't permanently open it, just test its availability. */
10069 x_display_ok (display)
10070 const char *display;
10072 int dpy_ok = 1;
10073 Display *dpy;
10075 dpy = XOpenDisplay (display);
10076 if (dpy)
10077 XCloseDisplay (dpy);
10078 else
10079 dpy_ok = 0;
10080 return dpy_ok;
10083 #ifdef USE_GTK
10084 static void
10085 my_log_handler (log_domain, log_level, message, user_data)
10086 const gchar *log_domain;
10087 GLogLevelFlags log_level;
10088 const gchar *message;
10089 gpointer user_data;
10091 if (!strstr (message, "g_set_prgname"))
10092 fprintf (stderr, "%s-WARNING **: %s\n", log_domain, message);
10094 #endif
10096 /* Open a connection to X display DISPLAY_NAME, and return
10097 the structure that describes the open display.
10098 If we cannot contact the display, return null. */
10100 struct x_display_info *
10101 x_term_init (display_name, xrm_option, resource_name)
10102 Lisp_Object display_name;
10103 char *xrm_option;
10104 char *resource_name;
10106 int connection;
10107 Display *dpy;
10108 struct terminal *terminal;
10109 struct x_display_info *dpyinfo;
10110 XrmDatabase xrdb;
10112 BLOCK_INPUT;
10114 if (!x_initialized)
10116 x_initialize ();
10117 ++x_initialized;
10120 if (! x_display_ok (SDATA (display_name)))
10121 error ("Display %s can't be opened", SDATA (display_name));
10123 #ifdef USE_GTK
10125 #define NUM_ARGV 10
10126 int argc;
10127 char *argv[NUM_ARGV];
10128 char **argv2 = argv;
10129 guint id;
10130 #ifndef HAVE_GTK_MULTIDISPLAY
10131 if (!EQ (Vinitial_window_system, Qx))
10132 error ("Sorry, you cannot connect to X servers with the GTK toolkit");
10133 #endif
10135 if (x_initialized++ > 1)
10137 #ifdef HAVE_GTK_MULTIDISPLAY
10138 /* Opening another display. If xg_display_open returns less
10139 than zero, we are probably on GTK 2.0, which can only handle
10140 one display. GTK 2.2 or later can handle more than one. */
10141 if (xg_display_open (SDATA (display_name), &dpy) < 0)
10142 #endif
10143 error ("Sorry, this version of GTK can only handle one display");
10145 else
10147 for (argc = 0; argc < NUM_ARGV; ++argc)
10148 argv[argc] = 0;
10150 argc = 0;
10151 argv[argc++] = initial_argv[0];
10153 if (! NILP (display_name))
10155 argv[argc++] = "--display";
10156 argv[argc++] = SDATA (display_name);
10159 argv[argc++] = "--name";
10160 argv[argc++] = resource_name;
10162 XSetLocaleModifiers ("");
10164 /* Work around GLib bug that outputs a faulty warning. See
10165 https://bugzilla.gnome.org/show_bug.cgi?id=563627. */
10166 id = g_log_set_handler ("GLib", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
10167 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
10168 gtk_init (&argc, &argv2);
10169 g_log_remove_handler ("GLib", id);
10171 /* gtk_init does set_locale. We must fix locale after calling it. */
10172 fixup_locale ();
10173 xg_initialize ();
10175 dpy = GDK_DISPLAY ();
10177 /* NULL window -> events for all windows go to our function */
10178 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
10180 /* Load our own gtkrc if it exists. */
10182 char *file = "~/.emacs.d/gtkrc";
10183 Lisp_Object s, abs_file;
10185 s = make_string (file, strlen (file));
10186 abs_file = Fexpand_file_name (s, Qnil);
10188 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
10189 gtk_rc_parse (SDATA (abs_file));
10192 XSetErrorHandler (x_error_handler);
10193 XSetIOErrorHandler (x_io_error_quitter);
10196 #else /* not USE_GTK */
10197 #ifdef USE_X_TOOLKIT
10198 /* weiner@footloose.sps.mot.com reports that this causes
10199 errors with X11R5:
10200 X protocol error: BadAtom (invalid Atom parameter)
10201 on protocol request 18skiloaf.
10202 So let's not use it until R6. */
10203 #ifdef HAVE_X11XTR6
10204 XtSetLanguageProc (NULL, NULL, NULL);
10205 #endif
10208 int argc = 0;
10209 char *argv[3];
10211 argv[0] = "";
10212 argc = 1;
10213 if (xrm_option)
10215 argv[argc++] = "-xrm";
10216 argv[argc++] = xrm_option;
10218 turn_on_atimers (0);
10219 dpy = XtOpenDisplay (Xt_app_con, SDATA (display_name),
10220 resource_name, EMACS_CLASS,
10221 emacs_options, XtNumber (emacs_options),
10222 &argc, argv);
10223 turn_on_atimers (1);
10225 #ifdef HAVE_X11XTR6
10226 /* I think this is to compensate for XtSetLanguageProc. */
10227 fixup_locale ();
10228 #endif
10231 #else /* not USE_X_TOOLKIT */
10232 XSetLocaleModifiers ("");
10233 dpy = XOpenDisplay (SDATA (display_name));
10234 #endif /* not USE_X_TOOLKIT */
10235 #endif /* not USE_GTK*/
10237 /* Detect failure. */
10238 if (dpy == 0)
10240 UNBLOCK_INPUT;
10241 return 0;
10244 /* We have definitely succeeded. Record the new connection. */
10246 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
10247 bzero (dpyinfo, sizeof *dpyinfo);
10249 terminal = x_create_terminal (dpyinfo);
10252 struct x_display_info *share;
10253 Lisp_Object tail;
10255 for (share = x_display_list, tail = x_display_name_list; share;
10256 share = share->next, tail = XCDR (tail))
10257 if (same_x_server (SDATA (XCAR (XCAR (tail))),
10258 SDATA (display_name)))
10259 break;
10260 if (share)
10261 terminal->kboard = share->terminal->kboard;
10262 else
10264 terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
10265 init_kboard (terminal->kboard);
10266 terminal->kboard->Vwindow_system = Qx;
10268 /* Add the keyboard to the list before running Lisp code (via
10269 Qvendor_specific_keysyms below), since these are not traced
10270 via terminals but only through all_kboards. */
10271 terminal->kboard->next_kboard = all_kboards;
10272 all_kboards = terminal->kboard;
10274 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10276 char *vendor = ServerVendor (dpy);
10278 /* Protect terminal from GC before removing it from the
10279 list of terminals. */
10280 struct gcpro gcpro1;
10281 Lisp_Object gcpro_term;
10282 XSETTERMINAL (gcpro_term, terminal);
10283 GCPRO1 (gcpro_term);
10285 /* Temporarily hide the partially initialized terminal. */
10286 terminal_list = terminal->next_terminal;
10287 UNBLOCK_INPUT;
10288 terminal->kboard->Vsystem_key_alist
10289 = call1 (Qvendor_specific_keysyms,
10290 vendor ? build_string (vendor) : empty_unibyte_string);
10291 BLOCK_INPUT;
10292 terminal->next_terminal = terminal_list;
10293 terminal_list = terminal;
10294 UNGCPRO;
10297 /* Don't let the initial kboard remain current longer than necessary.
10298 That would cause problems if a file loaded on startup tries to
10299 prompt in the mini-buffer. */
10300 if (current_kboard == initial_kboard)
10301 current_kboard = terminal->kboard;
10303 terminal->kboard->reference_count++;
10306 /* Put this display on the chain. */
10307 dpyinfo->next = x_display_list;
10308 x_display_list = dpyinfo;
10310 /* Put it on x_display_name_list as well, to keep them parallel. */
10311 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10312 x_display_name_list);
10313 dpyinfo->name_list_element = XCAR (x_display_name_list);
10315 dpyinfo->display = dpy;
10317 /* Set the name of the terminal. */
10318 terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
10319 strncpy (terminal->name, SDATA (display_name), SBYTES (display_name));
10320 terminal->name[SBYTES (display_name)] = 0;
10322 #if 0
10323 XSetAfterFunction (x_current_display, x_trace_wire);
10324 #endif /* ! 0 */
10326 dpyinfo->x_id_name
10327 = (char *) xmalloc (SBYTES (Vinvocation_name)
10328 + SBYTES (Vsystem_name)
10329 + 2);
10330 sprintf (dpyinfo->x_id_name, "%s@%s",
10331 SDATA (Vinvocation_name), SDATA (Vsystem_name));
10333 /* Figure out which modifier bits mean what. */
10334 x_find_modifier_meanings (dpyinfo);
10336 /* Get the scroll bar cursor. */
10337 #ifdef USE_GTK
10338 /* We must create a GTK cursor, it is required for GTK widgets. */
10339 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10340 #endif /* USE_GTK */
10342 dpyinfo->vertical_scroll_bar_cursor
10343 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10345 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10346 resource_name, EMACS_CLASS);
10347 #ifdef HAVE_XRMSETDATABASE
10348 XrmSetDatabase (dpyinfo->display, xrdb);
10349 #else
10350 dpyinfo->display->db = xrdb;
10351 #endif
10352 /* Put the rdb where we can find it in a way that works on
10353 all versions. */
10354 dpyinfo->xrdb = xrdb;
10356 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10357 DefaultScreen (dpyinfo->display));
10358 select_visual (dpyinfo);
10359 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10360 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10361 dpyinfo->client_leader_window = 0;
10362 dpyinfo->grabbed = 0;
10363 dpyinfo->reference_count = 0;
10364 dpyinfo->icon_bitmap_id = -1;
10365 dpyinfo->n_fonts = 0;
10366 dpyinfo->bitmaps = 0;
10367 dpyinfo->bitmaps_size = 0;
10368 dpyinfo->bitmaps_last = 0;
10369 dpyinfo->scratch_cursor_gc = 0;
10370 dpyinfo->mouse_face_mouse_frame = 0;
10371 dpyinfo->mouse_face_deferred_gc = 0;
10372 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
10373 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
10374 dpyinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10375 dpyinfo->mouse_face_window = Qnil;
10376 dpyinfo->mouse_face_overlay = Qnil;
10377 dpyinfo->mouse_face_mouse_x = dpyinfo->mouse_face_mouse_y = 0;
10378 dpyinfo->mouse_face_defer = 0;
10379 dpyinfo->mouse_face_hidden = 0;
10380 dpyinfo->x_focus_frame = 0;
10381 dpyinfo->x_focus_event_frame = 0;
10382 dpyinfo->x_highlight_frame = 0;
10383 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10385 /* See if we can construct pixel values from RGB values. */
10386 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10387 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10389 if (dpyinfo->visual->class == TrueColor)
10391 get_bits_and_offset (dpyinfo->visual->red_mask,
10392 &dpyinfo->red_bits, &dpyinfo->red_offset);
10393 get_bits_and_offset (dpyinfo->visual->blue_mask,
10394 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10395 get_bits_and_offset (dpyinfo->visual->green_mask,
10396 &dpyinfo->green_bits, &dpyinfo->green_offset);
10399 /* See if a private colormap is requested. */
10400 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10402 if (dpyinfo->visual->class == PseudoColor)
10404 Lisp_Object value;
10405 value = display_x_get_resource (dpyinfo,
10406 build_string ("privateColormap"),
10407 build_string ("PrivateColormap"),
10408 Qnil, Qnil);
10409 if (STRINGP (value)
10410 && (!strcmp (SDATA (value), "true")
10411 || !strcmp (SDATA (value), "on")))
10412 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10415 else
10416 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10417 dpyinfo->visual, AllocNone);
10419 #ifdef HAVE_XFT
10421 /* If we are using Xft, check dpi value in X resources.
10422 It is better we use it as well, since Xft will use it, as will all
10423 Gnome applications. If our real DPI is smaller or larger than the
10424 one Xft uses, our font will look smaller or larger than other
10425 for other applications, even if it is the same font name (monospace-10
10426 for example). */
10427 char *v = XGetDefault (dpyinfo->display, "Xft", "dpi");
10428 double d;
10429 if (v != NULL && sscanf (v, "%lf", &d) == 1)
10430 dpyinfo->resy = dpyinfo->resx = d;
10432 #endif
10434 if (dpyinfo->resy < 1)
10436 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10437 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10438 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10439 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10440 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10441 pixels = DisplayWidth (dpyinfo->display, screen_number);
10442 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10443 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10444 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10447 dpyinfo->Xatom_wm_protocols
10448 = XInternAtom (dpyinfo->display, "WM_PROTOCOLS", False);
10449 dpyinfo->Xatom_wm_take_focus
10450 = XInternAtom (dpyinfo->display, "WM_TAKE_FOCUS", False);
10451 dpyinfo->Xatom_wm_save_yourself
10452 = XInternAtom (dpyinfo->display, "WM_SAVE_YOURSELF", False);
10453 dpyinfo->Xatom_wm_delete_window
10454 = XInternAtom (dpyinfo->display, "WM_DELETE_WINDOW", False);
10455 dpyinfo->Xatom_wm_change_state
10456 = XInternAtom (dpyinfo->display, "WM_CHANGE_STATE", False);
10457 dpyinfo->Xatom_wm_configure_denied
10458 = XInternAtom (dpyinfo->display, "WM_CONFIGURE_DENIED", False);
10459 dpyinfo->Xatom_wm_window_moved
10460 = XInternAtom (dpyinfo->display, "WM_MOVED", False);
10461 dpyinfo->Xatom_wm_client_leader
10462 = XInternAtom (dpyinfo->display, "WM_CLIENT_LEADER", False);
10463 dpyinfo->Xatom_editres
10464 = XInternAtom (dpyinfo->display, "Editres", False);
10465 dpyinfo->Xatom_CLIPBOARD
10466 = XInternAtom (dpyinfo->display, "CLIPBOARD", False);
10467 dpyinfo->Xatom_TIMESTAMP
10468 = XInternAtom (dpyinfo->display, "TIMESTAMP", False);
10469 dpyinfo->Xatom_TEXT
10470 = XInternAtom (dpyinfo->display, "TEXT", False);
10471 dpyinfo->Xatom_COMPOUND_TEXT
10472 = XInternAtom (dpyinfo->display, "COMPOUND_TEXT", False);
10473 dpyinfo->Xatom_UTF8_STRING
10474 = XInternAtom (dpyinfo->display, "UTF8_STRING", False);
10475 dpyinfo->Xatom_DELETE
10476 = XInternAtom (dpyinfo->display, "DELETE", False);
10477 dpyinfo->Xatom_MULTIPLE
10478 = XInternAtom (dpyinfo->display, "MULTIPLE", False);
10479 dpyinfo->Xatom_INCR
10480 = XInternAtom (dpyinfo->display, "INCR", False);
10481 dpyinfo->Xatom_EMACS_TMP
10482 = XInternAtom (dpyinfo->display, "_EMACS_TMP_", False);
10483 dpyinfo->Xatom_TARGETS
10484 = XInternAtom (dpyinfo->display, "TARGETS", False);
10485 dpyinfo->Xatom_NULL
10486 = XInternAtom (dpyinfo->display, "NULL", False);
10487 dpyinfo->Xatom_ATOM_PAIR
10488 = XInternAtom (dpyinfo->display, "ATOM_PAIR", False);
10489 /* For properties of font. */
10490 dpyinfo->Xatom_PIXEL_SIZE
10491 = XInternAtom (dpyinfo->display, "PIXEL_SIZE", False);
10492 dpyinfo->Xatom_AVERAGE_WIDTH
10493 = XInternAtom (dpyinfo->display, "AVERAGE_WIDTH", False);
10494 dpyinfo->Xatom_MULE_BASELINE_OFFSET
10495 = XInternAtom (dpyinfo->display, "_MULE_BASELINE_OFFSET", False);
10496 dpyinfo->Xatom_MULE_RELATIVE_COMPOSE
10497 = XInternAtom (dpyinfo->display, "_MULE_RELATIVE_COMPOSE", False);
10498 dpyinfo->Xatom_MULE_DEFAULT_ASCENT
10499 = XInternAtom (dpyinfo->display, "_MULE_DEFAULT_ASCENT", False);
10501 /* Ghostscript support. */
10502 dpyinfo->Xatom_PAGE = XInternAtom (dpyinfo->display, "PAGE", False);
10503 dpyinfo->Xatom_DONE = XInternAtom (dpyinfo->display, "DONE", False);
10505 dpyinfo->Xatom_Scrollbar = XInternAtom (dpyinfo->display, "SCROLLBAR",
10506 False);
10508 dpyinfo->Xatom_XEMBED = XInternAtom (dpyinfo->display, "_XEMBED",
10509 False);
10511 dpyinfo->Xatom_net_wm_state
10512 = XInternAtom (dpyinfo->display, "_NET_WM_STATE", False);
10513 dpyinfo->Xatom_net_wm_state_fullscreen_atom
10514 = XInternAtom (dpyinfo->display, "_NET_WM_STATE_FULLSCREEN", False);
10515 dpyinfo->Xatom_net_wm_state_maximized_horz
10516 = XInternAtom (dpyinfo->display, "_NET_WM_STATE_MAXIMIZED_HORZ", False);
10517 dpyinfo->Xatom_net_wm_state_maximized_vert
10518 = XInternAtom (dpyinfo->display, "_NET_WM_STATE_MAXIMIZED_VERT", False);
10519 dpyinfo->Xatom_net_wm_state_sticky
10520 = XInternAtom (dpyinfo->display, "_NET_WM_STATE_STICKY", False);
10521 dpyinfo->Xatom_net_window_type
10522 = XInternAtom (dpyinfo->display, "_NET_WM_WINDOW_TYPE", False);
10523 dpyinfo->Xatom_net_window_type_tooltip
10524 = XInternAtom (dpyinfo->display, "_NET_WM_WINDOW_TYPE_TOOLTIP", False);
10525 dpyinfo->Xatom_net_frame_extents
10526 = XInternAtom (dpyinfo->display, "_NET_FRAME_EXTENTS", False);
10527 dpyinfo->cut_buffers_initialized = 0;
10529 dpyinfo->x_dnd_atoms_size = 8;
10530 dpyinfo->x_dnd_atoms_length = 0;
10531 dpyinfo->x_dnd_atoms = xmalloc (sizeof (*dpyinfo->x_dnd_atoms)
10532 * dpyinfo->x_dnd_atoms_size);
10534 dpyinfo->net_supported_atoms = NULL;
10535 dpyinfo->nr_net_supported_atoms = 0;
10536 dpyinfo->net_supported_window = 0;
10538 connection = ConnectionNumber (dpyinfo->display);
10539 dpyinfo->connection = connection;
10542 extern int gray_bitmap_width, gray_bitmap_height;
10543 extern char *gray_bitmap_bits;
10544 dpyinfo->gray
10545 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10546 gray_bitmap_bits,
10547 gray_bitmap_width, gray_bitmap_height,
10548 (unsigned long) 1, (unsigned long) 0, 1);
10551 #ifdef HAVE_X_I18N
10552 xim_initialize (dpyinfo, resource_name);
10553 #endif
10555 xsettings_initialize (dpyinfo);
10557 #ifdef subprocesses
10558 /* This is only needed for distinguishing keyboard and process input. */
10559 if (connection != 0)
10560 add_keyboard_wait_descriptor (connection);
10561 #endif
10563 #ifdef F_SETOWN
10564 fcntl (connection, F_SETOWN, getpid ());
10565 #endif /* ! defined (F_SETOWN) */
10567 #ifdef SIGIO
10568 if (interrupt_input)
10569 init_sigio (connection);
10570 #endif /* ! defined (SIGIO) */
10572 #ifdef USE_LUCID
10574 Display *dpy = dpyinfo->display;
10575 XrmValue d, fr, to;
10576 Font font;
10578 d.addr = (XPointer)&dpy;
10579 d.size = sizeof (Display *);
10580 fr.addr = XtDefaultFont;
10581 fr.size = sizeof (XtDefaultFont);
10582 to.size = sizeof (Font *);
10583 to.addr = (XPointer)&font;
10584 x_catch_errors (dpy);
10585 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10586 abort ();
10587 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10588 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10589 x_uncatch_errors ();
10591 #endif
10593 /* See if we should run in synchronous mode. This is useful
10594 for debugging X code. */
10596 Lisp_Object value;
10597 value = display_x_get_resource (dpyinfo,
10598 build_string ("synchronous"),
10599 build_string ("Synchronous"),
10600 Qnil, Qnil);
10601 if (STRINGP (value)
10602 && (!strcmp (SDATA (value), "true")
10603 || !strcmp (SDATA (value), "on")))
10604 XSynchronize (dpyinfo->display, True);
10608 Lisp_Object value;
10609 value = display_x_get_resource (dpyinfo,
10610 build_string ("useXIM"),
10611 build_string ("UseXIM"),
10612 Qnil, Qnil);
10613 #ifdef USE_XIM
10614 if (STRINGP (value)
10615 && (!strcmp (SDATA (value), "false")
10616 || !strcmp (SDATA (value), "off")))
10617 use_xim = 0;
10618 #else
10619 if (STRINGP (value)
10620 && (!strcmp (SDATA (value), "true")
10621 || !strcmp (SDATA (value), "on")))
10622 use_xim = 1;
10623 #endif
10626 #ifdef HAVE_X_SM
10627 /* Only do this for the very first display in the Emacs session.
10628 Ignore X session management when Emacs was first started on a
10629 tty. */
10630 if (terminal->id == 1)
10631 x_session_initialize (dpyinfo);
10632 #endif
10634 UNBLOCK_INPUT;
10636 return dpyinfo;
10639 /* Get rid of display DPYINFO, deleting all frames on it,
10640 and without sending any more commands to the X server. */
10642 void
10643 x_delete_display (dpyinfo)
10644 struct x_display_info *dpyinfo;
10646 struct terminal *t;
10648 /* Close all frames and delete the generic struct terminal for this
10649 X display. */
10650 for (t = terminal_list; t; t = t->next_terminal)
10651 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10653 #ifdef HAVE_X_SM
10654 /* Close X session management when we close its display. */
10655 if (t->id == 1 && x_session_have_connection ())
10656 x_session_close();
10657 #endif
10658 delete_terminal (t);
10659 break;
10662 delete_keyboard_wait_descriptor (dpyinfo->connection);
10664 /* Discard this display from x_display_name_list and x_display_list.
10665 We can't use Fdelq because that can quit. */
10666 if (! NILP (x_display_name_list)
10667 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10668 x_display_name_list = XCDR (x_display_name_list);
10669 else
10671 Lisp_Object tail;
10673 tail = x_display_name_list;
10674 while (CONSP (tail) && CONSP (XCDR (tail)))
10676 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10678 XSETCDR (tail, XCDR (XCDR (tail)));
10679 break;
10681 tail = XCDR (tail);
10685 if (next_noop_dpyinfo == dpyinfo)
10686 next_noop_dpyinfo = dpyinfo->next;
10688 if (x_display_list == dpyinfo)
10689 x_display_list = dpyinfo->next;
10690 else
10692 struct x_display_info *tail;
10694 for (tail = x_display_list; tail; tail = tail->next)
10695 if (tail->next == dpyinfo)
10696 tail->next = tail->next->next;
10699 xfree (dpyinfo->x_id_name);
10700 xfree (dpyinfo->x_dnd_atoms);
10701 xfree (dpyinfo->color_cells);
10702 xfree (dpyinfo);
10705 #ifdef USE_X_TOOLKIT
10707 /* Atimer callback function for TIMER. Called every 0.1s to process
10708 Xt timeouts, if needed. We must avoid calling XtAppPending as
10709 much as possible because that function does an implicit XFlush
10710 that slows us down. */
10712 static void
10713 x_process_timeouts (timer)
10714 struct atimer *timer;
10716 BLOCK_INPUT;
10717 x_timeout_atimer_activated_flag = 0;
10718 if (toolkit_scroll_bar_interaction || popup_activated ())
10720 while (XtAppPending (Xt_app_con) & XtIMTimer)
10721 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10722 /* Reactivate the atimer for next time. */
10723 x_activate_timeout_atimer ();
10725 UNBLOCK_INPUT;
10728 /* Install an asynchronous timer that processes Xt timeout events
10729 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10730 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10731 function whenever these variables are set. This is necessary
10732 because some widget sets use timeouts internally, for example the
10733 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10734 processed, these widgets don't behave normally. */
10736 void
10737 x_activate_timeout_atimer ()
10739 BLOCK_INPUT;
10740 if (!x_timeout_atimer_activated_flag)
10742 EMACS_TIME interval;
10744 EMACS_SET_SECS_USECS (interval, 0, 100000);
10745 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10746 x_timeout_atimer_activated_flag = 1;
10748 UNBLOCK_INPUT;
10751 #endif /* USE_X_TOOLKIT */
10754 /* Set up use of X before we make the first connection. */
10756 extern frame_parm_handler x_frame_parm_handlers[];
10758 static struct redisplay_interface x_redisplay_interface =
10760 x_frame_parm_handlers,
10761 x_produce_glyphs,
10762 x_write_glyphs,
10763 x_insert_glyphs,
10764 x_clear_end_of_line,
10765 x_scroll_run,
10766 x_after_update_window_line,
10767 x_update_window_begin,
10768 x_update_window_end,
10769 x_cursor_to,
10770 x_flush,
10771 #ifdef XFlush
10772 x_flush,
10773 #else
10774 0, /* flush_display_optional */
10775 #endif
10776 x_clear_window_mouse_face,
10777 x_get_glyph_overhangs,
10778 x_fix_overlapping_area,
10779 x_draw_fringe_bitmap,
10780 0, /* define_fringe_bitmap */
10781 0, /* destroy_fringe_bitmap */
10782 x_compute_glyph_string_overhangs,
10783 x_draw_glyph_string,
10784 x_define_frame_cursor,
10785 x_clear_frame_area,
10786 x_draw_window_cursor,
10787 x_draw_vertical_window_border,
10788 x_shift_glyphs_for_insert
10792 /* This function is called when the last frame on a display is deleted. */
10793 void
10794 x_delete_terminal (struct terminal *terminal)
10796 struct x_display_info *dpyinfo = terminal->display_info.x;
10798 /* Protect against recursive calls. delete_frame in
10799 delete_terminal calls us back when it deletes our last frame. */
10800 if (!terminal->name)
10801 return;
10803 BLOCK_INPUT;
10804 #ifdef HAVE_X_I18N
10805 /* We must close our connection to the XIM server before closing the
10806 X display. */
10807 if (dpyinfo->xim)
10808 xim_close_dpy (dpyinfo);
10809 #endif
10811 /* If called from x_connection_closed, the display may already be closed
10812 and dpyinfo->display was set to 0 to indicate that. */
10813 if (dpyinfo->display)
10815 x_destroy_all_bitmaps (dpyinfo);
10816 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10818 /* Whether or not XCloseDisplay destroys the associated resource
10819 database depends on the version of libX11. To avoid both
10820 crash and memory leak, we dissociate the database from the
10821 display and then destroy dpyinfo->xrdb ourselves.
10823 Unfortunately, the above strategy does not work in some
10824 situations due to a bug in newer versions of libX11: because
10825 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
10826 dpy->db is NULL, XCloseDisplay destroys the associated
10827 database whereas it has not been created by XGetDefault
10828 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
10829 don't destroy the database here in order to avoid the crash
10830 in the above situations for now, though that may cause memory
10831 leaks in other situations. */
10832 #if 0
10833 #ifdef HAVE_XRMSETDATABASE
10834 XrmSetDatabase (dpyinfo->display, NULL);
10835 #else
10836 dpyinfo->display->db = NULL;
10837 #endif
10838 /* We used to call XrmDestroyDatabase from x_delete_display, but
10839 some older versions of libX11 crash if we call it after
10840 closing all the displays. */
10841 XrmDestroyDatabase (dpyinfo->xrdb);
10842 #endif
10844 #ifdef USE_GTK
10845 xg_display_close (dpyinfo->display);
10846 #else
10847 #ifdef USE_X_TOOLKIT
10848 XtCloseDisplay (dpyinfo->display);
10849 #else
10850 XCloseDisplay (dpyinfo->display);
10851 #endif
10852 #endif /* ! USE_GTK */
10855 /* Mark as dead. */
10856 dpyinfo->display = NULL;
10857 x_delete_display (dpyinfo);
10858 UNBLOCK_INPUT;
10861 /* Create a struct terminal, initialize it with the X11 specific
10862 functions and make DISPLAY->TERMINAL point to it. */
10864 static struct terminal *
10865 x_create_terminal (struct x_display_info *dpyinfo)
10867 struct terminal *terminal;
10869 terminal = create_terminal ();
10871 terminal->type = output_x_window;
10872 terminal->display_info.x = dpyinfo;
10873 dpyinfo->terminal = terminal;
10875 /* kboard is initialized in x_term_init. */
10877 terminal->clear_frame_hook = x_clear_frame;
10878 terminal->ins_del_lines_hook = x_ins_del_lines;
10879 terminal->delete_glyphs_hook = x_delete_glyphs;
10880 terminal->ring_bell_hook = XTring_bell;
10881 terminal->toggle_invisible_pointer_hook = XTtoggle_invisible_pointer;
10882 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10883 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10884 terminal->update_begin_hook = x_update_begin;
10885 terminal->update_end_hook = x_update_end;
10886 terminal->set_terminal_window_hook = XTset_terminal_window;
10887 terminal->read_socket_hook = XTread_socket;
10888 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10889 terminal->mouse_position_hook = XTmouse_position;
10890 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10891 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10892 terminal->fullscreen_hook = XTfullscreen_hook;
10893 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10894 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10895 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10896 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10898 terminal->delete_frame_hook = x_destroy_window;
10899 terminal->delete_terminal_hook = x_delete_terminal;
10901 terminal->rif = &x_redisplay_interface;
10902 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10903 terminal->char_ins_del_ok = 1;
10904 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10905 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10906 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10907 off the bottom. */
10909 return terminal;
10912 void
10913 x_initialize ()
10915 baud_rate = 19200;
10917 x_noop_count = 0;
10918 last_tool_bar_item = -1;
10919 any_help_event_p = 0;
10920 ignore_next_mouse_click_timeout = 0;
10921 #ifdef HAVE_X_SM
10922 x_session_initialized = 0;
10923 #endif
10925 #ifdef USE_GTK
10926 current_count = -1;
10927 #endif
10929 /* Try to use interrupt input; if we can't, then start polling. */
10930 Fset_input_interrupt_mode (Qt);
10932 #ifdef USE_X_TOOLKIT
10933 XtToolkitInitialize ();
10935 Xt_app_con = XtCreateApplicationContext ();
10937 /* Register a converter from strings to pixels, which uses
10938 Emacs' color allocation infrastructure. */
10939 XtAppSetTypeConverter (Xt_app_con,
10940 XtRString, XtRPixel, cvt_string_to_pixel,
10941 cvt_string_to_pixel_args,
10942 XtNumber (cvt_string_to_pixel_args),
10943 XtCacheByDisplay, cvt_pixel_dtor);
10945 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10946 #endif
10948 #ifdef USE_TOOLKIT_SCROLL_BARS
10949 #ifndef USE_GTK
10950 xaw3d_arrow_scroll = False;
10951 xaw3d_pick_top = True;
10952 #endif
10953 #endif
10955 pending_autoraise_frame = 0;
10956 pending_event_wait.f = 0;
10957 pending_event_wait.eventtype = 0;
10959 /* Note that there is no real way portable across R3/R4 to get the
10960 original error handler. */
10961 XSetErrorHandler (x_error_handler);
10962 XSetIOErrorHandler (x_io_error_quitter);
10964 signal (SIGPIPE, x_connection_signal);
10966 xgselect_initialize ();
10970 void
10971 syms_of_xterm ()
10973 x_error_message = NULL;
10975 staticpro (&x_display_name_list);
10976 x_display_name_list = Qnil;
10978 staticpro (&last_mouse_scroll_bar);
10979 last_mouse_scroll_bar = Qnil;
10981 staticpro (&Qvendor_specific_keysyms);
10982 Qvendor_specific_keysyms = intern_c_string ("vendor-specific-keysyms");
10984 staticpro (&Qlatin_1);
10985 Qlatin_1 = intern_c_string ("latin-1");
10987 staticpro (&last_mouse_press_frame);
10988 last_mouse_press_frame = Qnil;
10990 #ifdef USE_GTK
10991 xg_default_icon_file = make_pure_c_string ("icons/hicolor/scalable/apps/emacs.svg");
10992 staticpro (&xg_default_icon_file);
10994 Qx_gtk_map_stock = intern_c_string ("x-gtk-map-stock");
10995 staticpro (&Qx_gtk_map_stock);
10996 #endif
10998 DEFVAR_BOOL ("x-use-underline-position-properties",
10999 &x_use_underline_position_properties,
11000 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
11001 A value of nil means ignore them. If you encounter fonts with bogus
11002 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
11003 to 4.1, set this to nil. You can also use `underline-minimum-offset'
11004 to override the font's UNDERLINE_POSITION for small font display
11005 sizes. */);
11006 x_use_underline_position_properties = 1;
11008 DEFVAR_BOOL ("x-underline-at-descent-line",
11009 &x_underline_at_descent_line,
11010 doc: /* *Non-nil means to draw the underline at the same place as the descent line.
11011 A value of nil means to draw the underline according to the value of the
11012 variable `x-use-underline-position-properties', which is usually at the
11013 baseline level. The default value is nil. */);
11014 x_underline_at_descent_line = 0;
11016 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
11017 &x_mouse_click_focus_ignore_position,
11018 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
11019 This variable is only used when the window manager requires that you
11020 click on a frame to select it (give it focus). In that case, a value
11021 of nil, means that the selected window and cursor position changes to
11022 reflect the mouse click position, while a non-nil value means that the
11023 selected window or cursor position is preserved. */);
11024 x_mouse_click_focus_ignore_position = 0;
11026 DEFVAR_LISP ("x-toolkit-scroll-bars", &Vx_toolkit_scroll_bars,
11027 doc: /* What X toolkit scroll bars Emacs uses.
11028 A value of nil means Emacs doesn't use X toolkit scroll bars.
11029 Otherwise, value is a symbol describing the X toolkit. */);
11030 #ifdef USE_TOOLKIT_SCROLL_BARS
11031 #ifdef USE_MOTIF
11032 Vx_toolkit_scroll_bars = intern_c_string ("motif");
11033 #elif defined HAVE_XAW3D
11034 Vx_toolkit_scroll_bars = intern_c_string ("xaw3d");
11035 #elif USE_GTK
11036 Vx_toolkit_scroll_bars = intern_c_string ("gtk");
11037 #else
11038 Vx_toolkit_scroll_bars = intern_c_string ("xaw");
11039 #endif
11040 #else
11041 Vx_toolkit_scroll_bars = Qnil;
11042 #endif
11044 staticpro (&last_mouse_motion_frame);
11045 last_mouse_motion_frame = Qnil;
11047 Qmodifier_value = intern_c_string ("modifier-value");
11048 Qalt = intern_c_string ("alt");
11049 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
11050 Qhyper = intern_c_string ("hyper");
11051 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
11052 Qmeta = intern_c_string ("meta");
11053 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
11054 Qsuper = intern_c_string ("super");
11055 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
11057 DEFVAR_LISP ("x-alt-keysym", &Vx_alt_keysym,
11058 doc: /* Which keys Emacs uses for the alt modifier.
11059 This should be one of the symbols `alt', `hyper', `meta', `super'.
11060 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
11061 is nil, which is the same as `alt'. */);
11062 Vx_alt_keysym = Qnil;
11064 DEFVAR_LISP ("x-hyper-keysym", &Vx_hyper_keysym,
11065 doc: /* Which keys Emacs uses for the hyper modifier.
11066 This should be one of the symbols `alt', `hyper', `meta', `super'.
11067 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
11068 default is nil, which is the same as `hyper'. */);
11069 Vx_hyper_keysym = Qnil;
11071 DEFVAR_LISP ("x-meta-keysym", &Vx_meta_keysym,
11072 doc: /* Which keys Emacs uses for the meta modifier.
11073 This should be one of the symbols `alt', `hyper', `meta', `super'.
11074 For example, `meta' means use the Meta_L and Meta_R keysyms. The
11075 default is nil, which is the same as `meta'. */);
11076 Vx_meta_keysym = Qnil;
11078 DEFVAR_LISP ("x-super-keysym", &Vx_super_keysym,
11079 doc: /* Which keys Emacs uses for the super modifier.
11080 This should be one of the symbols `alt', `hyper', `meta', `super'.
11081 For example, `super' means use the Super_L and Super_R keysyms. The
11082 default is nil, which is the same as `super'. */);
11083 Vx_super_keysym = Qnil;
11085 DEFVAR_LISP ("x-keysym-table", &Vx_keysym_table,
11086 doc: /* Hash table of character codes indexed by X keysym codes. */);
11087 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
11088 make_float (DEFAULT_REHASH_SIZE),
11089 make_float (DEFAULT_REHASH_THRESHOLD),
11090 Qnil, Qnil, Qnil);
11093 #endif /* HAVE_X_WINDOWS */
11095 /* arch-tag: 6d4e4cb7-abc1-4302-9585-d84dcfb09d0f
11096 (do not change this comment) */