(ediff-context-diff-label-regexp): Don't match
[emacs.git] / src / xterm.c
blob7f9f6f3c05e78e8a17dcfa6fd57c24a1e23512a4
1 /* X Communication module for terminals which understand the X protocol.
2 Copyright (C) 1989, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
3 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New display code by Gerd Moellmann <gerd@gnu.org>. */
22 /* Xt features made by Fred Pierresteguy. */
24 #include <config.h>
26 /* On 4.3 these lose if they come after xterm.h. */
27 /* Putting these at the beginning seems to be standard for other .c files. */
28 #include <signal.h>
30 #include <stdio.h>
31 #include <setjmp.h>
33 #ifdef HAVE_X_WINDOWS
35 #include "lisp.h"
36 #include "blockinput.h"
38 /* Need syssignal.h for various externs and definitions that may be required
39 by some configurations for calls to signal later in this source file. */
40 #include "syssignal.h"
42 /* This may include sys/types.h, and that somehow loses
43 if this is not done before the other system files. */
44 #include "xterm.h"
45 #include <X11/cursorfont.h>
47 /* Load sys/types.h if not already loaded.
48 In some systems loading it twice is suicidal. */
49 #ifndef makedev
50 #include <sys/types.h>
51 #endif /* makedev */
53 #ifdef BSD_SYSTEM
54 #include <sys/ioctl.h>
55 #endif /* ! defined (BSD_SYSTEM) */
57 #include "systime.h"
59 #ifndef INCLUDED_FCNTL
60 #include <fcntl.h>
61 #endif
62 #include <ctype.h>
63 #include <errno.h>
64 #include <setjmp.h>
65 #include <sys/stat.h>
66 /* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed. */
67 /* #include <sys/param.h> */
69 #include "charset.h"
70 #include "character.h"
71 #include "coding.h"
72 #include "frame.h"
73 #include "dispextern.h"
74 #include "fontset.h"
75 #include "termhooks.h"
76 #include "termopts.h"
77 #include "termchar.h"
78 #include "emacs-icon.h"
79 #include "disptab.h"
80 #include "buffer.h"
81 #include "window.h"
82 #include "keyboard.h"
83 #include "intervals.h"
84 #include "process.h"
85 #include "atimer.h"
86 #include "keymap.h"
87 #include "font.h"
88 #include "fontset.h"
89 #include "xsettings.h"
90 #include "xgselect.h"
91 #include "sysselect.h"
93 #ifdef USE_X_TOOLKIT
94 #include <X11/Shell.h>
95 #endif
97 #ifdef HAVE_SYS_TIME_H
98 #include <sys/time.h>
99 #endif
100 #ifdef HAVE_UNISTD_H
101 #include <unistd.h>
102 #endif
104 #ifdef USE_GTK
105 #include "gtkutil.h"
106 #endif
108 #ifdef USE_LUCID
109 extern int xlwmenu_window_p P_ ((Widget w, Window window));
110 extern void xlwmenu_redisplay P_ ((Widget));
111 #endif
113 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
115 extern void free_frame_menubar P_ ((struct frame *));
116 #endif
118 #ifdef USE_X_TOOLKIT
119 #if !defined(NO_EDITRES)
120 #define HACK_EDITRES
121 extern void _XEditResCheckMessages ();
122 #endif /* not NO_EDITRES */
124 /* Include toolkit specific headers for the scroll bar widget. */
126 #ifdef USE_TOOLKIT_SCROLL_BARS
127 #if defined USE_MOTIF
128 #include <Xm/Xm.h> /* for LESSTIF_VERSION */
129 #include <Xm/ScrollBar.h>
130 #else /* !USE_MOTIF i.e. use Xaw */
132 #ifdef HAVE_XAW3D
133 #include <X11/Xaw3d/Simple.h>
134 #include <X11/Xaw3d/Scrollbar.h>
135 #include <X11/Xaw3d/ThreeD.h>
136 #else /* !HAVE_XAW3D */
137 #include <X11/Xaw/Simple.h>
138 #include <X11/Xaw/Scrollbar.h>
139 #endif /* !HAVE_XAW3D */
140 #ifndef XtNpickTop
141 #define XtNpickTop "pickTop"
142 #endif /* !XtNpickTop */
143 #endif /* !USE_MOTIF */
144 #endif /* USE_TOOLKIT_SCROLL_BARS */
146 #endif /* USE_X_TOOLKIT */
148 #ifdef USE_X_TOOLKIT
149 #include "widget.h"
150 #ifndef XtNinitialState
151 #define XtNinitialState "initialState"
152 #endif
153 #endif
155 /* Default to using XIM if available. */
156 #ifdef USE_XIM
157 int use_xim = 1;
158 #else
159 int use_xim = 0; /* configure --without-xim */
160 #endif
164 /* Non-nil means Emacs uses toolkit scroll bars. */
166 Lisp_Object Vx_toolkit_scroll_bars;
168 /* Non-zero means that a HELP_EVENT has been generated since Emacs
169 start. */
171 static int any_help_event_p;
173 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
174 static Lisp_Object last_window;
176 /* Non-zero means make use of UNDERLINE_POSITION font properties. */
178 int x_use_underline_position_properties;
180 /* Non-zero means to draw the underline at the same place as the descent line. */
182 int x_underline_at_descent_line;
184 /* This is a chain of structures for all the X displays currently in
185 use. */
187 struct x_display_info *x_display_list;
189 /* This is a list of cons cells, each of the form (NAME
190 . FONT-LIST-CACHE), one for each element of x_display_list and in
191 the same order. NAME is the name of the frame. FONT-LIST-CACHE
192 records previous values returned by x-list-fonts. */
194 Lisp_Object x_display_name_list;
196 /* Frame being updated by update_frame. This is declared in term.c.
197 This is set by update_begin and looked at by all the XT functions.
198 It is zero while not inside an update. In that case, the XT
199 functions assume that `selected_frame' is the frame to apply to. */
201 extern struct frame *updating_frame;
203 /* This is a frame waiting to be auto-raised, within XTread_socket. */
205 static struct frame *pending_autoraise_frame;
207 /* This is a frame waiting for an event matching mask, within XTread_socket. */
209 static struct {
210 struct frame *f;
211 int eventtype;
212 } pending_event_wait;
214 #ifdef USE_X_TOOLKIT
215 /* The application context for Xt use. */
216 XtAppContext Xt_app_con;
217 static String Xt_default_resources[] = {0};
218 #endif /* USE_X_TOOLKIT */
220 /* Non-zero means user is interacting with a toolkit scroll bar. */
222 static int toolkit_scroll_bar_interaction;
224 /* Non-zero means to not move point as a result of clicking on a
225 frame to focus it (when focus-follows-mouse is nil). */
227 int x_mouse_click_focus_ignore_position;
229 /* Non-zero timeout value means ignore next mouse click if it arrives
230 before that timeout elapses (i.e. as part of the same sequence of
231 events resulting from clicking on a frame to select it). */
233 static unsigned long ignore_next_mouse_click_timeout;
235 /* Mouse movement.
237 Formerly, we used PointerMotionHintMask (in standard_event_mask)
238 so that we would have to call XQueryPointer after each MotionNotify
239 event to ask for another such event. However, this made mouse tracking
240 slow, and there was a bug that made it eventually stop.
242 Simply asking for MotionNotify all the time seems to work better.
244 In order to avoid asking for motion events and then throwing most
245 of them away or busy-polling the server for mouse positions, we ask
246 the server for pointer motion hints. This means that we get only
247 one event per group of mouse movements. "Groups" are delimited by
248 other kinds of events (focus changes and button clicks, for
249 example), or by XQueryPointer calls; when one of these happens, we
250 get another MotionNotify event the next time the mouse moves. This
251 is at least as efficient as getting motion events when mouse
252 tracking is on, and I suspect only negligibly worse when tracking
253 is off. */
255 /* Where the mouse was last time we reported a mouse event. */
257 static XRectangle last_mouse_glyph;
258 static FRAME_PTR last_mouse_glyph_frame;
259 static Lisp_Object last_mouse_press_frame;
261 /* The scroll bar in which the last X motion event occurred.
263 If the last X motion event occurred in a scroll bar, we set this so
264 XTmouse_position can know whether to report a scroll bar motion or
265 an ordinary motion.
267 If the last X motion event didn't occur in a scroll bar, we set
268 this to Qnil, to tell XTmouse_position to return an ordinary motion
269 event. */
271 static Lisp_Object last_mouse_scroll_bar;
273 /* This is a hack. We would really prefer that XTmouse_position would
274 return the time associated with the position it returns, but there
275 doesn't seem to be any way to wrest the time-stamp from the server
276 along with the position query. So, we just keep track of the time
277 of the last movement we received, and return that in hopes that
278 it's somewhat accurate. */
280 static Time last_mouse_movement_time;
282 /* Time for last user interaction as returned in X events. */
284 static Time last_user_time;
286 /* Incremented by XTread_socket whenever it really tries to read
287 events. */
289 #ifdef __STDC__
290 static int volatile input_signal_count;
291 #else
292 static int input_signal_count;
293 #endif
295 /* Used locally within XTread_socket. */
297 static int x_noop_count;
299 /* Initial values of argv and argc. */
301 extern char **initial_argv;
302 extern int initial_argc;
304 extern Lisp_Object Vcommand_line_args, Vsystem_name;
306 /* Tells if a window manager is present or not. */
308 extern Lisp_Object Vx_no_window_manager;
310 extern Lisp_Object Qeql;
312 extern int errno;
314 /* A mask of extra modifier bits to put into every keyboard char. */
316 extern EMACS_INT extra_keyboard_modifiers;
318 /* The keysyms to use for the various modifiers. */
320 Lisp_Object Vx_alt_keysym, Vx_hyper_keysym, Vx_meta_keysym, Vx_super_keysym;
321 Lisp_Object Vx_keysym_table;
322 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
324 static Lisp_Object Qvendor_specific_keysyms;
325 static Lisp_Object Qlatin_1;
327 #ifdef USE_GTK
328 /* The name of the Emacs icon file. */
329 static Lisp_Object xg_default_icon_file;
331 /* Used in gtkutil.c. */
332 Lisp_Object Qx_gtk_map_stock;
333 #endif
335 /* Used in x_flush. */
337 extern Lisp_Object Vinhibit_redisplay;
339 extern XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
340 extern int x_bitmap_mask P_ ((FRAME_PTR, int));
342 static int x_alloc_nearest_color_1 P_ ((Display *, Colormap, XColor *));
343 static void x_set_window_size_1 P_ ((struct frame *, int, int, int));
344 static const XColor *x_color_cells P_ ((Display *, int *));
345 static void x_update_window_end P_ ((struct window *, int, int));
347 static int x_io_error_quitter P_ ((Display *));
348 static struct terminal *x_create_terminal P_ ((struct x_display_info *));
349 void x_delete_terminal P_ ((struct terminal *));
350 static void x_update_end P_ ((struct frame *));
351 static void XTframe_up_to_date P_ ((struct frame *));
352 static void XTset_terminal_modes P_ ((struct terminal *));
353 static void XTreset_terminal_modes P_ ((struct terminal *));
354 static void x_clear_frame P_ ((struct frame *));
355 static void frame_highlight P_ ((struct frame *));
356 static void frame_unhighlight P_ ((struct frame *));
357 static void x_new_focus_frame P_ ((struct x_display_info *, struct frame *));
358 static void x_focus_changed P_ ((int, int, struct x_display_info *,
359 struct frame *, struct input_event *));
360 static void x_detect_focus_change P_ ((struct x_display_info *,
361 XEvent *, struct input_event *));
362 static void XTframe_rehighlight P_ ((struct frame *));
363 static void x_frame_rehighlight P_ ((struct x_display_info *));
364 static void x_draw_hollow_cursor P_ ((struct window *, struct glyph_row *));
365 static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int,
366 enum text_cursor_kinds));
368 static void x_clip_to_row P_ ((struct window *, struct glyph_row *, int, GC));
369 static void x_flush P_ ((struct frame *f));
370 static void x_update_begin P_ ((struct frame *));
371 static void x_update_window_begin P_ ((struct window *));
372 static void x_after_update_window_line P_ ((struct glyph_row *));
373 static struct scroll_bar *x_window_to_scroll_bar P_ ((Display *, Window));
374 static void x_scroll_bar_report_motion P_ ((struct frame **, Lisp_Object *,
375 enum scroll_bar_part *,
376 Lisp_Object *, Lisp_Object *,
377 unsigned long *));
378 static void x_handle_net_wm_state P_ ((struct frame *, XPropertyEvent *));
379 static void x_check_fullscreen P_ ((struct frame *));
380 static void x_check_expected_move P_ ((struct frame *, int, int));
381 static void x_sync_with_move P_ ((struct frame *, int, int, int));
382 static int handle_one_xevent P_ ((struct x_display_info *, XEvent *,
383 int *, struct input_event *));
384 /* Don't declare this NO_RETURN because we want no
385 interference with debugging failing X calls. */
386 static SIGTYPE x_connection_closed P_ ((Display *, char *));
389 /* Flush display of frame F, or of all frames if F is null. */
391 static void
392 x_flush (f)
393 struct frame *f;
395 /* Don't call XFlush when it is not safe to redisplay; the X
396 connection may be broken. */
397 if (!NILP (Vinhibit_redisplay))
398 return;
400 BLOCK_INPUT;
401 if (f == NULL)
403 Lisp_Object rest, frame;
404 FOR_EACH_FRAME (rest, frame)
405 if (FRAME_X_P (XFRAME (frame)))
406 x_flush (XFRAME (frame));
408 else if (FRAME_X_P (f))
409 XFlush (FRAME_X_DISPLAY (f));
410 UNBLOCK_INPUT;
414 /* Remove calls to XFlush by defining XFlush to an empty replacement.
415 Calls to XFlush should be unnecessary because the X output buffer
416 is flushed automatically as needed by calls to XPending,
417 XNextEvent, or XWindowEvent according to the XFlush man page.
418 XTread_socket calls XPending. Removing XFlush improves
419 performance. */
421 #define XFlush(DISPLAY) (void) 0
424 /***********************************************************************
425 Debugging
426 ***********************************************************************/
428 #if 0
430 /* This is a function useful for recording debugging information about
431 the sequence of occurrences in this file. */
433 struct record
435 char *locus;
436 int type;
439 struct record event_record[100];
441 int event_record_index;
443 record_event (locus, type)
444 char *locus;
445 int type;
447 if (event_record_index == sizeof (event_record) / sizeof (struct record))
448 event_record_index = 0;
450 event_record[event_record_index].locus = locus;
451 event_record[event_record_index].type = type;
452 event_record_index++;
455 #endif /* 0 */
459 /* Return the struct x_display_info corresponding to DPY. */
461 struct x_display_info *
462 x_display_info_for_display (dpy)
463 Display *dpy;
465 struct x_display_info *dpyinfo;
467 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
468 if (dpyinfo->display == dpy)
469 return dpyinfo;
471 return 0;
474 #define OPAQUE 0xffffffff
475 #define OPACITY "_NET_WM_WINDOW_OPACITY"
477 void
478 x_set_frame_alpha (f)
479 struct frame *f;
481 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
482 Display *dpy = FRAME_X_DISPLAY (f);
483 Window win = FRAME_OUTER_WINDOW (f);
484 double alpha = 1.0;
485 double alpha_min = 1.0;
486 unsigned long opac;
488 if (FRAME_X_DISPLAY_INFO (f)->root_window != FRAME_X_OUTPUT (f)->parent_desc)
489 /* Since the WM decoration lies under the FRAME_OUTER_WINDOW,
490 we must treat the former instead of the latter. */
491 win = FRAME_X_OUTPUT(f)->parent_desc;
493 if (dpyinfo->x_highlight_frame == f)
494 alpha = f->alpha[0];
495 else
496 alpha = f->alpha[1];
498 if (FLOATP (Vframe_alpha_lower_limit))
499 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
500 else if (INTEGERP (Vframe_alpha_lower_limit))
501 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
503 if (alpha < 0.0)
504 return;
505 else if (alpha > 1.0)
506 alpha = 1.0;
507 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
508 alpha = alpha_min;
510 opac = alpha * OPAQUE;
512 /* return unless necessary */
514 unsigned char *data;
515 Atom actual;
516 int rc, format;
517 unsigned long n, left;
519 x_catch_errors (dpy);
520 rc = XGetWindowProperty(dpy, win, XInternAtom(dpy, OPACITY, False),
521 0L, 1L, False, XA_CARDINAL,
522 &actual, &format, &n, &left,
523 &data);
525 if (rc == Success && actual != None)
526 if (*(unsigned long *)data == opac)
528 XFree ((void *) data);
529 x_uncatch_errors ();
530 return;
532 else
533 XFree ((void *) data);
534 x_uncatch_errors ();
537 x_catch_errors (dpy);
538 XChangeProperty (dpy, win, XInternAtom (dpy, OPACITY, False),
539 XA_CARDINAL, 32, PropModeReplace,
540 (unsigned char *) &opac, 1L);
541 x_uncatch_errors ();
545 x_display_pixel_height (dpyinfo)
546 struct x_display_info *dpyinfo;
548 return HeightOfScreen (dpyinfo->screen);
552 x_display_pixel_width (dpyinfo)
553 struct x_display_info *dpyinfo;
555 return WidthOfScreen (dpyinfo->screen);
559 /***********************************************************************
560 Starting and ending an update
561 ***********************************************************************/
563 /* Start an update of frame F. This function is installed as a hook
564 for update_begin, i.e. it is called when update_begin is called.
565 This function is called prior to calls to x_update_window_begin for
566 each window being updated. Currently, there is nothing to do here
567 because all interesting stuff is done on a window basis. */
569 static void
570 x_update_begin (f)
571 struct frame *f;
573 /* Nothing to do. */
577 /* Start update of window W. Set the global variable updated_window
578 to the window being updated and set output_cursor to the cursor
579 position of W. */
581 static void
582 x_update_window_begin (w)
583 struct window *w;
585 struct frame *f = XFRAME (WINDOW_FRAME (w));
586 struct x_display_info *display_info = FRAME_X_DISPLAY_INFO (f);
588 updated_window = w;
589 set_output_cursor (&w->cursor);
591 BLOCK_INPUT;
593 if (f == display_info->mouse_face_mouse_frame)
595 /* Don't do highlighting for mouse motion during the update. */
596 display_info->mouse_face_defer = 1;
598 /* If F needs to be redrawn, simply forget about any prior mouse
599 highlighting. */
600 if (FRAME_GARBAGED_P (f))
601 display_info->mouse_face_window = Qnil;
604 UNBLOCK_INPUT;
608 /* Draw a vertical window border from (x,y0) to (x,y1) */
610 static void
611 x_draw_vertical_window_border (w, x, y0, y1)
612 struct window *w;
613 int x, y0, y1;
615 struct frame *f = XFRAME (WINDOW_FRAME (w));
616 struct face *face;
618 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
619 if (face)
620 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
621 face->foreground);
623 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
624 f->output_data.x->normal_gc, x, y0, x, y1);
627 /* End update of window W (which is equal to updated_window).
629 Draw vertical borders between horizontally adjacent windows, and
630 display W's cursor if CURSOR_ON_P is non-zero.
632 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
633 glyphs in mouse-face were overwritten. In that case we have to
634 make sure that the mouse-highlight is properly redrawn.
636 W may be a menu bar pseudo-window in case we don't have X toolkit
637 support. Such windows don't have a cursor, so don't display it
638 here. */
640 static void
641 x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
642 struct window *w;
643 int cursor_on_p, mouse_face_overwritten_p;
645 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
647 if (!w->pseudo_window_p)
649 BLOCK_INPUT;
651 if (cursor_on_p)
652 display_and_set_cursor (w, 1, output_cursor.hpos,
653 output_cursor.vpos,
654 output_cursor.x, output_cursor.y);
656 if (draw_window_fringes (w, 1))
657 x_draw_vertical_border (w);
659 UNBLOCK_INPUT;
662 /* If a row with mouse-face was overwritten, arrange for
663 XTframe_up_to_date to redisplay the mouse highlight. */
664 if (mouse_face_overwritten_p)
666 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
667 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
668 dpyinfo->mouse_face_window = Qnil;
671 updated_window = NULL;
675 /* End update of frame F. This function is installed as a hook in
676 update_end. */
678 static void
679 x_update_end (f)
680 struct frame *f;
682 /* Mouse highlight may be displayed again. */
683 FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
685 #ifndef XFlush
686 BLOCK_INPUT;
687 XFlush (FRAME_X_DISPLAY (f));
688 UNBLOCK_INPUT;
689 #endif
693 /* This function is called from various places in xdisp.c whenever a
694 complete update has been performed. The global variable
695 updated_window is not available here. */
697 static void
698 XTframe_up_to_date (f)
699 struct frame *f;
701 if (FRAME_X_P (f))
703 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
705 if (dpyinfo->mouse_face_deferred_gc
706 || f == dpyinfo->mouse_face_mouse_frame)
708 BLOCK_INPUT;
709 if (dpyinfo->mouse_face_mouse_frame)
710 note_mouse_highlight (dpyinfo->mouse_face_mouse_frame,
711 dpyinfo->mouse_face_mouse_x,
712 dpyinfo->mouse_face_mouse_y);
713 dpyinfo->mouse_face_deferred_gc = 0;
714 UNBLOCK_INPUT;
720 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
721 arrow bitmaps, or clear the fringes if no bitmaps are required
722 before DESIRED_ROW is made current. The window being updated is
723 found in updated_window. This function It is called from
724 update_window_line only if it is known that there are differences
725 between bitmaps to be drawn between current row and DESIRED_ROW. */
727 static void
728 x_after_update_window_line (desired_row)
729 struct glyph_row *desired_row;
731 struct window *w = updated_window;
732 struct frame *f;
733 int width, height;
735 xassert (w);
737 if (!desired_row->mode_line_p && !w->pseudo_window_p)
738 desired_row->redraw_fringe_bitmaps_p = 1;
740 /* When a window has disappeared, make sure that no rest of
741 full-width rows stays visible in the internal border. Could
742 check here if updated_window is the leftmost/rightmost window,
743 but I guess it's not worth doing since vertically split windows
744 are almost never used, internal border is rarely set, and the
745 overhead is very small. */
746 if (windows_or_buffers_changed
747 && desired_row->full_width_p
748 && (f = XFRAME (w->frame),
749 width = FRAME_INTERNAL_BORDER_WIDTH (f),
750 width != 0)
751 && (height = desired_row->visible_height,
752 height > 0))
754 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
756 /* Internal border is drawn below the tool bar. */
757 if (WINDOWP (f->tool_bar_window)
758 && w == XWINDOW (f->tool_bar_window))
759 y -= width;
761 BLOCK_INPUT;
762 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
763 0, y, width, height, False);
764 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
765 FRAME_PIXEL_WIDTH (f) - width,
766 y, width, height, False);
767 UNBLOCK_INPUT;
771 static void
772 x_draw_fringe_bitmap (w, row, p)
773 struct window *w;
774 struct glyph_row *row;
775 struct draw_fringe_bitmap_params *p;
777 struct frame *f = XFRAME (WINDOW_FRAME (w));
778 Display *display = FRAME_X_DISPLAY (f);
779 Window window = FRAME_X_WINDOW (f);
780 GC gc = f->output_data.x->normal_gc;
781 struct face *face = p->face;
782 int rowY;
784 /* Must clip because of partially visible lines. */
785 rowY = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
786 if (p->y < rowY)
788 /* Adjust position of "bottom aligned" bitmap on partially
789 visible last row. */
790 int oldY = row->y;
791 int oldVH = row->visible_height;
792 row->visible_height = p->h;
793 row->y -= rowY - p->y;
794 x_clip_to_row (w, row, -1, gc);
795 row->y = oldY;
796 row->visible_height = oldVH;
798 else
799 x_clip_to_row (w, row, -1, gc);
801 if (!p->overlay_p)
803 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
805 /* In case the same realized face is used for fringes and
806 for something displayed in the text (e.g. face `region' on
807 mono-displays, the fill style may have been changed to
808 FillSolid in x_draw_glyph_string_background. */
809 if (face->stipple)
810 XSetFillStyle (display, face->gc, FillOpaqueStippled);
811 else
812 XSetForeground (display, face->gc, face->background);
814 #ifdef USE_TOOLKIT_SCROLL_BARS
815 /* If the fringe is adjacent to the left (right) scroll bar of a
816 leftmost (rightmost, respectively) window, then extend its
817 background to the gap between the fringe and the bar. */
818 if ((WINDOW_LEFTMOST_P (w)
819 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
820 || (WINDOW_RIGHTMOST_P (w)
821 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
823 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
825 if (sb_width > 0)
827 int left = WINDOW_SCROLL_BAR_AREA_X (w);
828 int width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
829 * FRAME_COLUMN_WIDTH (f));
831 if (bx < 0)
833 /* Bitmap fills the fringe. */
834 if (left + width == p->x)
835 bx = left + sb_width;
836 else if (p->x + p->wd == left)
837 bx = left;
838 if (bx >= 0)
840 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
842 nx = width - sb_width;
843 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
844 row->y));
845 ny = row->visible_height;
848 else
850 if (left + width == bx)
852 bx = left + sb_width;
853 nx += width - sb_width;
855 else if (bx + nx == left)
856 nx += width - sb_width;
860 #endif
861 if (bx >= 0 && nx > 0)
862 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
864 if (!face->stipple)
865 XSetForeground (display, face->gc, face->foreground);
868 if (p->which)
870 unsigned char *bits;
871 Pixmap pixmap, clipmask = (Pixmap) 0;
872 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
873 XGCValues gcv;
875 if (p->wd > 8)
876 bits = (unsigned char *)(p->bits + p->dh);
877 else
878 bits = (unsigned char *)p->bits + p->dh;
880 /* Draw the bitmap. I believe these small pixmaps can be cached
881 by the server. */
882 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
883 (p->cursor_p
884 ? (p->overlay_p ? face->background
885 : f->output_data.x->cursor_pixel)
886 : face->foreground),
887 face->background, depth);
889 if (p->overlay_p)
891 clipmask = XCreatePixmapFromBitmapData (display,
892 FRAME_X_DISPLAY_INFO (f)->root_window,
893 bits, p->wd, p->h,
894 1, 0, 1);
895 gcv.clip_mask = clipmask;
896 gcv.clip_x_origin = p->x;
897 gcv.clip_y_origin = p->y;
898 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
901 XCopyArea (display, pixmap, window, gc, 0, 0,
902 p->wd, p->h, p->x, p->y);
903 XFreePixmap (display, pixmap);
905 if (p->overlay_p)
907 gcv.clip_mask = (Pixmap) 0;
908 XChangeGC (display, gc, GCClipMask, &gcv);
909 XFreePixmap (display, clipmask);
913 XSetClipMask (display, gc, None);
918 /* This is called when starting Emacs and when restarting after
919 suspend. When starting Emacs, no X window is mapped. And nothing
920 must be done to Emacs's own window if it is suspended (though that
921 rarely happens). */
923 static void
924 XTset_terminal_modes (struct terminal *terminal)
928 /* This is called when exiting or suspending Emacs. Exiting will make
929 the X-windows go away, and suspending requires no action. */
931 static void
932 XTreset_terminal_modes (struct terminal *terminal)
937 /***********************************************************************
938 Glyph display
939 ***********************************************************************/
943 static void x_set_glyph_string_clipping P_ ((struct glyph_string *));
944 static void x_set_glyph_string_gc P_ ((struct glyph_string *));
945 static void x_draw_glyph_string_background P_ ((struct glyph_string *,
946 int));
947 static void x_draw_glyph_string_foreground P_ ((struct glyph_string *));
948 static void x_draw_composite_glyph_string_foreground P_ ((struct glyph_string *));
949 static void x_draw_glyph_string_box P_ ((struct glyph_string *));
950 static void x_draw_glyph_string P_ ((struct glyph_string *));
951 static void x_compute_glyph_string_overhangs P_ ((struct glyph_string *));
952 static void x_set_cursor_gc P_ ((struct glyph_string *));
953 static void x_set_mode_line_face_gc P_ ((struct glyph_string *));
954 static void x_set_mouse_face_gc P_ ((struct glyph_string *));
955 static int x_alloc_lighter_color P_ ((struct frame *, Display *, Colormap,
956 unsigned long *, double, int));
957 static void x_setup_relief_color P_ ((struct frame *, struct relief *,
958 double, int, unsigned long));
959 static void x_setup_relief_colors P_ ((struct glyph_string *));
960 static void x_draw_image_glyph_string P_ ((struct glyph_string *));
961 static void x_draw_image_relief P_ ((struct glyph_string *));
962 static void x_draw_image_foreground P_ ((struct glyph_string *));
963 static void x_draw_image_foreground_1 P_ ((struct glyph_string *, Pixmap));
964 static void x_clear_glyph_string_rect P_ ((struct glyph_string *, int,
965 int, int, int));
966 static void x_draw_relief_rect P_ ((struct frame *, int, int, int, int,
967 int, int, int, int, int, int,
968 XRectangle *));
969 static void x_draw_box_rect P_ ((struct glyph_string *, int, int, int, int,
970 int, int, int, XRectangle *));
972 #if GLYPH_DEBUG
973 static void x_check_font P_ ((struct frame *, struct font *));
974 #endif
977 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
978 face. */
980 static void
981 x_set_cursor_gc (s)
982 struct glyph_string *s;
984 if (s->font == FRAME_FONT (s->f)
985 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
986 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
987 && !s->cmp)
988 s->gc = s->f->output_data.x->cursor_gc;
989 else
991 /* Cursor on non-default face: must merge. */
992 XGCValues xgcv;
993 unsigned long mask;
995 xgcv.background = s->f->output_data.x->cursor_pixel;
996 xgcv.foreground = s->face->background;
998 /* If the glyph would be invisible, try a different foreground. */
999 if (xgcv.foreground == xgcv.background)
1000 xgcv.foreground = s->face->foreground;
1001 if (xgcv.foreground == xgcv.background)
1002 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
1003 if (xgcv.foreground == xgcv.background)
1004 xgcv.foreground = s->face->foreground;
1006 /* Make sure the cursor is distinct from text in this face. */
1007 if (xgcv.background == s->face->background
1008 && xgcv.foreground == s->face->foreground)
1010 xgcv.background = s->face->foreground;
1011 xgcv.foreground = s->face->background;
1014 IF_DEBUG (x_check_font (s->f, s->font));
1015 xgcv.graphics_exposures = False;
1016 mask = GCForeground | GCBackground | GCGraphicsExposures;
1018 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1019 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1020 mask, &xgcv);
1021 else
1022 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1023 = XCreateGC (s->display, s->window, mask, &xgcv);
1025 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1030 /* Set up S->gc of glyph string S for drawing text in mouse face. */
1032 static void
1033 x_set_mouse_face_gc (s)
1034 struct glyph_string *s;
1036 int face_id;
1037 struct face *face;
1039 /* What face has to be used last for the mouse face? */
1040 face_id = FRAME_X_DISPLAY_INFO (s->f)->mouse_face_face_id;
1041 face = FACE_FROM_ID (s->f, face_id);
1042 if (face == NULL)
1043 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
1045 if (s->first_glyph->type == CHAR_GLYPH)
1046 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1047 else
1048 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1049 s->face = FACE_FROM_ID (s->f, face_id);
1050 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1052 if (s->font == s->face->font)
1053 s->gc = s->face->gc;
1054 else
1056 /* Otherwise construct scratch_cursor_gc with values from FACE
1057 except for FONT. */
1058 XGCValues xgcv;
1059 unsigned long mask;
1061 xgcv.background = s->face->background;
1062 xgcv.foreground = s->face->foreground;
1063 xgcv.graphics_exposures = False;
1064 mask = GCForeground | GCBackground | GCGraphicsExposures;
1066 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1067 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1068 mask, &xgcv);
1069 else
1070 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1071 = XCreateGC (s->display, s->window, mask, &xgcv);
1073 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1076 xassert (s->gc != 0);
1080 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1081 Faces to use in the mode line have already been computed when the
1082 matrix was built, so there isn't much to do, here. */
1084 static INLINE void
1085 x_set_mode_line_face_gc (s)
1086 struct glyph_string *s;
1088 s->gc = s->face->gc;
1092 /* Set S->gc of glyph string S for drawing that glyph string. Set
1093 S->stippled_p to a non-zero value if the face of S has a stipple
1094 pattern. */
1096 static INLINE void
1097 x_set_glyph_string_gc (s)
1098 struct glyph_string *s;
1100 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1102 if (s->hl == DRAW_NORMAL_TEXT)
1104 s->gc = s->face->gc;
1105 s->stippled_p = s->face->stipple != 0;
1107 else if (s->hl == DRAW_INVERSE_VIDEO)
1109 x_set_mode_line_face_gc (s);
1110 s->stippled_p = s->face->stipple != 0;
1112 else if (s->hl == DRAW_CURSOR)
1114 x_set_cursor_gc (s);
1115 s->stippled_p = 0;
1117 else if (s->hl == DRAW_MOUSE_FACE)
1119 x_set_mouse_face_gc (s);
1120 s->stippled_p = s->face->stipple != 0;
1122 else if (s->hl == DRAW_IMAGE_RAISED
1123 || s->hl == DRAW_IMAGE_SUNKEN)
1125 s->gc = s->face->gc;
1126 s->stippled_p = s->face->stipple != 0;
1128 else
1130 s->gc = s->face->gc;
1131 s->stippled_p = s->face->stipple != 0;
1134 /* GC must have been set. */
1135 xassert (s->gc != 0);
1139 /* Set clipping for output of glyph string S. S may be part of a mode
1140 line or menu if we don't have X toolkit support. */
1142 static INLINE void
1143 x_set_glyph_string_clipping (s)
1144 struct glyph_string *s;
1146 XRectangle *r = s->clip;
1147 int n = get_glyph_string_clip_rects (s, r, 2);
1149 if (n > 0)
1150 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1151 s->num_clips = n;
1155 /* Set SRC's clipping for output of glyph string DST. This is called
1156 when we are drawing DST's left_overhang or right_overhang only in
1157 the area of SRC. */
1159 static void
1160 x_set_glyph_string_clipping_exactly (src, dst)
1161 struct glyph_string *src, *dst;
1163 XRectangle r;
1165 r.x = src->x;
1166 r.width = src->width;
1167 r.y = src->y;
1168 r.height = src->height;
1169 dst->clip[0] = r;
1170 dst->num_clips = 1;
1171 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1175 /* RIF:
1176 Compute left and right overhang of glyph string S. */
1178 static void
1179 x_compute_glyph_string_overhangs (s)
1180 struct glyph_string *s;
1182 if (s->cmp == NULL
1183 && (s->first_glyph->type == CHAR_GLYPH
1184 || s->first_glyph->type == COMPOSITE_GLYPH))
1186 struct font_metrics metrics;
1188 if (s->first_glyph->type == CHAR_GLYPH)
1190 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1191 struct font *font = s->font;
1192 int i;
1194 for (i = 0; i < s->nchars; i++)
1195 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1196 font->driver->text_extents (font, code, s->nchars, &metrics);
1198 else
1200 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1202 composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
1204 s->right_overhang = (metrics.rbearing > metrics.width
1205 ? metrics.rbearing - metrics.width : 0);
1206 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1208 else if (s->cmp)
1210 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1211 s->left_overhang = - s->cmp->lbearing;
1216 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1218 static INLINE void
1219 x_clear_glyph_string_rect (s, x, y, w, h)
1220 struct glyph_string *s;
1221 int x, y, w, h;
1223 XGCValues xgcv;
1224 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1225 XSetForeground (s->display, s->gc, xgcv.background);
1226 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1227 XSetForeground (s->display, s->gc, xgcv.foreground);
1231 /* Draw the background of glyph_string S. If S->background_filled_p
1232 is non-zero don't draw it. FORCE_P non-zero means draw the
1233 background even if it wouldn't be drawn normally. This is used
1234 when a string preceding S draws into the background of S, or S
1235 contains the first component of a composition. */
1237 static void
1238 x_draw_glyph_string_background (s, force_p)
1239 struct glyph_string *s;
1240 int force_p;
1242 /* Nothing to do if background has already been drawn or if it
1243 shouldn't be drawn in the first place. */
1244 if (!s->background_filled_p)
1246 int box_line_width = max (s->face->box_line_width, 0);
1248 if (s->stippled_p)
1250 /* Fill background with a stipple pattern. */
1251 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1252 XFillRectangle (s->display, s->window, s->gc, s->x,
1253 s->y + box_line_width,
1254 s->background_width,
1255 s->height - 2 * box_line_width);
1256 XSetFillStyle (s->display, s->gc, FillSolid);
1257 s->background_filled_p = 1;
1259 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1260 || s->font_not_found_p
1261 || s->extends_to_end_of_line_p
1262 || force_p)
1264 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1265 s->background_width,
1266 s->height - 2 * box_line_width);
1267 s->background_filled_p = 1;
1273 /* Draw the foreground of glyph string S. */
1275 static void
1276 x_draw_glyph_string_foreground (s)
1277 struct glyph_string *s;
1279 int i, x;
1281 /* If first glyph of S has a left box line, start drawing the text
1282 of S to the right of that box line. */
1283 if (s->face->box != FACE_NO_BOX
1284 && s->first_glyph->left_box_line_p)
1285 x = s->x + eabs (s->face->box_line_width);
1286 else
1287 x = s->x;
1289 /* Draw characters of S as rectangles if S's font could not be
1290 loaded. */
1291 if (s->font_not_found_p)
1293 for (i = 0; i < s->nchars; ++i)
1295 struct glyph *g = s->first_glyph + i;
1296 XDrawRectangle (s->display, s->window,
1297 s->gc, x, s->y, g->pixel_width - 1,
1298 s->height - 1);
1299 x += g->pixel_width;
1302 else
1304 struct font *font = s->font;
1305 int boff = font->baseline_offset;
1306 int y;
1308 if (font->vertical_centering)
1309 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1311 y = s->ybase - boff;
1312 if (s->for_overlaps
1313 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1314 font->driver->draw (s, 0, s->nchars, x, y, 0);
1315 else
1316 font->driver->draw (s, 0, s->nchars, x, y, 1);
1317 if (s->face->overstrike)
1318 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1322 /* Draw the foreground of composite glyph string S. */
1324 static void
1325 x_draw_composite_glyph_string_foreground (s)
1326 struct glyph_string *s;
1328 int i, j, x;
1329 struct font *font = s->font;
1331 /* If first glyph of S has a left box line, start drawing the text
1332 of S to the right of that box line. */
1333 if (s->face && s->face->box != FACE_NO_BOX
1334 && s->first_glyph->left_box_line_p)
1335 x = s->x + eabs (s->face->box_line_width);
1336 else
1337 x = s->x;
1339 /* S is a glyph string for a composition. S->cmp_from is the index
1340 of the first character drawn for glyphs of this composition.
1341 S->cmp_from == 0 means we are drawing the very first character of
1342 this composition. */
1344 /* Draw a rectangle for the composition if the font for the very
1345 first character of the composition could not be loaded. */
1346 if (s->font_not_found_p)
1348 if (s->cmp_from == 0)
1349 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1350 s->width - 1, s->height - 1);
1352 else if (! s->first_glyph->u.cmp.automatic)
1354 int y = s->ybase;
1356 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1357 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1359 int xx = x + s->cmp->offsets[j * 2];
1360 int yy = y - s->cmp->offsets[j * 2 + 1];
1362 font->driver->draw (s, j, j + 1, xx, yy, 0);
1363 if (s->face->overstrike)
1364 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1367 else
1369 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1370 Lisp_Object glyph;
1371 int y = s->ybase;
1372 int width = 0;
1374 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1376 glyph = LGSTRING_GLYPH (gstring, i);
1377 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1378 width += LGLYPH_WIDTH (glyph);
1379 else
1381 int xoff, yoff, wadjust;
1383 if (j < i)
1385 font->driver->draw (s, j, i, x, y, 0);
1386 x += width;
1388 xoff = LGLYPH_XOFF (glyph);
1389 yoff = LGLYPH_YOFF (glyph);
1390 wadjust = LGLYPH_WADJUST (glyph);
1391 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1392 x += wadjust;
1393 j = i + 1;
1394 width = 0;
1397 if (j < i)
1398 font->driver->draw (s, j, i, x, y, 0);
1403 #ifdef USE_X_TOOLKIT
1405 static struct frame *x_frame_of_widget P_ ((Widget));
1406 static Boolean cvt_string_to_pixel P_ ((Display *, XrmValue *, Cardinal *,
1407 XrmValue *, XrmValue *, XtPointer *));
1408 static void cvt_pixel_dtor P_ ((XtAppContext, XrmValue *, XtPointer,
1409 XrmValue *, Cardinal *));
1412 /* Return the frame on which widget WIDGET is used.. Abort if frame
1413 cannot be determined. */
1415 static struct frame *
1416 x_frame_of_widget (widget)
1417 Widget widget;
1419 struct x_display_info *dpyinfo;
1420 Lisp_Object tail;
1421 struct frame *f;
1423 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1425 /* Find the top-level shell of the widget. Note that this function
1426 can be called when the widget is not yet realized, so XtWindow
1427 (widget) == 0. That's the reason we can't simply use
1428 x_any_window_to_frame. */
1429 while (!XtIsTopLevelShell (widget))
1430 widget = XtParent (widget);
1432 /* Look for a frame with that top-level widget. Allocate the color
1433 on that frame to get the right gamma correction value. */
1434 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1435 if (FRAMEP (XCAR (tail))
1436 && (f = XFRAME (XCAR (tail)),
1437 (FRAME_X_P (f)
1438 && f->output_data.nothing != 1
1439 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1440 && f->output_data.x->widget == widget)
1441 return f;
1443 abort ();
1447 /* Allocate the color COLOR->pixel on the screen and display of
1448 widget WIDGET in colormap CMAP. If an exact match cannot be
1449 allocated, try the nearest color available. Value is non-zero
1450 if successful. This is called from lwlib. */
1453 x_alloc_nearest_color_for_widget (widget, cmap, color)
1454 Widget widget;
1455 Colormap cmap;
1456 XColor *color;
1458 struct frame *f = x_frame_of_widget (widget);
1459 return x_alloc_nearest_color (f, cmap, color);
1463 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1464 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1465 If this produces the same color as PIXEL, try a color where all RGB
1466 values have DELTA added. Return the allocated color in *PIXEL.
1467 DISPLAY is the X display, CMAP is the colormap to operate on.
1468 Value is non-zero if successful. */
1471 x_alloc_lighter_color_for_widget (widget, display, cmap, pixel, factor, delta)
1472 Widget widget;
1473 Display *display;
1474 Colormap cmap;
1475 unsigned long *pixel;
1476 double factor;
1477 int delta;
1479 struct frame *f = x_frame_of_widget (widget);
1480 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1484 /* Structure specifying which arguments should be passed by Xt to
1485 cvt_string_to_pixel. We want the widget's screen and colormap. */
1487 static XtConvertArgRec cvt_string_to_pixel_args[] =
1489 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1490 sizeof (Screen *)},
1491 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1492 sizeof (Colormap)}
1496 /* The address of this variable is returned by
1497 cvt_string_to_pixel. */
1499 static Pixel cvt_string_to_pixel_value;
1502 /* Convert a color name to a pixel color.
1504 DPY is the display we are working on.
1506 ARGS is an array of *NARGS XrmValue structures holding additional
1507 information about the widget for which the conversion takes place.
1508 The contents of this array are determined by the specification
1509 in cvt_string_to_pixel_args.
1511 FROM is a pointer to an XrmValue which points to the color name to
1512 convert. TO is an XrmValue in which to return the pixel color.
1514 CLOSURE_RET is a pointer to user-data, in which we record if
1515 we allocated the color or not.
1517 Value is True if successful, False otherwise. */
1519 static Boolean
1520 cvt_string_to_pixel (dpy, args, nargs, from, to, closure_ret)
1521 Display *dpy;
1522 XrmValue *args;
1523 Cardinal *nargs;
1524 XrmValue *from, *to;
1525 XtPointer *closure_ret;
1527 Screen *screen;
1528 Colormap cmap;
1529 Pixel pixel;
1530 String color_name;
1531 XColor color;
1533 if (*nargs != 2)
1535 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1536 "wrongParameters", "cvt_string_to_pixel",
1537 "XtToolkitError",
1538 "Screen and colormap args required", NULL, NULL);
1539 return False;
1542 screen = *(Screen **) args[0].addr;
1543 cmap = *(Colormap *) args[1].addr;
1544 color_name = (String) from->addr;
1546 if (strcmp (color_name, XtDefaultBackground) == 0)
1548 *closure_ret = (XtPointer) False;
1549 pixel = WhitePixelOfScreen (screen);
1551 else if (strcmp (color_name, XtDefaultForeground) == 0)
1553 *closure_ret = (XtPointer) False;
1554 pixel = BlackPixelOfScreen (screen);
1556 else if (XParseColor (dpy, cmap, color_name, &color)
1557 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1559 pixel = color.pixel;
1560 *closure_ret = (XtPointer) True;
1562 else
1564 String params[1];
1565 Cardinal nparams = 1;
1567 params[0] = color_name;
1568 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1569 "badValue", "cvt_string_to_pixel",
1570 "XtToolkitError", "Invalid color `%s'",
1571 params, &nparams);
1572 return False;
1575 if (to->addr != NULL)
1577 if (to->size < sizeof (Pixel))
1579 to->size = sizeof (Pixel);
1580 return False;
1583 *(Pixel *) to->addr = pixel;
1585 else
1587 cvt_string_to_pixel_value = pixel;
1588 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1591 to->size = sizeof (Pixel);
1592 return True;
1596 /* Free a pixel color which was previously allocated via
1597 cvt_string_to_pixel. This is registered as the destructor
1598 for this type of resource via XtSetTypeConverter.
1600 APP is the application context in which we work.
1602 TO is a pointer to an XrmValue holding the color to free.
1603 CLOSURE is the value we stored in CLOSURE_RET for this color
1604 in cvt_string_to_pixel.
1606 ARGS and NARGS are like for cvt_string_to_pixel. */
1608 static void
1609 cvt_pixel_dtor (app, to, closure, args, nargs)
1610 XtAppContext app;
1611 XrmValuePtr to;
1612 XtPointer closure;
1613 XrmValuePtr args;
1614 Cardinal *nargs;
1616 if (*nargs != 2)
1618 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1619 "XtToolkitError",
1620 "Screen and colormap arguments required",
1621 NULL, NULL);
1623 else if (closure != NULL)
1625 /* We did allocate the pixel, so free it. */
1626 Screen *screen = *(Screen **) args[0].addr;
1627 Colormap cmap = *(Colormap *) args[1].addr;
1628 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1629 (Pixel *) to->addr, 1);
1634 #endif /* USE_X_TOOLKIT */
1637 /* Value is an array of XColor structures for the contents of the
1638 color map of display DPY. Set *NCELLS to the size of the array.
1639 Note that this probably shouldn't be called for large color maps,
1640 say a 24-bit TrueColor map. */
1642 static const XColor *
1643 x_color_cells (dpy, ncells)
1644 Display *dpy;
1645 int *ncells;
1647 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1649 if (dpyinfo->color_cells == NULL)
1651 Screen *screen = dpyinfo->screen;
1652 int i;
1654 dpyinfo->ncolor_cells
1655 = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1656 dpyinfo->color_cells
1657 = (XColor *) xmalloc (dpyinfo->ncolor_cells
1658 * sizeof *dpyinfo->color_cells);
1660 for (i = 0; i < dpyinfo->ncolor_cells; ++i)
1661 dpyinfo->color_cells[i].pixel = i;
1663 XQueryColors (dpy, dpyinfo->cmap,
1664 dpyinfo->color_cells, dpyinfo->ncolor_cells);
1667 *ncells = dpyinfo->ncolor_cells;
1668 return dpyinfo->color_cells;
1672 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1673 colors in COLORS. Use cached information, if available. */
1675 void
1676 x_query_colors (f, colors, ncolors)
1677 struct frame *f;
1678 XColor *colors;
1679 int ncolors;
1681 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1683 if (dpyinfo->color_cells)
1685 int i;
1686 for (i = 0; i < ncolors; ++i)
1688 unsigned long pixel = colors[i].pixel;
1689 xassert (pixel < dpyinfo->ncolor_cells);
1690 xassert (dpyinfo->color_cells[pixel].pixel == pixel);
1691 colors[i] = dpyinfo->color_cells[pixel];
1694 else
1695 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1699 /* On frame F, translate pixel color to RGB values for the color in
1700 COLOR. Use cached information, if available. */
1702 void
1703 x_query_color (f, color)
1704 struct frame *f;
1705 XColor *color;
1707 x_query_colors (f, color, 1);
1711 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1712 exact match can't be allocated, try the nearest color available.
1713 Value is non-zero if successful. Set *COLOR to the color
1714 allocated. */
1716 static int
1717 x_alloc_nearest_color_1 (dpy, cmap, color)
1718 Display *dpy;
1719 Colormap cmap;
1720 XColor *color;
1722 int rc;
1724 rc = XAllocColor (dpy, cmap, color);
1725 if (rc == 0)
1727 /* If we got to this point, the colormap is full, so we're going
1728 to try to get the next closest color. The algorithm used is
1729 a least-squares matching, which is what X uses for closest
1730 color matching with StaticColor visuals. */
1731 int nearest, i;
1732 unsigned long nearest_delta = ~0;
1733 int ncells;
1734 const XColor *cells = x_color_cells (dpy, &ncells);
1736 for (nearest = i = 0; i < ncells; ++i)
1738 long dred = (color->red >> 8) - (cells[i].red >> 8);
1739 long dgreen = (color->green >> 8) - (cells[i].green >> 8);
1740 long dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1741 unsigned long delta = dred * dred + dgreen * dgreen + dblue * dblue;
1743 if (delta < nearest_delta)
1745 nearest = i;
1746 nearest_delta = delta;
1750 color->red = cells[nearest].red;
1751 color->green = cells[nearest].green;
1752 color->blue = cells[nearest].blue;
1753 rc = XAllocColor (dpy, cmap, color);
1755 else
1757 /* If allocation succeeded, and the allocated pixel color is not
1758 equal to a cached pixel color recorded earlier, there was a
1759 change in the colormap, so clear the color cache. */
1760 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1761 XColor *cached_color;
1763 if (dpyinfo->color_cells
1764 && (cached_color = &dpyinfo->color_cells[color->pixel],
1765 (cached_color->red != color->red
1766 || cached_color->blue != color->blue
1767 || cached_color->green != color->green)))
1769 xfree (dpyinfo->color_cells);
1770 dpyinfo->color_cells = NULL;
1771 dpyinfo->ncolor_cells = 0;
1775 #ifdef DEBUG_X_COLORS
1776 if (rc)
1777 register_color (color->pixel);
1778 #endif /* DEBUG_X_COLORS */
1780 return rc;
1784 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1785 exact match can't be allocated, try the nearest color available.
1786 Value is non-zero if successful. Set *COLOR to the color
1787 allocated. */
1790 x_alloc_nearest_color (f, cmap, color)
1791 struct frame *f;
1792 Colormap cmap;
1793 XColor *color;
1795 gamma_correct (f, color);
1796 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1800 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1801 It's necessary to do this instead of just using PIXEL directly to
1802 get color reference counts right. */
1804 unsigned long
1805 x_copy_color (f, pixel)
1806 struct frame *f;
1807 unsigned long pixel;
1809 XColor color;
1811 color.pixel = pixel;
1812 BLOCK_INPUT;
1813 x_query_color (f, &color);
1814 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1815 UNBLOCK_INPUT;
1816 #ifdef DEBUG_X_COLORS
1817 register_color (pixel);
1818 #endif
1819 return color.pixel;
1823 /* Allocate color PIXEL on display DPY. PIXEL must already be allocated.
1824 It's necessary to do this instead of just using PIXEL directly to
1825 get color reference counts right. */
1827 unsigned long
1828 x_copy_dpy_color (dpy, cmap, pixel)
1829 Display *dpy;
1830 Colormap cmap;
1831 unsigned long pixel;
1833 XColor color;
1835 color.pixel = pixel;
1836 BLOCK_INPUT;
1837 XQueryColor (dpy, cmap, &color);
1838 XAllocColor (dpy, cmap, &color);
1839 UNBLOCK_INPUT;
1840 #ifdef DEBUG_X_COLORS
1841 register_color (pixel);
1842 #endif
1843 return color.pixel;
1847 /* Brightness beyond which a color won't have its highlight brightness
1848 boosted.
1850 Nominally, highlight colors for `3d' faces are calculated by
1851 brightening an object's color by a constant scale factor, but this
1852 doesn't yield good results for dark colors, so for colors who's
1853 brightness is less than this value (on a scale of 0-65535) have an
1854 use an additional additive factor.
1856 The value here is set so that the default menu-bar/mode-line color
1857 (grey75) will not have its highlights changed at all. */
1858 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1861 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1862 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1863 If this produces the same color as PIXEL, try a color where all RGB
1864 values have DELTA added. Return the allocated color in *PIXEL.
1865 DISPLAY is the X display, CMAP is the colormap to operate on.
1866 Value is non-zero if successful. */
1868 static int
1869 x_alloc_lighter_color (f, display, cmap, pixel, factor, delta)
1870 struct frame *f;
1871 Display *display;
1872 Colormap cmap;
1873 unsigned long *pixel;
1874 double factor;
1875 int delta;
1877 XColor color, new;
1878 long bright;
1879 int success_p;
1881 /* Get RGB color values. */
1882 color.pixel = *pixel;
1883 x_query_color (f, &color);
1885 /* Change RGB values by specified FACTOR. Avoid overflow! */
1886 xassert (factor >= 0);
1887 new.red = min (0xffff, factor * color.red);
1888 new.green = min (0xffff, factor * color.green);
1889 new.blue = min (0xffff, factor * color.blue);
1891 /* Calculate brightness of COLOR. */
1892 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1894 /* We only boost colors that are darker than
1895 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1896 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1897 /* Make an additive adjustment to NEW, because it's dark enough so
1898 that scaling by FACTOR alone isn't enough. */
1900 /* How far below the limit this color is (0 - 1, 1 being darker). */
1901 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1902 /* The additive adjustment. */
1903 int min_delta = delta * dimness * factor / 2;
1905 if (factor < 1)
1907 new.red = max (0, new.red - min_delta);
1908 new.green = max (0, new.green - min_delta);
1909 new.blue = max (0, new.blue - min_delta);
1911 else
1913 new.red = min (0xffff, min_delta + new.red);
1914 new.green = min (0xffff, min_delta + new.green);
1915 new.blue = min (0xffff, min_delta + new.blue);
1919 /* Try to allocate the color. */
1920 success_p = x_alloc_nearest_color (f, cmap, &new);
1921 if (success_p)
1923 if (new.pixel == *pixel)
1925 /* If we end up with the same color as before, try adding
1926 delta to the RGB values. */
1927 x_free_colors (f, &new.pixel, 1);
1929 new.red = min (0xffff, delta + color.red);
1930 new.green = min (0xffff, delta + color.green);
1931 new.blue = min (0xffff, delta + color.blue);
1932 success_p = x_alloc_nearest_color (f, cmap, &new);
1934 else
1935 success_p = 1;
1936 *pixel = new.pixel;
1939 return success_p;
1943 /* Set up the foreground color for drawing relief lines of glyph
1944 string S. RELIEF is a pointer to a struct relief containing the GC
1945 with which lines will be drawn. Use a color that is FACTOR or
1946 DELTA lighter or darker than the relief's background which is found
1947 in S->f->output_data.x->relief_background. If such a color cannot
1948 be allocated, use DEFAULT_PIXEL, instead. */
1950 static void
1951 x_setup_relief_color (f, relief, factor, delta, default_pixel)
1952 struct frame *f;
1953 struct relief *relief;
1954 double factor;
1955 int delta;
1956 unsigned long default_pixel;
1958 XGCValues xgcv;
1959 struct x_output *di = f->output_data.x;
1960 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1961 unsigned long pixel;
1962 unsigned long background = di->relief_background;
1963 Colormap cmap = FRAME_X_COLORMAP (f);
1964 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1965 Display *dpy = FRAME_X_DISPLAY (f);
1967 xgcv.graphics_exposures = False;
1968 xgcv.line_width = 1;
1970 /* Free previously allocated color. The color cell will be reused
1971 when it has been freed as many times as it was allocated, so this
1972 doesn't affect faces using the same colors. */
1973 if (relief->gc
1974 && relief->allocated_p)
1976 x_free_colors (f, &relief->pixel, 1);
1977 relief->allocated_p = 0;
1980 /* Allocate new color. */
1981 xgcv.foreground = default_pixel;
1982 pixel = background;
1983 if (dpyinfo->n_planes != 1
1984 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1986 relief->allocated_p = 1;
1987 xgcv.foreground = relief->pixel = pixel;
1990 if (relief->gc == 0)
1992 xgcv.stipple = dpyinfo->gray;
1993 mask |= GCStipple;
1994 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1996 else
1997 XChangeGC (dpy, relief->gc, mask, &xgcv);
2001 /* Set up colors for the relief lines around glyph string S. */
2003 static void
2004 x_setup_relief_colors (s)
2005 struct glyph_string *s;
2007 struct x_output *di = s->f->output_data.x;
2008 unsigned long color;
2010 if (s->face->use_box_color_for_shadows_p)
2011 color = s->face->box_color;
2012 else if (s->first_glyph->type == IMAGE_GLYPH
2013 && s->img->pixmap
2014 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2015 color = IMAGE_BACKGROUND (s->img, s->f, 0);
2016 else
2018 XGCValues xgcv;
2020 /* Get the background color of the face. */
2021 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
2022 color = xgcv.background;
2025 if (di->white_relief.gc == 0
2026 || color != di->relief_background)
2028 di->relief_background = color;
2029 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
2030 WHITE_PIX_DEFAULT (s->f));
2031 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
2032 BLACK_PIX_DEFAULT (s->f));
2037 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
2038 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
2039 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
2040 relief. LEFT_P non-zero means draw a relief on the left side of
2041 the rectangle. RIGHT_P non-zero means draw a relief on the right
2042 side of the rectangle. CLIP_RECT is the clipping rectangle to use
2043 when drawing. */
2045 static void
2046 x_draw_relief_rect (f, left_x, top_y, right_x, bottom_y, width,
2047 raised_p, top_p, bot_p, left_p, right_p, clip_rect)
2048 struct frame *f;
2049 int left_x, top_y, right_x, bottom_y, width;
2050 int top_p, bot_p, left_p, right_p, raised_p;
2051 XRectangle *clip_rect;
2053 Display *dpy = FRAME_X_DISPLAY (f);
2054 Window window = FRAME_X_WINDOW (f);
2055 int i;
2056 GC gc;
2058 if (raised_p)
2059 gc = f->output_data.x->white_relief.gc;
2060 else
2061 gc = f->output_data.x->black_relief.gc;
2062 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2064 /* Top. */
2065 if (top_p)
2066 for (i = 0; i < width; ++i)
2067 XDrawLine (dpy, window, gc,
2068 left_x + i * left_p, top_y + i,
2069 right_x + 1 - i * right_p, top_y + i);
2071 /* Left. */
2072 if (left_p)
2073 for (i = 0; i < width; ++i)
2074 XDrawLine (dpy, window, gc,
2075 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
2077 XSetClipMask (dpy, gc, None);
2078 if (raised_p)
2079 gc = f->output_data.x->black_relief.gc;
2080 else
2081 gc = f->output_data.x->white_relief.gc;
2082 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2084 /* Bottom. */
2085 if (bot_p)
2086 for (i = 0; i < width; ++i)
2087 XDrawLine (dpy, window, gc,
2088 left_x + i * left_p, bottom_y - i,
2089 right_x + 1 - i * right_p, bottom_y - i);
2091 /* Right. */
2092 if (right_p)
2093 for (i = 0; i < width; ++i)
2094 XDrawLine (dpy, window, gc,
2095 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
2097 XSetClipMask (dpy, gc, None);
2101 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2102 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2103 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2104 left side of the rectangle. RIGHT_P non-zero means draw a line
2105 on the right side of the rectangle. CLIP_RECT is the clipping
2106 rectangle to use when drawing. */
2108 static void
2109 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2110 left_p, right_p, clip_rect)
2111 struct glyph_string *s;
2112 int left_x, top_y, right_x, bottom_y, width, left_p, right_p;
2113 XRectangle *clip_rect;
2115 XGCValues xgcv;
2117 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2118 XSetForeground (s->display, s->gc, s->face->box_color);
2119 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2121 /* Top. */
2122 XFillRectangle (s->display, s->window, s->gc,
2123 left_x, top_y, right_x - left_x + 1, width);
2125 /* Left. */
2126 if (left_p)
2127 XFillRectangle (s->display, s->window, s->gc,
2128 left_x, top_y, width, bottom_y - top_y + 1);
2130 /* Bottom. */
2131 XFillRectangle (s->display, s->window, s->gc,
2132 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2134 /* Right. */
2135 if (right_p)
2136 XFillRectangle (s->display, s->window, s->gc,
2137 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2139 XSetForeground (s->display, s->gc, xgcv.foreground);
2140 XSetClipMask (s->display, s->gc, None);
2144 /* Draw a box around glyph string S. */
2146 static void
2147 x_draw_glyph_string_box (s)
2148 struct glyph_string *s;
2150 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2151 int left_p, right_p;
2152 struct glyph *last_glyph;
2153 XRectangle clip_rect;
2155 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2156 ? WINDOW_RIGHT_EDGE_X (s->w)
2157 : window_box_right (s->w, s->area));
2159 /* The glyph that may have a right box line. */
2160 last_glyph = (s->cmp || s->img
2161 ? s->first_glyph
2162 : s->first_glyph + s->nchars - 1);
2164 width = eabs (s->face->box_line_width);
2165 raised_p = s->face->box == FACE_RAISED_BOX;
2166 left_x = s->x;
2167 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2168 ? last_x - 1
2169 : min (last_x, s->x + s->background_width) - 1);
2170 top_y = s->y;
2171 bottom_y = top_y + s->height - 1;
2173 left_p = (s->first_glyph->left_box_line_p
2174 || (s->hl == DRAW_MOUSE_FACE
2175 && (s->prev == NULL
2176 || s->prev->hl != s->hl)));
2177 right_p = (last_glyph->right_box_line_p
2178 || (s->hl == DRAW_MOUSE_FACE
2179 && (s->next == NULL
2180 || s->next->hl != s->hl)));
2182 get_glyph_string_clip_rect (s, &clip_rect);
2184 if (s->face->box == FACE_SIMPLE_BOX)
2185 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2186 left_p, right_p, &clip_rect);
2187 else
2189 x_setup_relief_colors (s);
2190 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2191 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2196 /* Draw foreground of image glyph string S. */
2198 static void
2199 x_draw_image_foreground (s)
2200 struct glyph_string *s;
2202 int x = s->x;
2203 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2205 /* If first glyph of S has a left box line, start drawing it to the
2206 right of that line. */
2207 if (s->face->box != FACE_NO_BOX
2208 && s->first_glyph->left_box_line_p
2209 && s->slice.x == 0)
2210 x += eabs (s->face->box_line_width);
2212 /* If there is a margin around the image, adjust x- and y-position
2213 by that margin. */
2214 if (s->slice.x == 0)
2215 x += s->img->hmargin;
2216 if (s->slice.y == 0)
2217 y += s->img->vmargin;
2219 if (s->img->pixmap)
2221 if (s->img->mask)
2223 /* We can't set both a clip mask and use XSetClipRectangles
2224 because the latter also sets a clip mask. We also can't
2225 trust on the shape extension to be available
2226 (XShapeCombineRegion). So, compute the rectangle to draw
2227 manually. */
2228 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2229 | GCFunction);
2230 XGCValues xgcv;
2231 XRectangle clip_rect, image_rect, r;
2233 xgcv.clip_mask = s->img->mask;
2234 xgcv.clip_x_origin = x;
2235 xgcv.clip_y_origin = y;
2236 xgcv.function = GXcopy;
2237 XChangeGC (s->display, s->gc, mask, &xgcv);
2239 get_glyph_string_clip_rect (s, &clip_rect);
2240 image_rect.x = x;
2241 image_rect.y = y;
2242 image_rect.width = s->slice.width;
2243 image_rect.height = s->slice.height;
2244 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2245 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2246 s->slice.x + r.x - x, s->slice.y + r.y - y,
2247 r.width, r.height, r.x, r.y);
2249 else
2251 XRectangle clip_rect, image_rect, r;
2253 get_glyph_string_clip_rect (s, &clip_rect);
2254 image_rect.x = x;
2255 image_rect.y = y;
2256 image_rect.width = s->slice.width;
2257 image_rect.height = s->slice.height;
2258 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2259 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2260 s->slice.x + r.x - x, s->slice.y + r.y - y,
2261 r.width, r.height, r.x, r.y);
2263 /* When the image has a mask, we can expect that at
2264 least part of a mouse highlight or a block cursor will
2265 be visible. If the image doesn't have a mask, make
2266 a block cursor visible by drawing a rectangle around
2267 the image. I believe it's looking better if we do
2268 nothing here for mouse-face. */
2269 if (s->hl == DRAW_CURSOR)
2271 int r = s->img->relief;
2272 if (r < 0) r = -r;
2273 XDrawRectangle (s->display, s->window, s->gc,
2274 x - r, y - r,
2275 s->slice.width + r*2 - 1,
2276 s->slice.height + r*2 - 1);
2280 else
2281 /* Draw a rectangle if image could not be loaded. */
2282 XDrawRectangle (s->display, s->window, s->gc, x, y,
2283 s->slice.width - 1, s->slice.height - 1);
2287 /* Draw a relief around the image glyph string S. */
2289 static void
2290 x_draw_image_relief (s)
2291 struct glyph_string *s;
2293 int x0, y0, x1, y1, thick, raised_p;
2294 XRectangle r;
2295 int x = s->x;
2296 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2298 /* If first glyph of S has a left box line, start drawing it to the
2299 right of that line. */
2300 if (s->face->box != FACE_NO_BOX
2301 && s->first_glyph->left_box_line_p
2302 && s->slice.x == 0)
2303 x += eabs (s->face->box_line_width);
2305 /* If there is a margin around the image, adjust x- and y-position
2306 by that margin. */
2307 if (s->slice.x == 0)
2308 x += s->img->hmargin;
2309 if (s->slice.y == 0)
2310 y += s->img->vmargin;
2312 if (s->hl == DRAW_IMAGE_SUNKEN
2313 || s->hl == DRAW_IMAGE_RAISED)
2315 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2316 raised_p = s->hl == DRAW_IMAGE_RAISED;
2318 else
2320 thick = eabs (s->img->relief);
2321 raised_p = s->img->relief > 0;
2324 x0 = x - thick;
2325 y0 = y - thick;
2326 x1 = x + s->slice.width + thick - 1;
2327 y1 = y + s->slice.height + thick - 1;
2329 x_setup_relief_colors (s);
2330 get_glyph_string_clip_rect (s, &r);
2331 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2332 s->slice.y == 0,
2333 s->slice.y + s->slice.height == s->img->height,
2334 s->slice.x == 0,
2335 s->slice.x + s->slice.width == s->img->width,
2336 &r);
2340 /* Draw the foreground of image glyph string S to PIXMAP. */
2342 static void
2343 x_draw_image_foreground_1 (s, pixmap)
2344 struct glyph_string *s;
2345 Pixmap pixmap;
2347 int x = 0;
2348 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2350 /* If first glyph of S has a left box line, start drawing it to the
2351 right of that line. */
2352 if (s->face->box != FACE_NO_BOX
2353 && s->first_glyph->left_box_line_p
2354 && s->slice.x == 0)
2355 x += eabs (s->face->box_line_width);
2357 /* If there is a margin around the image, adjust x- and y-position
2358 by that margin. */
2359 if (s->slice.x == 0)
2360 x += s->img->hmargin;
2361 if (s->slice.y == 0)
2362 y += s->img->vmargin;
2364 if (s->img->pixmap)
2366 if (s->img->mask)
2368 /* We can't set both a clip mask and use XSetClipRectangles
2369 because the latter also sets a clip mask. We also can't
2370 trust on the shape extension to be available
2371 (XShapeCombineRegion). So, compute the rectangle to draw
2372 manually. */
2373 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2374 | GCFunction);
2375 XGCValues xgcv;
2377 xgcv.clip_mask = s->img->mask;
2378 xgcv.clip_x_origin = x - s->slice.x;
2379 xgcv.clip_y_origin = y - s->slice.y;
2380 xgcv.function = GXcopy;
2381 XChangeGC (s->display, s->gc, mask, &xgcv);
2383 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2384 s->slice.x, s->slice.y,
2385 s->slice.width, s->slice.height, x, y);
2386 XSetClipMask (s->display, s->gc, None);
2388 else
2390 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2391 s->slice.x, s->slice.y,
2392 s->slice.width, s->slice.height, x, y);
2394 /* When the image has a mask, we can expect that at
2395 least part of a mouse highlight or a block cursor will
2396 be visible. If the image doesn't have a mask, make
2397 a block cursor visible by drawing a rectangle around
2398 the image. I believe it's looking better if we do
2399 nothing here for mouse-face. */
2400 if (s->hl == DRAW_CURSOR)
2402 int r = s->img->relief;
2403 if (r < 0) r = -r;
2404 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2405 s->slice.width + r*2 - 1,
2406 s->slice.height + r*2 - 1);
2410 else
2411 /* Draw a rectangle if image could not be loaded. */
2412 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2413 s->slice.width - 1, s->slice.height - 1);
2417 /* Draw part of the background of glyph string S. X, Y, W, and H
2418 give the rectangle to draw. */
2420 static void
2421 x_draw_glyph_string_bg_rect (s, x, y, w, h)
2422 struct glyph_string *s;
2423 int x, y, w, h;
2425 if (s->stippled_p)
2427 /* Fill background with a stipple pattern. */
2428 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2429 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2430 XSetFillStyle (s->display, s->gc, FillSolid);
2432 else
2433 x_clear_glyph_string_rect (s, x, y, w, h);
2437 /* Draw image glyph string S.
2439 s->y
2440 s->x +-------------------------
2441 | s->face->box
2443 | +-------------------------
2444 | | s->img->margin
2446 | | +-------------------
2447 | | | the image
2451 static void
2452 x_draw_image_glyph_string (s)
2453 struct glyph_string *s;
2455 int box_line_hwidth = eabs (s->face->box_line_width);
2456 int box_line_vwidth = max (s->face->box_line_width, 0);
2457 int height;
2458 Pixmap pixmap = None;
2460 height = s->height;
2461 if (s->slice.y == 0)
2462 height -= box_line_vwidth;
2463 if (s->slice.y + s->slice.height >= s->img->height)
2464 height -= box_line_vwidth;
2466 /* Fill background with face under the image. Do it only if row is
2467 taller than image or if image has a clip mask to reduce
2468 flickering. */
2469 s->stippled_p = s->face->stipple != 0;
2470 if (height > s->slice.height
2471 || s->img->hmargin
2472 || s->img->vmargin
2473 || s->img->mask
2474 || s->img->pixmap == 0
2475 || s->width != s->background_width)
2477 if (s->img->mask)
2479 /* Create a pixmap as large as the glyph string. Fill it
2480 with the background color. Copy the image to it, using
2481 its mask. Copy the temporary pixmap to the display. */
2482 Screen *screen = FRAME_X_SCREEN (s->f);
2483 int depth = DefaultDepthOfScreen (screen);
2485 /* Create a pixmap as large as the glyph string. */
2486 pixmap = XCreatePixmap (s->display, s->window,
2487 s->background_width,
2488 s->height, depth);
2490 /* Don't clip in the following because we're working on the
2491 pixmap. */
2492 XSetClipMask (s->display, s->gc, None);
2494 /* Fill the pixmap with the background color/stipple. */
2495 if (s->stippled_p)
2497 /* Fill background with a stipple pattern. */
2498 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2499 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2500 XFillRectangle (s->display, pixmap, s->gc,
2501 0, 0, s->background_width, s->height);
2502 XSetFillStyle (s->display, s->gc, FillSolid);
2503 XSetTSOrigin (s->display, s->gc, 0, 0);
2505 else
2507 XGCValues xgcv;
2508 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2509 &xgcv);
2510 XSetForeground (s->display, s->gc, xgcv.background);
2511 XFillRectangle (s->display, pixmap, s->gc,
2512 0, 0, s->background_width, s->height);
2513 XSetForeground (s->display, s->gc, xgcv.foreground);
2516 else
2518 int x = s->x;
2519 int y = s->y;
2521 if (s->first_glyph->left_box_line_p
2522 && s->slice.x == 0)
2523 x += box_line_hwidth;
2525 if (s->slice.y == 0)
2526 y += box_line_vwidth;
2528 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2531 s->background_filled_p = 1;
2534 /* Draw the foreground. */
2535 if (pixmap != None)
2537 x_draw_image_foreground_1 (s, pixmap);
2538 x_set_glyph_string_clipping (s);
2539 XCopyArea (s->display, pixmap, s->window, s->gc,
2540 0, 0, s->background_width, s->height, s->x, s->y);
2541 XFreePixmap (s->display, pixmap);
2543 else
2544 x_draw_image_foreground (s);
2546 /* If we must draw a relief around the image, do it. */
2547 if (s->img->relief
2548 || s->hl == DRAW_IMAGE_RAISED
2549 || s->hl == DRAW_IMAGE_SUNKEN)
2550 x_draw_image_relief (s);
2554 /* Draw stretch glyph string S. */
2556 static void
2557 x_draw_stretch_glyph_string (s)
2558 struct glyph_string *s;
2560 xassert (s->first_glyph->type == STRETCH_GLYPH);
2562 if (s->hl == DRAW_CURSOR
2563 && !x_stretch_cursor_p)
2565 /* If `x-stretch-block-cursor' is nil, don't draw a block cursor
2566 as wide as the stretch glyph. */
2567 int width, background_width = s->background_width;
2568 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2570 if (x < left_x)
2572 background_width -= left_x - x;
2573 x = left_x;
2575 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2577 /* Draw cursor. */
2578 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2580 /* Clear rest using the GC of the original non-cursor face. */
2581 if (width < background_width)
2583 int y = s->y;
2584 int w = background_width - width, h = s->height;
2585 XRectangle r;
2586 GC gc;
2588 x += width;
2589 if (s->row->mouse_face_p
2590 && cursor_in_mouse_face_p (s->w))
2592 x_set_mouse_face_gc (s);
2593 gc = s->gc;
2595 else
2596 gc = s->face->gc;
2598 get_glyph_string_clip_rect (s, &r);
2599 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2601 if (s->face->stipple)
2603 /* Fill background with a stipple pattern. */
2604 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2605 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2606 XSetFillStyle (s->display, gc, FillSolid);
2608 else
2610 XGCValues xgcv;
2611 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2612 XSetForeground (s->display, gc, xgcv.background);
2613 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2614 XSetForeground (s->display, gc, xgcv.foreground);
2618 else if (!s->background_filled_p)
2620 int background_width = s->background_width;
2621 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2623 /* Don't draw into left margin, fringe or scrollbar area
2624 except for header line and mode line. */
2625 if (x < left_x && !s->row->mode_line_p)
2627 background_width -= left_x - x;
2628 x = left_x;
2630 if (background_width > 0)
2631 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2634 s->background_filled_p = 1;
2638 /* Draw glyph string S. */
2640 static void
2641 x_draw_glyph_string (s)
2642 struct glyph_string *s;
2644 int relief_drawn_p = 0;
2646 /* If S draws into the background of its successors, draw the
2647 background of the successors first so that S can draw into it.
2648 This makes S->next use XDrawString instead of XDrawImageString. */
2649 if (s->next && s->right_overhang && !s->for_overlaps)
2651 int width;
2652 struct glyph_string *next;
2654 for (width = 0, next = s->next;
2655 next && width < s->right_overhang;
2656 width += next->width, next = next->next)
2657 if (next->first_glyph->type != IMAGE_GLYPH)
2659 x_set_glyph_string_gc (next);
2660 x_set_glyph_string_clipping (next);
2661 if (next->first_glyph->type == STRETCH_GLYPH)
2662 x_draw_stretch_glyph_string (next);
2663 else
2664 x_draw_glyph_string_background (next, 1);
2665 next->num_clips = 0;
2669 /* Set up S->gc, set clipping and draw S. */
2670 x_set_glyph_string_gc (s);
2672 /* Draw relief (if any) in advance for char/composition so that the
2673 glyph string can be drawn over it. */
2674 if (!s->for_overlaps
2675 && s->face->box != FACE_NO_BOX
2676 && (s->first_glyph->type == CHAR_GLYPH
2677 || s->first_glyph->type == COMPOSITE_GLYPH))
2680 x_set_glyph_string_clipping (s);
2681 x_draw_glyph_string_background (s, 1);
2682 x_draw_glyph_string_box (s);
2683 x_set_glyph_string_clipping (s);
2684 relief_drawn_p = 1;
2686 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2687 && !s->clip_tail
2688 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2689 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2690 /* We must clip just this glyph. left_overhang part has already
2691 drawn when s->prev was drawn, and right_overhang part will be
2692 drawn later when s->next is drawn. */
2693 x_set_glyph_string_clipping_exactly (s, s);
2694 else
2695 x_set_glyph_string_clipping (s);
2697 switch (s->first_glyph->type)
2699 case IMAGE_GLYPH:
2700 x_draw_image_glyph_string (s);
2701 break;
2703 case STRETCH_GLYPH:
2704 x_draw_stretch_glyph_string (s);
2705 break;
2707 case CHAR_GLYPH:
2708 if (s->for_overlaps)
2709 s->background_filled_p = 1;
2710 else
2711 x_draw_glyph_string_background (s, 0);
2712 x_draw_glyph_string_foreground (s);
2713 break;
2715 case COMPOSITE_GLYPH:
2716 if (s->for_overlaps || (s->cmp_from > 0
2717 && ! s->first_glyph->u.cmp.automatic))
2718 s->background_filled_p = 1;
2719 else
2720 x_draw_glyph_string_background (s, 1);
2721 x_draw_composite_glyph_string_foreground (s);
2722 break;
2724 default:
2725 abort ();
2728 if (!s->for_overlaps)
2730 /* Draw underline. */
2731 if (s->face->underline_p)
2733 unsigned long thickness, position;
2734 int y;
2736 if (s->prev && s->prev->face->underline_p)
2738 /* We use the same underline style as the previous one. */
2739 thickness = s->prev->underline_thickness;
2740 position = s->prev->underline_position;
2742 else
2744 /* Get the underline thickness. Default is 1 pixel. */
2745 if (s->font && s->font->underline_thickness > 0)
2746 thickness = s->font->underline_thickness;
2747 else
2748 thickness = 1;
2749 if (x_underline_at_descent_line)
2750 position = (s->height - thickness) - (s->ybase - s->y);
2751 else
2753 /* Get the underline position. This is the recommended
2754 vertical offset in pixels from the baseline to the top of
2755 the underline. This is a signed value according to the
2756 specs, and its default is
2758 ROUND ((maximum descent) / 2), with
2759 ROUND(x) = floor (x + 0.5) */
2761 if (x_use_underline_position_properties
2762 && s->font && s->font->underline_position >= 0)
2763 position = s->font->underline_position;
2764 else if (s->font)
2765 position = (s->font->descent + 1) / 2;
2766 else
2767 position = underline_minimum_offset;
2769 position = max (position, underline_minimum_offset);
2771 /* Check the sanity of thickness and position. We should
2772 avoid drawing underline out of the current line area. */
2773 if (s->y + s->height <= s->ybase + position)
2774 position = (s->height - 1) - (s->ybase - s->y);
2775 if (s->y + s->height < s->ybase + position + thickness)
2776 thickness = (s->y + s->height) - (s->ybase + position);
2777 s->underline_thickness = thickness;
2778 s->underline_position = position;
2779 y = s->ybase + position;
2780 if (s->face->underline_defaulted_p)
2781 XFillRectangle (s->display, s->window, s->gc,
2782 s->x, y, s->width, thickness);
2783 else
2785 XGCValues xgcv;
2786 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2787 XSetForeground (s->display, s->gc, s->face->underline_color);
2788 XFillRectangle (s->display, s->window, s->gc,
2789 s->x, y, s->width, thickness);
2790 XSetForeground (s->display, s->gc, xgcv.foreground);
2794 /* Draw overline. */
2795 if (s->face->overline_p)
2797 unsigned long dy = 0, h = 1;
2799 if (s->face->overline_color_defaulted_p)
2800 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2801 s->width, h);
2802 else
2804 XGCValues xgcv;
2805 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2806 XSetForeground (s->display, s->gc, s->face->overline_color);
2807 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2808 s->width, h);
2809 XSetForeground (s->display, s->gc, xgcv.foreground);
2813 /* Draw strike-through. */
2814 if (s->face->strike_through_p)
2816 unsigned long h = 1;
2817 unsigned long dy = (s->height - h) / 2;
2819 if (s->face->strike_through_color_defaulted_p)
2820 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2821 s->width, h);
2822 else
2824 XGCValues xgcv;
2825 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2826 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2827 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2828 s->width, h);
2829 XSetForeground (s->display, s->gc, xgcv.foreground);
2833 /* Draw relief if not yet drawn. */
2834 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2835 x_draw_glyph_string_box (s);
2837 if (s->prev)
2839 struct glyph_string *prev;
2841 for (prev = s->prev; prev; prev = prev->prev)
2842 if (prev->hl != s->hl
2843 && prev->x + prev->width + prev->right_overhang > s->x)
2845 /* As prev was drawn while clipped to its own area, we
2846 must draw the right_overhang part using s->hl now. */
2847 enum draw_glyphs_face save = prev->hl;
2849 prev->hl = s->hl;
2850 x_set_glyph_string_gc (prev);
2851 x_set_glyph_string_clipping_exactly (s, prev);
2852 if (prev->first_glyph->type == CHAR_GLYPH)
2853 x_draw_glyph_string_foreground (prev);
2854 else
2855 x_draw_composite_glyph_string_foreground (prev);
2856 XSetClipMask (prev->display, prev->gc, None);
2857 prev->hl = save;
2858 prev->num_clips = 0;
2862 if (s->next)
2864 struct glyph_string *next;
2866 for (next = s->next; next; next = next->next)
2867 if (next->hl != s->hl
2868 && next->x - next->left_overhang < s->x + s->width)
2870 /* As next will be drawn while clipped to its own area,
2871 we must draw the left_overhang part using s->hl now. */
2872 enum draw_glyphs_face save = next->hl;
2874 next->hl = s->hl;
2875 x_set_glyph_string_gc (next);
2876 x_set_glyph_string_clipping_exactly (s, next);
2877 if (next->first_glyph->type == CHAR_GLYPH)
2878 x_draw_glyph_string_foreground (next);
2879 else
2880 x_draw_composite_glyph_string_foreground (next);
2881 XSetClipMask (next->display, next->gc, None);
2882 next->hl = save;
2883 next->num_clips = 0;
2888 /* Reset clipping. */
2889 XSetClipMask (s->display, s->gc, None);
2890 s->num_clips = 0;
2893 /* Shift display to make room for inserted glyphs. */
2895 void
2896 x_shift_glyphs_for_insert (f, x, y, width, height, shift_by)
2897 struct frame *f;
2898 int x, y, width, height, shift_by;
2900 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2901 f->output_data.x->normal_gc,
2902 x, y, width, height,
2903 x + shift_by, y);
2906 /* Delete N glyphs at the nominal cursor position. Not implemented
2907 for X frames. */
2909 static void
2910 x_delete_glyphs (f, n)
2911 struct frame *f;
2912 register int n;
2914 abort ();
2918 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2919 If they are <= 0, this is probably an error. */
2921 void
2922 x_clear_area (dpy, window, x, y, width, height, exposures)
2923 Display *dpy;
2924 Window window;
2925 int x, y;
2926 int width, height;
2927 int exposures;
2929 xassert (width > 0 && height > 0);
2930 XClearArea (dpy, window, x, y, width, height, exposures);
2934 /* Clear an entire frame. */
2936 static void
2937 x_clear_frame (struct frame *f)
2939 /* Clearing the frame will erase any cursor, so mark them all as no
2940 longer visible. */
2941 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2942 output_cursor.hpos = output_cursor.vpos = 0;
2943 output_cursor.x = -1;
2945 /* We don't set the output cursor here because there will always
2946 follow an explicit cursor_to. */
2947 BLOCK_INPUT;
2948 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
2950 /* We have to clear the scroll bars, too. If we have changed
2951 colors or something like that, then they should be notified. */
2952 x_scroll_bar_clear (f);
2954 XFlush (FRAME_X_DISPLAY (f));
2956 UNBLOCK_INPUT;
2961 /* Invert the middle quarter of the frame for .15 sec. */
2963 /* We use the select system call to do the waiting, so we have to make
2964 sure it's available. If it isn't, we just won't do visual bells. */
2966 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
2969 /* Subtract the `struct timeval' values X and Y, storing the result in
2970 *RESULT. Return 1 if the difference is negative, otherwise 0. */
2972 static int
2973 timeval_subtract (result, x, y)
2974 struct timeval *result, x, y;
2976 /* Perform the carry for the later subtraction by updating y. This
2977 is safer because on some systems the tv_sec member is unsigned. */
2978 if (x.tv_usec < y.tv_usec)
2980 int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
2981 y.tv_usec -= 1000000 * nsec;
2982 y.tv_sec += nsec;
2985 if (x.tv_usec - y.tv_usec > 1000000)
2987 int nsec = (y.tv_usec - x.tv_usec) / 1000000;
2988 y.tv_usec += 1000000 * nsec;
2989 y.tv_sec -= nsec;
2992 /* Compute the time remaining to wait. tv_usec is certainly
2993 positive. */
2994 result->tv_sec = x.tv_sec - y.tv_sec;
2995 result->tv_usec = x.tv_usec - y.tv_usec;
2997 /* Return indication of whether the result should be considered
2998 negative. */
2999 return x.tv_sec < y.tv_sec;
3002 void
3003 XTflash (f)
3004 struct frame *f;
3006 BLOCK_INPUT;
3009 GC gc;
3011 /* Create a GC that will use the GXxor function to flip foreground
3012 pixels into background pixels. */
3014 XGCValues values;
3016 values.function = GXxor;
3017 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3018 ^ FRAME_BACKGROUND_PIXEL (f));
3020 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3021 GCFunction | GCForeground, &values);
3025 /* Get the height not including a menu bar widget. */
3026 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3027 /* Height of each line to flash. */
3028 int flash_height = FRAME_LINE_HEIGHT (f);
3029 /* These will be the left and right margins of the rectangles. */
3030 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3031 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3033 int width;
3035 /* Don't flash the area between a scroll bar and the frame
3036 edge it is next to. */
3037 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3039 case vertical_scroll_bar_left:
3040 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3041 break;
3043 case vertical_scroll_bar_right:
3044 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3045 break;
3047 default:
3048 break;
3051 width = flash_right - flash_left;
3053 /* If window is tall, flash top and bottom line. */
3054 if (height > 3 * FRAME_LINE_HEIGHT (f))
3056 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3057 flash_left,
3058 (FRAME_INTERNAL_BORDER_WIDTH (f)
3059 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
3060 width, flash_height);
3061 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3062 flash_left,
3063 (height - flash_height
3064 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3065 width, flash_height);
3067 else
3068 /* If it is short, flash it all. */
3069 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3070 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3071 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3073 x_flush (f);
3076 struct timeval wakeup;
3078 EMACS_GET_TIME (wakeup);
3080 /* Compute time to wait until, propagating carry from usecs. */
3081 wakeup.tv_usec += 150000;
3082 wakeup.tv_sec += (wakeup.tv_usec / 1000000);
3083 wakeup.tv_usec %= 1000000;
3085 /* Keep waiting until past the time wakeup or any input gets
3086 available. */
3087 while (! detect_input_pending ())
3089 struct timeval current;
3090 struct timeval timeout;
3092 EMACS_GET_TIME (current);
3094 /* Break if result would be negative. */
3095 if (timeval_subtract (&current, wakeup, current))
3096 break;
3098 /* How long `select' should wait. */
3099 timeout.tv_sec = 0;
3100 timeout.tv_usec = 10000;
3102 /* Try to wait that long--but we might wake up sooner. */
3103 select (0, NULL, NULL, NULL, &timeout);
3107 /* If window is tall, flash top and bottom line. */
3108 if (height > 3 * FRAME_LINE_HEIGHT (f))
3110 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3111 flash_left,
3112 (FRAME_INTERNAL_BORDER_WIDTH (f)
3113 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
3114 width, flash_height);
3115 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3116 flash_left,
3117 (height - flash_height
3118 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3119 width, flash_height);
3121 else
3122 /* If it is short, flash it all. */
3123 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3124 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3125 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3127 XFreeGC (FRAME_X_DISPLAY (f), gc);
3128 x_flush (f);
3132 UNBLOCK_INPUT;
3135 #endif /* defined (HAVE_TIMEVAL) && defined (HAVE_SELECT) */
3138 static void
3139 XTtoggle_invisible_pointer (f, invisible)
3140 FRAME_PTR f;
3141 int invisible;
3143 BLOCK_INPUT;
3144 if (invisible)
3146 if (FRAME_X_DISPLAY_INFO (f)->invisible_cursor != 0)
3147 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3148 FRAME_X_DISPLAY_INFO (f)->invisible_cursor);
3150 else
3151 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3152 f->output_data.x->current_cursor);
3153 f->pointer_invisible = invisible;
3154 UNBLOCK_INPUT;
3158 /* Make audible bell. */
3160 void
3161 XTring_bell ()
3163 struct frame *f = SELECTED_FRAME ();
3165 if (FRAME_X_DISPLAY (f))
3167 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
3168 if (visible_bell)
3169 XTflash (f);
3170 else
3171 #endif
3173 BLOCK_INPUT;
3174 XBell (FRAME_X_DISPLAY (f), 0);
3175 XFlush (FRAME_X_DISPLAY (f));
3176 UNBLOCK_INPUT;
3182 /* Specify how many text lines, from the top of the window,
3183 should be affected by insert-lines and delete-lines operations.
3184 This, and those operations, are used only within an update
3185 that is bounded by calls to x_update_begin and x_update_end. */
3187 static void
3188 XTset_terminal_window (n)
3189 register int n;
3191 /* This function intentionally left blank. */
3196 /***********************************************************************
3197 Line Dance
3198 ***********************************************************************/
3200 /* Perform an insert-lines or delete-lines operation, inserting N
3201 lines or deleting -N lines at vertical position VPOS. */
3203 static void
3204 x_ins_del_lines (f, vpos, n)
3205 struct frame *f;
3206 int vpos, n;
3208 abort ();
3212 /* Scroll part of the display as described by RUN. */
3214 static void
3215 x_scroll_run (w, run)
3216 struct window *w;
3217 struct run *run;
3219 struct frame *f = XFRAME (w->frame);
3220 int x, y, width, height, from_y, to_y, bottom_y;
3222 /* Get frame-relative bounding box of the text display area of W,
3223 without mode lines. Include in this box the left and right
3224 fringe of W. */
3225 window_box (w, -1, &x, &y, &width, &height);
3227 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3228 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3229 bottom_y = y + height;
3231 if (to_y < from_y)
3233 /* Scrolling up. Make sure we don't copy part of the mode
3234 line at the bottom. */
3235 if (from_y + run->height > bottom_y)
3236 height = bottom_y - from_y;
3237 else
3238 height = run->height;
3240 else
3242 /* Scolling down. Make sure we don't copy over the mode line.
3243 at the bottom. */
3244 if (to_y + run->height > bottom_y)
3245 height = bottom_y - to_y;
3246 else
3247 height = run->height;
3250 BLOCK_INPUT;
3252 /* Cursor off. Will be switched on again in x_update_window_end. */
3253 updated_window = w;
3254 x_clear_cursor (w);
3256 XCopyArea (FRAME_X_DISPLAY (f),
3257 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3258 f->output_data.x->normal_gc,
3259 x, from_y,
3260 width, height,
3261 x, to_y);
3263 UNBLOCK_INPUT;
3268 /***********************************************************************
3269 Exposure Events
3270 ***********************************************************************/
3273 static void
3274 frame_highlight (f)
3275 struct frame *f;
3277 /* We used to only do this if Vx_no_window_manager was non-nil, but
3278 the ICCCM (section 4.1.6) says that the window's border pixmap
3279 and border pixel are window attributes which are "private to the
3280 client", so we can always change it to whatever we want. */
3281 BLOCK_INPUT;
3282 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3283 f->output_data.x->border_pixel);
3284 UNBLOCK_INPUT;
3285 x_update_cursor (f, 1);
3286 x_set_frame_alpha (f);
3289 static void
3290 frame_unhighlight (f)
3291 struct frame *f;
3293 /* We used to only do this if Vx_no_window_manager was non-nil, but
3294 the ICCCM (section 4.1.6) says that the window's border pixmap
3295 and border pixel are window attributes which are "private to the
3296 client", so we can always change it to whatever we want. */
3297 BLOCK_INPUT;
3298 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3299 f->output_data.x->border_tile);
3300 UNBLOCK_INPUT;
3301 x_update_cursor (f, 1);
3302 x_set_frame_alpha (f);
3305 /* The focus has changed. Update the frames as necessary to reflect
3306 the new situation. Note that we can't change the selected frame
3307 here, because the Lisp code we are interrupting might become confused.
3308 Each event gets marked with the frame in which it occurred, so the
3309 Lisp code can tell when the switch took place by examining the events. */
3311 static void
3312 x_new_focus_frame (dpyinfo, frame)
3313 struct x_display_info *dpyinfo;
3314 struct frame *frame;
3316 struct frame *old_focus = dpyinfo->x_focus_frame;
3318 if (frame != dpyinfo->x_focus_frame)
3320 /* Set this before calling other routines, so that they see
3321 the correct value of x_focus_frame. */
3322 dpyinfo->x_focus_frame = frame;
3324 if (old_focus && old_focus->auto_lower)
3325 x_lower_frame (old_focus);
3327 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3328 pending_autoraise_frame = dpyinfo->x_focus_frame;
3329 else
3330 pending_autoraise_frame = 0;
3333 x_frame_rehighlight (dpyinfo);
3336 /* Handle FocusIn and FocusOut state changes for FRAME.
3337 If FRAME has focus and there exists more than one frame, puts
3338 a FOCUS_IN_EVENT into *BUFP. */
3340 static void
3341 x_focus_changed (type, state, dpyinfo, frame, bufp)
3342 int type;
3343 int state;
3344 struct x_display_info *dpyinfo;
3345 struct frame *frame;
3346 struct input_event *bufp;
3348 if (type == FocusIn)
3350 if (dpyinfo->x_focus_event_frame != frame)
3352 x_new_focus_frame (dpyinfo, frame);
3353 dpyinfo->x_focus_event_frame = frame;
3355 /* Don't stop displaying the initial startup message
3356 for a switch-frame event we don't need. */
3357 if (NILP (Vterminal_frame)
3358 && CONSP (Vframe_list)
3359 && !NILP (XCDR (Vframe_list)))
3361 bufp->kind = FOCUS_IN_EVENT;
3362 XSETFRAME (bufp->frame_or_window, frame);
3366 frame->output_data.x->focus_state |= state;
3368 #ifdef HAVE_X_I18N
3369 if (FRAME_XIC (frame))
3370 XSetICFocus (FRAME_XIC (frame));
3371 #endif
3373 else if (type == FocusOut)
3375 frame->output_data.x->focus_state &= ~state;
3377 if (dpyinfo->x_focus_event_frame == frame)
3379 dpyinfo->x_focus_event_frame = 0;
3380 x_new_focus_frame (dpyinfo, 0);
3383 #ifdef HAVE_X_I18N
3384 if (FRAME_XIC (frame))
3385 XUnsetICFocus (FRAME_XIC (frame));
3386 #endif
3387 if (frame->pointer_invisible)
3388 XTtoggle_invisible_pointer (frame, 0);
3392 /* The focus may have changed. Figure out if it is a real focus change,
3393 by checking both FocusIn/Out and Enter/LeaveNotify events.
3395 Returns FOCUS_IN_EVENT event in *BUFP. */
3397 static void
3398 x_detect_focus_change (dpyinfo, event, bufp)
3399 struct x_display_info *dpyinfo;
3400 XEvent *event;
3401 struct input_event *bufp;
3403 struct frame *frame;
3405 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3406 if (! frame)
3407 return;
3409 switch (event->type)
3411 case EnterNotify:
3412 case LeaveNotify:
3414 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3415 int focus_state
3416 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3418 if (event->xcrossing.detail != NotifyInferior
3419 && event->xcrossing.focus
3420 && ! (focus_state & FOCUS_EXPLICIT))
3421 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3422 FOCUS_IMPLICIT,
3423 dpyinfo, frame, bufp);
3425 break;
3427 case FocusIn:
3428 case FocusOut:
3429 x_focus_changed (event->type,
3430 (event->xfocus.detail == NotifyPointer ?
3431 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3432 dpyinfo, frame, bufp);
3433 break;
3435 case ClientMessage:
3436 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3438 enum xembed_message msg = event->xclient.data.l[1];
3439 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3440 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3442 break;
3447 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3449 void
3450 x_mouse_leave (dpyinfo)
3451 struct x_display_info *dpyinfo;
3453 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3456 /* The focus has changed, or we have redirected a frame's focus to
3457 another frame (this happens when a frame uses a surrogate
3458 mini-buffer frame). Shift the highlight as appropriate.
3460 The FRAME argument doesn't necessarily have anything to do with which
3461 frame is being highlighted or un-highlighted; we only use it to find
3462 the appropriate X display info. */
3464 static void
3465 XTframe_rehighlight (frame)
3466 struct frame *frame;
3468 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3471 static void
3472 x_frame_rehighlight (dpyinfo)
3473 struct x_display_info *dpyinfo;
3475 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3477 if (dpyinfo->x_focus_frame)
3479 dpyinfo->x_highlight_frame
3480 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3481 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3482 : dpyinfo->x_focus_frame);
3483 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3485 FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
3486 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3489 else
3490 dpyinfo->x_highlight_frame = 0;
3492 if (dpyinfo->x_highlight_frame != old_highlight)
3494 if (old_highlight)
3495 frame_unhighlight (old_highlight);
3496 if (dpyinfo->x_highlight_frame)
3497 frame_highlight (dpyinfo->x_highlight_frame);
3503 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3505 /* Initialize mode_switch_bit and modifier_meaning. */
3506 static void
3507 x_find_modifier_meanings (dpyinfo)
3508 struct x_display_info *dpyinfo;
3510 int min_code, max_code;
3511 KeySym *syms;
3512 int syms_per_code;
3513 XModifierKeymap *mods;
3515 dpyinfo->meta_mod_mask = 0;
3516 dpyinfo->shift_lock_mask = 0;
3517 dpyinfo->alt_mod_mask = 0;
3518 dpyinfo->super_mod_mask = 0;
3519 dpyinfo->hyper_mod_mask = 0;
3521 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3523 syms = XGetKeyboardMapping (dpyinfo->display,
3524 min_code, max_code - min_code + 1,
3525 &syms_per_code);
3526 mods = XGetModifierMapping (dpyinfo->display);
3528 /* Scan the modifier table to see which modifier bits the Meta and
3529 Alt keysyms are on. */
3531 int row, col; /* The row and column in the modifier table. */
3532 int found_alt_or_meta;
3534 for (row = 3; row < 8; row++)
3536 found_alt_or_meta = 0;
3537 for (col = 0; col < mods->max_keypermod; col++)
3539 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3541 /* Zeroes are used for filler. Skip them. */
3542 if (code == 0)
3543 continue;
3545 /* Are any of this keycode's keysyms a meta key? */
3547 int code_col;
3549 for (code_col = 0; code_col < syms_per_code; code_col++)
3551 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3553 switch (sym)
3555 case XK_Meta_L:
3556 case XK_Meta_R:
3557 found_alt_or_meta = 1;
3558 dpyinfo->meta_mod_mask |= (1 << row);
3559 break;
3561 case XK_Alt_L:
3562 case XK_Alt_R:
3563 found_alt_or_meta = 1;
3564 dpyinfo->alt_mod_mask |= (1 << row);
3565 break;
3567 case XK_Hyper_L:
3568 case XK_Hyper_R:
3569 if (!found_alt_or_meta)
3570 dpyinfo->hyper_mod_mask |= (1 << row);
3571 code_col = syms_per_code;
3572 col = mods->max_keypermod;
3573 break;
3575 case XK_Super_L:
3576 case XK_Super_R:
3577 if (!found_alt_or_meta)
3578 dpyinfo->super_mod_mask |= (1 << row);
3579 code_col = syms_per_code;
3580 col = mods->max_keypermod;
3581 break;
3583 case XK_Shift_Lock:
3584 /* Ignore this if it's not on the lock modifier. */
3585 if (!found_alt_or_meta && ((1 << row) == LockMask))
3586 dpyinfo->shift_lock_mask = LockMask;
3587 code_col = syms_per_code;
3588 col = mods->max_keypermod;
3589 break;
3597 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3598 if (! dpyinfo->meta_mod_mask)
3600 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3601 dpyinfo->alt_mod_mask = 0;
3604 /* If some keys are both alt and meta,
3605 make them just meta, not alt. */
3606 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3608 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3611 XFree ((char *) syms);
3612 XFreeModifiermap (mods);
3615 /* Convert between the modifier bits X uses and the modifier bits
3616 Emacs uses. */
3618 unsigned int
3619 x_x_to_emacs_modifiers (dpyinfo, state)
3620 struct x_display_info *dpyinfo;
3621 unsigned int state;
3623 EMACS_UINT mod_meta = meta_modifier;
3624 EMACS_UINT mod_alt = alt_modifier;
3625 EMACS_UINT mod_hyper = hyper_modifier;
3626 EMACS_UINT mod_super = super_modifier;
3627 Lisp_Object tem;
3629 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3630 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3631 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3632 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3633 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3634 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3635 tem = Fget (Vx_super_keysym, Qmodifier_value);
3636 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3639 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3640 | ((state & ControlMask) ? ctrl_modifier : 0)
3641 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3642 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3643 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3644 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3647 static unsigned int
3648 x_emacs_to_x_modifiers (dpyinfo, state)
3649 struct x_display_info *dpyinfo;
3650 unsigned int state;
3652 EMACS_UINT mod_meta = meta_modifier;
3653 EMACS_UINT mod_alt = alt_modifier;
3654 EMACS_UINT mod_hyper = hyper_modifier;
3655 EMACS_UINT mod_super = super_modifier;
3657 Lisp_Object tem;
3659 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3660 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3661 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3662 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3663 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3664 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3665 tem = Fget (Vx_super_keysym, Qmodifier_value);
3666 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3669 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3670 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3671 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3672 | ((state & shift_modifier) ? ShiftMask : 0)
3673 | ((state & ctrl_modifier) ? ControlMask : 0)
3674 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3677 /* Convert a keysym to its name. */
3679 char *
3680 x_get_keysym_name (keysym)
3681 KeySym keysym;
3683 char *value;
3685 BLOCK_INPUT;
3686 value = XKeysymToString (keysym);
3687 UNBLOCK_INPUT;
3689 return value;
3694 /* Mouse clicks and mouse movement. Rah. */
3696 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3698 If the event is a button press, then note that we have grabbed
3699 the mouse. */
3701 static Lisp_Object
3702 construct_mouse_click (result, event, f)
3703 struct input_event *result;
3704 XButtonEvent *event;
3705 struct frame *f;
3707 /* Make the event type NO_EVENT; we'll change that when we decide
3708 otherwise. */
3709 result->kind = MOUSE_CLICK_EVENT;
3710 result->code = event->button - Button1;
3711 result->timestamp = event->time;
3712 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3713 event->state)
3714 | (event->type == ButtonRelease
3715 ? up_modifier
3716 : down_modifier));
3718 XSETINT (result->x, event->x);
3719 XSETINT (result->y, event->y);
3720 XSETFRAME (result->frame_or_window, f);
3721 result->arg = Qnil;
3722 return Qnil;
3726 /* Function to report a mouse movement to the mainstream Emacs code.
3727 The input handler calls this.
3729 We have received a mouse movement event, which is given in *event.
3730 If the mouse is over a different glyph than it was last time, tell
3731 the mainstream emacs code by setting mouse_moved. If not, ask for
3732 another motion event, so we can check again the next time it moves. */
3734 static XMotionEvent last_mouse_motion_event;
3735 static Lisp_Object last_mouse_motion_frame;
3737 static int
3738 note_mouse_movement (frame, event)
3739 FRAME_PTR frame;
3740 XMotionEvent *event;
3742 last_mouse_movement_time = event->time;
3743 last_mouse_motion_event = *event;
3744 XSETFRAME (last_mouse_motion_frame, frame);
3746 if (!FRAME_X_OUTPUT (frame))
3747 return 0;
3749 if (event->window != FRAME_X_WINDOW (frame))
3751 frame->mouse_moved = 1;
3752 last_mouse_scroll_bar = Qnil;
3753 note_mouse_highlight (frame, -1, -1);
3754 last_mouse_glyph_frame = 0;
3755 return 1;
3759 /* Has the mouse moved off the glyph it was on at the last sighting? */
3760 if (frame != last_mouse_glyph_frame
3761 || event->x < last_mouse_glyph.x
3762 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3763 || event->y < last_mouse_glyph.y
3764 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3766 frame->mouse_moved = 1;
3767 last_mouse_scroll_bar = Qnil;
3768 note_mouse_highlight (frame, event->x, event->y);
3769 /* Remember which glyph we're now on. */
3770 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3771 last_mouse_glyph_frame = frame;
3772 return 1;
3775 return 0;
3779 /************************************************************************
3780 Mouse Face
3781 ************************************************************************/
3783 static void
3784 redo_mouse_highlight ()
3786 if (!NILP (last_mouse_motion_frame)
3787 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3788 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3789 last_mouse_motion_event.x,
3790 last_mouse_motion_event.y);
3795 /* Return the current position of the mouse.
3796 *FP should be a frame which indicates which display to ask about.
3798 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3799 and *PART to the frame, window, and scroll bar part that the mouse
3800 is over. Set *X and *Y to the portion and whole of the mouse's
3801 position on the scroll bar.
3803 If the mouse movement started elsewhere, set *FP to the frame the
3804 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3805 the mouse is over.
3807 Set *TIME to the server time-stamp for the time at which the mouse
3808 was at this position.
3810 Don't store anything if we don't have a valid set of values to report.
3812 This clears the mouse_moved flag, so we can wait for the next mouse
3813 movement. */
3815 static void
3816 XTmouse_position (fp, insist, bar_window, part, x, y, time)
3817 FRAME_PTR *fp;
3818 int insist;
3819 Lisp_Object *bar_window;
3820 enum scroll_bar_part *part;
3821 Lisp_Object *x, *y;
3822 unsigned long *time;
3824 FRAME_PTR f1;
3826 BLOCK_INPUT;
3828 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3829 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time);
3830 else
3832 Window root;
3833 int root_x, root_y;
3835 Window dummy_window;
3836 int dummy;
3838 Lisp_Object frame, tail;
3840 /* Clear the mouse-moved flag for every frame on this display. */
3841 FOR_EACH_FRAME (tail, frame)
3842 if (FRAME_X_P (XFRAME (frame))
3843 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3844 XFRAME (frame)->mouse_moved = 0;
3846 last_mouse_scroll_bar = Qnil;
3848 /* Figure out which root window we're on. */
3849 XQueryPointer (FRAME_X_DISPLAY (*fp),
3850 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3852 /* The root window which contains the pointer. */
3853 &root,
3855 /* Trash which we can't trust if the pointer is on
3856 a different screen. */
3857 &dummy_window,
3859 /* The position on that root window. */
3860 &root_x, &root_y,
3862 /* More trash we can't trust. */
3863 &dummy, &dummy,
3865 /* Modifier keys and pointer buttons, about which
3866 we don't care. */
3867 (unsigned int *) &dummy);
3869 /* Now we have a position on the root; find the innermost window
3870 containing the pointer. */
3872 Window win, child;
3873 int win_x, win_y;
3874 int parent_x = 0, parent_y = 0;
3876 win = root;
3878 /* XTranslateCoordinates can get errors if the window
3879 structure is changing at the same time this function
3880 is running. So at least we must not crash from them. */
3882 x_catch_errors (FRAME_X_DISPLAY (*fp));
3884 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3885 && FRAME_LIVE_P (last_mouse_frame))
3887 /* If mouse was grabbed on a frame, give coords for that frame
3888 even if the mouse is now outside it. */
3889 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3891 /* From-window, to-window. */
3892 root, FRAME_X_WINDOW (last_mouse_frame),
3894 /* From-position, to-position. */
3895 root_x, root_y, &win_x, &win_y,
3897 /* Child of win. */
3898 &child);
3899 f1 = last_mouse_frame;
3901 else
3903 while (1)
3905 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3907 /* From-window, to-window. */
3908 root, win,
3910 /* From-position, to-position. */
3911 root_x, root_y, &win_x, &win_y,
3913 /* Child of win. */
3914 &child);
3916 if (child == None || child == win)
3917 break;
3918 #ifdef USE_GTK
3919 /* We don't wan't to know the innermost window. We
3920 want the edit window. For non-Gtk+ the innermost
3921 window is the edit window. For Gtk+ it might not
3922 be. It might be the tool bar for example. */
3923 if (x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win))
3924 break;
3925 #endif
3926 win = child;
3927 parent_x = win_x;
3928 parent_y = win_y;
3931 /* Now we know that:
3932 win is the innermost window containing the pointer
3933 (XTC says it has no child containing the pointer),
3934 win_x and win_y are the pointer's position in it
3935 (XTC did this the last time through), and
3936 parent_x and parent_y are the pointer's position in win's parent.
3937 (They are what win_x and win_y were when win was child.
3938 If win is the root window, it has no parent, and
3939 parent_{x,y} are invalid, but that's okay, because we'll
3940 never use them in that case.) */
3942 #ifdef USE_GTK
3943 /* We don't wan't to know the innermost window. We
3944 want the edit window. */
3945 f1 = x_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3946 #else
3947 /* Is win one of our frames? */
3948 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3949 #endif
3951 #ifdef USE_X_TOOLKIT
3952 /* If we end up with the menu bar window, say it's not
3953 on the frame. */
3954 if (f1 != NULL
3955 && f1->output_data.x->menubar_widget
3956 && win == XtWindow (f1->output_data.x->menubar_widget))
3957 f1 = NULL;
3958 #endif /* USE_X_TOOLKIT */
3961 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
3962 f1 = 0;
3964 x_uncatch_errors ();
3966 /* If not, is it one of our scroll bars? */
3967 if (! f1)
3969 struct scroll_bar *bar;
3971 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
3973 if (bar)
3975 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3976 win_x = parent_x;
3977 win_y = parent_y;
3981 if (f1 == 0 && insist > 0)
3982 f1 = SELECTED_FRAME ();
3984 if (f1)
3986 /* Ok, we found a frame. Store all the values.
3987 last_mouse_glyph is a rectangle used to reduce the
3988 generation of mouse events. To not miss any motion
3989 events, we must divide the frame into rectangles of the
3990 size of the smallest character that could be displayed
3991 on it, i.e. into the same rectangles that matrices on
3992 the frame are divided into. */
3994 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
3995 last_mouse_glyph_frame = f1;
3997 *bar_window = Qnil;
3998 *part = 0;
3999 *fp = f1;
4000 XSETINT (*x, win_x);
4001 XSETINT (*y, win_y);
4002 *time = last_mouse_movement_time;
4007 UNBLOCK_INPUT;
4012 /***********************************************************************
4013 Scroll bars
4014 ***********************************************************************/
4016 /* Scroll bar support. */
4018 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
4019 manages it.
4020 This can be called in GC, so we have to make sure to strip off mark
4021 bits. */
4023 static struct scroll_bar *
4024 x_window_to_scroll_bar (display, window_id)
4025 Display *display;
4026 Window window_id;
4028 Lisp_Object tail;
4030 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
4031 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
4032 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
4034 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4036 Lisp_Object frame, bar, condemned;
4038 frame = XCAR (tail);
4039 /* All elements of Vframe_list should be frames. */
4040 if (! FRAMEP (frame))
4041 abort ();
4043 if (! FRAME_X_P (XFRAME (frame)))
4044 continue;
4046 /* Scan this frame's scroll bar list for a scroll bar with the
4047 right window ID. */
4048 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4049 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4050 /* This trick allows us to search both the ordinary and
4051 condemned scroll bar lists with one loop. */
4052 ! NILP (bar) || (bar = condemned,
4053 condemned = Qnil,
4054 ! NILP (bar));
4055 bar = XSCROLL_BAR (bar)->next)
4056 if (XSCROLL_BAR (bar)->x_window == window_id &&
4057 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4058 return XSCROLL_BAR (bar);
4061 return 0;
4065 #if defined USE_LUCID
4067 /* Return the Lucid menu bar WINDOW is part of. Return null
4068 if WINDOW is not part of a menu bar. */
4070 static Widget
4071 x_window_to_menu_bar (window)
4072 Window window;
4074 Lisp_Object tail;
4076 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4078 if (FRAME_X_P (XFRAME (XCAR (tail))))
4080 Lisp_Object frame = XCAR (tail);
4081 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4083 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4084 return menu_bar;
4088 return NULL;
4091 #endif /* USE_LUCID */
4094 /************************************************************************
4095 Toolkit scroll bars
4096 ************************************************************************/
4098 #ifdef USE_TOOLKIT_SCROLL_BARS
4100 static void x_scroll_bar_to_input_event P_ ((XEvent *, struct input_event *));
4101 static void x_send_scroll_bar_event P_ ((Lisp_Object, int, int, int));
4102 static void x_create_toolkit_scroll_bar P_ ((struct frame *,
4103 struct scroll_bar *));
4104 static void x_set_toolkit_scroll_bar_thumb P_ ((struct scroll_bar *,
4105 int, int, int));
4108 /* Lisp window being scrolled. Set when starting to interact with
4109 a toolkit scroll bar, reset to nil when ending the interaction. */
4111 static Lisp_Object window_being_scrolled;
4113 /* Last scroll bar part sent in xm_scroll_callback. */
4115 static int last_scroll_bar_part;
4117 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4118 that movements of 1/20 of the screen size are mapped to up/down. */
4120 #ifndef USE_GTK
4121 /* Id of action hook installed for scroll bars. */
4123 static XtActionHookId action_hook_id;
4125 static Boolean xaw3d_arrow_scroll;
4127 /* Whether the drag scrolling maintains the mouse at the top of the
4128 thumb. If not, resizing the thumb needs to be done more carefully
4129 to avoid jerkyness. */
4131 static Boolean xaw3d_pick_top;
4133 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4134 bars are used.. The hook is responsible for detecting when
4135 the user ends an interaction with the scroll bar, and generates
4136 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4138 static void
4139 xt_action_hook (widget, client_data, action_name, event, params,
4140 num_params)
4141 Widget widget;
4142 XtPointer client_data;
4143 String action_name;
4144 XEvent *event;
4145 String *params;
4146 Cardinal *num_params;
4148 int scroll_bar_p;
4149 char *end_action;
4151 #ifdef USE_MOTIF
4152 scroll_bar_p = XmIsScrollBar (widget);
4153 end_action = "Release";
4154 #else /* !USE_MOTIF i.e. use Xaw */
4155 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4156 end_action = "EndScroll";
4157 #endif /* USE_MOTIF */
4159 if (scroll_bar_p
4160 && strcmp (action_name, end_action) == 0
4161 && WINDOWP (window_being_scrolled))
4163 struct window *w;
4165 x_send_scroll_bar_event (window_being_scrolled,
4166 scroll_bar_end_scroll, 0, 0);
4167 w = XWINDOW (window_being_scrolled);
4169 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4171 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4172 /* The thumb size is incorrect while dragging: fix it. */
4173 set_vertical_scroll_bar (w);
4175 window_being_scrolled = Qnil;
4176 last_scroll_bar_part = -1;
4178 /* Xt timeouts no longer needed. */
4179 toolkit_scroll_bar_interaction = 0;
4182 #endif /* not USE_GTK */
4184 /* A vector of windows used for communication between
4185 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4187 static struct window **scroll_bar_windows;
4188 static int scroll_bar_windows_size;
4191 /* Send a client message with message type Xatom_Scrollbar for a
4192 scroll action to the frame of WINDOW. PART is a value identifying
4193 the part of the scroll bar that was clicked on. PORTION is the
4194 amount to scroll of a whole of WHOLE. */
4196 static void
4197 x_send_scroll_bar_event (window, part, portion, whole)
4198 Lisp_Object window;
4199 int part, portion, whole;
4201 XEvent event;
4202 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4203 struct window *w = XWINDOW (window);
4204 struct frame *f = XFRAME (w->frame);
4205 int i;
4207 BLOCK_INPUT;
4209 /* Construct a ClientMessage event to send to the frame. */
4210 ev->type = ClientMessage;
4211 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4212 ev->display = FRAME_X_DISPLAY (f);
4213 ev->window = FRAME_X_WINDOW (f);
4214 ev->format = 32;
4216 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4217 not enough to store a pointer or Lisp_Object on a 64 bit system.
4218 So, store the window in scroll_bar_windows and pass the index
4219 into that array in the event. */
4220 for (i = 0; i < scroll_bar_windows_size; ++i)
4221 if (scroll_bar_windows[i] == NULL)
4222 break;
4224 if (i == scroll_bar_windows_size)
4226 int new_size = max (10, 2 * scroll_bar_windows_size);
4227 size_t nbytes = new_size * sizeof *scroll_bar_windows;
4228 size_t old_nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4230 scroll_bar_windows = (struct window **) xrealloc (scroll_bar_windows,
4231 nbytes);
4232 bzero (&scroll_bar_windows[i], nbytes - old_nbytes);
4233 scroll_bar_windows_size = new_size;
4236 scroll_bar_windows[i] = w;
4237 ev->data.l[0] = (long) i;
4238 ev->data.l[1] = (long) part;
4239 ev->data.l[2] = (long) 0;
4240 ev->data.l[3] = (long) portion;
4241 ev->data.l[4] = (long) whole;
4243 /* Make Xt timeouts work while the scroll bar is active. */
4244 toolkit_scroll_bar_interaction = 1;
4245 #ifdef USE_X_TOOLKIT
4246 x_activate_timeout_atimer ();
4247 #endif
4249 /* Setting the event mask to zero means that the message will
4250 be sent to the client that created the window, and if that
4251 window no longer exists, no event will be sent. */
4252 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4253 UNBLOCK_INPUT;
4257 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4258 in *IEVENT. */
4260 static void
4261 x_scroll_bar_to_input_event (event, ievent)
4262 XEvent *event;
4263 struct input_event *ievent;
4265 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4266 Lisp_Object window;
4267 struct frame *f;
4268 struct window *w;
4270 w = scroll_bar_windows[ev->data.l[0]];
4271 scroll_bar_windows[ev->data.l[0]] = NULL;
4273 XSETWINDOW (window, w);
4274 f = XFRAME (w->frame);
4276 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4277 ievent->frame_or_window = window;
4278 ievent->arg = Qnil;
4279 #ifdef USE_GTK
4280 ievent->timestamp = CurrentTime;
4281 #else
4282 ievent->timestamp = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
4283 #endif
4284 ievent->part = ev->data.l[1];
4285 ievent->code = ev->data.l[2];
4286 ievent->x = make_number ((int) ev->data.l[3]);
4287 ievent->y = make_number ((int) ev->data.l[4]);
4288 ievent->modifiers = 0;
4292 #ifdef USE_MOTIF
4294 /* Minimum and maximum values used for Motif scroll bars. */
4296 #define XM_SB_MAX 10000000
4299 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4300 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4301 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4303 static void
4304 xm_scroll_callback (widget, client_data, call_data)
4305 Widget widget;
4306 XtPointer client_data, call_data;
4308 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4309 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4310 int part = -1, whole = 0, portion = 0;
4312 switch (cs->reason)
4314 case XmCR_DECREMENT:
4315 bar->dragging = Qnil;
4316 part = scroll_bar_up_arrow;
4317 break;
4319 case XmCR_INCREMENT:
4320 bar->dragging = Qnil;
4321 part = scroll_bar_down_arrow;
4322 break;
4324 case XmCR_PAGE_DECREMENT:
4325 bar->dragging = Qnil;
4326 part = scroll_bar_above_handle;
4327 break;
4329 case XmCR_PAGE_INCREMENT:
4330 bar->dragging = Qnil;
4331 part = scroll_bar_below_handle;
4332 break;
4334 case XmCR_TO_TOP:
4335 bar->dragging = Qnil;
4336 part = scroll_bar_to_top;
4337 break;
4339 case XmCR_TO_BOTTOM:
4340 bar->dragging = Qnil;
4341 part = scroll_bar_to_bottom;
4342 break;
4344 case XmCR_DRAG:
4346 int slider_size;
4348 /* Get the slider size. */
4349 BLOCK_INPUT;
4350 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4351 UNBLOCK_INPUT;
4353 whole = XM_SB_MAX - slider_size;
4354 portion = min (cs->value, whole);
4355 part = scroll_bar_handle;
4356 bar->dragging = make_number (cs->value);
4358 break;
4360 case XmCR_VALUE_CHANGED:
4361 break;
4364 if (part >= 0)
4366 window_being_scrolled = bar->window;
4367 last_scroll_bar_part = part;
4368 x_send_scroll_bar_event (bar->window, part, portion, whole);
4372 #elif defined USE_GTK
4374 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4375 bar widget. DATA is a pointer to the scroll_bar structure. */
4377 static gboolean
4378 xg_scroll_callback (GtkRange *range,
4379 GtkScrollType scroll,
4380 gdouble value,
4381 gpointer user_data)
4383 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4384 gdouble position;
4385 int part = -1, whole = 0, portion = 0;
4386 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (range));
4387 FRAME_PTR f = (FRAME_PTR) g_object_get_data (G_OBJECT (range), XG_FRAME_DATA);
4389 if (xg_ignore_gtk_scrollbar) return FALSE;
4390 position = gtk_adjustment_get_value (adj);
4393 switch (scroll)
4395 case GTK_SCROLL_JUMP:
4396 /* Buttons 1 2 or 3 must be grabbed. */
4397 if (FRAME_X_DISPLAY_INFO (f)->grabbed != 0
4398 && FRAME_X_DISPLAY_INFO (f)->grabbed < (1 << 4))
4400 part = scroll_bar_handle;
4401 whole = adj->upper - adj->page_size;
4402 portion = min ((int)position, whole);
4403 bar->dragging = make_number ((int)portion);
4405 break;
4406 case GTK_SCROLL_STEP_BACKWARD:
4407 part = scroll_bar_up_arrow;
4408 bar->dragging = Qnil;
4409 break;
4410 case GTK_SCROLL_STEP_FORWARD:
4411 part = scroll_bar_down_arrow;
4412 bar->dragging = Qnil;
4413 break;
4414 case GTK_SCROLL_PAGE_BACKWARD:
4415 part = scroll_bar_above_handle;
4416 bar->dragging = Qnil;
4417 break;
4418 case GTK_SCROLL_PAGE_FORWARD:
4419 part = scroll_bar_below_handle;
4420 bar->dragging = Qnil;
4421 break;
4424 if (part >= 0)
4426 window_being_scrolled = bar->window;
4427 last_scroll_bar_part = part;
4428 x_send_scroll_bar_event (bar->window, part, portion, whole);
4431 return FALSE;
4434 /* Callback for button release. Sets dragging to Qnil when dragging is done. */
4436 static gboolean
4437 xg_end_scroll_callback (GtkWidget *widget,
4438 GdkEventButton *event,
4439 gpointer user_data)
4441 struct scroll_bar *bar = (struct scroll_bar *) user_data;
4442 bar->dragging = Qnil;
4443 if (WINDOWP (window_being_scrolled))
4445 x_send_scroll_bar_event (window_being_scrolled,
4446 scroll_bar_end_scroll, 0, 0);
4447 window_being_scrolled = Qnil;
4450 return FALSE;
4454 #else /* not USE_GTK and not USE_MOTIF */
4456 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4457 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4458 scroll bar struct. CALL_DATA is a pointer to a float saying where
4459 the thumb is. */
4461 static void
4462 xaw_jump_callback (widget, client_data, call_data)
4463 Widget widget;
4464 XtPointer client_data, call_data;
4466 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4467 float top = *(float *) call_data;
4468 float shown;
4469 int whole, portion, height;
4470 int part;
4472 /* Get the size of the thumb, a value between 0 and 1. */
4473 BLOCK_INPUT;
4474 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4475 UNBLOCK_INPUT;
4477 whole = 10000000;
4478 portion = shown < 1 ? top * whole : 0;
4480 if (shown < 1 && (eabs (top + shown - 1) < 1.0/height))
4481 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4482 the bottom, so we force the scrolling whenever we see that we're
4483 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4484 we try to ensure that we always stay two pixels away from the
4485 bottom). */
4486 part = scroll_bar_down_arrow;
4487 else
4488 part = scroll_bar_handle;
4490 window_being_scrolled = bar->window;
4491 bar->dragging = make_number (portion);
4492 last_scroll_bar_part = part;
4493 x_send_scroll_bar_event (bar->window, part, portion, whole);
4497 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4498 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4499 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4500 the scroll bar. CALL_DATA is an integer specifying the action that
4501 has taken place. Its magnitude is in the range 0..height of the
4502 scroll bar. Negative values mean scroll towards buffer start.
4503 Values < height of scroll bar mean line-wise movement. */
4505 static void
4506 xaw_scroll_callback (widget, client_data, call_data)
4507 Widget widget;
4508 XtPointer client_data, call_data;
4510 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4511 /* The position really is stored cast to a pointer. */
4512 int position = (long) call_data;
4513 Dimension height;
4514 int part;
4516 /* Get the height of the scroll bar. */
4517 BLOCK_INPUT;
4518 XtVaGetValues (widget, XtNheight, &height, NULL);
4519 UNBLOCK_INPUT;
4521 if (eabs (position) >= height)
4522 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4524 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4525 it maps line-movement to call_data = max(5, height/20). */
4526 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4527 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4528 else
4529 part = scroll_bar_move_ratio;
4531 window_being_scrolled = bar->window;
4532 bar->dragging = Qnil;
4533 last_scroll_bar_part = part;
4534 x_send_scroll_bar_event (bar->window, part, position, height);
4537 #endif /* not USE_GTK and not USE_MOTIF */
4539 #define SCROLL_BAR_NAME "verticalScrollBar"
4541 /* Create the widget for scroll bar BAR on frame F. Record the widget
4542 and X window of the scroll bar in BAR. */
4544 #ifdef USE_GTK
4545 static void
4546 x_create_toolkit_scroll_bar (f, bar)
4547 struct frame *f;
4548 struct scroll_bar *bar;
4550 char *scroll_bar_name = SCROLL_BAR_NAME;
4552 BLOCK_INPUT;
4553 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4554 G_CALLBACK (xg_end_scroll_callback),
4555 scroll_bar_name);
4556 UNBLOCK_INPUT;
4559 #else /* not USE_GTK */
4561 static void
4562 x_create_toolkit_scroll_bar (f, bar)
4563 struct frame *f;
4564 struct scroll_bar *bar;
4566 Window xwindow;
4567 Widget widget;
4568 Arg av[20];
4569 int ac = 0;
4570 char *scroll_bar_name = SCROLL_BAR_NAME;
4571 unsigned long pixel;
4573 BLOCK_INPUT;
4575 #ifdef USE_MOTIF
4576 /* Set resources. Create the widget. */
4577 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4578 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4579 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4580 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4581 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4582 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4583 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4585 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4586 if (pixel != -1)
4588 XtSetArg (av[ac], XmNforeground, pixel);
4589 ++ac;
4592 pixel = f->output_data.x->scroll_bar_background_pixel;
4593 if (pixel != -1)
4595 XtSetArg (av[ac], XmNbackground, pixel);
4596 ++ac;
4599 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4600 scroll_bar_name, av, ac);
4602 /* Add one callback for everything that can happen. */
4603 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4604 (XtPointer) bar);
4605 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4606 (XtPointer) bar);
4607 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4608 (XtPointer) bar);
4609 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4610 (XtPointer) bar);
4611 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4612 (XtPointer) bar);
4613 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4614 (XtPointer) bar);
4615 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4616 (XtPointer) bar);
4618 /* Realize the widget. Only after that is the X window created. */
4619 XtRealizeWidget (widget);
4621 /* Set the cursor to an arrow. I didn't find a resource to do that.
4622 And I'm wondering why it hasn't an arrow cursor by default. */
4623 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4624 f->output_data.x->nontext_cursor);
4626 #else /* !USE_MOTIF i.e. use Xaw */
4628 /* Set resources. Create the widget. The background of the
4629 Xaw3d scroll bar widget is a little bit light for my taste.
4630 We don't alter it here to let users change it according
4631 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4632 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4633 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4634 /* For smoother scrolling with Xaw3d -sm */
4635 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4637 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4638 if (pixel != -1)
4640 XtSetArg (av[ac], XtNforeground, pixel);
4641 ++ac;
4644 pixel = f->output_data.x->scroll_bar_background_pixel;
4645 if (pixel != -1)
4647 XtSetArg (av[ac], XtNbackground, pixel);
4648 ++ac;
4651 /* Top/bottom shadow colors. */
4653 /* Allocate them, if necessary. */
4654 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4656 pixel = f->output_data.x->scroll_bar_background_pixel;
4657 if (pixel != -1)
4659 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4660 FRAME_X_COLORMAP (f),
4661 &pixel, 1.2, 0x8000))
4662 pixel = -1;
4663 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4666 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4668 pixel = f->output_data.x->scroll_bar_background_pixel;
4669 if (pixel != -1)
4671 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
4672 FRAME_X_COLORMAP (f),
4673 &pixel, 0.6, 0x4000))
4674 pixel = -1;
4675 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4679 #ifdef XtNbeNiceToColormap
4680 /* Tell the toolkit about them. */
4681 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4682 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4683 /* We tried to allocate a color for the top/bottom shadow, and
4684 failed, so tell Xaw3d to use dithering instead. */
4686 XtSetArg (av[ac], XtNbeNiceToColormap, True);
4687 ++ac;
4689 else
4690 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4691 be more consistent with other emacs 3d colors, and since Xaw3d is
4692 not good at dealing with allocation failure. */
4694 /* This tells Xaw3d to use real colors instead of dithering for
4695 the shadows. */
4696 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4697 ++ac;
4699 /* Specify the colors. */
4700 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4701 if (pixel != -1)
4703 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4704 ++ac;
4706 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4707 if (pixel != -1)
4709 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4710 ++ac;
4713 #endif
4715 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4716 f->output_data.x->edit_widget, av, ac);
4719 char *initial = "";
4720 char *val = initial;
4721 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4722 #ifdef XtNarrowScrollbars
4723 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4724 #endif
4725 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4726 if (xaw3d_arrow_scroll || val == initial)
4727 { /* ARROW_SCROLL */
4728 xaw3d_arrow_scroll = True;
4729 /* Isn't that just a personal preference ? --Stef */
4730 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4734 /* Define callbacks. */
4735 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4736 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4737 (XtPointer) bar);
4739 /* Realize the widget. Only after that is the X window created. */
4740 XtRealizeWidget (widget);
4742 #endif /* !USE_MOTIF */
4744 /* Install an action hook that lets us detect when the user
4745 finishes interacting with a scroll bar. */
4746 if (action_hook_id == 0)
4747 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4749 /* Remember X window and widget in the scroll bar vector. */
4750 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4751 xwindow = XtWindow (widget);
4752 bar->x_window = xwindow;
4754 UNBLOCK_INPUT;
4756 #endif /* not USE_GTK */
4759 /* Set the thumb size and position of scroll bar BAR. We are currently
4760 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4762 #ifdef USE_GTK
4763 static void
4764 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4765 struct scroll_bar *bar;
4766 int portion, position, whole;
4768 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4771 #else /* not USE_GTK */
4772 static void
4773 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4774 struct scroll_bar *bar;
4775 int portion, position, whole;
4777 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4778 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4779 float top, shown;
4781 BLOCK_INPUT;
4783 #ifdef USE_MOTIF
4785 /* We use an estimate of 30 chars per line rather than the real
4786 `portion' value. This has the disadvantage that the thumb size
4787 is not very representative, but it makes our life a lot easier.
4788 Otherwise, we have to constantly adjust the thumb size, which
4789 we can't always do quickly enough: while dragging, the size of
4790 the thumb might prevent the user from dragging the thumb all the
4791 way to the end. but Motif and some versions of Xaw3d don't allow
4792 updating the thumb size while dragging. Also, even if we can update
4793 its size, the update will often happen too late.
4794 If you don't believe it, check out revision 1.650 of xterm.c to see
4795 what hoops we were going through and the still poor behavior we got. */
4796 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4797 /* When the thumb is at the bottom, position == whole.
4798 So we need to increase `whole' to make space for the thumb. */
4799 whole += portion;
4801 if (whole <= 0)
4802 top = 0, shown = 1;
4803 else
4805 top = (float) position / whole;
4806 shown = (float) portion / whole;
4809 if (NILP (bar->dragging))
4811 int size, value;
4813 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4814 is the scroll bar's maximum and MIN is the scroll bar's minimum
4815 value. */
4816 size = shown * XM_SB_MAX;
4817 size = min (size, XM_SB_MAX);
4818 size = max (size, 1);
4820 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4821 value = top * XM_SB_MAX;
4822 value = min (value, XM_SB_MAX - size);
4824 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4826 #else /* !USE_MOTIF i.e. use Xaw */
4828 if (whole == 0)
4829 top = 0, shown = 1;
4830 else
4832 top = (float) position / whole;
4833 shown = (float) portion / whole;
4837 float old_top, old_shown;
4838 Dimension height;
4839 XtVaGetValues (widget,
4840 XtNtopOfThumb, &old_top,
4841 XtNshown, &old_shown,
4842 XtNheight, &height,
4843 NULL);
4845 /* Massage the top+shown values. */
4846 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4847 top = max (0, min (1, top));
4848 else
4849 top = old_top;
4850 /* Keep two pixels available for moving the thumb down. */
4851 shown = max (0, min (1 - top - (2.0 / height), shown));
4853 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4854 check that your system's configuration file contains a define
4855 for `NARROWPROTO'. See s/freebsd.h for an example. */
4856 if (top != old_top || shown != old_shown)
4858 if (NILP (bar->dragging))
4859 XawScrollbarSetThumb (widget, top, shown);
4860 else
4862 /* Try to make the scrolling a tad smoother. */
4863 if (!xaw3d_pick_top)
4864 shown = min (shown, old_shown);
4866 XawScrollbarSetThumb (widget, top, shown);
4870 #endif /* !USE_MOTIF */
4872 UNBLOCK_INPUT;
4874 #endif /* not USE_GTK */
4876 #endif /* USE_TOOLKIT_SCROLL_BARS */
4880 /************************************************************************
4881 Scroll bars, general
4882 ************************************************************************/
4884 /* Create a scroll bar and return the scroll bar vector for it. W is
4885 the Emacs window on which to create the scroll bar. TOP, LEFT,
4886 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4887 scroll bar. */
4889 static struct scroll_bar *
4890 x_scroll_bar_create (w, top, left, width, height)
4891 struct window *w;
4892 int top, left, width, height;
4894 struct frame *f = XFRAME (w->frame);
4895 struct scroll_bar *bar
4896 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4898 BLOCK_INPUT;
4900 #ifdef USE_TOOLKIT_SCROLL_BARS
4901 x_create_toolkit_scroll_bar (f, bar);
4902 #else /* not USE_TOOLKIT_SCROLL_BARS */
4904 XSetWindowAttributes a;
4905 unsigned long mask;
4906 Window window;
4908 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4909 if (a.background_pixel == -1)
4910 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4912 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4913 | ButtonMotionMask | PointerMotionHintMask
4914 | ExposureMask);
4915 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4917 mask = (CWBackPixel | CWEventMask | CWCursor);
4919 /* Clear the area of W that will serve as a scroll bar. This is
4920 for the case that a window has been split horizontally. In
4921 this case, no clear_frame is generated to reduce flickering. */
4922 if (width > 0 && height > 0)
4923 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4924 left, top, width,
4925 window_box_height (w), False);
4927 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4928 /* Position and size of scroll bar. */
4929 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4930 top,
4931 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4932 height,
4933 /* Border width, depth, class, and visual. */
4935 CopyFromParent,
4936 CopyFromParent,
4937 CopyFromParent,
4938 /* Attributes. */
4939 mask, &a);
4940 bar->x_window = window;
4942 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4944 XSETWINDOW (bar->window, w);
4945 bar->top = top;
4946 bar->left = left;
4947 bar->width = width;
4948 bar->height = height;
4949 bar->start = 0;
4950 bar->end = 0;
4951 bar->dragging = Qnil;
4952 bar->fringe_extended_p = 0;
4954 /* Add bar to its frame's list of scroll bars. */
4955 bar->next = FRAME_SCROLL_BARS (f);
4956 bar->prev = Qnil;
4957 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4958 if (!NILP (bar->next))
4959 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4961 /* Map the window/widget. */
4962 #ifdef USE_TOOLKIT_SCROLL_BARS
4964 #ifdef USE_GTK
4965 xg_update_scrollbar_pos (f,
4966 bar->x_window,
4967 top,
4968 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4969 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4970 max (height, 1));
4971 xg_show_scroll_bar (bar->x_window);
4972 #else /* not USE_GTK */
4973 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4974 XtConfigureWidget (scroll_bar,
4975 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4976 top,
4977 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4978 max (height, 1), 0);
4979 XtMapWidget (scroll_bar);
4980 #endif /* not USE_GTK */
4982 #else /* not USE_TOOLKIT_SCROLL_BARS */
4983 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
4984 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4986 UNBLOCK_INPUT;
4987 return bar;
4991 #ifndef USE_TOOLKIT_SCROLL_BARS
4993 /* Draw BAR's handle in the proper position.
4995 If the handle is already drawn from START to END, don't bother
4996 redrawing it, unless REBUILD is non-zero; in that case, always
4997 redraw it. (REBUILD is handy for drawing the handle after expose
4998 events.)
5000 Normally, we want to constrain the start and end of the handle to
5001 fit inside its rectangle, but if the user is dragging the scroll
5002 bar handle, we want to let them drag it down all the way, so that
5003 the bar's top is as far down as it goes; otherwise, there's no way
5004 to move to the very end of the buffer. */
5006 static void
5007 x_scroll_bar_set_handle (bar, start, end, rebuild)
5008 struct scroll_bar *bar;
5009 int start, end;
5010 int rebuild;
5012 int dragging = ! NILP (bar->dragging);
5013 Window w = bar->x_window;
5014 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5015 GC gc = f->output_data.x->normal_gc;
5017 /* If the display is already accurate, do nothing. */
5018 if (! rebuild
5019 && start == bar->start
5020 && end == bar->end)
5021 return;
5023 BLOCK_INPUT;
5026 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
5027 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
5028 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5030 /* Make sure the values are reasonable, and try to preserve
5031 the distance between start and end. */
5033 int length = end - start;
5035 if (start < 0)
5036 start = 0;
5037 else if (start > top_range)
5038 start = top_range;
5039 end = start + length;
5041 if (end < start)
5042 end = start;
5043 else if (end > top_range && ! dragging)
5044 end = top_range;
5047 /* Store the adjusted setting in the scroll bar. */
5048 bar->start = start;
5049 bar->end = end;
5051 /* Clip the end position, just for display. */
5052 if (end > top_range)
5053 end = top_range;
5055 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
5056 below top positions, to make sure the handle is always at least
5057 that many pixels tall. */
5058 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
5060 /* Draw the empty space above the handle. Note that we can't clear
5061 zero-height areas; that means "clear to end of window." */
5062 if (0 < start)
5063 x_clear_area (FRAME_X_DISPLAY (f), w,
5064 /* x, y, width, height, and exposures. */
5065 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5066 VERTICAL_SCROLL_BAR_TOP_BORDER,
5067 inside_width, start,
5068 False);
5070 /* Change to proper foreground color if one is specified. */
5071 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5072 XSetForeground (FRAME_X_DISPLAY (f), gc,
5073 f->output_data.x->scroll_bar_foreground_pixel);
5075 /* Draw the handle itself. */
5076 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5077 /* x, y, width, height */
5078 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5079 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5080 inside_width, end - start);
5082 /* Restore the foreground color of the GC if we changed it above. */
5083 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5084 XSetForeground (FRAME_X_DISPLAY (f), gc,
5085 FRAME_FOREGROUND_PIXEL (f));
5087 /* Draw the empty space below the handle. Note that we can't
5088 clear zero-height areas; that means "clear to end of window." */
5089 if (end < inside_height)
5090 x_clear_area (FRAME_X_DISPLAY (f), w,
5091 /* x, y, width, height, and exposures. */
5092 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5093 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5094 inside_width, inside_height - end,
5095 False);
5099 UNBLOCK_INPUT;
5102 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5104 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5105 nil. */
5107 static void
5108 x_scroll_bar_remove (bar)
5109 struct scroll_bar *bar;
5111 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5112 BLOCK_INPUT;
5114 #ifdef USE_TOOLKIT_SCROLL_BARS
5115 #ifdef USE_GTK
5116 xg_remove_scroll_bar (f, bar->x_window);
5117 #else /* not USE_GTK */
5118 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5119 #endif /* not USE_GTK */
5120 #else
5121 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5122 #endif
5124 /* Disassociate this scroll bar from its window. */
5125 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
5127 UNBLOCK_INPUT;
5131 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5132 that we are displaying PORTION characters out of a total of WHOLE
5133 characters, starting at POSITION. If WINDOW has no scroll bar,
5134 create one. */
5136 static void
5137 XTset_vertical_scroll_bar (w, portion, whole, position)
5138 struct window *w;
5139 int portion, whole, position;
5141 struct frame *f = XFRAME (w->frame);
5142 struct scroll_bar *bar;
5143 int top, height, left, sb_left, width, sb_width;
5144 int window_y, window_height;
5145 #ifdef USE_TOOLKIT_SCROLL_BARS
5146 int fringe_extended_p;
5147 #endif
5149 /* Get window dimensions. */
5150 window_box (w, -1, 0, &window_y, 0, &window_height);
5151 top = window_y;
5152 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5153 height = window_height;
5155 /* Compute the left edge of the scroll bar area. */
5156 left = WINDOW_SCROLL_BAR_AREA_X (w);
5158 /* Compute the width of the scroll bar which might be less than
5159 the width of the area reserved for the scroll bar. */
5160 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5161 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5162 else
5163 sb_width = width;
5165 /* Compute the left edge of the scroll bar. */
5166 #ifdef USE_TOOLKIT_SCROLL_BARS
5167 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5168 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5169 else
5170 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5171 #else
5172 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5173 sb_left = left + width - sb_width;
5174 else
5175 sb_left = left;
5176 #endif
5178 #ifdef USE_TOOLKIT_SCROLL_BARS
5179 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5180 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5181 && WINDOW_LEFT_FRINGE_WIDTH (w)
5182 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5183 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5184 else
5185 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5186 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5187 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5188 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5189 #endif
5191 /* Does the scroll bar exist yet? */
5192 if (NILP (w->vertical_scroll_bar))
5194 if (width > 0 && height > 0)
5196 BLOCK_INPUT;
5197 #ifdef USE_TOOLKIT_SCROLL_BARS
5198 if (fringe_extended_p)
5199 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5200 sb_left, top, sb_width, height, False);
5201 else
5202 #endif
5203 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5204 left, top, width, height, False);
5205 UNBLOCK_INPUT;
5208 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5210 else
5212 /* It may just need to be moved and resized. */
5213 unsigned int mask = 0;
5215 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5217 BLOCK_INPUT;
5219 if (sb_left != bar->left)
5220 mask |= CWX;
5221 if (top != bar->top)
5222 mask |= CWY;
5223 if (sb_width != bar->width)
5224 mask |= CWWidth;
5225 if (height != bar->height)
5226 mask |= CWHeight;
5228 #ifdef USE_TOOLKIT_SCROLL_BARS
5230 /* Move/size the scroll bar widget. */
5231 if (mask || bar->fringe_extended_p != fringe_extended_p)
5233 /* Since toolkit scroll bars are smaller than the space reserved
5234 for them on the frame, we have to clear "under" them. */
5235 if (width > 0 && height > 0)
5237 if (fringe_extended_p)
5238 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5239 sb_left, top, sb_width, height, False);
5240 else
5241 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5242 left, top, width, height, False);
5244 #ifdef USE_GTK
5245 xg_update_scrollbar_pos (f,
5246 bar->x_window,
5247 top,
5248 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5249 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5250 max (height, 1));
5251 #else /* not USE_GTK */
5252 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5253 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5254 top,
5255 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5256 max (height, 1), 0);
5257 #endif /* not USE_GTK */
5259 #else /* not USE_TOOLKIT_SCROLL_BARS */
5261 /* Clear areas not covered by the scroll bar because of
5262 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5263 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5265 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5266 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5267 height, False);
5268 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5269 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5270 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5271 height, False);
5274 /* Clear areas not covered by the scroll bar because it's not as
5275 wide as the area reserved for it. This makes sure a
5276 previous mode line display is cleared after C-x 2 C-x 1, for
5277 example. */
5279 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5280 int rest = area_width - sb_width;
5281 if (rest > 0 && height > 0)
5283 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5284 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5285 left + area_width - rest, top,
5286 rest, height, False);
5287 else
5288 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5289 left, top, rest, height, False);
5293 /* Move/size the scroll bar window. */
5294 if (mask)
5296 XWindowChanges wc;
5298 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5299 wc.y = top;
5300 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5301 wc.height = height;
5302 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5303 mask, &wc);
5306 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5308 /* Remember new settings. */
5309 bar->left = sb_left;
5310 bar->top = top;
5311 bar->width = sb_width;
5312 bar->height = height;
5314 UNBLOCK_INPUT;
5317 #ifdef USE_TOOLKIT_SCROLL_BARS
5318 bar->fringe_extended_p = fringe_extended_p;
5320 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5321 #else /* not USE_TOOLKIT_SCROLL_BARS */
5322 /* Set the scroll bar's current state, unless we're currently being
5323 dragged. */
5324 if (NILP (bar->dragging))
5326 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5328 if (whole == 0)
5329 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5330 else
5332 int start = ((double) position * top_range) / whole;
5333 int end = ((double) (position + portion) * top_range) / whole;
5334 x_scroll_bar_set_handle (bar, start, end, 0);
5337 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5339 XSETVECTOR (w->vertical_scroll_bar, bar);
5343 /* The following three hooks are used when we're doing a thorough
5344 redisplay of the frame. We don't explicitly know which scroll bars
5345 are going to be deleted, because keeping track of when windows go
5346 away is a real pain - "Can you say set-window-configuration, boys
5347 and girls?" Instead, we just assert at the beginning of redisplay
5348 that *all* scroll bars are to be removed, and then save a scroll bar
5349 from the fiery pit when we actually redisplay its window. */
5351 /* Arrange for all scroll bars on FRAME to be removed at the next call
5352 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5353 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5355 static void
5356 XTcondemn_scroll_bars (frame)
5357 FRAME_PTR frame;
5359 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5360 while (! NILP (FRAME_SCROLL_BARS (frame)))
5362 Lisp_Object bar;
5363 bar = FRAME_SCROLL_BARS (frame);
5364 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5365 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5366 XSCROLL_BAR (bar)->prev = Qnil;
5367 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5368 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5369 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5374 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5375 Note that WINDOW isn't necessarily condemned at all. */
5377 static void
5378 XTredeem_scroll_bar (window)
5379 struct window *window;
5381 struct scroll_bar *bar;
5382 struct frame *f;
5384 /* We can't redeem this window's scroll bar if it doesn't have one. */
5385 if (NILP (window->vertical_scroll_bar))
5386 abort ();
5388 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5390 /* Unlink it from the condemned list. */
5391 f = XFRAME (WINDOW_FRAME (window));
5392 if (NILP (bar->prev))
5394 /* If the prev pointer is nil, it must be the first in one of
5395 the lists. */
5396 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5397 /* It's not condemned. Everything's fine. */
5398 return;
5399 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5400 window->vertical_scroll_bar))
5401 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5402 else
5403 /* If its prev pointer is nil, it must be at the front of
5404 one or the other! */
5405 abort ();
5407 else
5408 XSCROLL_BAR (bar->prev)->next = bar->next;
5410 if (! NILP (bar->next))
5411 XSCROLL_BAR (bar->next)->prev = bar->prev;
5413 bar->next = FRAME_SCROLL_BARS (f);
5414 bar->prev = Qnil;
5415 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5416 if (! NILP (bar->next))
5417 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5420 /* Remove all scroll bars on FRAME that haven't been saved since the
5421 last call to `*condemn_scroll_bars_hook'. */
5423 static void
5424 XTjudge_scroll_bars (f)
5425 FRAME_PTR f;
5427 Lisp_Object bar, next;
5429 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5431 /* Clear out the condemned list now so we won't try to process any
5432 more events on the hapless scroll bars. */
5433 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5435 for (; ! NILP (bar); bar = next)
5437 struct scroll_bar *b = XSCROLL_BAR (bar);
5439 x_scroll_bar_remove (b);
5441 next = b->next;
5442 b->next = b->prev = Qnil;
5445 /* Now there should be no references to the condemned scroll bars,
5446 and they should get garbage-collected. */
5450 #ifndef USE_TOOLKIT_SCROLL_BARS
5451 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5452 is a no-op when using toolkit scroll bars.
5454 This may be called from a signal handler, so we have to ignore GC
5455 mark bits. */
5457 static void
5458 x_scroll_bar_expose (bar, event)
5459 struct scroll_bar *bar;
5460 XEvent *event;
5462 Window w = bar->x_window;
5463 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5464 GC gc = f->output_data.x->normal_gc;
5465 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5467 BLOCK_INPUT;
5469 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5471 /* Switch to scroll bar foreground color. */
5472 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5473 XSetForeground (FRAME_X_DISPLAY (f), gc,
5474 f->output_data.x->scroll_bar_foreground_pixel);
5476 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5477 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5479 /* x, y, width, height */
5480 0, 0,
5481 bar->width - 1 - width_trim - width_trim,
5482 bar->height - 1);
5484 /* Restore the foreground color of the GC if we changed it above. */
5485 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5486 XSetForeground (FRAME_X_DISPLAY (f), gc,
5487 FRAME_FOREGROUND_PIXEL (f));
5489 UNBLOCK_INPUT;
5492 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5494 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5495 is set to something other than NO_EVENT, it is enqueued.
5497 This may be called from a signal handler, so we have to ignore GC
5498 mark bits. */
5501 static void
5502 x_scroll_bar_handle_click (bar, event, emacs_event)
5503 struct scroll_bar *bar;
5504 XEvent *event;
5505 struct input_event *emacs_event;
5507 if (! WINDOWP (bar->window))
5508 abort ();
5510 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5511 emacs_event->code = event->xbutton.button - Button1;
5512 emacs_event->modifiers
5513 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5514 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5515 event->xbutton.state)
5516 | (event->type == ButtonRelease
5517 ? up_modifier
5518 : down_modifier));
5519 emacs_event->frame_or_window = bar->window;
5520 emacs_event->arg = Qnil;
5521 emacs_event->timestamp = event->xbutton.time;
5523 int top_range
5524 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5525 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5527 if (y < 0) y = 0;
5528 if (y > top_range) y = top_range;
5530 if (y < bar->start)
5531 emacs_event->part = scroll_bar_above_handle;
5532 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5533 emacs_event->part = scroll_bar_handle;
5534 else
5535 emacs_event->part = scroll_bar_below_handle;
5537 #ifndef USE_TOOLKIT_SCROLL_BARS
5538 /* If the user has released the handle, set it to its final position. */
5539 if (event->type == ButtonRelease
5540 && ! NILP (bar->dragging))
5542 int new_start = y - XINT (bar->dragging);
5543 int new_end = new_start + bar->end - bar->start;
5545 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5546 bar->dragging = Qnil;
5548 #endif
5550 XSETINT (emacs_event->x, y);
5551 XSETINT (emacs_event->y, top_range);
5555 #ifndef USE_TOOLKIT_SCROLL_BARS
5557 /* Handle some mouse motion while someone is dragging the scroll bar.
5559 This may be called from a signal handler, so we have to ignore GC
5560 mark bits. */
5562 static void
5563 x_scroll_bar_note_movement (bar, event)
5564 struct scroll_bar *bar;
5565 XEvent *event;
5567 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5569 last_mouse_movement_time = event->xmotion.time;
5571 f->mouse_moved = 1;
5572 XSETVECTOR (last_mouse_scroll_bar, bar);
5574 /* If we're dragging the bar, display it. */
5575 if (! NILP (bar->dragging))
5577 /* Where should the handle be now? */
5578 int new_start = event->xmotion.y - XINT (bar->dragging);
5580 if (new_start != bar->start)
5582 int new_end = new_start + bar->end - bar->start;
5584 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5589 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5591 /* Return information to the user about the current position of the mouse
5592 on the scroll bar. */
5594 static void
5595 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time)
5596 FRAME_PTR *fp;
5597 Lisp_Object *bar_window;
5598 enum scroll_bar_part *part;
5599 Lisp_Object *x, *y;
5600 unsigned long *time;
5602 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5603 Window w = bar->x_window;
5604 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5605 int win_x, win_y;
5606 Window dummy_window;
5607 int dummy_coord;
5608 unsigned int dummy_mask;
5610 BLOCK_INPUT;
5612 /* Get the mouse's position relative to the scroll bar window, and
5613 report that. */
5614 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5616 /* Root, child, root x and root y. */
5617 &dummy_window, &dummy_window,
5618 &dummy_coord, &dummy_coord,
5620 /* Position relative to scroll bar. */
5621 &win_x, &win_y,
5623 /* Mouse buttons and modifier keys. */
5624 &dummy_mask))
5626 else
5628 int top_range
5629 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5631 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5633 if (! NILP (bar->dragging))
5634 win_y -= XINT (bar->dragging);
5636 if (win_y < 0)
5637 win_y = 0;
5638 if (win_y > top_range)
5639 win_y = top_range;
5641 *fp = f;
5642 *bar_window = bar->window;
5644 if (! NILP (bar->dragging))
5645 *part = scroll_bar_handle;
5646 else if (win_y < bar->start)
5647 *part = scroll_bar_above_handle;
5648 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5649 *part = scroll_bar_handle;
5650 else
5651 *part = scroll_bar_below_handle;
5653 XSETINT (*x, win_y);
5654 XSETINT (*y, top_range);
5656 f->mouse_moved = 0;
5657 last_mouse_scroll_bar = Qnil;
5660 *time = last_mouse_movement_time;
5662 UNBLOCK_INPUT;
5666 /* The screen has been cleared so we may have changed foreground or
5667 background colors, and the scroll bars may need to be redrawn.
5668 Clear out the scroll bars, and ask for expose events, so we can
5669 redraw them. */
5671 void
5672 x_scroll_bar_clear (f)
5673 FRAME_PTR f;
5675 #ifndef USE_TOOLKIT_SCROLL_BARS
5676 Lisp_Object bar;
5678 /* We can have scroll bars even if this is 0,
5679 if we just turned off scroll bar mode.
5680 But in that case we should not clear them. */
5681 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5682 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5683 bar = XSCROLL_BAR (bar)->next)
5684 XClearArea (FRAME_X_DISPLAY (f),
5685 XSCROLL_BAR (bar)->x_window,
5686 0, 0, 0, 0, True);
5687 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5691 /* The main X event-reading loop - XTread_socket. */
5693 /* This holds the state XLookupString needs to implement dead keys
5694 and other tricks known as "compose processing". _X Window System_
5695 says that a portable program can't use this, but Stephen Gildea assures
5696 me that letting the compiler initialize it to zeros will work okay.
5698 This must be defined outside of XTread_socket, for the same reasons
5699 given for enter_timestamp, above. */
5701 static XComposeStatus compose_status;
5703 /* Record the last 100 characters stored
5704 to help debug the loss-of-chars-during-GC problem. */
5706 static int temp_index;
5707 static short temp_buffer[100];
5709 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5710 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5711 temp_index = 0; \
5712 temp_buffer[temp_index++] = (keysym)
5714 /* Set this to nonzero to fake an "X I/O error"
5715 on a particular display. */
5717 struct x_display_info *XTread_socket_fake_io_error;
5719 /* When we find no input here, we occasionally do a no-op command
5720 to verify that the X server is still running and we can still talk with it.
5721 We try all the open displays, one by one.
5722 This variable is used for cycling thru the displays. */
5724 static struct x_display_info *next_noop_dpyinfo;
5726 #define SET_SAVED_MENU_EVENT(size) \
5727 do \
5729 if (f->output_data.x->saved_menu_event == 0) \
5730 f->output_data.x->saved_menu_event \
5731 = (XEvent *) xmalloc (sizeof (XEvent)); \
5732 bcopy (&event, f->output_data.x->saved_menu_event, size); \
5733 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5734 XSETFRAME (inev.ie.frame_or_window, f); \
5736 while (0)
5738 #define SET_SAVED_BUTTON_EVENT SET_SAVED_MENU_EVENT (sizeof (XButtonEvent))
5739 #define SET_SAVED_KEY_EVENT SET_SAVED_MENU_EVENT (sizeof (XKeyEvent))
5742 enum
5744 X_EVENT_NORMAL,
5745 X_EVENT_GOTO_OUT,
5746 X_EVENT_DROP
5749 /* Filter events for the current X input method.
5750 DPYINFO is the display this event is for.
5751 EVENT is the X event to filter.
5753 Returns non-zero if the event was filtered, caller shall not process
5754 this event further.
5755 Returns zero if event is wasn't filtered. */
5757 #ifdef HAVE_X_I18N
5758 static int
5759 x_filter_event (dpyinfo, event)
5760 struct x_display_info *dpyinfo;
5761 XEvent *event;
5763 /* XFilterEvent returns non-zero if the input method has
5764 consumed the event. We pass the frame's X window to
5765 XFilterEvent because that's the one for which the IC
5766 was created. */
5768 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5769 event->xclient.window);
5771 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5773 #endif
5775 #ifdef USE_GTK
5776 static int current_count;
5777 static int current_finish;
5778 static struct input_event *current_hold_quit;
5780 /* This is the filter function invoked by the GTK event loop.
5781 It is invoked before the XEvent is translated to a GdkEvent,
5782 so we have a chance to act on the event before GTK. */
5783 static GdkFilterReturn
5784 event_handler_gdk (gxev, ev, data)
5785 GdkXEvent *gxev;
5786 GdkEvent *ev;
5787 gpointer data;
5789 XEvent *xev = (XEvent *) gxev;
5791 if (current_count >= 0)
5793 struct x_display_info *dpyinfo;
5795 dpyinfo = x_display_info_for_display (xev->xany.display);
5797 #ifdef HAVE_X_I18N
5798 /* Filter events for the current X input method.
5799 GTK calls XFilterEvent but not for key press and release,
5800 so we do it here. */
5801 if (xev->type == KeyPress || xev->type == KeyRelease)
5802 if (dpyinfo && x_filter_event (dpyinfo, xev))
5803 return GDK_FILTER_REMOVE;
5804 #endif
5806 if (! dpyinfo)
5807 current_finish = X_EVENT_NORMAL;
5808 else
5810 current_count +=
5811 handle_one_xevent (dpyinfo, xev, &current_finish,
5812 current_hold_quit);
5815 else
5816 current_finish = x_dispatch_event (xev, xev->xany.display);
5818 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5819 return GDK_FILTER_REMOVE;
5821 return GDK_FILTER_CONTINUE;
5823 #endif /* USE_GTK */
5826 /* Handles the XEvent EVENT on display DPYINFO.
5828 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5829 *FINISH is zero if caller should continue reading events.
5830 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5832 We return the number of characters stored into the buffer. */
5834 static int
5835 handle_one_xevent (dpyinfo, eventp, finish, hold_quit)
5836 struct x_display_info *dpyinfo;
5837 XEvent *eventp;
5838 int *finish;
5839 struct input_event *hold_quit;
5841 union {
5842 struct input_event ie;
5843 struct selection_input_event sie;
5844 } inev;
5845 int count = 0;
5846 int do_help = 0;
5847 int nbytes = 0;
5848 struct frame *f = NULL;
5849 struct coding_system coding;
5850 XEvent event = *eventp;
5852 *finish = X_EVENT_NORMAL;
5854 EVENT_INIT (inev.ie);
5855 inev.ie.kind = NO_EVENT;
5856 inev.ie.arg = Qnil;
5858 if (pending_event_wait.eventtype == event.type)
5859 pending_event_wait.eventtype = 0; /* Indicates we got it. */
5861 switch (event.type)
5863 case ClientMessage:
5865 if (event.xclient.message_type
5866 == dpyinfo->Xatom_wm_protocols
5867 && event.xclient.format == 32)
5869 if (event.xclient.data.l[0]
5870 == dpyinfo->Xatom_wm_take_focus)
5872 /* Use x_any_window_to_frame because this
5873 could be the shell widget window
5874 if the frame has no title bar. */
5875 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5876 #ifdef HAVE_X_I18N
5877 /* Not quite sure this is needed -pd */
5878 if (f && FRAME_XIC (f))
5879 XSetICFocus (FRAME_XIC (f));
5880 #endif
5881 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5882 instructs the WM to set the input focus automatically for
5883 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5884 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5885 it has set the focus. So, XSetInputFocus below is not
5886 needed.
5888 The call to XSetInputFocus below has also caused trouble. In
5889 cases where the XSetInputFocus done by the WM and the one
5890 below are temporally close (on a fast machine), the call
5891 below can generate additional FocusIn events which confuse
5892 Emacs. */
5894 /* Since we set WM_TAKE_FOCUS, we must call
5895 XSetInputFocus explicitly. But not if f is null,
5896 since that might be an event for a deleted frame. */
5897 if (f)
5899 Display *d = event.xclient.display;
5900 /* Catch and ignore errors, in case window has been
5901 iconified by a window manager such as GWM. */
5902 x_catch_errors (d);
5903 XSetInputFocus (d, event.xclient.window,
5904 /* The ICCCM says this is
5905 the only valid choice. */
5906 RevertToParent,
5907 event.xclient.data.l[1]);
5908 /* This is needed to detect the error
5909 if there is an error. */
5910 XSync (d, False);
5911 x_uncatch_errors ();
5913 /* Not certain about handling scroll bars here */
5914 #endif /* 0 */
5915 goto done;
5918 if (event.xclient.data.l[0]
5919 == dpyinfo->Xatom_wm_save_yourself)
5921 /* Save state modify the WM_COMMAND property to
5922 something which can reinstate us. This notifies
5923 the session manager, who's looking for such a
5924 PropertyNotify. Can restart processing when
5925 a keyboard or mouse event arrives. */
5926 /* If we have a session manager, don't set this.
5927 KDE will then start two Emacsen, one for the
5928 session manager and one for this. */
5929 #ifdef HAVE_X_SM
5930 if (! x_session_have_connection ())
5931 #endif
5933 f = x_top_window_to_frame (dpyinfo,
5934 event.xclient.window);
5935 /* This is just so we only give real data once
5936 for a single Emacs process. */
5937 if (f == SELECTED_FRAME ())
5938 XSetCommand (FRAME_X_DISPLAY (f),
5939 event.xclient.window,
5940 initial_argv, initial_argc);
5941 else if (f)
5942 XSetCommand (FRAME_X_DISPLAY (f),
5943 event.xclient.window,
5944 0, 0);
5946 goto done;
5949 if (event.xclient.data.l[0]
5950 == dpyinfo->Xatom_wm_delete_window)
5952 f = x_any_window_to_frame (dpyinfo,
5953 event.xclient.window);
5954 if (!f)
5955 goto OTHER; /* May be a dialog that is to be removed */
5957 inev.ie.kind = DELETE_WINDOW_EVENT;
5958 XSETFRAME (inev.ie.frame_or_window, f);
5959 goto done;
5962 goto done;
5965 if (event.xclient.message_type
5966 == dpyinfo->Xatom_wm_configure_denied)
5968 goto done;
5971 if (event.xclient.message_type
5972 == dpyinfo->Xatom_wm_window_moved)
5974 int new_x, new_y;
5975 f = x_window_to_frame (dpyinfo, event.xclient.window);
5977 new_x = event.xclient.data.s[0];
5978 new_y = event.xclient.data.s[1];
5980 if (f)
5982 f->left_pos = new_x;
5983 f->top_pos = new_y;
5985 goto done;
5988 #ifdef HACK_EDITRES
5989 if (event.xclient.message_type
5990 == dpyinfo->Xatom_editres)
5992 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5993 if (f)
5994 _XEditResCheckMessages (f->output_data.x->widget, NULL,
5995 &event, NULL);
5996 goto done;
5998 #endif /* HACK_EDITRES */
6000 if ((event.xclient.message_type
6001 == dpyinfo->Xatom_DONE)
6002 || (event.xclient.message_type
6003 == dpyinfo->Xatom_PAGE))
6005 /* Ghostview job completed. Kill it. We could
6006 reply with "Next" if we received "Page", but we
6007 currently never do because we are interested in
6008 images, only, which should have 1 page. */
6009 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
6010 f = x_window_to_frame (dpyinfo, event.xclient.window);
6011 if (!f)
6012 goto OTHER;
6013 x_kill_gs_process (pixmap, f);
6014 expose_frame (f, 0, 0, 0, 0);
6015 goto done;
6018 #ifdef USE_TOOLKIT_SCROLL_BARS
6019 /* Scroll bar callbacks send a ClientMessage from which
6020 we construct an input_event. */
6021 if (event.xclient.message_type
6022 == dpyinfo->Xatom_Scrollbar)
6024 x_scroll_bar_to_input_event (&event, &inev.ie);
6025 *finish = X_EVENT_GOTO_OUT;
6026 goto done;
6028 #endif /* USE_TOOLKIT_SCROLL_BARS */
6030 /* XEmbed messages from the embedder (if any). */
6031 if (event.xclient.message_type
6032 == dpyinfo->Xatom_XEMBED)
6034 enum xembed_message msg = event.xclient.data.l[1];
6035 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
6036 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6038 *finish = X_EVENT_GOTO_OUT;
6039 goto done;
6042 xft_settings_event (dpyinfo, &event);
6044 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
6045 if (!f)
6046 goto OTHER;
6047 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
6048 *finish = X_EVENT_DROP;
6050 break;
6052 case SelectionNotify:
6053 last_user_time = event.xselection.time;
6054 #ifdef USE_X_TOOLKIT
6055 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
6056 goto OTHER;
6057 #endif /* not USE_X_TOOLKIT */
6058 x_handle_selection_notify (&event.xselection);
6059 break;
6061 case SelectionClear: /* Someone has grabbed ownership. */
6062 last_user_time = event.xselectionclear.time;
6063 #ifdef USE_X_TOOLKIT
6064 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
6065 goto OTHER;
6066 #endif /* USE_X_TOOLKIT */
6068 XSelectionClearEvent *eventp = (XSelectionClearEvent *) &event;
6070 inev.ie.kind = SELECTION_CLEAR_EVENT;
6071 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6072 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6073 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6074 inev.ie.frame_or_window = Qnil;
6076 break;
6078 case SelectionRequest: /* Someone wants our selection. */
6079 last_user_time = event.xselectionrequest.time;
6080 #ifdef USE_X_TOOLKIT
6081 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6082 goto OTHER;
6083 #endif /* USE_X_TOOLKIT */
6085 XSelectionRequestEvent *eventp
6086 = (XSelectionRequestEvent *) &event;
6088 inev.ie.kind = SELECTION_REQUEST_EVENT;
6089 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6090 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6091 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6092 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6093 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6094 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6095 inev.ie.frame_or_window = Qnil;
6097 break;
6099 case PropertyNotify:
6100 last_user_time = event.xproperty.time;
6101 f = x_top_window_to_frame (dpyinfo, event.xproperty.window);
6102 if (f && event.xproperty.atom == dpyinfo->Xatom_net_wm_state)
6103 x_handle_net_wm_state (f, &event.xproperty);
6105 x_handle_property_notify (&event.xproperty);
6106 xft_settings_event (dpyinfo, &event);
6107 goto OTHER;
6109 case ReparentNotify:
6110 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6111 if (f)
6113 int x, y;
6114 f->output_data.x->parent_desc = event.xreparent.parent;
6115 x_real_positions (f, &x, &y);
6116 f->left_pos = x;
6117 f->top_pos = y;
6119 /* Perhaps reparented due to a WM restart. Reset this. */
6120 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6121 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6123 goto OTHER;
6125 case Expose:
6126 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6127 if (f)
6129 #ifdef USE_GTK
6130 /* This seems to be needed for GTK 2.6. */
6131 x_clear_area (event.xexpose.display,
6132 event.xexpose.window,
6133 event.xexpose.x, event.xexpose.y,
6134 event.xexpose.width, event.xexpose.height,
6135 FALSE);
6136 #endif
6137 if (f->async_visible == 0)
6139 f->async_visible = 1;
6140 f->async_iconified = 0;
6141 f->output_data.x->has_been_visible = 1;
6142 SET_FRAME_GARBAGED (f);
6144 else
6145 expose_frame (f,
6146 event.xexpose.x, event.xexpose.y,
6147 event.xexpose.width, event.xexpose.height);
6149 else
6151 #ifndef USE_TOOLKIT_SCROLL_BARS
6152 struct scroll_bar *bar;
6153 #endif
6154 #if defined USE_LUCID
6155 /* Submenus of the Lucid menu bar aren't widgets
6156 themselves, so there's no way to dispatch events
6157 to them. Recognize this case separately. */
6159 Widget widget
6160 = x_window_to_menu_bar (event.xexpose.window);
6161 if (widget)
6162 xlwmenu_redisplay (widget);
6164 #endif /* USE_LUCID */
6166 #ifdef USE_TOOLKIT_SCROLL_BARS
6167 /* Dispatch event to the widget. */
6168 goto OTHER;
6169 #else /* not USE_TOOLKIT_SCROLL_BARS */
6170 bar = x_window_to_scroll_bar (event.xexpose.display,
6171 event.xexpose.window);
6173 if (bar)
6174 x_scroll_bar_expose (bar, &event);
6175 #ifdef USE_X_TOOLKIT
6176 else
6177 goto OTHER;
6178 #endif /* USE_X_TOOLKIT */
6179 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6181 break;
6183 case GraphicsExpose: /* This occurs when an XCopyArea's
6184 source area was obscured or not
6185 available. */
6186 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6187 if (f)
6189 expose_frame (f,
6190 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6191 event.xgraphicsexpose.width,
6192 event.xgraphicsexpose.height);
6194 #ifdef USE_X_TOOLKIT
6195 else
6196 goto OTHER;
6197 #endif /* USE_X_TOOLKIT */
6198 break;
6200 case NoExpose: /* This occurs when an XCopyArea's
6201 source area was completely
6202 available. */
6203 break;
6205 case UnmapNotify:
6206 /* Redo the mouse-highlight after the tooltip has gone. */
6207 if (event.xmap.window == tip_window)
6209 tip_window = 0;
6210 redo_mouse_highlight ();
6213 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6214 if (f) /* F may no longer exist if
6215 the frame was deleted. */
6217 /* While a frame is unmapped, display generation is
6218 disabled; you don't want to spend time updating a
6219 display that won't ever be seen. */
6220 f->async_visible = 0;
6221 /* We can't distinguish, from the event, whether the window
6222 has become iconified or invisible. So assume, if it
6223 was previously visible, than now it is iconified.
6224 But x_make_frame_invisible clears both
6225 the visible flag and the iconified flag;
6226 and that way, we know the window is not iconified now. */
6227 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6229 f->async_iconified = 1;
6231 inev.ie.kind = ICONIFY_EVENT;
6232 XSETFRAME (inev.ie.frame_or_window, f);
6235 goto OTHER;
6237 case MapNotify:
6238 if (event.xmap.window == tip_window)
6239 /* The tooltip has been drawn already. Avoid
6240 the SET_FRAME_GARBAGED below. */
6241 goto OTHER;
6243 /* We use x_top_window_to_frame because map events can
6244 come for sub-windows and they don't mean that the
6245 frame is visible. */
6246 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6247 if (f)
6249 /* wait_reading_process_output will notice this and update
6250 the frame's display structures.
6251 If we where iconified, we should not set garbaged,
6252 because that stops redrawing on Expose events. This looks
6253 bad if we are called from a recursive event loop
6254 (x_dispatch_event), for example when a dialog is up. */
6255 if (! f->async_iconified)
6256 SET_FRAME_GARBAGED (f);
6258 /* Check if fullscreen was specified before we where mapped the
6259 first time, i.e. from the command line. */
6260 if (!f->output_data.x->has_been_visible)
6261 x_check_fullscreen (f);
6263 f->async_visible = 1;
6264 f->async_iconified = 0;
6265 f->output_data.x->has_been_visible = 1;
6267 if (f->iconified)
6269 inev.ie.kind = DEICONIFY_EVENT;
6270 XSETFRAME (inev.ie.frame_or_window, f);
6272 else if (! NILP (Vframe_list)
6273 && ! NILP (XCDR (Vframe_list)))
6274 /* Force a redisplay sooner or later
6275 to update the frame titles
6276 in case this is the second frame. */
6277 record_asynch_buffer_change ();
6279 #ifdef USE_GTK
6280 xg_frame_resized (f, -1, -1);
6281 #endif
6283 goto OTHER;
6285 case KeyPress:
6287 last_user_time = event.xkey.time;
6288 ignore_next_mouse_click_timeout = 0;
6290 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6291 /* Dispatch KeyPress events when in menu. */
6292 if (popup_activated ())
6293 goto OTHER;
6294 #endif
6296 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6298 /* If mouse-highlight is an integer, input clears out
6299 mouse highlighting. */
6300 if (!dpyinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6301 && (f == 0
6302 || !EQ (f->tool_bar_window, dpyinfo->mouse_face_window)))
6304 clear_mouse_face (dpyinfo);
6305 dpyinfo->mouse_face_hidden = 1;
6308 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6309 if (f == 0)
6311 /* Scroll bars consume key events, but we want
6312 the keys to go to the scroll bar's frame. */
6313 Widget widget = XtWindowToWidget (dpyinfo->display,
6314 event.xkey.window);
6315 if (widget && XmIsScrollBar (widget))
6317 widget = XtParent (widget);
6318 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6321 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6323 if (f != 0)
6325 KeySym keysym, orig_keysym;
6326 /* al%imercury@uunet.uu.net says that making this 81
6327 instead of 80 fixed a bug whereby meta chars made
6328 his Emacs hang.
6330 It seems that some version of XmbLookupString has
6331 a bug of not returning XBufferOverflow in
6332 status_return even if the input is too long to
6333 fit in 81 bytes. So, we must prepare sufficient
6334 bytes for copy_buffer. 513 bytes (256 chars for
6335 two-byte character set) seems to be a fairly good
6336 approximation. -- 2000.8.10 handa@etl.go.jp */
6337 unsigned char copy_buffer[513];
6338 unsigned char *copy_bufptr = copy_buffer;
6339 int copy_bufsiz = sizeof (copy_buffer);
6340 int modifiers;
6341 Lisp_Object coding_system = Qlatin_1;
6342 Lisp_Object c;
6344 #ifdef USE_GTK
6345 /* Don't pass keys to GTK. A Tab will shift focus to the
6346 tool bar in GTK 2.4. Keys will still go to menus and
6347 dialogs because in that case popup_activated is TRUE
6348 (see above). */
6349 *finish = X_EVENT_DROP;
6350 #endif
6352 event.xkey.state
6353 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6354 extra_keyboard_modifiers);
6355 modifiers = event.xkey.state;
6357 /* This will have to go some day... */
6359 /* make_lispy_event turns chars into control chars.
6360 Don't do it here because XLookupString is too eager. */
6361 event.xkey.state &= ~ControlMask;
6362 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6363 | dpyinfo->super_mod_mask
6364 | dpyinfo->hyper_mod_mask
6365 | dpyinfo->alt_mod_mask);
6367 /* In case Meta is ComposeCharacter,
6368 clear its status. According to Markus Ehrnsperger
6369 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6370 this enables ComposeCharacter to work whether or
6371 not it is combined with Meta. */
6372 if (modifiers & dpyinfo->meta_mod_mask)
6373 bzero (&compose_status, sizeof (compose_status));
6375 #ifdef HAVE_X_I18N
6376 if (FRAME_XIC (f))
6378 Status status_return;
6380 coding_system = Vlocale_coding_system;
6381 nbytes = XmbLookupString (FRAME_XIC (f),
6382 &event.xkey, copy_bufptr,
6383 copy_bufsiz, &keysym,
6384 &status_return);
6385 if (status_return == XBufferOverflow)
6387 copy_bufsiz = nbytes + 1;
6388 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6389 nbytes = XmbLookupString (FRAME_XIC (f),
6390 &event.xkey, copy_bufptr,
6391 copy_bufsiz, &keysym,
6392 &status_return);
6394 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6395 if (status_return == XLookupNone)
6396 break;
6397 else if (status_return == XLookupChars)
6399 keysym = NoSymbol;
6400 modifiers = 0;
6402 else if (status_return != XLookupKeySym
6403 && status_return != XLookupBoth)
6404 abort ();
6406 else
6407 nbytes = XLookupString (&event.xkey, copy_bufptr,
6408 copy_bufsiz, &keysym,
6409 &compose_status);
6410 #else
6411 nbytes = XLookupString (&event.xkey, copy_bufptr,
6412 copy_bufsiz, &keysym,
6413 &compose_status);
6414 #endif
6416 /* If not using XIM/XIC, and a compose sequence is in progress,
6417 we break here. Otherwise, chars_matched is always 0. */
6418 if (compose_status.chars_matched > 0 && nbytes == 0)
6419 break;
6421 bzero (&compose_status, sizeof (compose_status));
6422 orig_keysym = keysym;
6424 /* Common for all keysym input events. */
6425 XSETFRAME (inev.ie.frame_or_window, f);
6426 inev.ie.modifiers
6427 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6428 inev.ie.timestamp = event.xkey.time;
6430 /* First deal with keysyms which have defined
6431 translations to characters. */
6432 if (keysym >= 32 && keysym < 128)
6433 /* Avoid explicitly decoding each ASCII character. */
6435 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6436 inev.ie.code = keysym;
6437 goto done_keysym;
6440 /* Keysyms directly mapped to Unicode characters. */
6441 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6443 if (keysym < 0x01000080)
6444 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6445 else
6446 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6447 inev.ie.code = keysym & 0xFFFFFF;
6448 goto done_keysym;
6451 /* Now non-ASCII. */
6452 if (HASH_TABLE_P (Vx_keysym_table)
6453 && (NATNUMP (c = Fgethash (make_number (keysym),
6454 Vx_keysym_table,
6455 Qnil))))
6457 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6458 ? ASCII_KEYSTROKE_EVENT
6459 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6460 inev.ie.code = XFASTINT (c);
6461 goto done_keysym;
6464 /* Random non-modifier sorts of keysyms. */
6465 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6466 || keysym == XK_Delete
6467 #ifdef XK_ISO_Left_Tab
6468 || (keysym >= XK_ISO_Left_Tab
6469 && keysym <= XK_ISO_Enter)
6470 #endif
6471 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6472 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6473 #ifdef HPUX
6474 /* This recognizes the "extended function
6475 keys". It seems there's no cleaner way.
6476 Test IsModifierKey to avoid handling
6477 mode_switch incorrectly. */
6478 || ((unsigned) (keysym) >= XK_Select
6479 && (unsigned)(keysym) < XK_KP_Space)
6480 #endif
6481 #ifdef XK_dead_circumflex
6482 || orig_keysym == XK_dead_circumflex
6483 #endif
6484 #ifdef XK_dead_grave
6485 || orig_keysym == XK_dead_grave
6486 #endif
6487 #ifdef XK_dead_tilde
6488 || orig_keysym == XK_dead_tilde
6489 #endif
6490 #ifdef XK_dead_diaeresis
6491 || orig_keysym == XK_dead_diaeresis
6492 #endif
6493 #ifdef XK_dead_macron
6494 || orig_keysym == XK_dead_macron
6495 #endif
6496 #ifdef XK_dead_degree
6497 || orig_keysym == XK_dead_degree
6498 #endif
6499 #ifdef XK_dead_acute
6500 || orig_keysym == XK_dead_acute
6501 #endif
6502 #ifdef XK_dead_cedilla
6503 || orig_keysym == XK_dead_cedilla
6504 #endif
6505 #ifdef XK_dead_breve
6506 || orig_keysym == XK_dead_breve
6507 #endif
6508 #ifdef XK_dead_ogonek
6509 || orig_keysym == XK_dead_ogonek
6510 #endif
6511 #ifdef XK_dead_caron
6512 || orig_keysym == XK_dead_caron
6513 #endif
6514 #ifdef XK_dead_doubleacute
6515 || orig_keysym == XK_dead_doubleacute
6516 #endif
6517 #ifdef XK_dead_abovedot
6518 || orig_keysym == XK_dead_abovedot
6519 #endif
6520 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6521 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6522 /* Any "vendor-specific" key is ok. */
6523 || (orig_keysym & (1 << 28))
6524 || (keysym != NoSymbol && nbytes == 0))
6525 && ! (IsModifierKey (orig_keysym)
6526 /* The symbols from XK_ISO_Lock
6527 to XK_ISO_Last_Group_Lock
6528 don't have real modifiers but
6529 should be treated similarly to
6530 Mode_switch by Emacs. */
6531 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6532 || ((unsigned)(orig_keysym)
6533 >= XK_ISO_Lock
6534 && (unsigned)(orig_keysym)
6535 <= XK_ISO_Last_Group_Lock)
6536 #endif
6539 STORE_KEYSYM_FOR_DEBUG (keysym);
6540 /* make_lispy_event will convert this to a symbolic
6541 key. */
6542 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6543 inev.ie.code = keysym;
6544 goto done_keysym;
6547 { /* Raw bytes, not keysym. */
6548 register int i;
6549 register int c;
6550 int nchars, len;
6552 for (i = 0, nchars = 0; i < nbytes; i++)
6554 if (ASCII_BYTE_P (copy_bufptr[i]))
6555 nchars++;
6556 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6559 if (nchars < nbytes)
6561 /* Decode the input data. */
6562 int require;
6563 unsigned char *p;
6565 /* The input should be decoded with `coding_system'
6566 which depends on which X*LookupString function
6567 we used just above and the locale. */
6568 setup_coding_system (coding_system, &coding);
6569 coding.src_multibyte = 0;
6570 coding.dst_multibyte = 1;
6571 /* The input is converted to events, thus we can't
6572 handle composition. Anyway, there's no XIM that
6573 gives us composition information. */
6574 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6576 require = MAX_MULTIBYTE_LENGTH * nbytes;
6577 coding.destination = alloca (require);
6578 coding.dst_bytes = require;
6579 coding.mode |= CODING_MODE_LAST_BLOCK;
6580 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6581 nbytes = coding.produced;
6582 nchars = coding.produced_char;
6583 copy_bufptr = coding.destination;
6586 /* Convert the input data to a sequence of
6587 character events. */
6588 for (i = 0; i < nbytes; i += len)
6590 if (nchars == nbytes)
6591 c = copy_bufptr[i], len = 1;
6592 else
6593 c = STRING_CHAR_AND_LENGTH (copy_bufptr + i, len);
6594 inev.ie.kind = (SINGLE_BYTE_CHAR_P (c)
6595 ? ASCII_KEYSTROKE_EVENT
6596 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6597 inev.ie.code = c;
6598 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6601 count += nchars;
6603 inev.ie.kind = NO_EVENT; /* Already stored above. */
6605 if (keysym == NoSymbol)
6606 break;
6609 done_keysym:
6610 #ifdef HAVE_X_I18N
6611 /* Don't dispatch this event since XtDispatchEvent calls
6612 XFilterEvent, and two calls in a row may freeze the
6613 client. */
6614 break;
6615 #else
6616 goto OTHER;
6617 #endif
6619 case KeyRelease:
6620 last_user_time = event.xkey.time;
6621 #ifdef HAVE_X_I18N
6622 /* Don't dispatch this event since XtDispatchEvent calls
6623 XFilterEvent, and two calls in a row may freeze the
6624 client. */
6625 break;
6626 #else
6627 goto OTHER;
6628 #endif
6630 case EnterNotify:
6631 last_user_time = event.xcrossing.time;
6632 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6634 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6636 if (f && x_mouse_click_focus_ignore_position)
6637 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
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 #ifdef USE_GTK
6707 if (f && xg_event_is_for_scrollbar (f, &event))
6708 f = 0;
6709 #endif
6710 if (f)
6713 /* Generate SELECT_WINDOW_EVENTs when needed.
6714 Don't let popup menus influence things (bug#1261). */
6715 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6717 Lisp_Object window;
6719 window = window_from_coordinates (f,
6720 event.xmotion.x, event.xmotion.y,
6721 0, 0, 0, 0);
6723 /* Window will be selected only when it is not selected now and
6724 last mouse movement event was not in it. Minibuffer window
6725 will be selected only when it is active. */
6726 if (WINDOWP (window)
6727 && !EQ (window, last_window)
6728 && !EQ (window, selected_window)
6729 /* For click-to-focus window managers
6730 create event iff we don't leave the
6731 selected frame. */
6732 && (focus_follows_mouse
6733 || (EQ (XWINDOW (window)->frame,
6734 XWINDOW (selected_window)->frame))))
6736 inev.ie.kind = SELECT_WINDOW_EVENT;
6737 inev.ie.frame_or_window = window;
6740 last_window=window;
6742 if (!note_mouse_movement (f, &event.xmotion))
6743 help_echo_string = previous_help_echo_string;
6745 else
6747 #ifndef USE_TOOLKIT_SCROLL_BARS
6748 struct scroll_bar *bar
6749 = x_window_to_scroll_bar (event.xmotion.display,
6750 event.xmotion.window);
6752 if (bar)
6753 x_scroll_bar_note_movement (bar, &event);
6754 #endif /* USE_TOOLKIT_SCROLL_BARS */
6756 /* If we move outside the frame, then we're
6757 certainly no longer on any text in the frame. */
6758 clear_mouse_face (dpyinfo);
6761 /* If the contents of the global variable help_echo_string
6762 has changed, generate a HELP_EVENT. */
6763 if (!NILP (help_echo_string)
6764 || !NILP (previous_help_echo_string))
6765 do_help = 1;
6766 goto OTHER;
6769 case ConfigureNotify:
6770 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6771 #ifdef USE_GTK
6772 if (!f
6773 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6774 && event.xconfigure.window == FRAME_X_WINDOW (f))
6776 xg_frame_resized (f, event.xconfigure.width,
6777 event.xconfigure.height);
6778 f = 0;
6780 #endif
6781 if (f)
6783 #ifndef USE_X_TOOLKIT
6784 #ifndef USE_GTK
6785 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6786 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6788 /* In the toolkit version, change_frame_size
6789 is called by the code that handles resizing
6790 of the EmacsFrame widget. */
6792 /* Even if the number of character rows and columns has
6793 not changed, the font size may have changed, so we need
6794 to check the pixel dimensions as well. */
6795 if (columns != FRAME_COLS (f)
6796 || rows != FRAME_LINES (f)
6797 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6798 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6800 change_frame_size (f, rows, columns, 0, 1, 0);
6801 SET_FRAME_GARBAGED (f);
6802 cancel_mouse_face (f);
6805 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6806 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6807 #endif /* not USE_GTK */
6808 #endif
6810 #ifdef USE_GTK
6811 /* GTK creates windows but doesn't map them.
6812 Only get real positions when mapped. */
6813 if (FRAME_GTK_OUTER_WIDGET (f)
6814 && GTK_WIDGET_MAPPED (FRAME_GTK_OUTER_WIDGET (f)))
6815 #endif
6817 x_real_positions (f, &f->left_pos, &f->top_pos);
6820 #ifdef HAVE_X_I18N
6821 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6822 xic_set_statusarea (f);
6823 #endif
6826 goto OTHER;
6828 case ButtonRelease:
6829 case ButtonPress:
6831 /* If we decide we want to generate an event to be seen
6832 by the rest of Emacs, we put it here. */
6833 int tool_bar_p = 0;
6835 bzero (&compose_status, sizeof (compose_status));
6836 last_mouse_glyph_frame = 0;
6837 last_user_time = event.xbutton.time;
6839 if (dpyinfo->grabbed
6840 && last_mouse_frame
6841 && FRAME_LIVE_P (last_mouse_frame))
6842 f = last_mouse_frame;
6843 else
6844 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6846 #ifdef USE_GTK
6847 if (f && xg_event_is_for_scrollbar (f, &event))
6848 f = 0;
6849 #endif
6850 if (f)
6852 /* Is this in the tool-bar? */
6853 if (WINDOWP (f->tool_bar_window)
6854 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6856 Lisp_Object window;
6857 int x = event.xbutton.x;
6858 int y = event.xbutton.y;
6860 window = window_from_coordinates (f, x, y, 0, 0, 0, 1);
6861 tool_bar_p = EQ (window, f->tool_bar_window);
6863 if (tool_bar_p && event.xbutton.button < 4)
6865 handle_tool_bar_click (f, x, y,
6866 event.xbutton.type == ButtonPress,
6867 x_x_to_emacs_modifiers (dpyinfo,
6868 event.xbutton.state));
6872 if (!tool_bar_p)
6873 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6874 if (! popup_activated ())
6875 #endif
6877 if (ignore_next_mouse_click_timeout)
6879 if (event.type == ButtonPress
6880 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6882 ignore_next_mouse_click_timeout = 0;
6883 construct_mouse_click (&inev.ie, &event.xbutton, f);
6885 if (event.type == ButtonRelease)
6886 ignore_next_mouse_click_timeout = 0;
6888 else
6889 construct_mouse_click (&inev.ie, &event.xbutton, f);
6891 if (FRAME_X_EMBEDDED_P (f))
6892 xembed_send_message (f, event.xbutton.time,
6893 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6895 else
6897 struct scroll_bar *bar
6898 = x_window_to_scroll_bar (event.xbutton.display,
6899 event.xbutton.window);
6901 #ifdef USE_TOOLKIT_SCROLL_BARS
6902 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6903 scroll bars. */
6904 if (bar && event.xbutton.state & ControlMask)
6906 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6907 *finish = X_EVENT_DROP;
6909 #else /* not USE_TOOLKIT_SCROLL_BARS */
6910 if (bar)
6911 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6912 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6915 if (event.type == ButtonPress)
6917 dpyinfo->grabbed |= (1 << event.xbutton.button);
6918 last_mouse_frame = f;
6920 if (!tool_bar_p)
6921 last_tool_bar_item = -1;
6923 else
6924 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6926 /* Ignore any mouse motion that happened before this event;
6927 any subsequent mouse-movement Emacs events should reflect
6928 only motion after the ButtonPress/Release. */
6929 if (f != 0)
6930 f->mouse_moved = 0;
6932 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6933 f = x_menubar_window_to_frame (dpyinfo, event.xbutton.window);
6934 /* For a down-event in the menu bar,
6935 don't pass it to Xt right now.
6936 Instead, save it away
6937 and we will pass it to Xt from kbd_buffer_get_event.
6938 That way, we can run some Lisp code first. */
6939 if (
6940 #ifdef USE_GTK
6941 ! popup_activated ()
6942 /* Gtk+ menus only react to the first three buttons. */
6943 && event.xbutton.button < 3
6945 #endif
6946 f && event.type == ButtonPress
6947 /* Verify the event is really within the menu bar
6948 and not just sent to it due to grabbing. */
6949 && event.xbutton.x >= 0
6950 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6951 && event.xbutton.y >= 0
6952 && event.xbutton.y < f->output_data.x->menubar_height
6953 && event.xbutton.same_screen)
6955 SET_SAVED_BUTTON_EVENT;
6956 XSETFRAME (last_mouse_press_frame, f);
6957 #ifdef USE_GTK
6958 *finish = X_EVENT_DROP;
6959 #endif
6961 else if (event.type == ButtonPress)
6963 last_mouse_press_frame = Qnil;
6964 goto OTHER;
6967 #ifdef USE_MOTIF /* This should do not harm for Lucid,
6968 but I am trying to be cautious. */
6969 else if (event.type == ButtonRelease)
6971 if (!NILP (last_mouse_press_frame))
6973 f = XFRAME (last_mouse_press_frame);
6974 if (f->output_data.x)
6975 SET_SAVED_BUTTON_EVENT;
6977 else
6978 goto OTHER;
6980 #endif /* USE_MOTIF */
6981 else
6982 goto OTHER;
6983 #endif /* USE_X_TOOLKIT || USE_GTK */
6985 break;
6987 case CirculateNotify:
6988 goto OTHER;
6990 case CirculateRequest:
6991 goto OTHER;
6993 case VisibilityNotify:
6994 goto OTHER;
6996 case MappingNotify:
6997 /* Someone has changed the keyboard mapping - update the
6998 local cache. */
6999 switch (event.xmapping.request)
7001 case MappingModifier:
7002 x_find_modifier_meanings (dpyinfo);
7003 /* This is meant to fall through. */
7004 case MappingKeyboard:
7005 XRefreshKeyboardMapping (&event.xmapping);
7007 goto OTHER;
7009 case DestroyNotify:
7010 xft_settings_event (dpyinfo, &event);
7011 break;
7013 default:
7014 OTHER:
7015 #ifdef USE_X_TOOLKIT
7016 BLOCK_INPUT;
7017 if (*finish != X_EVENT_DROP)
7018 XtDispatchEvent (&event);
7019 UNBLOCK_INPUT;
7020 #endif /* USE_X_TOOLKIT */
7021 break;
7024 done:
7025 if (inev.ie.kind != NO_EVENT)
7027 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
7028 count++;
7031 if (do_help
7032 && !(hold_quit && hold_quit->kind != NO_EVENT))
7034 Lisp_Object frame;
7036 if (f)
7037 XSETFRAME (frame, f);
7038 else
7039 frame = Qnil;
7041 if (do_help > 0)
7043 any_help_event_p = 1;
7044 gen_help_event (help_echo_string, frame, help_echo_window,
7045 help_echo_object, help_echo_pos);
7047 else
7049 help_echo_string = Qnil;
7050 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
7052 count++;
7055 *eventp = event;
7056 return count;
7060 /* Handles the XEvent EVENT on display DISPLAY.
7061 This is used for event loops outside the normal event handling,
7062 i.e. looping while a popup menu or a dialog is posted.
7064 Returns the value handle_one_xevent sets in the finish argument. */
7066 x_dispatch_event (event, display)
7067 XEvent *event;
7068 Display *display;
7070 struct x_display_info *dpyinfo;
7071 int finish = X_EVENT_NORMAL;
7073 dpyinfo = x_display_info_for_display (display);
7075 if (dpyinfo)
7076 handle_one_xevent (dpyinfo, event, &finish, 0);
7078 return finish;
7082 /* Read events coming from the X server.
7083 This routine is called by the SIGIO handler.
7084 We return as soon as there are no more events to be read.
7086 We return the number of characters stored into the buffer,
7087 thus pretending to be `read' (except the characters we store
7088 in the keyboard buffer can be multibyte, so are not necessarily
7089 C chars).
7091 EXPECTED is nonzero if the caller knows input is available. */
7093 static int
7094 XTread_socket (terminal, expected, hold_quit)
7095 struct terminal *terminal;
7096 int expected;
7097 struct input_event *hold_quit;
7099 int count = 0;
7100 XEvent event;
7101 int event_found = 0;
7103 if (interrupt_input_blocked)
7105 interrupt_input_pending = 1;
7106 #ifdef SYNC_INPUT
7107 pending_signals = 1;
7108 #endif
7109 return -1;
7112 interrupt_input_pending = 0;
7113 #ifdef SYNC_INPUT
7114 pending_signals = pending_atimers;
7115 #endif
7116 BLOCK_INPUT;
7118 /* So people can tell when we have read the available input. */
7119 input_signal_count++;
7121 ++handling_signal;
7123 #ifdef HAVE_X_SM
7124 /* Only check session manager input for the primary display. */
7125 if (terminal->id == 1 && x_session_have_connection ())
7127 struct input_event inev;
7128 BLOCK_INPUT;
7129 /* We don't need to EVENT_INIT (inev) here, as
7130 x_session_check_input copies an entire input_event. */
7131 if (x_session_check_input (&inev))
7133 kbd_buffer_store_event_hold (&inev, hold_quit);
7134 count++;
7136 UNBLOCK_INPUT;
7138 #endif
7140 /* For debugging, this gives a way to fake an I/O error. */
7141 if (terminal->display_info.x == XTread_socket_fake_io_error)
7143 XTread_socket_fake_io_error = 0;
7144 x_io_error_quitter (terminal->display_info.x->display);
7147 #ifndef USE_GTK
7148 while (XPending (terminal->display_info.x->display))
7150 int finish;
7152 XNextEvent (terminal->display_info.x->display, &event);
7154 #ifdef HAVE_X_I18N
7155 /* Filter events for the current X input method. */
7156 if (x_filter_event (terminal->display_info.x, &event))
7157 continue;
7158 #endif
7159 event_found = 1;
7161 count += handle_one_xevent (terminal->display_info.x,
7162 &event, &finish, hold_quit);
7164 if (finish == X_EVENT_GOTO_OUT)
7165 goto out;
7168 #else /* USE_GTK */
7170 /* For GTK we must use the GTK event loop. But XEvents gets passed
7171 to our filter function above, and then to the big event switch.
7172 We use a bunch of globals to communicate with our filter function,
7173 that is kind of ugly, but it works.
7175 There is no way to do one display at the time, GTK just does events
7176 from all displays. */
7178 while (gtk_events_pending ())
7180 current_count = count;
7181 current_hold_quit = hold_quit;
7183 gtk_main_iteration ();
7185 count = current_count;
7186 current_count = -1;
7187 current_hold_quit = 0;
7189 if (current_finish == X_EVENT_GOTO_OUT)
7190 break;
7192 #endif /* USE_GTK */
7194 out:;
7196 /* On some systems, an X bug causes Emacs to get no more events
7197 when the window is destroyed. Detect that. (1994.) */
7198 if (! event_found)
7200 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7201 One XNOOP in 100 loops will make Emacs terminate.
7202 B. Bretthauer, 1994 */
7203 x_noop_count++;
7204 if (x_noop_count >= 100)
7206 x_noop_count=0;
7208 if (next_noop_dpyinfo == 0)
7209 next_noop_dpyinfo = x_display_list;
7211 XNoOp (next_noop_dpyinfo->display);
7213 /* Each time we get here, cycle through the displays now open. */
7214 next_noop_dpyinfo = next_noop_dpyinfo->next;
7218 /* If the focus was just given to an auto-raising frame,
7219 raise it now. */
7220 /* ??? This ought to be able to handle more than one such frame. */
7221 if (pending_autoraise_frame)
7223 x_raise_frame (pending_autoraise_frame);
7224 pending_autoraise_frame = 0;
7227 --handling_signal;
7228 UNBLOCK_INPUT;
7230 return count;
7236 /***********************************************************************
7237 Text Cursor
7238 ***********************************************************************/
7240 /* Set clipping for output in glyph row ROW. W is the window in which
7241 we operate. GC is the graphics context to set clipping in.
7243 ROW may be a text row or, e.g., a mode line. Text rows must be
7244 clipped to the interior of the window dedicated to text display,
7245 mode lines must be clipped to the whole window. */
7247 static void
7248 x_clip_to_row (w, row, area, gc)
7249 struct window *w;
7250 struct glyph_row *row;
7251 int area;
7252 GC gc;
7254 struct frame *f = XFRAME (WINDOW_FRAME (w));
7255 XRectangle clip_rect;
7256 int window_x, window_y, window_width;
7258 window_box (w, area, &window_x, &window_y, &window_width, 0);
7260 clip_rect.x = window_x;
7261 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7262 clip_rect.y = max (clip_rect.y, window_y);
7263 clip_rect.width = window_width;
7264 clip_rect.height = row->visible_height;
7266 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7270 /* Draw a hollow box cursor on window W in glyph row ROW. */
7272 static void
7273 x_draw_hollow_cursor (w, row)
7274 struct window *w;
7275 struct glyph_row *row;
7277 struct frame *f = XFRAME (WINDOW_FRAME (w));
7278 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7279 Display *dpy = FRAME_X_DISPLAY (f);
7280 int x, y, wd, h;
7281 XGCValues xgcv;
7282 struct glyph *cursor_glyph;
7283 GC gc;
7285 /* Get the glyph the cursor is on. If we can't tell because
7286 the current matrix is invalid or such, give up. */
7287 cursor_glyph = get_phys_cursor_glyph (w);
7288 if (cursor_glyph == NULL)
7289 return;
7291 /* Compute frame-relative coordinates for phys cursor. */
7292 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7293 wd = w->phys_cursor_width;
7295 /* The foreground of cursor_gc is typically the same as the normal
7296 background color, which can cause the cursor box to be invisible. */
7297 xgcv.foreground = f->output_data.x->cursor_pixel;
7298 if (dpyinfo->scratch_cursor_gc)
7299 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7300 else
7301 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7302 GCForeground, &xgcv);
7303 gc = dpyinfo->scratch_cursor_gc;
7305 /* Set clipping, draw the rectangle, and reset clipping again. */
7306 x_clip_to_row (w, row, TEXT_AREA, gc);
7307 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7308 XSetClipMask (dpy, gc, None);
7312 /* Draw a bar cursor on window W in glyph row ROW.
7314 Implementation note: One would like to draw a bar cursor with an
7315 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7316 Unfortunately, I didn't find a font yet that has this property set.
7317 --gerd. */
7319 static void
7320 x_draw_bar_cursor (w, row, width, kind)
7321 struct window *w;
7322 struct glyph_row *row;
7323 int width;
7324 enum text_cursor_kinds kind;
7326 struct frame *f = XFRAME (w->frame);
7327 struct glyph *cursor_glyph;
7329 /* If cursor is out of bounds, don't draw garbage. This can happen
7330 in mini-buffer windows when switching between echo area glyphs
7331 and mini-buffer. */
7332 cursor_glyph = get_phys_cursor_glyph (w);
7333 if (cursor_glyph == NULL)
7334 return;
7336 /* If on an image, draw like a normal cursor. That's usually better
7337 visible than drawing a bar, esp. if the image is large so that
7338 the bar might not be in the window. */
7339 if (cursor_glyph->type == IMAGE_GLYPH)
7341 struct glyph_row *row;
7342 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7343 draw_phys_cursor_glyph (w, row, DRAW_CURSOR);
7345 else
7347 Display *dpy = FRAME_X_DISPLAY (f);
7348 Window window = FRAME_X_WINDOW (f);
7349 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7350 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7351 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7352 XGCValues xgcv;
7354 /* If the glyph's background equals the color we normally draw
7355 the bars cursor in, the bar cursor in its normal color is
7356 invisible. Use the glyph's foreground color instead in this
7357 case, on the assumption that the glyph's colors are chosen so
7358 that the glyph is legible. */
7359 if (face->background == f->output_data.x->cursor_pixel)
7360 xgcv.background = xgcv.foreground = face->foreground;
7361 else
7362 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7363 xgcv.graphics_exposures = 0;
7365 if (gc)
7366 XChangeGC (dpy, gc, mask, &xgcv);
7367 else
7369 gc = XCreateGC (dpy, window, mask, &xgcv);
7370 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7373 x_clip_to_row (w, row, TEXT_AREA, gc);
7375 if (kind == BAR_CURSOR)
7377 if (width < 0)
7378 width = FRAME_CURSOR_WIDTH (f);
7379 width = min (cursor_glyph->pixel_width, width);
7381 w->phys_cursor_width = width;
7383 XFillRectangle (dpy, window, gc,
7384 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7385 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7386 width, row->height);
7388 else
7390 int dummy_x, dummy_y, dummy_h;
7392 if (width < 0)
7393 width = row->height;
7395 width = min (row->height, width);
7397 get_phys_cursor_geometry (w, row, cursor_glyph, &dummy_x,
7398 &dummy_y, &dummy_h);
7400 XFillRectangle (dpy, window, gc,
7401 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7402 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7403 row->height - width),
7404 w->phys_cursor_width, width);
7407 XSetClipMask (dpy, gc, None);
7412 /* RIF: Define cursor CURSOR on frame F. */
7414 static void
7415 x_define_frame_cursor (f, cursor)
7416 struct frame *f;
7417 Cursor cursor;
7419 if (!f->pointer_invisible
7420 && f->output_data.x->current_cursor != cursor)
7421 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7422 f->output_data.x->current_cursor = cursor;
7426 /* RIF: Clear area on frame F. */
7428 static void
7429 x_clear_frame_area (f, x, y, width, height)
7430 struct frame *f;
7431 int x, y, width, height;
7433 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7434 x, y, width, height, False);
7438 /* RIF: Draw cursor on window W. */
7440 static void
7441 x_draw_window_cursor (w, glyph_row, x, y, cursor_type, cursor_width, on_p, active_p)
7442 struct window *w;
7443 struct glyph_row *glyph_row;
7444 int x, y;
7445 int cursor_type, cursor_width;
7446 int on_p, active_p;
7448 struct frame *f = XFRAME (WINDOW_FRAME (w));
7450 if (on_p)
7452 w->phys_cursor_type = cursor_type;
7453 w->phys_cursor_on_p = 1;
7455 if (glyph_row->exact_window_width_line_p
7456 && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
7458 glyph_row->cursor_in_fringe_p = 1;
7459 draw_fringe_bitmap (w, glyph_row, 0);
7461 else
7462 switch (cursor_type)
7464 case HOLLOW_BOX_CURSOR:
7465 x_draw_hollow_cursor (w, glyph_row);
7466 break;
7468 case FILLED_BOX_CURSOR:
7469 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7470 break;
7472 case BAR_CURSOR:
7473 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7474 break;
7476 case HBAR_CURSOR:
7477 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7478 break;
7480 case NO_CURSOR:
7481 w->phys_cursor_width = 0;
7482 break;
7484 default:
7485 abort ();
7488 #ifdef HAVE_X_I18N
7489 if (w == XWINDOW (f->selected_window))
7490 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7491 xic_set_preeditarea (w, x, y);
7492 #endif
7495 #ifndef XFlush
7496 XFlush (FRAME_X_DISPLAY (f));
7497 #endif
7501 /* Icons. */
7503 /* Make the x-window of frame F use the gnu icon bitmap. */
7506 x_bitmap_icon (f, file)
7507 struct frame *f;
7508 Lisp_Object file;
7510 int bitmap_id;
7512 if (FRAME_X_WINDOW (f) == 0)
7513 return 1;
7515 /* Free up our existing icon bitmap and mask if any. */
7516 if (f->output_data.x->icon_bitmap > 0)
7517 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7518 f->output_data.x->icon_bitmap = 0;
7520 if (STRINGP (file))
7522 #ifdef USE_GTK
7523 /* Use gtk_window_set_icon_from_file () if available,
7524 It's not restricted to bitmaps */
7525 if (xg_set_icon (f, file))
7526 return 0;
7527 #endif /* USE_GTK */
7528 bitmap_id = x_create_bitmap_from_file (f, file);
7529 x_create_bitmap_mask (f, bitmap_id);
7531 else
7533 /* Create the GNU bitmap and mask if necessary. */
7534 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7536 int rc = -1;
7538 #ifdef USE_GTK
7540 if (xg_set_icon (f, xg_default_icon_file)
7541 || xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7542 return 0;
7544 #elif defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7546 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7547 if (rc != -1)
7548 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7550 #endif
7552 /* If all else fails, use the (black and white) xbm image. */
7553 if (rc == -1)
7555 rc = x_create_bitmap_from_data (f, gnu_xbm_bits,
7556 gnu_xbm_width, gnu_xbm_height);
7557 if (rc == -1)
7558 return 1;
7560 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7561 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7565 /* The first time we create the GNU bitmap and mask,
7566 this increments the ref-count one extra time.
7567 As a result, the GNU bitmap and mask are never freed.
7568 That way, we don't have to worry about allocating it again. */
7569 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7571 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7574 x_wm_set_icon_pixmap (f, bitmap_id);
7575 f->output_data.x->icon_bitmap = bitmap_id;
7577 return 0;
7581 /* Make the x-window of frame F use a rectangle with text.
7582 Use ICON_NAME as the text. */
7585 x_text_icon (f, icon_name)
7586 struct frame *f;
7587 char *icon_name;
7589 if (FRAME_X_WINDOW (f) == 0)
7590 return 1;
7593 XTextProperty text;
7594 text.value = (unsigned char *) icon_name;
7595 text.encoding = XA_STRING;
7596 text.format = 8;
7597 text.nitems = strlen (icon_name);
7598 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7601 if (f->output_data.x->icon_bitmap > 0)
7602 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7603 f->output_data.x->icon_bitmap = 0;
7604 x_wm_set_icon_pixmap (f, 0);
7606 return 0;
7609 #define X_ERROR_MESSAGE_SIZE 200
7611 /* If non-nil, this should be a string.
7612 It means catch X errors and store the error message in this string.
7614 The reason we use a stack is that x_catch_error/x_uncatch_error can
7615 be called from a signal handler.
7618 struct x_error_message_stack {
7619 char string[X_ERROR_MESSAGE_SIZE];
7620 Display *dpy;
7621 struct x_error_message_stack *prev;
7623 static struct x_error_message_stack *x_error_message;
7625 /* An X error handler which stores the error message in
7626 *x_error_message. This is called from x_error_handler if
7627 x_catch_errors is in effect. */
7629 static void
7630 x_error_catcher (display, error)
7631 Display *display;
7632 XErrorEvent *error;
7634 XGetErrorText (display, error->error_code,
7635 x_error_message->string,
7636 X_ERROR_MESSAGE_SIZE);
7639 /* Begin trapping X errors for display DPY. Actually we trap X errors
7640 for all displays, but DPY should be the display you are actually
7641 operating on.
7643 After calling this function, X protocol errors no longer cause
7644 Emacs to exit; instead, they are recorded in the string
7645 stored in *x_error_message.
7647 Calling x_check_errors signals an Emacs error if an X error has
7648 occurred since the last call to x_catch_errors or x_check_errors.
7650 Calling x_uncatch_errors resumes the normal error handling. */
7652 void x_check_errors ();
7654 void
7655 x_catch_errors (dpy)
7656 Display *dpy;
7658 struct x_error_message_stack *data = xmalloc (sizeof (*data));
7660 /* Make sure any errors from previous requests have been dealt with. */
7661 XSync (dpy, False);
7663 data->dpy = dpy;
7664 data->string[0] = 0;
7665 data->prev = x_error_message;
7666 x_error_message = data;
7669 /* Undo the last x_catch_errors call.
7670 DPY should be the display that was passed to x_catch_errors. */
7672 void
7673 x_uncatch_errors ()
7675 struct x_error_message_stack *tmp;
7677 BLOCK_INPUT;
7679 /* The display may have been closed before this function is called.
7680 Check if it is still open before calling XSync. */
7681 if (x_display_info_for_display (x_error_message->dpy) != 0)
7682 XSync (x_error_message->dpy, False);
7684 tmp = x_error_message;
7685 x_error_message = x_error_message->prev;
7686 xfree (tmp);
7687 UNBLOCK_INPUT;
7690 /* If any X protocol errors have arrived since the last call to
7691 x_catch_errors or x_check_errors, signal an Emacs error using
7692 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7694 void
7695 x_check_errors (dpy, format)
7696 Display *dpy;
7697 char *format;
7699 /* Make sure to catch any errors incurred so far. */
7700 XSync (dpy, False);
7702 if (x_error_message->string[0])
7704 char string[X_ERROR_MESSAGE_SIZE];
7705 bcopy (x_error_message->string, string, X_ERROR_MESSAGE_SIZE);
7706 x_uncatch_errors ();
7707 error (format, string);
7711 /* Nonzero if we had any X protocol errors
7712 since we did x_catch_errors on DPY. */
7715 x_had_errors_p (dpy)
7716 Display *dpy;
7718 /* Make sure to catch any errors incurred so far. */
7719 XSync (dpy, False);
7721 return x_error_message->string[0] != 0;
7724 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7726 void
7727 x_clear_errors (dpy)
7728 Display *dpy;
7730 x_error_message->string[0] = 0;
7733 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7734 * idea. --lorentey */
7735 /* Close off all unclosed x_catch_errors calls. */
7737 void
7738 x_fully_uncatch_errors ()
7740 while (x_error_message)
7741 x_uncatch_errors ();
7743 #endif
7745 /* Nonzero if x_catch_errors has been done and not yet canceled. */
7748 x_catching_errors ()
7750 return x_error_message != 0;
7753 #if 0
7754 static unsigned int x_wire_count;
7755 x_trace_wire ()
7757 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7759 #endif /* ! 0 */
7762 /* Handle SIGPIPE, which can happen when the connection to a server
7763 simply goes away. SIGPIPE is handled by x_connection_signal.
7764 Don't need to do anything, because the write which caused the
7765 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7766 which will do the appropriate cleanup for us. */
7768 static SIGTYPE
7769 x_connection_signal (signalnum) /* If we don't have an argument, */
7770 int signalnum; /* some compilers complain in signal calls. */
7772 #ifdef USG
7773 /* USG systems forget handlers when they are used;
7774 must reestablish each time */
7775 signal (signalnum, x_connection_signal);
7776 #endif /* USG */
7780 /************************************************************************
7781 Handling X errors
7782 ************************************************************************/
7784 /* Error message passed to x_connection_closed. */
7786 static char *error_msg;
7788 /* Function installed as fatal_error_signal_hook in
7789 x_connection_closed. Print the X error message, and exit normally,
7790 instead of dumping core when XtCloseDisplay fails. */
7792 static void
7793 x_fatal_error_signal ()
7795 fprintf (stderr, "%s\n", error_msg);
7796 exit (70);
7799 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7800 the text of an error message that lead to the connection loss. */
7802 static SIGTYPE
7803 x_connection_closed (dpy, error_message)
7804 Display *dpy;
7805 char *error_message;
7807 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7808 Lisp_Object frame, tail;
7809 int index = SPECPDL_INDEX ();
7811 error_msg = (char *) alloca (strlen (error_message) + 1);
7812 strcpy (error_msg, error_message);
7813 handling_signal = 0;
7815 /* Prevent being called recursively because of an error condition
7816 below. Otherwise, we might end up with printing ``can't find per
7817 display information'' in the recursive call instead of printing
7818 the original message here. */
7819 x_catch_errors (dpy);
7821 /* Inhibit redisplay while frames are being deleted. */
7822 specbind (Qinhibit_redisplay, Qt);
7824 if (dpyinfo)
7826 /* Protect display from being closed when we delete the last
7827 frame on it. */
7828 dpyinfo->reference_count++;
7829 dpyinfo->terminal->reference_count++;
7832 /* First delete frames whose mini-buffers are on frames
7833 that are on the dead display. */
7834 FOR_EACH_FRAME (tail, frame)
7836 Lisp_Object minibuf_frame;
7837 minibuf_frame
7838 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7839 if (FRAME_X_P (XFRAME (frame))
7840 && FRAME_X_P (XFRAME (minibuf_frame))
7841 && ! EQ (frame, minibuf_frame)
7842 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7843 delete_frame (frame, Qnoelisp);
7846 /* Now delete all remaining frames on the dead display.
7847 We are now sure none of these is used as the mini-buffer
7848 for another frame that we need to delete. */
7849 FOR_EACH_FRAME (tail, frame)
7850 if (FRAME_X_P (XFRAME (frame))
7851 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7853 /* Set this to t so that delete_frame won't get confused
7854 trying to find a replacement. */
7855 FRAME_KBOARD (XFRAME (frame))->Vdefault_minibuffer_frame = Qt;
7856 delete_frame (frame, Qnoelisp);
7859 /* We have to close the display to inform Xt that it doesn't
7860 exist anymore. If we don't, Xt will continue to wait for
7861 events from the display. As a consequence, a sequence of
7863 M-x make-frame-on-display RET :1 RET
7864 ...kill the new frame, so that we get an IO error...
7865 M-x make-frame-on-display RET :1 RET
7867 will indefinitely wait in Xt for events for display `:1', opened
7868 in the first call to make-frame-on-display.
7870 Closing the display is reported to lead to a bus error on
7871 OpenWindows in certain situations. I suspect that is a bug
7872 in OpenWindows. I don't know how to circumvent it here. */
7874 if (dpyinfo)
7876 #ifdef USE_X_TOOLKIT
7877 /* If DPYINFO is null, this means we didn't open the display
7878 in the first place, so don't try to close it. */
7880 extern void (*fatal_error_signal_hook) P_ ((void));
7881 fatal_error_signal_hook = x_fatal_error_signal;
7882 XtCloseDisplay (dpy);
7883 fatal_error_signal_hook = NULL;
7885 #endif
7887 #ifdef USE_GTK
7888 /* Due to bugs in some Gtk+ versions, just exit here if this
7889 is the last display/terminal. */
7890 if (terminal_list->next_terminal == NULL)
7892 fprintf (stderr, "%s\n", error_msg);
7893 shut_down_emacs (0, 0, Qnil);
7894 exit (70);
7896 xg_display_close (dpyinfo->display);
7897 #endif
7899 /* Indicate that this display is dead. */
7900 dpyinfo->display = 0;
7902 dpyinfo->reference_count--;
7903 dpyinfo->terminal->reference_count--;
7904 if (dpyinfo->reference_count != 0)
7905 /* We have just closed all frames on this display. */
7906 abort ();
7909 Lisp_Object tmp;
7910 XSETTERMINAL (tmp, dpyinfo->terminal);
7911 Fdelete_terminal (tmp, Qnoelisp);
7915 x_uncatch_errors ();
7917 if (terminal_list == 0)
7919 fprintf (stderr, "%s\n", error_msg);
7920 shut_down_emacs (0, 0, Qnil);
7921 exit (70);
7924 /* Ordinary stack unwind doesn't deal with these. */
7925 #ifdef SIGIO
7926 sigunblock (sigmask (SIGIO));
7927 #endif
7928 sigunblock (sigmask (SIGALRM));
7929 TOTALLY_UNBLOCK_INPUT;
7931 unbind_to (index, Qnil);
7932 clear_waiting_for_input ();
7933 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7934 longjmp), because returning from this function would get us back into
7935 Xlib's code which will directly call `exit'. */
7936 error ("%s", error_msg);
7939 /* We specifically use it before defining it, so that gcc doesn't inline it,
7940 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7941 static void x_error_quitter P_ ((Display *, XErrorEvent *));
7943 /* This is the first-level handler for X protocol errors.
7944 It calls x_error_quitter or x_error_catcher. */
7946 static int
7947 x_error_handler (display, error)
7948 Display *display;
7949 XErrorEvent *error;
7951 if (x_error_message)
7952 x_error_catcher (display, error);
7953 else
7954 x_error_quitter (display, error);
7955 return 0;
7958 /* This is the usual handler for X protocol errors.
7959 It kills all frames on the display that we got the error for.
7960 If that was the only one, it prints an error message and kills Emacs. */
7962 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7964 #if __GNUC__ >= 3 /* On GCC 3.0 we might get a warning. */
7965 #define NO_INLINE __attribute__((noinline))
7966 #else
7967 #define NO_INLINE
7968 #endif
7970 /* Some versions of GNU/Linux define noinline in their headers. */
7972 #ifdef noinline
7973 #undef noinline
7974 #endif
7976 /* On older GCC versions, just putting x_error_quitter
7977 after x_error_handler prevents inlining into the former. */
7979 static void NO_INLINE
7980 x_error_quitter (display, error)
7981 Display *display;
7982 XErrorEvent *error;
7984 char buf[256], buf1[356];
7986 /* Ignore BadName errors. They can happen because of fonts
7987 or colors that are not defined. */
7989 if (error->error_code == BadName)
7990 return;
7992 /* Note that there is no real way portable across R3/R4 to get the
7993 original error handler. */
7995 XGetErrorText (display, error->error_code, buf, sizeof (buf));
7996 sprintf (buf1, "X protocol error: %s on protocol request %d",
7997 buf, error->request_code);
7998 x_connection_closed (display, buf1);
8002 /* This is the handler for X IO errors, always.
8003 It kills all frames on the display that we lost touch with.
8004 If that was the only one, it prints an error message and kills Emacs. */
8006 static int
8007 x_io_error_quitter (display)
8008 Display *display;
8010 char buf[256];
8012 sprintf (buf, "Connection lost to X server `%s'", DisplayString (display));
8013 x_connection_closed (display, buf);
8014 return 0;
8017 /* Changing the font of the frame. */
8019 /* Give frame F the font FONT-OBJECT as its default font. The return
8020 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
8021 frame. If it is negative, generate a new fontset from
8022 FONT-OBJECT. */
8024 Lisp_Object
8025 x_new_font (f, font_object, fontset)
8026 struct frame *f;
8027 Lisp_Object font_object;
8028 int fontset;
8030 struct font *font = XFONT_OBJECT (font_object);
8032 if (fontset < 0)
8033 fontset = fontset_from_font (font_object);
8034 FRAME_FONTSET (f) = fontset;
8035 if (FRAME_FONT (f) == font)
8036 /* This font is already set in frame F. There's nothing more to
8037 do. */
8038 return font_object;
8040 FRAME_FONT (f) = font;
8041 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
8042 FRAME_COLUMN_WIDTH (f) = font->average_width;
8043 FRAME_SPACE_WIDTH (f) = font->space_width;
8044 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
8046 compute_fringe_widths (f, 1);
8048 /* Compute the scroll bar width in character columns. */
8049 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
8051 int wid = FRAME_COLUMN_WIDTH (f);
8052 FRAME_CONFIG_SCROLL_BAR_COLS (f)
8053 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
8055 else
8057 int wid = FRAME_COLUMN_WIDTH (f);
8058 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
8061 if (FRAME_X_WINDOW (f) != 0)
8063 /* Don't change the size of a tip frame; there's no point in
8064 doing it because it's done in Fx_show_tip, and it leads to
8065 problems because the tip frame has no widget. */
8066 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
8068 int rows, cols;
8070 /* When the frame is maximized/fullscreen or running under for
8071 example Xmonad, x_set_window_size will be a no-op.
8072 In that case, the right thing to do is extend rows/cols to
8073 the current frame size. We do that first if x_set_window_size
8074 turns out to not be a no-op (there is no way to know).
8075 The size will be adjusted again if the frame gets a
8076 ConfigureNotify event as a result of x_set_window_size. */
8077 int pixelh = FRAME_PIXEL_HEIGHT (f);
8078 #ifdef USE_X_TOOLKIT
8079 /* The menu bar is not part of text lines. The tool bar
8080 is however. */
8081 pixelh -= FRAME_MENUBAR_HEIGHT (f);
8082 #endif
8083 rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, pixelh);
8084 /* Update f->scroll_bar_actual_width because it is used in
8085 FRAME_PIXEL_WIDTH_TO_TEXT_COLS. */
8086 f->scroll_bar_actual_width
8087 = FRAME_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f);
8088 cols = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, FRAME_PIXEL_WIDTH (f));
8090 change_frame_size (f, rows, cols, 0, 1, 0);
8091 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
8095 #ifdef HAVE_X_I18N
8096 if (FRAME_XIC (f)
8097 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
8099 BLOCK_INPUT;
8100 xic_set_xfontset (f, SDATA (fontset_ascii (fontset)));
8101 UNBLOCK_INPUT;
8103 #endif
8105 return font_object;
8109 /***********************************************************************
8110 X Input Methods
8111 ***********************************************************************/
8113 #ifdef HAVE_X_I18N
8115 #ifdef HAVE_X11R6
8117 /* XIM destroy callback function, which is called whenever the
8118 connection to input method XIM dies. CLIENT_DATA contains a
8119 pointer to the x_display_info structure corresponding to XIM. */
8121 static void
8122 xim_destroy_callback (xim, client_data, call_data)
8123 XIM xim;
8124 XPointer client_data;
8125 XPointer call_data;
8127 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
8128 Lisp_Object frame, tail;
8130 BLOCK_INPUT;
8132 /* No need to call XDestroyIC.. */
8133 FOR_EACH_FRAME (tail, frame)
8135 struct frame *f = XFRAME (frame);
8136 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
8138 FRAME_XIC (f) = NULL;
8139 xic_free_xfontset (f);
8143 /* No need to call XCloseIM. */
8144 dpyinfo->xim = NULL;
8145 XFree (dpyinfo->xim_styles);
8146 UNBLOCK_INPUT;
8149 #endif /* HAVE_X11R6 */
8151 #ifdef HAVE_X11R6
8152 /* This isn't prototyped in OSF 5.0 or 5.1a. */
8153 extern char *XSetIMValues P_ ((XIM, ...));
8154 #endif
8156 /* Open the connection to the XIM server on display DPYINFO.
8157 RESOURCE_NAME is the resource name Emacs uses. */
8159 static void
8160 xim_open_dpy (dpyinfo, resource_name)
8161 struct x_display_info *dpyinfo;
8162 char *resource_name;
8164 XIM xim;
8166 #ifdef HAVE_XIM
8167 if (use_xim)
8169 if (dpyinfo->xim)
8170 XCloseIM (dpyinfo->xim);
8171 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8172 EMACS_CLASS);
8173 dpyinfo->xim = xim;
8175 if (xim)
8177 #ifdef HAVE_X11R6
8178 XIMCallback destroy;
8179 #endif
8181 /* Get supported styles and XIM values. */
8182 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8184 #ifdef HAVE_X11R6
8185 destroy.callback = xim_destroy_callback;
8186 destroy.client_data = (XPointer)dpyinfo;
8187 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8188 #endif
8192 else
8193 #endif /* HAVE_XIM */
8194 dpyinfo->xim = NULL;
8198 #ifdef HAVE_X11R6_XIM
8200 /* XIM instantiate callback function, which is called whenever an XIM
8201 server is available. DISPLAY is the display of the XIM.
8202 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8203 when the callback was registered. */
8205 static void
8206 xim_instantiate_callback (display, client_data, call_data)
8207 Display *display;
8208 XPointer client_data;
8209 XPointer call_data;
8211 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8212 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8214 /* We don't support multiple XIM connections. */
8215 if (dpyinfo->xim)
8216 return;
8218 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8220 /* Create XIC for the existing frames on the same display, as long
8221 as they have no XIC. */
8222 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8224 Lisp_Object tail, frame;
8226 BLOCK_INPUT;
8227 FOR_EACH_FRAME (tail, frame)
8229 struct frame *f = XFRAME (frame);
8231 if (FRAME_X_P (f)
8232 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8233 if (FRAME_XIC (f) == NULL)
8235 create_frame_xic (f);
8236 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8237 xic_set_statusarea (f);
8238 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8240 struct window *w = XWINDOW (f->selected_window);
8241 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8246 UNBLOCK_INPUT;
8250 #endif /* HAVE_X11R6_XIM */
8253 /* Open a connection to the XIM server on display DPYINFO.
8254 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8255 connection only at the first time. On X11R6, open the connection
8256 in the XIM instantiate callback function. */
8258 static void
8259 xim_initialize (dpyinfo, resource_name)
8260 struct x_display_info *dpyinfo;
8261 char *resource_name;
8263 dpyinfo->xim = NULL;
8264 #ifdef HAVE_XIM
8265 if (use_xim)
8267 #ifdef HAVE_X11R6_XIM
8268 struct xim_inst_t *xim_inst;
8269 int len;
8271 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
8272 dpyinfo->xim_callback_data = xim_inst;
8273 xim_inst->dpyinfo = dpyinfo;
8274 len = strlen (resource_name);
8275 xim_inst->resource_name = (char *) xmalloc (len + 1);
8276 bcopy (resource_name, xim_inst->resource_name, len + 1);
8277 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8278 resource_name, EMACS_CLASS,
8279 xim_instantiate_callback,
8280 /* This is XPointer in XFree86
8281 but (XPointer *) on Tru64, at
8282 least, hence the configure test. */
8283 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8284 #else /* not HAVE_X11R6_XIM */
8285 xim_open_dpy (dpyinfo, resource_name);
8286 #endif /* not HAVE_X11R6_XIM */
8288 #endif /* HAVE_XIM */
8292 /* Close the connection to the XIM server on display DPYINFO. */
8294 static void
8295 xim_close_dpy (dpyinfo)
8296 struct x_display_info *dpyinfo;
8298 #ifdef HAVE_XIM
8299 if (use_xim)
8301 #ifdef HAVE_X11R6_XIM
8302 if (dpyinfo->display)
8303 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8304 NULL, EMACS_CLASS,
8305 xim_instantiate_callback, NULL);
8306 xfree (dpyinfo->xim_callback_data->resource_name);
8307 xfree (dpyinfo->xim_callback_data);
8308 #endif /* HAVE_X11R6_XIM */
8309 if (dpyinfo->display)
8310 XCloseIM (dpyinfo->xim);
8311 dpyinfo->xim = NULL;
8312 XFree (dpyinfo->xim_styles);
8314 #endif /* HAVE_XIM */
8317 #endif /* not HAVE_X11R6_XIM */
8321 /* Calculate the absolute position in frame F
8322 from its current recorded position values and gravity. */
8324 void
8325 x_calc_absolute_position (f)
8326 struct frame *f;
8328 int flags = f->size_hint_flags;
8330 /* We have nothing to do if the current position
8331 is already for the top-left corner. */
8332 if (! ((flags & XNegative) || (flags & YNegative)))
8333 return;
8335 /* Treat negative positions as relative to the leftmost bottommost
8336 position that fits on the screen. */
8337 if (flags & XNegative)
8338 f->left_pos = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
8339 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8342 int height = FRAME_PIXEL_HEIGHT (f);
8344 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8345 /* Something is fishy here. When using Motif, starting Emacs with
8346 `-g -0-0', the frame appears too low by a few pixels.
8348 This seems to be so because initially, while Emacs is starting,
8349 the column widget's height and the frame's pixel height are
8350 different. The column widget's height is the right one. In
8351 later invocations, when Emacs is up, the frame's pixel height
8352 is right, though.
8354 It's not obvious where the initial small difference comes from.
8355 2000-12-01, gerd. */
8357 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8358 #endif
8360 if (flags & YNegative)
8361 f->top_pos = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
8362 - height + f->top_pos;
8365 /* The left_pos and top_pos
8366 are now relative to the top and left screen edges,
8367 so the flags should correspond. */
8368 f->size_hint_flags &= ~ (XNegative | YNegative);
8371 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8372 to really change the position, and 0 when calling from
8373 x_make_frame_visible (in that case, XOFF and YOFF are the current
8374 position values). It is -1 when calling from x_set_frame_parameters,
8375 which means, do adjust for borders but don't change the gravity. */
8377 void
8378 x_set_offset (f, xoff, yoff, change_gravity)
8379 struct frame *f;
8380 register int xoff, yoff;
8381 int change_gravity;
8383 int modified_top, modified_left;
8385 if (change_gravity > 0)
8387 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8388 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8390 f->top_pos = yoff;
8391 f->left_pos = xoff;
8392 f->size_hint_flags &= ~ (XNegative | YNegative);
8393 if (xoff < 0)
8394 f->size_hint_flags |= XNegative;
8395 if (yoff < 0)
8396 f->size_hint_flags |= YNegative;
8397 f->win_gravity = NorthWestGravity;
8399 x_calc_absolute_position (f);
8401 BLOCK_INPUT;
8402 x_wm_set_size_hint (f, (long) 0, 0);
8404 modified_left = f->left_pos;
8405 modified_top = f->top_pos;
8407 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8409 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8410 than the WM decorations. So we use the calculated offset instead
8411 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8412 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8413 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8416 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8417 modified_left, modified_top);
8419 x_sync_with_move (f, f->left_pos, f->top_pos,
8420 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8421 ? 1 : 0);
8423 /* change_gravity is non-zero when this function is called from Lisp to
8424 programmatically move a frame. In that case, we call
8425 x_check_expected_move to discover if we have a "Type A" or "Type B"
8426 window manager, and, for a "Type A" window manager, adjust the position
8427 of the frame.
8429 We call x_check_expected_move if a programmatic move occurred, and
8430 either the window manager type (A/B) is unknown or it is Type A but we
8431 need to compute the top/left offset adjustment for this frame. */
8433 if (change_gravity != 0 &&
8434 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8435 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8436 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8437 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8438 x_check_expected_move (f, modified_left, modified_top);
8440 UNBLOCK_INPUT;
8443 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8444 on the root window for frame F contains ATOMNAME.
8445 This is how a WM check shall be done according to the Window Manager
8446 Specification/Extended Window Manager Hints at
8447 http://freedesktop.org/wiki/Specifications/wm-spec. */
8449 static int
8450 wm_supports (f, atomname)
8451 struct frame *f;
8452 const char *atomname;
8454 Atom actual_type;
8455 unsigned long actual_size, bytes_remaining;
8456 int i, rc, actual_format;
8457 Atom prop_atom;
8458 Window wmcheck_window;
8459 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8460 Window target_window = dpyinfo->root_window;
8461 long max_len = 65536;
8462 Display *dpy = FRAME_X_DISPLAY (f);
8463 unsigned char *tmp_data = NULL;
8464 Atom target_type = XA_WINDOW;
8465 Atom want_atom;
8467 BLOCK_INPUT;
8469 prop_atom = XInternAtom (dpy, "_NET_SUPPORTING_WM_CHECK", False);
8471 x_catch_errors (dpy);
8472 rc = XGetWindowProperty (dpy, target_window,
8473 prop_atom, 0, max_len, False, target_type,
8474 &actual_type, &actual_format, &actual_size,
8475 &bytes_remaining, &tmp_data);
8477 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8479 if (tmp_data) XFree (tmp_data);
8480 x_uncatch_errors ();
8481 UNBLOCK_INPUT;
8482 return 0;
8485 wmcheck_window = *(Window *) tmp_data;
8486 XFree (tmp_data);
8488 /* Check if window exists. */
8489 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8490 x_sync (f);
8491 if (x_had_errors_p (dpy))
8493 x_uncatch_errors ();
8494 UNBLOCK_INPUT;
8495 return 0;
8498 if (dpyinfo->net_supported_window != wmcheck_window)
8500 /* Window changed, reload atoms */
8501 if (dpyinfo->net_supported_atoms != NULL)
8502 XFree (dpyinfo->net_supported_atoms);
8503 dpyinfo->net_supported_atoms = NULL;
8504 dpyinfo->nr_net_supported_atoms = 0;
8505 dpyinfo->net_supported_window = 0;
8507 target_type = XA_ATOM;
8508 prop_atom = XInternAtom (dpy, "_NET_SUPPORTED", False);
8509 tmp_data = NULL;
8510 rc = XGetWindowProperty (dpy, target_window,
8511 prop_atom, 0, max_len, False, target_type,
8512 &actual_type, &actual_format, &actual_size,
8513 &bytes_remaining, &tmp_data);
8515 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8517 if (tmp_data) XFree (tmp_data);
8518 x_uncatch_errors ();
8519 UNBLOCK_INPUT;
8520 return 0;
8523 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8524 dpyinfo->nr_net_supported_atoms = actual_size;
8525 dpyinfo->net_supported_window = wmcheck_window;
8528 rc = 0;
8529 want_atom = XInternAtom (dpy, atomname, False);
8531 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8532 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8534 x_uncatch_errors ();
8535 UNBLOCK_INPUT;
8537 return rc;
8540 static void
8541 set_wm_state (frame, add, what, what2)
8542 Lisp_Object frame;
8543 int add;
8544 const char *what;
8545 const char *what2;
8547 const char *atom = "_NET_WM_STATE";
8548 Fx_send_client_event (frame, make_number (0), frame,
8549 make_unibyte_string (atom, strlen (atom)),
8550 make_number (32),
8551 /* 1 = add, 0 = remove */
8552 Fcons
8553 (make_number (add ? 1 : 0),
8554 Fcons
8555 (make_unibyte_string (what, strlen (what)),
8556 what2 != 0
8557 ? Fcons (make_unibyte_string (what2, strlen (what2)),
8558 Qnil)
8559 : Qnil)));
8562 void
8563 x_set_sticky (f, new_value, old_value)
8564 struct frame *f;
8565 Lisp_Object new_value, old_value;
8567 Lisp_Object frame;
8569 XSETFRAME (frame, f);
8570 set_wm_state (frame, NILP (new_value) ? 0 : 1,
8571 "_NET_WM_STATE_STICKY", NULL);
8574 /* Do fullscreen as specified in extended window manager hints */
8576 static int
8577 do_ewmh_fullscreen (f)
8578 struct frame *f;
8580 int have_net_atom = wm_supports (f, "_NET_WM_STATE");
8582 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8583 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8584 if (!have_net_atom)
8585 have_net_atom = wm_supports (f, "_NET_WM_STATE_FULLSCREEN");
8587 if (have_net_atom)
8589 Lisp_Object frame;
8590 const char *fs = "_NET_WM_STATE_FULLSCREEN";
8591 const char *fw = "_NET_WM_STATE_MAXIMIZED_HORZ";
8592 const char *fh = "_NET_WM_STATE_MAXIMIZED_VERT";
8594 XSETFRAME (frame, f);
8596 set_wm_state (frame, 0, fs, NULL);
8597 set_wm_state (frame, 0, fh, NULL);
8598 set_wm_state (frame, 0, fw, NULL);
8600 /* If there are _NET_ atoms we assume we have extended window manager
8601 hints. */
8602 switch (f->want_fullscreen)
8604 case FULLSCREEN_BOTH:
8605 set_wm_state (frame, 1, fs, NULL);
8606 break;
8607 case FULLSCREEN_WIDTH:
8608 set_wm_state (frame, 1, fw, NULL);
8609 break;
8610 case FULLSCREEN_HEIGHT:
8611 set_wm_state (frame, 1, fh, NULL);
8612 break;
8613 case FULLSCREEN_MAXIMIZED:
8614 set_wm_state (frame, 1, fw, fh);
8615 break;
8618 f->want_fullscreen = FULLSCREEN_NONE;
8622 return have_net_atom;
8625 static void
8626 XTfullscreen_hook (f)
8627 FRAME_PTR f;
8629 if (f->async_visible)
8631 BLOCK_INPUT;
8632 x_check_fullscreen (f);
8633 x_sync (f);
8634 UNBLOCK_INPUT;
8639 static void
8640 x_handle_net_wm_state (f, event)
8641 struct frame *f;
8642 XPropertyEvent *event;
8644 Atom actual_type;
8645 unsigned long actual_size, bytes_remaining;
8646 int i, rc, actual_format, value = FULLSCREEN_NONE;
8647 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8648 long max_len = 65536;
8649 Display *dpy = FRAME_X_DISPLAY (f);
8650 unsigned char *tmp_data = NULL;
8651 Atom target_type = XA_ATOM;
8652 Lisp_Object lval;
8653 int sticky = 0;
8655 BLOCK_INPUT;
8656 x_catch_errors (dpy);
8657 rc = XGetWindowProperty (dpy, event->window,
8658 event->atom, 0, max_len, False, target_type,
8659 &actual_type, &actual_format, &actual_size,
8660 &bytes_remaining, &tmp_data);
8662 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
8664 if (tmp_data) XFree (tmp_data);
8665 x_uncatch_errors ();
8666 UNBLOCK_INPUT;
8667 return;
8670 x_uncatch_errors ();
8672 for (i = 0; i < actual_size; ++i)
8674 Atom a = ((Atom*)tmp_data)[i];
8675 if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
8677 if (value == FULLSCREEN_HEIGHT)
8678 value = FULLSCREEN_MAXIMIZED;
8679 else
8680 value = FULLSCREEN_WIDTH;
8682 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
8684 if (value == FULLSCREEN_WIDTH)
8685 value = FULLSCREEN_MAXIMIZED;
8686 else
8687 value = FULLSCREEN_HEIGHT;
8689 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen_atom)
8690 value = FULLSCREEN_BOTH;
8691 else if (a == dpyinfo->Xatom_net_wm_state_sticky)
8692 sticky = 1;
8695 lval = Qnil;
8696 switch (value)
8698 case FULLSCREEN_WIDTH:
8699 lval = Qfullwidth;
8700 break;
8701 case FULLSCREEN_HEIGHT:
8702 lval = Qfullheight;
8703 break;
8704 case FULLSCREEN_BOTH:
8705 lval = Qfullboth;
8706 break;
8707 case FULLSCREEN_MAXIMIZED:
8708 lval = Qmaximized;
8709 break;
8712 store_frame_param (f, Qfullscreen, lval);
8713 store_frame_param (f, Qsticky, sticky ? Qt : Qnil);
8715 if (tmp_data) XFree (tmp_data);
8716 UNBLOCK_INPUT;
8719 /* Check if we need to resize the frame due to a fullscreen request.
8720 If so needed, resize the frame. */
8721 static void
8722 x_check_fullscreen (f)
8723 struct frame *f;
8725 if (do_ewmh_fullscreen (f))
8726 return;
8728 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
8729 return; /* Only fullscreen without WM or with EWM hints (above). */
8731 if (f->want_fullscreen != FULLSCREEN_NONE)
8733 int width = FRAME_COLS (f), height = FRAME_LINES (f);
8734 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8736 switch (f->want_fullscreen)
8738 /* No difference between these two when there is no WM */
8739 case FULLSCREEN_BOTH:
8740 case FULLSCREEN_MAXIMIZED:
8741 width = x_display_pixel_width (dpyinfo);
8742 height = x_display_pixel_height (dpyinfo);
8743 break;
8744 case FULLSCREEN_WIDTH:
8745 width = x_display_pixel_width (dpyinfo);
8746 break;
8747 case FULLSCREEN_HEIGHT:
8748 height = x_display_pixel_height (dpyinfo);
8751 if (FRAME_COLS (f) != width || FRAME_LINES (f) != height)
8753 change_frame_size (f, height, width, 0, 1, 0);
8754 SET_FRAME_GARBAGED (f);
8755 cancel_mouse_face (f);
8760 /* This function is called by x_set_offset to determine whether the window
8761 manager interfered with the positioning of the frame. Type A window
8762 managers position the surrounding window manager decorations a small
8763 amount above and left of the user-supplied position. Type B window
8764 managers position the surrounding window manager decorations at the
8765 user-specified position. If we detect a Type A window manager, we
8766 compensate by moving the window right and down by the proper amount. */
8768 static void
8769 x_check_expected_move (f, expected_left, expected_top)
8770 struct frame *f;
8771 int expected_left;
8772 int expected_top;
8774 int current_left = 0, current_top = 0;
8776 /* x_real_positions returns the left and top offsets of the outermost
8777 window manager window around the frame. */
8779 x_real_positions (f, &current_left, &current_top);
8781 if (current_left != expected_left || current_top != expected_top)
8783 /* It's a "Type A" window manager. */
8785 int adjusted_left;
8786 int adjusted_top;
8788 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8789 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8790 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8792 /* Now fix the mispositioned frame's location. */
8794 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8795 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8797 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8798 adjusted_left, adjusted_top);
8800 x_sync_with_move (f, expected_left, expected_top, 0);
8802 else
8803 /* It's a "Type B" window manager. We don't have to adjust the
8804 frame's position. */
8806 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8810 /* Wait for XGetGeometry to return up-to-date position information for a
8811 recently-moved frame. Call this immediately after calling XMoveWindow.
8812 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8813 frame has been moved to, so we use a fuzzy position comparison instead
8814 of an exact comparison. */
8816 static void
8817 x_sync_with_move (f, left, top, fuzzy)
8818 struct frame *f;
8819 int left, top, fuzzy;
8821 int count = 0;
8823 while (count++ < 50)
8825 int current_left = 0, current_top = 0;
8827 /* In theory, this call to XSync only needs to happen once, but in
8828 practice, it doesn't seem to work, hence the need for the surrounding
8829 loop. */
8831 XSync (FRAME_X_DISPLAY (f), False);
8832 x_real_positions (f, &current_left, &current_top);
8834 if (fuzzy)
8836 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8837 pixels. */
8839 if (eabs (current_left - left) <= 10
8840 && eabs (current_top - top) <= 40)
8841 return;
8843 else if (current_left == left && current_top == top)
8844 return;
8847 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8848 will then return up-to-date position info. */
8850 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8854 /* Wait for an event on frame F matching EVENTTYPE. */
8855 void
8856 x_wait_for_event (f, eventtype)
8857 struct frame *f;
8858 int eventtype;
8860 int level = interrupt_input_blocked;
8862 SELECT_TYPE fds;
8863 EMACS_TIME tmo, tmo_at, time_now;
8864 int fd = ConnectionNumber (FRAME_X_DISPLAY (f));
8866 pending_event_wait.f = f;
8867 pending_event_wait.eventtype = eventtype;
8869 /* Set timeout to 0.1 second. Hopefully not noticable.
8870 Maybe it should be configurable. */
8871 EMACS_SET_SECS_USECS (tmo, 0, 100000);
8872 EMACS_GET_TIME (tmo_at);
8873 EMACS_ADD_TIME (tmo_at, tmo_at, tmo);
8875 while (pending_event_wait.eventtype)
8877 interrupt_input_pending = 1;
8878 TOTALLY_UNBLOCK_INPUT;
8879 /* XTread_socket is called after unblock. */
8880 BLOCK_INPUT;
8881 interrupt_input_blocked = level;
8883 FD_ZERO (&fds);
8884 FD_SET (fd, &fds);
8886 EMACS_GET_TIME (time_now);
8887 EMACS_SUB_TIME (tmo, tmo_at, time_now);
8889 if (EMACS_TIME_NEG_P (tmo) || select (fd+1, &fds, NULL, NULL, &tmo) == 0)
8890 break; /* Timeout */
8892 pending_event_wait.f = 0;
8893 pending_event_wait.eventtype = 0;
8897 /* Change the size of frame F's X window to COLS/ROWS in the case F
8898 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8899 top-left-corner window gravity for this size change and subsequent
8900 size changes. Otherwise we leave the window gravity unchanged. */
8902 static void
8903 x_set_window_size_1 (f, change_gravity, cols, rows)
8904 struct frame *f;
8905 int change_gravity;
8906 int cols, rows;
8908 int pixelwidth, pixelheight;
8910 check_frame_size (f, &rows, &cols);
8911 f->scroll_bar_actual_width
8912 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8914 : FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0
8915 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)
8916 : (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)));
8918 compute_fringe_widths (f, 0);
8920 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols)
8921 + 2*f->border_width;
8922 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows)
8923 + FRAME_MENUBAR_HEIGHT (f) + FRAME_TOOLBAR_HEIGHT (f)
8924 + 2*f->border_width;
8926 if (change_gravity) f->win_gravity = NorthWestGravity;
8927 x_wm_set_size_hint (f, (long) 0, 0);
8928 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8929 pixelwidth, pixelheight);
8932 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8933 receive in the ConfigureNotify event; if we get what we asked
8934 for, then the event won't cause the screen to become garbaged, so
8935 we have to make sure to do it here. */
8936 SET_FRAME_GARBAGED (f);
8938 /* Now, strictly speaking, we can't be sure that this is accurate,
8939 but the window manager will get around to dealing with the size
8940 change request eventually, and we'll hear how it went when the
8941 ConfigureNotify event gets here.
8943 We could just not bother storing any of this information here,
8944 and let the ConfigureNotify event set everything up, but that
8945 might be kind of confusing to the Lisp code, since size changes
8946 wouldn't be reported in the frame parameters until some random
8947 point in the future when the ConfigureNotify event arrives.
8949 We pass 1 for DELAY since we can't run Lisp code inside of
8950 a BLOCK_INPUT. */
8952 /* But the ConfigureNotify may in fact never arrive, and then this is
8953 not right if the frame is visible. Instead wait (with timeout)
8954 for the ConfigureNotify. */
8955 if (f->async_visible)
8956 x_wait_for_event (f, ConfigureNotify);
8957 else
8959 change_frame_size (f, rows, cols, 0, 1, 0);
8960 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8961 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8962 x_sync (f);
8967 /* Call this to change the size of frame F's x-window.
8968 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8969 for this size change and subsequent size changes.
8970 Otherwise we leave the window gravity unchanged. */
8972 void
8973 x_set_window_size (f, change_gravity, cols, rows)
8974 struct frame *f;
8975 int change_gravity;
8976 int cols, rows;
8978 BLOCK_INPUT;
8980 #ifdef USE_GTK
8981 if (FRAME_GTK_WIDGET (f))
8982 xg_frame_set_char_size (f, cols, rows);
8983 else
8984 x_set_window_size_1 (f, change_gravity, cols, rows);
8985 #else /* not USE_GTK */
8987 x_set_window_size_1 (f, change_gravity, cols, rows);
8989 #endif /* not USE_GTK */
8991 /* If cursor was outside the new size, mark it as off. */
8992 mark_window_cursors_off (XWINDOW (f->root_window));
8994 /* Clear out any recollection of where the mouse highlighting was,
8995 since it might be in a place that's outside the new frame size.
8996 Actually checking whether it is outside is a pain in the neck,
8997 so don't try--just let the highlighting be done afresh with new size. */
8998 cancel_mouse_face (f);
9000 UNBLOCK_INPUT;
9003 /* Mouse warping. */
9005 void
9006 x_set_mouse_position (f, x, y)
9007 struct frame *f;
9008 int x, y;
9010 int pix_x, pix_y;
9012 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
9013 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
9015 if (pix_x < 0) pix_x = 0;
9016 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
9018 if (pix_y < 0) pix_y = 0;
9019 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
9021 BLOCK_INPUT;
9023 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
9024 0, 0, 0, 0, pix_x, pix_y);
9025 UNBLOCK_INPUT;
9028 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
9030 void
9031 x_set_mouse_pixel_position (f, pix_x, pix_y)
9032 struct frame *f;
9033 int pix_x, pix_y;
9035 BLOCK_INPUT;
9037 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
9038 0, 0, 0, 0, pix_x, pix_y);
9039 UNBLOCK_INPUT;
9042 /* focus shifting, raising and lowering. */
9044 void
9045 x_focus_on_frame (f)
9046 struct frame *f;
9048 #if 0
9049 /* I don't think that the ICCCM allows programs to do things like this
9050 without the interaction of the window manager. Whatever you end up
9051 doing with this code, do it to x_unfocus_frame too. */
9052 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
9053 RevertToPointerRoot, CurrentTime);
9054 #endif /* ! 0 */
9057 void
9058 x_unfocus_frame (f)
9059 struct frame *f;
9061 #if 0
9062 /* Look at the remarks in x_focus_on_frame. */
9063 if (FRAME_X_DISPLAY_INFO (f)->x_focus_frame == f)
9064 XSetInputFocus (FRAME_X_DISPLAY (f), PointerRoot,
9065 RevertToPointerRoot, CurrentTime);
9066 #endif /* ! 0 */
9069 /* Raise frame F. */
9071 void
9072 x_raise_frame (f)
9073 struct frame *f;
9075 BLOCK_INPUT;
9076 if (f->async_visible)
9077 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
9079 XFlush (FRAME_X_DISPLAY (f));
9080 UNBLOCK_INPUT;
9083 /* Lower frame F. */
9085 void
9086 x_lower_frame (f)
9087 struct frame *f;
9089 if (f->async_visible)
9091 BLOCK_INPUT;
9092 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
9093 XFlush (FRAME_X_DISPLAY (f));
9094 UNBLOCK_INPUT;
9098 /* Activate frame with Extended Window Manager Hints */
9100 void
9101 x_ewmh_activate_frame (f)
9102 FRAME_PTR f;
9104 /* See Window Manager Specification/Extended Window Manager Hints at
9105 http://freedesktop.org/wiki/Specifications/wm-spec */
9107 const char *atom = "_NET_ACTIVE_WINDOW";
9108 if (f->async_visible && wm_supports (f, atom))
9110 Lisp_Object frame;
9111 XSETFRAME (frame, f);
9112 Fx_send_client_event (frame, make_number (0), frame,
9113 make_unibyte_string (atom, strlen (atom)),
9114 make_number (32),
9115 Fcons (make_number (1),
9116 Fcons (make_number (last_user_time),
9117 Qnil)));
9121 static void
9122 XTframe_raise_lower (f, raise_flag)
9123 FRAME_PTR f;
9124 int raise_flag;
9126 if (raise_flag)
9127 x_raise_frame (f);
9128 else
9129 x_lower_frame (f);
9132 /* XEmbed implementation. */
9134 void
9135 xembed_set_info (f, flags)
9136 struct frame *f;
9137 enum xembed_info flags;
9139 Atom atom;
9140 unsigned long data[2];
9142 atom = XInternAtom (FRAME_X_DISPLAY (f), "_XEMBED_INFO", False);
9144 data[0] = XEMBED_VERSION;
9145 data[1] = flags;
9147 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), atom, atom,
9148 32, PropModeReplace, (unsigned char *) data, 2);
9151 void
9152 xembed_send_message (f, time, message, detail, data1, data2)
9153 struct frame *f;
9154 Time time;
9155 enum xembed_message message;
9156 long detail;
9157 long data1;
9158 long data2;
9160 XEvent event;
9162 event.xclient.type = ClientMessage;
9163 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
9164 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
9165 event.xclient.format = 32;
9166 event.xclient.data.l[0] = time;
9167 event.xclient.data.l[1] = message;
9168 event.xclient.data.l[2] = detail;
9169 event.xclient.data.l[3] = data1;
9170 event.xclient.data.l[4] = data2;
9172 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9173 False, NoEventMask, &event);
9174 XSync (FRAME_X_DISPLAY (f), False);
9177 /* Change of visibility. */
9179 /* This tries to wait until the frame is really visible.
9180 However, if the window manager asks the user where to position
9181 the frame, this will return before the user finishes doing that.
9182 The frame will not actually be visible at that time,
9183 but it will become visible later when the window manager
9184 finishes with it. */
9186 void
9187 x_make_frame_visible (f)
9188 struct frame *f;
9190 Lisp_Object type;
9191 int original_top, original_left;
9192 int retry_count = 2;
9194 retry:
9196 BLOCK_INPUT;
9198 type = x_icon_type (f);
9199 if (!NILP (type))
9200 x_bitmap_icon (f, type);
9202 if (! FRAME_VISIBLE_P (f))
9204 /* We test FRAME_GARBAGED_P here to make sure we don't
9205 call x_set_offset a second time
9206 if we get to x_make_frame_visible a second time
9207 before the window gets really visible. */
9208 if (! FRAME_ICONIFIED_P (f)
9209 && ! FRAME_X_EMBEDDED_P (f)
9210 && ! f->output_data.x->asked_for_visible)
9211 x_set_offset (f, f->left_pos, f->top_pos, 0);
9213 f->output_data.x->asked_for_visible = 1;
9215 if (! EQ (Vx_no_window_manager, Qt))
9216 x_wm_set_window_state (f, NormalState);
9217 #ifdef USE_X_TOOLKIT
9218 if (FRAME_X_EMBEDDED_P (f))
9219 xembed_set_info (f, XEMBED_MAPPED);
9220 else
9222 /* This was XtPopup, but that did nothing for an iconified frame. */
9223 XtMapWidget (f->output_data.x->widget);
9225 #else /* not USE_X_TOOLKIT */
9226 #ifdef USE_GTK
9227 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9228 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9229 #else
9230 if (FRAME_X_EMBEDDED_P (f))
9231 xembed_set_info (f, XEMBED_MAPPED);
9232 else
9233 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9234 #endif /* not USE_GTK */
9235 #endif /* not USE_X_TOOLKIT */
9238 XFlush (FRAME_X_DISPLAY (f));
9240 /* Synchronize to ensure Emacs knows the frame is visible
9241 before we do anything else. We do this loop with input not blocked
9242 so that incoming events are handled. */
9244 Lisp_Object frame;
9245 int count;
9246 /* This must be before UNBLOCK_INPUT
9247 since events that arrive in response to the actions above
9248 will set it when they are handled. */
9249 int previously_visible = f->output_data.x->has_been_visible;
9251 original_left = f->left_pos;
9252 original_top = f->top_pos;
9254 /* This must come after we set COUNT. */
9255 UNBLOCK_INPUT;
9257 /* We unblock here so that arriving X events are processed. */
9259 /* Now move the window back to where it was "supposed to be".
9260 But don't do it if the gravity is negative.
9261 When the gravity is negative, this uses a position
9262 that is 3 pixels too low. Perhaps that's really the border width.
9264 Don't do this if the window has never been visible before,
9265 because the window manager may choose the position
9266 and we don't want to override it. */
9268 if (! FRAME_VISIBLE_P (f)
9269 && ! FRAME_ICONIFIED_P (f)
9270 && ! FRAME_X_EMBEDDED_P (f)
9271 && f->win_gravity == NorthWestGravity
9272 && previously_visible)
9274 Drawable rootw;
9275 int x, y;
9276 unsigned int width, height, border, depth;
9278 BLOCK_INPUT;
9280 /* On some window managers (such as FVWM) moving an existing
9281 window, even to the same place, causes the window manager
9282 to introduce an offset. This can cause the window to move
9283 to an unexpected location. Check the geometry (a little
9284 slow here) and then verify that the window is in the right
9285 place. If the window is not in the right place, move it
9286 there, and take the potential window manager hit. */
9287 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9288 &rootw, &x, &y, &width, &height, &border, &depth);
9290 if (original_left != x || original_top != y)
9291 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9292 original_left, original_top);
9294 UNBLOCK_INPUT;
9297 XSETFRAME (frame, f);
9299 /* Wait until the frame is visible. Process X events until a
9300 MapNotify event has been seen, or until we think we won't get a
9301 MapNotify at all.. */
9302 for (count = input_signal_count + 10;
9303 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9305 /* Force processing of queued events. */
9306 x_sync (f);
9308 /* Machines that do polling rather than SIGIO have been
9309 observed to go into a busy-wait here. So we'll fake an
9310 alarm signal to let the handler know that there's something
9311 to be read. We used to raise a real alarm, but it seems
9312 that the handler isn't always enabled here. This is
9313 probably a bug. */
9314 if (input_polling_used ())
9316 /* It could be confusing if a real alarm arrives while
9317 processing the fake one. Turn it off and let the
9318 handler reset it. */
9319 extern void poll_for_input_1 P_ ((void));
9320 int old_poll_suppress_count = poll_suppress_count;
9321 poll_suppress_count = 1;
9322 poll_for_input_1 ();
9323 poll_suppress_count = old_poll_suppress_count;
9326 /* See if a MapNotify event has been processed. */
9327 FRAME_SAMPLE_VISIBILITY (f);
9330 /* 2000-09-28: In
9332 (let ((f (selected-frame)))
9333 (iconify-frame f)
9334 (raise-frame f))
9336 the frame is not raised with various window managers on
9337 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9338 unknown reason, the call to XtMapWidget is completely ignored.
9339 Mapping the widget a second time works. */
9341 if (!FRAME_VISIBLE_P (f) && --retry_count > 0)
9342 goto retry;
9346 /* Change from mapped state to withdrawn state. */
9348 /* Make the frame visible (mapped and not iconified). */
9350 void
9351 x_make_frame_invisible (f)
9352 struct frame *f;
9354 Window window;
9356 /* Use the frame's outermost window, not the one we normally draw on. */
9357 window = FRAME_OUTER_WINDOW (f);
9359 /* Don't keep the highlight on an invisible frame. */
9360 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9361 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9363 BLOCK_INPUT;
9365 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9366 that the current position of the window is user-specified, rather than
9367 program-specified, so that when the window is mapped again, it will be
9368 placed at the same location, without forcing the user to position it
9369 by hand again (they have already done that once for this window.) */
9370 x_wm_set_size_hint (f, (long) 0, 1);
9372 #ifdef USE_GTK
9373 if (FRAME_GTK_OUTER_WIDGET (f))
9374 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9375 else
9376 #else
9377 if (FRAME_X_EMBEDDED_P (f))
9378 xembed_set_info (f, 0);
9379 else
9380 #endif
9383 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9384 DefaultScreen (FRAME_X_DISPLAY (f))))
9386 UNBLOCK_INPUT_RESIGNAL;
9387 error ("Can't notify window manager of window withdrawal");
9391 /* We can't distinguish this from iconification
9392 just by the event that we get from the server.
9393 So we can't win using the usual strategy of letting
9394 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9395 and synchronize with the server to make sure we agree. */
9396 f->visible = 0;
9397 FRAME_ICONIFIED_P (f) = 0;
9398 f->async_visible = 0;
9399 f->async_iconified = 0;
9401 x_sync (f);
9403 UNBLOCK_INPUT;
9406 /* Change window state from mapped to iconified. */
9408 void
9409 x_iconify_frame (f)
9410 struct frame *f;
9412 int result;
9413 Lisp_Object type;
9415 /* Don't keep the highlight on an invisible frame. */
9416 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9417 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9419 if (f->async_iconified)
9420 return;
9422 BLOCK_INPUT;
9424 FRAME_SAMPLE_VISIBILITY (f);
9426 type = x_icon_type (f);
9427 if (!NILP (type))
9428 x_bitmap_icon (f, type);
9430 #ifdef USE_GTK
9431 if (FRAME_GTK_OUTER_WIDGET (f))
9433 if (! FRAME_VISIBLE_P (f))
9434 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9436 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9437 f->iconified = 1;
9438 f->visible = 1;
9439 f->async_iconified = 1;
9440 f->async_visible = 0;
9441 UNBLOCK_INPUT;
9442 return;
9444 #endif
9446 #ifdef USE_X_TOOLKIT
9448 if (! FRAME_VISIBLE_P (f))
9450 if (! EQ (Vx_no_window_manager, Qt))
9451 x_wm_set_window_state (f, IconicState);
9452 /* This was XtPopup, but that did nothing for an iconified frame. */
9453 XtMapWidget (f->output_data.x->widget);
9454 /* The server won't give us any event to indicate
9455 that an invisible frame was changed to an icon,
9456 so we have to record it here. */
9457 f->iconified = 1;
9458 f->visible = 1;
9459 f->async_iconified = 1;
9460 f->async_visible = 0;
9461 UNBLOCK_INPUT;
9462 return;
9465 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9466 XtWindow (f->output_data.x->widget),
9467 DefaultScreen (FRAME_X_DISPLAY (f)));
9468 UNBLOCK_INPUT;
9470 if (!result)
9471 error ("Can't notify window manager of iconification");
9473 f->async_iconified = 1;
9474 f->async_visible = 0;
9477 BLOCK_INPUT;
9478 XFlush (FRAME_X_DISPLAY (f));
9479 UNBLOCK_INPUT;
9480 #else /* not USE_X_TOOLKIT */
9482 /* Make sure the X server knows where the window should be positioned,
9483 in case the user deiconifies with the window manager. */
9484 if (! FRAME_VISIBLE_P (f)
9485 && ! FRAME_ICONIFIED_P (f)
9486 && ! FRAME_X_EMBEDDED_P (f))
9487 x_set_offset (f, f->left_pos, f->top_pos, 0);
9489 /* Since we don't know which revision of X we're running, we'll use both
9490 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9492 /* X11R4: send a ClientMessage to the window manager using the
9493 WM_CHANGE_STATE type. */
9495 XEvent message;
9497 message.xclient.window = FRAME_X_WINDOW (f);
9498 message.xclient.type = ClientMessage;
9499 message.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9500 message.xclient.format = 32;
9501 message.xclient.data.l[0] = IconicState;
9503 if (! XSendEvent (FRAME_X_DISPLAY (f),
9504 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9505 False,
9506 SubstructureRedirectMask | SubstructureNotifyMask,
9507 &message))
9509 UNBLOCK_INPUT_RESIGNAL;
9510 error ("Can't notify window manager of iconification");
9514 /* X11R3: set the initial_state field of the window manager hints to
9515 IconicState. */
9516 x_wm_set_window_state (f, IconicState);
9518 if (!FRAME_VISIBLE_P (f))
9520 /* If the frame was withdrawn, before, we must map it. */
9521 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9524 f->async_iconified = 1;
9525 f->async_visible = 0;
9527 XFlush (FRAME_X_DISPLAY (f));
9528 UNBLOCK_INPUT;
9529 #endif /* not USE_X_TOOLKIT */
9533 /* Free X resources of frame F. */
9535 void
9536 x_free_frame_resources (f)
9537 struct frame *f;
9539 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9540 Lisp_Object bar;
9541 struct scroll_bar *b;
9543 BLOCK_INPUT;
9545 /* If a display connection is dead, don't try sending more
9546 commands to the X server. */
9547 if (dpyinfo->display)
9549 /* We must free faces before destroying windows because some
9550 font-driver (e.g. xft) access a window while finishing a
9551 face. */
9552 if (FRAME_FACE_CACHE (f))
9553 free_frame_faces (f);
9555 if (f->output_data.x->icon_desc)
9556 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9558 #ifdef USE_X_TOOLKIT
9559 /* Explicitly destroy the scroll bars of the frame. Without
9560 this, we get "BadDrawable" errors from the toolkit later on,
9561 presumably from expose events generated for the disappearing
9562 toolkit scroll bars. */
9563 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9565 b = XSCROLL_BAR (bar);
9566 x_scroll_bar_remove (b);
9568 #endif
9570 #ifdef HAVE_X_I18N
9571 if (FRAME_XIC (f))
9572 free_frame_xic (f);
9573 #endif
9575 #ifdef USE_X_TOOLKIT
9576 if (f->output_data.x->widget)
9578 XtDestroyWidget (f->output_data.x->widget);
9579 f->output_data.x->widget = NULL;
9581 /* Tooltips don't have widgets, only a simple X window, even if
9582 we are using a toolkit. */
9583 else if (FRAME_X_WINDOW (f))
9584 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9586 free_frame_menubar (f);
9587 #else /* !USE_X_TOOLKIT */
9589 #ifdef USE_GTK
9590 /* In the GTK version, tooltips are normal X
9591 frames. We must check and free both types. */
9592 if (FRAME_GTK_OUTER_WIDGET (f))
9594 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
9595 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow below */
9596 FRAME_GTK_OUTER_WIDGET (f) = 0;
9598 #endif /* USE_GTK */
9600 if (FRAME_X_WINDOW (f))
9601 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9602 #endif /* !USE_X_TOOLKIT */
9604 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9605 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9606 unload_color (f, f->output_data.x->cursor_pixel);
9607 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9608 unload_color (f, f->output_data.x->border_pixel);
9609 unload_color (f, f->output_data.x->mouse_pixel);
9611 if (f->output_data.x->scroll_bar_background_pixel != -1)
9612 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9613 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9614 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9615 #ifdef USE_TOOLKIT_SCROLL_BARS
9616 /* Scrollbar shadow colors. */
9617 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9618 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9619 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9620 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9621 #endif /* USE_TOOLKIT_SCROLL_BARS */
9622 if (f->output_data.x->white_relief.allocated_p)
9623 unload_color (f, f->output_data.x->white_relief.pixel);
9624 if (f->output_data.x->black_relief.allocated_p)
9625 unload_color (f, f->output_data.x->black_relief.pixel);
9627 x_free_gcs (f);
9628 XFlush (FRAME_X_DISPLAY (f));
9631 xfree (f->output_data.x->saved_menu_event);
9632 xfree (f->output_data.x);
9633 f->output_data.x = NULL;
9635 if (f == dpyinfo->x_focus_frame)
9636 dpyinfo->x_focus_frame = 0;
9637 if (f == dpyinfo->x_focus_event_frame)
9638 dpyinfo->x_focus_event_frame = 0;
9639 if (f == dpyinfo->x_highlight_frame)
9640 dpyinfo->x_highlight_frame = 0;
9642 if (f == dpyinfo->mouse_face_mouse_frame)
9644 dpyinfo->mouse_face_beg_row
9645 = dpyinfo->mouse_face_beg_col = -1;
9646 dpyinfo->mouse_face_end_row
9647 = dpyinfo->mouse_face_end_col = -1;
9648 dpyinfo->mouse_face_window = Qnil;
9649 dpyinfo->mouse_face_deferred_gc = 0;
9650 dpyinfo->mouse_face_mouse_frame = 0;
9653 UNBLOCK_INPUT;
9657 /* Destroy the X window of frame F. */
9659 void
9660 x_destroy_window (f)
9661 struct frame *f;
9663 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9665 /* If a display connection is dead, don't try sending more
9666 commands to the X server. */
9667 if (dpyinfo->display != 0)
9668 x_free_frame_resources (f);
9670 dpyinfo->reference_count--;
9674 /* Setting window manager hints. */
9676 /* Set the normal size hints for the window manager, for frame F.
9677 FLAGS is the flags word to use--or 0 meaning preserve the flags
9678 that the window now has.
9679 If USER_POSITION is nonzero, we set the USPosition
9680 flag (this is useful when FLAGS is 0).
9681 The GTK version is in gtkutils.c */
9683 #ifndef USE_GTK
9684 void
9685 x_wm_set_size_hint (f, flags, user_position)
9686 struct frame *f;
9687 long flags;
9688 int user_position;
9690 XSizeHints size_hints;
9691 Window window = FRAME_OUTER_WINDOW (f);
9693 /* Setting PMaxSize caused various problems. */
9694 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9696 size_hints.x = f->left_pos;
9697 size_hints.y = f->top_pos;
9699 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9700 size_hints.width = FRAME_PIXEL_WIDTH (f);
9702 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9703 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9704 size_hints.max_width = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
9705 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9706 size_hints.max_height = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
9707 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9709 /* Calculate the base and minimum sizes. */
9711 int base_width, base_height;
9712 int min_rows = 0, min_cols = 0;
9714 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9715 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9717 check_frame_size (f, &min_rows, &min_cols);
9719 /* The window manager uses the base width hints to calculate the
9720 current number of rows and columns in the frame while
9721 resizing; min_width and min_height aren't useful for this
9722 purpose, since they might not give the dimensions for a
9723 zero-row, zero-column frame.
9725 We use the base_width and base_height members if we have
9726 them; otherwise, we set the min_width and min_height members
9727 to the size for a zero x zero frame. */
9729 size_hints.flags |= PBaseSize;
9730 size_hints.base_width = base_width;
9731 size_hints.base_height = base_height + FRAME_MENUBAR_HEIGHT (f);
9732 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9733 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9736 /* If we don't need the old flags, we don't need the old hint at all. */
9737 if (flags)
9739 size_hints.flags |= flags;
9740 goto no_read;
9744 XSizeHints hints; /* Sometimes I hate X Windows... */
9745 long supplied_return;
9746 int value;
9748 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9749 &supplied_return);
9751 if (flags)
9752 size_hints.flags |= flags;
9753 else
9755 if (value == 0)
9756 hints.flags = 0;
9757 if (hints.flags & PSize)
9758 size_hints.flags |= PSize;
9759 if (hints.flags & PPosition)
9760 size_hints.flags |= PPosition;
9761 if (hints.flags & USPosition)
9762 size_hints.flags |= USPosition;
9763 if (hints.flags & USSize)
9764 size_hints.flags |= USSize;
9768 no_read:
9770 #ifdef PWinGravity
9771 size_hints.win_gravity = f->win_gravity;
9772 size_hints.flags |= PWinGravity;
9774 if (user_position)
9776 size_hints.flags &= ~ PPosition;
9777 size_hints.flags |= USPosition;
9779 #endif /* PWinGravity */
9781 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9783 #endif /* not USE_GTK */
9785 /* Used for IconicState or NormalState */
9787 void
9788 x_wm_set_window_state (f, state)
9789 struct frame *f;
9790 int state;
9792 #ifdef USE_X_TOOLKIT
9793 Arg al[1];
9795 XtSetArg (al[0], XtNinitialState, state);
9796 XtSetValues (f->output_data.x->widget, al, 1);
9797 #else /* not USE_X_TOOLKIT */
9798 Window window = FRAME_X_WINDOW (f);
9800 f->output_data.x->wm_hints.flags |= StateHint;
9801 f->output_data.x->wm_hints.initial_state = state;
9803 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9804 #endif /* not USE_X_TOOLKIT */
9807 void
9808 x_wm_set_icon_pixmap (f, pixmap_id)
9809 struct frame *f;
9810 int pixmap_id;
9812 Pixmap icon_pixmap, icon_mask;
9814 #ifndef USE_X_TOOLKIT
9815 Window window = FRAME_OUTER_WINDOW (f);
9816 #endif
9818 if (pixmap_id > 0)
9820 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9821 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9822 icon_mask = x_bitmap_mask (f, pixmap_id);
9823 f->output_data.x->wm_hints.icon_mask = icon_mask;
9825 else
9827 /* It seems there is no way to turn off use of an icon
9828 pixmap. */
9829 return;
9833 #ifdef USE_GTK
9835 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9836 return;
9839 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9842 Arg al[1];
9843 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9844 XtSetValues (f->output_data.x->widget, al, 1);
9845 XtSetArg (al[0], XtNiconMask, icon_mask);
9846 XtSetValues (f->output_data.x->widget, al, 1);
9849 #else /* not USE_X_TOOLKIT && not USE_GTK */
9851 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9852 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9854 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9857 void
9858 x_wm_set_icon_position (f, icon_x, icon_y)
9859 struct frame *f;
9860 int icon_x, icon_y;
9862 Window window = FRAME_OUTER_WINDOW (f);
9864 f->output_data.x->wm_hints.flags |= IconPositionHint;
9865 f->output_data.x->wm_hints.icon_x = icon_x;
9866 f->output_data.x->wm_hints.icon_y = icon_y;
9868 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9872 /***********************************************************************
9873 Fonts
9874 ***********************************************************************/
9876 #if GLYPH_DEBUG
9878 /* Check that FONT is valid on frame F. It is if it can be found in F's
9879 font table. */
9881 static void
9882 x_check_font (f, font)
9883 struct frame *f;
9884 struct font *font;
9886 Lisp_Object frame;
9888 xassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9889 if (font->driver->check)
9890 xassert (font->driver->check (f, font) == 0);
9893 #endif /* GLYPH_DEBUG != 0 */
9896 /***********************************************************************
9897 Initialization
9898 ***********************************************************************/
9900 #ifdef USE_X_TOOLKIT
9901 static XrmOptionDescRec emacs_options[] = {
9902 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9903 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9905 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9906 XrmoptionSepArg, NULL},
9907 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9909 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9910 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9911 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9912 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9913 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9914 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9915 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9918 /* Whether atimer for Xt timeouts is activated or not. */
9920 static int x_timeout_atimer_activated_flag;
9922 #endif /* USE_X_TOOLKIT */
9924 static int x_initialized;
9926 #ifdef HAVE_X_SM
9927 static int x_session_initialized;
9928 #endif
9930 /* Test whether two display-name strings agree up to the dot that separates
9931 the screen number from the server number. */
9932 static int
9933 same_x_server (name1, name2)
9934 const char *name1, *name2;
9936 int seen_colon = 0;
9937 const unsigned char *system_name = SDATA (Vsystem_name);
9938 int system_name_length = strlen (system_name);
9939 int length_until_period = 0;
9941 while (system_name[length_until_period] != 0
9942 && system_name[length_until_period] != '.')
9943 length_until_period++;
9945 /* Treat `unix' like an empty host name. */
9946 if (! strncmp (name1, "unix:", 5))
9947 name1 += 4;
9948 if (! strncmp (name2, "unix:", 5))
9949 name2 += 4;
9950 /* Treat this host's name like an empty host name. */
9951 if (! strncmp (name1, system_name, system_name_length)
9952 && name1[system_name_length] == ':')
9953 name1 += system_name_length;
9954 if (! strncmp (name2, system_name, system_name_length)
9955 && name2[system_name_length] == ':')
9956 name2 += system_name_length;
9957 /* Treat this host's domainless name like an empty host name. */
9958 if (! strncmp (name1, system_name, length_until_period)
9959 && name1[length_until_period] == ':')
9960 name1 += length_until_period;
9961 if (! strncmp (name2, system_name, length_until_period)
9962 && name2[length_until_period] == ':')
9963 name2 += length_until_period;
9965 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9967 if (*name1 == ':')
9968 seen_colon++;
9969 if (seen_colon && *name1 == '.')
9970 return 1;
9972 return (seen_colon
9973 && (*name1 == '.' || *name1 == '\0')
9974 && (*name2 == '.' || *name2 == '\0'));
9977 /* Count number of set bits in mask and number of bits to shift to
9978 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9979 to 5. */
9980 static void
9981 get_bits_and_offset (mask, bits, offset)
9982 unsigned long mask;
9983 int *bits;
9984 int *offset;
9986 int nr = 0;
9987 int off = 0;
9989 while (!(mask & 1))
9991 off++;
9992 mask >>= 1;
9995 while (mask & 1)
9997 nr++;
9998 mask >>= 1;
10001 *offset = off;
10002 *bits = nr;
10005 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
10006 But don't permanently open it, just test its availability. */
10009 x_display_ok (display)
10010 const char *display;
10012 int dpy_ok = 1;
10013 Display *dpy;
10015 dpy = XOpenDisplay (display);
10016 if (dpy)
10017 XCloseDisplay (dpy);
10018 else
10019 dpy_ok = 0;
10020 return dpy_ok;
10023 #ifdef USE_GTK
10024 static void
10025 my_log_handler (log_domain, log_level, message, user_data)
10026 const gchar *log_domain;
10027 GLogLevelFlags log_level;
10028 const gchar *message;
10029 gpointer user_data;
10031 if (!strstr (message, "g_set_prgname"))
10032 fprintf (stderr, "%s-WARNING **: %s\n", log_domain, message);
10034 #endif
10036 /* Open a connection to X display DISPLAY_NAME, and return
10037 the structure that describes the open display.
10038 If we cannot contact the display, return null. */
10040 struct x_display_info *
10041 x_term_init (display_name, xrm_option, resource_name)
10042 Lisp_Object display_name;
10043 char *xrm_option;
10044 char *resource_name;
10046 int connection;
10047 Display *dpy;
10048 struct terminal *terminal;
10049 struct x_display_info *dpyinfo;
10050 XrmDatabase xrdb;
10052 BLOCK_INPUT;
10054 if (!x_initialized)
10056 x_initialize ();
10057 ++x_initialized;
10060 if (! x_display_ok (SDATA (display_name)))
10061 error ("Display %s can't be opened", SDATA (display_name));
10063 #ifdef USE_GTK
10065 #define NUM_ARGV 10
10066 int argc;
10067 char *argv[NUM_ARGV];
10068 char **argv2 = argv;
10069 GdkAtom atom;
10070 guint id;
10071 #ifndef HAVE_GTK_MULTIDISPLAY
10072 if (!EQ (Vinitial_window_system, Qx))
10073 error ("Sorry, you cannot connect to X servers with the GTK toolkit");
10074 #endif
10076 if (x_initialized++ > 1)
10078 #ifdef HAVE_GTK_MULTIDISPLAY
10079 /* Opening another display. If xg_display_open returns less
10080 than zero, we are probably on GTK 2.0, which can only handle
10081 one display. GTK 2.2 or later can handle more than one. */
10082 if (xg_display_open (SDATA (display_name), &dpy) < 0)
10083 #endif
10084 error ("Sorry, this version of GTK can only handle one display");
10086 else
10088 for (argc = 0; argc < NUM_ARGV; ++argc)
10089 argv[argc] = 0;
10091 argc = 0;
10092 argv[argc++] = initial_argv[0];
10094 if (! NILP (display_name))
10096 argv[argc++] = "--display";
10097 argv[argc++] = SDATA (display_name);
10100 argv[argc++] = "--name";
10101 argv[argc++] = resource_name;
10103 XSetLocaleModifiers ("");
10105 /* Work around GLib bug that outputs a faulty warning. See
10106 https://bugzilla.gnome.org/show_bug.cgi?id=563627. */
10107 id = g_log_set_handler ("GLib", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
10108 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
10109 gtk_init (&argc, &argv2);
10110 g_log_remove_handler ("GLib", id);
10112 /* gtk_init does set_locale. We must fix locale after calling it. */
10113 fixup_locale ();
10114 xg_initialize ();
10116 dpy = GDK_DISPLAY ();
10118 /* NULL window -> events for all windows go to our function */
10119 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
10121 /* Load our own gtkrc if it exists. */
10123 char *file = "~/.emacs.d/gtkrc";
10124 Lisp_Object s, abs_file;
10126 s = make_string (file, strlen (file));
10127 abs_file = Fexpand_file_name (s, Qnil);
10129 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
10130 gtk_rc_parse (SDATA (abs_file));
10133 XSetErrorHandler (x_error_handler);
10134 XSetIOErrorHandler (x_io_error_quitter);
10137 #else /* not USE_GTK */
10138 #ifdef USE_X_TOOLKIT
10139 /* weiner@footloose.sps.mot.com reports that this causes
10140 errors with X11R5:
10141 X protocol error: BadAtom (invalid Atom parameter)
10142 on protocol request 18skiloaf.
10143 So let's not use it until R6. */
10144 #ifdef HAVE_X11XTR6
10145 XtSetLanguageProc (NULL, NULL, NULL);
10146 #endif
10149 int argc = 0;
10150 char *argv[3];
10152 argv[0] = "";
10153 argc = 1;
10154 if (xrm_option)
10156 argv[argc++] = "-xrm";
10157 argv[argc++] = xrm_option;
10159 turn_on_atimers (0);
10160 dpy = XtOpenDisplay (Xt_app_con, SDATA (display_name),
10161 resource_name, EMACS_CLASS,
10162 emacs_options, XtNumber (emacs_options),
10163 &argc, argv);
10164 turn_on_atimers (1);
10166 #ifdef HAVE_X11XTR6
10167 /* I think this is to compensate for XtSetLanguageProc. */
10168 fixup_locale ();
10169 #endif
10172 #else /* not USE_X_TOOLKIT */
10173 XSetLocaleModifiers ("");
10174 dpy = XOpenDisplay (SDATA (display_name));
10175 #endif /* not USE_X_TOOLKIT */
10176 #endif /* not USE_GTK*/
10178 /* Detect failure. */
10179 if (dpy == 0)
10181 UNBLOCK_INPUT;
10182 return 0;
10185 /* We have definitely succeeded. Record the new connection. */
10187 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
10188 bzero (dpyinfo, sizeof *dpyinfo);
10190 terminal = x_create_terminal (dpyinfo);
10193 struct x_display_info *share;
10194 Lisp_Object tail;
10196 for (share = x_display_list, tail = x_display_name_list; share;
10197 share = share->next, tail = XCDR (tail))
10198 if (same_x_server (SDATA (XCAR (XCAR (tail))),
10199 SDATA (display_name)))
10200 break;
10201 if (share)
10202 terminal->kboard = share->terminal->kboard;
10203 else
10205 terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
10206 init_kboard (terminal->kboard);
10207 terminal->kboard->Vwindow_system = Qx;
10208 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10210 char *vendor = ServerVendor (dpy);
10211 /* Temporarily hide the partially initialized terminal */
10212 terminal_list = terminal->next_terminal;
10213 UNBLOCK_INPUT;
10214 terminal->kboard->Vsystem_key_alist
10215 = call1 (Qvendor_specific_keysyms,
10216 vendor ? build_string (vendor) : empty_unibyte_string);
10217 BLOCK_INPUT;
10218 terminal->next_terminal = terminal_list;
10219 terminal_list = terminal;
10222 terminal->kboard->next_kboard = all_kboards;
10223 all_kboards = terminal->kboard;
10224 /* Don't let the initial kboard remain current longer than necessary.
10225 That would cause problems if a file loaded on startup tries to
10226 prompt in the mini-buffer. */
10227 if (current_kboard == initial_kboard)
10228 current_kboard = terminal->kboard;
10230 terminal->kboard->reference_count++;
10233 /* Put this display on the chain. */
10234 dpyinfo->next = x_display_list;
10235 x_display_list = dpyinfo;
10237 /* Put it on x_display_name_list as well, to keep them parallel. */
10238 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10239 x_display_name_list);
10240 dpyinfo->name_list_element = XCAR (x_display_name_list);
10242 dpyinfo->display = dpy;
10244 /* Set the name of the terminal. */
10245 terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
10246 strncpy (terminal->name, SDATA (display_name), SBYTES (display_name));
10247 terminal->name[SBYTES (display_name)] = 0;
10249 #if 0
10250 XSetAfterFunction (x_current_display, x_trace_wire);
10251 #endif /* ! 0 */
10253 dpyinfo->x_id_name
10254 = (char *) xmalloc (SBYTES (Vinvocation_name)
10255 + SBYTES (Vsystem_name)
10256 + 2);
10257 sprintf (dpyinfo->x_id_name, "%s@%s",
10258 SDATA (Vinvocation_name), SDATA (Vsystem_name));
10260 /* Figure out which modifier bits mean what. */
10261 x_find_modifier_meanings (dpyinfo);
10263 /* Get the scroll bar cursor. */
10264 #ifdef USE_GTK
10265 /* We must create a GTK cursor, it is required for GTK widgets. */
10266 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10267 #endif /* USE_GTK */
10269 dpyinfo->vertical_scroll_bar_cursor
10270 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10272 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10273 resource_name, EMACS_CLASS);
10274 #ifdef HAVE_XRMSETDATABASE
10275 XrmSetDatabase (dpyinfo->display, xrdb);
10276 #else
10277 dpyinfo->display->db = xrdb;
10278 #endif
10279 /* Put the rdb where we can find it in a way that works on
10280 all versions. */
10281 dpyinfo->xrdb = xrdb;
10283 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10284 DefaultScreen (dpyinfo->display));
10285 select_visual (dpyinfo);
10286 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10287 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10288 dpyinfo->client_leader_window = 0;
10289 dpyinfo->grabbed = 0;
10290 dpyinfo->reference_count = 0;
10291 dpyinfo->icon_bitmap_id = -1;
10292 dpyinfo->n_fonts = 0;
10293 dpyinfo->bitmaps = 0;
10294 dpyinfo->bitmaps_size = 0;
10295 dpyinfo->bitmaps_last = 0;
10296 dpyinfo->scratch_cursor_gc = 0;
10297 dpyinfo->mouse_face_mouse_frame = 0;
10298 dpyinfo->mouse_face_deferred_gc = 0;
10299 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
10300 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
10301 dpyinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10302 dpyinfo->mouse_face_window = Qnil;
10303 dpyinfo->mouse_face_overlay = Qnil;
10304 dpyinfo->mouse_face_mouse_x = dpyinfo->mouse_face_mouse_y = 0;
10305 dpyinfo->mouse_face_defer = 0;
10306 dpyinfo->mouse_face_hidden = 0;
10307 dpyinfo->x_focus_frame = 0;
10308 dpyinfo->x_focus_event_frame = 0;
10309 dpyinfo->x_highlight_frame = 0;
10310 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10312 /* See if we can construct pixel values from RGB values. */
10313 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10314 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10316 if (dpyinfo->visual->class == TrueColor)
10318 get_bits_and_offset (dpyinfo->visual->red_mask,
10319 &dpyinfo->red_bits, &dpyinfo->red_offset);
10320 get_bits_and_offset (dpyinfo->visual->blue_mask,
10321 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10322 get_bits_and_offset (dpyinfo->visual->green_mask,
10323 &dpyinfo->green_bits, &dpyinfo->green_offset);
10326 /* See if a private colormap is requested. */
10327 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10329 if (dpyinfo->visual->class == PseudoColor)
10331 Lisp_Object value;
10332 value = display_x_get_resource (dpyinfo,
10333 build_string ("privateColormap"),
10334 build_string ("PrivateColormap"),
10335 Qnil, Qnil);
10336 if (STRINGP (value)
10337 && (!strcmp (SDATA (value), "true")
10338 || !strcmp (SDATA (value), "on")))
10339 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10342 else
10343 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10344 dpyinfo->visual, AllocNone);
10346 #ifdef HAVE_XFT
10348 /* If we are using Xft, check dpi value in X resources.
10349 It is better we use it as well, since Xft will use it, as will all
10350 Gnome applications. If our real DPI is smaller or larger than the
10351 one Xft uses, our font will look smaller or larger than other
10352 for other applications, even if it is the same font name (monospace-10
10353 for example). */
10354 char *v = XGetDefault (dpyinfo->display, "Xft", "dpi");
10355 double d;
10356 if (v != NULL && sscanf (v, "%lf", &d) == 1)
10357 dpyinfo->resy = dpyinfo->resx = d;
10359 #endif
10361 if (dpyinfo->resy < 1)
10363 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10364 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10365 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10366 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10367 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10368 pixels = DisplayWidth (dpyinfo->display, screen_number);
10369 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10370 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10371 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10374 dpyinfo->Xatom_wm_protocols
10375 = XInternAtom (dpyinfo->display, "WM_PROTOCOLS", False);
10376 dpyinfo->Xatom_wm_take_focus
10377 = XInternAtom (dpyinfo->display, "WM_TAKE_FOCUS", False);
10378 dpyinfo->Xatom_wm_save_yourself
10379 = XInternAtom (dpyinfo->display, "WM_SAVE_YOURSELF", False);
10380 dpyinfo->Xatom_wm_delete_window
10381 = XInternAtom (dpyinfo->display, "WM_DELETE_WINDOW", False);
10382 dpyinfo->Xatom_wm_change_state
10383 = XInternAtom (dpyinfo->display, "WM_CHANGE_STATE", False);
10384 dpyinfo->Xatom_wm_configure_denied
10385 = XInternAtom (dpyinfo->display, "WM_CONFIGURE_DENIED", False);
10386 dpyinfo->Xatom_wm_window_moved
10387 = XInternAtom (dpyinfo->display, "WM_MOVED", False);
10388 dpyinfo->Xatom_wm_client_leader
10389 = XInternAtom (dpyinfo->display, "WM_CLIENT_LEADER", False);
10390 dpyinfo->Xatom_editres
10391 = XInternAtom (dpyinfo->display, "Editres", False);
10392 dpyinfo->Xatom_CLIPBOARD
10393 = XInternAtom (dpyinfo->display, "CLIPBOARD", False);
10394 dpyinfo->Xatom_TIMESTAMP
10395 = XInternAtom (dpyinfo->display, "TIMESTAMP", False);
10396 dpyinfo->Xatom_TEXT
10397 = XInternAtom (dpyinfo->display, "TEXT", False);
10398 dpyinfo->Xatom_COMPOUND_TEXT
10399 = XInternAtom (dpyinfo->display, "COMPOUND_TEXT", False);
10400 dpyinfo->Xatom_UTF8_STRING
10401 = XInternAtom (dpyinfo->display, "UTF8_STRING", False);
10402 dpyinfo->Xatom_DELETE
10403 = XInternAtom (dpyinfo->display, "DELETE", False);
10404 dpyinfo->Xatom_MULTIPLE
10405 = XInternAtom (dpyinfo->display, "MULTIPLE", False);
10406 dpyinfo->Xatom_INCR
10407 = XInternAtom (dpyinfo->display, "INCR", False);
10408 dpyinfo->Xatom_EMACS_TMP
10409 = XInternAtom (dpyinfo->display, "_EMACS_TMP_", False);
10410 dpyinfo->Xatom_TARGETS
10411 = XInternAtom (dpyinfo->display, "TARGETS", False);
10412 dpyinfo->Xatom_NULL
10413 = XInternAtom (dpyinfo->display, "NULL", False);
10414 dpyinfo->Xatom_ATOM_PAIR
10415 = XInternAtom (dpyinfo->display, "ATOM_PAIR", False);
10416 /* For properties of font. */
10417 dpyinfo->Xatom_PIXEL_SIZE
10418 = XInternAtom (dpyinfo->display, "PIXEL_SIZE", False);
10419 dpyinfo->Xatom_AVERAGE_WIDTH
10420 = XInternAtom (dpyinfo->display, "AVERAGE_WIDTH", False);
10421 dpyinfo->Xatom_MULE_BASELINE_OFFSET
10422 = XInternAtom (dpyinfo->display, "_MULE_BASELINE_OFFSET", False);
10423 dpyinfo->Xatom_MULE_RELATIVE_COMPOSE
10424 = XInternAtom (dpyinfo->display, "_MULE_RELATIVE_COMPOSE", False);
10425 dpyinfo->Xatom_MULE_DEFAULT_ASCENT
10426 = XInternAtom (dpyinfo->display, "_MULE_DEFAULT_ASCENT", False);
10428 /* Ghostscript support. */
10429 dpyinfo->Xatom_PAGE = XInternAtom (dpyinfo->display, "PAGE", False);
10430 dpyinfo->Xatom_DONE = XInternAtom (dpyinfo->display, "DONE", False);
10432 dpyinfo->Xatom_Scrollbar = XInternAtom (dpyinfo->display, "SCROLLBAR",
10433 False);
10435 dpyinfo->Xatom_XEMBED = XInternAtom (dpyinfo->display, "_XEMBED",
10436 False);
10438 dpyinfo->Xatom_net_wm_state
10439 = XInternAtom (dpyinfo->display, "_NET_WM_STATE", False);
10440 dpyinfo->Xatom_net_wm_state_fullscreen_atom
10441 = XInternAtom (dpyinfo->display, "_NET_WM_STATE_FULLSCREEN", False);
10442 dpyinfo->Xatom_net_wm_state_maximized_horz
10443 = XInternAtom (dpyinfo->display, "_NET_WM_STATE_MAXIMIZED_HORZ", False);
10444 dpyinfo->Xatom_net_wm_state_maximized_vert
10445 = XInternAtom (dpyinfo->display, "_NET_WM_STATE_MAXIMIZED_VERT", False);
10446 dpyinfo->Xatom_net_wm_state_sticky
10447 = XInternAtom (dpyinfo->display, "_NET_WM_STATE_STICKY", False);
10448 dpyinfo->Xatom_net_window_type
10449 = XInternAtom (dpyinfo->display, "_NET_WM_WINDOW_TYPE", False);
10450 dpyinfo->Xatom_net_window_type_tooltip
10451 = XInternAtom (dpyinfo->display, "_NET_WM_WINDOW_TYPE_TOOLTIP", False);
10453 dpyinfo->cut_buffers_initialized = 0;
10455 dpyinfo->x_dnd_atoms_size = 8;
10456 dpyinfo->x_dnd_atoms_length = 0;
10457 dpyinfo->x_dnd_atoms = xmalloc (sizeof (*dpyinfo->x_dnd_atoms)
10458 * dpyinfo->x_dnd_atoms_size);
10460 dpyinfo->net_supported_atoms = NULL;
10461 dpyinfo->nr_net_supported_atoms = 0;
10462 dpyinfo->net_supported_window = 0;
10464 connection = ConnectionNumber (dpyinfo->display);
10465 dpyinfo->connection = connection;
10468 extern int gray_bitmap_width, gray_bitmap_height;
10469 extern char *gray_bitmap_bits;
10470 dpyinfo->gray
10471 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10472 gray_bitmap_bits,
10473 gray_bitmap_width, gray_bitmap_height,
10474 (unsigned long) 1, (unsigned long) 0, 1);
10477 #ifdef HAVE_X_I18N
10478 xim_initialize (dpyinfo, resource_name);
10479 #endif
10481 xsettings_initialize (dpyinfo);
10483 #ifdef subprocesses
10484 /* This is only needed for distinguishing keyboard and process input. */
10485 if (connection != 0)
10486 add_keyboard_wait_descriptor (connection);
10487 #endif
10489 #ifdef F_SETOWN
10490 fcntl (connection, F_SETOWN, getpid ());
10491 #endif /* ! defined (F_SETOWN) */
10493 #ifdef SIGIO
10494 if (interrupt_input)
10495 init_sigio (connection);
10496 #endif /* ! defined (SIGIO) */
10498 #ifdef USE_LUCID
10500 Display *dpy = dpyinfo->display;
10501 XrmValue d, fr, to;
10502 Font font;
10504 d.addr = (XPointer)&dpy;
10505 d.size = sizeof (Display *);
10506 fr.addr = XtDefaultFont;
10507 fr.size = sizeof (XtDefaultFont);
10508 to.size = sizeof (Font *);
10509 to.addr = (XPointer)&font;
10510 x_catch_errors (dpy);
10511 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10512 abort ();
10513 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10514 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10515 x_uncatch_errors ();
10517 #endif
10519 /* See if we should run in synchronous mode. This is useful
10520 for debugging X code. */
10522 Lisp_Object value;
10523 value = display_x_get_resource (dpyinfo,
10524 build_string ("synchronous"),
10525 build_string ("Synchronous"),
10526 Qnil, Qnil);
10527 if (STRINGP (value)
10528 && (!strcmp (SDATA (value), "true")
10529 || !strcmp (SDATA (value), "on")))
10530 XSynchronize (dpyinfo->display, True);
10534 Lisp_Object value;
10535 value = display_x_get_resource (dpyinfo,
10536 build_string ("useXIM"),
10537 build_string ("UseXIM"),
10538 Qnil, Qnil);
10539 #ifdef USE_XIM
10540 if (STRINGP (value)
10541 && (!strcmp (SDATA (value), "false")
10542 || !strcmp (SDATA (value), "off")))
10543 use_xim = 0;
10544 #else
10545 if (STRINGP (value)
10546 && (!strcmp (SDATA (value), "true")
10547 || !strcmp (SDATA (value), "on")))
10548 use_xim = 1;
10549 #endif
10552 #ifdef HAVE_X_SM
10553 /* Only do this for the very first display in the Emacs session.
10554 Ignore X session management when Emacs was first started on a
10555 tty. */
10556 if (terminal->id == 1)
10557 x_session_initialize (dpyinfo);
10558 #endif
10560 UNBLOCK_INPUT;
10562 return dpyinfo;
10565 /* Get rid of display DPYINFO, deleting all frames on it,
10566 and without sending any more commands to the X server. */
10568 void
10569 x_delete_display (dpyinfo)
10570 struct x_display_info *dpyinfo;
10572 int i;
10573 struct terminal *t;
10575 /* Close all frames and delete the generic struct terminal for this
10576 X display. */
10577 for (t = terminal_list; t; t = t->next_terminal)
10578 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10580 #ifdef HAVE_X_SM
10581 /* Close X session management when we close its display. */
10582 if (t->id == 1 && x_session_have_connection ())
10583 x_session_close();
10584 #endif
10585 delete_terminal (t);
10586 break;
10589 delete_keyboard_wait_descriptor (dpyinfo->connection);
10591 /* Discard this display from x_display_name_list and x_display_list.
10592 We can't use Fdelq because that can quit. */
10593 if (! NILP (x_display_name_list)
10594 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10595 x_display_name_list = XCDR (x_display_name_list);
10596 else
10598 Lisp_Object tail;
10600 tail = x_display_name_list;
10601 while (CONSP (tail) && CONSP (XCDR (tail)))
10603 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10605 XSETCDR (tail, XCDR (XCDR (tail)));
10606 break;
10608 tail = XCDR (tail);
10612 if (next_noop_dpyinfo == dpyinfo)
10613 next_noop_dpyinfo = dpyinfo->next;
10615 if (x_display_list == dpyinfo)
10616 x_display_list = dpyinfo->next;
10617 else
10619 struct x_display_info *tail;
10621 for (tail = x_display_list; tail; tail = tail->next)
10622 if (tail->next == dpyinfo)
10623 tail->next = tail->next->next;
10626 xfree (dpyinfo->x_id_name);
10627 xfree (dpyinfo->x_dnd_atoms);
10628 xfree (dpyinfo->color_cells);
10629 xfree (dpyinfo);
10632 #ifdef USE_X_TOOLKIT
10634 /* Atimer callback function for TIMER. Called every 0.1s to process
10635 Xt timeouts, if needed. We must avoid calling XtAppPending as
10636 much as possible because that function does an implicit XFlush
10637 that slows us down. */
10639 static void
10640 x_process_timeouts (timer)
10641 struct atimer *timer;
10643 BLOCK_INPUT;
10644 x_timeout_atimer_activated_flag = 0;
10645 if (toolkit_scroll_bar_interaction || popup_activated ())
10647 while (XtAppPending (Xt_app_con) & XtIMTimer)
10648 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10649 /* Reactivate the atimer for next time. */
10650 x_activate_timeout_atimer ();
10652 UNBLOCK_INPUT;
10655 /* Install an asynchronous timer that processes Xt timeout events
10656 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10657 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10658 function whenever these variables are set. This is necessary
10659 because some widget sets use timeouts internally, for example the
10660 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10661 processed, these widgets don't behave normally. */
10663 void
10664 x_activate_timeout_atimer ()
10666 BLOCK_INPUT;
10667 if (!x_timeout_atimer_activated_flag)
10669 EMACS_TIME interval;
10671 EMACS_SET_SECS_USECS (interval, 0, 100000);
10672 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10673 x_timeout_atimer_activated_flag = 1;
10675 UNBLOCK_INPUT;
10678 #endif /* USE_X_TOOLKIT */
10681 /* Set up use of X before we make the first connection. */
10683 extern frame_parm_handler x_frame_parm_handlers[];
10685 static struct redisplay_interface x_redisplay_interface =
10687 x_frame_parm_handlers,
10688 x_produce_glyphs,
10689 x_write_glyphs,
10690 x_insert_glyphs,
10691 x_clear_end_of_line,
10692 x_scroll_run,
10693 x_after_update_window_line,
10694 x_update_window_begin,
10695 x_update_window_end,
10696 x_cursor_to,
10697 x_flush,
10698 #ifdef XFlush
10699 x_flush,
10700 #else
10701 0, /* flush_display_optional */
10702 #endif
10703 x_clear_window_mouse_face,
10704 x_get_glyph_overhangs,
10705 x_fix_overlapping_area,
10706 x_draw_fringe_bitmap,
10707 0, /* define_fringe_bitmap */
10708 0, /* destroy_fringe_bitmap */
10709 x_compute_glyph_string_overhangs,
10710 x_draw_glyph_string,
10711 x_define_frame_cursor,
10712 x_clear_frame_area,
10713 x_draw_window_cursor,
10714 x_draw_vertical_window_border,
10715 x_shift_glyphs_for_insert
10719 /* This function is called when the last frame on a display is deleted. */
10720 void
10721 x_delete_terminal (struct terminal *terminal)
10723 struct x_display_info *dpyinfo = terminal->display_info.x;
10724 int i;
10726 /* Protect against recursive calls. delete_frame in
10727 delete_terminal calls us back when it deletes our last frame. */
10728 if (!terminal->name)
10729 return;
10731 BLOCK_INPUT;
10732 #ifdef HAVE_X_I18N
10733 /* We must close our connection to the XIM server before closing the
10734 X display. */
10735 if (dpyinfo->xim)
10736 xim_close_dpy (dpyinfo);
10737 #endif
10739 /* If called from x_connection_closed, the display may already be closed
10740 and dpyinfo->display was set to 0 to indicate that. */
10741 if (dpyinfo->display)
10743 x_destroy_all_bitmaps (dpyinfo);
10744 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10746 /* Whether or not XCloseDisplay destroys the associated resource
10747 database depends on the version of libX11. To avoid both
10748 crash and memory leak, we dissociate the database from the
10749 display and then destroy dpyinfo->xrdb ourselves.
10751 Unfortunately, the above strategy does not work in some
10752 situations due to a bug in newer versions of libX11: because
10753 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
10754 dpy->db is NULL, XCloseDisplay destroys the associated
10755 database whereas it has not been created by XGetDefault
10756 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
10757 don't destroy the database here in order to avoid the crash
10758 in the above situations for now, though that may cause memory
10759 leaks in other situations. */
10760 #if 0
10761 #ifdef HAVE_XRMSETDATABASE
10762 XrmSetDatabase (dpyinfo->display, NULL);
10763 #else
10764 dpyinfo->display->db = NULL;
10765 #endif
10766 /* We used to call XrmDestroyDatabase from x_delete_display, but
10767 some older versions of libX11 crash if we call it after
10768 closing all the displays. */
10769 XrmDestroyDatabase (dpyinfo->xrdb);
10770 #endif
10772 #ifdef USE_GTK
10773 xg_display_close (dpyinfo->display);
10774 #else
10775 #ifdef USE_X_TOOLKIT
10776 XtCloseDisplay (dpyinfo->display);
10777 #else
10778 XCloseDisplay (dpyinfo->display);
10779 #endif
10780 #endif /* ! USE_GTK */
10783 /* Mark as dead. */
10784 dpyinfo->display = NULL;
10785 x_delete_display (dpyinfo);
10786 UNBLOCK_INPUT;
10789 /* Create a struct terminal, initialize it with the X11 specific
10790 functions and make DISPLAY->TERMINAL point to it. */
10792 static struct terminal *
10793 x_create_terminal (struct x_display_info *dpyinfo)
10795 struct terminal *terminal;
10797 terminal = create_terminal ();
10799 terminal->type = output_x_window;
10800 terminal->display_info.x = dpyinfo;
10801 dpyinfo->terminal = terminal;
10803 /* kboard is initialized in x_term_init. */
10805 terminal->clear_frame_hook = x_clear_frame;
10806 terminal->ins_del_lines_hook = x_ins_del_lines;
10807 terminal->delete_glyphs_hook = x_delete_glyphs;
10808 terminal->ring_bell_hook = XTring_bell;
10809 terminal->toggle_invisible_pointer_hook = XTtoggle_invisible_pointer;
10810 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10811 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10812 terminal->update_begin_hook = x_update_begin;
10813 terminal->update_end_hook = x_update_end;
10814 terminal->set_terminal_window_hook = XTset_terminal_window;
10815 terminal->read_socket_hook = XTread_socket;
10816 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10817 terminal->mouse_position_hook = XTmouse_position;
10818 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10819 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10820 terminal->fullscreen_hook = XTfullscreen_hook;
10821 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10822 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10823 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10824 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10826 terminal->delete_frame_hook = x_destroy_window;
10827 terminal->delete_terminal_hook = x_delete_terminal;
10829 terminal->rif = &x_redisplay_interface;
10830 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10831 terminal->char_ins_del_ok = 1;
10832 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10833 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10834 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10835 off the bottom. */
10837 return terminal;
10840 void
10841 x_initialize ()
10843 baud_rate = 19200;
10845 x_noop_count = 0;
10846 last_tool_bar_item = -1;
10847 any_help_event_p = 0;
10848 ignore_next_mouse_click_timeout = 0;
10849 #ifdef HAVE_X_SM
10850 x_session_initialized = 0;
10851 #endif
10853 #ifdef USE_GTK
10854 current_count = -1;
10855 #endif
10857 /* Try to use interrupt input; if we can't, then start polling. */
10858 Fset_input_interrupt_mode (Qt);
10860 #ifdef USE_X_TOOLKIT
10861 XtToolkitInitialize ();
10863 Xt_app_con = XtCreateApplicationContext ();
10865 /* Register a converter from strings to pixels, which uses
10866 Emacs' color allocation infrastructure. */
10867 XtAppSetTypeConverter (Xt_app_con,
10868 XtRString, XtRPixel, cvt_string_to_pixel,
10869 cvt_string_to_pixel_args,
10870 XtNumber (cvt_string_to_pixel_args),
10871 XtCacheByDisplay, cvt_pixel_dtor);
10873 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10874 #endif
10876 #ifdef USE_TOOLKIT_SCROLL_BARS
10877 #ifndef USE_GTK
10878 xaw3d_arrow_scroll = False;
10879 xaw3d_pick_top = True;
10880 #endif
10881 #endif
10883 pending_autoraise_frame = 0;
10884 pending_event_wait.f = 0;
10885 pending_event_wait.eventtype = 0;
10887 /* Note that there is no real way portable across R3/R4 to get the
10888 original error handler. */
10889 XSetErrorHandler (x_error_handler);
10890 XSetIOErrorHandler (x_io_error_quitter);
10892 signal (SIGPIPE, x_connection_signal);
10894 xgselect_initialize ();
10898 void
10899 syms_of_xterm ()
10901 x_error_message = NULL;
10903 staticpro (&x_display_name_list);
10904 x_display_name_list = Qnil;
10906 staticpro (&last_mouse_scroll_bar);
10907 last_mouse_scroll_bar = Qnil;
10909 staticpro (&Qvendor_specific_keysyms);
10910 Qvendor_specific_keysyms = intern_c_string ("vendor-specific-keysyms");
10912 staticpro (&Qlatin_1);
10913 Qlatin_1 = intern_c_string ("latin-1");
10915 staticpro (&last_mouse_press_frame);
10916 last_mouse_press_frame = Qnil;
10918 #ifdef USE_GTK
10919 xg_default_icon_file = make_pure_c_string ("icons/hicolor/scalable/apps/emacs.svg");
10920 staticpro (&xg_default_icon_file);
10922 Qx_gtk_map_stock = intern_c_string ("x-gtk-map-stock");
10923 staticpro (&Qx_gtk_map_stock);
10924 #endif
10926 DEFVAR_BOOL ("x-use-underline-position-properties",
10927 &x_use_underline_position_properties,
10928 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
10929 A value of nil means ignore them. If you encounter fonts with bogus
10930 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10931 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10932 to override the font's UNDERLINE_POSITION for small font display
10933 sizes. */);
10934 x_use_underline_position_properties = 1;
10936 DEFVAR_BOOL ("x-underline-at-descent-line",
10937 &x_underline_at_descent_line,
10938 doc: /* *Non-nil means to draw the underline at the same place as the descent line.
10939 A value of nil means to draw the underline according to the value of the
10940 variable `x-use-underline-position-properties', which is usually at the
10941 baseline level. The default value is nil. */);
10942 x_underline_at_descent_line = 0;
10944 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10945 &x_mouse_click_focus_ignore_position,
10946 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10947 This variable is only used when the window manager requires that you
10948 click on a frame to select it (give it focus). In that case, a value
10949 of nil, means that the selected window and cursor position changes to
10950 reflect the mouse click position, while a non-nil value means that the
10951 selected window or cursor position is preserved. */);
10952 x_mouse_click_focus_ignore_position = 0;
10954 DEFVAR_LISP ("x-toolkit-scroll-bars", &Vx_toolkit_scroll_bars,
10955 doc: /* What X toolkit scroll bars Emacs uses.
10956 A value of nil means Emacs doesn't use X toolkit scroll bars.
10957 Otherwise, value is a symbol describing the X toolkit. */);
10958 #ifdef USE_TOOLKIT_SCROLL_BARS
10959 #ifdef USE_MOTIF
10960 Vx_toolkit_scroll_bars = intern_c_string ("motif");
10961 #elif defined HAVE_XAW3D
10962 Vx_toolkit_scroll_bars = intern_c_string ("xaw3d");
10963 #elif USE_GTK
10964 Vx_toolkit_scroll_bars = intern_c_string ("gtk");
10965 #else
10966 Vx_toolkit_scroll_bars = intern_c_string ("xaw");
10967 #endif
10968 #else
10969 Vx_toolkit_scroll_bars = Qnil;
10970 #endif
10972 staticpro (&last_mouse_motion_frame);
10973 last_mouse_motion_frame = Qnil;
10975 Qmodifier_value = intern_c_string ("modifier-value");
10976 Qalt = intern_c_string ("alt");
10977 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10978 Qhyper = intern_c_string ("hyper");
10979 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10980 Qmeta = intern_c_string ("meta");
10981 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10982 Qsuper = intern_c_string ("super");
10983 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10985 DEFVAR_LISP ("x-alt-keysym", &Vx_alt_keysym,
10986 doc: /* Which keys Emacs uses for the alt modifier.
10987 This should be one of the symbols `alt', `hyper', `meta', `super'.
10988 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10989 is nil, which is the same as `alt'. */);
10990 Vx_alt_keysym = Qnil;
10992 DEFVAR_LISP ("x-hyper-keysym", &Vx_hyper_keysym,
10993 doc: /* Which keys Emacs uses for the hyper modifier.
10994 This should be one of the symbols `alt', `hyper', `meta', `super'.
10995 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10996 default is nil, which is the same as `hyper'. */);
10997 Vx_hyper_keysym = Qnil;
10999 DEFVAR_LISP ("x-meta-keysym", &Vx_meta_keysym,
11000 doc: /* Which keys Emacs uses for the meta modifier.
11001 This should be one of the symbols `alt', `hyper', `meta', `super'.
11002 For example, `meta' means use the Meta_L and Meta_R keysyms. The
11003 default is nil, which is the same as `meta'. */);
11004 Vx_meta_keysym = Qnil;
11006 DEFVAR_LISP ("x-super-keysym", &Vx_super_keysym,
11007 doc: /* Which keys Emacs uses for the super modifier.
11008 This should be one of the symbols `alt', `hyper', `meta', `super'.
11009 For example, `super' means use the Super_L and Super_R keysyms. The
11010 default is nil, which is the same as `super'. */);
11011 Vx_super_keysym = Qnil;
11013 DEFVAR_LISP ("x-keysym-table", &Vx_keysym_table,
11014 doc: /* Hash table of character codes indexed by X keysym codes. */);
11015 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
11016 make_float (DEFAULT_REHASH_SIZE),
11017 make_float (DEFAULT_REHASH_THRESHOLD),
11018 Qnil, Qnil, Qnil);
11021 #endif /* HAVE_X_WINDOWS */
11023 /* arch-tag: 6d4e4cb7-abc1-4302-9585-d84dcfb09d0f
11024 (do not change this comment) */