Add font logging to list and match functions.
[emacs.git] / src / xterm.c
blobd2222b4a9b996e898ac0d6e785d59c656811e6e4
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
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>
32 #ifdef HAVE_X_WINDOWS
34 #include "lisp.h"
35 #include "blockinput.h"
37 /* Need syssignal.h for various externs and definitions that may be required
38 by some configurations for calls to signal later in this source file. */
39 #include "syssignal.h"
41 /* This may include sys/types.h, and that somehow loses
42 if this is not done before the other system files. */
43 #include "xterm.h"
44 #include <X11/cursorfont.h>
46 /* Load sys/types.h if not already loaded.
47 In some systems loading it twice is suicidal. */
48 #ifndef makedev
49 #include <sys/types.h>
50 #endif /* makedev */
52 #ifdef BSD_SYSTEM
53 #include <sys/ioctl.h>
54 #endif /* ! defined (BSD_SYSTEM) */
56 #include "systime.h"
58 #ifndef INCLUDED_FCNTL
59 #include <fcntl.h>
60 #endif
61 #include <ctype.h>
62 #include <errno.h>
63 #include <setjmp.h>
64 #include <sys/stat.h>
65 /* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed. */
66 /* #include <sys/param.h> */
68 #include "charset.h"
69 #include "character.h"
70 #include "coding.h"
71 #include "frame.h"
72 #include "dispextern.h"
73 #include "fontset.h"
74 #include "termhooks.h"
75 #include "termopts.h"
76 #include "termchar.h"
77 #include "emacs-icon.h"
78 #include "disptab.h"
79 #include "buffer.h"
80 #include "window.h"
81 #include "keyboard.h"
82 #include "intervals.h"
83 #include "process.h"
84 #include "atimer.h"
85 #include "keymap.h"
86 #include "font.h"
88 #ifdef USE_X_TOOLKIT
89 #include <X11/Shell.h>
90 #endif
92 #ifdef HAVE_SYS_TIME_H
93 #include <sys/time.h>
94 #endif
95 #ifdef HAVE_UNISTD_H
96 #include <unistd.h>
97 #endif
99 #ifdef USE_GTK
100 #include "gtkutil.h"
101 #endif
103 #ifdef USE_LUCID
104 extern int xlwmenu_window_p P_ ((Widget w, Window window));
105 extern void xlwmenu_redisplay P_ ((Widget));
106 #endif
108 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
110 extern void free_frame_menubar P_ ((struct frame *));
111 extern struct frame *x_menubar_window_to_frame P_ ((struct x_display_info *,
112 int));
113 #endif
115 #ifdef USE_X_TOOLKIT
116 #if (XtSpecificationRelease >= 5) && !defined(NO_EDITRES)
117 #define HACK_EDITRES
118 extern void _XEditResCheckMessages ();
119 #endif /* not NO_EDITRES */
121 /* Include toolkit specific headers for the scroll bar widget. */
123 #ifdef USE_TOOLKIT_SCROLL_BARS
124 #if defined USE_MOTIF
125 #include <Xm/Xm.h> /* for LESSTIF_VERSION */
126 #include <Xm/ScrollBar.h>
127 #else /* !USE_MOTIF i.e. use Xaw */
129 #ifdef HAVE_XAW3D
130 #include <X11/Xaw3d/Simple.h>
131 #include <X11/Xaw3d/Scrollbar.h>
132 #include <X11/Xaw3d/ThreeD.h>
133 #else /* !HAVE_XAW3D */
134 #include <X11/Xaw/Simple.h>
135 #include <X11/Xaw/Scrollbar.h>
136 #endif /* !HAVE_XAW3D */
137 #ifndef XtNpickTop
138 #define XtNpickTop "pickTop"
139 #endif /* !XtNpickTop */
140 #endif /* !USE_MOTIF */
141 #endif /* USE_TOOLKIT_SCROLL_BARS */
143 #endif /* USE_X_TOOLKIT */
145 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
146 #define x_any_window_to_frame x_window_to_frame
147 #define x_top_window_to_frame x_window_to_frame
148 #endif
150 #ifdef USE_X_TOOLKIT
151 #include "widget.h"
152 #ifndef XtNinitialState
153 #define XtNinitialState "initialState"
154 #endif
155 #endif
157 /* Default to using XIM if available. */
158 #ifdef USE_XIM
159 int use_xim = 1;
160 #else
161 int use_xim = 0; /* configure --without-xim */
162 #endif
166 /* Non-nil means Emacs uses toolkit scroll bars. */
168 Lisp_Object Vx_toolkit_scroll_bars;
170 /* Non-zero means that a HELP_EVENT has been generated since Emacs
171 start. */
173 static int any_help_event_p;
175 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
176 static Lisp_Object last_window;
178 /* Non-zero means make use of UNDERLINE_POSITION font properties. */
180 int x_use_underline_position_properties;
182 /* Non-zero means to draw the underline at the same place as the descent line. */
184 int x_underline_at_descent_line;
186 /* This is a chain of structures for all the X displays currently in
187 use. */
189 struct x_display_info *x_display_list;
191 /* This is a list of cons cells, each of the form (NAME
192 . FONT-LIST-CACHE), one for each element of x_display_list and in
193 the same order. NAME is the name of the frame. FONT-LIST-CACHE
194 records previous values returned by x-list-fonts. */
196 Lisp_Object x_display_name_list;
198 /* Frame being updated by update_frame. This is declared in term.c.
199 This is set by update_begin and looked at by all the XT functions.
200 It is zero while not inside an update. In that case, the XT
201 functions assume that `selected_frame' is the frame to apply to. */
203 extern struct frame *updating_frame;
205 /* This is a frame waiting to be auto-raised, within XTread_socket. */
207 struct frame *pending_autoraise_frame;
209 #ifdef USE_X_TOOLKIT
210 /* The application context for Xt use. */
211 XtAppContext Xt_app_con;
212 static String Xt_default_resources[] = {0};
213 #endif /* USE_X_TOOLKIT */
215 /* Non-zero means user is interacting with a toolkit scroll bar. */
217 static int toolkit_scroll_bar_interaction;
219 /* Non-zero means to not move point as a result of clicking on a
220 frame to focus it (when focus-follows-mouse is nil). */
222 int x_mouse_click_focus_ignore_position;
224 /* Non-zero timeout value means ignore next mouse click if it arrives
225 before that timeout elapses (i.e. as part of the same sequence of
226 events resulting from clicking on a frame to select it). */
228 static unsigned long ignore_next_mouse_click_timeout;
230 /* Mouse movement.
232 Formerly, we used PointerMotionHintMask (in standard_event_mask)
233 so that we would have to call XQueryPointer after each MotionNotify
234 event to ask for another such event. However, this made mouse tracking
235 slow, and there was a bug that made it eventually stop.
237 Simply asking for MotionNotify all the time seems to work better.
239 In order to avoid asking for motion events and then throwing most
240 of them away or busy-polling the server for mouse positions, we ask
241 the server for pointer motion hints. This means that we get only
242 one event per group of mouse movements. "Groups" are delimited by
243 other kinds of events (focus changes and button clicks, for
244 example), or by XQueryPointer calls; when one of these happens, we
245 get another MotionNotify event the next time the mouse moves. This
246 is at least as efficient as getting motion events when mouse
247 tracking is on, and I suspect only negligibly worse when tracking
248 is off. */
250 /* Where the mouse was last time we reported a mouse event. */
252 static XRectangle last_mouse_glyph;
253 static FRAME_PTR last_mouse_glyph_frame;
254 static Lisp_Object last_mouse_press_frame;
256 /* The scroll bar in which the last X motion event occurred.
258 If the last X motion event occurred in a scroll bar, we set this so
259 XTmouse_position can know whether to report a scroll bar motion or
260 an ordinary motion.
262 If the last X motion event didn't occur in a scroll bar, we set
263 this to Qnil, to tell XTmouse_position to return an ordinary motion
264 event. */
266 static Lisp_Object last_mouse_scroll_bar;
268 /* This is a hack. We would really prefer that XTmouse_position would
269 return the time associated with the position it returns, but there
270 doesn't seem to be any way to wrest the time-stamp from the server
271 along with the position query. So, we just keep track of the time
272 of the last movement we received, and return that in hopes that
273 it's somewhat accurate. */
275 static Time last_mouse_movement_time;
277 /* Time for last user interaction as returned in X events. */
279 static Time last_user_time;
281 /* Incremented by XTread_socket whenever it really tries to read
282 events. */
284 #ifdef __STDC__
285 static int volatile input_signal_count;
286 #else
287 static int input_signal_count;
288 #endif
290 /* Used locally within XTread_socket. */
292 static int x_noop_count;
294 /* Initial values of argv and argc. */
296 extern char **initial_argv;
297 extern int initial_argc;
299 extern Lisp_Object Vcommand_line_args, Vsystem_name;
301 /* Tells if a window manager is present or not. */
303 extern Lisp_Object Vx_no_window_manager;
305 extern Lisp_Object Qeql;
307 extern int errno;
309 /* A mask of extra modifier bits to put into every keyboard char. */
311 extern EMACS_INT extra_keyboard_modifiers;
313 /* The keysyms to use for the various modifiers. */
315 Lisp_Object Vx_alt_keysym, Vx_hyper_keysym, Vx_meta_keysym, Vx_super_keysym;
316 Lisp_Object Vx_keysym_table;
317 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
319 static Lisp_Object Qvendor_specific_keysyms;
320 static Lisp_Object Qlatin_1;
322 /* Used in x_flush. */
324 extern Lisp_Object Vinhibit_redisplay;
326 extern XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
327 extern int x_bitmap_mask P_ ((FRAME_PTR, int));
329 static int x_alloc_nearest_color_1 P_ ((Display *, Colormap, XColor *));
330 static void x_set_window_size_1 P_ ((struct frame *, int, int, int));
331 static const XColor *x_color_cells P_ ((Display *, int *));
332 static void x_update_window_end P_ ((struct window *, int, int));
334 static int x_io_error_quitter P_ ((Display *));
335 static struct terminal *x_create_terminal P_ ((struct x_display_info *));
336 void x_delete_terminal P_ ((struct terminal *));
337 static void x_update_end P_ ((struct frame *));
338 static void XTframe_up_to_date P_ ((struct frame *));
339 static void XTset_terminal_modes P_ ((struct terminal *));
340 static void XTreset_terminal_modes P_ ((struct terminal *));
341 static void x_clear_frame P_ ((struct frame *));
342 static void frame_highlight P_ ((struct frame *));
343 static void frame_unhighlight P_ ((struct frame *));
344 static void x_new_focus_frame P_ ((struct x_display_info *, struct frame *));
345 static void x_focus_changed P_ ((int, int, struct x_display_info *,
346 struct frame *, struct input_event *));
347 static void x_detect_focus_change P_ ((struct x_display_info *,
348 XEvent *, struct input_event *));
349 static void XTframe_rehighlight P_ ((struct frame *));
350 static void x_frame_rehighlight P_ ((struct x_display_info *));
351 static void x_draw_hollow_cursor P_ ((struct window *, struct glyph_row *));
352 static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int,
353 enum text_cursor_kinds));
355 static void x_clip_to_row P_ ((struct window *, struct glyph_row *, int, GC));
356 static void x_flush P_ ((struct frame *f));
357 static void x_update_begin P_ ((struct frame *));
358 static void x_update_window_begin P_ ((struct window *));
359 static void x_after_update_window_line P_ ((struct glyph_row *));
360 static struct scroll_bar *x_window_to_scroll_bar P_ ((Display *, Window));
361 static void x_scroll_bar_report_motion P_ ((struct frame **, Lisp_Object *,
362 enum scroll_bar_part *,
363 Lisp_Object *, Lisp_Object *,
364 unsigned long *));
365 static void x_check_fullscreen P_ ((struct frame *));
366 static void x_check_expected_move P_ ((struct frame *, int, int));
367 static void x_sync_with_move P_ ((struct frame *, int, int, int));
368 static int handle_one_xevent P_ ((struct x_display_info *, XEvent *,
369 int *, struct input_event *));
370 /* Don't declare this NO_RETURN because we want no
371 interference with debugging failing X calls. */
372 static SIGTYPE x_connection_closed P_ ((Display *, char *));
375 /* Flush display of frame F, or of all frames if F is null. */
377 static void
378 x_flush (f)
379 struct frame *f;
381 /* Don't call XFlush when it is not safe to redisplay; the X
382 connection may be broken. */
383 if (!NILP (Vinhibit_redisplay))
384 return;
386 BLOCK_INPUT;
387 if (f == NULL)
389 Lisp_Object rest, frame;
390 FOR_EACH_FRAME (rest, frame)
391 if (FRAME_X_P (XFRAME (frame)))
392 x_flush (XFRAME (frame));
394 else if (FRAME_X_P (f))
395 XFlush (FRAME_X_DISPLAY (f));
396 UNBLOCK_INPUT;
400 /* Remove calls to XFlush by defining XFlush to an empty replacement.
401 Calls to XFlush should be unnecessary because the X output buffer
402 is flushed automatically as needed by calls to XPending,
403 XNextEvent, or XWindowEvent according to the XFlush man page.
404 XTread_socket calls XPending. Removing XFlush improves
405 performance. */
407 #define XFlush(DISPLAY) (void) 0
410 /***********************************************************************
411 Debugging
412 ***********************************************************************/
414 #if 0
416 /* This is a function useful for recording debugging information about
417 the sequence of occurrences in this file. */
419 struct record
421 char *locus;
422 int type;
425 struct record event_record[100];
427 int event_record_index;
429 record_event (locus, type)
430 char *locus;
431 int type;
433 if (event_record_index == sizeof (event_record) / sizeof (struct record))
434 event_record_index = 0;
436 event_record[event_record_index].locus = locus;
437 event_record[event_record_index].type = type;
438 event_record_index++;
441 #endif /* 0 */
445 /* Return the struct x_display_info corresponding to DPY. */
447 struct x_display_info *
448 x_display_info_for_display (dpy)
449 Display *dpy;
451 struct x_display_info *dpyinfo;
453 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
454 if (dpyinfo->display == dpy)
455 return dpyinfo;
457 return 0;
460 #define OPAQUE 0xffffffff
461 #define OPACITY "_NET_WM_WINDOW_OPACITY"
463 void
464 x_set_frame_alpha (f)
465 struct frame *f;
467 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
468 Display *dpy = FRAME_X_DISPLAY (f);
469 Window win = FRAME_OUTER_WINDOW (f);
470 double alpha = 1.0;
471 double alpha_min = 1.0;
472 unsigned long opac;
474 if (FRAME_X_DISPLAY_INFO (f)->root_window != FRAME_X_OUTPUT (f)->parent_desc)
475 /* Since the WM decoration lies under the FRAME_OUTER_WINDOW,
476 we must treat the former instead of the latter. */
477 win = FRAME_X_OUTPUT(f)->parent_desc;
479 if (dpyinfo->x_highlight_frame == f)
480 alpha = f->alpha[0];
481 else
482 alpha = f->alpha[1];
484 if (FLOATP (Vframe_alpha_lower_limit))
485 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
486 else if (INTEGERP (Vframe_alpha_lower_limit))
487 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
489 if (alpha < 0.0 || 1.0 < alpha)
490 alpha = 1.0;
491 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
492 alpha = alpha_min;
494 opac = alpha * OPAQUE;
496 /* return unless necessary */
498 unsigned char *data;
499 Atom actual;
500 int format;
501 unsigned long n, left;
503 XGetWindowProperty(dpy, win, XInternAtom(dpy, OPACITY, False),
504 0L, 1L, False, XA_CARDINAL, &actual, &format, &n, &left,
505 &data);
506 if (actual != None)
507 if (*(unsigned long *)data == opac)
509 XFree ((void *) data);
510 return;
512 else
513 XFree ((void *) data);
516 XChangeProperty (dpy, win, XInternAtom (dpy, OPACITY, False),
517 XA_CARDINAL, 32, PropModeReplace,
518 (unsigned char *) &opac, 1L);
519 XSync (dpy, False);
523 /***********************************************************************
524 Starting and ending an update
525 ***********************************************************************/
527 /* Start an update of frame F. This function is installed as a hook
528 for update_begin, i.e. it is called when update_begin is called.
529 This function is called prior to calls to x_update_window_begin for
530 each window being updated. Currently, there is nothing to do here
531 because all interesting stuff is done on a window basis. */
533 static void
534 x_update_begin (f)
535 struct frame *f;
537 /* Nothing to do. */
541 /* Start update of window W. Set the global variable updated_window
542 to the window being updated and set output_cursor to the cursor
543 position of W. */
545 static void
546 x_update_window_begin (w)
547 struct window *w;
549 struct frame *f = XFRAME (WINDOW_FRAME (w));
550 struct x_display_info *display_info = FRAME_X_DISPLAY_INFO (f);
552 updated_window = w;
553 set_output_cursor (&w->cursor);
555 BLOCK_INPUT;
557 if (f == display_info->mouse_face_mouse_frame)
559 /* Don't do highlighting for mouse motion during the update. */
560 display_info->mouse_face_defer = 1;
562 /* If F needs to be redrawn, simply forget about any prior mouse
563 highlighting. */
564 if (FRAME_GARBAGED_P (f))
565 display_info->mouse_face_window = Qnil;
567 #if 0 /* Rows in a current matrix containing glyphs in mouse-face have
568 their mouse_face_p flag set, which means that they are always
569 unequal to rows in a desired matrix which never have that
570 flag set. So, rows containing mouse-face glyphs are never
571 scrolled, and we don't have to switch the mouse highlight off
572 here to prevent it from being scrolled. */
574 /* Can we tell that this update does not affect the window
575 where the mouse highlight is? If so, no need to turn off.
576 Likewise, don't do anything if the frame is garbaged;
577 in that case, the frame's current matrix that we would use
578 is all wrong, and we will redisplay that line anyway. */
579 if (!NILP (display_info->mouse_face_window)
580 && w == XWINDOW (display_info->mouse_face_window))
582 int i;
584 for (i = 0; i < w->desired_matrix->nrows; ++i)
585 if (MATRIX_ROW_ENABLED_P (w->desired_matrix, i))
586 break;
588 if (i < w->desired_matrix->nrows)
589 clear_mouse_face (display_info);
591 #endif /* 0 */
594 UNBLOCK_INPUT;
598 /* Draw a vertical window border from (x,y0) to (x,y1) */
600 static void
601 x_draw_vertical_window_border (w, x, y0, y1)
602 struct window *w;
603 int x, y0, y1;
605 struct frame *f = XFRAME (WINDOW_FRAME (w));
606 struct face *face;
608 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
609 if (face)
610 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
611 face->foreground);
613 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
614 f->output_data.x->normal_gc, x, y0, x, y1);
617 /* End update of window W (which is equal to updated_window).
619 Draw vertical borders between horizontally adjacent windows, and
620 display W's cursor if CURSOR_ON_P is non-zero.
622 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
623 glyphs in mouse-face were overwritten. In that case we have to
624 make sure that the mouse-highlight is properly redrawn.
626 W may be a menu bar pseudo-window in case we don't have X toolkit
627 support. Such windows don't have a cursor, so don't display it
628 here. */
630 static void
631 x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
632 struct window *w;
633 int cursor_on_p, mouse_face_overwritten_p;
635 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
637 if (!w->pseudo_window_p)
639 BLOCK_INPUT;
641 if (cursor_on_p)
642 display_and_set_cursor (w, 1, output_cursor.hpos,
643 output_cursor.vpos,
644 output_cursor.x, output_cursor.y);
646 if (draw_window_fringes (w, 1))
647 x_draw_vertical_border (w);
649 UNBLOCK_INPUT;
652 /* If a row with mouse-face was overwritten, arrange for
653 XTframe_up_to_date to redisplay the mouse highlight. */
654 if (mouse_face_overwritten_p)
656 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
657 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
658 dpyinfo->mouse_face_window = Qnil;
661 updated_window = NULL;
665 /* End update of frame F. This function is installed as a hook in
666 update_end. */
668 static void
669 x_update_end (f)
670 struct frame *f;
672 /* Mouse highlight may be displayed again. */
673 FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
675 #ifndef XFlush
676 BLOCK_INPUT;
677 XFlush (FRAME_X_DISPLAY (f));
678 UNBLOCK_INPUT;
679 #endif
683 /* This function is called from various places in xdisp.c whenever a
684 complete update has been performed. The global variable
685 updated_window is not available here. */
687 static void
688 XTframe_up_to_date (f)
689 struct frame *f;
691 if (FRAME_X_P (f))
693 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
695 if (dpyinfo->mouse_face_deferred_gc
696 || f == dpyinfo->mouse_face_mouse_frame)
698 BLOCK_INPUT;
699 if (dpyinfo->mouse_face_mouse_frame)
700 note_mouse_highlight (dpyinfo->mouse_face_mouse_frame,
701 dpyinfo->mouse_face_mouse_x,
702 dpyinfo->mouse_face_mouse_y);
703 dpyinfo->mouse_face_deferred_gc = 0;
704 UNBLOCK_INPUT;
710 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
711 arrow bitmaps, or clear the fringes if no bitmaps are required
712 before DESIRED_ROW is made current. The window being updated is
713 found in updated_window. This function It is called from
714 update_window_line only if it is known that there are differences
715 between bitmaps to be drawn between current row and DESIRED_ROW. */
717 static void
718 x_after_update_window_line (desired_row)
719 struct glyph_row *desired_row;
721 struct window *w = updated_window;
722 struct frame *f;
723 int width, height;
725 xassert (w);
727 if (!desired_row->mode_line_p && !w->pseudo_window_p)
728 desired_row->redraw_fringe_bitmaps_p = 1;
730 /* When a window has disappeared, make sure that no rest of
731 full-width rows stays visible in the internal border. Could
732 check here if updated_window is the leftmost/rightmost window,
733 but I guess it's not worth doing since vertically split windows
734 are almost never used, internal border is rarely set, and the
735 overhead is very small. */
736 if (windows_or_buffers_changed
737 && desired_row->full_width_p
738 && (f = XFRAME (w->frame),
739 width = FRAME_INTERNAL_BORDER_WIDTH (f),
740 width != 0)
741 && (height = desired_row->visible_height,
742 height > 0))
744 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
746 /* Internal border is drawn below the tool bar. */
747 if (WINDOWP (f->tool_bar_window)
748 && w == XWINDOW (f->tool_bar_window))
749 y -= width;
751 BLOCK_INPUT;
752 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
753 0, y, width, height, False);
754 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
755 FRAME_PIXEL_WIDTH (f) - width,
756 y, width, height, False);
757 UNBLOCK_INPUT;
761 static void
762 x_draw_fringe_bitmap (w, row, p)
763 struct window *w;
764 struct glyph_row *row;
765 struct draw_fringe_bitmap_params *p;
767 struct frame *f = XFRAME (WINDOW_FRAME (w));
768 Display *display = FRAME_X_DISPLAY (f);
769 Window window = FRAME_X_WINDOW (f);
770 GC gc = f->output_data.x->normal_gc;
771 struct face *face = p->face;
772 int rowY;
774 /* Must clip because of partially visible lines. */
775 rowY = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
776 if (p->y < rowY)
778 /* Adjust position of "bottom aligned" bitmap on partially
779 visible last row. */
780 int oldY = row->y;
781 int oldVH = row->visible_height;
782 row->visible_height = p->h;
783 row->y -= rowY - p->y;
784 x_clip_to_row (w, row, -1, gc);
785 row->y = oldY;
786 row->visible_height = oldVH;
788 else
789 x_clip_to_row (w, row, -1, gc);
791 if (!p->overlay_p)
793 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
795 /* In case the same realized face is used for fringes and
796 for something displayed in the text (e.g. face `region' on
797 mono-displays, the fill style may have been changed to
798 FillSolid in x_draw_glyph_string_background. */
799 if (face->stipple)
800 XSetFillStyle (display, face->gc, FillOpaqueStippled);
801 else
802 XSetForeground (display, face->gc, face->background);
804 #ifdef USE_TOOLKIT_SCROLL_BARS
805 /* If the fringe is adjacent to the left (right) scroll bar of a
806 leftmost (rightmost, respectively) window, then extend its
807 background to the gap between the fringe and the bar. */
808 if ((WINDOW_LEFTMOST_P (w)
809 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
810 || (WINDOW_RIGHTMOST_P (w)
811 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
813 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
815 if (sb_width > 0)
817 int left = WINDOW_SCROLL_BAR_AREA_X (w);
818 int width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
819 * FRAME_COLUMN_WIDTH (f));
821 if (bx < 0)
823 /* Bitmap fills the fringe. */
824 if (left + width == p->x)
825 bx = left + sb_width;
826 else if (p->x + p->wd == left)
827 bx = left;
828 if (bx >= 0)
830 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
832 nx = width - sb_width;
833 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
834 row->y));
835 ny = row->visible_height;
838 else
840 if (left + width == bx)
842 bx = left + sb_width;
843 nx += width - sb_width;
845 else if (bx + nx == left)
846 nx += width - sb_width;
850 #endif
851 if (bx >= 0 && nx > 0)
852 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
854 if (!face->stipple)
855 XSetForeground (display, face->gc, face->foreground);
858 if (p->which)
860 unsigned char *bits;
861 Pixmap pixmap, clipmask = (Pixmap) 0;
862 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
863 XGCValues gcv;
865 if (p->wd > 8)
866 bits = (unsigned char *)(p->bits + p->dh);
867 else
868 bits = (unsigned char *)p->bits + p->dh;
870 /* Draw the bitmap. I believe these small pixmaps can be cached
871 by the server. */
872 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
873 (p->cursor_p
874 ? (p->overlay_p ? face->background
875 : f->output_data.x->cursor_pixel)
876 : face->foreground),
877 face->background, depth);
879 if (p->overlay_p)
881 clipmask = XCreatePixmapFromBitmapData (display,
882 FRAME_X_DISPLAY_INFO (f)->root_window,
883 bits, p->wd, p->h,
884 1, 0, 1);
885 gcv.clip_mask = clipmask;
886 gcv.clip_x_origin = p->x;
887 gcv.clip_y_origin = p->y;
888 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
891 XCopyArea (display, pixmap, window, gc, 0, 0,
892 p->wd, p->h, p->x, p->y);
893 XFreePixmap (display, pixmap);
895 if (p->overlay_p)
897 gcv.clip_mask = (Pixmap) 0;
898 XChangeGC (display, gc, GCClipMask, &gcv);
899 XFreePixmap (display, clipmask);
903 XSetClipMask (display, gc, None);
908 /* This is called when starting Emacs and when restarting after
909 suspend. When starting Emacs, no X window is mapped. And nothing
910 must be done to Emacs's own window if it is suspended (though that
911 rarely happens). */
913 static void
914 XTset_terminal_modes (struct terminal *terminal)
918 /* This is called when exiting or suspending Emacs. Exiting will make
919 the X-windows go away, and suspending requires no action. */
921 static void
922 XTreset_terminal_modes (struct terminal *terminal)
927 /***********************************************************************
928 Glyph display
929 ***********************************************************************/
933 static void x_set_glyph_string_clipping P_ ((struct glyph_string *));
934 static void x_set_glyph_string_gc P_ ((struct glyph_string *));
935 static void x_draw_glyph_string_background P_ ((struct glyph_string *,
936 int));
937 static void x_draw_glyph_string_foreground P_ ((struct glyph_string *));
938 static void x_draw_composite_glyph_string_foreground P_ ((struct glyph_string *));
939 static void x_draw_glyph_string_box P_ ((struct glyph_string *));
940 static void x_draw_glyph_string P_ ((struct glyph_string *));
941 static void x_compute_glyph_string_overhangs P_ ((struct glyph_string *));
942 static void x_set_cursor_gc P_ ((struct glyph_string *));
943 static void x_set_mode_line_face_gc P_ ((struct glyph_string *));
944 static void x_set_mouse_face_gc P_ ((struct glyph_string *));
945 static int x_alloc_lighter_color P_ ((struct frame *, Display *, Colormap,
946 unsigned long *, double, int));
947 static void x_setup_relief_color P_ ((struct frame *, struct relief *,
948 double, int, unsigned long));
949 static void x_setup_relief_colors P_ ((struct glyph_string *));
950 static void x_draw_image_glyph_string P_ ((struct glyph_string *));
951 static void x_draw_image_relief P_ ((struct glyph_string *));
952 static void x_draw_image_foreground P_ ((struct glyph_string *));
953 static void x_draw_image_foreground_1 P_ ((struct glyph_string *, Pixmap));
954 static void x_clear_glyph_string_rect P_ ((struct glyph_string *, int,
955 int, int, int));
956 static void x_draw_relief_rect P_ ((struct frame *, int, int, int, int,
957 int, int, int, int, int, int,
958 XRectangle *));
959 static void x_draw_box_rect P_ ((struct glyph_string *, int, int, int, int,
960 int, int, int, XRectangle *));
962 #if GLYPH_DEBUG
963 static void x_check_font P_ ((struct frame *, struct font *));
964 #endif
967 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
968 face. */
970 static void
971 x_set_cursor_gc (s)
972 struct glyph_string *s;
974 if (s->font == FRAME_FONT (s->f)
975 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
976 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
977 && !s->cmp)
978 s->gc = s->f->output_data.x->cursor_gc;
979 else
981 /* Cursor on non-default face: must merge. */
982 XGCValues xgcv;
983 unsigned long mask;
985 xgcv.background = s->f->output_data.x->cursor_pixel;
986 xgcv.foreground = s->face->background;
988 /* If the glyph would be invisible, try a different foreground. */
989 if (xgcv.foreground == xgcv.background)
990 xgcv.foreground = s->face->foreground;
991 if (xgcv.foreground == xgcv.background)
992 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
993 if (xgcv.foreground == xgcv.background)
994 xgcv.foreground = s->face->foreground;
996 /* Make sure the cursor is distinct from text in this face. */
997 if (xgcv.background == s->face->background
998 && xgcv.foreground == s->face->foreground)
1000 xgcv.background = s->face->foreground;
1001 xgcv.foreground = s->face->background;
1004 IF_DEBUG (x_check_font (s->f, s->font));
1005 xgcv.graphics_exposures = False;
1006 mask = GCForeground | GCBackground | GCGraphicsExposures;
1008 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1009 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1010 mask, &xgcv);
1011 else
1012 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1013 = XCreateGC (s->display, s->window, mask, &xgcv);
1015 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1020 /* Set up S->gc of glyph string S for drawing text in mouse face. */
1022 static void
1023 x_set_mouse_face_gc (s)
1024 struct glyph_string *s;
1026 int face_id;
1027 struct face *face;
1029 /* What face has to be used last for the mouse face? */
1030 face_id = FRAME_X_DISPLAY_INFO (s->f)->mouse_face_face_id;
1031 face = FACE_FROM_ID (s->f, face_id);
1032 if (face == NULL)
1033 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
1035 if (s->first_glyph->type == CHAR_GLYPH)
1036 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1037 else
1038 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1039 s->face = FACE_FROM_ID (s->f, face_id);
1040 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1042 if (s->font == s->face->font)
1043 s->gc = s->face->gc;
1044 else
1046 /* Otherwise construct scratch_cursor_gc with values from FACE
1047 except for FONT. */
1048 XGCValues xgcv;
1049 unsigned long mask;
1051 xgcv.background = s->face->background;
1052 xgcv.foreground = s->face->foreground;
1053 xgcv.graphics_exposures = False;
1054 mask = GCForeground | GCBackground | GCGraphicsExposures;
1056 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1057 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1058 mask, &xgcv);
1059 else
1060 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1061 = XCreateGC (s->display, s->window, mask, &xgcv);
1063 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1066 xassert (s->gc != 0);
1070 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1071 Faces to use in the mode line have already been computed when the
1072 matrix was built, so there isn't much to do, here. */
1074 static INLINE void
1075 x_set_mode_line_face_gc (s)
1076 struct glyph_string *s;
1078 s->gc = s->face->gc;
1082 /* Set S->gc of glyph string S for drawing that glyph string. Set
1083 S->stippled_p to a non-zero value if the face of S has a stipple
1084 pattern. */
1086 static INLINE void
1087 x_set_glyph_string_gc (s)
1088 struct glyph_string *s;
1090 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1092 if (s->hl == DRAW_NORMAL_TEXT)
1094 s->gc = s->face->gc;
1095 s->stippled_p = s->face->stipple != 0;
1097 else if (s->hl == DRAW_INVERSE_VIDEO)
1099 x_set_mode_line_face_gc (s);
1100 s->stippled_p = s->face->stipple != 0;
1102 else if (s->hl == DRAW_CURSOR)
1104 x_set_cursor_gc (s);
1105 s->stippled_p = 0;
1107 else if (s->hl == DRAW_MOUSE_FACE)
1109 x_set_mouse_face_gc (s);
1110 s->stippled_p = s->face->stipple != 0;
1112 else if (s->hl == DRAW_IMAGE_RAISED
1113 || s->hl == DRAW_IMAGE_SUNKEN)
1115 s->gc = s->face->gc;
1116 s->stippled_p = s->face->stipple != 0;
1118 else
1120 s->gc = s->face->gc;
1121 s->stippled_p = s->face->stipple != 0;
1124 /* GC must have been set. */
1125 xassert (s->gc != 0);
1129 /* Set clipping for output of glyph string S. S may be part of a mode
1130 line or menu if we don't have X toolkit support. */
1132 static INLINE void
1133 x_set_glyph_string_clipping (s)
1134 struct glyph_string *s;
1136 XRectangle *r = s->clip;
1137 int n = get_glyph_string_clip_rects (s, r, 2);
1139 if (n > 0)
1140 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1141 s->num_clips = n;
1145 /* Set SRC's clipping for output of glyph string DST. This is called
1146 when we are drawing DST's left_overhang or right_overhang only in
1147 the area of SRC. */
1149 static void
1150 x_set_glyph_string_clipping_exactly (src, dst)
1151 struct glyph_string *src, *dst;
1153 XRectangle r;
1155 r.x = src->x;
1156 r.width = src->width;
1157 r.y = src->y;
1158 r.height = src->height;
1159 dst->clip[0] = r;
1160 dst->num_clips = 1;
1161 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1165 /* RIF:
1166 Compute left and right overhang of glyph string S. */
1168 static void
1169 x_compute_glyph_string_overhangs (s)
1170 struct glyph_string *s;
1172 if (s->cmp == NULL
1173 && s->first_glyph->type == CHAR_GLYPH)
1175 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1176 struct font *font = s->font;
1177 struct font_metrics metrics;
1178 int i;
1180 for (i = 0; i < s->nchars; i++)
1181 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1182 font->driver->text_extents (font, code, s->nchars, &metrics);
1183 s->right_overhang = (metrics.rbearing > metrics.width
1184 ? metrics.rbearing - metrics.width : 0);
1185 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1187 else if (s->cmp)
1189 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1190 s->left_overhang = - s->cmp->lbearing;
1195 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1197 static INLINE void
1198 x_clear_glyph_string_rect (s, x, y, w, h)
1199 struct glyph_string *s;
1200 int x, y, w, h;
1202 XGCValues xgcv;
1203 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1204 XSetForeground (s->display, s->gc, xgcv.background);
1205 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1206 XSetForeground (s->display, s->gc, xgcv.foreground);
1210 /* Draw the background of glyph_string S. If S->background_filled_p
1211 is non-zero don't draw it. FORCE_P non-zero means draw the
1212 background even if it wouldn't be drawn normally. This is used
1213 when a string preceding S draws into the background of S, or S
1214 contains the first component of a composition. */
1216 static void
1217 x_draw_glyph_string_background (s, force_p)
1218 struct glyph_string *s;
1219 int force_p;
1221 /* Nothing to do if background has already been drawn or if it
1222 shouldn't be drawn in the first place. */
1223 if (!s->background_filled_p)
1225 int box_line_width = max (s->face->box_line_width, 0);
1227 if (s->stippled_p)
1229 /* Fill background with a stipple pattern. */
1230 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1231 XFillRectangle (s->display, s->window, s->gc, s->x,
1232 s->y + box_line_width,
1233 s->background_width,
1234 s->height - 2 * box_line_width);
1235 XSetFillStyle (s->display, s->gc, FillSolid);
1236 s->background_filled_p = 1;
1238 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1239 || s->font_not_found_p
1240 || s->extends_to_end_of_line_p
1241 || force_p)
1243 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1244 s->background_width,
1245 s->height - 2 * box_line_width);
1246 s->background_filled_p = 1;
1252 /* Draw the foreground of glyph string S. */
1254 static void
1255 x_draw_glyph_string_foreground (s)
1256 struct glyph_string *s;
1258 int i, x;
1260 /* If first glyph of S has a left box line, start drawing the text
1261 of S to the right of that box line. */
1262 if (s->face->box != FACE_NO_BOX
1263 && s->first_glyph->left_box_line_p)
1264 x = s->x + eabs (s->face->box_line_width);
1265 else
1266 x = s->x;
1268 /* Draw characters of S as rectangles if S's font could not be
1269 loaded. */
1270 if (s->font_not_found_p)
1272 for (i = 0; i < s->nchars; ++i)
1274 struct glyph *g = s->first_glyph + i;
1275 XDrawRectangle (s->display, s->window,
1276 s->gc, x, s->y, g->pixel_width - 1,
1277 s->height - 1);
1278 x += g->pixel_width;
1281 else
1283 struct font *font = s->font;
1284 int boff = font->baseline_offset;
1285 int y;
1287 if (font->vertical_centering)
1288 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1290 y = s->ybase - boff;
1291 if (s->for_overlaps
1292 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1293 font->driver->draw (s, 0, s->nchars, x, y, 0);
1294 else
1295 font->driver->draw (s, 0, s->nchars, x, y, 1);
1296 if (s->face->overstrike)
1297 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1301 /* Draw the foreground of composite glyph string S. */
1303 static void
1304 x_draw_composite_glyph_string_foreground (s)
1305 struct glyph_string *s;
1307 int i, j, x;
1309 /* If first glyph of S has a left box line, start drawing the text
1310 of S to the right of that box line. */
1311 if (s->face && s->face->box != FACE_NO_BOX
1312 && s->first_glyph->left_box_line_p)
1313 x = s->x + eabs (s->face->box_line_width);
1314 else
1315 x = s->x;
1317 /* S is a glyph string for a composition. S->gidx is the index of
1318 the first character drawn for glyphs of this composition.
1319 S->gidx == 0 means we are drawing the very first character of
1320 this composition. */
1322 /* Draw a rectangle for the composition if the font for the very
1323 first character of the composition could not be loaded. */
1324 if (s->font_not_found_p)
1326 if (s->gidx == 0)
1327 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1328 s->width - 1, s->height - 1);
1330 else
1332 struct font *font = s->font;
1333 int y = s->ybase;
1334 int width = 0;
1336 if (s->cmp->method == COMPOSITION_WITH_GLYPH_STRING)
1338 Lisp_Object gstring = AREF (XHASH_TABLE (composition_hash_table)
1339 ->key_and_value,
1340 s->cmp->hash_index * 2);
1341 int from;
1343 for (i = from = 0; i < s->nchars; i++)
1345 Lisp_Object g = LGSTRING_GLYPH (gstring, i);
1346 Lisp_Object adjustment = LGLYPH_ADJUSTMENT (g);
1347 int xoff, yoff, wadjust;
1349 if (! VECTORP (adjustment))
1351 width += LGLYPH_WIDTH (g);
1352 continue;
1354 if (from < i)
1356 font->driver->draw (s, from, i, x, y, 0);
1357 x += width;
1359 xoff = XINT (AREF (adjustment, 0));
1360 yoff = XINT (AREF (adjustment, 1));
1361 wadjust = XINT (AREF (adjustment, 2));
1363 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1364 x += wadjust;
1365 from = i + 1;
1366 width = 0;
1368 if (from < i)
1369 font->driver->draw (s, from, i, x, y, 0);
1371 else
1373 for (i = 0, j = s->gidx; i < s->nchars; i++, j++)
1374 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1376 int xx = x + s->cmp->offsets[j * 2];
1377 int yy = y - s->cmp->offsets[j * 2 + 1];
1379 font->driver->draw (s, j, j + 1, xx, yy, 0);
1380 if (s->face->overstrike)
1381 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1388 #ifdef USE_X_TOOLKIT
1390 static struct frame *x_frame_of_widget P_ ((Widget));
1391 static Boolean cvt_string_to_pixel P_ ((Display *, XrmValue *, Cardinal *,
1392 XrmValue *, XrmValue *, XtPointer *));
1393 static void cvt_pixel_dtor P_ ((XtAppContext, XrmValue *, XtPointer,
1394 XrmValue *, Cardinal *));
1397 /* Return the frame on which widget WIDGET is used.. Abort if frame
1398 cannot be determined. */
1400 static struct frame *
1401 x_frame_of_widget (widget)
1402 Widget widget;
1404 struct x_display_info *dpyinfo;
1405 Lisp_Object tail;
1406 struct frame *f;
1408 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1410 /* Find the top-level shell of the widget. Note that this function
1411 can be called when the widget is not yet realized, so XtWindow
1412 (widget) == 0. That's the reason we can't simply use
1413 x_any_window_to_frame. */
1414 while (!XtIsTopLevelShell (widget))
1415 widget = XtParent (widget);
1417 /* Look for a frame with that top-level widget. Allocate the color
1418 on that frame to get the right gamma correction value. */
1419 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1420 if (FRAMEP (XCAR (tail))
1421 && (f = XFRAME (XCAR (tail)),
1422 (FRAME_X_P (f)
1423 && f->output_data.nothing != 1
1424 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1425 && f->output_data.x->widget == widget)
1426 return f;
1428 abort ();
1432 /* Allocate the color COLOR->pixel on the screen and display of
1433 widget WIDGET in colormap CMAP. If an exact match cannot be
1434 allocated, try the nearest color available. Value is non-zero
1435 if successful. This is called from lwlib. */
1438 x_alloc_nearest_color_for_widget (widget, cmap, color)
1439 Widget widget;
1440 Colormap cmap;
1441 XColor *color;
1443 struct frame *f = x_frame_of_widget (widget);
1444 return x_alloc_nearest_color (f, cmap, color);
1448 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1449 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1450 If this produces the same color as PIXEL, try a color where all RGB
1451 values have DELTA added. Return the allocated color in *PIXEL.
1452 DISPLAY is the X display, CMAP is the colormap to operate on.
1453 Value is non-zero if successful. */
1456 x_alloc_lighter_color_for_widget (widget, display, cmap, pixel, factor, delta)
1457 Widget widget;
1458 Display *display;
1459 Colormap cmap;
1460 unsigned long *pixel;
1461 double factor;
1462 int delta;
1464 struct frame *f = x_frame_of_widget (widget);
1465 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1469 /* Structure specifying which arguments should be passed by Xt to
1470 cvt_string_to_pixel. We want the widget's screen and colormap. */
1472 static XtConvertArgRec cvt_string_to_pixel_args[] =
1474 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1475 sizeof (Screen *)},
1476 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1477 sizeof (Colormap)}
1481 /* The address of this variable is returned by
1482 cvt_string_to_pixel. */
1484 static Pixel cvt_string_to_pixel_value;
1487 /* Convert a color name to a pixel color.
1489 DPY is the display we are working on.
1491 ARGS is an array of *NARGS XrmValue structures holding additional
1492 information about the widget for which the conversion takes place.
1493 The contents of this array are determined by the specification
1494 in cvt_string_to_pixel_args.
1496 FROM is a pointer to an XrmValue which points to the color name to
1497 convert. TO is an XrmValue in which to return the pixel color.
1499 CLOSURE_RET is a pointer to user-data, in which we record if
1500 we allocated the color or not.
1502 Value is True if successful, False otherwise. */
1504 static Boolean
1505 cvt_string_to_pixel (dpy, args, nargs, from, to, closure_ret)
1506 Display *dpy;
1507 XrmValue *args;
1508 Cardinal *nargs;
1509 XrmValue *from, *to;
1510 XtPointer *closure_ret;
1512 Screen *screen;
1513 Colormap cmap;
1514 Pixel pixel;
1515 String color_name;
1516 XColor color;
1518 if (*nargs != 2)
1520 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1521 "wrongParameters", "cvt_string_to_pixel",
1522 "XtToolkitError",
1523 "Screen and colormap args required", NULL, NULL);
1524 return False;
1527 screen = *(Screen **) args[0].addr;
1528 cmap = *(Colormap *) args[1].addr;
1529 color_name = (String) from->addr;
1531 if (strcmp (color_name, XtDefaultBackground) == 0)
1533 *closure_ret = (XtPointer) False;
1534 pixel = WhitePixelOfScreen (screen);
1536 else if (strcmp (color_name, XtDefaultForeground) == 0)
1538 *closure_ret = (XtPointer) False;
1539 pixel = BlackPixelOfScreen (screen);
1541 else if (XParseColor (dpy, cmap, color_name, &color)
1542 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1544 pixel = color.pixel;
1545 *closure_ret = (XtPointer) True;
1547 else
1549 String params[1];
1550 Cardinal nparams = 1;
1552 params[0] = color_name;
1553 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1554 "badValue", "cvt_string_to_pixel",
1555 "XtToolkitError", "Invalid color `%s'",
1556 params, &nparams);
1557 return False;
1560 if (to->addr != NULL)
1562 if (to->size < sizeof (Pixel))
1564 to->size = sizeof (Pixel);
1565 return False;
1568 *(Pixel *) to->addr = pixel;
1570 else
1572 cvt_string_to_pixel_value = pixel;
1573 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1576 to->size = sizeof (Pixel);
1577 return True;
1581 /* Free a pixel color which was previously allocated via
1582 cvt_string_to_pixel. This is registered as the destructor
1583 for this type of resource via XtSetTypeConverter.
1585 APP is the application context in which we work.
1587 TO is a pointer to an XrmValue holding the color to free.
1588 CLOSURE is the value we stored in CLOSURE_RET for this color
1589 in cvt_string_to_pixel.
1591 ARGS and NARGS are like for cvt_string_to_pixel. */
1593 static void
1594 cvt_pixel_dtor (app, to, closure, args, nargs)
1595 XtAppContext app;
1596 XrmValuePtr to;
1597 XtPointer closure;
1598 XrmValuePtr args;
1599 Cardinal *nargs;
1601 if (*nargs != 2)
1603 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1604 "XtToolkitError",
1605 "Screen and colormap arguments required",
1606 NULL, NULL);
1608 else if (closure != NULL)
1610 /* We did allocate the pixel, so free it. */
1611 Screen *screen = *(Screen **) args[0].addr;
1612 Colormap cmap = *(Colormap *) args[1].addr;
1613 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1614 (Pixel *) to->addr, 1);
1619 #endif /* USE_X_TOOLKIT */
1622 /* Value is an array of XColor structures for the contents of the
1623 color map of display DPY. Set *NCELLS to the size of the array.
1624 Note that this probably shouldn't be called for large color maps,
1625 say a 24-bit TrueColor map. */
1627 static const XColor *
1628 x_color_cells (dpy, ncells)
1629 Display *dpy;
1630 int *ncells;
1632 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1634 if (dpyinfo->color_cells == NULL)
1636 Screen *screen = dpyinfo->screen;
1637 int i;
1639 dpyinfo->ncolor_cells
1640 = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1641 dpyinfo->color_cells
1642 = (XColor *) xmalloc (dpyinfo->ncolor_cells
1643 * sizeof *dpyinfo->color_cells);
1645 for (i = 0; i < dpyinfo->ncolor_cells; ++i)
1646 dpyinfo->color_cells[i].pixel = i;
1648 XQueryColors (dpy, dpyinfo->cmap,
1649 dpyinfo->color_cells, dpyinfo->ncolor_cells);
1652 *ncells = dpyinfo->ncolor_cells;
1653 return dpyinfo->color_cells;
1657 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1658 colors in COLORS. Use cached information, if available. */
1660 void
1661 x_query_colors (f, colors, ncolors)
1662 struct frame *f;
1663 XColor *colors;
1664 int ncolors;
1666 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1668 if (dpyinfo->color_cells)
1670 int i;
1671 for (i = 0; i < ncolors; ++i)
1673 unsigned long pixel = colors[i].pixel;
1674 xassert (pixel < dpyinfo->ncolor_cells);
1675 xassert (dpyinfo->color_cells[pixel].pixel == pixel);
1676 colors[i] = dpyinfo->color_cells[pixel];
1679 else
1680 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1684 /* On frame F, translate pixel color to RGB values for the color in
1685 COLOR. Use cached information, if available. */
1687 void
1688 x_query_color (f, color)
1689 struct frame *f;
1690 XColor *color;
1692 x_query_colors (f, color, 1);
1696 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1697 exact match can't be allocated, try the nearest color available.
1698 Value is non-zero if successful. Set *COLOR to the color
1699 allocated. */
1701 static int
1702 x_alloc_nearest_color_1 (dpy, cmap, color)
1703 Display *dpy;
1704 Colormap cmap;
1705 XColor *color;
1707 int rc;
1709 rc = XAllocColor (dpy, cmap, color);
1710 if (rc == 0)
1712 /* If we got to this point, the colormap is full, so we're going
1713 to try to get the next closest color. The algorithm used is
1714 a least-squares matching, which is what X uses for closest
1715 color matching with StaticColor visuals. */
1716 int nearest, i;
1717 unsigned long nearest_delta = ~0;
1718 int ncells;
1719 const XColor *cells = x_color_cells (dpy, &ncells);
1721 for (nearest = i = 0; i < ncells; ++i)
1723 long dred = (color->red >> 8) - (cells[i].red >> 8);
1724 long dgreen = (color->green >> 8) - (cells[i].green >> 8);
1725 long dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1726 unsigned long delta = dred * dred + dgreen * dgreen + dblue * dblue;
1728 if (delta < nearest_delta)
1730 nearest = i;
1731 nearest_delta = delta;
1735 color->red = cells[nearest].red;
1736 color->green = cells[nearest].green;
1737 color->blue = cells[nearest].blue;
1738 rc = XAllocColor (dpy, cmap, color);
1740 else
1742 /* If allocation succeeded, and the allocated pixel color is not
1743 equal to a cached pixel color recorded earlier, there was a
1744 change in the colormap, so clear the color cache. */
1745 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1746 XColor *cached_color;
1748 if (dpyinfo->color_cells
1749 && (cached_color = &dpyinfo->color_cells[color->pixel],
1750 (cached_color->red != color->red
1751 || cached_color->blue != color->blue
1752 || cached_color->green != color->green)))
1754 xfree (dpyinfo->color_cells);
1755 dpyinfo->color_cells = NULL;
1756 dpyinfo->ncolor_cells = 0;
1760 #ifdef DEBUG_X_COLORS
1761 if (rc)
1762 register_color (color->pixel);
1763 #endif /* DEBUG_X_COLORS */
1765 return rc;
1769 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1770 exact match can't be allocated, try the nearest color available.
1771 Value is non-zero if successful. Set *COLOR to the color
1772 allocated. */
1775 x_alloc_nearest_color (f, cmap, color)
1776 struct frame *f;
1777 Colormap cmap;
1778 XColor *color;
1780 gamma_correct (f, color);
1781 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1785 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1786 It's necessary to do this instead of just using PIXEL directly to
1787 get color reference counts right. */
1789 unsigned long
1790 x_copy_color (f, pixel)
1791 struct frame *f;
1792 unsigned long pixel;
1794 XColor color;
1796 color.pixel = pixel;
1797 BLOCK_INPUT;
1798 x_query_color (f, &color);
1799 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1800 UNBLOCK_INPUT;
1801 #ifdef DEBUG_X_COLORS
1802 register_color (pixel);
1803 #endif
1804 return color.pixel;
1808 /* Allocate color PIXEL on display DPY. PIXEL must already be allocated.
1809 It's necessary to do this instead of just using PIXEL directly to
1810 get color reference counts right. */
1812 unsigned long
1813 x_copy_dpy_color (dpy, cmap, pixel)
1814 Display *dpy;
1815 Colormap cmap;
1816 unsigned long pixel;
1818 XColor color;
1820 color.pixel = pixel;
1821 BLOCK_INPUT;
1822 XQueryColor (dpy, cmap, &color);
1823 XAllocColor (dpy, cmap, &color);
1824 UNBLOCK_INPUT;
1825 #ifdef DEBUG_X_COLORS
1826 register_color (pixel);
1827 #endif
1828 return color.pixel;
1832 /* Brightness beyond which a color won't have its highlight brightness
1833 boosted.
1835 Nominally, highlight colors for `3d' faces are calculated by
1836 brightening an object's color by a constant scale factor, but this
1837 doesn't yield good results for dark colors, so for colors who's
1838 brightness is less than this value (on a scale of 0-65535) have an
1839 use an additional additive factor.
1841 The value here is set so that the default menu-bar/mode-line color
1842 (grey75) will not have its highlights changed at all. */
1843 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1846 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1847 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1848 If this produces the same color as PIXEL, try a color where all RGB
1849 values have DELTA added. Return the allocated color in *PIXEL.
1850 DISPLAY is the X display, CMAP is the colormap to operate on.
1851 Value is non-zero if successful. */
1853 static int
1854 x_alloc_lighter_color (f, display, cmap, pixel, factor, delta)
1855 struct frame *f;
1856 Display *display;
1857 Colormap cmap;
1858 unsigned long *pixel;
1859 double factor;
1860 int delta;
1862 XColor color, new;
1863 long bright;
1864 int success_p;
1866 /* Get RGB color values. */
1867 color.pixel = *pixel;
1868 x_query_color (f, &color);
1870 /* Change RGB values by specified FACTOR. Avoid overflow! */
1871 xassert (factor >= 0);
1872 new.red = min (0xffff, factor * color.red);
1873 new.green = min (0xffff, factor * color.green);
1874 new.blue = min (0xffff, factor * color.blue);
1876 /* Calculate brightness of COLOR. */
1877 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1879 /* We only boost colors that are darker than
1880 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1881 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1882 /* Make an additive adjustment to NEW, because it's dark enough so
1883 that scaling by FACTOR alone isn't enough. */
1885 /* How far below the limit this color is (0 - 1, 1 being darker). */
1886 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1887 /* The additive adjustment. */
1888 int min_delta = delta * dimness * factor / 2;
1890 if (factor < 1)
1892 new.red = max (0, new.red - min_delta);
1893 new.green = max (0, new.green - min_delta);
1894 new.blue = max (0, new.blue - min_delta);
1896 else
1898 new.red = min (0xffff, min_delta + new.red);
1899 new.green = min (0xffff, min_delta + new.green);
1900 new.blue = min (0xffff, min_delta + new.blue);
1904 /* Try to allocate the color. */
1905 success_p = x_alloc_nearest_color (f, cmap, &new);
1906 if (success_p)
1908 if (new.pixel == *pixel)
1910 /* If we end up with the same color as before, try adding
1911 delta to the RGB values. */
1912 x_free_colors (f, &new.pixel, 1);
1914 new.red = min (0xffff, delta + color.red);
1915 new.green = min (0xffff, delta + color.green);
1916 new.blue = min (0xffff, delta + color.blue);
1917 success_p = x_alloc_nearest_color (f, cmap, &new);
1919 else
1920 success_p = 1;
1921 *pixel = new.pixel;
1924 return success_p;
1928 /* Set up the foreground color for drawing relief lines of glyph
1929 string S. RELIEF is a pointer to a struct relief containing the GC
1930 with which lines will be drawn. Use a color that is FACTOR or
1931 DELTA lighter or darker than the relief's background which is found
1932 in S->f->output_data.x->relief_background. If such a color cannot
1933 be allocated, use DEFAULT_PIXEL, instead. */
1935 static void
1936 x_setup_relief_color (f, relief, factor, delta, default_pixel)
1937 struct frame *f;
1938 struct relief *relief;
1939 double factor;
1940 int delta;
1941 unsigned long default_pixel;
1943 XGCValues xgcv;
1944 struct x_output *di = f->output_data.x;
1945 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1946 unsigned long pixel;
1947 unsigned long background = di->relief_background;
1948 Colormap cmap = FRAME_X_COLORMAP (f);
1949 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1950 Display *dpy = FRAME_X_DISPLAY (f);
1952 xgcv.graphics_exposures = False;
1953 xgcv.line_width = 1;
1955 /* Free previously allocated color. The color cell will be reused
1956 when it has been freed as many times as it was allocated, so this
1957 doesn't affect faces using the same colors. */
1958 if (relief->gc
1959 && relief->allocated_p)
1961 x_free_colors (f, &relief->pixel, 1);
1962 relief->allocated_p = 0;
1965 /* Allocate new color. */
1966 xgcv.foreground = default_pixel;
1967 pixel = background;
1968 if (dpyinfo->n_planes != 1
1969 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1971 relief->allocated_p = 1;
1972 xgcv.foreground = relief->pixel = pixel;
1975 if (relief->gc == 0)
1977 xgcv.stipple = dpyinfo->gray;
1978 mask |= GCStipple;
1979 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1981 else
1982 XChangeGC (dpy, relief->gc, mask, &xgcv);
1986 /* Set up colors for the relief lines around glyph string S. */
1988 static void
1989 x_setup_relief_colors (s)
1990 struct glyph_string *s;
1992 struct x_output *di = s->f->output_data.x;
1993 unsigned long color;
1995 if (s->face->use_box_color_for_shadows_p)
1996 color = s->face->box_color;
1997 else if (s->first_glyph->type == IMAGE_GLYPH
1998 && s->img->pixmap
1999 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2000 color = IMAGE_BACKGROUND (s->img, s->f, 0);
2001 else
2003 XGCValues xgcv;
2005 /* Get the background color of the face. */
2006 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
2007 color = xgcv.background;
2010 if (di->white_relief.gc == 0
2011 || color != di->relief_background)
2013 di->relief_background = color;
2014 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
2015 WHITE_PIX_DEFAULT (s->f));
2016 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
2017 BLACK_PIX_DEFAULT (s->f));
2022 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
2023 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
2024 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
2025 relief. LEFT_P non-zero means draw a relief on the left side of
2026 the rectangle. RIGHT_P non-zero means draw a relief on the right
2027 side of the rectangle. CLIP_RECT is the clipping rectangle to use
2028 when drawing. */
2030 static void
2031 x_draw_relief_rect (f, left_x, top_y, right_x, bottom_y, width,
2032 raised_p, top_p, bot_p, left_p, right_p, clip_rect)
2033 struct frame *f;
2034 int left_x, top_y, right_x, bottom_y, width;
2035 int top_p, bot_p, left_p, right_p, raised_p;
2036 XRectangle *clip_rect;
2038 Display *dpy = FRAME_X_DISPLAY (f);
2039 Window window = FRAME_X_WINDOW (f);
2040 int i;
2041 GC gc;
2043 if (raised_p)
2044 gc = f->output_data.x->white_relief.gc;
2045 else
2046 gc = f->output_data.x->black_relief.gc;
2047 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2049 /* Top. */
2050 if (top_p)
2051 for (i = 0; i < width; ++i)
2052 XDrawLine (dpy, window, gc,
2053 left_x + i * left_p, top_y + i,
2054 right_x + 1 - i * right_p, top_y + i);
2056 /* Left. */
2057 if (left_p)
2058 for (i = 0; i < width; ++i)
2059 XDrawLine (dpy, window, gc,
2060 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
2062 XSetClipMask (dpy, gc, None);
2063 if (raised_p)
2064 gc = f->output_data.x->black_relief.gc;
2065 else
2066 gc = f->output_data.x->white_relief.gc;
2067 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2069 /* Bottom. */
2070 if (bot_p)
2071 for (i = 0; i < width; ++i)
2072 XDrawLine (dpy, window, gc,
2073 left_x + i * left_p, bottom_y - i,
2074 right_x + 1 - i * right_p, bottom_y - i);
2076 /* Right. */
2077 if (right_p)
2078 for (i = 0; i < width; ++i)
2079 XDrawLine (dpy, window, gc,
2080 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
2082 XSetClipMask (dpy, gc, None);
2086 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2087 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2088 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2089 left side of the rectangle. RIGHT_P non-zero means draw a line
2090 on the right side of the rectangle. CLIP_RECT is the clipping
2091 rectangle to use when drawing. */
2093 static void
2094 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2095 left_p, right_p, clip_rect)
2096 struct glyph_string *s;
2097 int left_x, top_y, right_x, bottom_y, width, left_p, right_p;
2098 XRectangle *clip_rect;
2100 XGCValues xgcv;
2102 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2103 XSetForeground (s->display, s->gc, s->face->box_color);
2104 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2106 /* Top. */
2107 XFillRectangle (s->display, s->window, s->gc,
2108 left_x, top_y, right_x - left_x + 1, width);
2110 /* Left. */
2111 if (left_p)
2112 XFillRectangle (s->display, s->window, s->gc,
2113 left_x, top_y, width, bottom_y - top_y + 1);
2115 /* Bottom. */
2116 XFillRectangle (s->display, s->window, s->gc,
2117 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2119 /* Right. */
2120 if (right_p)
2121 XFillRectangle (s->display, s->window, s->gc,
2122 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2124 XSetForeground (s->display, s->gc, xgcv.foreground);
2125 XSetClipMask (s->display, s->gc, None);
2129 /* Draw a box around glyph string S. */
2131 static void
2132 x_draw_glyph_string_box (s)
2133 struct glyph_string *s;
2135 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2136 int left_p, right_p;
2137 struct glyph *last_glyph;
2138 XRectangle clip_rect;
2140 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2141 ? WINDOW_RIGHT_EDGE_X (s->w)
2142 : window_box_right (s->w, s->area));
2144 /* The glyph that may have a right box line. */
2145 last_glyph = (s->cmp || s->img
2146 ? s->first_glyph
2147 : s->first_glyph + s->nchars - 1);
2149 width = eabs (s->face->box_line_width);
2150 raised_p = s->face->box == FACE_RAISED_BOX;
2151 left_x = s->x;
2152 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2153 ? last_x - 1
2154 : min (last_x, s->x + s->background_width) - 1);
2155 top_y = s->y;
2156 bottom_y = top_y + s->height - 1;
2158 left_p = (s->first_glyph->left_box_line_p
2159 || (s->hl == DRAW_MOUSE_FACE
2160 && (s->prev == NULL
2161 || s->prev->hl != s->hl)));
2162 right_p = (last_glyph->right_box_line_p
2163 || (s->hl == DRAW_MOUSE_FACE
2164 && (s->next == NULL
2165 || s->next->hl != s->hl)));
2167 get_glyph_string_clip_rect (s, &clip_rect);
2169 if (s->face->box == FACE_SIMPLE_BOX)
2170 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2171 left_p, right_p, &clip_rect);
2172 else
2174 x_setup_relief_colors (s);
2175 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2176 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2181 /* Draw foreground of image glyph string S. */
2183 static void
2184 x_draw_image_foreground (s)
2185 struct glyph_string *s;
2187 int x = s->x;
2188 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2190 /* If first glyph of S has a left box line, start drawing it to the
2191 right of that line. */
2192 if (s->face->box != FACE_NO_BOX
2193 && s->first_glyph->left_box_line_p
2194 && s->slice.x == 0)
2195 x += eabs (s->face->box_line_width);
2197 /* If there is a margin around the image, adjust x- and y-position
2198 by that margin. */
2199 if (s->slice.x == 0)
2200 x += s->img->hmargin;
2201 if (s->slice.y == 0)
2202 y += s->img->vmargin;
2204 if (s->img->pixmap)
2206 if (s->img->mask)
2208 /* We can't set both a clip mask and use XSetClipRectangles
2209 because the latter also sets a clip mask. We also can't
2210 trust on the shape extension to be available
2211 (XShapeCombineRegion). So, compute the rectangle to draw
2212 manually. */
2213 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2214 | GCFunction);
2215 XGCValues xgcv;
2216 XRectangle clip_rect, image_rect, r;
2218 xgcv.clip_mask = s->img->mask;
2219 xgcv.clip_x_origin = x;
2220 xgcv.clip_y_origin = y;
2221 xgcv.function = GXcopy;
2222 XChangeGC (s->display, s->gc, mask, &xgcv);
2224 get_glyph_string_clip_rect (s, &clip_rect);
2225 image_rect.x = x;
2226 image_rect.y = y;
2227 image_rect.width = s->slice.width;
2228 image_rect.height = s->slice.height;
2229 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2230 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2231 s->slice.x + r.x - x, s->slice.y + r.y - y,
2232 r.width, r.height, r.x, r.y);
2234 else
2236 XRectangle clip_rect, image_rect, r;
2238 get_glyph_string_clip_rect (s, &clip_rect);
2239 image_rect.x = x;
2240 image_rect.y = y;
2241 image_rect.width = s->slice.width;
2242 image_rect.height = s->slice.height;
2243 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2244 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2245 s->slice.x + r.x - x, s->slice.y + r.y - y,
2246 r.width, r.height, r.x, r.y);
2248 /* When the image has a mask, we can expect that at
2249 least part of a mouse highlight or a block cursor will
2250 be visible. If the image doesn't have a mask, make
2251 a block cursor visible by drawing a rectangle around
2252 the image. I believe it's looking better if we do
2253 nothing here for mouse-face. */
2254 if (s->hl == DRAW_CURSOR)
2256 int r = s->img->relief;
2257 if (r < 0) r = -r;
2258 XDrawRectangle (s->display, s->window, s->gc,
2259 x - r, y - r,
2260 s->slice.width + r*2 - 1,
2261 s->slice.height + r*2 - 1);
2265 else
2266 /* Draw a rectangle if image could not be loaded. */
2267 XDrawRectangle (s->display, s->window, s->gc, x, y,
2268 s->slice.width - 1, s->slice.height - 1);
2272 /* Draw a relief around the image glyph string S. */
2274 static void
2275 x_draw_image_relief (s)
2276 struct glyph_string *s;
2278 int x0, y0, x1, y1, thick, raised_p;
2279 XRectangle r;
2280 int x = s->x;
2281 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2283 /* If first glyph of S has a left box line, start drawing it to the
2284 right of that line. */
2285 if (s->face->box != FACE_NO_BOX
2286 && s->first_glyph->left_box_line_p
2287 && s->slice.x == 0)
2288 x += eabs (s->face->box_line_width);
2290 /* If there is a margin around the image, adjust x- and y-position
2291 by that margin. */
2292 if (s->slice.x == 0)
2293 x += s->img->hmargin;
2294 if (s->slice.y == 0)
2295 y += s->img->vmargin;
2297 if (s->hl == DRAW_IMAGE_SUNKEN
2298 || s->hl == DRAW_IMAGE_RAISED)
2300 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2301 raised_p = s->hl == DRAW_IMAGE_RAISED;
2303 else
2305 thick = eabs (s->img->relief);
2306 raised_p = s->img->relief > 0;
2309 x0 = x - thick;
2310 y0 = y - thick;
2311 x1 = x + s->slice.width + thick - 1;
2312 y1 = y + s->slice.height + thick - 1;
2314 x_setup_relief_colors (s);
2315 get_glyph_string_clip_rect (s, &r);
2316 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2317 s->slice.y == 0,
2318 s->slice.y + s->slice.height == s->img->height,
2319 s->slice.x == 0,
2320 s->slice.x + s->slice.width == s->img->width,
2321 &r);
2325 /* Draw the foreground of image glyph string S to PIXMAP. */
2327 static void
2328 x_draw_image_foreground_1 (s, pixmap)
2329 struct glyph_string *s;
2330 Pixmap pixmap;
2332 int x = 0;
2333 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2335 /* If first glyph of S has a left box line, start drawing it to the
2336 right of that line. */
2337 if (s->face->box != FACE_NO_BOX
2338 && s->first_glyph->left_box_line_p
2339 && s->slice.x == 0)
2340 x += eabs (s->face->box_line_width);
2342 /* If there is a margin around the image, adjust x- and y-position
2343 by that margin. */
2344 if (s->slice.x == 0)
2345 x += s->img->hmargin;
2346 if (s->slice.y == 0)
2347 y += s->img->vmargin;
2349 if (s->img->pixmap)
2351 if (s->img->mask)
2353 /* We can't set both a clip mask and use XSetClipRectangles
2354 because the latter also sets a clip mask. We also can't
2355 trust on the shape extension to be available
2356 (XShapeCombineRegion). So, compute the rectangle to draw
2357 manually. */
2358 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2359 | GCFunction);
2360 XGCValues xgcv;
2362 xgcv.clip_mask = s->img->mask;
2363 xgcv.clip_x_origin = x - s->slice.x;
2364 xgcv.clip_y_origin = y - s->slice.y;
2365 xgcv.function = GXcopy;
2366 XChangeGC (s->display, s->gc, mask, &xgcv);
2368 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2369 s->slice.x, s->slice.y,
2370 s->slice.width, s->slice.height, x, y);
2371 XSetClipMask (s->display, s->gc, None);
2373 else
2375 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2376 s->slice.x, s->slice.y,
2377 s->slice.width, s->slice.height, x, y);
2379 /* When the image has a mask, we can expect that at
2380 least part of a mouse highlight or a block cursor will
2381 be visible. If the image doesn't have a mask, make
2382 a block cursor visible by drawing a rectangle around
2383 the image. I believe it's looking better if we do
2384 nothing here for mouse-face. */
2385 if (s->hl == DRAW_CURSOR)
2387 int r = s->img->relief;
2388 if (r < 0) r = -r;
2389 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2390 s->slice.width + r*2 - 1,
2391 s->slice.height + r*2 - 1);
2395 else
2396 /* Draw a rectangle if image could not be loaded. */
2397 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2398 s->slice.width - 1, s->slice.height - 1);
2402 /* Draw part of the background of glyph string S. X, Y, W, and H
2403 give the rectangle to draw. */
2405 static void
2406 x_draw_glyph_string_bg_rect (s, x, y, w, h)
2407 struct glyph_string *s;
2408 int x, y, w, h;
2410 if (s->stippled_p)
2412 /* Fill background with a stipple pattern. */
2413 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2414 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2415 XSetFillStyle (s->display, s->gc, FillSolid);
2417 else
2418 x_clear_glyph_string_rect (s, x, y, w, h);
2422 /* Draw image glyph string S.
2424 s->y
2425 s->x +-------------------------
2426 | s->face->box
2428 | +-------------------------
2429 | | s->img->margin
2431 | | +-------------------
2432 | | | the image
2436 static void
2437 x_draw_image_glyph_string (s)
2438 struct glyph_string *s;
2440 int box_line_hwidth = eabs (s->face->box_line_width);
2441 int box_line_vwidth = max (s->face->box_line_width, 0);
2442 int height;
2443 Pixmap pixmap = None;
2445 height = s->height;
2446 if (s->slice.y == 0)
2447 height -= box_line_vwidth;
2448 if (s->slice.y + s->slice.height >= s->img->height)
2449 height -= box_line_vwidth;
2451 /* Fill background with face under the image. Do it only if row is
2452 taller than image or if image has a clip mask to reduce
2453 flickering. */
2454 s->stippled_p = s->face->stipple != 0;
2455 if (height > s->slice.height
2456 || s->img->hmargin
2457 || s->img->vmargin
2458 || s->img->mask
2459 || s->img->pixmap == 0
2460 || s->width != s->background_width)
2462 if (s->img->mask)
2464 /* Create a pixmap as large as the glyph string. Fill it
2465 with the background color. Copy the image to it, using
2466 its mask. Copy the temporary pixmap to the display. */
2467 Screen *screen = FRAME_X_SCREEN (s->f);
2468 int depth = DefaultDepthOfScreen (screen);
2470 /* Create a pixmap as large as the glyph string. */
2471 pixmap = XCreatePixmap (s->display, s->window,
2472 s->background_width,
2473 s->height, depth);
2475 /* Don't clip in the following because we're working on the
2476 pixmap. */
2477 XSetClipMask (s->display, s->gc, None);
2479 /* Fill the pixmap with the background color/stipple. */
2480 if (s->stippled_p)
2482 /* Fill background with a stipple pattern. */
2483 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2484 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2485 XFillRectangle (s->display, pixmap, s->gc,
2486 0, 0, s->background_width, s->height);
2487 XSetFillStyle (s->display, s->gc, FillSolid);
2488 XSetTSOrigin (s->display, s->gc, 0, 0);
2490 else
2492 XGCValues xgcv;
2493 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2494 &xgcv);
2495 XSetForeground (s->display, s->gc, xgcv.background);
2496 XFillRectangle (s->display, pixmap, s->gc,
2497 0, 0, s->background_width, s->height);
2498 XSetForeground (s->display, s->gc, xgcv.foreground);
2501 else
2503 int x = s->x;
2504 int y = s->y;
2506 if (s->first_glyph->left_box_line_p
2507 && s->slice.x == 0)
2508 x += box_line_hwidth;
2510 if (s->slice.y == 0)
2511 y += box_line_vwidth;
2513 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2516 s->background_filled_p = 1;
2519 /* Draw the foreground. */
2520 if (pixmap != None)
2522 x_draw_image_foreground_1 (s, pixmap);
2523 x_set_glyph_string_clipping (s);
2524 XCopyArea (s->display, pixmap, s->window, s->gc,
2525 0, 0, s->background_width, s->height, s->x, s->y);
2526 XFreePixmap (s->display, pixmap);
2528 else
2529 x_draw_image_foreground (s);
2531 /* If we must draw a relief around the image, do it. */
2532 if (s->img->relief
2533 || s->hl == DRAW_IMAGE_RAISED
2534 || s->hl == DRAW_IMAGE_SUNKEN)
2535 x_draw_image_relief (s);
2539 /* Draw stretch glyph string S. */
2541 static void
2542 x_draw_stretch_glyph_string (s)
2543 struct glyph_string *s;
2545 xassert (s->first_glyph->type == STRETCH_GLYPH);
2547 if (s->hl == DRAW_CURSOR
2548 && !x_stretch_cursor_p)
2550 /* If `x-stretch-block-cursor' is nil, don't draw a block cursor
2551 as wide as the stretch glyph. */
2552 int width, background_width = s->background_width;
2553 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2555 if (x < left_x)
2557 background_width -= left_x - x;
2558 x = left_x;
2560 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2562 /* Draw cursor. */
2563 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2565 /* Clear rest using the GC of the original non-cursor face. */
2566 if (width < background_width)
2568 int y = s->y;
2569 int w = background_width - width, h = s->height;
2570 XRectangle r;
2571 GC gc;
2573 x += width;
2574 if (s->row->mouse_face_p
2575 && cursor_in_mouse_face_p (s->w))
2577 x_set_mouse_face_gc (s);
2578 gc = s->gc;
2580 else
2581 gc = s->face->gc;
2583 get_glyph_string_clip_rect (s, &r);
2584 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2586 if (s->face->stipple)
2588 /* Fill background with a stipple pattern. */
2589 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2590 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2591 XSetFillStyle (s->display, gc, FillSolid);
2593 else
2595 XGCValues xgcv;
2596 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2597 XSetForeground (s->display, gc, xgcv.background);
2598 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2599 XSetForeground (s->display, gc, xgcv.foreground);
2603 else if (!s->background_filled_p)
2605 int background_width = s->background_width;
2606 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2608 /* Don't draw into left margin, fringe or scrollbar area
2609 except for header line and mode line. */
2610 if (x < left_x && !s->row->mode_line_p)
2612 background_width -= left_x - x;
2613 x = left_x;
2615 if (background_width > 0)
2616 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2619 s->background_filled_p = 1;
2623 /* Draw glyph string S. */
2625 static void
2626 x_draw_glyph_string (s)
2627 struct glyph_string *s;
2629 int relief_drawn_p = 0;
2631 /* If S draws into the background of its successors, draw the
2632 background of the successors first so that S can draw into it.
2633 This makes S->next use XDrawString instead of XDrawImageString. */
2634 if (s->next && s->right_overhang && !s->for_overlaps)
2636 int width;
2637 struct glyph_string *next;
2639 for (width = 0, next = s->next; next;
2640 width += next->width, next = next->next)
2641 if (next->first_glyph->type != IMAGE_GLYPH)
2643 x_set_glyph_string_gc (next);
2644 x_set_glyph_string_clipping (next);
2645 x_draw_glyph_string_background (next, 1);
2646 next->num_clips = 0;
2650 /* Set up S->gc, set clipping and draw S. */
2651 x_set_glyph_string_gc (s);
2653 /* Draw relief (if any) in advance for char/composition so that the
2654 glyph string can be drawn over it. */
2655 if (!s->for_overlaps
2656 && s->face->box != FACE_NO_BOX
2657 && (s->first_glyph->type == CHAR_GLYPH
2658 || s->first_glyph->type == COMPOSITE_GLYPH))
2661 x_set_glyph_string_clipping (s);
2662 x_draw_glyph_string_background (s, 1);
2663 x_draw_glyph_string_box (s);
2664 x_set_glyph_string_clipping (s);
2665 relief_drawn_p = 1;
2667 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2668 && !s->clip_tail
2669 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2670 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2671 /* We must clip just this glyph. left_overhang part has already
2672 drawn when s->prev was drawn, and right_overhang part will be
2673 drawn later when s->next is drawn. */
2674 x_set_glyph_string_clipping_exactly (s, s);
2675 else
2676 x_set_glyph_string_clipping (s);
2678 switch (s->first_glyph->type)
2680 case IMAGE_GLYPH:
2681 x_draw_image_glyph_string (s);
2682 break;
2684 case STRETCH_GLYPH:
2685 x_draw_stretch_glyph_string (s);
2686 break;
2688 case CHAR_GLYPH:
2689 if (s->for_overlaps)
2690 s->background_filled_p = 1;
2691 else
2692 x_draw_glyph_string_background (s, 0);
2693 x_draw_glyph_string_foreground (s);
2694 break;
2696 case COMPOSITE_GLYPH:
2697 if (s->for_overlaps || s->gidx > 0)
2698 s->background_filled_p = 1;
2699 else
2700 x_draw_glyph_string_background (s, 1);
2701 x_draw_composite_glyph_string_foreground (s);
2702 break;
2704 default:
2705 abort ();
2708 if (!s->for_overlaps)
2710 /* Draw underline. */
2711 if (s->face->underline_p)
2713 unsigned long thickness, position;
2714 int y;
2716 if (s->prev && s->prev->face->underline_p)
2718 /* We use the same underline style as the previous one. */
2719 thickness = s->prev->underline_thickness;
2720 position = s->prev->underline_position;
2722 else
2724 /* Get the underline thickness. Default is 1 pixel. */
2725 if (s->font && s->font->underline_thickness > 0)
2726 thickness = s->font->underline_thickness;
2727 else
2728 thickness = 1;
2729 if (x_underline_at_descent_line)
2730 position = (s->height - thickness) - (s->ybase - s->y);
2731 else
2733 /* Get the underline position. This is the recommended
2734 vertical offset in pixels from the baseline to the top of
2735 the underline. This is a signed value according to the
2736 specs, and its default is
2738 ROUND ((maximum descent) / 2), with
2739 ROUND(x) = floor (x + 0.5) */
2741 if (x_use_underline_position_properties
2742 && s->font && s->font->underline_position >= 0)
2743 position = s->font->underline_position;
2744 else if (s->font)
2745 position = (s->font->descent + 1) / 2;
2747 position = max (position, underline_minimum_offset);
2749 /* Check the sanity of thickness and position. We should
2750 avoid drawing underline out of the current line area. */
2751 if (s->y + s->height <= s->ybase + position)
2752 position = (s->height - 1) - (s->ybase - s->y);
2753 if (s->y + s->height < s->ybase + position + thickness)
2754 thickness = (s->y + s->height) - (s->ybase + position);
2755 s->underline_thickness = thickness;
2756 s->underline_position = position;
2757 y = s->ybase + position;
2758 if (s->face->underline_defaulted_p)
2759 XFillRectangle (s->display, s->window, s->gc,
2760 s->x, y, s->background_width, thickness);
2761 else
2763 XGCValues xgcv;
2764 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2765 XSetForeground (s->display, s->gc, s->face->underline_color);
2766 XFillRectangle (s->display, s->window, s->gc,
2767 s->x, y, s->background_width, thickness);
2768 XSetForeground (s->display, s->gc, xgcv.foreground);
2772 /* Draw overline. */
2773 if (s->face->overline_p)
2775 unsigned long dy = 0, h = 1;
2777 if (s->face->overline_color_defaulted_p)
2778 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2779 s->background_width, h);
2780 else
2782 XGCValues xgcv;
2783 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2784 XSetForeground (s->display, s->gc, s->face->overline_color);
2785 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2786 s->background_width, h);
2787 XSetForeground (s->display, s->gc, xgcv.foreground);
2791 /* Draw strike-through. */
2792 if (s->face->strike_through_p)
2794 unsigned long h = 1;
2795 unsigned long dy = (s->height - h) / 2;
2797 if (s->face->strike_through_color_defaulted_p)
2798 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2799 s->width, h);
2800 else
2802 XGCValues xgcv;
2803 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2804 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2805 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2806 s->width, h);
2807 XSetForeground (s->display, s->gc, xgcv.foreground);
2811 /* Draw relief if not yet drawn. */
2812 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2813 x_draw_glyph_string_box (s);
2815 if (s->prev)
2817 struct glyph_string *prev;
2819 for (prev = s->prev; prev; prev = prev->prev)
2820 if (prev->hl != s->hl
2821 && prev->x + prev->width + prev->right_overhang > s->x)
2823 /* As prev was drawn while clipped to its own area, we
2824 must draw the right_overhang part using s->hl now. */
2825 enum draw_glyphs_face save = prev->hl;
2827 prev->hl = s->hl;
2828 x_set_glyph_string_gc (prev);
2829 x_set_glyph_string_clipping_exactly (s, prev);
2830 if (prev->first_glyph->type == CHAR_GLYPH)
2831 x_draw_glyph_string_foreground (prev);
2832 else
2833 x_draw_composite_glyph_string_foreground (prev);
2834 XSetClipMask (prev->display, prev->gc, None);
2835 prev->hl = save;
2836 prev->num_clips = 0;
2840 if (s->next)
2842 struct glyph_string *next;
2844 for (next = s->next; next; next = next->next)
2845 if (next->hl != s->hl
2846 && next->x - next->left_overhang < s->x + s->width)
2848 /* As next will be drawn while clipped to its own area,
2849 we must draw the left_overhang part using s->hl now. */
2850 enum draw_glyphs_face save = next->hl;
2852 next->hl = s->hl;
2853 x_set_glyph_string_gc (next);
2854 x_set_glyph_string_clipping_exactly (s, next);
2855 if (next->first_glyph->type == CHAR_GLYPH)
2856 x_draw_glyph_string_foreground (next);
2857 else
2858 x_draw_composite_glyph_string_foreground (next);
2859 XSetClipMask (next->display, next->gc, None);
2860 next->hl = save;
2861 next->num_clips = 0;
2866 /* Reset clipping. */
2867 XSetClipMask (s->display, s->gc, None);
2868 s->num_clips = 0;
2871 /* Shift display to make room for inserted glyphs. */
2873 void
2874 x_shift_glyphs_for_insert (f, x, y, width, height, shift_by)
2875 struct frame *f;
2876 int x, y, width, height, shift_by;
2878 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2879 f->output_data.x->normal_gc,
2880 x, y, width, height,
2881 x + shift_by, y);
2884 /* Delete N glyphs at the nominal cursor position. Not implemented
2885 for X frames. */
2887 static void
2888 x_delete_glyphs (f, n)
2889 struct frame *f;
2890 register int n;
2892 abort ();
2896 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2897 If they are <= 0, this is probably an error. */
2899 void
2900 x_clear_area (dpy, window, x, y, width, height, exposures)
2901 Display *dpy;
2902 Window window;
2903 int x, y;
2904 int width, height;
2905 int exposures;
2907 xassert (width > 0 && height > 0);
2908 XClearArea (dpy, window, x, y, width, height, exposures);
2912 /* Clear an entire frame. */
2914 static void
2915 x_clear_frame (struct frame *f)
2917 /* Clearing the frame will erase any cursor, so mark them all as no
2918 longer visible. */
2919 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2920 output_cursor.hpos = output_cursor.vpos = 0;
2921 output_cursor.x = -1;
2923 /* We don't set the output cursor here because there will always
2924 follow an explicit cursor_to. */
2925 BLOCK_INPUT;
2926 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
2928 /* We have to clear the scroll bars, too. If we have changed
2929 colors or something like that, then they should be notified. */
2930 x_scroll_bar_clear (f);
2932 XFlush (FRAME_X_DISPLAY (f));
2934 UNBLOCK_INPUT;
2939 /* Invert the middle quarter of the frame for .15 sec. */
2941 /* We use the select system call to do the waiting, so we have to make
2942 sure it's available. If it isn't, we just won't do visual bells. */
2944 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
2947 /* Subtract the `struct timeval' values X and Y, storing the result in
2948 *RESULT. Return 1 if the difference is negative, otherwise 0. */
2950 static int
2951 timeval_subtract (result, x, y)
2952 struct timeval *result, x, y;
2954 /* Perform the carry for the later subtraction by updating y. This
2955 is safer because on some systems the tv_sec member is unsigned. */
2956 if (x.tv_usec < y.tv_usec)
2958 int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
2959 y.tv_usec -= 1000000 * nsec;
2960 y.tv_sec += nsec;
2963 if (x.tv_usec - y.tv_usec > 1000000)
2965 int nsec = (y.tv_usec - x.tv_usec) / 1000000;
2966 y.tv_usec += 1000000 * nsec;
2967 y.tv_sec -= nsec;
2970 /* Compute the time remaining to wait. tv_usec is certainly
2971 positive. */
2972 result->tv_sec = x.tv_sec - y.tv_sec;
2973 result->tv_usec = x.tv_usec - y.tv_usec;
2975 /* Return indication of whether the result should be considered
2976 negative. */
2977 return x.tv_sec < y.tv_sec;
2980 void
2981 XTflash (f)
2982 struct frame *f;
2984 BLOCK_INPUT;
2987 GC gc;
2989 /* Create a GC that will use the GXxor function to flip foreground
2990 pixels into background pixels. */
2992 XGCValues values;
2994 values.function = GXxor;
2995 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
2996 ^ FRAME_BACKGROUND_PIXEL (f));
2998 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2999 GCFunction | GCForeground, &values);
3003 /* Get the height not including a menu bar widget. */
3004 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3005 /* Height of each line to flash. */
3006 int flash_height = FRAME_LINE_HEIGHT (f);
3007 /* These will be the left and right margins of the rectangles. */
3008 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3009 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3011 int width;
3013 /* Don't flash the area between a scroll bar and the frame
3014 edge it is next to. */
3015 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3017 case vertical_scroll_bar_left:
3018 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3019 break;
3021 case vertical_scroll_bar_right:
3022 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3023 break;
3025 default:
3026 break;
3029 width = flash_right - flash_left;
3031 /* If window is tall, flash top and bottom line. */
3032 if (height > 3 * FRAME_LINE_HEIGHT (f))
3034 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3035 flash_left,
3036 (FRAME_INTERNAL_BORDER_WIDTH (f)
3037 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
3038 width, flash_height);
3039 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3040 flash_left,
3041 (height - flash_height
3042 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3043 width, flash_height);
3045 else
3046 /* If it is short, flash it all. */
3047 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3048 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3049 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3051 x_flush (f);
3054 struct timeval wakeup;
3056 EMACS_GET_TIME (wakeup);
3058 /* Compute time to wait until, propagating carry from usecs. */
3059 wakeup.tv_usec += 150000;
3060 wakeup.tv_sec += (wakeup.tv_usec / 1000000);
3061 wakeup.tv_usec %= 1000000;
3063 /* Keep waiting until past the time wakeup or any input gets
3064 available. */
3065 while (! detect_input_pending ())
3067 struct timeval current;
3068 struct timeval timeout;
3070 EMACS_GET_TIME (current);
3072 /* Break if result would be negative. */
3073 if (timeval_subtract (&current, wakeup, current))
3074 break;
3076 /* How long `select' should wait. */
3077 timeout.tv_sec = 0;
3078 timeout.tv_usec = 10000;
3080 /* Try to wait that long--but we might wake up sooner. */
3081 select (0, NULL, NULL, NULL, &timeout);
3085 /* If window is tall, flash top and bottom line. */
3086 if (height > 3 * FRAME_LINE_HEIGHT (f))
3088 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3089 flash_left,
3090 (FRAME_INTERNAL_BORDER_WIDTH (f)
3091 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
3092 width, flash_height);
3093 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3094 flash_left,
3095 (height - flash_height
3096 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3097 width, flash_height);
3099 else
3100 /* If it is short, flash it all. */
3101 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3102 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3103 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3105 XFreeGC (FRAME_X_DISPLAY (f), gc);
3106 x_flush (f);
3110 UNBLOCK_INPUT;
3113 #endif /* defined (HAVE_TIMEVAL) && defined (HAVE_SELECT) */
3116 /* Make audible bell. */
3118 void
3119 XTring_bell ()
3121 struct frame *f = SELECTED_FRAME ();
3123 if (FRAME_X_DISPLAY (f))
3125 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
3126 if (visible_bell)
3127 XTflash (f);
3128 else
3129 #endif
3131 BLOCK_INPUT;
3132 XBell (FRAME_X_DISPLAY (f), 0);
3133 XFlush (FRAME_X_DISPLAY (f));
3134 UNBLOCK_INPUT;
3140 /* Specify how many text lines, from the top of the window,
3141 should be affected by insert-lines and delete-lines operations.
3142 This, and those operations, are used only within an update
3143 that is bounded by calls to x_update_begin and x_update_end. */
3145 static void
3146 XTset_terminal_window (n)
3147 register int n;
3149 /* This function intentionally left blank. */
3154 /***********************************************************************
3155 Line Dance
3156 ***********************************************************************/
3158 /* Perform an insert-lines or delete-lines operation, inserting N
3159 lines or deleting -N lines at vertical position VPOS. */
3161 static void
3162 x_ins_del_lines (f, vpos, n)
3163 struct frame *f;
3164 int vpos, n;
3166 abort ();
3170 /* Scroll part of the display as described by RUN. */
3172 static void
3173 x_scroll_run (w, run)
3174 struct window *w;
3175 struct run *run;
3177 struct frame *f = XFRAME (w->frame);
3178 int x, y, width, height, from_y, to_y, bottom_y;
3180 /* Get frame-relative bounding box of the text display area of W,
3181 without mode lines. Include in this box the left and right
3182 fringe of W. */
3183 window_box (w, -1, &x, &y, &width, &height);
3185 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3186 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3187 bottom_y = y + height;
3189 if (to_y < from_y)
3191 /* Scrolling up. Make sure we don't copy part of the mode
3192 line at the bottom. */
3193 if (from_y + run->height > bottom_y)
3194 height = bottom_y - from_y;
3195 else
3196 height = run->height;
3198 else
3200 /* Scolling down. Make sure we don't copy over the mode line.
3201 at the bottom. */
3202 if (to_y + run->height > bottom_y)
3203 height = bottom_y - to_y;
3204 else
3205 height = run->height;
3208 BLOCK_INPUT;
3210 /* Cursor off. Will be switched on again in x_update_window_end. */
3211 updated_window = w;
3212 x_clear_cursor (w);
3214 XCopyArea (FRAME_X_DISPLAY (f),
3215 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3216 f->output_data.x->normal_gc,
3217 x, from_y,
3218 width, height,
3219 x, to_y);
3221 UNBLOCK_INPUT;
3226 /***********************************************************************
3227 Exposure Events
3228 ***********************************************************************/
3231 static void
3232 frame_highlight (f)
3233 struct frame *f;
3235 /* We used to only do this if Vx_no_window_manager was non-nil, but
3236 the ICCCM (section 4.1.6) says that the window's border pixmap
3237 and border pixel are window attributes which are "private to the
3238 client", so we can always change it to whatever we want. */
3239 BLOCK_INPUT;
3240 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3241 f->output_data.x->border_pixel);
3242 UNBLOCK_INPUT;
3243 x_update_cursor (f, 1);
3244 x_set_frame_alpha (f);
3247 static void
3248 frame_unhighlight (f)
3249 struct frame *f;
3251 /* We used to only do this if Vx_no_window_manager was non-nil, but
3252 the ICCCM (section 4.1.6) says that the window's border pixmap
3253 and border pixel are window attributes which are "private to the
3254 client", so we can always change it to whatever we want. */
3255 BLOCK_INPUT;
3256 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3257 f->output_data.x->border_tile);
3258 UNBLOCK_INPUT;
3259 x_update_cursor (f, 1);
3260 x_set_frame_alpha (f);
3263 /* The focus has changed. Update the frames as necessary to reflect
3264 the new situation. Note that we can't change the selected frame
3265 here, because the Lisp code we are interrupting might become confused.
3266 Each event gets marked with the frame in which it occurred, so the
3267 Lisp code can tell when the switch took place by examining the events. */
3269 static void
3270 x_new_focus_frame (dpyinfo, frame)
3271 struct x_display_info *dpyinfo;
3272 struct frame *frame;
3274 struct frame *old_focus = dpyinfo->x_focus_frame;
3276 if (frame != dpyinfo->x_focus_frame)
3278 /* Set this before calling other routines, so that they see
3279 the correct value of x_focus_frame. */
3280 dpyinfo->x_focus_frame = frame;
3282 if (old_focus && old_focus->auto_lower)
3283 x_lower_frame (old_focus);
3285 #if 0
3286 selected_frame = frame;
3287 XSETFRAME (XWINDOW (selected_frame->selected_window)->frame,
3288 selected_frame);
3289 Fselect_window (selected_frame->selected_window, Qnil);
3290 choose_minibuf_frame ();
3291 #endif /* ! 0 */
3293 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3294 pending_autoraise_frame = dpyinfo->x_focus_frame;
3295 else
3296 pending_autoraise_frame = 0;
3299 x_frame_rehighlight (dpyinfo);
3302 /* Handle FocusIn and FocusOut state changes for FRAME.
3303 If FRAME has focus and there exists more than one frame, puts
3304 a FOCUS_IN_EVENT into *BUFP. */
3306 static void
3307 x_focus_changed (type, state, dpyinfo, frame, bufp)
3308 int type;
3309 int state;
3310 struct x_display_info *dpyinfo;
3311 struct frame *frame;
3312 struct input_event *bufp;
3314 if (type == FocusIn)
3316 if (dpyinfo->x_focus_event_frame != frame)
3318 x_new_focus_frame (dpyinfo, frame);
3319 dpyinfo->x_focus_event_frame = frame;
3321 /* Don't stop displaying the initial startup message
3322 for a switch-frame event we don't need. */
3323 if (NILP (Vterminal_frame)
3324 && CONSP (Vframe_list)
3325 && !NILP (XCDR (Vframe_list)))
3327 bufp->kind = FOCUS_IN_EVENT;
3328 XSETFRAME (bufp->frame_or_window, frame);
3332 frame->output_data.x->focus_state |= state;
3334 #ifdef HAVE_X_I18N
3335 if (FRAME_XIC (frame))
3336 XSetICFocus (FRAME_XIC (frame));
3337 #endif
3339 else if (type == FocusOut)
3341 frame->output_data.x->focus_state &= ~state;
3343 if (dpyinfo->x_focus_event_frame == frame)
3345 dpyinfo->x_focus_event_frame = 0;
3346 x_new_focus_frame (dpyinfo, 0);
3349 #ifdef HAVE_X_I18N
3350 if (FRAME_XIC (frame))
3351 XUnsetICFocus (FRAME_XIC (frame));
3352 #endif
3356 /* The focus may have changed. Figure out if it is a real focus change,
3357 by checking both FocusIn/Out and Enter/LeaveNotify events.
3359 Returns FOCUS_IN_EVENT event in *BUFP. */
3361 static void
3362 x_detect_focus_change (dpyinfo, event, bufp)
3363 struct x_display_info *dpyinfo;
3364 XEvent *event;
3365 struct input_event *bufp;
3367 struct frame *frame;
3369 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3370 if (! frame)
3371 return;
3373 switch (event->type)
3375 case EnterNotify:
3376 case LeaveNotify:
3378 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3379 int focus_state
3380 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3382 if (event->xcrossing.detail != NotifyInferior
3383 && event->xcrossing.focus
3384 && ! (focus_state & FOCUS_EXPLICIT))
3385 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3386 FOCUS_IMPLICIT,
3387 dpyinfo, frame, bufp);
3389 break;
3391 case FocusIn:
3392 case FocusOut:
3393 x_focus_changed (event->type,
3394 (event->xfocus.detail == NotifyPointer ?
3395 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3396 dpyinfo, frame, bufp);
3397 break;
3399 case ClientMessage:
3400 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3402 enum xembed_message msg = event->xclient.data.l[1];
3403 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3404 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3406 break;
3411 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3413 void
3414 x_mouse_leave (dpyinfo)
3415 struct x_display_info *dpyinfo;
3417 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3420 /* The focus has changed, or we have redirected a frame's focus to
3421 another frame (this happens when a frame uses a surrogate
3422 mini-buffer frame). Shift the highlight as appropriate.
3424 The FRAME argument doesn't necessarily have anything to do with which
3425 frame is being highlighted or un-highlighted; we only use it to find
3426 the appropriate X display info. */
3428 static void
3429 XTframe_rehighlight (frame)
3430 struct frame *frame;
3432 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3435 static void
3436 x_frame_rehighlight (dpyinfo)
3437 struct x_display_info *dpyinfo;
3439 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3441 if (dpyinfo->x_focus_frame)
3443 dpyinfo->x_highlight_frame
3444 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3445 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3446 : dpyinfo->x_focus_frame);
3447 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3449 FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
3450 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3453 else
3454 dpyinfo->x_highlight_frame = 0;
3456 if (dpyinfo->x_highlight_frame != old_highlight)
3458 if (old_highlight)
3459 frame_unhighlight (old_highlight);
3460 if (dpyinfo->x_highlight_frame)
3461 frame_highlight (dpyinfo->x_highlight_frame);
3467 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3469 /* Initialize mode_switch_bit and modifier_meaning. */
3470 static void
3471 x_find_modifier_meanings (dpyinfo)
3472 struct x_display_info *dpyinfo;
3474 int min_code, max_code;
3475 KeySym *syms;
3476 int syms_per_code;
3477 XModifierKeymap *mods;
3479 dpyinfo->meta_mod_mask = 0;
3480 dpyinfo->shift_lock_mask = 0;
3481 dpyinfo->alt_mod_mask = 0;
3482 dpyinfo->super_mod_mask = 0;
3483 dpyinfo->hyper_mod_mask = 0;
3485 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3487 syms = XGetKeyboardMapping (dpyinfo->display,
3488 min_code, max_code - min_code + 1,
3489 &syms_per_code);
3490 mods = XGetModifierMapping (dpyinfo->display);
3492 /* Scan the modifier table to see which modifier bits the Meta and
3493 Alt keysyms are on. */
3495 int row, col; /* The row and column in the modifier table. */
3496 int found_alt_or_meta;
3498 for (row = 3; row < 8; row++)
3500 found_alt_or_meta = 0;
3501 for (col = 0; col < mods->max_keypermod; col++)
3503 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3505 /* Zeroes are used for filler. Skip them. */
3506 if (code == 0)
3507 continue;
3509 /* Are any of this keycode's keysyms a meta key? */
3511 int code_col;
3513 for (code_col = 0; code_col < syms_per_code; code_col++)
3515 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3517 switch (sym)
3519 case XK_Meta_L:
3520 case XK_Meta_R:
3521 found_alt_or_meta = 1;
3522 dpyinfo->meta_mod_mask |= (1 << row);
3523 break;
3525 case XK_Alt_L:
3526 case XK_Alt_R:
3527 found_alt_or_meta = 1;
3528 dpyinfo->alt_mod_mask |= (1 << row);
3529 break;
3531 case XK_Hyper_L:
3532 case XK_Hyper_R:
3533 if (!found_alt_or_meta)
3534 dpyinfo->hyper_mod_mask |= (1 << row);
3535 code_col = syms_per_code;
3536 col = mods->max_keypermod;
3537 break;
3539 case XK_Super_L:
3540 case XK_Super_R:
3541 if (!found_alt_or_meta)
3542 dpyinfo->super_mod_mask |= (1 << row);
3543 code_col = syms_per_code;
3544 col = mods->max_keypermod;
3545 break;
3547 case XK_Shift_Lock:
3548 /* Ignore this if it's not on the lock modifier. */
3549 if (!found_alt_or_meta && ((1 << row) == LockMask))
3550 dpyinfo->shift_lock_mask = LockMask;
3551 code_col = syms_per_code;
3552 col = mods->max_keypermod;
3553 break;
3561 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3562 if (! dpyinfo->meta_mod_mask)
3564 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3565 dpyinfo->alt_mod_mask = 0;
3568 /* If some keys are both alt and meta,
3569 make them just meta, not alt. */
3570 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3572 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3575 XFree ((char *) syms);
3576 XFreeModifiermap (mods);
3579 /* Convert between the modifier bits X uses and the modifier bits
3580 Emacs uses. */
3582 unsigned int
3583 x_x_to_emacs_modifiers (dpyinfo, state)
3584 struct x_display_info *dpyinfo;
3585 unsigned int state;
3587 EMACS_UINT mod_meta = meta_modifier;
3588 EMACS_UINT mod_alt = alt_modifier;
3589 EMACS_UINT mod_hyper = hyper_modifier;
3590 EMACS_UINT mod_super = super_modifier;
3591 Lisp_Object tem;
3593 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3594 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3595 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3596 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3597 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3598 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3599 tem = Fget (Vx_super_keysym, Qmodifier_value);
3600 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3603 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3604 | ((state & ControlMask) ? ctrl_modifier : 0)
3605 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3606 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3607 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3608 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3611 static unsigned int
3612 x_emacs_to_x_modifiers (dpyinfo, state)
3613 struct x_display_info *dpyinfo;
3614 unsigned int state;
3616 EMACS_UINT mod_meta = meta_modifier;
3617 EMACS_UINT mod_alt = alt_modifier;
3618 EMACS_UINT mod_hyper = hyper_modifier;
3619 EMACS_UINT mod_super = super_modifier;
3621 Lisp_Object tem;
3623 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3624 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3625 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3626 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3627 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3628 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3629 tem = Fget (Vx_super_keysym, Qmodifier_value);
3630 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3633 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3634 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3635 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3636 | ((state & shift_modifier) ? ShiftMask : 0)
3637 | ((state & ctrl_modifier) ? ControlMask : 0)
3638 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3641 /* Convert a keysym to its name. */
3643 char *
3644 x_get_keysym_name (keysym)
3645 KeySym keysym;
3647 char *value;
3649 BLOCK_INPUT;
3650 value = XKeysymToString (keysym);
3651 UNBLOCK_INPUT;
3653 return value;
3658 /* Mouse clicks and mouse movement. Rah. */
3660 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3662 If the event is a button press, then note that we have grabbed
3663 the mouse. */
3665 static Lisp_Object
3666 construct_mouse_click (result, event, f)
3667 struct input_event *result;
3668 XButtonEvent *event;
3669 struct frame *f;
3671 /* Make the event type NO_EVENT; we'll change that when we decide
3672 otherwise. */
3673 result->kind = MOUSE_CLICK_EVENT;
3674 result->code = event->button - Button1;
3675 result->timestamp = event->time;
3676 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3677 event->state)
3678 | (event->type == ButtonRelease
3679 ? up_modifier
3680 : down_modifier));
3682 XSETINT (result->x, event->x);
3683 XSETINT (result->y, event->y);
3684 XSETFRAME (result->frame_or_window, f);
3685 result->arg = Qnil;
3686 return Qnil;
3690 /* Function to report a mouse movement to the mainstream Emacs code.
3691 The input handler calls this.
3693 We have received a mouse movement event, which is given in *event.
3694 If the mouse is over a different glyph than it was last time, tell
3695 the mainstream emacs code by setting mouse_moved. If not, ask for
3696 another motion event, so we can check again the next time it moves. */
3698 static XMotionEvent last_mouse_motion_event;
3699 static Lisp_Object last_mouse_motion_frame;
3701 static int
3702 note_mouse_movement (frame, event)
3703 FRAME_PTR frame;
3704 XMotionEvent *event;
3706 last_mouse_movement_time = event->time;
3707 last_mouse_motion_event = *event;
3708 XSETFRAME (last_mouse_motion_frame, frame);
3710 if (!FRAME_X_OUTPUT (frame))
3711 return 0;
3713 if (event->window != FRAME_X_WINDOW (frame))
3715 frame->mouse_moved = 1;
3716 last_mouse_scroll_bar = Qnil;
3717 note_mouse_highlight (frame, -1, -1);
3718 last_mouse_glyph_frame = 0;
3719 return 1;
3723 /* Has the mouse moved off the glyph it was on at the last sighting? */
3724 if (frame != last_mouse_glyph_frame
3725 || event->x < last_mouse_glyph.x
3726 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3727 || event->y < last_mouse_glyph.y
3728 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3730 frame->mouse_moved = 1;
3731 last_mouse_scroll_bar = Qnil;
3732 note_mouse_highlight (frame, event->x, event->y);
3733 /* Remember which glyph we're now on. */
3734 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3735 last_mouse_glyph_frame = frame;
3736 return 1;
3739 return 0;
3743 /************************************************************************
3744 Mouse Face
3745 ************************************************************************/
3747 static void
3748 redo_mouse_highlight ()
3750 if (!NILP (last_mouse_motion_frame)
3751 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3752 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3753 last_mouse_motion_event.x,
3754 last_mouse_motion_event.y);
3759 /* Return the current position of the mouse.
3760 *FP should be a frame which indicates which display to ask about.
3762 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3763 and *PART to the frame, window, and scroll bar part that the mouse
3764 is over. Set *X and *Y to the portion and whole of the mouse's
3765 position on the scroll bar.
3767 If the mouse movement started elsewhere, set *FP to the frame the
3768 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3769 the mouse is over.
3771 Set *TIME to the server time-stamp for the time at which the mouse
3772 was at this position.
3774 Don't store anything if we don't have a valid set of values to report.
3776 This clears the mouse_moved flag, so we can wait for the next mouse
3777 movement. */
3779 static void
3780 XTmouse_position (fp, insist, bar_window, part, x, y, time)
3781 FRAME_PTR *fp;
3782 int insist;
3783 Lisp_Object *bar_window;
3784 enum scroll_bar_part *part;
3785 Lisp_Object *x, *y;
3786 unsigned long *time;
3788 FRAME_PTR f1;
3790 BLOCK_INPUT;
3792 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3793 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time);
3794 else
3796 Window root;
3797 int root_x, root_y;
3799 Window dummy_window;
3800 int dummy;
3802 Lisp_Object frame, tail;
3804 /* Clear the mouse-moved flag for every frame on this display. */
3805 FOR_EACH_FRAME (tail, frame)
3806 if (FRAME_X_P (XFRAME (frame))
3807 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3808 XFRAME (frame)->mouse_moved = 0;
3810 last_mouse_scroll_bar = Qnil;
3812 /* Figure out which root window we're on. */
3813 XQueryPointer (FRAME_X_DISPLAY (*fp),
3814 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3816 /* The root window which contains the pointer. */
3817 &root,
3819 /* Trash which we can't trust if the pointer is on
3820 a different screen. */
3821 &dummy_window,
3823 /* The position on that root window. */
3824 &root_x, &root_y,
3826 /* More trash we can't trust. */
3827 &dummy, &dummy,
3829 /* Modifier keys and pointer buttons, about which
3830 we don't care. */
3831 (unsigned int *) &dummy);
3833 /* Now we have a position on the root; find the innermost window
3834 containing the pointer. */
3836 Window win, child;
3837 int win_x, win_y;
3838 int parent_x = 0, parent_y = 0;
3840 win = root;
3842 /* XTranslateCoordinates can get errors if the window
3843 structure is changing at the same time this function
3844 is running. So at least we must not crash from them. */
3846 x_catch_errors (FRAME_X_DISPLAY (*fp));
3848 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3849 && FRAME_LIVE_P (last_mouse_frame))
3851 /* If mouse was grabbed on a frame, give coords for that frame
3852 even if the mouse is now outside it. */
3853 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3855 /* From-window, to-window. */
3856 root, FRAME_X_WINDOW (last_mouse_frame),
3858 /* From-position, to-position. */
3859 root_x, root_y, &win_x, &win_y,
3861 /* Child of win. */
3862 &child);
3863 f1 = last_mouse_frame;
3865 else
3867 while (1)
3869 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3871 /* From-window, to-window. */
3872 root, win,
3874 /* From-position, to-position. */
3875 root_x, root_y, &win_x, &win_y,
3877 /* Child of win. */
3878 &child);
3880 if (child == None || child == win)
3881 break;
3883 win = child;
3884 parent_x = win_x;
3885 parent_y = win_y;
3888 /* Now we know that:
3889 win is the innermost window containing the pointer
3890 (XTC says it has no child containing the pointer),
3891 win_x and win_y are the pointer's position in it
3892 (XTC did this the last time through), and
3893 parent_x and parent_y are the pointer's position in win's parent.
3894 (They are what win_x and win_y were when win was child.
3895 If win is the root window, it has no parent, and
3896 parent_{x,y} are invalid, but that's okay, because we'll
3897 never use them in that case.) */
3899 /* Is win one of our frames? */
3900 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3902 #ifdef USE_X_TOOLKIT
3903 /* If we end up with the menu bar window, say it's not
3904 on the frame. */
3905 if (f1 != NULL
3906 && f1->output_data.x->menubar_widget
3907 && win == XtWindow (f1->output_data.x->menubar_widget))
3908 f1 = NULL;
3909 #endif /* USE_X_TOOLKIT */
3912 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
3913 f1 = 0;
3915 x_uncatch_errors ();
3917 /* If not, is it one of our scroll bars? */
3918 if (! f1)
3920 struct scroll_bar *bar;
3922 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
3924 if (bar)
3926 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3927 win_x = parent_x;
3928 win_y = parent_y;
3932 if (f1 == 0 && insist > 0)
3933 f1 = SELECTED_FRAME ();
3935 if (f1)
3937 /* Ok, we found a frame. Store all the values.
3938 last_mouse_glyph is a rectangle used to reduce the
3939 generation of mouse events. To not miss any motion
3940 events, we must divide the frame into rectangles of the
3941 size of the smallest character that could be displayed
3942 on it, i.e. into the same rectangles that matrices on
3943 the frame are divided into. */
3945 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
3946 last_mouse_glyph_frame = f1;
3948 *bar_window = Qnil;
3949 *part = 0;
3950 *fp = f1;
3951 XSETINT (*x, win_x);
3952 XSETINT (*y, win_y);
3953 *time = last_mouse_movement_time;
3958 UNBLOCK_INPUT;
3963 /***********************************************************************
3964 Scroll bars
3965 ***********************************************************************/
3967 /* Scroll bar support. */
3969 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
3970 manages it.
3971 This can be called in GC, so we have to make sure to strip off mark
3972 bits. */
3974 static struct scroll_bar *
3975 x_window_to_scroll_bar (display, window_id)
3976 Display *display;
3977 Window window_id;
3979 Lisp_Object tail;
3981 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3982 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
3983 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
3985 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
3987 Lisp_Object frame, bar, condemned;
3989 frame = XCAR (tail);
3990 /* All elements of Vframe_list should be frames. */
3991 if (! FRAMEP (frame))
3992 abort ();
3994 if (! FRAME_X_P (XFRAME (frame)))
3995 continue;
3997 /* Scan this frame's scroll bar list for a scroll bar with the
3998 right window ID. */
3999 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4000 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4001 /* This trick allows us to search both the ordinary and
4002 condemned scroll bar lists with one loop. */
4003 ! NILP (bar) || (bar = condemned,
4004 condemned = Qnil,
4005 ! NILP (bar));
4006 bar = XSCROLL_BAR (bar)->next)
4007 if (XSCROLL_BAR (bar)->x_window == window_id &&
4008 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4009 return XSCROLL_BAR (bar);
4012 return 0;
4016 #if defined USE_LUCID
4018 /* Return the Lucid menu bar WINDOW is part of. Return null
4019 if WINDOW is not part of a menu bar. */
4021 static Widget
4022 x_window_to_menu_bar (window)
4023 Window window;
4025 Lisp_Object tail;
4027 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4029 if (FRAME_X_P (XFRAME (XCAR (tail))))
4031 Lisp_Object frame = XCAR (tail);
4032 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4034 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4035 return menu_bar;
4039 return NULL;
4042 #endif /* USE_LUCID */
4045 /************************************************************************
4046 Toolkit scroll bars
4047 ************************************************************************/
4049 #ifdef USE_TOOLKIT_SCROLL_BARS
4051 static void x_scroll_bar_to_input_event P_ ((XEvent *, struct input_event *));
4052 static void x_send_scroll_bar_event P_ ((Lisp_Object, int, int, int));
4053 static void x_create_toolkit_scroll_bar P_ ((struct frame *,
4054 struct scroll_bar *));
4055 static void x_set_toolkit_scroll_bar_thumb P_ ((struct scroll_bar *,
4056 int, int, int));
4059 /* Lisp window being scrolled. Set when starting to interact with
4060 a toolkit scroll bar, reset to nil when ending the interaction. */
4062 static Lisp_Object window_being_scrolled;
4064 /* Last scroll bar part sent in xm_scroll_callback. */
4066 static int last_scroll_bar_part;
4068 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4069 that movements of 1/20 of the screen size are mapped to up/down. */
4071 #ifndef USE_GTK
4072 /* Id of action hook installed for scroll bars. */
4074 static XtActionHookId action_hook_id;
4076 static Boolean xaw3d_arrow_scroll;
4078 /* Whether the drag scrolling maintains the mouse at the top of the
4079 thumb. If not, resizing the thumb needs to be done more carefully
4080 to avoid jerkyness. */
4082 static Boolean xaw3d_pick_top;
4084 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4085 bars are used.. The hook is responsible for detecting when
4086 the user ends an interaction with the scroll bar, and generates
4087 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4089 static void
4090 xt_action_hook (widget, client_data, action_name, event, params,
4091 num_params)
4092 Widget widget;
4093 XtPointer client_data;
4094 String action_name;
4095 XEvent *event;
4096 String *params;
4097 Cardinal *num_params;
4099 int scroll_bar_p;
4100 char *end_action;
4102 #ifdef USE_MOTIF
4103 scroll_bar_p = XmIsScrollBar (widget);
4104 end_action = "Release";
4105 #else /* !USE_MOTIF i.e. use Xaw */
4106 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4107 end_action = "EndScroll";
4108 #endif /* USE_MOTIF */
4110 if (scroll_bar_p
4111 && strcmp (action_name, end_action) == 0
4112 && WINDOWP (window_being_scrolled))
4114 struct window *w;
4116 x_send_scroll_bar_event (window_being_scrolled,
4117 scroll_bar_end_scroll, 0, 0);
4118 w = XWINDOW (window_being_scrolled);
4120 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4122 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4123 /* The thumb size is incorrect while dragging: fix it. */
4124 set_vertical_scroll_bar (w);
4126 window_being_scrolled = Qnil;
4127 last_scroll_bar_part = -1;
4129 /* Xt timeouts no longer needed. */
4130 toolkit_scroll_bar_interaction = 0;
4133 #endif /* not USE_GTK */
4135 /* A vector of windows used for communication between
4136 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4138 static struct window **scroll_bar_windows;
4139 static int scroll_bar_windows_size;
4142 /* Send a client message with message type Xatom_Scrollbar for a
4143 scroll action to the frame of WINDOW. PART is a value identifying
4144 the part of the scroll bar that was clicked on. PORTION is the
4145 amount to scroll of a whole of WHOLE. */
4147 static void
4148 x_send_scroll_bar_event (window, part, portion, whole)
4149 Lisp_Object window;
4150 int part, portion, whole;
4152 XEvent event;
4153 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4154 struct window *w = XWINDOW (window);
4155 struct frame *f = XFRAME (w->frame);
4156 int i;
4158 BLOCK_INPUT;
4160 /* Construct a ClientMessage event to send to the frame. */
4161 ev->type = ClientMessage;
4162 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4163 ev->display = FRAME_X_DISPLAY (f);
4164 ev->window = FRAME_X_WINDOW (f);
4165 ev->format = 32;
4167 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4168 not enough to store a pointer or Lisp_Object on a 64 bit system.
4169 So, store the window in scroll_bar_windows and pass the index
4170 into that array in the event. */
4171 for (i = 0; i < scroll_bar_windows_size; ++i)
4172 if (scroll_bar_windows[i] == NULL)
4173 break;
4175 if (i == scroll_bar_windows_size)
4177 int new_size = max (10, 2 * scroll_bar_windows_size);
4178 size_t nbytes = new_size * sizeof *scroll_bar_windows;
4179 size_t old_nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4181 scroll_bar_windows = (struct window **) xrealloc (scroll_bar_windows,
4182 nbytes);
4183 bzero (&scroll_bar_windows[i], nbytes - old_nbytes);
4184 scroll_bar_windows_size = new_size;
4187 scroll_bar_windows[i] = w;
4188 ev->data.l[0] = (long) i;
4189 ev->data.l[1] = (long) part;
4190 ev->data.l[2] = (long) 0;
4191 ev->data.l[3] = (long) portion;
4192 ev->data.l[4] = (long) whole;
4194 /* Make Xt timeouts work while the scroll bar is active. */
4195 toolkit_scroll_bar_interaction = 1;
4196 #ifdef USE_X_TOOLKIT
4197 x_activate_timeout_atimer ();
4198 #endif
4200 /* Setting the event mask to zero means that the message will
4201 be sent to the client that created the window, and if that
4202 window no longer exists, no event will be sent. */
4203 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4204 UNBLOCK_INPUT;
4208 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4209 in *IEVENT. */
4211 static void
4212 x_scroll_bar_to_input_event (event, ievent)
4213 XEvent *event;
4214 struct input_event *ievent;
4216 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4217 Lisp_Object window;
4218 struct frame *f;
4219 struct window *w;
4221 w = scroll_bar_windows[ev->data.l[0]];
4222 scroll_bar_windows[ev->data.l[0]] = NULL;
4224 XSETWINDOW (window, w);
4225 f = XFRAME (w->frame);
4227 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4228 ievent->frame_or_window = window;
4229 ievent->arg = Qnil;
4230 #ifdef USE_GTK
4231 ievent->timestamp = CurrentTime;
4232 #else
4233 ievent->timestamp = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
4234 #endif
4235 ievent->part = ev->data.l[1];
4236 ievent->code = ev->data.l[2];
4237 ievent->x = make_number ((int) ev->data.l[3]);
4238 ievent->y = make_number ((int) ev->data.l[4]);
4239 ievent->modifiers = 0;
4243 #ifdef USE_MOTIF
4245 /* Minimum and maximum values used for Motif scroll bars. */
4247 #define XM_SB_MAX 10000000
4250 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4251 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4252 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4254 static void
4255 xm_scroll_callback (widget, client_data, call_data)
4256 Widget widget;
4257 XtPointer client_data, call_data;
4259 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4260 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4261 int part = -1, whole = 0, portion = 0;
4263 switch (cs->reason)
4265 case XmCR_DECREMENT:
4266 bar->dragging = Qnil;
4267 part = scroll_bar_up_arrow;
4268 break;
4270 case XmCR_INCREMENT:
4271 bar->dragging = Qnil;
4272 part = scroll_bar_down_arrow;
4273 break;
4275 case XmCR_PAGE_DECREMENT:
4276 bar->dragging = Qnil;
4277 part = scroll_bar_above_handle;
4278 break;
4280 case XmCR_PAGE_INCREMENT:
4281 bar->dragging = Qnil;
4282 part = scroll_bar_below_handle;
4283 break;
4285 case XmCR_TO_TOP:
4286 bar->dragging = Qnil;
4287 part = scroll_bar_to_top;
4288 break;
4290 case XmCR_TO_BOTTOM:
4291 bar->dragging = Qnil;
4292 part = scroll_bar_to_bottom;
4293 break;
4295 case XmCR_DRAG:
4297 int slider_size;
4299 /* Get the slider size. */
4300 BLOCK_INPUT;
4301 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4302 UNBLOCK_INPUT;
4304 whole = XM_SB_MAX - slider_size;
4305 portion = min (cs->value, whole);
4306 part = scroll_bar_handle;
4307 bar->dragging = make_number (cs->value);
4309 break;
4311 case XmCR_VALUE_CHANGED:
4312 break;
4315 if (part >= 0)
4317 window_being_scrolled = bar->window;
4318 last_scroll_bar_part = part;
4319 x_send_scroll_bar_event (bar->window, part, portion, whole);
4323 #elif defined USE_GTK
4325 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4326 bar widget. DATA is a pointer to the scroll_bar structure. */
4328 static void
4329 xg_scroll_callback (widget, data)
4330 GtkRange *widget;
4331 gpointer data;
4333 struct scroll_bar *bar = (struct scroll_bar *) data;
4334 gdouble previous;
4335 gdouble position;
4336 gdouble *p;
4337 int diff;
4339 int part = -1, whole = 0, portion = 0;
4340 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (widget));
4342 position = gtk_adjustment_get_value (adj);
4344 p = g_object_get_data (G_OBJECT (widget), XG_LAST_SB_DATA);
4345 if (! p)
4347 p = (gdouble*) xmalloc (sizeof (gdouble));
4348 *p = XG_SB_MIN;
4349 g_object_set_data (G_OBJECT (widget), XG_LAST_SB_DATA, p);
4352 previous = *p;
4353 *p = position;
4355 if (xg_ignore_gtk_scrollbar) return;
4357 diff = (int) (position - previous);
4359 if (diff == (int) adj->step_increment)
4361 part = scroll_bar_down_arrow;
4362 bar->dragging = Qnil;
4364 else if (-diff == (int) adj->step_increment)
4366 part = scroll_bar_up_arrow;
4367 bar->dragging = Qnil;
4369 else if (diff == (int) adj->page_increment)
4371 part = scroll_bar_below_handle;
4372 bar->dragging = Qnil;
4374 else if (-diff == (int) adj->page_increment)
4376 part = scroll_bar_above_handle;
4377 bar->dragging = Qnil;
4379 else
4381 part = scroll_bar_handle;
4382 whole = adj->upper - adj->page_size;
4383 portion = min ((int)position, whole);
4384 bar->dragging = make_number ((int)portion);
4387 if (part >= 0)
4389 window_being_scrolled = bar->window;
4390 last_scroll_bar_part = part;
4391 x_send_scroll_bar_event (bar->window, part, portion, whole);
4395 #else /* not USE_GTK and not USE_MOTIF */
4397 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4398 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4399 scroll bar struct. CALL_DATA is a pointer to a float saying where
4400 the thumb is. */
4402 static void
4403 xaw_jump_callback (widget, client_data, call_data)
4404 Widget widget;
4405 XtPointer client_data, call_data;
4407 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4408 float top = *(float *) call_data;
4409 float shown;
4410 int whole, portion, height;
4411 int part;
4413 /* Get the size of the thumb, a value between 0 and 1. */
4414 BLOCK_INPUT;
4415 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4416 UNBLOCK_INPUT;
4418 whole = 10000000;
4419 portion = shown < 1 ? top * whole : 0;
4421 if (shown < 1 && (eabs (top + shown - 1) < 1.0/height))
4422 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4423 the bottom, so we force the scrolling whenever we see that we're
4424 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4425 we try to ensure that we always stay two pixels away from the
4426 bottom). */
4427 part = scroll_bar_down_arrow;
4428 else
4429 part = scroll_bar_handle;
4431 window_being_scrolled = bar->window;
4432 bar->dragging = make_number (portion);
4433 last_scroll_bar_part = part;
4434 x_send_scroll_bar_event (bar->window, part, portion, whole);
4438 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4439 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4440 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4441 the scroll bar. CALL_DATA is an integer specifying the action that
4442 has taken place. Its magnitude is in the range 0..height of the
4443 scroll bar. Negative values mean scroll towards buffer start.
4444 Values < height of scroll bar mean line-wise movement. */
4446 static void
4447 xaw_scroll_callback (widget, client_data, call_data)
4448 Widget widget;
4449 XtPointer client_data, call_data;
4451 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4452 /* The position really is stored cast to a pointer. */
4453 int position = (long) call_data;
4454 Dimension height;
4455 int part;
4457 /* Get the height of the scroll bar. */
4458 BLOCK_INPUT;
4459 XtVaGetValues (widget, XtNheight, &height, NULL);
4460 UNBLOCK_INPUT;
4462 if (eabs (position) >= height)
4463 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4465 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4466 it maps line-movement to call_data = max(5, height/20). */
4467 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4468 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4469 else
4470 part = scroll_bar_move_ratio;
4472 window_being_scrolled = bar->window;
4473 bar->dragging = Qnil;
4474 last_scroll_bar_part = part;
4475 x_send_scroll_bar_event (bar->window, part, position, height);
4478 #endif /* not USE_GTK and not USE_MOTIF */
4480 #define SCROLL_BAR_NAME "verticalScrollBar"
4482 /* Create the widget for scroll bar BAR on frame F. Record the widget
4483 and X window of the scroll bar in BAR. */
4485 #ifdef USE_GTK
4486 static void
4487 x_create_toolkit_scroll_bar (f, bar)
4488 struct frame *f;
4489 struct scroll_bar *bar;
4491 char *scroll_bar_name = SCROLL_BAR_NAME;
4493 BLOCK_INPUT;
4494 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4495 scroll_bar_name);
4496 UNBLOCK_INPUT;
4499 #else /* not USE_GTK */
4501 static void
4502 x_create_toolkit_scroll_bar (f, bar)
4503 struct frame *f;
4504 struct scroll_bar *bar;
4506 Window xwindow;
4507 Widget widget;
4508 Arg av[20];
4509 int ac = 0;
4510 char *scroll_bar_name = SCROLL_BAR_NAME;
4511 unsigned long pixel;
4513 BLOCK_INPUT;
4515 #ifdef USE_MOTIF
4516 /* Set resources. Create the widget. */
4517 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4518 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4519 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4520 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4521 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4522 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4523 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4525 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4526 if (pixel != -1)
4528 XtSetArg (av[ac], XmNforeground, pixel);
4529 ++ac;
4532 pixel = f->output_data.x->scroll_bar_background_pixel;
4533 if (pixel != -1)
4535 XtSetArg (av[ac], XmNbackground, pixel);
4536 ++ac;
4539 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4540 scroll_bar_name, av, ac);
4542 /* Add one callback for everything that can happen. */
4543 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4544 (XtPointer) bar);
4545 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4546 (XtPointer) bar);
4547 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4548 (XtPointer) bar);
4549 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4550 (XtPointer) bar);
4551 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4552 (XtPointer) bar);
4553 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4554 (XtPointer) bar);
4555 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4556 (XtPointer) bar);
4558 /* Realize the widget. Only after that is the X window created. */
4559 XtRealizeWidget (widget);
4561 /* Set the cursor to an arrow. I didn't find a resource to do that.
4562 And I'm wondering why it hasn't an arrow cursor by default. */
4563 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4564 f->output_data.x->nontext_cursor);
4566 #else /* !USE_MOTIF i.e. use Xaw */
4568 /* Set resources. Create the widget. The background of the
4569 Xaw3d scroll bar widget is a little bit light for my taste.
4570 We don't alter it here to let users change it according
4571 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4572 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4573 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4574 /* For smoother scrolling with Xaw3d -sm */
4575 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4577 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4578 if (pixel != -1)
4580 XtSetArg (av[ac], XtNforeground, pixel);
4581 ++ac;
4584 pixel = f->output_data.x->scroll_bar_background_pixel;
4585 if (pixel != -1)
4587 XtSetArg (av[ac], XtNbackground, pixel);
4588 ++ac;
4591 /* Top/bottom shadow colors. */
4593 /* Allocate them, if necessary. */
4594 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4596 pixel = f->output_data.x->scroll_bar_background_pixel;
4597 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
4598 &pixel, 1.2, 0x8000))
4599 pixel = -1;
4600 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4602 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4604 pixel = f->output_data.x->scroll_bar_background_pixel;
4605 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
4606 &pixel, 0.6, 0x4000))
4607 pixel = -1;
4608 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4611 #ifdef XtNbeNiceToColormap
4612 /* Tell the toolkit about them. */
4613 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4614 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4615 /* We tried to allocate a color for the top/bottom shadow, and
4616 failed, so tell Xaw3d to use dithering instead. */
4618 XtSetArg (av[ac], XtNbeNiceToColormap, True);
4619 ++ac;
4621 else
4622 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4623 be more consistent with other emacs 3d colors, and since Xaw3d is
4624 not good at dealing with allocation failure. */
4626 /* This tells Xaw3d to use real colors instead of dithering for
4627 the shadows. */
4628 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4629 ++ac;
4631 /* Specify the colors. */
4632 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4633 if (pixel != -1)
4635 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4636 ++ac;
4638 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4639 if (pixel != -1)
4641 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4642 ++ac;
4645 #endif
4647 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4648 f->output_data.x->edit_widget, av, ac);
4651 char *initial = "";
4652 char *val = initial;
4653 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4654 #ifdef XtNarrowScrollbars
4655 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4656 #endif
4657 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4658 if (xaw3d_arrow_scroll || val == initial)
4659 { /* ARROW_SCROLL */
4660 xaw3d_arrow_scroll = True;
4661 /* Isn't that just a personal preference ? --Stef */
4662 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4666 /* Define callbacks. */
4667 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4668 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4669 (XtPointer) bar);
4671 /* Realize the widget. Only after that is the X window created. */
4672 XtRealizeWidget (widget);
4674 #endif /* !USE_MOTIF */
4676 /* Install an action hook that lets us detect when the user
4677 finishes interacting with a scroll bar. */
4678 if (action_hook_id == 0)
4679 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4681 /* Remember X window and widget in the scroll bar vector. */
4682 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4683 xwindow = XtWindow (widget);
4684 bar->x_window = xwindow;
4686 UNBLOCK_INPUT;
4688 #endif /* not USE_GTK */
4691 /* Set the thumb size and position of scroll bar BAR. We are currently
4692 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4694 #ifdef USE_GTK
4695 static void
4696 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4697 struct scroll_bar *bar;
4698 int portion, position, whole;
4700 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4703 #else /* not USE_GTK */
4704 static void
4705 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4706 struct scroll_bar *bar;
4707 int portion, position, whole;
4709 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4710 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4711 float top, shown;
4713 BLOCK_INPUT;
4715 #ifdef USE_MOTIF
4717 /* We use an estimate of 30 chars per line rather than the real
4718 `portion' value. This has the disadvantage that the thumb size
4719 is not very representative, but it makes our life a lot easier.
4720 Otherwise, we have to constantly adjust the thumb size, which
4721 we can't always do quickly enough: while dragging, the size of
4722 the thumb might prevent the user from dragging the thumb all the
4723 way to the end. but Motif and some versions of Xaw3d don't allow
4724 updating the thumb size while dragging. Also, even if we can update
4725 its size, the update will often happen too late.
4726 If you don't believe it, check out revision 1.650 of xterm.c to see
4727 what hoops we were going through and the still poor behavior we got. */
4728 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4729 /* When the thumb is at the bottom, position == whole.
4730 So we need to increase `whole' to make space for the thumb. */
4731 whole += portion;
4733 if (whole <= 0)
4734 top = 0, shown = 1;
4735 else
4737 top = (float) position / whole;
4738 shown = (float) portion / whole;
4741 if (NILP (bar->dragging))
4743 int size, value;
4745 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4746 is the scroll bar's maximum and MIN is the scroll bar's minimum
4747 value. */
4748 size = shown * XM_SB_MAX;
4749 size = min (size, XM_SB_MAX);
4750 size = max (size, 1);
4752 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4753 value = top * XM_SB_MAX;
4754 value = min (value, XM_SB_MAX - size);
4756 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4758 #else /* !USE_MOTIF i.e. use Xaw */
4760 if (whole == 0)
4761 top = 0, shown = 1;
4762 else
4764 top = (float) position / whole;
4765 shown = (float) portion / whole;
4769 float old_top, old_shown;
4770 Dimension height;
4771 XtVaGetValues (widget,
4772 XtNtopOfThumb, &old_top,
4773 XtNshown, &old_shown,
4774 XtNheight, &height,
4775 NULL);
4777 /* Massage the top+shown values. */
4778 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4779 top = max (0, min (1, top));
4780 else
4781 top = old_top;
4782 /* Keep two pixels available for moving the thumb down. */
4783 shown = max (0, min (1 - top - (2.0 / height), shown));
4785 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4786 check that your system's configuration file contains a define
4787 for `NARROWPROTO'. See s/freebsd.h for an example. */
4788 if (top != old_top || shown != old_shown)
4790 if (NILP (bar->dragging))
4791 XawScrollbarSetThumb (widget, top, shown);
4792 else
4794 /* Try to make the scrolling a tad smoother. */
4795 if (!xaw3d_pick_top)
4796 shown = min (shown, old_shown);
4798 XawScrollbarSetThumb (widget, top, shown);
4802 #endif /* !USE_MOTIF */
4804 UNBLOCK_INPUT;
4806 #endif /* not USE_GTK */
4808 #endif /* USE_TOOLKIT_SCROLL_BARS */
4812 /************************************************************************
4813 Scroll bars, general
4814 ************************************************************************/
4816 /* Create a scroll bar and return the scroll bar vector for it. W is
4817 the Emacs window on which to create the scroll bar. TOP, LEFT,
4818 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4819 scroll bar. */
4821 static struct scroll_bar *
4822 x_scroll_bar_create (w, top, left, width, height)
4823 struct window *w;
4824 int top, left, width, height;
4826 struct frame *f = XFRAME (w->frame);
4827 struct scroll_bar *bar
4828 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4830 BLOCK_INPUT;
4832 #ifdef USE_TOOLKIT_SCROLL_BARS
4833 x_create_toolkit_scroll_bar (f, bar);
4834 #else /* not USE_TOOLKIT_SCROLL_BARS */
4836 XSetWindowAttributes a;
4837 unsigned long mask;
4838 Window window;
4840 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4841 if (a.background_pixel == -1)
4842 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4844 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4845 | ButtonMotionMask | PointerMotionHintMask
4846 | ExposureMask);
4847 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4849 mask = (CWBackPixel | CWEventMask | CWCursor);
4851 /* Clear the area of W that will serve as a scroll bar. This is
4852 for the case that a window has been split horizontally. In
4853 this case, no clear_frame is generated to reduce flickering. */
4854 if (width > 0 && height > 0)
4855 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4856 left, top, width,
4857 window_box_height (w), False);
4859 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4860 /* Position and size of scroll bar. */
4861 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4862 top,
4863 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4864 height,
4865 /* Border width, depth, class, and visual. */
4867 CopyFromParent,
4868 CopyFromParent,
4869 CopyFromParent,
4870 /* Attributes. */
4871 mask, &a);
4872 bar->x_window = window;
4874 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4876 XSETWINDOW (bar->window, w);
4877 bar->top = top;
4878 bar->left = left;
4879 bar->width = width;
4880 bar->height = height;
4881 bar->start = 0;
4882 bar->end = 0;
4883 bar->dragging = Qnil;
4884 bar->fringe_extended_p = 0;
4886 /* Add bar to its frame's list of scroll bars. */
4887 bar->next = FRAME_SCROLL_BARS (f);
4888 bar->prev = Qnil;
4889 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4890 if (!NILP (bar->next))
4891 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4893 /* Map the window/widget. */
4894 #ifdef USE_TOOLKIT_SCROLL_BARS
4896 #ifdef USE_GTK
4897 xg_update_scrollbar_pos (f,
4898 bar->x_window,
4899 top,
4900 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4901 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4902 max (height, 1));
4903 xg_show_scroll_bar (bar->x_window);
4904 #else /* not USE_GTK */
4905 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4906 XtConfigureWidget (scroll_bar,
4907 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4908 top,
4909 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4910 max (height, 1), 0);
4911 XtMapWidget (scroll_bar);
4912 #endif /* not USE_GTK */
4914 #else /* not USE_TOOLKIT_SCROLL_BARS */
4915 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
4916 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4918 UNBLOCK_INPUT;
4919 return bar;
4923 #ifndef USE_TOOLKIT_SCROLL_BARS
4925 /* Draw BAR's handle in the proper position.
4927 If the handle is already drawn from START to END, don't bother
4928 redrawing it, unless REBUILD is non-zero; in that case, always
4929 redraw it. (REBUILD is handy for drawing the handle after expose
4930 events.)
4932 Normally, we want to constrain the start and end of the handle to
4933 fit inside its rectangle, but if the user is dragging the scroll
4934 bar handle, we want to let them drag it down all the way, so that
4935 the bar's top is as far down as it goes; otherwise, there's no way
4936 to move to the very end of the buffer. */
4938 static void
4939 x_scroll_bar_set_handle (bar, start, end, rebuild)
4940 struct scroll_bar *bar;
4941 int start, end;
4942 int rebuild;
4944 int dragging = ! NILP (bar->dragging);
4945 Window w = bar->x_window;
4946 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4947 GC gc = f->output_data.x->normal_gc;
4949 /* If the display is already accurate, do nothing. */
4950 if (! rebuild
4951 && start == bar->start
4952 && end == bar->end)
4953 return;
4955 BLOCK_INPUT;
4958 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
4959 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
4960 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
4962 /* Make sure the values are reasonable, and try to preserve
4963 the distance between start and end. */
4965 int length = end - start;
4967 if (start < 0)
4968 start = 0;
4969 else if (start > top_range)
4970 start = top_range;
4971 end = start + length;
4973 if (end < start)
4974 end = start;
4975 else if (end > top_range && ! dragging)
4976 end = top_range;
4979 /* Store the adjusted setting in the scroll bar. */
4980 bar->start = start;
4981 bar->end = end;
4983 /* Clip the end position, just for display. */
4984 if (end > top_range)
4985 end = top_range;
4987 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
4988 below top positions, to make sure the handle is always at least
4989 that many pixels tall. */
4990 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
4992 /* Draw the empty space above the handle. Note that we can't clear
4993 zero-height areas; that means "clear to end of window." */
4994 if (0 < start)
4995 x_clear_area (FRAME_X_DISPLAY (f), w,
4996 /* x, y, width, height, and exposures. */
4997 VERTICAL_SCROLL_BAR_LEFT_BORDER,
4998 VERTICAL_SCROLL_BAR_TOP_BORDER,
4999 inside_width, start,
5000 False);
5002 /* Change to proper foreground color if one is specified. */
5003 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5004 XSetForeground (FRAME_X_DISPLAY (f), gc,
5005 f->output_data.x->scroll_bar_foreground_pixel);
5007 /* Draw the handle itself. */
5008 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5009 /* x, y, width, height */
5010 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5011 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5012 inside_width, end - start);
5014 /* Restore the foreground color of the GC if we changed it above. */
5015 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5016 XSetForeground (FRAME_X_DISPLAY (f), gc,
5017 FRAME_FOREGROUND_PIXEL (f));
5019 /* Draw the empty space below the handle. Note that we can't
5020 clear zero-height areas; that means "clear to end of window." */
5021 if (end < inside_height)
5022 x_clear_area (FRAME_X_DISPLAY (f), w,
5023 /* x, y, width, height, and exposures. */
5024 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5025 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5026 inside_width, inside_height - end,
5027 False);
5031 UNBLOCK_INPUT;
5034 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5036 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5037 nil. */
5039 static void
5040 x_scroll_bar_remove (bar)
5041 struct scroll_bar *bar;
5043 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5044 BLOCK_INPUT;
5046 #ifdef USE_TOOLKIT_SCROLL_BARS
5047 #ifdef USE_GTK
5048 xg_remove_scroll_bar (f, bar->x_window);
5049 #else /* not USE_GTK */
5050 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5051 #endif /* not USE_GTK */
5052 #else
5053 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5054 #endif
5056 /* Disassociate this scroll bar from its window. */
5057 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
5059 UNBLOCK_INPUT;
5063 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5064 that we are displaying PORTION characters out of a total of WHOLE
5065 characters, starting at POSITION. If WINDOW has no scroll bar,
5066 create one. */
5068 static void
5069 XTset_vertical_scroll_bar (w, portion, whole, position)
5070 struct window *w;
5071 int portion, whole, position;
5073 struct frame *f = XFRAME (w->frame);
5074 struct scroll_bar *bar;
5075 int top, height, left, sb_left, width, sb_width;
5076 int window_y, window_height;
5077 #ifdef USE_TOOLKIT_SCROLL_BARS
5078 int fringe_extended_p;
5079 #endif
5081 /* Get window dimensions. */
5082 window_box (w, -1, 0, &window_y, 0, &window_height);
5083 top = window_y;
5084 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5085 height = window_height;
5087 /* Compute the left edge of the scroll bar area. */
5088 left = WINDOW_SCROLL_BAR_AREA_X (w);
5090 /* Compute the width of the scroll bar which might be less than
5091 the width of the area reserved for the scroll bar. */
5092 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5093 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5094 else
5095 sb_width = width;
5097 /* Compute the left edge of the scroll bar. */
5098 #ifdef USE_TOOLKIT_SCROLL_BARS
5099 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5100 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5101 else
5102 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5103 #else
5104 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5105 sb_left = left + width - sb_width;
5106 else
5107 sb_left = left;
5108 #endif
5110 #ifdef USE_TOOLKIT_SCROLL_BARS
5111 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5112 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5113 && WINDOW_LEFT_FRINGE_WIDTH (w)
5114 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5115 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5116 else
5117 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5118 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5119 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5120 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5121 #endif
5123 /* Does the scroll bar exist yet? */
5124 if (NILP (w->vertical_scroll_bar))
5126 if (width > 0 && height > 0)
5128 BLOCK_INPUT;
5129 #ifdef USE_TOOLKIT_SCROLL_BARS
5130 if (fringe_extended_p)
5131 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5132 sb_left, top, sb_width, height, False);
5133 else
5134 #endif
5135 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5136 left, top, width, height, False);
5137 UNBLOCK_INPUT;
5140 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5142 else
5144 /* It may just need to be moved and resized. */
5145 unsigned int mask = 0;
5147 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5149 BLOCK_INPUT;
5151 if (sb_left != bar->left)
5152 mask |= CWX;
5153 if (top != bar->top)
5154 mask |= CWY;
5155 if (sb_width != bar->width)
5156 mask |= CWWidth;
5157 if (height != bar->height)
5158 mask |= CWHeight;
5160 #ifdef USE_TOOLKIT_SCROLL_BARS
5162 /* Move/size the scroll bar widget. */
5163 if (mask || bar->fringe_extended_p != fringe_extended_p)
5165 /* Since toolkit scroll bars are smaller than the space reserved
5166 for them on the frame, we have to clear "under" them. */
5167 if (width > 0 && height > 0)
5169 if (fringe_extended_p)
5170 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5171 sb_left, top, sb_width, height, False);
5172 else
5173 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5174 left, top, width, height, False);
5176 #ifdef USE_GTK
5177 xg_update_scrollbar_pos (f,
5178 bar->x_window,
5179 top,
5180 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5181 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5182 max (height, 1));
5183 #else /* not USE_GTK */
5184 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5185 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5186 top,
5187 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5188 max (height, 1), 0);
5189 #endif /* not USE_GTK */
5191 #else /* not USE_TOOLKIT_SCROLL_BARS */
5193 /* Clear areas not covered by the scroll bar because of
5194 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5195 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5197 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5198 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5199 height, False);
5200 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5201 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5202 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5203 height, False);
5206 /* Clear areas not covered by the scroll bar because it's not as
5207 wide as the area reserved for it. This makes sure a
5208 previous mode line display is cleared after C-x 2 C-x 1, for
5209 example. */
5211 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5212 int rest = area_width - sb_width;
5213 if (rest > 0 && height > 0)
5215 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5216 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5217 left + area_width - rest, top,
5218 rest, height, False);
5219 else
5220 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5221 left, top, rest, height, False);
5225 /* Move/size the scroll bar window. */
5226 if (mask)
5228 XWindowChanges wc;
5230 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5231 wc.y = top;
5232 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5233 wc.height = height;
5234 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5235 mask, &wc);
5238 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5240 /* Remember new settings. */
5241 bar->left = sb_left;
5242 bar->top = top;
5243 bar->width = sb_width;
5244 bar->height = height;
5246 UNBLOCK_INPUT;
5249 #ifdef USE_TOOLKIT_SCROLL_BARS
5250 bar->fringe_extended_p = fringe_extended_p;
5252 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5253 #else /* not USE_TOOLKIT_SCROLL_BARS */
5254 /* Set the scroll bar's current state, unless we're currently being
5255 dragged. */
5256 if (NILP (bar->dragging))
5258 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5260 if (whole == 0)
5261 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5262 else
5264 int start = ((double) position * top_range) / whole;
5265 int end = ((double) (position + portion) * top_range) / whole;
5266 x_scroll_bar_set_handle (bar, start, end, 0);
5269 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5271 XSETVECTOR (w->vertical_scroll_bar, bar);
5275 /* The following three hooks are used when we're doing a thorough
5276 redisplay of the frame. We don't explicitly know which scroll bars
5277 are going to be deleted, because keeping track of when windows go
5278 away is a real pain - "Can you say set-window-configuration, boys
5279 and girls?" Instead, we just assert at the beginning of redisplay
5280 that *all* scroll bars are to be removed, and then save a scroll bar
5281 from the fiery pit when we actually redisplay its window. */
5283 /* Arrange for all scroll bars on FRAME to be removed at the next call
5284 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5285 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5287 static void
5288 XTcondemn_scroll_bars (frame)
5289 FRAME_PTR frame;
5291 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5292 while (! NILP (FRAME_SCROLL_BARS (frame)))
5294 Lisp_Object bar;
5295 bar = FRAME_SCROLL_BARS (frame);
5296 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5297 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5298 XSCROLL_BAR (bar)->prev = Qnil;
5299 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5300 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5301 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5306 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5307 Note that WINDOW isn't necessarily condemned at all. */
5309 static void
5310 XTredeem_scroll_bar (window)
5311 struct window *window;
5313 struct scroll_bar *bar;
5314 struct frame *f;
5316 /* We can't redeem this window's scroll bar if it doesn't have one. */
5317 if (NILP (window->vertical_scroll_bar))
5318 abort ();
5320 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5322 /* Unlink it from the condemned list. */
5323 f = XFRAME (WINDOW_FRAME (window));
5324 if (NILP (bar->prev))
5326 /* If the prev pointer is nil, it must be the first in one of
5327 the lists. */
5328 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5329 /* It's not condemned. Everything's fine. */
5330 return;
5331 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5332 window->vertical_scroll_bar))
5333 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5334 else
5335 /* If its prev pointer is nil, it must be at the front of
5336 one or the other! */
5337 abort ();
5339 else
5340 XSCROLL_BAR (bar->prev)->next = bar->next;
5342 if (! NILP (bar->next))
5343 XSCROLL_BAR (bar->next)->prev = bar->prev;
5345 bar->next = FRAME_SCROLL_BARS (f);
5346 bar->prev = Qnil;
5347 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5348 if (! NILP (bar->next))
5349 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5352 /* Remove all scroll bars on FRAME that haven't been saved since the
5353 last call to `*condemn_scroll_bars_hook'. */
5355 static void
5356 XTjudge_scroll_bars (f)
5357 FRAME_PTR f;
5359 Lisp_Object bar, next;
5361 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5363 /* Clear out the condemned list now so we won't try to process any
5364 more events on the hapless scroll bars. */
5365 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5367 for (; ! NILP (bar); bar = next)
5369 struct scroll_bar *b = XSCROLL_BAR (bar);
5371 x_scroll_bar_remove (b);
5373 next = b->next;
5374 b->next = b->prev = Qnil;
5377 /* Now there should be no references to the condemned scroll bars,
5378 and they should get garbage-collected. */
5382 #ifndef USE_TOOLKIT_SCROLL_BARS
5383 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5384 is a no-op when using toolkit scroll bars.
5386 This may be called from a signal handler, so we have to ignore GC
5387 mark bits. */
5389 static void
5390 x_scroll_bar_expose (bar, event)
5391 struct scroll_bar *bar;
5392 XEvent *event;
5394 Window w = bar->x_window;
5395 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5396 GC gc = f->output_data.x->normal_gc;
5397 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5399 BLOCK_INPUT;
5401 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5403 /* Switch to scroll bar foreground color. */
5404 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5405 XSetForeground (FRAME_X_DISPLAY (f), gc,
5406 f->output_data.x->scroll_bar_foreground_pixel);
5408 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5409 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5411 /* x, y, width, height */
5412 0, 0,
5413 bar->width - 1 - width_trim - width_trim,
5414 bar->height - 1);
5416 /* Restore the foreground color of the GC if we changed it above. */
5417 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5418 XSetForeground (FRAME_X_DISPLAY (f), gc,
5419 FRAME_FOREGROUND_PIXEL (f));
5421 UNBLOCK_INPUT;
5424 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5426 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5427 is set to something other than NO_EVENT, it is enqueued.
5429 This may be called from a signal handler, so we have to ignore GC
5430 mark bits. */
5433 static void
5434 x_scroll_bar_handle_click (bar, event, emacs_event)
5435 struct scroll_bar *bar;
5436 XEvent *event;
5437 struct input_event *emacs_event;
5439 if (! WINDOWP (bar->window))
5440 abort ();
5442 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5443 emacs_event->code = event->xbutton.button - Button1;
5444 emacs_event->modifiers
5445 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5446 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5447 event->xbutton.state)
5448 | (event->type == ButtonRelease
5449 ? up_modifier
5450 : down_modifier));
5451 emacs_event->frame_or_window = bar->window;
5452 emacs_event->arg = Qnil;
5453 emacs_event->timestamp = event->xbutton.time;
5455 #if 0
5456 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5457 int internal_height
5458 = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5459 #endif
5460 int top_range
5461 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5462 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5464 if (y < 0) y = 0;
5465 if (y > top_range) y = top_range;
5467 if (y < bar->start)
5468 emacs_event->part = scroll_bar_above_handle;
5469 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5470 emacs_event->part = scroll_bar_handle;
5471 else
5472 emacs_event->part = scroll_bar_below_handle;
5474 /* Just because the user has clicked on the handle doesn't mean
5475 they want to drag it. Lisp code needs to be able to decide
5476 whether or not we're dragging. */
5477 #if 0
5478 /* If the user has just clicked on the handle, record where they're
5479 holding it. */
5480 if (event->type == ButtonPress
5481 && emacs_event->part == scroll_bar_handle)
5482 XSETINT (bar->dragging, y - bar->start);
5483 #endif
5485 #ifndef USE_TOOLKIT_SCROLL_BARS
5486 /* If the user has released the handle, set it to its final position. */
5487 if (event->type == ButtonRelease
5488 && ! NILP (bar->dragging))
5490 int new_start = y - XINT (bar->dragging);
5491 int new_end = new_start + bar->end - bar->start;
5493 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5494 bar->dragging = Qnil;
5496 #endif
5498 /* Same deal here as the other #if 0. */
5499 #if 0
5500 /* Clicks on the handle are always reported as occurring at the top of
5501 the handle. */
5502 if (emacs_event->part == scroll_bar_handle)
5503 emacs_event->x = bar->start;
5504 else
5505 XSETINT (emacs_event->x, y);
5506 #else
5507 XSETINT (emacs_event->x, y);
5508 #endif
5510 XSETINT (emacs_event->y, top_range);
5514 #ifndef USE_TOOLKIT_SCROLL_BARS
5516 /* Handle some mouse motion while someone is dragging the scroll bar.
5518 This may be called from a signal handler, so we have to ignore GC
5519 mark bits. */
5521 static void
5522 x_scroll_bar_note_movement (bar, event)
5523 struct scroll_bar *bar;
5524 XEvent *event;
5526 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5528 last_mouse_movement_time = event->xmotion.time;
5530 f->mouse_moved = 1;
5531 XSETVECTOR (last_mouse_scroll_bar, bar);
5533 /* If we're dragging the bar, display it. */
5534 if (! NILP (bar->dragging))
5536 /* Where should the handle be now? */
5537 int new_start = event->xmotion.y - XINT (bar->dragging);
5539 if (new_start != bar->start)
5541 int new_end = new_start + bar->end - bar->start;
5543 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5548 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5550 /* Return information to the user about the current position of the mouse
5551 on the scroll bar. */
5553 static void
5554 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time)
5555 FRAME_PTR *fp;
5556 Lisp_Object *bar_window;
5557 enum scroll_bar_part *part;
5558 Lisp_Object *x, *y;
5559 unsigned long *time;
5561 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5562 Window w = bar->x_window;
5563 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5564 int win_x, win_y;
5565 Window dummy_window;
5566 int dummy_coord;
5567 unsigned int dummy_mask;
5569 BLOCK_INPUT;
5571 /* Get the mouse's position relative to the scroll bar window, and
5572 report that. */
5573 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5575 /* Root, child, root x and root y. */
5576 &dummy_window, &dummy_window,
5577 &dummy_coord, &dummy_coord,
5579 /* Position relative to scroll bar. */
5580 &win_x, &win_y,
5582 /* Mouse buttons and modifier keys. */
5583 &dummy_mask))
5585 else
5587 #if 0
5588 int inside_height
5589 = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5590 #endif
5591 int top_range
5592 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5594 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5596 if (! NILP (bar->dragging))
5597 win_y -= XINT (bar->dragging);
5599 if (win_y < 0)
5600 win_y = 0;
5601 if (win_y > top_range)
5602 win_y = top_range;
5604 *fp = f;
5605 *bar_window = bar->window;
5607 if (! NILP (bar->dragging))
5608 *part = scroll_bar_handle;
5609 else if (win_y < bar->start)
5610 *part = scroll_bar_above_handle;
5611 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5612 *part = scroll_bar_handle;
5613 else
5614 *part = scroll_bar_below_handle;
5616 XSETINT (*x, win_y);
5617 XSETINT (*y, top_range);
5619 f->mouse_moved = 0;
5620 last_mouse_scroll_bar = Qnil;
5623 *time = last_mouse_movement_time;
5625 UNBLOCK_INPUT;
5629 /* The screen has been cleared so we may have changed foreground or
5630 background colors, and the scroll bars may need to be redrawn.
5631 Clear out the scroll bars, and ask for expose events, so we can
5632 redraw them. */
5634 void
5635 x_scroll_bar_clear (f)
5636 FRAME_PTR f;
5638 #ifndef USE_TOOLKIT_SCROLL_BARS
5639 Lisp_Object bar;
5641 /* We can have scroll bars even if this is 0,
5642 if we just turned off scroll bar mode.
5643 But in that case we should not clear them. */
5644 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5645 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5646 bar = XSCROLL_BAR (bar)->next)
5647 XClearArea (FRAME_X_DISPLAY (f),
5648 XSCROLL_BAR (bar)->x_window,
5649 0, 0, 0, 0, True);
5650 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5654 /* The main X event-reading loop - XTread_socket. */
5656 #if 0
5657 /* Time stamp of enter window event. This is only used by XTread_socket,
5658 but we have to put it out here, since static variables within functions
5659 sometimes don't work. */
5661 static Time enter_timestamp;
5662 #endif
5664 /* This holds the state XLookupString needs to implement dead keys
5665 and other tricks known as "compose processing". _X Window System_
5666 says that a portable program can't use this, but Stephen Gildea assures
5667 me that letting the compiler initialize it to zeros will work okay.
5669 This must be defined outside of XTread_socket, for the same reasons
5670 given for enter_timestamp, above. */
5672 static XComposeStatus compose_status;
5674 /* Record the last 100 characters stored
5675 to help debug the loss-of-chars-during-GC problem. */
5677 static int temp_index;
5678 static short temp_buffer[100];
5680 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5681 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5682 temp_index = 0; \
5683 temp_buffer[temp_index++] = (keysym)
5685 /* Set this to nonzero to fake an "X I/O error"
5686 on a particular display. */
5688 struct x_display_info *XTread_socket_fake_io_error;
5690 /* When we find no input here, we occasionally do a no-op command
5691 to verify that the X server is still running and we can still talk with it.
5692 We try all the open displays, one by one.
5693 This variable is used for cycling thru the displays. */
5695 static struct x_display_info *next_noop_dpyinfo;
5697 #define SET_SAVED_MENU_EVENT(size) \
5698 do \
5700 if (f->output_data.x->saved_menu_event == 0) \
5701 f->output_data.x->saved_menu_event \
5702 = (XEvent *) xmalloc (sizeof (XEvent)); \
5703 bcopy (&event, f->output_data.x->saved_menu_event, size); \
5704 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5705 XSETFRAME (inev.ie.frame_or_window, f); \
5707 while (0)
5709 #define SET_SAVED_BUTTON_EVENT SET_SAVED_MENU_EVENT (sizeof (XButtonEvent))
5710 #define SET_SAVED_KEY_EVENT SET_SAVED_MENU_EVENT (sizeof (XKeyEvent))
5713 enum
5715 X_EVENT_NORMAL,
5716 X_EVENT_GOTO_OUT,
5717 X_EVENT_DROP
5720 /* Filter events for the current X input method.
5721 DPYINFO is the display this event is for.
5722 EVENT is the X event to filter.
5724 Returns non-zero if the event was filtered, caller shall not process
5725 this event further.
5726 Returns zero if event is wasn't filtered. */
5728 #ifdef HAVE_X_I18N
5729 static int
5730 x_filter_event (dpyinfo, event)
5731 struct x_display_info *dpyinfo;
5732 XEvent *event;
5734 /* XFilterEvent returns non-zero if the input method has
5735 consumed the event. We pass the frame's X window to
5736 XFilterEvent because that's the one for which the IC
5737 was created. */
5739 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5740 event->xclient.window);
5742 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5744 #endif
5746 #ifdef USE_GTK
5747 static int current_count;
5748 static int current_finish;
5749 static struct input_event *current_hold_quit;
5751 /* This is the filter function invoked by the GTK event loop.
5752 It is invoked before the XEvent is translated to a GdkEvent,
5753 so we have a chance to act on the event before GTK. */
5754 static GdkFilterReturn
5755 event_handler_gdk (gxev, ev, data)
5756 GdkXEvent *gxev;
5757 GdkEvent *ev;
5758 gpointer data;
5760 XEvent *xev = (XEvent *) gxev;
5762 if (current_count >= 0)
5764 struct x_display_info *dpyinfo;
5766 dpyinfo = x_display_info_for_display (xev->xany.display);
5768 #ifdef HAVE_X_I18N
5769 /* Filter events for the current X input method.
5770 GTK calls XFilterEvent but not for key press and release,
5771 so we do it here. */
5772 if (xev->type == KeyPress || xev->type == KeyRelease)
5773 if (dpyinfo && x_filter_event (dpyinfo, xev))
5774 return GDK_FILTER_REMOVE;
5775 #endif
5777 if (! dpyinfo)
5778 current_finish = X_EVENT_NORMAL;
5779 else
5781 current_count +=
5782 handle_one_xevent (dpyinfo, xev, &current_finish,
5783 current_hold_quit);
5786 else
5787 current_finish = x_dispatch_event (xev, xev->xany.display);
5789 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5790 return GDK_FILTER_REMOVE;
5792 return GDK_FILTER_CONTINUE;
5794 #endif /* USE_GTK */
5797 /* Handles the XEvent EVENT on display DPYINFO.
5799 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5800 *FINISH is zero if caller should continue reading events.
5801 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5803 We return the number of characters stored into the buffer. */
5805 static int
5806 handle_one_xevent (dpyinfo, eventp, finish, hold_quit)
5807 struct x_display_info *dpyinfo;
5808 XEvent *eventp;
5809 int *finish;
5810 struct input_event *hold_quit;
5812 union {
5813 struct input_event ie;
5814 struct selection_input_event sie;
5815 } inev;
5816 int count = 0;
5817 int do_help = 0;
5818 int nbytes = 0;
5819 struct frame *f = NULL;
5820 struct coding_system coding;
5821 XEvent event = *eventp;
5823 *finish = X_EVENT_NORMAL;
5825 EVENT_INIT (inev.ie);
5826 inev.ie.kind = NO_EVENT;
5827 inev.ie.arg = Qnil;
5829 switch (event.type)
5831 case ClientMessage:
5833 if (event.xclient.message_type
5834 == dpyinfo->Xatom_wm_protocols
5835 && event.xclient.format == 32)
5837 if (event.xclient.data.l[0]
5838 == dpyinfo->Xatom_wm_take_focus)
5840 /* Use x_any_window_to_frame because this
5841 could be the shell widget window
5842 if the frame has no title bar. */
5843 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5844 #ifdef HAVE_X_I18N
5845 /* Not quite sure this is needed -pd */
5846 if (f && FRAME_XIC (f))
5847 XSetICFocus (FRAME_XIC (f));
5848 #endif
5849 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5850 instructs the WM to set the input focus automatically for
5851 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5852 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5853 it has set the focus. So, XSetInputFocus below is not
5854 needed.
5856 The call to XSetInputFocus below has also caused trouble. In
5857 cases where the XSetInputFocus done by the WM and the one
5858 below are temporally close (on a fast machine), the call
5859 below can generate additional FocusIn events which confuse
5860 Emacs. */
5862 /* Since we set WM_TAKE_FOCUS, we must call
5863 XSetInputFocus explicitly. But not if f is null,
5864 since that might be an event for a deleted frame. */
5865 if (f)
5867 Display *d = event.xclient.display;
5868 /* Catch and ignore errors, in case window has been
5869 iconified by a window manager such as GWM. */
5870 x_catch_errors (d);
5871 XSetInputFocus (d, event.xclient.window,
5872 /* The ICCCM says this is
5873 the only valid choice. */
5874 RevertToParent,
5875 event.xclient.data.l[1]);
5876 /* This is needed to detect the error
5877 if there is an error. */
5878 XSync (d, False);
5879 x_uncatch_errors ();
5881 /* Not certain about handling scroll bars here */
5882 #endif /* 0 */
5883 goto done;
5886 if (event.xclient.data.l[0]
5887 == dpyinfo->Xatom_wm_save_yourself)
5889 /* Save state modify the WM_COMMAND property to
5890 something which can reinstate us. This notifies
5891 the session manager, who's looking for such a
5892 PropertyNotify. Can restart processing when
5893 a keyboard or mouse event arrives. */
5894 /* If we have a session manager, don't set this.
5895 KDE will then start two Emacsen, one for the
5896 session manager and one for this. */
5897 #ifdef HAVE_X_SM
5898 if (! x_session_have_connection ())
5899 #endif
5901 f = x_top_window_to_frame (dpyinfo,
5902 event.xclient.window);
5903 /* This is just so we only give real data once
5904 for a single Emacs process. */
5905 if (f == SELECTED_FRAME ())
5906 XSetCommand (FRAME_X_DISPLAY (f),
5907 event.xclient.window,
5908 initial_argv, initial_argc);
5909 else if (f)
5910 XSetCommand (FRAME_X_DISPLAY (f),
5911 event.xclient.window,
5912 0, 0);
5914 goto done;
5917 if (event.xclient.data.l[0]
5918 == dpyinfo->Xatom_wm_delete_window)
5920 f = x_any_window_to_frame (dpyinfo,
5921 event.xclient.window);
5922 if (!f)
5923 goto OTHER; /* May be a dialog that is to be removed */
5925 inev.ie.kind = DELETE_WINDOW_EVENT;
5926 XSETFRAME (inev.ie.frame_or_window, f);
5927 goto done;
5930 goto done;
5933 if (event.xclient.message_type
5934 == dpyinfo->Xatom_wm_configure_denied)
5936 goto done;
5939 if (event.xclient.message_type
5940 == dpyinfo->Xatom_wm_window_moved)
5942 int new_x, new_y;
5943 f = x_window_to_frame (dpyinfo, event.xclient.window);
5945 new_x = event.xclient.data.s[0];
5946 new_y = event.xclient.data.s[1];
5948 if (f)
5950 f->left_pos = new_x;
5951 f->top_pos = new_y;
5953 goto done;
5956 #ifdef HACK_EDITRES
5957 if (event.xclient.message_type
5958 == dpyinfo->Xatom_editres)
5960 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5961 if (f)
5962 _XEditResCheckMessages (f->output_data.x->widget, NULL,
5963 &event, NULL);
5964 goto done;
5966 #endif /* HACK_EDITRES */
5968 if ((event.xclient.message_type
5969 == dpyinfo->Xatom_DONE)
5970 || (event.xclient.message_type
5971 == dpyinfo->Xatom_PAGE))
5973 /* Ghostview job completed. Kill it. We could
5974 reply with "Next" if we received "Page", but we
5975 currently never do because we are interested in
5976 images, only, which should have 1 page. */
5977 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
5978 f = x_window_to_frame (dpyinfo, event.xclient.window);
5979 if (!f)
5980 goto OTHER;
5981 x_kill_gs_process (pixmap, f);
5982 expose_frame (f, 0, 0, 0, 0);
5983 goto done;
5986 #ifdef USE_TOOLKIT_SCROLL_BARS
5987 /* Scroll bar callbacks send a ClientMessage from which
5988 we construct an input_event. */
5989 if (event.xclient.message_type
5990 == dpyinfo->Xatom_Scrollbar)
5992 x_scroll_bar_to_input_event (&event, &inev.ie);
5993 *finish = X_EVENT_GOTO_OUT;
5994 goto done;
5996 #endif /* USE_TOOLKIT_SCROLL_BARS */
5998 /* XEmbed messages from the embedder (if any). */
5999 if (event.xclient.message_type
6000 == dpyinfo->Xatom_XEMBED)
6002 enum xembed_message msg = event.xclient.data.l[1];
6003 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
6004 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6006 *finish = X_EVENT_GOTO_OUT;
6007 goto done;
6010 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6011 if (!f)
6012 goto OTHER;
6013 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
6014 *finish = X_EVENT_DROP;
6016 break;
6018 case SelectionNotify:
6019 last_user_time = event.xselection.time;
6020 #ifdef USE_X_TOOLKIT
6021 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
6022 goto OTHER;
6023 #endif /* not USE_X_TOOLKIT */
6024 x_handle_selection_notify (&event.xselection);
6025 break;
6027 case SelectionClear: /* Someone has grabbed ownership. */
6028 last_user_time = event.xselectionclear.time;
6029 #ifdef USE_X_TOOLKIT
6030 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6031 goto OTHER;
6032 #endif /* USE_X_TOOLKIT */
6034 XSelectionClearEvent *eventp = (XSelectionClearEvent *) &event;
6036 inev.ie.kind = SELECTION_CLEAR_EVENT;
6037 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6038 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6039 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6040 inev.ie.frame_or_window = Qnil;
6042 break;
6044 case SelectionRequest: /* Someone wants our selection. */
6045 last_user_time = event.xselectionrequest.time;
6046 #ifdef USE_X_TOOLKIT
6047 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6048 goto OTHER;
6049 #endif /* USE_X_TOOLKIT */
6051 XSelectionRequestEvent *eventp
6052 = (XSelectionRequestEvent *) &event;
6054 inev.ie.kind = SELECTION_REQUEST_EVENT;
6055 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6056 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6057 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6058 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6059 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6060 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6061 inev.ie.frame_or_window = Qnil;
6063 break;
6065 case PropertyNotify:
6066 last_user_time = event.xproperty.time;
6067 #if 0 /* This is plain wrong. In the case that we are waiting for a
6068 PropertyNotify used as an ACK in incremental selection
6069 transfer, the property will be on the receiver's window. */
6070 #if defined USE_X_TOOLKIT
6071 if (!x_any_window_to_frame (dpyinfo, event.xproperty.window))
6072 goto OTHER;
6073 #endif
6074 #endif
6075 x_handle_property_notify (&event.xproperty);
6076 goto OTHER;
6078 case ReparentNotify:
6079 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6080 if (f)
6082 int x, y;
6083 f->output_data.x->parent_desc = event.xreparent.parent;
6084 x_real_positions (f, &x, &y);
6085 f->left_pos = x;
6086 f->top_pos = y;
6088 /* Perhaps reparented due to a WM restart. Reset this. */
6089 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6090 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6092 goto OTHER;
6094 case Expose:
6095 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6096 if (f)
6098 x_check_fullscreen (f);
6100 #ifdef USE_GTK
6101 /* This seems to be needed for GTK 2.6. */
6102 x_clear_area (event.xexpose.display,
6103 event.xexpose.window,
6104 event.xexpose.x, event.xexpose.y,
6105 event.xexpose.width, event.xexpose.height,
6106 FALSE);
6107 #endif
6108 if (f->async_visible == 0)
6110 f->async_visible = 1;
6111 f->async_iconified = 0;
6112 f->output_data.x->has_been_visible = 1;
6113 SET_FRAME_GARBAGED (f);
6115 else
6116 expose_frame (f,
6117 event.xexpose.x, event.xexpose.y,
6118 event.xexpose.width, event.xexpose.height);
6120 else
6122 #ifndef USE_TOOLKIT_SCROLL_BARS
6123 struct scroll_bar *bar;
6124 #endif
6125 #if defined USE_LUCID
6126 /* Submenus of the Lucid menu bar aren't widgets
6127 themselves, so there's no way to dispatch events
6128 to them. Recognize this case separately. */
6130 Widget widget
6131 = x_window_to_menu_bar (event.xexpose.window);
6132 if (widget)
6133 xlwmenu_redisplay (widget);
6135 #endif /* USE_LUCID */
6137 #ifdef USE_TOOLKIT_SCROLL_BARS
6138 /* Dispatch event to the widget. */
6139 goto OTHER;
6140 #else /* not USE_TOOLKIT_SCROLL_BARS */
6141 bar = x_window_to_scroll_bar (event.xexpose.display,
6142 event.xexpose.window);
6144 if (bar)
6145 x_scroll_bar_expose (bar, &event);
6146 #ifdef USE_X_TOOLKIT
6147 else
6148 goto OTHER;
6149 #endif /* USE_X_TOOLKIT */
6150 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6152 break;
6154 case GraphicsExpose: /* This occurs when an XCopyArea's
6155 source area was obscured or not
6156 available. */
6157 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6158 if (f)
6160 expose_frame (f,
6161 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6162 event.xgraphicsexpose.width,
6163 event.xgraphicsexpose.height);
6165 #ifdef USE_X_TOOLKIT
6166 else
6167 goto OTHER;
6168 #endif /* USE_X_TOOLKIT */
6169 break;
6171 case NoExpose: /* This occurs when an XCopyArea's
6172 source area was completely
6173 available. */
6174 break;
6176 case UnmapNotify:
6177 /* Redo the mouse-highlight after the tooltip has gone. */
6178 if (event.xmap.window == tip_window)
6180 tip_window = 0;
6181 redo_mouse_highlight ();
6184 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6185 if (f) /* F may no longer exist if
6186 the frame was deleted. */
6188 /* While a frame is unmapped, display generation is
6189 disabled; you don't want to spend time updating a
6190 display that won't ever be seen. */
6191 f->async_visible = 0;
6192 /* We can't distinguish, from the event, whether the window
6193 has become iconified or invisible. So assume, if it
6194 was previously visible, than now it is iconified.
6195 But x_make_frame_invisible clears both
6196 the visible flag and the iconified flag;
6197 and that way, we know the window is not iconified now. */
6198 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6200 f->async_iconified = 1;
6202 inev.ie.kind = ICONIFY_EVENT;
6203 XSETFRAME (inev.ie.frame_or_window, f);
6206 goto OTHER;
6208 case MapNotify:
6209 if (event.xmap.window == tip_window)
6210 /* The tooltip has been drawn already. Avoid
6211 the SET_FRAME_GARBAGED below. */
6212 goto OTHER;
6214 /* We use x_top_window_to_frame because map events can
6215 come for sub-windows and they don't mean that the
6216 frame is visible. */
6217 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6218 if (f)
6220 /* wait_reading_process_output will notice this and update
6221 the frame's display structures.
6222 If we where iconified, we should not set garbaged,
6223 because that stops redrawing on Expose events. This looks
6224 bad if we are called from a recursive event loop
6225 (x_dispatch_event), for example when a dialog is up. */
6226 if (! f->async_iconified)
6227 SET_FRAME_GARBAGED (f);
6229 f->async_visible = 1;
6230 f->async_iconified = 0;
6231 f->output_data.x->has_been_visible = 1;
6233 if (f->iconified)
6235 inev.ie.kind = DEICONIFY_EVENT;
6236 XSETFRAME (inev.ie.frame_or_window, f);
6238 else if (! NILP (Vframe_list)
6239 && ! NILP (XCDR (Vframe_list)))
6240 /* Force a redisplay sooner or later
6241 to update the frame titles
6242 in case this is the second frame. */
6243 record_asynch_buffer_change ();
6245 goto OTHER;
6247 case KeyPress:
6249 last_user_time = event.xkey.time;
6250 ignore_next_mouse_click_timeout = 0;
6252 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6253 /* Dispatch KeyPress events when in menu. */
6254 if (popup_activated ())
6255 goto OTHER;
6256 #endif
6258 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6260 /* If mouse-highlight is an integer, input clears out
6261 mouse highlighting. */
6262 if (!dpyinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6263 && (f == 0
6264 || !EQ (f->tool_bar_window, dpyinfo->mouse_face_window)))
6266 clear_mouse_face (dpyinfo);
6267 dpyinfo->mouse_face_hidden = 1;
6270 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6271 if (f == 0)
6273 /* Scroll bars consume key events, but we want
6274 the keys to go to the scroll bar's frame. */
6275 Widget widget = XtWindowToWidget (dpyinfo->display,
6276 event.xkey.window);
6277 if (widget && XmIsScrollBar (widget))
6279 widget = XtParent (widget);
6280 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6283 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6285 if (f != 0)
6287 KeySym keysym, orig_keysym;
6288 /* al%imercury@uunet.uu.net says that making this 81
6289 instead of 80 fixed a bug whereby meta chars made
6290 his Emacs hang.
6292 It seems that some version of XmbLookupString has
6293 a bug of not returning XBufferOverflow in
6294 status_return even if the input is too long to
6295 fit in 81 bytes. So, we must prepare sufficient
6296 bytes for copy_buffer. 513 bytes (256 chars for
6297 two-byte character set) seems to be a fairly good
6298 approximation. -- 2000.8.10 handa@etl.go.jp */
6299 unsigned char copy_buffer[513];
6300 unsigned char *copy_bufptr = copy_buffer;
6301 int copy_bufsiz = sizeof (copy_buffer);
6302 int modifiers;
6303 Lisp_Object coding_system = Qlatin_1;
6304 Lisp_Object c;
6306 #ifdef USE_GTK
6307 /* Don't pass keys to GTK. A Tab will shift focus to the
6308 tool bar in GTK 2.4. Keys will still go to menus and
6309 dialogs because in that case popup_activated is TRUE
6310 (see above). */
6311 *finish = X_EVENT_DROP;
6312 #endif
6314 event.xkey.state
6315 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6316 extra_keyboard_modifiers);
6317 modifiers = event.xkey.state;
6319 /* This will have to go some day... */
6321 /* make_lispy_event turns chars into control chars.
6322 Don't do it here because XLookupString is too eager. */
6323 event.xkey.state &= ~ControlMask;
6324 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6325 | dpyinfo->super_mod_mask
6326 | dpyinfo->hyper_mod_mask
6327 | dpyinfo->alt_mod_mask);
6329 /* In case Meta is ComposeCharacter,
6330 clear its status. According to Markus Ehrnsperger
6331 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6332 this enables ComposeCharacter to work whether or
6333 not it is combined with Meta. */
6334 if (modifiers & dpyinfo->meta_mod_mask)
6335 bzero (&compose_status, sizeof (compose_status));
6337 #ifdef HAVE_X_I18N
6338 if (FRAME_XIC (f))
6340 Status status_return;
6342 coding_system = Vlocale_coding_system;
6343 nbytes = XmbLookupString (FRAME_XIC (f),
6344 &event.xkey, copy_bufptr,
6345 copy_bufsiz, &keysym,
6346 &status_return);
6347 if (status_return == XBufferOverflow)
6349 copy_bufsiz = nbytes + 1;
6350 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6351 nbytes = XmbLookupString (FRAME_XIC (f),
6352 &event.xkey, copy_bufptr,
6353 copy_bufsiz, &keysym,
6354 &status_return);
6356 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6357 #if 0 && defined X_HAVE_UTF8_STRING
6358 else if (status_return == XLookupKeySym)
6359 { /* Try again but with utf-8. */
6360 coding_system = Qutf_8;
6361 nbytes = Xutf8LookupString (FRAME_XIC (f),
6362 &event.xkey, copy_bufptr,
6363 copy_bufsiz, &keysym,
6364 &status_return);
6365 if (status_return == XBufferOverflow)
6367 copy_bufsiz = nbytes + 1;
6368 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6369 nbytes = Xutf8LookupString (FRAME_XIC (f),
6370 &event.xkey,
6371 copy_bufptr,
6372 copy_bufsiz, &keysym,
6373 &status_return);
6376 #endif
6378 if (status_return == XLookupNone)
6379 break;
6380 else if (status_return == XLookupChars)
6382 keysym = NoSymbol;
6383 modifiers = 0;
6385 else if (status_return != XLookupKeySym
6386 && status_return != XLookupBoth)
6387 abort ();
6389 else
6390 nbytes = XLookupString (&event.xkey, copy_bufptr,
6391 copy_bufsiz, &keysym,
6392 &compose_status);
6393 #else
6394 nbytes = XLookupString (&event.xkey, copy_bufptr,
6395 copy_bufsiz, &keysym,
6396 &compose_status);
6397 #endif
6399 /* If not using XIM/XIC, and a compose sequence is in progress,
6400 we break here. Otherwise, chars_matched is always 0. */
6401 if (compose_status.chars_matched > 0 && nbytes == 0)
6402 break;
6404 bzero (&compose_status, sizeof (compose_status));
6405 orig_keysym = keysym;
6407 /* Common for all keysym input events. */
6408 XSETFRAME (inev.ie.frame_or_window, f);
6409 inev.ie.modifiers
6410 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6411 inev.ie.timestamp = event.xkey.time;
6413 /* First deal with keysyms which have defined
6414 translations to characters. */
6415 if (keysym >= 32 && keysym < 128)
6416 /* Avoid explicitly decoding each ASCII character. */
6418 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6419 inev.ie.code = keysym;
6420 goto done_keysym;
6423 /* Keysyms directly mapped to Unicode characters. */
6424 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6426 if (keysym < 0x01000080)
6427 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6428 else
6429 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6430 inev.ie.code = keysym & 0xFFFFFF;
6431 goto done_keysym;
6434 /* Now non-ASCII. */
6435 if (HASH_TABLE_P (Vx_keysym_table)
6436 && (NATNUMP (c = Fgethash (make_number (keysym),
6437 Vx_keysym_table,
6438 Qnil))))
6440 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6441 ? ASCII_KEYSTROKE_EVENT
6442 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6443 inev.ie.code = XFASTINT (c);
6444 goto done_keysym;
6447 /* Random non-modifier sorts of keysyms. */
6448 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6449 || keysym == XK_Delete
6450 #ifdef XK_ISO_Left_Tab
6451 || (keysym >= XK_ISO_Left_Tab
6452 && keysym <= XK_ISO_Enter)
6453 #endif
6454 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6455 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6456 #ifdef HPUX
6457 /* This recognizes the "extended function
6458 keys". It seems there's no cleaner way.
6459 Test IsModifierKey to avoid handling
6460 mode_switch incorrectly. */
6461 || ((unsigned) (keysym) >= XK_Select
6462 && (unsigned)(keysym) < XK_KP_Space)
6463 #endif
6464 #ifdef XK_dead_circumflex
6465 || orig_keysym == XK_dead_circumflex
6466 #endif
6467 #ifdef XK_dead_grave
6468 || orig_keysym == XK_dead_grave
6469 #endif
6470 #ifdef XK_dead_tilde
6471 || orig_keysym == XK_dead_tilde
6472 #endif
6473 #ifdef XK_dead_diaeresis
6474 || orig_keysym == XK_dead_diaeresis
6475 #endif
6476 #ifdef XK_dead_macron
6477 || orig_keysym == XK_dead_macron
6478 #endif
6479 #ifdef XK_dead_degree
6480 || orig_keysym == XK_dead_degree
6481 #endif
6482 #ifdef XK_dead_acute
6483 || orig_keysym == XK_dead_acute
6484 #endif
6485 #ifdef XK_dead_cedilla
6486 || orig_keysym == XK_dead_cedilla
6487 #endif
6488 #ifdef XK_dead_breve
6489 || orig_keysym == XK_dead_breve
6490 #endif
6491 #ifdef XK_dead_ogonek
6492 || orig_keysym == XK_dead_ogonek
6493 #endif
6494 #ifdef XK_dead_caron
6495 || orig_keysym == XK_dead_caron
6496 #endif
6497 #ifdef XK_dead_doubleacute
6498 || orig_keysym == XK_dead_doubleacute
6499 #endif
6500 #ifdef XK_dead_abovedot
6501 || orig_keysym == XK_dead_abovedot
6502 #endif
6503 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6504 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6505 /* Any "vendor-specific" key is ok. */
6506 || (orig_keysym & (1 << 28))
6507 || (keysym != NoSymbol && nbytes == 0))
6508 && ! (IsModifierKey (orig_keysym)
6509 /* The symbols from XK_ISO_Lock
6510 to XK_ISO_Last_Group_Lock
6511 don't have real modifiers but
6512 should be treated similarly to
6513 Mode_switch by Emacs. */
6514 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6515 || ((unsigned)(orig_keysym)
6516 >= XK_ISO_Lock
6517 && (unsigned)(orig_keysym)
6518 <= XK_ISO_Last_Group_Lock)
6519 #endif
6522 STORE_KEYSYM_FOR_DEBUG (keysym);
6523 /* make_lispy_event will convert this to a symbolic
6524 key. */
6525 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6526 inev.ie.code = keysym;
6527 goto done_keysym;
6530 { /* Raw bytes, not keysym. */
6531 register int i;
6532 register int c;
6533 int nchars, len;
6535 for (i = 0, nchars = 0; i < nbytes; i++)
6537 if (ASCII_BYTE_P (copy_bufptr[i]))
6538 nchars++;
6539 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6542 if (nchars < nbytes)
6544 /* Decode the input data. */
6545 int require;
6546 unsigned char *p;
6548 /* The input should be decoded with `coding_system'
6549 which depends on which X*LookupString function
6550 we used just above and the locale. */
6551 setup_coding_system (coding_system, &coding);
6552 coding.src_multibyte = 0;
6553 coding.dst_multibyte = 1;
6554 /* The input is converted to events, thus we can't
6555 handle composition. Anyway, there's no XIM that
6556 gives us composition information. */
6557 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6559 require = MAX_MULTIBYTE_LENGTH * nbytes;
6560 coding.destination = alloca (require);
6561 coding.dst_bytes = require;
6562 coding.mode |= CODING_MODE_LAST_BLOCK;
6563 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6564 nbytes = coding.produced;
6565 nchars = coding.produced_char;
6566 copy_bufptr = coding.destination;
6569 /* Convert the input data to a sequence of
6570 character events. */
6571 for (i = 0; i < nbytes; i += len)
6573 if (nchars == nbytes)
6574 c = copy_bufptr[i], len = 1;
6575 else
6576 c = STRING_CHAR_AND_LENGTH (copy_bufptr + i,
6577 nbytes - i, len);
6578 inev.ie.kind = (SINGLE_BYTE_CHAR_P (c)
6579 ? ASCII_KEYSTROKE_EVENT
6580 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6581 inev.ie.code = c;
6582 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6585 count += nchars;
6587 inev.ie.kind = NO_EVENT; /* Already stored above. */
6589 if (keysym == NoSymbol)
6590 break;
6593 done_keysym:
6594 #ifdef HAVE_X_I18N
6595 /* Don't dispatch this event since XtDispatchEvent calls
6596 XFilterEvent, and two calls in a row may freeze the
6597 client. */
6598 break;
6599 #else
6600 goto OTHER;
6601 #endif
6603 case KeyRelease:
6604 last_user_time = event.xkey.time;
6605 #ifdef HAVE_X_I18N
6606 /* Don't dispatch this event since XtDispatchEvent calls
6607 XFilterEvent, and two calls in a row may freeze the
6608 client. */
6609 break;
6610 #else
6611 goto OTHER;
6612 #endif
6614 case EnterNotify:
6615 last_user_time = event.xcrossing.time;
6616 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6618 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6620 if (f && x_mouse_click_focus_ignore_position)
6621 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6623 #if 0
6624 if (event.xcrossing.focus)
6626 /* Avoid nasty pop/raise loops. */
6627 if (f && (!(f->auto_raise)
6628 || !(f->auto_lower)
6629 || (event.xcrossing.time - enter_timestamp) > 500))
6631 x_new_focus_frame (dpyinfo, f);
6632 enter_timestamp = event.xcrossing.time;
6635 else if (f == dpyinfo->x_focus_frame)
6636 x_new_focus_frame (dpyinfo, 0);
6637 #endif
6639 /* EnterNotify counts as mouse movement,
6640 so update things that depend on mouse position. */
6641 if (f && !f->output_data.x->hourglass_p)
6642 note_mouse_movement (f, &event.xmotion);
6643 #ifdef USE_GTK
6644 /* We may get an EnterNotify on the buttons in the toolbar. In that
6645 case we moved out of any highlighted area and need to note this. */
6646 if (!f && last_mouse_glyph_frame)
6647 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6648 #endif
6649 goto OTHER;
6651 case FocusIn:
6652 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6653 goto OTHER;
6655 case LeaveNotify:
6656 last_user_time = event.xcrossing.time;
6657 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6659 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6660 if (f)
6662 if (f == dpyinfo->mouse_face_mouse_frame)
6664 /* If we move outside the frame, then we're
6665 certainly no longer on any text in the frame. */
6666 clear_mouse_face (dpyinfo);
6667 dpyinfo->mouse_face_mouse_frame = 0;
6670 /* Generate a nil HELP_EVENT to cancel a help-echo.
6671 Do it only if there's something to cancel.
6672 Otherwise, the startup message is cleared when
6673 the mouse leaves the frame. */
6674 if (any_help_event_p)
6675 do_help = -1;
6677 #ifdef USE_GTK
6678 /* See comment in EnterNotify above */
6679 else if (last_mouse_glyph_frame)
6680 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6681 #endif
6682 goto OTHER;
6684 case FocusOut:
6685 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6686 goto OTHER;
6688 case MotionNotify:
6690 last_user_time = event.xmotion.time;
6691 previous_help_echo_string = help_echo_string;
6692 help_echo_string = Qnil;
6694 if (dpyinfo->grabbed && last_mouse_frame
6695 && FRAME_LIVE_P (last_mouse_frame))
6696 f = last_mouse_frame;
6697 else
6698 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6700 if (dpyinfo->mouse_face_hidden)
6702 dpyinfo->mouse_face_hidden = 0;
6703 clear_mouse_face (dpyinfo);
6706 if (f)
6709 /* Generate SELECT_WINDOW_EVENTs when needed. */
6710 if (!NILP (Vmouse_autoselect_window))
6712 Lisp_Object window;
6714 window = window_from_coordinates (f,
6715 event.xmotion.x, event.xmotion.y,
6716 0, 0, 0, 0);
6718 /* Window will be selected only when it is not selected now and
6719 last mouse movement event was not in it. Minibuffer window
6720 will be selected only when it is active. */
6721 if (WINDOWP (window)
6722 && !EQ (window, last_window)
6723 && !EQ (window, selected_window)
6724 /* For click-to-focus window managers
6725 create event iff we don't leave the
6726 selected frame. */
6727 && (focus_follows_mouse
6728 || (EQ (XWINDOW (window)->frame,
6729 XWINDOW (selected_window)->frame))))
6731 inev.ie.kind = SELECT_WINDOW_EVENT;
6732 inev.ie.frame_or_window = window;
6735 last_window=window;
6737 if (!note_mouse_movement (f, &event.xmotion))
6738 help_echo_string = previous_help_echo_string;
6740 else
6742 #ifndef USE_TOOLKIT_SCROLL_BARS
6743 struct scroll_bar *bar
6744 = x_window_to_scroll_bar (event.xmotion.display,
6745 event.xmotion.window);
6747 if (bar)
6748 x_scroll_bar_note_movement (bar, &event);
6749 #endif /* USE_TOOLKIT_SCROLL_BARS */
6751 /* If we move outside the frame, then we're
6752 certainly no longer on any text in the frame. */
6753 clear_mouse_face (dpyinfo);
6756 /* If the contents of the global variable help_echo_string
6757 has changed, generate a HELP_EVENT. */
6758 if (!NILP (help_echo_string)
6759 || !NILP (previous_help_echo_string))
6760 do_help = 1;
6761 goto OTHER;
6764 case ConfigureNotify:
6765 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6766 #ifdef USE_GTK
6767 if (!f
6768 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6769 && event.xconfigure.window == FRAME_X_WINDOW (f))
6771 xg_frame_resized (f, event.xconfigure.width,
6772 event.xconfigure.height);
6773 f = 0;
6775 #endif
6776 if (f)
6778 #ifndef USE_X_TOOLKIT
6779 #ifndef USE_GTK
6780 /* If there is a pending resize for fullscreen, don't
6781 do this one, the right one will come later.
6782 The toolkit version doesn't seem to need this, but we
6783 need to reset it below. */
6784 int dont_resize
6785 = ((f->want_fullscreen & FULLSCREEN_WAIT)
6786 && f->new_text_cols != 0);
6787 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6788 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6790 if (dont_resize)
6791 goto OTHER;
6793 /* In the toolkit version, change_frame_size
6794 is called by the code that handles resizing
6795 of the EmacsFrame widget. */
6797 /* Even if the number of character rows and columns has
6798 not changed, the font size may have changed, so we need
6799 to check the pixel dimensions as well. */
6800 if (columns != FRAME_COLS (f)
6801 || rows != FRAME_LINES (f)
6802 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6803 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6805 change_frame_size (f, rows, columns, 0, 1, 0);
6806 SET_FRAME_GARBAGED (f);
6807 cancel_mouse_face (f);
6810 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6811 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6812 #endif /* not USE_GTK */
6813 #endif
6815 #ifdef USE_GTK
6816 /* GTK creates windows but doesn't map them.
6817 Only get real positions and check fullscreen when mapped. */
6818 if (FRAME_GTK_OUTER_WIDGET (f)
6819 && GTK_WIDGET_MAPPED (FRAME_GTK_OUTER_WIDGET (f)))
6820 #endif
6822 x_real_positions (f, &f->left_pos, &f->top_pos);
6824 if (f->want_fullscreen & FULLSCREEN_WAIT)
6825 f->want_fullscreen &= ~(FULLSCREEN_WAIT|FULLSCREEN_BOTH);
6828 #ifdef HAVE_X_I18N
6829 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6830 xic_set_statusarea (f);
6831 #endif
6833 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
6835 /* Since the WM decorations come below top_pos now,
6836 we must put them below top_pos in the future. */
6837 f->win_gravity = NorthWestGravity;
6838 x_wm_set_size_hint (f, (long) 0, 0);
6841 goto OTHER;
6843 case ButtonRelease:
6844 case ButtonPress:
6846 /* If we decide we want to generate an event to be seen
6847 by the rest of Emacs, we put it here. */
6848 int tool_bar_p = 0;
6850 bzero (&compose_status, sizeof (compose_status));
6851 last_mouse_glyph_frame = 0;
6852 last_user_time = event.xbutton.time;
6854 if (dpyinfo->grabbed
6855 && last_mouse_frame
6856 && FRAME_LIVE_P (last_mouse_frame))
6857 f = last_mouse_frame;
6858 else
6859 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6861 if (f)
6863 /* Is this in the tool-bar? */
6864 if (WINDOWP (f->tool_bar_window)
6865 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6867 Lisp_Object window;
6868 int x = event.xbutton.x;
6869 int y = event.xbutton.y;
6871 window = window_from_coordinates (f, x, y, 0, 0, 0, 1);
6872 tool_bar_p = EQ (window, f->tool_bar_window);
6874 if (tool_bar_p && event.xbutton.button < 4)
6876 handle_tool_bar_click (f, x, y,
6877 event.xbutton.type == ButtonPress,
6878 x_x_to_emacs_modifiers (dpyinfo,
6879 event.xbutton.state));
6883 if (!tool_bar_p)
6884 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6885 if (! popup_activated ())
6886 #endif
6888 if (ignore_next_mouse_click_timeout)
6890 if (event.type == ButtonPress
6891 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6893 ignore_next_mouse_click_timeout = 0;
6894 construct_mouse_click (&inev.ie, &event.xbutton, f);
6896 if (event.type == ButtonRelease)
6897 ignore_next_mouse_click_timeout = 0;
6899 else
6900 construct_mouse_click (&inev.ie, &event.xbutton, f);
6902 if (FRAME_X_EMBEDDED_P (f))
6903 xembed_send_message (f, event.xbutton.time,
6904 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6906 else
6908 struct scroll_bar *bar
6909 = x_window_to_scroll_bar (event.xbutton.display,
6910 event.xbutton.window);
6912 #ifdef USE_TOOLKIT_SCROLL_BARS
6913 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6914 scroll bars. */
6915 if (bar && event.xbutton.state & ControlMask)
6917 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6918 *finish = X_EVENT_DROP;
6920 #else /* not USE_TOOLKIT_SCROLL_BARS */
6921 if (bar)
6922 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6923 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6926 if (event.type == ButtonPress)
6928 dpyinfo->grabbed |= (1 << event.xbutton.button);
6929 last_mouse_frame = f;
6931 if (!tool_bar_p)
6932 last_tool_bar_item = -1;
6934 else
6935 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6937 /* Ignore any mouse motion that happened before this event;
6938 any subsequent mouse-movement Emacs events should reflect
6939 only motion after the ButtonPress/Release. */
6940 if (f != 0)
6941 f->mouse_moved = 0;
6943 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6944 f = x_menubar_window_to_frame (dpyinfo, event.xbutton.window);
6945 /* For a down-event in the menu bar,
6946 don't pass it to Xt right now.
6947 Instead, save it away
6948 and we will pass it to Xt from kbd_buffer_get_event.
6949 That way, we can run some Lisp code first. */
6950 if (
6951 #ifdef USE_GTK
6952 ! popup_activated ()
6953 /* Gtk+ menus only react to the first three buttons. */
6954 && event.xbutton.button < 3
6956 #endif
6957 f && event.type == ButtonPress
6958 /* Verify the event is really within the menu bar
6959 and not just sent to it due to grabbing. */
6960 && event.xbutton.x >= 0
6961 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6962 && event.xbutton.y >= 0
6963 && event.xbutton.y < f->output_data.x->menubar_height
6964 && event.xbutton.same_screen)
6966 SET_SAVED_BUTTON_EVENT;
6967 XSETFRAME (last_mouse_press_frame, f);
6968 #ifdef USE_GTK
6969 *finish = X_EVENT_DROP;
6970 #endif
6972 else if (event.type == ButtonPress)
6974 last_mouse_press_frame = Qnil;
6975 goto OTHER;
6978 #ifdef USE_MOTIF /* This should do not harm for Lucid,
6979 but I am trying to be cautious. */
6980 else if (event.type == ButtonRelease)
6982 if (!NILP (last_mouse_press_frame))
6984 f = XFRAME (last_mouse_press_frame);
6985 if (f->output_data.x)
6986 SET_SAVED_BUTTON_EVENT;
6988 else
6989 goto OTHER;
6991 #endif /* USE_MOTIF */
6992 else
6993 goto OTHER;
6994 #endif /* USE_X_TOOLKIT || USE_GTK */
6996 break;
6998 case CirculateNotify:
6999 goto OTHER;
7001 case CirculateRequest:
7002 goto OTHER;
7004 case VisibilityNotify:
7005 goto OTHER;
7007 case MappingNotify:
7008 /* Someone has changed the keyboard mapping - update the
7009 local cache. */
7010 switch (event.xmapping.request)
7012 case MappingModifier:
7013 x_find_modifier_meanings (dpyinfo);
7014 /* This is meant to fall through. */
7015 case MappingKeyboard:
7016 XRefreshKeyboardMapping (&event.xmapping);
7018 goto OTHER;
7020 default:
7021 OTHER:
7022 #ifdef USE_X_TOOLKIT
7023 BLOCK_INPUT;
7024 if (*finish != X_EVENT_DROP)
7025 XtDispatchEvent (&event);
7026 UNBLOCK_INPUT;
7027 #endif /* USE_X_TOOLKIT */
7028 break;
7031 done:
7032 if (inev.ie.kind != NO_EVENT)
7034 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
7035 count++;
7038 if (do_help
7039 && !(hold_quit && hold_quit->kind != NO_EVENT))
7041 Lisp_Object frame;
7043 if (f)
7044 XSETFRAME (frame, f);
7045 else
7046 frame = Qnil;
7048 if (do_help > 0)
7050 any_help_event_p = 1;
7051 gen_help_event (help_echo_string, frame, help_echo_window,
7052 help_echo_object, help_echo_pos);
7054 else
7056 help_echo_string = Qnil;
7057 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
7059 count++;
7062 *eventp = event;
7063 return count;
7067 /* Handles the XEvent EVENT on display DISPLAY.
7068 This is used for event loops outside the normal event handling,
7069 i.e. looping while a popup menu or a dialog is posted.
7071 Returns the value handle_one_xevent sets in the finish argument. */
7073 x_dispatch_event (event, display)
7074 XEvent *event;
7075 Display *display;
7077 struct x_display_info *dpyinfo;
7078 int finish = X_EVENT_NORMAL;
7080 dpyinfo = x_display_info_for_display (display);
7082 if (dpyinfo)
7083 handle_one_xevent (dpyinfo, event, &finish, 0);
7085 return finish;
7089 /* Read events coming from the X server.
7090 This routine is called by the SIGIO handler.
7091 We return as soon as there are no more events to be read.
7093 We return the number of characters stored into the buffer,
7094 thus pretending to be `read' (except the characters we store
7095 in the keyboard buffer can be multibyte, so are not necessarily
7096 C chars).
7098 EXPECTED is nonzero if the caller knows input is available. */
7100 static int
7101 XTread_socket (terminal, expected, hold_quit)
7102 struct terminal *terminal;
7103 int expected;
7104 struct input_event *hold_quit;
7106 int count = 0;
7107 XEvent event;
7108 int event_found = 0;
7109 #if 0
7110 struct x_display_info *dpyinfo;
7111 #endif
7113 if (interrupt_input_blocked)
7115 interrupt_input_pending = 1;
7116 return -1;
7119 interrupt_input_pending = 0;
7120 BLOCK_INPUT;
7122 /* So people can tell when we have read the available input. */
7123 input_signal_count++;
7125 ++handling_signal;
7127 #ifdef HAVE_X_SM
7128 /* Only check session manager input for the primary display. */
7129 if (terminal->id == 1 && x_session_have_connection ())
7131 struct input_event inev;
7132 BLOCK_INPUT;
7133 /* We don't need to EVENT_INIT (inev) here, as
7134 x_session_check_input copies an entire input_event. */
7135 if (x_session_check_input (&inev))
7137 kbd_buffer_store_event_hold (&inev, hold_quit);
7138 count++;
7140 UNBLOCK_INPUT;
7142 #endif
7144 /* For debugging, this gives a way to fake an I/O error. */
7145 if (terminal->display_info.x == XTread_socket_fake_io_error)
7147 XTread_socket_fake_io_error = 0;
7148 x_io_error_quitter (terminal->display_info.x->display);
7151 #if 0 /* This loop is a noop now. */
7152 /* Find the display we are supposed to read input for.
7153 It's the one communicating on descriptor SD. */
7154 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
7156 #if 0 /* This ought to be unnecessary; let's verify it. */
7157 #ifdef FIOSNBIO
7158 /* If available, Xlib uses FIOSNBIO to make the socket
7159 non-blocking, and then looks for EWOULDBLOCK. If O_NDELAY is set,
7160 FIOSNBIO is ignored, and instead of signaling EWOULDBLOCK,
7161 a read returns 0, which Xlib interprets as equivalent to EPIPE. */
7162 fcntl (dpyinfo->connection, F_SETFL, 0);
7163 #endif /* ! defined (FIOSNBIO) */
7164 #endif
7166 #if 0 /* This code can't be made to work, with multiple displays,
7167 and appears not to be used on any system any more.
7168 Also keyboard.c doesn't turn O_NDELAY on and off
7169 for X connections. */
7170 #ifndef SIGIO
7171 #ifndef HAVE_SELECT
7172 if (! (fcntl (dpyinfo->connection, F_GETFL, 0) & O_NDELAY))
7174 extern int read_alarm_should_throw;
7175 read_alarm_should_throw = 1;
7176 XPeekEvent (dpyinfo->display, &event);
7177 read_alarm_should_throw = 0;
7179 #endif /* HAVE_SELECT */
7180 #endif /* SIGIO */
7181 #endif
7183 #endif
7185 #ifndef USE_GTK
7186 while (XPending (terminal->display_info.x->display))
7188 int finish;
7190 XNextEvent (terminal->display_info.x->display, &event);
7192 #ifdef HAVE_X_I18N
7193 /* Filter events for the current X input method. */
7194 if (x_filter_event (terminal->display_info.x, &event))
7195 break;
7196 #endif
7197 event_found = 1;
7199 count += handle_one_xevent (terminal->display_info.x,
7200 &event, &finish, hold_quit);
7202 if (finish == X_EVENT_GOTO_OUT)
7203 goto out;
7206 #else /* USE_GTK */
7208 /* For GTK we must use the GTK event loop. But XEvents gets passed
7209 to our filter function above, and then to the big event switch.
7210 We use a bunch of globals to communicate with our filter function,
7211 that is kind of ugly, but it works.
7213 There is no way to do one display at the time, GTK just does events
7214 from all displays. */
7216 while (gtk_events_pending ())
7218 current_count = count;
7219 current_hold_quit = hold_quit;
7221 gtk_main_iteration ();
7223 count = current_count;
7224 current_count = -1;
7225 current_hold_quit = 0;
7227 if (current_finish == X_EVENT_GOTO_OUT)
7228 break;
7230 #endif /* USE_GTK */
7232 out:;
7234 /* On some systems, an X bug causes Emacs to get no more events
7235 when the window is destroyed. Detect that. (1994.) */
7236 if (! event_found)
7238 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7239 One XNOOP in 100 loops will make Emacs terminate.
7240 B. Bretthauer, 1994 */
7241 x_noop_count++;
7242 if (x_noop_count >= 100)
7244 x_noop_count=0;
7246 if (next_noop_dpyinfo == 0)
7247 next_noop_dpyinfo = x_display_list;
7249 XNoOp (next_noop_dpyinfo->display);
7251 /* Each time we get here, cycle through the displays now open. */
7252 next_noop_dpyinfo = next_noop_dpyinfo->next;
7256 /* If the focus was just given to an auto-raising frame,
7257 raise it now. */
7258 /* ??? This ought to be able to handle more than one such frame. */
7259 if (pending_autoraise_frame)
7261 x_raise_frame (pending_autoraise_frame);
7262 pending_autoraise_frame = 0;
7265 --handling_signal;
7266 UNBLOCK_INPUT;
7268 return count;
7274 /***********************************************************************
7275 Text Cursor
7276 ***********************************************************************/
7278 /* Set clipping for output in glyph row ROW. W is the window in which
7279 we operate. GC is the graphics context to set clipping in.
7281 ROW may be a text row or, e.g., a mode line. Text rows must be
7282 clipped to the interior of the window dedicated to text display,
7283 mode lines must be clipped to the whole window. */
7285 static void
7286 x_clip_to_row (w, row, area, gc)
7287 struct window *w;
7288 struct glyph_row *row;
7289 int area;
7290 GC gc;
7292 struct frame *f = XFRAME (WINDOW_FRAME (w));
7293 XRectangle clip_rect;
7294 int window_x, window_y, window_width;
7296 window_box (w, area, &window_x, &window_y, &window_width, 0);
7298 clip_rect.x = window_x;
7299 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7300 clip_rect.y = max (clip_rect.y, window_y);
7301 clip_rect.width = window_width;
7302 clip_rect.height = row->visible_height;
7304 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7308 /* Draw a hollow box cursor on window W in glyph row ROW. */
7310 static void
7311 x_draw_hollow_cursor (w, row)
7312 struct window *w;
7313 struct glyph_row *row;
7315 struct frame *f = XFRAME (WINDOW_FRAME (w));
7316 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7317 Display *dpy = FRAME_X_DISPLAY (f);
7318 int x, y, wd, h;
7319 XGCValues xgcv;
7320 struct glyph *cursor_glyph;
7321 GC gc;
7323 /* Get the glyph the cursor is on. If we can't tell because
7324 the current matrix is invalid or such, give up. */
7325 cursor_glyph = get_phys_cursor_glyph (w);
7326 if (cursor_glyph == NULL)
7327 return;
7329 /* Compute frame-relative coordinates for phys cursor. */
7330 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7331 wd = w->phys_cursor_width;
7333 /* The foreground of cursor_gc is typically the same as the normal
7334 background color, which can cause the cursor box to be invisible. */
7335 xgcv.foreground = f->output_data.x->cursor_pixel;
7336 if (dpyinfo->scratch_cursor_gc)
7337 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7338 else
7339 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7340 GCForeground, &xgcv);
7341 gc = dpyinfo->scratch_cursor_gc;
7343 /* Set clipping, draw the rectangle, and reset clipping again. */
7344 x_clip_to_row (w, row, TEXT_AREA, gc);
7345 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7346 XSetClipMask (dpy, gc, None);
7350 /* Draw a bar cursor on window W in glyph row ROW.
7352 Implementation note: One would like to draw a bar cursor with an
7353 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7354 Unfortunately, I didn't find a font yet that has this property set.
7355 --gerd. */
7357 static void
7358 x_draw_bar_cursor (w, row, width, kind)
7359 struct window *w;
7360 struct glyph_row *row;
7361 int width;
7362 enum text_cursor_kinds kind;
7364 struct frame *f = XFRAME (w->frame);
7365 struct glyph *cursor_glyph;
7367 /* If cursor is out of bounds, don't draw garbage. This can happen
7368 in mini-buffer windows when switching between echo area glyphs
7369 and mini-buffer. */
7370 cursor_glyph = get_phys_cursor_glyph (w);
7371 if (cursor_glyph == NULL)
7372 return;
7374 /* If on an image, draw like a normal cursor. That's usually better
7375 visible than drawing a bar, esp. if the image is large so that
7376 the bar might not be in the window. */
7377 if (cursor_glyph->type == IMAGE_GLYPH)
7379 struct glyph_row *row;
7380 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7381 draw_phys_cursor_glyph (w, row, DRAW_CURSOR);
7383 else
7385 Display *dpy = FRAME_X_DISPLAY (f);
7386 Window window = FRAME_X_WINDOW (f);
7387 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7388 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7389 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7390 XGCValues xgcv;
7392 /* If the glyph's background equals the color we normally draw
7393 the bar cursor in, the bar cursor in its normal color is
7394 invisible. Use the glyph's foreground color instead in this
7395 case, on the assumption that the glyph's colors are chosen so
7396 that the glyph is legible. */
7397 if (face->background == f->output_data.x->cursor_pixel)
7398 xgcv.background = xgcv.foreground = face->foreground;
7399 else
7400 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7401 xgcv.graphics_exposures = 0;
7403 if (gc)
7404 XChangeGC (dpy, gc, mask, &xgcv);
7405 else
7407 gc = XCreateGC (dpy, window, mask, &xgcv);
7408 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7411 if (width < 0)
7412 width = FRAME_CURSOR_WIDTH (f);
7413 width = min (cursor_glyph->pixel_width, width);
7415 w->phys_cursor_width = width;
7416 x_clip_to_row (w, row, TEXT_AREA, gc);
7418 if (kind == BAR_CURSOR)
7419 XFillRectangle (dpy, window, gc,
7420 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7421 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7422 width, row->height);
7423 else
7424 XFillRectangle (dpy, window, gc,
7425 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7426 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7427 row->height - width),
7428 cursor_glyph->pixel_width,
7429 width);
7431 XSetClipMask (dpy, gc, None);
7436 /* RIF: Define cursor CURSOR on frame F. */
7438 static void
7439 x_define_frame_cursor (f, cursor)
7440 struct frame *f;
7441 Cursor cursor;
7443 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), 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);
7459 /* RIF: Draw cursor on window W. */
7461 static void
7462 x_draw_window_cursor (w, glyph_row, x, y, cursor_type, cursor_width, on_p, active_p)
7463 struct window *w;
7464 struct glyph_row *glyph_row;
7465 int x, y;
7466 int cursor_type, cursor_width;
7467 int on_p, active_p;
7469 struct frame *f = XFRAME (WINDOW_FRAME (w));
7471 if (on_p)
7473 w->phys_cursor_type = cursor_type;
7474 w->phys_cursor_on_p = 1;
7476 if (glyph_row->exact_window_width_line_p
7477 && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
7479 glyph_row->cursor_in_fringe_p = 1;
7480 draw_fringe_bitmap (w, glyph_row, 0);
7482 else
7483 switch (cursor_type)
7485 case HOLLOW_BOX_CURSOR:
7486 x_draw_hollow_cursor (w, glyph_row);
7487 break;
7489 case FILLED_BOX_CURSOR:
7490 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7491 break;
7493 case BAR_CURSOR:
7494 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7495 break;
7497 case HBAR_CURSOR:
7498 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7499 break;
7501 case NO_CURSOR:
7502 w->phys_cursor_width = 0;
7503 break;
7505 default:
7506 abort ();
7509 #ifdef HAVE_X_I18N
7510 if (w == XWINDOW (f->selected_window))
7511 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7512 xic_set_preeditarea (w, x, y);
7513 #endif
7516 #ifndef XFlush
7517 XFlush (FRAME_X_DISPLAY (f));
7518 #endif
7522 /* Icons. */
7524 /* Make the x-window of frame F use the gnu icon bitmap. */
7527 x_bitmap_icon (f, file)
7528 struct frame *f;
7529 Lisp_Object file;
7531 int bitmap_id;
7533 if (FRAME_X_WINDOW (f) == 0)
7534 return 1;
7536 /* Free up our existing icon bitmap and mask if any. */
7537 if (f->output_data.x->icon_bitmap > 0)
7538 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7539 f->output_data.x->icon_bitmap = 0;
7541 if (STRINGP (file))
7543 #ifdef USE_GTK
7544 /* Use gtk_window_set_icon_from_file () if available,
7545 It's not restricted to bitmaps */
7546 if (xg_set_icon (f, file))
7547 return 0;
7548 #endif /* USE_GTK */
7549 bitmap_id = x_create_bitmap_from_file (f, file);
7550 x_create_bitmap_mask (f, bitmap_id);
7552 else
7554 /* Create the GNU bitmap and mask if necessary. */
7555 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7557 int rc = -1;
7559 #if defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7560 #ifdef USE_GTK
7561 if (xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7562 return 0;
7563 #else
7564 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7565 if (rc != -1)
7566 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7567 #endif /* USE_GTK */
7568 #endif /* defined (HAVE_XPM) && defined (HAVE_X_WINDOWS) */
7570 /* If all else fails, use the (black and white) xbm image. */
7571 if (rc == -1)
7573 rc = x_create_bitmap_from_data (f, gnu_xbm_bits,
7574 gnu_xbm_width, gnu_xbm_height);
7575 if (rc == -1)
7576 return 1;
7578 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7579 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7583 /* The first time we create the GNU bitmap and mask,
7584 this increments the ref-count one extra time.
7585 As a result, the GNU bitmap and mask are never freed.
7586 That way, we don't have to worry about allocating it again. */
7587 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7589 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7592 x_wm_set_icon_pixmap (f, bitmap_id);
7593 f->output_data.x->icon_bitmap = bitmap_id;
7595 return 0;
7599 /* Make the x-window of frame F use a rectangle with text.
7600 Use ICON_NAME as the text. */
7603 x_text_icon (f, icon_name)
7604 struct frame *f;
7605 char *icon_name;
7607 if (FRAME_X_WINDOW (f) == 0)
7608 return 1;
7611 XTextProperty text;
7612 text.value = (unsigned char *) icon_name;
7613 text.encoding = XA_STRING;
7614 text.format = 8;
7615 text.nitems = strlen (icon_name);
7616 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7619 if (f->output_data.x->icon_bitmap > 0)
7620 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7621 f->output_data.x->icon_bitmap = 0;
7622 x_wm_set_icon_pixmap (f, 0);
7624 return 0;
7627 #define X_ERROR_MESSAGE_SIZE 200
7629 /* If non-nil, this should be a string.
7630 It means catch X errors and store the error message in this string.
7632 The reason we use a stack is that x_catch_error/x_uncatch_error can
7633 be called from a signal handler.
7636 struct x_error_message_stack {
7637 char string[X_ERROR_MESSAGE_SIZE];
7638 Display *dpy;
7639 struct x_error_message_stack *prev;
7641 static struct x_error_message_stack *x_error_message;
7643 /* An X error handler which stores the error message in
7644 *x_error_message. This is called from x_error_handler if
7645 x_catch_errors is in effect. */
7647 static void
7648 x_error_catcher (display, error)
7649 Display *display;
7650 XErrorEvent *error;
7652 XGetErrorText (display, error->error_code,
7653 x_error_message->string,
7654 X_ERROR_MESSAGE_SIZE);
7657 /* Begin trapping X errors for display DPY. Actually we trap X errors
7658 for all displays, but DPY should be the display you are actually
7659 operating on.
7661 After calling this function, X protocol errors no longer cause
7662 Emacs to exit; instead, they are recorded in the string
7663 stored in *x_error_message.
7665 Calling x_check_errors signals an Emacs error if an X error has
7666 occurred since the last call to x_catch_errors or x_check_errors.
7668 Calling x_uncatch_errors resumes the normal error handling. */
7670 void x_check_errors ();
7672 void
7673 x_catch_errors (dpy)
7674 Display *dpy;
7676 struct x_error_message_stack *data = xmalloc (sizeof (*data));
7678 /* Make sure any errors from previous requests have been dealt with. */
7679 XSync (dpy, False);
7681 data->dpy = dpy;
7682 data->string[0] = 0;
7683 data->prev = x_error_message;
7684 x_error_message = data;
7687 /* Undo the last x_catch_errors call.
7688 DPY should be the display that was passed to x_catch_errors. */
7690 void
7691 x_uncatch_errors ()
7693 struct x_error_message_stack *tmp;
7695 BLOCK_INPUT;
7697 /* The display may have been closed before this function is called.
7698 Check if it is still open before calling XSync. */
7699 if (x_display_info_for_display (x_error_message->dpy) != 0)
7700 XSync (x_error_message->dpy, False);
7702 tmp = x_error_message;
7703 x_error_message = x_error_message->prev;
7704 xfree (tmp);
7705 UNBLOCK_INPUT;
7708 /* If any X protocol errors have arrived since the last call to
7709 x_catch_errors or x_check_errors, signal an Emacs error using
7710 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7712 void
7713 x_check_errors (dpy, format)
7714 Display *dpy;
7715 char *format;
7717 /* Make sure to catch any errors incurred so far. */
7718 XSync (dpy, False);
7720 if (x_error_message->string[0])
7722 char string[X_ERROR_MESSAGE_SIZE];
7723 bcopy (x_error_message->string, string, X_ERROR_MESSAGE_SIZE);
7724 x_uncatch_errors ();
7725 error (format, string);
7729 /* Nonzero if we had any X protocol errors
7730 since we did x_catch_errors on DPY. */
7733 x_had_errors_p (dpy)
7734 Display *dpy;
7736 /* Make sure to catch any errors incurred so far. */
7737 XSync (dpy, False);
7739 return x_error_message->string[0] != 0;
7742 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7744 void
7745 x_clear_errors (dpy)
7746 Display *dpy;
7748 x_error_message->string[0] = 0;
7751 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7752 * idea. --lorentey */
7753 /* Close off all unclosed x_catch_errors calls. */
7755 void
7756 x_fully_uncatch_errors ()
7758 while (x_error_message)
7759 x_uncatch_errors ();
7761 #endif
7763 /* Nonzero if x_catch_errors has been done and not yet canceled. */
7766 x_catching_errors ()
7768 return x_error_message != 0;
7771 #if 0
7772 static unsigned int x_wire_count;
7773 x_trace_wire ()
7775 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7777 #endif /* ! 0 */
7780 /* Handle SIGPIPE, which can happen when the connection to a server
7781 simply goes away. SIGPIPE is handled by x_connection_signal.
7782 Don't need to do anything, because the write which caused the
7783 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7784 which will do the appropriate cleanup for us. */
7786 static SIGTYPE
7787 x_connection_signal (signalnum) /* If we don't have an argument, */
7788 int signalnum; /* some compilers complain in signal calls. */
7790 #ifdef USG
7791 /* USG systems forget handlers when they are used;
7792 must reestablish each time */
7793 signal (signalnum, x_connection_signal);
7794 #endif /* USG */
7798 /************************************************************************
7799 Handling X errors
7800 ************************************************************************/
7802 /* Error message passed to x_connection_closed. */
7804 static char *error_msg;
7806 /* Function installed as fatal_error_signal_hook in
7807 x_connection_closed. Print the X error message, and exit normally,
7808 instead of dumping core when XtCloseDisplay fails. */
7810 static void
7811 x_fatal_error_signal ()
7813 fprintf (stderr, "%s\n", error_msg);
7814 exit (70);
7817 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7818 the text of an error message that lead to the connection loss. */
7820 static SIGTYPE
7821 x_connection_closed (dpy, error_message)
7822 Display *dpy;
7823 char *error_message;
7825 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7826 Lisp_Object frame, tail;
7827 int index = SPECPDL_INDEX ();
7829 error_msg = (char *) alloca (strlen (error_message) + 1);
7830 strcpy (error_msg, error_message);
7831 handling_signal = 0;
7833 /* Prevent being called recursively because of an error condition
7834 below. Otherwise, we might end up with printing ``can't find per
7835 display information'' in the recursive call instead of printing
7836 the original message here. */
7837 x_catch_errors (dpy);
7839 /* Inhibit redisplay while frames are being deleted. */
7840 specbind (Qinhibit_redisplay, Qt);
7842 if (dpyinfo)
7844 /* Protect display from being closed when we delete the last
7845 frame on it. */
7846 dpyinfo->reference_count++;
7847 dpyinfo->terminal->reference_count++;
7850 /* First delete frames whose mini-buffers are on frames
7851 that are on the dead display. */
7852 FOR_EACH_FRAME (tail, frame)
7854 Lisp_Object minibuf_frame;
7855 minibuf_frame
7856 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7857 if (FRAME_X_P (XFRAME (frame))
7858 && FRAME_X_P (XFRAME (minibuf_frame))
7859 && ! EQ (frame, minibuf_frame)
7860 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7861 Fdelete_frame (frame, Qnoelisp);
7864 /* Now delete all remaining frames on the dead display.
7865 We are now sure none of these is used as the mini-buffer
7866 for another frame that we need to delete. */
7867 FOR_EACH_FRAME (tail, frame)
7868 if (FRAME_X_P (XFRAME (frame))
7869 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7871 /* Set this to t so that Fdelete_frame won't get confused
7872 trying to find a replacement. */
7873 FRAME_KBOARD (XFRAME (frame))->Vdefault_minibuffer_frame = Qt;
7874 Fdelete_frame (frame, Qnoelisp);
7877 /* We have to close the display to inform Xt that it doesn't
7878 exist anymore. If we don't, Xt will continue to wait for
7879 events from the display. As a consequence, a sequence of
7881 M-x make-frame-on-display RET :1 RET
7882 ...kill the new frame, so that we get an IO error...
7883 M-x make-frame-on-display RET :1 RET
7885 will indefinitely wait in Xt for events for display `:1', opened
7886 in the first call to make-frame-on-display.
7888 Closing the display is reported to lead to a bus error on
7889 OpenWindows in certain situations. I suspect that is a bug
7890 in OpenWindows. I don't know how to circumvent it here. */
7892 if (dpyinfo)
7894 #ifdef USE_X_TOOLKIT
7895 /* If DPYINFO is null, this means we didn't open the display
7896 in the first place, so don't try to close it. */
7898 extern void (*fatal_error_signal_hook) P_ ((void));
7899 fatal_error_signal_hook = x_fatal_error_signal;
7900 XtCloseDisplay (dpy);
7901 fatal_error_signal_hook = NULL;
7903 #endif
7905 #ifdef USE_GTK
7906 /* Due to bugs in some Gtk+ versions, just exit here if this
7907 is the last display/terminal. */
7908 if (terminal_list->next_terminal == NULL)
7910 fprintf (stderr, "%s\n", error_msg);
7911 shut_down_emacs (0, 0, Qnil);
7912 exit (70);
7914 xg_display_close (dpyinfo->display);
7915 #endif
7917 /* Indicate that this display is dead. */
7918 dpyinfo->display = 0;
7920 dpyinfo->reference_count--;
7921 dpyinfo->terminal->reference_count--;
7922 if (dpyinfo->reference_count != 0)
7923 /* We have just closed all frames on this display. */
7924 abort ();
7927 Lisp_Object tmp;
7928 XSETTERMINAL (tmp, dpyinfo->terminal);
7929 Fdelete_terminal (tmp, Qnoelisp);
7933 x_uncatch_errors ();
7935 if (terminal_list == 0)
7937 fprintf (stderr, "%s\n", error_msg);
7938 shut_down_emacs (0, 0, Qnil);
7939 exit (70);
7942 /* Ordinary stack unwind doesn't deal with these. */
7943 #ifdef SIGIO
7944 sigunblock (sigmask (SIGIO));
7945 #endif
7946 sigunblock (sigmask (SIGALRM));
7947 TOTALLY_UNBLOCK_INPUT;
7949 unbind_to (index, Qnil);
7950 clear_waiting_for_input ();
7951 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7952 longjmp), because returning from this function would get us back into
7953 Xlib's code which will directly call `exit'. */
7954 error ("%s", error_msg);
7957 /* We specifically use it before defining it, so that gcc doesn't inline it,
7958 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7959 static void x_error_quitter P_ ((Display *, XErrorEvent *));
7961 /* This is the first-level handler for X protocol errors.
7962 It calls x_error_quitter or x_error_catcher. */
7964 static int
7965 x_error_handler (display, error)
7966 Display *display;
7967 XErrorEvent *error;
7969 if (x_error_message)
7970 x_error_catcher (display, error);
7971 else
7972 x_error_quitter (display, error);
7973 return 0;
7976 /* This is the usual handler for X protocol errors.
7977 It kills all frames on the display that we got the error for.
7978 If that was the only one, it prints an error message and kills Emacs. */
7980 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7982 #if __GNUC__ >= 3 /* On GCC 3.0 we might get a warning. */
7983 #define NO_INLINE __attribute__((noinline))
7984 #else
7985 #define NO_INLINE
7986 #endif
7988 /* Some versions of GNU/Linux define noinline in their headers. */
7990 #ifdef noinline
7991 #undef noinline
7992 #endif
7994 /* On older GCC versions, just putting x_error_quitter
7995 after x_error_handler prevents inlining into the former. */
7997 static void NO_INLINE
7998 x_error_quitter (display, error)
7999 Display *display;
8000 XErrorEvent *error;
8002 char buf[256], buf1[356];
8004 /* Ignore BadName errors. They can happen because of fonts
8005 or colors that are not defined. */
8007 if (error->error_code == BadName)
8008 return;
8010 /* Note that there is no real way portable across R3/R4 to get the
8011 original error handler. */
8013 XGetErrorText (display, error->error_code, buf, sizeof (buf));
8014 sprintf (buf1, "X protocol error: %s on protocol request %d",
8015 buf, error->request_code);
8016 x_connection_closed (display, buf1);
8020 /* This is the handler for X IO errors, always.
8021 It kills all frames on the display that we lost touch with.
8022 If that was the only one, it prints an error message and kills Emacs. */
8024 static int
8025 x_io_error_quitter (display)
8026 Display *display;
8028 char buf[256];
8030 sprintf (buf, "Connection lost to X server `%s'", DisplayString (display));
8031 x_connection_closed (display, buf);
8032 return 0;
8035 /* Changing the font of the frame. */
8037 /* Give frame F the font FONT-OBJECT as its default font. The return
8038 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
8039 frame. If it is negative, generate a new fontset from
8040 FONT-OBJECT. */
8042 Lisp_Object
8043 x_new_font (f, font_object, fontset)
8044 struct frame *f;
8045 Lisp_Object font_object;
8046 int fontset;
8048 struct font *font = XFONT_OBJECT (font_object);
8050 if (fontset < 0)
8051 fontset = fontset_from_font (font_object);
8052 FRAME_FONTSET (f) = fontset;
8053 if (FRAME_FONT (f) == font)
8054 /* This font is already set in frame F. There's nothing more to
8055 do. */
8056 return font_object;
8058 FRAME_FONT (f) = font;
8059 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
8060 FRAME_COLUMN_WIDTH (f) = font->average_width;
8061 FRAME_SPACE_WIDTH (f) = font->space_width;
8062 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
8064 compute_fringe_widths (f, 1);
8066 /* Compute the scroll bar width in character columns. */
8067 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
8069 int wid = FRAME_COLUMN_WIDTH (f);
8070 FRAME_CONFIG_SCROLL_BAR_COLS (f)
8071 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
8073 else
8075 int wid = FRAME_COLUMN_WIDTH (f);
8076 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
8079 if (FRAME_X_WINDOW (f) != 0)
8081 /* Don't change the size of a tip frame; there's no point in
8082 doing it because it's done in Fx_show_tip, and it leads to
8083 problems because the tip frame has no widget. */
8084 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8085 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
8088 #ifdef HAVE_X_I18N
8089 if (FRAME_XIC (f)
8090 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
8092 BLOCK_INPUT;
8093 xic_set_xfontset (f, SDATA (fontset_ascii (fontset)));
8094 UNBLOCK_INPUT;
8096 #endif
8098 return font_object;
8102 /***********************************************************************
8103 X Input Methods
8104 ***********************************************************************/
8106 #ifdef HAVE_X_I18N
8108 #ifdef HAVE_X11R6
8110 /* XIM destroy callback function, which is called whenever the
8111 connection to input method XIM dies. CLIENT_DATA contains a
8112 pointer to the x_display_info structure corresponding to XIM. */
8114 static void
8115 xim_destroy_callback (xim, client_data, call_data)
8116 XIM xim;
8117 XPointer client_data;
8118 XPointer call_data;
8120 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
8121 Lisp_Object frame, tail;
8123 BLOCK_INPUT;
8125 /* No need to call XDestroyIC.. */
8126 FOR_EACH_FRAME (tail, frame)
8128 struct frame *f = XFRAME (frame);
8129 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
8131 FRAME_XIC (f) = NULL;
8132 xic_free_xfontset (f);
8136 /* No need to call XCloseIM. */
8137 dpyinfo->xim = NULL;
8138 XFree (dpyinfo->xim_styles);
8139 UNBLOCK_INPUT;
8142 #endif /* HAVE_X11R6 */
8144 #ifdef HAVE_X11R6
8145 /* This isn't prototyped in OSF 5.0 or 5.1a. */
8146 extern char *XSetIMValues P_ ((XIM, ...));
8147 #endif
8149 /* Open the connection to the XIM server on display DPYINFO.
8150 RESOURCE_NAME is the resource name Emacs uses. */
8152 static void
8153 xim_open_dpy (dpyinfo, resource_name)
8154 struct x_display_info *dpyinfo;
8155 char *resource_name;
8157 XIM xim;
8159 #ifdef HAVE_XIM
8160 if (use_xim)
8162 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8163 EMACS_CLASS);
8164 dpyinfo->xim = xim;
8166 if (xim)
8168 #ifdef HAVE_X11R6
8169 XIMCallback destroy;
8170 #endif
8172 /* Get supported styles and XIM values. */
8173 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8175 #ifdef HAVE_X11R6
8176 destroy.callback = xim_destroy_callback;
8177 destroy.client_data = (XPointer)dpyinfo;
8178 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8179 #endif
8183 else
8184 #endif /* HAVE_XIM */
8185 dpyinfo->xim = NULL;
8189 #ifdef HAVE_X11R6_XIM
8191 struct xim_inst_t
8193 struct x_display_info *dpyinfo;
8194 char *resource_name;
8197 /* XIM instantiate callback function, which is called whenever an XIM
8198 server is available. DISPLAY is the display of the XIM.
8199 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8200 when the callback was registered. */
8202 static void
8203 xim_instantiate_callback (display, client_data, call_data)
8204 Display *display;
8205 XPointer client_data;
8206 XPointer call_data;
8208 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8209 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8211 /* We don't support multiple XIM connections. */
8212 if (dpyinfo->xim)
8213 return;
8215 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8217 /* Create XIC for the existing frames on the same display, as long
8218 as they have no XIC. */
8219 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8221 Lisp_Object tail, frame;
8223 BLOCK_INPUT;
8224 FOR_EACH_FRAME (tail, frame)
8226 struct frame *f = XFRAME (frame);
8228 if (FRAME_X_P (f)
8229 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8230 if (FRAME_XIC (f) == NULL)
8232 create_frame_xic (f);
8233 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8234 xic_set_statusarea (f);
8235 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8237 struct window *w = XWINDOW (f->selected_window);
8238 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8243 UNBLOCK_INPUT;
8247 #endif /* HAVE_X11R6_XIM */
8250 /* Open a connection to the XIM server on display DPYINFO.
8251 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8252 connection only at the first time. On X11R6, open the connection
8253 in the XIM instantiate callback function. */
8255 static void
8256 xim_initialize (dpyinfo, resource_name)
8257 struct x_display_info *dpyinfo;
8258 char *resource_name;
8260 #ifdef HAVE_XIM
8261 if (use_xim)
8263 #ifdef HAVE_X11R6_XIM
8264 struct xim_inst_t *xim_inst;
8265 int len;
8267 dpyinfo->xim = NULL;
8268 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
8269 xim_inst->dpyinfo = dpyinfo;
8270 len = strlen (resource_name);
8271 xim_inst->resource_name = (char *) xmalloc (len + 1);
8272 bcopy (resource_name, xim_inst->resource_name, len + 1);
8273 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8274 resource_name, EMACS_CLASS,
8275 xim_instantiate_callback,
8276 /* This is XPointer in XFree86
8277 but (XPointer *) on Tru64, at
8278 least, hence the configure test. */
8279 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8280 #else /* not HAVE_X11R6_XIM */
8281 dpyinfo->xim = NULL;
8282 xim_open_dpy (dpyinfo, resource_name);
8283 #endif /* not HAVE_X11R6_XIM */
8286 else
8287 #endif /* HAVE_XIM */
8288 dpyinfo->xim = NULL;
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 #endif /* not HAVE_X11R6_XIM */
8307 if (dpyinfo->display)
8308 XCloseIM (dpyinfo->xim);
8309 dpyinfo->xim = NULL;
8310 XFree (dpyinfo->xim_styles);
8312 #endif /* HAVE_XIM */
8315 #endif /* not HAVE_X11R6_XIM */
8319 /* Calculate the absolute position in frame F
8320 from its current recorded position values and gravity. */
8322 void
8323 x_calc_absolute_position (f)
8324 struct frame *f;
8326 int flags = f->size_hint_flags;
8328 /* We have nothing to do if the current position
8329 is already for the top-left corner. */
8330 if (! ((flags & XNegative) || (flags & YNegative)))
8331 return;
8333 /* Treat negative positions as relative to the leftmost bottommost
8334 position that fits on the screen. */
8335 if (flags & XNegative)
8336 f->left_pos = (FRAME_X_DISPLAY_INFO (f)->width
8337 - FRAME_PIXEL_WIDTH (f) + f->left_pos);
8340 int height = FRAME_PIXEL_HEIGHT (f);
8342 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8343 /* Something is fishy here. When using Motif, starting Emacs with
8344 `-g -0-0', the frame appears too low by a few pixels.
8346 This seems to be so because initially, while Emacs is starting,
8347 the column widget's height and the frame's pixel height are
8348 different. The column widget's height is the right one. In
8349 later invocations, when Emacs is up, the frame's pixel height
8350 is right, though.
8352 It's not obvious where the initial small difference comes from.
8353 2000-12-01, gerd. */
8355 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8356 #endif
8358 if (flags & YNegative)
8359 f->top_pos = (FRAME_X_DISPLAY_INFO (f)->height - height + f->top_pos);
8362 /* The left_pos and top_pos
8363 are now relative to the top and left screen edges,
8364 so the flags should correspond. */
8365 f->size_hint_flags &= ~ (XNegative | YNegative);
8368 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8369 to really change the position, and 0 when calling from
8370 x_make_frame_visible (in that case, XOFF and YOFF are the current
8371 position values). It is -1 when calling from x_set_frame_parameters,
8372 which means, do adjust for borders but don't change the gravity. */
8374 void
8375 x_set_offset (f, xoff, yoff, change_gravity)
8376 struct frame *f;
8377 register int xoff, yoff;
8378 int change_gravity;
8380 int modified_top, modified_left;
8382 if (change_gravity > 0)
8384 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8385 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8387 f->top_pos = yoff;
8388 f->left_pos = xoff;
8389 f->size_hint_flags &= ~ (XNegative | YNegative);
8390 if (xoff < 0)
8391 f->size_hint_flags |= XNegative;
8392 if (yoff < 0)
8393 f->size_hint_flags |= YNegative;
8394 f->win_gravity = NorthWestGravity;
8396 x_calc_absolute_position (f);
8398 BLOCK_INPUT;
8399 x_wm_set_size_hint (f, (long) 0, 0);
8401 modified_left = f->left_pos;
8402 modified_top = f->top_pos;
8404 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8406 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8407 than the WM decorations. So we use the calculated offset instead
8408 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8409 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8410 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8413 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8414 modified_left, modified_top);
8416 x_sync_with_move (f, f->left_pos, f->top_pos,
8417 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8418 ? 1 : 0);
8420 /* change_gravity is non-zero when this function is called from Lisp to
8421 programmatically move a frame. In that case, we call
8422 x_check_expected_move to discover if we have a "Type A" or "Type B"
8423 window manager, and, for a "Type A" window manager, adjust the position
8424 of the frame.
8426 We call x_check_expected_move if a programmatic move occurred, and
8427 either the window manager type (A/B) is unknown or it is Type A but we
8428 need to compute the top/left offset adjustment for this frame. */
8430 if (change_gravity != 0 &&
8431 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8432 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8433 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8434 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8435 x_check_expected_move (f, modified_left, modified_top);
8437 UNBLOCK_INPUT;
8440 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8441 on the root window for frame F contains ATOMNAME.
8442 This is how a WM check shall be done according to the Window Manager
8443 Specification/Extended Window Manager Hints at
8444 http://freedesktop.org/wiki/Specifications/wm-spec. */
8446 static int
8447 wm_supports (f, atomname)
8448 struct frame *f;
8449 const char *atomname;
8451 Atom actual_type;
8452 unsigned long actual_size, bytes_remaining;
8453 int i, rc, actual_format;
8454 Atom prop_atom;
8455 Window wmcheck_window;
8456 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8457 Window target_window = dpyinfo->root_window;
8458 long max_len = 65536;
8459 Display *dpy = FRAME_X_DISPLAY (f);
8460 unsigned char *tmp_data = NULL;
8461 Atom target_type = XA_WINDOW;
8462 Atom want_atom;
8464 BLOCK_INPUT;
8466 prop_atom = XInternAtom (dpy, "_NET_SUPPORTING_WM_CHECK", False);
8468 x_catch_errors (dpy);
8469 rc = XGetWindowProperty (dpy, target_window,
8470 prop_atom, 0, max_len, False, target_type,
8471 &actual_type, &actual_format, &actual_size,
8472 &bytes_remaining, &tmp_data);
8474 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8476 if (tmp_data) XFree (tmp_data);
8477 x_uncatch_errors ();
8478 UNBLOCK_INPUT;
8479 return 0;
8482 wmcheck_window = *(Window *) tmp_data;
8483 XFree (tmp_data);
8485 /* Check if window exists. */
8486 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8487 x_sync (f);
8488 if (x_had_errors_p (dpy))
8490 x_uncatch_errors ();
8491 UNBLOCK_INPUT;
8492 return 0;
8495 if (dpyinfo->net_supported_window != wmcheck_window)
8497 /* Window changed, reload atoms */
8498 if (dpyinfo->net_supported_atoms != NULL)
8499 XFree (dpyinfo->net_supported_atoms);
8500 dpyinfo->net_supported_atoms = NULL;
8501 dpyinfo->nr_net_supported_atoms = 0;
8502 dpyinfo->net_supported_window = 0;
8504 target_type = XA_ATOM;
8505 prop_atom = XInternAtom (dpy, "_NET_SUPPORTED", False);
8506 tmp_data = NULL;
8507 rc = XGetWindowProperty (dpy, target_window,
8508 prop_atom, 0, max_len, False, target_type,
8509 &actual_type, &actual_format, &actual_size,
8510 &bytes_remaining, &tmp_data);
8512 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8514 if (tmp_data) XFree (tmp_data);
8515 x_uncatch_errors ();
8516 UNBLOCK_INPUT;
8517 return 0;
8520 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8521 dpyinfo->nr_net_supported_atoms = actual_size;
8522 dpyinfo->net_supported_window = wmcheck_window;
8525 rc = 0;
8526 want_atom = XInternAtom (dpy, atomname, False);
8528 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8529 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8531 x_uncatch_errors ();
8532 UNBLOCK_INPUT;
8534 return rc;
8537 /* Do fullscreen as specified in extended window manager hints */
8539 static int
8540 do_ewmh_fullscreen (f)
8541 struct frame *f;
8543 int have_net_atom = wm_supports (f, "_NET_WM_STATE");
8545 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8546 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8547 if (!have_net_atom)
8548 have_net_atom = wm_supports (f, "_NET_WM_STATE_FULLSCREEN");
8550 if (have_net_atom)
8552 Lisp_Object frame;
8553 const char *atom = "_NET_WM_STATE";
8554 const char *fs = "_NET_WM_STATE_FULLSCREEN";
8555 const char *fw = "_NET_WM_STATE_MAXIMIZED_HORZ";
8556 const char *fh = "_NET_WM_STATE_MAXIMIZED_VERT";
8557 const char *what = NULL;
8559 XSETFRAME (frame, f);
8561 /* If there are _NET_ atoms we assume we have extended window manager
8562 hints. */
8563 switch (f->want_fullscreen)
8565 case FULLSCREEN_BOTH:
8566 what = fs;
8567 break;
8568 case FULLSCREEN_WIDTH:
8569 what = fw;
8570 break;
8571 case FULLSCREEN_HEIGHT:
8572 what = fh;
8573 break;
8576 if (what != NULL && !wm_supports (f, what)) return 0;
8579 Fx_send_client_event (frame, make_number (0), frame,
8580 make_unibyte_string (atom, strlen (atom)),
8581 make_number (32),
8582 Fcons (make_number (0), /* Remove */
8583 Fcons
8584 (make_unibyte_string (fs,
8585 strlen (fs)),
8586 Qnil)));
8587 Fx_send_client_event (frame, make_number (0), frame,
8588 make_unibyte_string (atom, strlen (atom)),
8589 make_number (32),
8590 Fcons (make_number (0), /* Remove */
8591 Fcons
8592 (make_unibyte_string (fh,
8593 strlen (fh)),
8594 Qnil)));
8595 Fx_send_client_event (frame, make_number (0), frame,
8596 make_unibyte_string (atom, strlen (atom)),
8597 make_number (32),
8598 Fcons (make_number (0), /* Remove */
8599 Fcons
8600 (make_unibyte_string (fw,
8601 strlen (fw)),
8602 Qnil)));
8603 f->want_fullscreen = FULLSCREEN_NONE;
8604 if (what != NULL)
8605 Fx_send_client_event (frame, make_number (0), frame,
8606 make_unibyte_string (atom, strlen (atom)),
8607 make_number (32),
8608 Fcons (make_number (1), /* Add */
8609 Fcons
8610 (make_unibyte_string (what,
8611 strlen (what)),
8612 Qnil)));
8615 return have_net_atom;
8618 static void
8619 XTfullscreen_hook (f)
8620 FRAME_PTR f;
8622 if (f->async_visible)
8624 BLOCK_INPUT;
8625 do_ewmh_fullscreen (f);
8626 x_sync (f);
8627 UNBLOCK_INPUT;
8632 /* Check if we need to resize the frame due to a fullscreen request.
8633 If so needed, resize the frame. */
8634 static void
8635 x_check_fullscreen (f)
8636 struct frame *f;
8638 if (f->want_fullscreen & FULLSCREEN_BOTH)
8640 int width, height, ign;
8642 if (do_ewmh_fullscreen (f))
8643 return;
8645 x_real_positions (f, &f->left_pos, &f->top_pos);
8647 x_fullscreen_adjust (f, &width, &height, &ign, &ign);
8649 /* We do not need to move the window, it shall be taken care of
8650 when setting WM manager hints.
8651 If the frame is visible already, the position is checked by
8652 x_check_expected_move. */
8653 if (FRAME_COLS (f) != width || FRAME_LINES (f) != height)
8655 change_frame_size (f, height, width, 0, 1, 0);
8656 SET_FRAME_GARBAGED (f);
8657 cancel_mouse_face (f);
8659 /* Wait for the change of frame size to occur */
8660 f->want_fullscreen |= FULLSCREEN_WAIT;
8665 /* This function is called by x_set_offset to determine whether the window
8666 manager interfered with the positioning of the frame. Type A window
8667 managers position the surrounding window manager decorations a small
8668 amount above and left of the user-supplied position. Type B window
8669 managers position the surrounding window manager decorations at the
8670 user-specified position. If we detect a Type A window manager, we
8671 compensate by moving the window right and down by the proper amount. */
8673 static void
8674 x_check_expected_move (f, expected_left, expected_top)
8675 struct frame *f;
8676 int expected_left;
8677 int expected_top;
8679 int current_left = 0, current_top = 0;
8681 /* x_real_positions returns the left and top offsets of the outermost
8682 window manager window around the frame. */
8684 x_real_positions (f, &current_left, &current_top);
8686 if (current_left != expected_left || current_top != expected_top)
8688 /* It's a "Type A" window manager. */
8690 int adjusted_left;
8691 int adjusted_top;
8693 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8694 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8695 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8697 /* Now fix the mispositioned frame's location. */
8699 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8700 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8702 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8703 adjusted_left, adjusted_top);
8705 x_sync_with_move (f, expected_left, expected_top, 0);
8707 else
8708 /* It's a "Type B" window manager. We don't have to adjust the
8709 frame's position. */
8711 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8715 /* Wait for XGetGeometry to return up-to-date position information for a
8716 recently-moved frame. Call this immediately after calling XMoveWindow.
8717 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8718 frame has been moved to, so we use a fuzzy position comparison instead
8719 of an exact comparison. */
8721 static void
8722 x_sync_with_move (f, left, top, fuzzy)
8723 struct frame *f;
8724 int left, top, fuzzy;
8726 int count = 0;
8728 while (count++ < 50)
8730 int current_left = 0, current_top = 0;
8732 /* In theory, this call to XSync only needs to happen once, but in
8733 practice, it doesn't seem to work, hence the need for the surrounding
8734 loop. */
8736 XSync (FRAME_X_DISPLAY (f), False);
8737 x_real_positions (f, &current_left, &current_top);
8739 if (fuzzy)
8741 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8742 pixels. */
8744 if (eabs (current_left - left) <= 10
8745 && eabs (current_top - top) <= 40)
8746 return;
8748 else if (current_left == left && current_top == top)
8749 return;
8752 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8753 will then return up-to-date position info. */
8755 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8759 /* Change the size of frame F's X window to COLS/ROWS in the case F
8760 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8761 top-left-corner window gravity for this size change and subsequent
8762 size changes. Otherwise we leave the window gravity unchanged. */
8764 static void
8765 x_set_window_size_1 (f, change_gravity, cols, rows)
8766 struct frame *f;
8767 int change_gravity;
8768 int cols, rows;
8770 int pixelwidth, pixelheight;
8772 check_frame_size (f, &rows, &cols);
8773 f->scroll_bar_actual_width
8774 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8776 : FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0
8777 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)
8778 : (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)));
8780 compute_fringe_widths (f, 0);
8782 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols);
8783 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows);
8785 f->win_gravity = NorthWestGravity;
8786 x_wm_set_size_hint (f, (long) 0, 0);
8788 XSync (FRAME_X_DISPLAY (f), False);
8789 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8790 pixelwidth, pixelheight);
8792 /* Now, strictly speaking, we can't be sure that this is accurate,
8793 but the window manager will get around to dealing with the size
8794 change request eventually, and we'll hear how it went when the
8795 ConfigureNotify event gets here.
8797 We could just not bother storing any of this information here,
8798 and let the ConfigureNotify event set everything up, but that
8799 might be kind of confusing to the Lisp code, since size changes
8800 wouldn't be reported in the frame parameters until some random
8801 point in the future when the ConfigureNotify event arrives.
8803 We pass 1 for DELAY since we can't run Lisp code inside of
8804 a BLOCK_INPUT. */
8805 change_frame_size (f, rows, cols, 0, 1, 0);
8806 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8807 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8809 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8810 receive in the ConfigureNotify event; if we get what we asked
8811 for, then the event won't cause the screen to become garbaged, so
8812 we have to make sure to do it here. */
8813 SET_FRAME_GARBAGED (f);
8815 XFlush (FRAME_X_DISPLAY (f));
8819 /* Call this to change the size of frame F's x-window.
8820 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8821 for this size change and subsequent size changes.
8822 Otherwise we leave the window gravity unchanged. */
8824 void
8825 x_set_window_size (f, change_gravity, cols, rows)
8826 struct frame *f;
8827 int change_gravity;
8828 int cols, rows;
8830 BLOCK_INPUT;
8832 #ifdef USE_GTK
8833 if (FRAME_GTK_WIDGET (f))
8834 xg_frame_set_char_size (f, cols, rows);
8835 else
8836 x_set_window_size_1 (f, change_gravity, cols, rows);
8837 #elif USE_X_TOOLKIT
8839 if (f->output_data.x->widget != NULL)
8841 /* The x and y position of the widget is clobbered by the
8842 call to XtSetValues within EmacsFrameSetCharSize.
8843 This is a real kludge, but I don't understand Xt so I can't
8844 figure out a correct fix. Can anyone else tell me? -- rms. */
8845 int xpos = f->output_data.x->widget->core.x;
8846 int ypos = f->output_data.x->widget->core.y;
8847 EmacsFrameSetCharSize (f->output_data.x->edit_widget, cols, rows);
8848 f->output_data.x->widget->core.x = xpos;
8849 f->output_data.x->widget->core.y = ypos;
8851 else
8852 x_set_window_size_1 (f, change_gravity, cols, rows);
8854 #else /* not USE_X_TOOLKIT */
8856 x_set_window_size_1 (f, change_gravity, cols, rows);
8858 #endif /* not USE_X_TOOLKIT */
8860 /* If cursor was outside the new size, mark it as off. */
8861 mark_window_cursors_off (XWINDOW (f->root_window));
8863 /* Clear out any recollection of where the mouse highlighting was,
8864 since it might be in a place that's outside the new frame size.
8865 Actually checking whether it is outside is a pain in the neck,
8866 so don't try--just let the highlighting be done afresh with new size. */
8867 cancel_mouse_face (f);
8869 UNBLOCK_INPUT;
8872 /* Mouse warping. */
8874 void
8875 x_set_mouse_position (f, x, y)
8876 struct frame *f;
8877 int x, y;
8879 int pix_x, pix_y;
8881 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8882 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8884 if (pix_x < 0) pix_x = 0;
8885 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8887 if (pix_y < 0) pix_y = 0;
8888 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8890 BLOCK_INPUT;
8892 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8893 0, 0, 0, 0, pix_x, pix_y);
8894 UNBLOCK_INPUT;
8897 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8899 void
8900 x_set_mouse_pixel_position (f, pix_x, pix_y)
8901 struct frame *f;
8902 int pix_x, pix_y;
8904 BLOCK_INPUT;
8906 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8907 0, 0, 0, 0, pix_x, pix_y);
8908 UNBLOCK_INPUT;
8911 /* focus shifting, raising and lowering. */
8913 void
8914 x_focus_on_frame (f)
8915 struct frame *f;
8917 #if 0 /* This proves to be unpleasant. */
8918 x_raise_frame (f);
8919 #endif
8920 #if 0
8921 /* I don't think that the ICCCM allows programs to do things like this
8922 without the interaction of the window manager. Whatever you end up
8923 doing with this code, do it to x_unfocus_frame too. */
8924 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8925 RevertToPointerRoot, CurrentTime);
8926 #endif /* ! 0 */
8929 void
8930 x_unfocus_frame (f)
8931 struct frame *f;
8933 #if 0
8934 /* Look at the remarks in x_focus_on_frame. */
8935 if (FRAME_X_DISPLAY_INFO (f)->x_focus_frame == f)
8936 XSetInputFocus (FRAME_X_DISPLAY (f), PointerRoot,
8937 RevertToPointerRoot, CurrentTime);
8938 #endif /* ! 0 */
8941 /* Raise frame F. */
8943 void
8944 x_raise_frame (f)
8945 struct frame *f;
8947 BLOCK_INPUT;
8948 if (f->async_visible)
8949 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8951 XFlush (FRAME_X_DISPLAY (f));
8952 UNBLOCK_INPUT;
8955 /* Lower frame F. */
8957 void
8958 x_lower_frame (f)
8959 struct frame *f;
8961 if (f->async_visible)
8963 BLOCK_INPUT;
8964 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8965 XFlush (FRAME_X_DISPLAY (f));
8966 UNBLOCK_INPUT;
8970 /* Activate frame with Extended Window Manager Hints */
8972 void
8973 x_ewmh_activate_frame (f)
8974 FRAME_PTR f;
8976 /* See Window Manager Specification/Extended Window Manager Hints at
8977 http://freedesktop.org/wiki/Specifications/wm-spec */
8979 const char *atom = "_NET_ACTIVE_WINDOW";
8980 if (f->async_visible && wm_supports (f, atom))
8982 Lisp_Object frame;
8983 XSETFRAME (frame, f);
8984 Fx_send_client_event (frame, make_number (0), frame,
8985 make_unibyte_string (atom, strlen (atom)),
8986 make_number (32),
8987 Fcons (make_number (1),
8988 Fcons (make_number (last_user_time),
8989 Qnil)));
8993 static void
8994 XTframe_raise_lower (f, raise_flag)
8995 FRAME_PTR f;
8996 int raise_flag;
8998 if (raise_flag)
8999 x_raise_frame (f);
9000 else
9001 x_lower_frame (f);
9004 /* XEmbed implementation. */
9006 void
9007 xembed_set_info (f, flags)
9008 struct frame *f;
9009 enum xembed_info flags;
9011 Atom atom;
9012 unsigned long data[2];
9014 atom = XInternAtom (FRAME_X_DISPLAY (f), "_XEMBED_INFO", False);
9016 data[0] = XEMBED_VERSION;
9017 data[1] = flags;
9019 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), atom, atom,
9020 32, PropModeReplace, (unsigned char *) data, 2);
9023 void
9024 xembed_send_message (f, time, message, detail, data1, data2)
9025 struct frame *f;
9026 Time time;
9027 enum xembed_message message;
9028 long detail;
9029 long data1;
9030 long data2;
9032 XEvent event;
9034 event.xclient.type = ClientMessage;
9035 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
9036 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
9037 event.xclient.format = 32;
9038 event.xclient.data.l[0] = time;
9039 event.xclient.data.l[1] = message;
9040 event.xclient.data.l[2] = detail;
9041 event.xclient.data.l[3] = data1;
9042 event.xclient.data.l[4] = data2;
9044 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9045 False, NoEventMask, &event);
9046 XSync (FRAME_X_DISPLAY (f), False);
9049 /* Change of visibility. */
9051 /* This tries to wait until the frame is really visible.
9052 However, if the window manager asks the user where to position
9053 the frame, this will return before the user finishes doing that.
9054 The frame will not actually be visible at that time,
9055 but it will become visible later when the window manager
9056 finishes with it. */
9058 void
9059 x_make_frame_visible (f)
9060 struct frame *f;
9062 Lisp_Object type;
9063 int original_top, original_left;
9064 int retry_count = 2;
9066 retry:
9068 BLOCK_INPUT;
9070 type = x_icon_type (f);
9071 if (!NILP (type))
9072 x_bitmap_icon (f, type);
9074 if (! FRAME_VISIBLE_P (f))
9076 /* We test FRAME_GARBAGED_P here to make sure we don't
9077 call x_set_offset a second time
9078 if we get to x_make_frame_visible a second time
9079 before the window gets really visible. */
9080 if (! FRAME_ICONIFIED_P (f)
9081 && ! FRAME_X_EMBEDDED_P (f)
9082 && ! f->output_data.x->asked_for_visible)
9083 x_set_offset (f, f->left_pos, f->top_pos, 0);
9085 f->output_data.x->asked_for_visible = 1;
9087 if (! EQ (Vx_no_window_manager, Qt))
9088 x_wm_set_window_state (f, NormalState);
9089 #ifdef USE_X_TOOLKIT
9090 if (FRAME_X_EMBEDDED_P (f))
9091 xembed_set_info (f, XEMBED_MAPPED);
9092 else
9094 /* This was XtPopup, but that did nothing for an iconified frame. */
9095 XtMapWidget (f->output_data.x->widget);
9097 #else /* not USE_X_TOOLKIT */
9098 #ifdef USE_GTK
9099 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9100 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9101 #else
9102 if (FRAME_X_EMBEDDED_P (f))
9103 xembed_set_info (f, XEMBED_MAPPED);
9104 else
9105 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9106 #endif /* not USE_GTK */
9107 #endif /* not USE_X_TOOLKIT */
9108 #if 0 /* This seems to bring back scroll bars in the wrong places
9109 if the window configuration has changed. They seem
9110 to come back ok without this. */
9111 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
9112 XMapSubwindows (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9113 #endif
9116 XFlush (FRAME_X_DISPLAY (f));
9118 /* Synchronize to ensure Emacs knows the frame is visible
9119 before we do anything else. We do this loop with input not blocked
9120 so that incoming events are handled. */
9122 Lisp_Object frame;
9123 int count;
9124 /* This must be before UNBLOCK_INPUT
9125 since events that arrive in response to the actions above
9126 will set it when they are handled. */
9127 int previously_visible = f->output_data.x->has_been_visible;
9129 original_left = f->left_pos;
9130 original_top = f->top_pos;
9132 /* This must come after we set COUNT. */
9133 UNBLOCK_INPUT;
9135 /* We unblock here so that arriving X events are processed. */
9137 /* Now move the window back to where it was "supposed to be".
9138 But don't do it if the gravity is negative.
9139 When the gravity is negative, this uses a position
9140 that is 3 pixels too low. Perhaps that's really the border width.
9142 Don't do this if the window has never been visible before,
9143 because the window manager may choose the position
9144 and we don't want to override it. */
9146 if (! FRAME_VISIBLE_P (f)
9147 && ! FRAME_ICONIFIED_P (f)
9148 && ! FRAME_X_EMBEDDED_P (f)
9149 && f->win_gravity == NorthWestGravity
9150 && previously_visible)
9152 Drawable rootw;
9153 int x, y;
9154 unsigned int width, height, border, depth;
9156 BLOCK_INPUT;
9158 /* On some window managers (such as FVWM) moving an existing
9159 window, even to the same place, causes the window manager
9160 to introduce an offset. This can cause the window to move
9161 to an unexpected location. Check the geometry (a little
9162 slow here) and then verify that the window is in the right
9163 place. If the window is not in the right place, move it
9164 there, and take the potential window manager hit. */
9165 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9166 &rootw, &x, &y, &width, &height, &border, &depth);
9168 if (original_left != x || original_top != y)
9169 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9170 original_left, original_top);
9172 UNBLOCK_INPUT;
9175 XSETFRAME (frame, f);
9177 /* Wait until the frame is visible. Process X events until a
9178 MapNotify event has been seen, or until we think we won't get a
9179 MapNotify at all.. */
9180 for (count = input_signal_count + 10;
9181 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9183 /* Force processing of queued events. */
9184 x_sync (f);
9186 /* Machines that do polling rather than SIGIO have been
9187 observed to go into a busy-wait here. So we'll fake an
9188 alarm signal to let the handler know that there's something
9189 to be read. We used to raise a real alarm, but it seems
9190 that the handler isn't always enabled here. This is
9191 probably a bug. */
9192 if (input_polling_used ())
9194 /* It could be confusing if a real alarm arrives while
9195 processing the fake one. Turn it off and let the
9196 handler reset it. */
9197 extern void poll_for_input_1 P_ ((void));
9198 int old_poll_suppress_count = poll_suppress_count;
9199 poll_suppress_count = 1;
9200 poll_for_input_1 ();
9201 poll_suppress_count = old_poll_suppress_count;
9204 /* See if a MapNotify event has been processed. */
9205 FRAME_SAMPLE_VISIBILITY (f);
9208 /* 2000-09-28: In
9210 (let ((f (selected-frame)))
9211 (iconify-frame f)
9212 (raise-frame f))
9214 the frame is not raised with various window managers on
9215 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9216 unknown reason, the call to XtMapWidget is completely ignored.
9217 Mapping the widget a second time works. */
9219 if (!FRAME_VISIBLE_P (f) && --retry_count > 0)
9220 goto retry;
9224 /* Change from mapped state to withdrawn state. */
9226 /* Make the frame visible (mapped and not iconified). */
9228 void
9229 x_make_frame_invisible (f)
9230 struct frame *f;
9232 Window window;
9234 /* Use the frame's outermost window, not the one we normally draw on. */
9235 window = FRAME_OUTER_WINDOW (f);
9237 /* Don't keep the highlight on an invisible frame. */
9238 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9239 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9241 #if 0/* This might add unreliability; I don't trust it -- rms. */
9242 if (! f->async_visible && ! f->async_iconified)
9243 return;
9244 #endif
9246 BLOCK_INPUT;
9248 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9249 that the current position of the window is user-specified, rather than
9250 program-specified, so that when the window is mapped again, it will be
9251 placed at the same location, without forcing the user to position it
9252 by hand again (they have already done that once for this window.) */
9253 x_wm_set_size_hint (f, (long) 0, 1);
9255 #ifdef USE_GTK
9256 if (FRAME_GTK_OUTER_WIDGET (f))
9257 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9258 else
9259 #else
9260 if (FRAME_X_EMBEDDED_P (f))
9261 xembed_set_info (f, 0);
9262 else
9263 #endif
9266 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9267 DefaultScreen (FRAME_X_DISPLAY (f))))
9269 UNBLOCK_INPUT_RESIGNAL;
9270 error ("Can't notify window manager of window withdrawal");
9274 /* We can't distinguish this from iconification
9275 just by the event that we get from the server.
9276 So we can't win using the usual strategy of letting
9277 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9278 and synchronize with the server to make sure we agree. */
9279 f->visible = 0;
9280 FRAME_ICONIFIED_P (f) = 0;
9281 f->async_visible = 0;
9282 f->async_iconified = 0;
9284 x_sync (f);
9286 UNBLOCK_INPUT;
9289 /* Change window state from mapped to iconified. */
9291 void
9292 x_iconify_frame (f)
9293 struct frame *f;
9295 int result;
9296 Lisp_Object type;
9298 /* Don't keep the highlight on an invisible frame. */
9299 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9300 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9302 if (f->async_iconified)
9303 return;
9305 BLOCK_INPUT;
9307 FRAME_SAMPLE_VISIBILITY (f);
9309 type = x_icon_type (f);
9310 if (!NILP (type))
9311 x_bitmap_icon (f, type);
9313 #ifdef USE_GTK
9314 if (FRAME_GTK_OUTER_WIDGET (f))
9316 if (! FRAME_VISIBLE_P (f))
9317 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9319 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9320 f->iconified = 1;
9321 f->visible = 1;
9322 f->async_iconified = 1;
9323 f->async_visible = 0;
9324 UNBLOCK_INPUT;
9325 return;
9327 #endif
9329 #ifdef USE_X_TOOLKIT
9331 if (! FRAME_VISIBLE_P (f))
9333 if (! EQ (Vx_no_window_manager, Qt))
9334 x_wm_set_window_state (f, IconicState);
9335 /* This was XtPopup, but that did nothing for an iconified frame. */
9336 XtMapWidget (f->output_data.x->widget);
9337 /* The server won't give us any event to indicate
9338 that an invisible frame was changed to an icon,
9339 so we have to record it here. */
9340 f->iconified = 1;
9341 f->visible = 1;
9342 f->async_iconified = 1;
9343 f->async_visible = 0;
9344 UNBLOCK_INPUT;
9345 return;
9348 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9349 XtWindow (f->output_data.x->widget),
9350 DefaultScreen (FRAME_X_DISPLAY (f)));
9351 UNBLOCK_INPUT;
9353 if (!result)
9354 error ("Can't notify window manager of iconification");
9356 f->async_iconified = 1;
9357 f->async_visible = 0;
9360 BLOCK_INPUT;
9361 XFlush (FRAME_X_DISPLAY (f));
9362 UNBLOCK_INPUT;
9363 #else /* not USE_X_TOOLKIT */
9365 /* Make sure the X server knows where the window should be positioned,
9366 in case the user deiconifies with the window manager. */
9367 if (! FRAME_VISIBLE_P (f)
9368 && ! FRAME_ICONIFIED_P (f)
9369 && ! FRAME_X_EMBEDDED_P (f))
9370 x_set_offset (f, f->left_pos, f->top_pos, 0);
9372 /* Since we don't know which revision of X we're running, we'll use both
9373 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9375 /* X11R4: send a ClientMessage to the window manager using the
9376 WM_CHANGE_STATE type. */
9378 XEvent message;
9380 message.xclient.window = FRAME_X_WINDOW (f);
9381 message.xclient.type = ClientMessage;
9382 message.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9383 message.xclient.format = 32;
9384 message.xclient.data.l[0] = IconicState;
9386 if (! XSendEvent (FRAME_X_DISPLAY (f),
9387 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9388 False,
9389 SubstructureRedirectMask | SubstructureNotifyMask,
9390 &message))
9392 UNBLOCK_INPUT_RESIGNAL;
9393 error ("Can't notify window manager of iconification");
9397 /* X11R3: set the initial_state field of the window manager hints to
9398 IconicState. */
9399 x_wm_set_window_state (f, IconicState);
9401 if (!FRAME_VISIBLE_P (f))
9403 /* If the frame was withdrawn, before, we must map it. */
9404 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9407 f->async_iconified = 1;
9408 f->async_visible = 0;
9410 XFlush (FRAME_X_DISPLAY (f));
9411 UNBLOCK_INPUT;
9412 #endif /* not USE_X_TOOLKIT */
9416 /* Free X resources of frame F. */
9418 void
9419 x_free_frame_resources (f)
9420 struct frame *f;
9422 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9423 Lisp_Object bar;
9424 struct scroll_bar *b;
9426 BLOCK_INPUT;
9428 /* If a display connection is dead, don't try sending more
9429 commands to the X server. */
9430 if (dpyinfo->display)
9432 /* We must free faces before destroying windows because some
9433 font-driver (e.g. xft) access a window while finishing a
9434 face. */
9435 if (FRAME_FACE_CACHE (f))
9436 free_frame_faces (f);
9438 if (f->output_data.x->icon_desc)
9439 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9441 #ifdef USE_X_TOOLKIT
9442 /* Explicitly destroy the scroll bars of the frame. Without
9443 this, we get "BadDrawable" errors from the toolkit later on,
9444 presumably from expose events generated for the disappearing
9445 toolkit scroll bars. */
9446 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9448 b = XSCROLL_BAR (bar);
9449 x_scroll_bar_remove (b);
9451 #endif
9453 #ifdef HAVE_X_I18N
9454 if (FRAME_XIC (f))
9455 free_frame_xic (f);
9456 #endif
9458 #ifdef USE_X_TOOLKIT
9459 if (f->output_data.x->widget)
9461 XtDestroyWidget (f->output_data.x->widget);
9462 f->output_data.x->widget = NULL;
9464 /* Tooltips don't have widgets, only a simple X window, even if
9465 we are using a toolkit. */
9466 else if (FRAME_X_WINDOW (f))
9467 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9469 free_frame_menubar (f);
9470 #else /* !USE_X_TOOLKIT */
9472 #ifdef USE_GTK
9473 /* In the GTK version, tooltips are normal X
9474 frames. We must check and free both types. */
9475 if (FRAME_GTK_OUTER_WIDGET (f))
9477 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
9478 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow below */
9479 FRAME_GTK_OUTER_WIDGET (f) = 0;
9481 #endif /* USE_GTK */
9483 if (FRAME_X_WINDOW (f))
9484 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9485 #endif /* !USE_X_TOOLKIT */
9487 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9488 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9489 unload_color (f, f->output_data.x->cursor_pixel);
9490 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9491 unload_color (f, f->output_data.x->border_pixel);
9492 unload_color (f, f->output_data.x->mouse_pixel);
9494 if (f->output_data.x->scroll_bar_background_pixel != -1)
9495 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9496 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9497 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9498 #ifdef USE_TOOLKIT_SCROLL_BARS
9499 /* Scrollbar shadow colors. */
9500 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9501 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9502 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9503 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9504 #endif /* USE_TOOLKIT_SCROLL_BARS */
9505 if (f->output_data.x->white_relief.allocated_p)
9506 unload_color (f, f->output_data.x->white_relief.pixel);
9507 if (f->output_data.x->black_relief.allocated_p)
9508 unload_color (f, f->output_data.x->black_relief.pixel);
9510 if (FRAME_FACE_CACHE (f))
9511 free_frame_faces (f);
9513 x_free_gcs (f);
9514 XFlush (FRAME_X_DISPLAY (f));
9517 xfree (f->output_data.x->saved_menu_event);
9518 xfree (f->output_data.x);
9519 f->output_data.x = NULL;
9521 if (f == dpyinfo->x_focus_frame)
9522 dpyinfo->x_focus_frame = 0;
9523 if (f == dpyinfo->x_focus_event_frame)
9524 dpyinfo->x_focus_event_frame = 0;
9525 if (f == dpyinfo->x_highlight_frame)
9526 dpyinfo->x_highlight_frame = 0;
9528 if (f == dpyinfo->mouse_face_mouse_frame)
9530 dpyinfo->mouse_face_beg_row
9531 = dpyinfo->mouse_face_beg_col = -1;
9532 dpyinfo->mouse_face_end_row
9533 = dpyinfo->mouse_face_end_col = -1;
9534 dpyinfo->mouse_face_window = Qnil;
9535 dpyinfo->mouse_face_deferred_gc = 0;
9536 dpyinfo->mouse_face_mouse_frame = 0;
9539 UNBLOCK_INPUT;
9543 /* Destroy the X window of frame F. */
9545 void
9546 x_destroy_window (f)
9547 struct frame *f;
9549 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9551 /* If a display connection is dead, don't try sending more
9552 commands to the X server. */
9553 if (dpyinfo->display != 0)
9554 x_free_frame_resources (f);
9556 dpyinfo->reference_count--;
9560 /* Setting window manager hints. */
9562 /* Set the normal size hints for the window manager, for frame F.
9563 FLAGS is the flags word to use--or 0 meaning preserve the flags
9564 that the window now has.
9565 If USER_POSITION is nonzero, we set the USPosition
9566 flag (this is useful when FLAGS is 0).
9567 The GTK version is in gtkutils.c */
9569 #ifndef USE_GTK
9570 void
9571 x_wm_set_size_hint (f, flags, user_position)
9572 struct frame *f;
9573 long flags;
9574 int user_position;
9576 XSizeHints size_hints;
9578 #ifdef USE_X_TOOLKIT
9579 Arg al[2];
9580 int ac = 0;
9581 Dimension widget_width, widget_height;
9582 #endif
9584 Window window = FRAME_OUTER_WINDOW (f);
9586 /* Setting PMaxSize caused various problems. */
9587 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9589 size_hints.x = f->left_pos;
9590 size_hints.y = f->top_pos;
9592 #ifdef USE_X_TOOLKIT
9593 XtSetArg (al[ac], XtNwidth, &widget_width); ac++;
9594 XtSetArg (al[ac], XtNheight, &widget_height); ac++;
9595 XtGetValues (f->output_data.x->widget, al, ac);
9596 size_hints.height = widget_height;
9597 size_hints.width = widget_width;
9598 #else /* not USE_X_TOOLKIT */
9599 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9600 size_hints.width = FRAME_PIXEL_WIDTH (f);
9601 #endif /* not USE_X_TOOLKIT */
9603 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9604 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9605 size_hints.max_width
9606 = FRAME_X_DISPLAY_INFO (f)->width - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9607 size_hints.max_height
9608 = FRAME_X_DISPLAY_INFO (f)->height - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9610 /* Calculate the base and minimum sizes.
9612 (When we use the X toolkit, we don't do it here.
9613 Instead we copy the values that the widgets are using, below.) */
9614 #ifndef USE_X_TOOLKIT
9616 int base_width, base_height;
9617 int min_rows = 0, min_cols = 0;
9619 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9620 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9622 check_frame_size (f, &min_rows, &min_cols);
9624 /* The window manager uses the base width hints to calculate the
9625 current number of rows and columns in the frame while
9626 resizing; min_width and min_height aren't useful for this
9627 purpose, since they might not give the dimensions for a
9628 zero-row, zero-column frame.
9630 We use the base_width and base_height members if we have
9631 them; otherwise, we set the min_width and min_height members
9632 to the size for a zero x zero frame. */
9634 size_hints.flags |= PBaseSize;
9635 size_hints.base_width = base_width;
9636 size_hints.base_height = base_height;
9637 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9638 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9641 /* If we don't need the old flags, we don't need the old hint at all. */
9642 if (flags)
9644 size_hints.flags |= flags;
9645 goto no_read;
9647 #endif /* not USE_X_TOOLKIT */
9650 XSizeHints hints; /* Sometimes I hate X Windows... */
9651 long supplied_return;
9652 int value;
9654 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9655 &supplied_return);
9657 #ifdef USE_X_TOOLKIT
9658 size_hints.base_height = hints.base_height;
9659 size_hints.base_width = hints.base_width;
9660 size_hints.min_height = hints.min_height;
9661 size_hints.min_width = hints.min_width;
9662 #endif
9664 if (flags)
9665 size_hints.flags |= flags;
9666 else
9668 if (value == 0)
9669 hints.flags = 0;
9670 if (hints.flags & PSize)
9671 size_hints.flags |= PSize;
9672 if (hints.flags & PPosition)
9673 size_hints.flags |= PPosition;
9674 if (hints.flags & USPosition)
9675 size_hints.flags |= USPosition;
9676 if (hints.flags & USSize)
9677 size_hints.flags |= USSize;
9681 #ifndef USE_X_TOOLKIT
9682 no_read:
9683 #endif
9685 #ifdef PWinGravity
9686 size_hints.win_gravity = f->win_gravity;
9687 size_hints.flags |= PWinGravity;
9689 if (user_position)
9691 size_hints.flags &= ~ PPosition;
9692 size_hints.flags |= USPosition;
9694 #endif /* PWinGravity */
9696 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9698 #endif /* not USE_GTK */
9700 /* Used for IconicState or NormalState */
9702 void
9703 x_wm_set_window_state (f, state)
9704 struct frame *f;
9705 int state;
9707 #ifdef USE_X_TOOLKIT
9708 Arg al[1];
9710 XtSetArg (al[0], XtNinitialState, state);
9711 XtSetValues (f->output_data.x->widget, al, 1);
9712 #else /* not USE_X_TOOLKIT */
9713 Window window = FRAME_X_WINDOW (f);
9715 f->output_data.x->wm_hints.flags |= StateHint;
9716 f->output_data.x->wm_hints.initial_state = state;
9718 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9719 #endif /* not USE_X_TOOLKIT */
9722 void
9723 x_wm_set_icon_pixmap (f, pixmap_id)
9724 struct frame *f;
9725 int pixmap_id;
9727 Pixmap icon_pixmap, icon_mask;
9729 #ifndef USE_X_TOOLKIT
9730 Window window = FRAME_OUTER_WINDOW (f);
9731 #endif
9733 if (pixmap_id > 0)
9735 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9736 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9737 icon_mask = x_bitmap_mask (f, pixmap_id);
9738 f->output_data.x->wm_hints.icon_mask = icon_mask;
9740 else
9742 /* It seems there is no way to turn off use of an icon pixmap.
9743 The following line does it, only if no icon has yet been created,
9744 for some window managers. But with mwm it crashes.
9745 Some people say it should clear the IconPixmapHint bit in this case,
9746 but that doesn't work, and the X consortium said it isn't the
9747 right thing at all. Since there is no way to win,
9748 best to explicitly give up. */
9749 #if 0
9750 f->output_data.x->wm_hints.icon_pixmap = None;
9751 f->output_data.x->wm_hints.icon_mask = None;
9752 #else
9753 return;
9754 #endif
9758 #ifdef USE_GTK
9760 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9761 return;
9764 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9767 Arg al[1];
9768 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9769 XtSetValues (f->output_data.x->widget, al, 1);
9770 XtSetArg (al[0], XtNiconMask, icon_mask);
9771 XtSetValues (f->output_data.x->widget, al, 1);
9774 #else /* not USE_X_TOOLKIT && not USE_GTK */
9776 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9777 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9779 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9782 void
9783 x_wm_set_icon_position (f, icon_x, icon_y)
9784 struct frame *f;
9785 int icon_x, icon_y;
9787 Window window = FRAME_OUTER_WINDOW (f);
9789 f->output_data.x->wm_hints.flags |= IconPositionHint;
9790 f->output_data.x->wm_hints.icon_x = icon_x;
9791 f->output_data.x->wm_hints.icon_y = icon_y;
9793 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9797 /***********************************************************************
9798 Fonts
9799 ***********************************************************************/
9801 #if GLYPH_DEBUG
9803 /* Check that FONT is valid on frame F. It is if it can be found in F's
9804 font table. */
9806 static void
9807 x_check_font (f, font)
9808 struct frame *f;
9809 struct font *font;
9811 Lisp_Object frame;
9813 xassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9814 if (font->driver->check)
9815 xassert (font->driver->check (f, font) == 0);
9818 #endif /* GLYPH_DEBUG != 0 */
9821 /***********************************************************************
9822 Initialization
9823 ***********************************************************************/
9825 #ifdef USE_X_TOOLKIT
9826 static XrmOptionDescRec emacs_options[] = {
9827 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9828 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9830 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9831 XrmoptionSepArg, NULL},
9832 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9834 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9835 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9836 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9837 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9838 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9839 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9840 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9843 /* Whether atimer for Xt timeouts is activated or not. */
9845 static int x_timeout_atimer_activated_flag;
9847 #endif /* USE_X_TOOLKIT */
9849 static int x_initialized;
9851 #ifdef HAVE_X_SM
9852 static int x_session_initialized;
9853 #endif
9855 #ifdef MULTI_KBOARD
9856 /* Test whether two display-name strings agree up to the dot that separates
9857 the screen number from the server number. */
9858 static int
9859 same_x_server (name1, name2)
9860 const char *name1, *name2;
9862 int seen_colon = 0;
9863 const unsigned char *system_name = SDATA (Vsystem_name);
9864 int system_name_length = strlen (system_name);
9865 int length_until_period = 0;
9867 while (system_name[length_until_period] != 0
9868 && system_name[length_until_period] != '.')
9869 length_until_period++;
9871 /* Treat `unix' like an empty host name. */
9872 if (! strncmp (name1, "unix:", 5))
9873 name1 += 4;
9874 if (! strncmp (name2, "unix:", 5))
9875 name2 += 4;
9876 /* Treat this host's name like an empty host name. */
9877 if (! strncmp (name1, system_name, system_name_length)
9878 && name1[system_name_length] == ':')
9879 name1 += system_name_length;
9880 if (! strncmp (name2, system_name, system_name_length)
9881 && name2[system_name_length] == ':')
9882 name2 += system_name_length;
9883 /* Treat this host's domainless name like an empty host name. */
9884 if (! strncmp (name1, system_name, length_until_period)
9885 && name1[length_until_period] == ':')
9886 name1 += length_until_period;
9887 if (! strncmp (name2, system_name, length_until_period)
9888 && name2[length_until_period] == ':')
9889 name2 += length_until_period;
9891 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9893 if (*name1 == ':')
9894 seen_colon++;
9895 if (seen_colon && *name1 == '.')
9896 return 1;
9898 return (seen_colon
9899 && (*name1 == '.' || *name1 == '\0')
9900 && (*name2 == '.' || *name2 == '\0'));
9902 #endif
9904 /* Count number of set bits in mask and number of bits to shift to
9905 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9906 to 5. */
9907 static void
9908 get_bits_and_offset (mask, bits, offset)
9909 unsigned long mask;
9910 int *bits;
9911 int *offset;
9913 int nr = 0;
9914 int off = 0;
9916 while (!(mask & 1))
9918 off++;
9919 mask >>= 1;
9922 while (mask & 1)
9924 nr++;
9925 mask >>= 1;
9928 *offset = off;
9929 *bits = nr;
9932 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9933 But don't permanently open it, just test its availability. */
9936 x_display_ok (display)
9937 const char *display;
9939 int dpy_ok = 1;
9940 Display *dpy;
9942 dpy = XOpenDisplay (display);
9943 if (dpy)
9944 XCloseDisplay (dpy);
9945 else
9946 dpy_ok = 0;
9947 return dpy_ok;
9950 /* Open a connection to X display DISPLAY_NAME, and return
9951 the structure that describes the open display.
9952 If we cannot contact the display, return null. */
9954 struct x_display_info *
9955 x_term_init (display_name, xrm_option, resource_name)
9956 Lisp_Object display_name;
9957 char *xrm_option;
9958 char *resource_name;
9960 int connection;
9961 Display *dpy;
9962 struct terminal *terminal;
9963 struct x_display_info *dpyinfo;
9964 XrmDatabase xrdb;
9966 BLOCK_INPUT;
9968 if (!x_initialized)
9970 x_initialize ();
9971 ++x_initialized;
9974 if (! x_display_ok (SDATA (display_name)))
9975 error ("Display %s can't be opened", SDATA (display_name));
9977 #ifdef USE_GTK
9979 #define NUM_ARGV 10
9980 int argc;
9981 char *argv[NUM_ARGV];
9982 char **argv2 = argv;
9983 GdkAtom atom;
9985 #ifndef HAVE_GTK_MULTIDISPLAY
9986 if (!EQ (Vinitial_window_system, intern ("x")))
9987 error ("Sorry, you cannot connect to X servers with the GTK toolkit");
9988 #endif
9990 if (x_initialized++ > 1)
9992 #ifdef HAVE_GTK_MULTIDISPLAY
9993 /* Opening another display. If xg_display_open returns less
9994 than zero, we are probably on GTK 2.0, which can only handle
9995 one display. GTK 2.2 or later can handle more than one. */
9996 if (xg_display_open (SDATA (display_name), &dpy) < 0)
9997 #endif
9998 error ("Sorry, this version of GTK can only handle one display");
10000 else
10002 for (argc = 0; argc < NUM_ARGV; ++argc)
10003 argv[argc] = 0;
10005 argc = 0;
10006 argv[argc++] = initial_argv[0];
10008 if (! NILP (display_name))
10010 argv[argc++] = "--display";
10011 argv[argc++] = SDATA (display_name);
10014 argv[argc++] = "--name";
10015 argv[argc++] = resource_name;
10017 XSetLocaleModifiers ("");
10019 gtk_init (&argc, &argv2);
10021 /* gtk_init does set_locale. We must fix locale after calling it. */
10022 fixup_locale ();
10023 xg_initialize ();
10025 dpy = GDK_DISPLAY ();
10027 /* NULL window -> events for all windows go to our function */
10028 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
10030 /* Load our own gtkrc if it exists. */
10032 char *file = "~/.emacs.d/gtkrc";
10033 Lisp_Object s, abs_file;
10035 s = make_string (file, strlen (file));
10036 abs_file = Fexpand_file_name (s, Qnil);
10038 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
10039 gtk_rc_parse (SDATA (abs_file));
10042 XSetErrorHandler (x_error_handler);
10043 XSetIOErrorHandler (x_io_error_quitter);
10046 #else /* not USE_GTK */
10047 #ifdef USE_X_TOOLKIT
10048 /* weiner@footloose.sps.mot.com reports that this causes
10049 errors with X11R5:
10050 X protocol error: BadAtom (invalid Atom parameter)
10051 on protocol request 18skiloaf.
10052 So let's not use it until R6. */
10053 #ifdef HAVE_X11XTR6
10054 XtSetLanguageProc (NULL, NULL, NULL);
10055 #endif
10058 int argc = 0;
10059 char *argv[3];
10061 argv[0] = "";
10062 argc = 1;
10063 if (xrm_option)
10065 argv[argc++] = "-xrm";
10066 argv[argc++] = xrm_option;
10068 turn_on_atimers (0);
10069 dpy = XtOpenDisplay (Xt_app_con, SDATA (display_name),
10070 resource_name, EMACS_CLASS,
10071 emacs_options, XtNumber (emacs_options),
10072 &argc, argv);
10073 turn_on_atimers (1);
10075 #ifdef HAVE_X11XTR6
10076 /* I think this is to compensate for XtSetLanguageProc. */
10077 fixup_locale ();
10078 #endif
10081 #else /* not USE_X_TOOLKIT */
10082 XSetLocaleModifiers ("");
10083 dpy = XOpenDisplay (SDATA (display_name));
10084 #endif /* not USE_X_TOOLKIT */
10085 #endif /* not USE_GTK*/
10087 /* Detect failure. */
10088 if (dpy == 0)
10090 UNBLOCK_INPUT;
10091 return 0;
10094 /* We have definitely succeeded. Record the new connection. */
10096 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
10097 bzero (dpyinfo, sizeof *dpyinfo);
10099 terminal = x_create_terminal (dpyinfo);
10101 #ifdef MULTI_KBOARD
10103 struct x_display_info *share;
10104 Lisp_Object tail;
10106 for (share = x_display_list, tail = x_display_name_list; share;
10107 share = share->next, tail = XCDR (tail))
10108 if (same_x_server (SDATA (XCAR (XCAR (tail))),
10109 SDATA (display_name)))
10110 break;
10111 if (share)
10112 terminal->kboard = share->terminal->kboard;
10113 else
10115 terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
10116 init_kboard (terminal->kboard);
10117 terminal->kboard->Vwindow_system = intern ("x");
10118 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10120 char *vendor = ServerVendor (dpy);
10121 UNBLOCK_INPUT;
10122 terminal->kboard->Vsystem_key_alist
10123 = call1 (Qvendor_specific_keysyms,
10124 vendor ? build_string (vendor) : empty_unibyte_string);
10125 BLOCK_INPUT;
10128 terminal->kboard->next_kboard = all_kboards;
10129 all_kboards = terminal->kboard;
10130 /* Don't let the initial kboard remain current longer than necessary.
10131 That would cause problems if a file loaded on startup tries to
10132 prompt in the mini-buffer. */
10133 if (current_kboard == initial_kboard)
10134 current_kboard = terminal->kboard;
10136 terminal->kboard->reference_count++;
10138 #endif
10140 /* Put this display on the chain. */
10141 dpyinfo->next = x_display_list;
10142 x_display_list = dpyinfo;
10144 /* Put it on x_display_name_list as well, to keep them parallel. */
10145 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10146 x_display_name_list);
10147 dpyinfo->name_list_element = XCAR (x_display_name_list);
10149 dpyinfo->display = dpy;
10151 /* Set the name of the terminal. */
10152 terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
10153 strncpy (terminal->name, SDATA (display_name), SBYTES (display_name));
10154 terminal->name[SBYTES (display_name)] = 0;
10156 #if 0
10157 XSetAfterFunction (x_current_display, x_trace_wire);
10158 #endif /* ! 0 */
10160 dpyinfo->x_id_name
10161 = (char *) xmalloc (SBYTES (Vinvocation_name)
10162 + SBYTES (Vsystem_name)
10163 + 2);
10164 sprintf (dpyinfo->x_id_name, "%s@%s",
10165 SDATA (Vinvocation_name), SDATA (Vsystem_name));
10167 /* Figure out which modifier bits mean what. */
10168 x_find_modifier_meanings (dpyinfo);
10170 /* Get the scroll bar cursor. */
10171 #ifdef USE_GTK
10172 /* We must create a GTK cursor, it is required for GTK widgets. */
10173 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10174 #endif /* USE_GTK */
10176 dpyinfo->vertical_scroll_bar_cursor
10177 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10179 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10180 resource_name, EMACS_CLASS);
10181 #ifdef HAVE_XRMSETDATABASE
10182 XrmSetDatabase (dpyinfo->display, xrdb);
10183 #else
10184 dpyinfo->display->db = xrdb;
10185 #endif
10186 /* Put the rdb where we can find it in a way that works on
10187 all versions. */
10188 dpyinfo->xrdb = xrdb;
10190 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10191 DefaultScreen (dpyinfo->display));
10192 select_visual (dpyinfo);
10193 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10194 dpyinfo->height = HeightOfScreen (dpyinfo->screen);
10195 dpyinfo->width = WidthOfScreen (dpyinfo->screen);
10196 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10197 dpyinfo->client_leader_window = 0;
10198 dpyinfo->grabbed = 0;
10199 dpyinfo->reference_count = 0;
10200 dpyinfo->icon_bitmap_id = -1;
10201 dpyinfo->n_fonts = 0;
10202 dpyinfo->bitmaps = 0;
10203 dpyinfo->bitmaps_size = 0;
10204 dpyinfo->bitmaps_last = 0;
10205 dpyinfo->scratch_cursor_gc = 0;
10206 dpyinfo->mouse_face_mouse_frame = 0;
10207 dpyinfo->mouse_face_deferred_gc = 0;
10208 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
10209 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
10210 dpyinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10211 dpyinfo->mouse_face_window = Qnil;
10212 dpyinfo->mouse_face_overlay = Qnil;
10213 dpyinfo->mouse_face_mouse_x = dpyinfo->mouse_face_mouse_y = 0;
10214 dpyinfo->mouse_face_defer = 0;
10215 dpyinfo->mouse_face_hidden = 0;
10216 dpyinfo->x_focus_frame = 0;
10217 dpyinfo->x_focus_event_frame = 0;
10218 dpyinfo->x_highlight_frame = 0;
10219 dpyinfo->terminal->image_cache = make_image_cache ();
10220 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10222 /* See if we can construct pixel values from RGB values. */
10223 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10224 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10226 if (dpyinfo->visual->class == TrueColor)
10228 get_bits_and_offset (dpyinfo->visual->red_mask,
10229 &dpyinfo->red_bits, &dpyinfo->red_offset);
10230 get_bits_and_offset (dpyinfo->visual->blue_mask,
10231 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10232 get_bits_and_offset (dpyinfo->visual->green_mask,
10233 &dpyinfo->green_bits, &dpyinfo->green_offset);
10236 /* See if a private colormap is requested. */
10237 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10239 if (dpyinfo->visual->class == PseudoColor)
10241 Lisp_Object value;
10242 value = display_x_get_resource (dpyinfo,
10243 build_string ("privateColormap"),
10244 build_string ("PrivateColormap"),
10245 Qnil, Qnil);
10246 if (STRINGP (value)
10247 && (!strcmp (SDATA (value), "true")
10248 || !strcmp (SDATA (value), "on")))
10249 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10252 else
10253 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10254 dpyinfo->visual, AllocNone);
10257 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10258 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10259 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10260 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10261 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10262 pixels = DisplayWidth (dpyinfo->display, screen_number);
10263 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10264 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10265 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10268 dpyinfo->Xatom_wm_protocols
10269 = XInternAtom (dpyinfo->display, "WM_PROTOCOLS", False);
10270 dpyinfo->Xatom_wm_take_focus
10271 = XInternAtom (dpyinfo->display, "WM_TAKE_FOCUS", False);
10272 dpyinfo->Xatom_wm_save_yourself
10273 = XInternAtom (dpyinfo->display, "WM_SAVE_YOURSELF", False);
10274 dpyinfo->Xatom_wm_delete_window
10275 = XInternAtom (dpyinfo->display, "WM_DELETE_WINDOW", False);
10276 dpyinfo->Xatom_wm_change_state
10277 = XInternAtom (dpyinfo->display, "WM_CHANGE_STATE", False);
10278 dpyinfo->Xatom_wm_configure_denied
10279 = XInternAtom (dpyinfo->display, "WM_CONFIGURE_DENIED", False);
10280 dpyinfo->Xatom_wm_window_moved
10281 = XInternAtom (dpyinfo->display, "WM_MOVED", False);
10282 dpyinfo->Xatom_wm_client_leader
10283 = XInternAtom (dpyinfo->display, "WM_CLIENT_LEADER", False);
10284 dpyinfo->Xatom_editres
10285 = XInternAtom (dpyinfo->display, "Editres", False);
10286 dpyinfo->Xatom_CLIPBOARD
10287 = XInternAtom (dpyinfo->display, "CLIPBOARD", False);
10288 dpyinfo->Xatom_TIMESTAMP
10289 = XInternAtom (dpyinfo->display, "TIMESTAMP", False);
10290 dpyinfo->Xatom_TEXT
10291 = XInternAtom (dpyinfo->display, "TEXT", False);
10292 dpyinfo->Xatom_COMPOUND_TEXT
10293 = XInternAtom (dpyinfo->display, "COMPOUND_TEXT", False);
10294 dpyinfo->Xatom_UTF8_STRING
10295 = XInternAtom (dpyinfo->display, "UTF8_STRING", False);
10296 dpyinfo->Xatom_DELETE
10297 = XInternAtom (dpyinfo->display, "DELETE", False);
10298 dpyinfo->Xatom_MULTIPLE
10299 = XInternAtom (dpyinfo->display, "MULTIPLE", False);
10300 dpyinfo->Xatom_INCR
10301 = XInternAtom (dpyinfo->display, "INCR", False);
10302 dpyinfo->Xatom_EMACS_TMP
10303 = XInternAtom (dpyinfo->display, "_EMACS_TMP_", False);
10304 dpyinfo->Xatom_TARGETS
10305 = XInternAtom (dpyinfo->display, "TARGETS", False);
10306 dpyinfo->Xatom_NULL
10307 = XInternAtom (dpyinfo->display, "NULL", False);
10308 dpyinfo->Xatom_ATOM_PAIR
10309 = XInternAtom (dpyinfo->display, "ATOM_PAIR", False);
10310 /* For properties of font. */
10311 dpyinfo->Xatom_PIXEL_SIZE
10312 = XInternAtom (dpyinfo->display, "PIXEL_SIZE", False);
10313 dpyinfo->Xatom_AVERAGE_WIDTH
10314 = XInternAtom (dpyinfo->display, "AVERAGE_WIDTH", False);
10315 dpyinfo->Xatom_MULE_BASELINE_OFFSET
10316 = XInternAtom (dpyinfo->display, "_MULE_BASELINE_OFFSET", False);
10317 dpyinfo->Xatom_MULE_RELATIVE_COMPOSE
10318 = XInternAtom (dpyinfo->display, "_MULE_RELATIVE_COMPOSE", False);
10319 dpyinfo->Xatom_MULE_DEFAULT_ASCENT
10320 = XInternAtom (dpyinfo->display, "_MULE_DEFAULT_ASCENT", False);
10322 /* Ghostscript support. */
10323 dpyinfo->Xatom_PAGE = XInternAtom (dpyinfo->display, "PAGE", False);
10324 dpyinfo->Xatom_DONE = XInternAtom (dpyinfo->display, "DONE", False);
10326 dpyinfo->Xatom_Scrollbar = XInternAtom (dpyinfo->display, "SCROLLBAR",
10327 False);
10329 dpyinfo->Xatom_XEMBED = XInternAtom (dpyinfo->display, "_XEMBED",
10330 False);
10332 dpyinfo->cut_buffers_initialized = 0;
10334 dpyinfo->x_dnd_atoms_size = 8;
10335 dpyinfo->x_dnd_atoms_length = 0;
10336 dpyinfo->x_dnd_atoms = xmalloc (sizeof (*dpyinfo->x_dnd_atoms)
10337 * dpyinfo->x_dnd_atoms_size);
10339 dpyinfo->net_supported_atoms = NULL;
10340 dpyinfo->nr_net_supported_atoms = 0;
10341 dpyinfo->net_supported_window = 0;
10343 connection = ConnectionNumber (dpyinfo->display);
10344 dpyinfo->connection = connection;
10347 char null_bits[1];
10349 null_bits[0] = 0x00;
10351 dpyinfo->null_pixel
10352 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10353 null_bits, 1, 1, (long) 0, (long) 0,
10358 extern int gray_bitmap_width, gray_bitmap_height;
10359 extern char *gray_bitmap_bits;
10360 dpyinfo->gray
10361 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10362 gray_bitmap_bits,
10363 gray_bitmap_width, gray_bitmap_height,
10364 (unsigned long) 1, (unsigned long) 0, 1);
10367 #ifdef HAVE_X_I18N
10368 xim_initialize (dpyinfo, resource_name);
10369 #endif
10371 #ifdef subprocesses
10372 /* This is only needed for distinguishing keyboard and process input. */
10373 if (connection != 0)
10374 add_keyboard_wait_descriptor (connection);
10375 #endif
10377 #ifdef F_SETOWN
10378 fcntl (connection, F_SETOWN, getpid ());
10379 #endif /* ! defined (F_SETOWN) */
10381 #ifdef SIGIO
10382 if (interrupt_input)
10383 init_sigio (connection);
10384 #endif /* ! defined (SIGIO) */
10386 #ifdef USE_LUCID
10388 Display *dpy = dpyinfo->display;
10389 XrmValue d, fr, to;
10390 Font font;
10392 d.addr = (XPointer)&dpy;
10393 d.size = sizeof (Display *);
10394 fr.addr = XtDefaultFont;
10395 fr.size = sizeof (XtDefaultFont);
10396 to.size = sizeof (Font *);
10397 to.addr = (XPointer)&font;
10398 x_catch_errors (dpy);
10399 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10400 abort ();
10401 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10402 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10403 x_uncatch_errors ();
10405 #endif
10407 /* See if we should run in synchronous mode. This is useful
10408 for debugging X code. */
10410 Lisp_Object value;
10411 value = display_x_get_resource (dpyinfo,
10412 build_string ("synchronous"),
10413 build_string ("Synchronous"),
10414 Qnil, Qnil);
10415 if (STRINGP (value)
10416 && (!strcmp (SDATA (value), "true")
10417 || !strcmp (SDATA (value), "on")))
10418 XSynchronize (dpyinfo->display, True);
10422 Lisp_Object value;
10423 value = display_x_get_resource (dpyinfo,
10424 build_string ("useXIM"),
10425 build_string ("UseXIM"),
10426 Qnil, Qnil);
10427 #ifdef USE_XIM
10428 if (STRINGP (value)
10429 && (!strcmp (SDATA (value), "false")
10430 || !strcmp (SDATA (value), "off")))
10431 use_xim = 0;
10432 #else
10433 if (STRINGP (value)
10434 && (!strcmp (SDATA (value), "true")
10435 || !strcmp (SDATA (value), "on")))
10436 use_xim = 1;
10437 #endif
10440 #ifdef HAVE_X_SM
10441 /* Only do this for the very first display in the Emacs session.
10442 Ignore X session management when Emacs was first started on a
10443 tty. */
10444 if (terminal->id == 1)
10445 x_session_initialize (dpyinfo);
10446 #endif
10448 UNBLOCK_INPUT;
10450 return dpyinfo;
10453 /* Get rid of display DPYINFO, deleting all frames on it,
10454 and without sending any more commands to the X server. */
10456 void
10457 x_delete_display (dpyinfo)
10458 struct x_display_info *dpyinfo;
10460 int i;
10461 struct terminal *t;
10463 /* Close all frames and delete the generic struct terminal for this
10464 X display. */
10465 for (t = terminal_list; t; t = t->next_terminal)
10466 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10468 #ifdef HAVE_X_SM
10469 /* Close X session management when we close its display. */
10470 if (t->id == 1 && x_session_have_connection ())
10471 x_session_close();
10472 #endif
10473 delete_terminal (t);
10474 break;
10477 delete_keyboard_wait_descriptor (dpyinfo->connection);
10479 /* Discard this display from x_display_name_list and x_display_list.
10480 We can't use Fdelq because that can quit. */
10481 if (! NILP (x_display_name_list)
10482 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10483 x_display_name_list = XCDR (x_display_name_list);
10484 else
10486 Lisp_Object tail;
10488 tail = x_display_name_list;
10489 while (CONSP (tail) && CONSP (XCDR (tail)))
10491 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10493 XSETCDR (tail, XCDR (XCDR (tail)));
10494 break;
10496 tail = XCDR (tail);
10500 if (next_noop_dpyinfo == dpyinfo)
10501 next_noop_dpyinfo = dpyinfo->next;
10503 if (x_display_list == dpyinfo)
10504 x_display_list = dpyinfo->next;
10505 else
10507 struct x_display_info *tail;
10509 for (tail = x_display_list; tail; tail = tail->next)
10510 if (tail->next == dpyinfo)
10511 tail->next = tail->next->next;
10514 #ifndef USE_X_TOOLKIT /* I'm told Xt does this itself. */
10515 #ifndef AIX /* On AIX, XCloseDisplay calls this. */
10516 XrmDestroyDatabase (dpyinfo->xrdb);
10517 #endif
10518 #endif
10519 #ifdef HAVE_X_I18N
10520 if (dpyinfo->xim)
10521 xim_close_dpy (dpyinfo);
10522 #endif
10524 xfree (dpyinfo->x_id_name);
10525 xfree (dpyinfo->color_cells);
10526 xfree (dpyinfo);
10529 #ifdef USE_X_TOOLKIT
10531 /* Atimer callback function for TIMER. Called every 0.1s to process
10532 Xt timeouts, if needed. We must avoid calling XtAppPending as
10533 much as possible because that function does an implicit XFlush
10534 that slows us down. */
10536 static void
10537 x_process_timeouts (timer)
10538 struct atimer *timer;
10540 BLOCK_INPUT;
10541 x_timeout_atimer_activated_flag = 0;
10542 if (toolkit_scroll_bar_interaction || popup_activated ())
10544 while (XtAppPending (Xt_app_con) & XtIMTimer)
10545 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10546 /* Reactivate the atimer for next time. */
10547 x_activate_timeout_atimer ();
10549 UNBLOCK_INPUT;
10552 /* Install an asynchronous timer that processes Xt timeout events
10553 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10554 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10555 function whenever these variables are set. This is necessary
10556 because some widget sets use timeouts internally, for example the
10557 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10558 processed, these widgets don't behave normally. */
10560 void
10561 x_activate_timeout_atimer ()
10563 BLOCK_INPUT;
10564 if (!x_timeout_atimer_activated_flag)
10566 EMACS_TIME interval;
10568 EMACS_SET_SECS_USECS (interval, 0, 100000);
10569 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10570 x_timeout_atimer_activated_flag = 1;
10572 UNBLOCK_INPUT;
10575 #endif /* USE_X_TOOLKIT */
10578 /* Set up use of X before we make the first connection. */
10580 extern frame_parm_handler x_frame_parm_handlers[];
10582 static struct redisplay_interface x_redisplay_interface =
10584 x_frame_parm_handlers,
10585 x_produce_glyphs,
10586 x_write_glyphs,
10587 x_insert_glyphs,
10588 x_clear_end_of_line,
10589 x_scroll_run,
10590 x_after_update_window_line,
10591 x_update_window_begin,
10592 x_update_window_end,
10593 x_cursor_to,
10594 x_flush,
10595 #ifdef XFlush
10596 x_flush,
10597 #else
10598 0, /* flush_display_optional */
10599 #endif
10600 x_clear_window_mouse_face,
10601 x_get_glyph_overhangs,
10602 x_fix_overlapping_area,
10603 x_draw_fringe_bitmap,
10604 0, /* define_fringe_bitmap */
10605 0, /* destroy_fringe_bitmap */
10606 x_compute_glyph_string_overhangs,
10607 x_draw_glyph_string,
10608 x_define_frame_cursor,
10609 x_clear_frame_area,
10610 x_draw_window_cursor,
10611 x_draw_vertical_window_border,
10612 x_shift_glyphs_for_insert
10616 /* This function is called when the last frame on a display is deleted. */
10617 void
10618 x_delete_terminal (struct terminal *terminal)
10620 struct x_display_info *dpyinfo = terminal->display_info.x;
10621 int i;
10623 /* Protect against recursive calls. Fdelete_frame in
10624 delete_terminal calls us back when it deletes our last frame. */
10625 if (!terminal->name)
10626 return;
10628 BLOCK_INPUT;
10629 /* If called from x_connection_closed, the display may already be closed
10630 and dpyinfo->display was set to 0 to indicate that. */
10631 if (dpyinfo->display)
10633 x_destroy_all_bitmaps (dpyinfo);
10634 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10636 #ifdef USE_GTK
10637 xg_display_close (dpyinfo->display);
10638 #else
10639 #ifdef USE_X_TOOLKIT
10640 XtCloseDisplay (dpyinfo->display);
10641 #else
10642 XCloseDisplay (dpyinfo->display);
10643 #endif
10644 #endif /* ! USE_GTK */
10647 x_delete_display (dpyinfo);
10648 UNBLOCK_INPUT;
10651 /* Create a struct terminal, initialize it with the X11 specific
10652 functions and make DISPLAY->TERMINAL point to it. */
10654 static struct terminal *
10655 x_create_terminal (struct x_display_info *dpyinfo)
10657 struct terminal *terminal;
10659 terminal = create_terminal ();
10661 terminal->type = output_x_window;
10662 terminal->display_info.x = dpyinfo;
10663 dpyinfo->terminal = terminal;
10665 /* kboard is initialized in x_term_init. */
10667 terminal->clear_frame_hook = x_clear_frame;
10668 terminal->ins_del_lines_hook = x_ins_del_lines;
10669 terminal->delete_glyphs_hook = x_delete_glyphs;
10670 terminal->ring_bell_hook = XTring_bell;
10671 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10672 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10673 terminal->update_begin_hook = x_update_begin;
10674 terminal->update_end_hook = x_update_end;
10675 terminal->set_terminal_window_hook = XTset_terminal_window;
10676 terminal->read_socket_hook = XTread_socket;
10677 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10678 terminal->mouse_position_hook = XTmouse_position;
10679 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10680 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10681 terminal->fullscreen_hook = XTfullscreen_hook;
10682 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10683 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10684 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10685 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10687 terminal->delete_frame_hook = x_destroy_window;
10688 terminal->delete_terminal_hook = x_delete_terminal;
10690 terminal->rif = &x_redisplay_interface;
10691 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10692 terminal->char_ins_del_ok = 1;
10693 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10694 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10695 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10696 off the bottom. */
10698 return terminal;
10701 void
10702 x_initialize ()
10704 baud_rate = 19200;
10706 x_noop_count = 0;
10707 last_tool_bar_item = -1;
10708 any_help_event_p = 0;
10709 ignore_next_mouse_click_timeout = 0;
10710 #ifdef HAVE_X_SM
10711 x_session_initialized = 0;
10712 #endif
10714 #ifdef USE_GTK
10715 current_count = -1;
10716 #endif
10718 /* Try to use interrupt input; if we can't, then start polling. */
10719 Fset_input_interrupt_mode (Qt);
10721 #ifdef USE_X_TOOLKIT
10722 XtToolkitInitialize ();
10724 Xt_app_con = XtCreateApplicationContext ();
10726 /* Register a converter from strings to pixels, which uses
10727 Emacs' color allocation infrastructure. */
10728 XtAppSetTypeConverter (Xt_app_con,
10729 XtRString, XtRPixel, cvt_string_to_pixel,
10730 cvt_string_to_pixel_args,
10731 XtNumber (cvt_string_to_pixel_args),
10732 XtCacheByDisplay, cvt_pixel_dtor);
10734 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10735 #endif
10737 #ifdef USE_TOOLKIT_SCROLL_BARS
10738 #ifndef USE_GTK
10739 xaw3d_arrow_scroll = False;
10740 xaw3d_pick_top = True;
10741 #endif
10742 #endif
10744 /* Note that there is no real way portable across R3/R4 to get the
10745 original error handler. */
10746 XSetErrorHandler (x_error_handler);
10747 XSetIOErrorHandler (x_io_error_quitter);
10749 /* Disable Window Change signals; they are handled by X events. */
10750 #if 0 /* Don't. We may want to open tty frames later. */
10751 #ifdef SIGWINCH
10752 signal (SIGWINCH, SIG_DFL);
10753 #endif /* SIGWINCH */
10754 #endif
10756 signal (SIGPIPE, x_connection_signal);
10760 void
10761 syms_of_xterm ()
10763 x_error_message = NULL;
10765 staticpro (&x_display_name_list);
10766 x_display_name_list = Qnil;
10768 staticpro (&last_mouse_scroll_bar);
10769 last_mouse_scroll_bar = Qnil;
10771 staticpro (&Qvendor_specific_keysyms);
10772 Qvendor_specific_keysyms = intern ("vendor-specific-keysyms");
10774 staticpro (&Qlatin_1);
10775 Qlatin_1 = intern ("latin-1");
10777 staticpro (&last_mouse_press_frame);
10778 last_mouse_press_frame = Qnil;
10780 DEFVAR_BOOL ("x-use-underline-position-properties",
10781 &x_use_underline_position_properties,
10782 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
10783 A value of nil means ignore them. If you encounter fonts with bogus
10784 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10785 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10786 to override the font's UNDERLINE_POSITION for small font display
10787 sizes. */);
10788 x_use_underline_position_properties = 1;
10790 DEFVAR_BOOL ("x-underline-at-descent-line",
10791 &x_underline_at_descent_line,
10792 doc: /* *Non-nil means to draw the underline at the same place as the descent line.
10793 A value of nil means to draw the underline according to the value of the
10794 variable `x-use-underline-position-properties', which is usually at the
10795 baseline level. The default value is nil. */);
10796 x_underline_at_descent_line = 0;
10798 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10799 &x_mouse_click_focus_ignore_position,
10800 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10801 This variable is only used when the window manager requires that you
10802 click on a frame to select it (give it focus). In that case, a value
10803 of nil, means that the selected window and cursor position changes to
10804 reflect the mouse click position, while a non-nil value means that the
10805 selected window or cursor position is preserved. */);
10806 x_mouse_click_focus_ignore_position = 0;
10808 DEFVAR_LISP ("x-toolkit-scroll-bars", &Vx_toolkit_scroll_bars,
10809 doc: /* What X toolkit scroll bars Emacs uses.
10810 A value of nil means Emacs doesn't use X toolkit scroll bars.
10811 Otherwise, value is a symbol describing the X toolkit. */);
10812 #ifdef USE_TOOLKIT_SCROLL_BARS
10813 #ifdef USE_MOTIF
10814 Vx_toolkit_scroll_bars = intern ("motif");
10815 #elif defined HAVE_XAW3D
10816 Vx_toolkit_scroll_bars = intern ("xaw3d");
10817 #elif USE_GTK
10818 Vx_toolkit_scroll_bars = intern ("gtk");
10819 #else
10820 Vx_toolkit_scroll_bars = intern ("xaw");
10821 #endif
10822 #else
10823 Vx_toolkit_scroll_bars = Qnil;
10824 #endif
10826 staticpro (&last_mouse_motion_frame);
10827 last_mouse_motion_frame = Qnil;
10829 Qmodifier_value = intern ("modifier-value");
10830 Qalt = intern ("alt");
10831 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10832 Qhyper = intern ("hyper");
10833 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10834 Qmeta = intern ("meta");
10835 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10836 Qsuper = intern ("super");
10837 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10839 DEFVAR_LISP ("x-alt-keysym", &Vx_alt_keysym,
10840 doc: /* Which keys Emacs uses for the alt modifier.
10841 This should be one of the symbols `alt', `hyper', `meta', `super'.
10842 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10843 is nil, which is the same as `alt'. */);
10844 Vx_alt_keysym = Qnil;
10846 DEFVAR_LISP ("x-hyper-keysym", &Vx_hyper_keysym,
10847 doc: /* Which keys Emacs uses for the hyper modifier.
10848 This should be one of the symbols `alt', `hyper', `meta', `super'.
10849 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10850 default is nil, which is the same as `hyper'. */);
10851 Vx_hyper_keysym = Qnil;
10853 DEFVAR_LISP ("x-meta-keysym", &Vx_meta_keysym,
10854 doc: /* Which keys Emacs uses for the meta modifier.
10855 This should be one of the symbols `alt', `hyper', `meta', `super'.
10856 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10857 default is nil, which is the same as `meta'. */);
10858 Vx_meta_keysym = Qnil;
10860 DEFVAR_LISP ("x-super-keysym", &Vx_super_keysym,
10861 doc: /* Which keys Emacs uses for the super modifier.
10862 This should be one of the symbols `alt', `hyper', `meta', `super'.
10863 For example, `super' means use the Super_L and Super_R keysyms. The
10864 default is nil, which is the same as `super'. */);
10865 Vx_super_keysym = Qnil;
10867 DEFVAR_LISP ("x-keysym-table", &Vx_keysym_table,
10868 doc: /* Hash table of character codes indexed by X keysym codes. */);
10869 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10870 make_float (DEFAULT_REHASH_SIZE),
10871 make_float (DEFAULT_REHASH_THRESHOLD),
10872 Qnil, Qnil, Qnil);
10875 #endif /* HAVE_X_WINDOWS */
10877 /* arch-tag: 6d4e4cb7-abc1-4302-9585-d84dcfb09d0f
10878 (do not change this comment) */