Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-412
[emacs.git] / src / xterm.c
blob4ab555974db49b296fe14bcd8e430a88d7250abb
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 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* New display code by Gerd Moellmann <gerd@gnu.org>. */
23 /* Xt features made by Fred Pierresteguy. */
25 #include <config.h>
27 /* On 4.3 these lose if they come after xterm.h. */
28 /* Putting these at the beginning seems to be standard for other .c files. */
29 #include <signal.h>
31 #include <stdio.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 "systty.h"
58 #include "systime.h"
60 #ifndef INCLUDED_FCNTL
61 #include <fcntl.h>
62 #endif
63 #include <ctype.h>
64 #include <errno.h>
65 #include <setjmp.h>
66 #include <sys/stat.h>
67 /* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed. */
68 /* #include <sys/param.h> */
70 #include "charset.h"
71 #include "coding.h"
72 #include "ccl.h"
73 #include "frame.h"
74 #include "dispextern.h"
75 #include "fontset.h"
76 #include "termhooks.h"
77 #include "termopts.h"
78 #include "termchar.h"
79 #include "gnu.h"
80 #include "disptab.h"
81 #include "buffer.h"
82 #include "window.h"
83 #include "keyboard.h"
84 #include "intervals.h"
85 #include "process.h"
86 #include "atimer.h"
87 #include "keymap.h"
89 #ifdef USE_X_TOOLKIT
90 #include <X11/Shell.h>
91 #endif
93 #ifdef HAVE_SYS_TIME_H
94 #include <sys/time.h>
95 #endif
96 #ifdef HAVE_UNISTD_H
97 #include <unistd.h>
98 #endif
100 #ifdef USE_GTK
101 #include "gtkutil.h"
102 #endif
104 #ifdef USE_LUCID
105 extern int xlwmenu_window_p P_ ((Widget w, Window window));
106 extern void xlwmenu_redisplay P_ ((Widget));
107 #endif
109 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
111 extern void free_frame_menubar P_ ((struct frame *));
112 extern struct frame *x_menubar_window_to_frame P_ ((struct x_display_info *,
113 int));
114 #endif
116 #ifdef USE_X_TOOLKIT
117 #if (XtSpecificationRelease >= 5) && !defined(NO_EDITRES)
118 #define HACK_EDITRES
119 extern void _XEditResCheckMessages ();
120 #endif /* not NO_EDITRES */
122 /* Include toolkit specific headers for the scroll bar widget. */
124 #ifdef USE_TOOLKIT_SCROLL_BARS
125 #if defined USE_MOTIF
126 #include <Xm/Xm.h> /* for LESSTIF_VERSION */
127 #include <Xm/ScrollBar.h>
128 #else /* !USE_MOTIF i.e. use Xaw */
130 #ifdef HAVE_XAW3D
131 #include <X11/Xaw3d/Simple.h>
132 #include <X11/Xaw3d/Scrollbar.h>
133 #include <X11/Xaw3d/ThreeD.h>
134 #else /* !HAVE_XAW3D */
135 #include <X11/Xaw/Simple.h>
136 #include <X11/Xaw/Scrollbar.h>
137 #endif /* !HAVE_XAW3D */
138 #ifndef XtNpickTop
139 #define XtNpickTop "pickTop"
140 #endif /* !XtNpickTop */
141 #endif /* !USE_MOTIF */
142 #endif /* USE_TOOLKIT_SCROLL_BARS */
144 #endif /* USE_X_TOOLKIT */
146 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
147 #define x_any_window_to_frame x_window_to_frame
148 #define x_top_window_to_frame x_window_to_frame
149 #endif
151 #ifdef USE_X_TOOLKIT
152 #include "widget.h"
153 #ifndef XtNinitialState
154 #define XtNinitialState "initialState"
155 #endif
156 #endif
158 #define abs(x) ((x) < 0 ? -(x) : (x))
160 /* Default to using XIM if available. */
161 #ifdef USE_XIM
162 int use_xim = 1;
163 #else
164 int use_xim = 0; /* configure --without-xim */
165 #endif
169 /* Non-nil means Emacs uses toolkit scroll bars. */
171 Lisp_Object Vx_toolkit_scroll_bars;
173 /* Non-zero means that a HELP_EVENT has been generated since Emacs
174 start. */
176 static int any_help_event_p;
178 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
179 static Lisp_Object last_window;
181 /* Non-zero means make use of UNDERLINE_POSITION font properties. */
183 int x_use_underline_position_properties;
185 /* This is a chain of structures for all the X displays currently in
186 use. */
188 struct x_display_info *x_display_list;
190 /* This is a list of cons cells, each of the form (NAME
191 . FONT-LIST-CACHE), one for each element of x_display_list and in
192 the same order. NAME is the name of the frame. FONT-LIST-CACHE
193 records previous values returned by x-list-fonts. */
195 Lisp_Object x_display_name_list;
197 /* Frame being updated by update_frame. This is declared in term.c.
198 This is set by update_begin and looked at by all the XT functions.
199 It is zero while not inside an update. In that case, the XT
200 functions assume that `selected_frame' is the frame to apply to. */
202 extern struct frame *updating_frame;
204 /* This is a frame waiting to be auto-raised, within XTread_socket. */
206 struct frame *pending_autoraise_frame;
208 #ifdef USE_X_TOOLKIT
209 /* The application context for Xt use. */
210 XtAppContext Xt_app_con;
211 static String Xt_default_resources[] = {0};
212 #endif /* USE_X_TOOLKIT */
214 /* Non-zero means user is interacting with a toolkit scroll bar. */
216 static int toolkit_scroll_bar_interaction;
218 /* Non-zero means to not move point as a result of clicking on a
219 frame to focus it (when focus-follows-mouse is nil). */
221 int x_mouse_click_focus_ignore_position;
223 /* Non-zero timeout value means ignore next mouse click if it arrives
224 before that timeout elapses (i.e. as part of the same sequence of
225 events resulting from clicking on a frame to select it). */
227 static unsigned long ignore_next_mouse_click_timeout;
229 /* Mouse movement.
231 Formerly, we used PointerMotionHintMask (in standard_event_mask)
232 so that we would have to call XQueryPointer after each MotionNotify
233 event to ask for another such event. However, this made mouse tracking
234 slow, and there was a bug that made it eventually stop.
236 Simply asking for MotionNotify all the time seems to work better.
238 In order to avoid asking for motion events and then throwing most
239 of them away or busy-polling the server for mouse positions, we ask
240 the server for pointer motion hints. This means that we get only
241 one event per group of mouse movements. "Groups" are delimited by
242 other kinds of events (focus changes and button clicks, for
243 example), or by XQueryPointer calls; when one of these happens, we
244 get another MotionNotify event the next time the mouse moves. This
245 is at least as efficient as getting motion events when mouse
246 tracking is on, and I suspect only negligibly worse when tracking
247 is off. */
249 /* Where the mouse was last time we reported a mouse event. */
251 static XRectangle last_mouse_glyph;
252 static Lisp_Object last_mouse_press_frame;
254 /* The scroll bar in which the last X motion event occurred.
256 If the last X motion event occurred in a scroll bar, we set this so
257 XTmouse_position can know whether to report a scroll bar motion or
258 an ordinary motion.
260 If the last X motion event didn't occur in a scroll bar, we set
261 this to Qnil, to tell XTmouse_position to return an ordinary motion
262 event. */
264 static Lisp_Object last_mouse_scroll_bar;
266 /* This is a hack. We would really prefer that XTmouse_position would
267 return the time associated with the position it returns, but there
268 doesn't seem to be any way to wrest the time-stamp from the server
269 along with the position query. So, we just keep track of the time
270 of the last movement we received, and return that in hopes that
271 it's somewhat accurate. */
273 static Time last_mouse_movement_time;
275 /* Incremented by XTread_socket whenever it really tries to read
276 events. */
278 #ifdef __STDC__
279 static int volatile input_signal_count;
280 #else
281 static int input_signal_count;
282 #endif
284 /* Used locally within XTread_socket. */
286 static int x_noop_count;
288 /* Initial values of argv and argc. */
290 extern char **initial_argv;
291 extern int initial_argc;
293 extern Lisp_Object Vcommand_line_args, Vsystem_name;
295 /* Tells if a window manager is present or not. */
297 extern Lisp_Object Vx_no_window_manager;
299 extern Lisp_Object Qeql;
301 extern int errno;
303 /* A mask of extra modifier bits to put into every keyboard char. */
305 extern EMACS_INT extra_keyboard_modifiers;
307 /* The keysyms to use for the various modifiers. */
309 Lisp_Object Vx_alt_keysym, Vx_hyper_keysym, Vx_meta_keysym, Vx_super_keysym;
310 Lisp_Object Vx_keysym_table;
311 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
313 static Lisp_Object Qvendor_specific_keysyms;
314 static Lisp_Object Qlatin_1;
316 extern XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
317 extern int x_bitmap_mask P_ ((FRAME_PTR, int));
319 static int x_alloc_nearest_color_1 P_ ((Display *, Colormap, XColor *));
320 static void x_set_window_size_1 P_ ((struct frame *, int, int, int));
321 static const XColor *x_color_cells P_ ((Display *, int *));
322 static void x_update_window_end P_ ((struct window *, int, int));
323 void x_delete_display P_ ((struct x_display_info *));
324 static unsigned int x_x_to_emacs_modifiers P_ ((struct x_display_info *,
325 unsigned));
326 static int x_io_error_quitter P_ ((Display *));
327 int x_catch_errors P_ ((Display *));
328 void x_uncatch_errors P_ ((Display *, int));
329 void x_lower_frame P_ ((struct frame *));
330 void x_scroll_bar_clear P_ ((struct frame *));
331 int x_had_errors_p P_ ((Display *));
332 void x_wm_set_size_hint P_ ((struct frame *, long, int));
333 void x_raise_frame P_ ((struct frame *));
334 void x_set_window_size P_ ((struct frame *, int, int, int));
335 void x_wm_set_window_state P_ ((struct frame *, int));
336 void x_wm_set_icon_pixmap P_ ((struct frame *, int));
337 void x_initialize P_ ((void));
338 static void x_font_min_bounds P_ ((XFontStruct *, int *, int *));
339 static int x_compute_min_glyph_bounds P_ ((struct frame *));
340 static void x_update_end P_ ((struct frame *));
341 static void XTframe_up_to_date P_ ((struct frame *));
342 static void XTset_terminal_modes P_ ((void));
343 static void XTreset_terminal_modes P_ ((void));
344 static void x_clear_frame P_ ((void));
345 static void frame_highlight P_ ((struct frame *));
346 static void frame_unhighlight P_ ((struct frame *));
347 static void x_new_focus_frame P_ ((struct x_display_info *, struct frame *));
348 static void x_focus_changed P_ ((int, int, struct x_display_info *,
349 struct frame *, struct input_event *));
350 static void x_detect_focus_change P_ ((struct x_display_info *,
351 XEvent *, struct input_event *));
352 static void XTframe_rehighlight P_ ((struct frame *));
353 static void x_frame_rehighlight P_ ((struct x_display_info *));
354 static void x_draw_hollow_cursor P_ ((struct window *, struct glyph_row *));
355 static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int,
356 enum text_cursor_kinds));
358 static void x_clip_to_row P_ ((struct window *, struct glyph_row *, int, GC));
359 static void x_flush P_ ((struct frame *f));
360 static void x_update_begin P_ ((struct frame *));
361 static void x_update_window_begin P_ ((struct window *));
362 static void x_after_update_window_line P_ ((struct glyph_row *));
363 static struct scroll_bar *x_window_to_scroll_bar P_ ((Display *, Window));
364 static void x_scroll_bar_report_motion P_ ((struct frame **, Lisp_Object *,
365 enum scroll_bar_part *,
366 Lisp_Object *, Lisp_Object *,
367 unsigned long *));
368 static void x_check_fullscreen P_ ((struct frame *));
369 static void x_check_expected_move P_ ((struct frame *));
370 static int handle_one_xevent P_ ((struct x_display_info *, XEvent *,
371 int *, struct input_event *));
374 /* Flush display of frame F, or of all frames if F is null. */
376 static void
377 x_flush (f)
378 struct frame *f;
380 BLOCK_INPUT;
381 if (f == NULL)
383 Lisp_Object rest, frame;
384 FOR_EACH_FRAME (rest, frame)
385 x_flush (XFRAME (frame));
387 else if (FRAME_X_P (f))
388 XFlush (FRAME_X_DISPLAY (f));
389 UNBLOCK_INPUT;
393 /* Remove calls to XFlush by defining XFlush to an empty replacement.
394 Calls to XFlush should be unnecessary because the X output buffer
395 is flushed automatically as needed by calls to XPending,
396 XNextEvent, or XWindowEvent according to the XFlush man page.
397 XTread_socket calls XPending. Removing XFlush improves
398 performance. */
400 #define XFlush(DISPLAY) (void) 0
403 /***********************************************************************
404 Debugging
405 ***********************************************************************/
407 #if 0
409 /* This is a function useful for recording debugging information about
410 the sequence of occurrences in this file. */
412 struct record
414 char *locus;
415 int type;
418 struct record event_record[100];
420 int event_record_index;
422 record_event (locus, type)
423 char *locus;
424 int type;
426 if (event_record_index == sizeof (event_record) / sizeof (struct record))
427 event_record_index = 0;
429 event_record[event_record_index].locus = locus;
430 event_record[event_record_index].type = type;
431 event_record_index++;
434 #endif /* 0 */
438 /* Return the struct x_display_info corresponding to DPY. */
440 struct x_display_info *
441 x_display_info_for_display (dpy)
442 Display *dpy;
444 struct x_display_info *dpyinfo;
446 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
447 if (dpyinfo->display == dpy)
448 return dpyinfo;
450 return 0;
455 /***********************************************************************
456 Starting and ending an update
457 ***********************************************************************/
459 /* Start an update of frame F. This function is installed as a hook
460 for update_begin, i.e. it is called when update_begin is called.
461 This function is called prior to calls to x_update_window_begin for
462 each window being updated. Currently, there is nothing to do here
463 because all interesting stuff is done on a window basis. */
465 static void
466 x_update_begin (f)
467 struct frame *f;
469 /* Nothing to do. */
473 /* Start update of window W. Set the global variable updated_window
474 to the window being updated and set output_cursor to the cursor
475 position of W. */
477 static void
478 x_update_window_begin (w)
479 struct window *w;
481 struct frame *f = XFRAME (WINDOW_FRAME (w));
482 struct x_display_info *display_info = FRAME_X_DISPLAY_INFO (f);
484 updated_window = w;
485 set_output_cursor (&w->cursor);
487 BLOCK_INPUT;
489 if (f == display_info->mouse_face_mouse_frame)
491 /* Don't do highlighting for mouse motion during the update. */
492 display_info->mouse_face_defer = 1;
494 /* If F needs to be redrawn, simply forget about any prior mouse
495 highlighting. */
496 if (FRAME_GARBAGED_P (f))
497 display_info->mouse_face_window = Qnil;
499 #if 0 /* Rows in a current matrix containing glyphs in mouse-face have
500 their mouse_face_p flag set, which means that they are always
501 unequal to rows in a desired matrix which never have that
502 flag set. So, rows containing mouse-face glyphs are never
503 scrolled, and we don't have to switch the mouse highlight off
504 here to prevent it from being scrolled. */
506 /* Can we tell that this update does not affect the window
507 where the mouse highlight is? If so, no need to turn off.
508 Likewise, don't do anything if the frame is garbaged;
509 in that case, the frame's current matrix that we would use
510 is all wrong, and we will redisplay that line anyway. */
511 if (!NILP (display_info->mouse_face_window)
512 && w == XWINDOW (display_info->mouse_face_window))
514 int i;
516 for (i = 0; i < w->desired_matrix->nrows; ++i)
517 if (MATRIX_ROW_ENABLED_P (w->desired_matrix, i))
518 break;
520 if (i < w->desired_matrix->nrows)
521 clear_mouse_face (display_info);
523 #endif /* 0 */
526 UNBLOCK_INPUT;
530 /* Draw a vertical window border from (x,y0) to (x,y1) */
532 static void
533 x_draw_vertical_window_border (w, x, y0, y1)
534 struct window *w;
535 int x, y0, y1;
537 struct frame *f = XFRAME (WINDOW_FRAME (w));
539 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
540 f->output_data.x->normal_gc, x, y0, x, y1);
543 /* End update of window W (which is equal to updated_window).
545 Draw vertical borders between horizontally adjacent windows, and
546 display W's cursor if CURSOR_ON_P is non-zero.
548 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
549 glyphs in mouse-face were overwritten. In that case we have to
550 make sure that the mouse-highlight is properly redrawn.
552 W may be a menu bar pseudo-window in case we don't have X toolkit
553 support. Such windows don't have a cursor, so don't display it
554 here. */
556 static void
557 x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
558 struct window *w;
559 int cursor_on_p, mouse_face_overwritten_p;
561 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
563 if (!w->pseudo_window_p)
565 BLOCK_INPUT;
567 if (cursor_on_p)
568 display_and_set_cursor (w, 1, output_cursor.hpos,
569 output_cursor.vpos,
570 output_cursor.x, output_cursor.y);
572 if (draw_window_fringes (w, 1))
573 x_draw_vertical_border (w);
575 UNBLOCK_INPUT;
578 /* If a row with mouse-face was overwritten, arrange for
579 XTframe_up_to_date to redisplay the mouse highlight. */
580 if (mouse_face_overwritten_p)
582 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
583 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
584 dpyinfo->mouse_face_window = Qnil;
587 updated_window = NULL;
591 /* End update of frame F. This function is installed as a hook in
592 update_end. */
594 static void
595 x_update_end (f)
596 struct frame *f;
598 /* Mouse highlight may be displayed again. */
599 FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
601 #ifndef XFlush
602 BLOCK_INPUT;
603 XFlush (FRAME_X_DISPLAY (f));
604 UNBLOCK_INPUT;
605 #endif
609 /* This function is called from various places in xdisp.c whenever a
610 complete update has been performed. The global variable
611 updated_window is not available here. */
613 static void
614 XTframe_up_to_date (f)
615 struct frame *f;
617 if (FRAME_X_P (f))
619 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
621 if (dpyinfo->mouse_face_deferred_gc
622 || f == dpyinfo->mouse_face_mouse_frame)
624 BLOCK_INPUT;
625 if (dpyinfo->mouse_face_mouse_frame)
626 note_mouse_highlight (dpyinfo->mouse_face_mouse_frame,
627 dpyinfo->mouse_face_mouse_x,
628 dpyinfo->mouse_face_mouse_y);
629 dpyinfo->mouse_face_deferred_gc = 0;
630 UNBLOCK_INPUT;
636 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
637 arrow bitmaps, or clear the fringes if no bitmaps are required
638 before DESIRED_ROW is made current. The window being updated is
639 found in updated_window. This function It is called from
640 update_window_line only if it is known that there are differences
641 between bitmaps to be drawn between current row and DESIRED_ROW. */
643 static void
644 x_after_update_window_line (desired_row)
645 struct glyph_row *desired_row;
647 struct window *w = updated_window;
648 struct frame *f;
649 int width, height;
651 xassert (w);
653 if (!desired_row->mode_line_p && !w->pseudo_window_p)
654 desired_row->redraw_fringe_bitmaps_p = 1;
656 /* When a window has disappeared, make sure that no rest of
657 full-width rows stays visible in the internal border. Could
658 check here if updated_window is the leftmost/rightmost window,
659 but I guess it's not worth doing since vertically split windows
660 are almost never used, internal border is rarely set, and the
661 overhead is very small. */
662 if (windows_or_buffers_changed
663 && desired_row->full_width_p
664 && (f = XFRAME (w->frame),
665 width = FRAME_INTERNAL_BORDER_WIDTH (f),
666 width != 0)
667 && (height = desired_row->visible_height,
668 height > 0))
670 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
672 /* Internal border is drawn below the tool bar. */
673 if (WINDOWP (f->tool_bar_window)
674 && w == XWINDOW (f->tool_bar_window))
675 y -= width;
677 BLOCK_INPUT;
678 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
679 0, y, width, height, False);
680 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
681 FRAME_PIXEL_WIDTH (f) - width,
682 y, width, height, False);
683 UNBLOCK_INPUT;
687 static void
688 x_draw_fringe_bitmap (w, row, p)
689 struct window *w;
690 struct glyph_row *row;
691 struct draw_fringe_bitmap_params *p;
693 struct frame *f = XFRAME (WINDOW_FRAME (w));
694 Display *display = FRAME_X_DISPLAY (f);
695 Window window = FRAME_X_WINDOW (f);
696 GC gc = f->output_data.x->normal_gc;
697 struct face *face = p->face;
698 int rowY;
700 /* Must clip because of partially visible lines. */
701 rowY = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
702 if (p->y < rowY)
704 /* Adjust position of "bottom aligned" bitmap on partially
705 visible last row. */
706 int oldY = row->y;
707 int oldVH = row->visible_height;
708 row->visible_height = p->h;
709 row->y -= rowY - p->y;
710 x_clip_to_row (w, row, -1, gc);
711 row->y = oldY;
712 row->visible_height = oldVH;
714 else
715 x_clip_to_row (w, row, -1, gc);
717 if (p->bx >= 0 && !p->overlay_p)
719 /* In case the same realized face is used for fringes and
720 for something displayed in the text (e.g. face `region' on
721 mono-displays, the fill style may have been changed to
722 FillSolid in x_draw_glyph_string_background. */
723 if (face->stipple)
724 XSetFillStyle (display, face->gc, FillOpaqueStippled);
725 else
726 XSetForeground (display, face->gc, face->background);
728 XFillRectangle (display, window, face->gc,
729 p->bx, p->by, p->nx, p->ny);
731 if (!face->stipple)
732 XSetForeground (display, face->gc, face->foreground);
735 if (p->which)
737 unsigned char *bits;
738 Pixmap pixmap, clipmask = (Pixmap) 0;
739 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
740 XGCValues gcv;
742 if (p->wd > 8)
743 bits = (unsigned char *)(p->bits + p->dh);
744 else
745 bits = (unsigned char *)p->bits + p->dh;
747 /* Draw the bitmap. I believe these small pixmaps can be cached
748 by the server. */
749 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
750 (p->cursor_p
751 ? (p->overlay_p ? face->background
752 : f->output_data.x->cursor_pixel)
753 : face->foreground),
754 face->background, depth);
756 if (p->overlay_p)
758 clipmask = XCreatePixmapFromBitmapData (display,
759 FRAME_X_DISPLAY_INFO (f)->root_window,
760 bits, p->wd, p->h,
761 1, 0, 1);
762 gcv.clip_mask = clipmask;
763 gcv.clip_x_origin = p->x;
764 gcv.clip_y_origin = p->y;
765 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
768 XCopyArea (display, pixmap, window, gc, 0, 0,
769 p->wd, p->h, p->x, p->y);
770 XFreePixmap (display, pixmap);
772 if (p->overlay_p)
774 gcv.clip_mask = (Pixmap) 0;
775 XChangeGC (display, gc, GCClipMask, &gcv);
776 XFreePixmap (display, clipmask);
780 XSetClipMask (display, gc, None);
785 /* This is called when starting Emacs and when restarting after
786 suspend. When starting Emacs, no X window is mapped. And nothing
787 must be done to Emacs's own window if it is suspended (though that
788 rarely happens). */
790 static void
791 XTset_terminal_modes ()
795 /* This is called when exiting or suspending Emacs. Exiting will make
796 the X-windows go away, and suspending requires no action. */
798 static void
799 XTreset_terminal_modes ()
805 /***********************************************************************
806 Display Iterator
807 ***********************************************************************/
809 /* Function prototypes of this page. */
811 static int x_encode_char P_ ((int, XChar2b *, struct font_info *, int *));
814 /* Get metrics of character CHAR2B in FONT. Value is null if CHAR2B
815 is not contained in the font. */
817 static XCharStruct *
818 x_per_char_metric (font, char2b, font_type)
819 XFontStruct *font;
820 XChar2b *char2b;
821 int font_type; /* unused on X */
823 /* The result metric information. */
824 XCharStruct *pcm = NULL;
826 xassert (font && char2b);
828 if (font->per_char != NULL)
830 if (font->min_byte1 == 0 && font->max_byte1 == 0)
832 /* min_char_or_byte2 specifies the linear character index
833 corresponding to the first element of the per_char array,
834 max_char_or_byte2 is the index of the last character. A
835 character with non-zero CHAR2B->byte1 is not in the font.
836 A character with byte2 less than min_char_or_byte2 or
837 greater max_char_or_byte2 is not in the font. */
838 if (char2b->byte1 == 0
839 && char2b->byte2 >= font->min_char_or_byte2
840 && char2b->byte2 <= font->max_char_or_byte2)
841 pcm = font->per_char + char2b->byte2 - font->min_char_or_byte2;
843 else
845 /* If either min_byte1 or max_byte1 are nonzero, both
846 min_char_or_byte2 and max_char_or_byte2 are less than
847 256, and the 2-byte character index values corresponding
848 to the per_char array element N (counting from 0) are:
850 byte1 = N/D + min_byte1
851 byte2 = N\D + min_char_or_byte2
853 where:
855 D = max_char_or_byte2 - min_char_or_byte2 + 1
856 / = integer division
857 \ = integer modulus */
858 if (char2b->byte1 >= font->min_byte1
859 && char2b->byte1 <= font->max_byte1
860 && char2b->byte2 >= font->min_char_or_byte2
861 && char2b->byte2 <= font->max_char_or_byte2)
863 pcm = (font->per_char
864 + ((font->max_char_or_byte2 - font->min_char_or_byte2 + 1)
865 * (char2b->byte1 - font->min_byte1))
866 + (char2b->byte2 - font->min_char_or_byte2));
870 else
872 /* If the per_char pointer is null, all glyphs between the first
873 and last character indexes inclusive have the same
874 information, as given by both min_bounds and max_bounds. */
875 if (char2b->byte2 >= font->min_char_or_byte2
876 && char2b->byte2 <= font->max_char_or_byte2)
877 pcm = &font->max_bounds;
880 return ((pcm == NULL
881 || (pcm->width == 0 && (pcm->rbearing - pcm->lbearing) == 0))
882 ? NULL : pcm);
886 /* Encode CHAR2B using encoding information from FONT_INFO. CHAR2B is
887 the two-byte form of C. Encoding is returned in *CHAR2B. */
889 static int
890 x_encode_char (c, char2b, font_info, two_byte_p)
891 int c;
892 XChar2b *char2b;
893 struct font_info *font_info;
894 int *two_byte_p;
896 int charset = CHAR_CHARSET (c);
897 XFontStruct *font = font_info->font;
899 /* FONT_INFO may define a scheme by which to encode byte1 and byte2.
900 This may be either a program in a special encoder language or a
901 fixed encoding. */
902 if (font_info->font_encoder)
904 /* It's a program. */
905 struct ccl_program *ccl = font_info->font_encoder;
907 check_ccl_update (ccl);
908 if (CHARSET_DIMENSION (charset) == 1)
910 ccl->reg[0] = charset;
911 ccl->reg[1] = char2b->byte2;
912 ccl->reg[2] = -1;
914 else
916 ccl->reg[0] = charset;
917 ccl->reg[1] = char2b->byte1;
918 ccl->reg[2] = char2b->byte2;
921 ccl_driver (ccl, NULL, NULL, 0, 0, NULL);
923 /* We assume that MSBs are appropriately set/reset by CCL
924 program. */
925 if (font->max_byte1 == 0) /* 1-byte font */
926 char2b->byte1 = 0, char2b->byte2 = ccl->reg[1];
927 else
928 char2b->byte1 = ccl->reg[1], char2b->byte2 = ccl->reg[2];
930 else if (font_info->encoding[charset])
932 /* Fixed encoding scheme. See fontset.h for the meaning of the
933 encoding numbers. */
934 int enc = font_info->encoding[charset];
936 if ((enc == 1 || enc == 2)
937 && CHARSET_DIMENSION (charset) == 2)
938 char2b->byte1 |= 0x80;
940 if (enc == 1 || enc == 3)
941 char2b->byte2 |= 0x80;
944 if (two_byte_p)
945 *two_byte_p = ((XFontStruct *) (font_info->font))->max_byte1 > 0;
947 return FONT_TYPE_UNKNOWN;
952 /***********************************************************************
953 Glyph display
954 ***********************************************************************/
958 static void x_set_glyph_string_clipping P_ ((struct glyph_string *));
959 static void x_set_glyph_string_gc P_ ((struct glyph_string *));
960 static void x_draw_glyph_string_background P_ ((struct glyph_string *,
961 int));
962 static void x_draw_glyph_string_foreground P_ ((struct glyph_string *));
963 static void x_draw_composite_glyph_string_foreground P_ ((struct glyph_string *));
964 static void x_draw_glyph_string_box P_ ((struct glyph_string *));
965 static void x_draw_glyph_string P_ ((struct glyph_string *));
966 static void x_compute_glyph_string_overhangs P_ ((struct glyph_string *));
967 static void x_set_cursor_gc P_ ((struct glyph_string *));
968 static void x_set_mode_line_face_gc P_ ((struct glyph_string *));
969 static void x_set_mouse_face_gc P_ ((struct glyph_string *));
970 static int x_alloc_lighter_color P_ ((struct frame *, Display *, Colormap,
971 unsigned long *, double, int));
972 static void x_setup_relief_color P_ ((struct frame *, struct relief *,
973 double, int, unsigned long));
974 static void x_setup_relief_colors P_ ((struct glyph_string *));
975 static void x_draw_image_glyph_string P_ ((struct glyph_string *));
976 static void x_draw_image_relief P_ ((struct glyph_string *));
977 static void x_draw_image_foreground P_ ((struct glyph_string *));
978 static void x_draw_image_foreground_1 P_ ((struct glyph_string *, Pixmap));
979 static void x_clear_glyph_string_rect P_ ((struct glyph_string *, int,
980 int, int, int));
981 static void x_draw_relief_rect P_ ((struct frame *, int, int, int, int,
982 int, int, int, int, int, int,
983 XRectangle *));
984 static void x_draw_box_rect P_ ((struct glyph_string *, int, int, int, int,
985 int, int, int, XRectangle *));
987 #if GLYPH_DEBUG
988 static void x_check_font P_ ((struct frame *, XFontStruct *));
989 #endif
992 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
993 face. */
995 static void
996 x_set_cursor_gc (s)
997 struct glyph_string *s;
999 if (s->font == FRAME_FONT (s->f)
1000 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
1001 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
1002 && !s->cmp)
1003 s->gc = s->f->output_data.x->cursor_gc;
1004 else
1006 /* Cursor on non-default face: must merge. */
1007 XGCValues xgcv;
1008 unsigned long mask;
1010 xgcv.background = s->f->output_data.x->cursor_pixel;
1011 xgcv.foreground = s->face->background;
1013 /* If the glyph would be invisible, try a different foreground. */
1014 if (xgcv.foreground == xgcv.background)
1015 xgcv.foreground = s->face->foreground;
1016 if (xgcv.foreground == xgcv.background)
1017 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
1018 if (xgcv.foreground == xgcv.background)
1019 xgcv.foreground = s->face->foreground;
1021 /* Make sure the cursor is distinct from text in this face. */
1022 if (xgcv.background == s->face->background
1023 && xgcv.foreground == s->face->foreground)
1025 xgcv.background = s->face->foreground;
1026 xgcv.foreground = s->face->background;
1029 IF_DEBUG (x_check_font (s->f, s->font));
1030 xgcv.font = s->font->fid;
1031 xgcv.graphics_exposures = False;
1032 mask = GCForeground | GCBackground | GCFont | GCGraphicsExposures;
1034 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1035 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1036 mask, &xgcv);
1037 else
1038 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1039 = XCreateGC (s->display, s->window, mask, &xgcv);
1041 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1046 /* Set up S->gc of glyph string S for drawing text in mouse face. */
1048 static void
1049 x_set_mouse_face_gc (s)
1050 struct glyph_string *s;
1052 int face_id;
1053 struct face *face;
1055 /* What face has to be used last for the mouse face? */
1056 face_id = FRAME_X_DISPLAY_INFO (s->f)->mouse_face_face_id;
1057 face = FACE_FROM_ID (s->f, face_id);
1058 if (face == NULL)
1059 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
1061 if (s->first_glyph->type == CHAR_GLYPH)
1062 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch);
1063 else
1064 face_id = FACE_FOR_CHAR (s->f, face, 0);
1065 s->face = FACE_FROM_ID (s->f, face_id);
1066 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1068 /* If font in this face is same as S->font, use it. */
1069 if (s->font == s->face->font)
1070 s->gc = s->face->gc;
1071 else
1073 /* Otherwise construct scratch_cursor_gc with values from FACE
1074 but font FONT. */
1075 XGCValues xgcv;
1076 unsigned long mask;
1078 xgcv.background = s->face->background;
1079 xgcv.foreground = s->face->foreground;
1080 IF_DEBUG (x_check_font (s->f, s->font));
1081 xgcv.font = s->font->fid;
1082 xgcv.graphics_exposures = False;
1083 mask = GCForeground | GCBackground | GCFont | GCGraphicsExposures;
1085 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1086 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1087 mask, &xgcv);
1088 else
1089 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1090 = XCreateGC (s->display, s->window, mask, &xgcv);
1092 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1095 xassert (s->gc != 0);
1099 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1100 Faces to use in the mode line have already been computed when the
1101 matrix was built, so there isn't much to do, here. */
1103 static INLINE void
1104 x_set_mode_line_face_gc (s)
1105 struct glyph_string *s;
1107 s->gc = s->face->gc;
1111 /* Set S->gc of glyph string S for drawing that glyph string. Set
1112 S->stippled_p to a non-zero value if the face of S has a stipple
1113 pattern. */
1115 static INLINE void
1116 x_set_glyph_string_gc (s)
1117 struct glyph_string *s;
1119 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1121 if (s->hl == DRAW_NORMAL_TEXT)
1123 s->gc = s->face->gc;
1124 s->stippled_p = s->face->stipple != 0;
1126 else if (s->hl == DRAW_INVERSE_VIDEO)
1128 x_set_mode_line_face_gc (s);
1129 s->stippled_p = s->face->stipple != 0;
1131 else if (s->hl == DRAW_CURSOR)
1133 x_set_cursor_gc (s);
1134 s->stippled_p = 0;
1136 else if (s->hl == DRAW_MOUSE_FACE)
1138 x_set_mouse_face_gc (s);
1139 s->stippled_p = s->face->stipple != 0;
1141 else if (s->hl == DRAW_IMAGE_RAISED
1142 || s->hl == DRAW_IMAGE_SUNKEN)
1144 s->gc = s->face->gc;
1145 s->stippled_p = s->face->stipple != 0;
1147 else
1149 s->gc = s->face->gc;
1150 s->stippled_p = s->face->stipple != 0;
1153 /* GC must have been set. */
1154 xassert (s->gc != 0);
1158 /* Set clipping for output of glyph string S. S may be part of a mode
1159 line or menu if we don't have X toolkit support. */
1161 static INLINE void
1162 x_set_glyph_string_clipping (s)
1163 struct glyph_string *s;
1165 XRectangle r;
1166 get_glyph_string_clip_rect (s, &r);
1167 XSetClipRectangles (s->display, s->gc, 0, 0, &r, 1, Unsorted);
1171 /* RIF:
1172 Compute left and right overhang of glyph string S. If S is a glyph
1173 string for a composition, assume overhangs don't exist. */
1175 static void
1176 x_compute_glyph_string_overhangs (s)
1177 struct glyph_string *s;
1179 if (s->cmp == NULL
1180 && s->first_glyph->type == CHAR_GLYPH)
1182 XCharStruct cs;
1183 int direction, font_ascent, font_descent;
1184 XTextExtents16 (s->font, s->char2b, s->nchars, &direction,
1185 &font_ascent, &font_descent, &cs);
1186 s->right_overhang = cs.rbearing > cs.width ? cs.rbearing - cs.width : 0;
1187 s->left_overhang = cs.lbearing < 0 ? -cs.lbearing : 0;
1192 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1194 static INLINE void
1195 x_clear_glyph_string_rect (s, x, y, w, h)
1196 struct glyph_string *s;
1197 int x, y, w, h;
1199 XGCValues xgcv;
1200 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1201 XSetForeground (s->display, s->gc, xgcv.background);
1202 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1203 XSetForeground (s->display, s->gc, xgcv.foreground);
1207 /* Draw the background of glyph_string S. If S->background_filled_p
1208 is non-zero don't draw it. FORCE_P non-zero means draw the
1209 background even if it wouldn't be drawn normally. This is used
1210 when a string preceding S draws into the background of S, or S
1211 contains the first component of a composition. */
1213 static void
1214 x_draw_glyph_string_background (s, force_p)
1215 struct glyph_string *s;
1216 int force_p;
1218 /* Nothing to do if background has already been drawn or if it
1219 shouldn't be drawn in the first place. */
1220 if (!s->background_filled_p)
1222 int box_line_width = max (s->face->box_line_width, 0);
1224 if (s->stippled_p)
1226 /* Fill background with a stipple pattern. */
1227 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1228 XFillRectangle (s->display, s->window, s->gc, s->x,
1229 s->y + box_line_width,
1230 s->background_width,
1231 s->height - 2 * box_line_width);
1232 XSetFillStyle (s->display, s->gc, FillSolid);
1233 s->background_filled_p = 1;
1235 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1236 || s->font_not_found_p
1237 || s->extends_to_end_of_line_p
1238 || force_p)
1240 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1241 s->background_width,
1242 s->height - 2 * box_line_width);
1243 s->background_filled_p = 1;
1249 /* Draw the foreground of glyph string S. */
1251 static void
1252 x_draw_glyph_string_foreground (s)
1253 struct glyph_string *s;
1255 int i, x;
1257 /* If first glyph of S has a left box line, start drawing the text
1258 of S to the right of that box line. */
1259 if (s->face->box != FACE_NO_BOX
1260 && s->first_glyph->left_box_line_p)
1261 x = s->x + abs (s->face->box_line_width);
1262 else
1263 x = s->x;
1265 /* Draw characters of S as rectangles if S's font could not be
1266 loaded. */
1267 if (s->font_not_found_p)
1269 for (i = 0; i < s->nchars; ++i)
1271 struct glyph *g = s->first_glyph + i;
1272 XDrawRectangle (s->display, s->window,
1273 s->gc, x, s->y, g->pixel_width - 1,
1274 s->height - 1);
1275 x += g->pixel_width;
1278 else
1280 char *char1b = (char *) s->char2b;
1281 int boff = s->font_info->baseline_offset;
1283 if (s->font_info->vertical_centering)
1284 boff = VCENTER_BASELINE_OFFSET (s->font, s->f) - boff;
1286 /* If we can use 8-bit functions, condense S->char2b. */
1287 if (!s->two_byte_p)
1288 for (i = 0; i < s->nchars; ++i)
1289 char1b[i] = s->char2b[i].byte2;
1291 /* Draw text with XDrawString if background has already been
1292 filled. Otherwise, use XDrawImageString. (Note that
1293 XDrawImageString is usually faster than XDrawString.) Always
1294 use XDrawImageString when drawing the cursor so that there is
1295 no chance that characters under a box cursor are invisible. */
1296 if (s->for_overlaps_p
1297 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1299 /* Draw characters with 16-bit or 8-bit functions. */
1300 if (s->two_byte_p)
1301 XDrawString16 (s->display, s->window, s->gc, x,
1302 s->ybase - boff, s->char2b, s->nchars);
1303 else
1304 XDrawString (s->display, s->window, s->gc, x,
1305 s->ybase - boff, char1b, s->nchars);
1307 else
1309 if (s->two_byte_p)
1310 XDrawImageString16 (s->display, s->window, s->gc, x,
1311 s->ybase - boff, s->char2b, s->nchars);
1312 else
1313 XDrawImageString (s->display, s->window, s->gc, x,
1314 s->ybase - boff, char1b, s->nchars);
1317 if (s->face->overstrike)
1319 /* For overstriking (to simulate bold-face), draw the
1320 characters again shifted to the right by one pixel. */
1321 if (s->two_byte_p)
1322 XDrawString16 (s->display, s->window, s->gc, x + 1,
1323 s->ybase - boff, s->char2b, s->nchars);
1324 else
1325 XDrawString (s->display, s->window, s->gc, x + 1,
1326 s->ybase - boff, char1b, s->nchars);
1331 /* Draw the foreground of composite glyph string S. */
1333 static void
1334 x_draw_composite_glyph_string_foreground (s)
1335 struct glyph_string *s;
1337 int i, x;
1339 /* If first glyph of S has a left box line, start drawing the text
1340 of S to the right of that box line. */
1341 if (s->face->box != FACE_NO_BOX
1342 && s->first_glyph->left_box_line_p)
1343 x = s->x + abs (s->face->box_line_width);
1344 else
1345 x = s->x;
1347 /* S is a glyph string for a composition. S->gidx is the index of
1348 the first character drawn for glyphs of this composition.
1349 S->gidx == 0 means we are drawing the very first character of
1350 this composition. */
1352 /* Draw a rectangle for the composition if the font for the very
1353 first character of the composition could not be loaded. */
1354 if (s->font_not_found_p)
1356 if (s->gidx == 0)
1357 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1358 s->width - 1, s->height - 1);
1360 else
1362 for (i = 0; i < s->nchars; i++, ++s->gidx)
1364 XDrawString16 (s->display, s->window, s->gc,
1365 x + s->cmp->offsets[s->gidx * 2],
1366 s->ybase - s->cmp->offsets[s->gidx * 2 + 1],
1367 s->char2b + i, 1);
1368 if (s->face->overstrike)
1369 XDrawString16 (s->display, s->window, s->gc,
1370 x + s->cmp->offsets[s->gidx * 2] + 1,
1371 s->ybase - s->cmp->offsets[s->gidx * 2 + 1],
1372 s->char2b + i, 1);
1378 #ifdef USE_X_TOOLKIT
1380 static struct frame *x_frame_of_widget P_ ((Widget));
1381 static Boolean cvt_string_to_pixel P_ ((Display *, XrmValue *, Cardinal *,
1382 XrmValue *, XrmValue *, XtPointer *));
1383 static void cvt_pixel_dtor P_ ((XtAppContext, XrmValue *, XtPointer,
1384 XrmValue *, Cardinal *));
1387 /* Return the frame on which widget WIDGET is used.. Abort if frame
1388 cannot be determined. */
1390 static struct frame *
1391 x_frame_of_widget (widget)
1392 Widget widget;
1394 struct x_display_info *dpyinfo;
1395 Lisp_Object tail;
1396 struct frame *f;
1398 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1400 /* Find the top-level shell of the widget. Note that this function
1401 can be called when the widget is not yet realized, so XtWindow
1402 (widget) == 0. That's the reason we can't simply use
1403 x_any_window_to_frame. */
1404 while (!XtIsTopLevelShell (widget))
1405 widget = XtParent (widget);
1407 /* Look for a frame with that top-level widget. Allocate the color
1408 on that frame to get the right gamma correction value. */
1409 for (tail = Vframe_list; GC_CONSP (tail); tail = XCDR (tail))
1410 if (GC_FRAMEP (XCAR (tail))
1411 && (f = XFRAME (XCAR (tail)),
1412 (f->output_data.nothing != 1
1413 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1414 && f->output_data.x->widget == widget)
1415 return f;
1417 abort ();
1421 /* Allocate the color COLOR->pixel on the screen and display of
1422 widget WIDGET in colormap CMAP. If an exact match cannot be
1423 allocated, try the nearest color available. Value is non-zero
1424 if successful. This is called from lwlib. */
1427 x_alloc_nearest_color_for_widget (widget, cmap, color)
1428 Widget widget;
1429 Colormap cmap;
1430 XColor *color;
1432 struct frame *f = x_frame_of_widget (widget);
1433 return x_alloc_nearest_color (f, cmap, color);
1437 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1438 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1439 If this produces the same color as PIXEL, try a color where all RGB
1440 values have DELTA added. Return the allocated color in *PIXEL.
1441 DISPLAY is the X display, CMAP is the colormap to operate on.
1442 Value is non-zero if successful. */
1445 x_alloc_lighter_color_for_widget (widget, display, cmap, pixel, factor, delta)
1446 Widget widget;
1447 Display *display;
1448 Colormap cmap;
1449 unsigned long *pixel;
1450 double factor;
1451 int delta;
1453 struct frame *f = x_frame_of_widget (widget);
1454 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1458 /* Structure specifying which arguments should be passed by Xt to
1459 cvt_string_to_pixel. We want the widget's screen and colormap. */
1461 static XtConvertArgRec cvt_string_to_pixel_args[] =
1463 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1464 sizeof (Screen *)},
1465 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1466 sizeof (Colormap)}
1470 /* The address of this variable is returned by
1471 cvt_string_to_pixel. */
1473 static Pixel cvt_string_to_pixel_value;
1476 /* Convert a color name to a pixel color.
1478 DPY is the display we are working on.
1480 ARGS is an array of *NARGS XrmValue structures holding additional
1481 information about the widget for which the conversion takes place.
1482 The contents of this array are determined by the specification
1483 in cvt_string_to_pixel_args.
1485 FROM is a pointer to an XrmValue which points to the color name to
1486 convert. TO is an XrmValue in which to return the pixel color.
1488 CLOSURE_RET is a pointer to user-data, in which we record if
1489 we allocated the color or not.
1491 Value is True if successful, False otherwise. */
1493 static Boolean
1494 cvt_string_to_pixel (dpy, args, nargs, from, to, closure_ret)
1495 Display *dpy;
1496 XrmValue *args;
1497 Cardinal *nargs;
1498 XrmValue *from, *to;
1499 XtPointer *closure_ret;
1501 Screen *screen;
1502 Colormap cmap;
1503 Pixel pixel;
1504 String color_name;
1505 XColor color;
1507 if (*nargs != 2)
1509 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1510 "wrongParameters", "cvt_string_to_pixel",
1511 "XtToolkitError",
1512 "Screen and colormap args required", NULL, NULL);
1513 return False;
1516 screen = *(Screen **) args[0].addr;
1517 cmap = *(Colormap *) args[1].addr;
1518 color_name = (String) from->addr;
1520 if (strcmp (color_name, XtDefaultBackground) == 0)
1522 *closure_ret = (XtPointer) False;
1523 pixel = WhitePixelOfScreen (screen);
1525 else if (strcmp (color_name, XtDefaultForeground) == 0)
1527 *closure_ret = (XtPointer) False;
1528 pixel = BlackPixelOfScreen (screen);
1530 else if (XParseColor (dpy, cmap, color_name, &color)
1531 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1533 pixel = color.pixel;
1534 *closure_ret = (XtPointer) True;
1536 else
1538 String params[1];
1539 Cardinal nparams = 1;
1541 params[0] = color_name;
1542 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1543 "badValue", "cvt_string_to_pixel",
1544 "XtToolkitError", "Invalid color `%s'",
1545 params, &nparams);
1546 return False;
1549 if (to->addr != NULL)
1551 if (to->size < sizeof (Pixel))
1553 to->size = sizeof (Pixel);
1554 return False;
1557 *(Pixel *) to->addr = pixel;
1559 else
1561 cvt_string_to_pixel_value = pixel;
1562 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1565 to->size = sizeof (Pixel);
1566 return True;
1570 /* Free a pixel color which was previously allocated via
1571 cvt_string_to_pixel. This is registered as the destructor
1572 for this type of resource via XtSetTypeConverter.
1574 APP is the application context in which we work.
1576 TO is a pointer to an XrmValue holding the color to free.
1577 CLOSURE is the value we stored in CLOSURE_RET for this color
1578 in cvt_string_to_pixel.
1580 ARGS and NARGS are like for cvt_string_to_pixel. */
1582 static void
1583 cvt_pixel_dtor (app, to, closure, args, nargs)
1584 XtAppContext app;
1585 XrmValuePtr to;
1586 XtPointer closure;
1587 XrmValuePtr args;
1588 Cardinal *nargs;
1590 if (*nargs != 2)
1592 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1593 "XtToolkitError",
1594 "Screen and colormap arguments required",
1595 NULL, NULL);
1597 else if (closure != NULL)
1599 /* We did allocate the pixel, so free it. */
1600 Screen *screen = *(Screen **) args[0].addr;
1601 Colormap cmap = *(Colormap *) args[1].addr;
1602 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1603 (Pixel *) to->addr, 1);
1608 #endif /* USE_X_TOOLKIT */
1611 /* Value is an array of XColor structures for the contents of the
1612 color map of display DPY. Set *NCELLS to the size of the array.
1613 Note that this probably shouldn't be called for large color maps,
1614 say a 24-bit TrueColor map. */
1616 static const XColor *
1617 x_color_cells (dpy, ncells)
1618 Display *dpy;
1619 int *ncells;
1621 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1623 if (dpyinfo->color_cells == NULL)
1625 Screen *screen = dpyinfo->screen;
1626 int i;
1628 dpyinfo->ncolor_cells
1629 = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1630 dpyinfo->color_cells
1631 = (XColor *) xmalloc (dpyinfo->ncolor_cells
1632 * sizeof *dpyinfo->color_cells);
1634 for (i = 0; i < dpyinfo->ncolor_cells; ++i)
1635 dpyinfo->color_cells[i].pixel = i;
1637 XQueryColors (dpy, dpyinfo->cmap,
1638 dpyinfo->color_cells, dpyinfo->ncolor_cells);
1641 *ncells = dpyinfo->ncolor_cells;
1642 return dpyinfo->color_cells;
1646 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1647 colors in COLORS. Use cached information, if available. */
1649 void
1650 x_query_colors (f, colors, ncolors)
1651 struct frame *f;
1652 XColor *colors;
1653 int ncolors;
1655 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1657 if (dpyinfo->color_cells)
1659 int i;
1660 for (i = 0; i < ncolors; ++i)
1662 unsigned long pixel = colors[i].pixel;
1663 xassert (pixel < dpyinfo->ncolor_cells);
1664 xassert (dpyinfo->color_cells[pixel].pixel == pixel);
1665 colors[i] = dpyinfo->color_cells[pixel];
1668 else
1669 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1673 /* On frame F, translate pixel color to RGB values for the color in
1674 COLOR. Use cached information, if available. */
1676 void
1677 x_query_color (f, color)
1678 struct frame *f;
1679 XColor *color;
1681 x_query_colors (f, color, 1);
1685 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1686 exact match can't be allocated, try the nearest color available.
1687 Value is non-zero if successful. Set *COLOR to the color
1688 allocated. */
1690 static int
1691 x_alloc_nearest_color_1 (dpy, cmap, color)
1692 Display *dpy;
1693 Colormap cmap;
1694 XColor *color;
1696 int rc;
1698 rc = XAllocColor (dpy, cmap, color);
1699 if (rc == 0)
1701 /* If we got to this point, the colormap is full, so we're going
1702 to try to get the next closest color. The algorithm used is
1703 a least-squares matching, which is what X uses for closest
1704 color matching with StaticColor visuals. */
1705 int nearest, i;
1706 unsigned long nearest_delta = ~0;
1707 int ncells;
1708 const XColor *cells = x_color_cells (dpy, &ncells);
1710 for (nearest = i = 0; i < ncells; ++i)
1712 long dred = (color->red >> 8) - (cells[i].red >> 8);
1713 long dgreen = (color->green >> 8) - (cells[i].green >> 8);
1714 long dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1715 unsigned long delta = dred * dred + dgreen * dgreen + dblue * dblue;
1717 if (delta < nearest_delta)
1719 nearest = i;
1720 nearest_delta = delta;
1724 color->red = cells[nearest].red;
1725 color->green = cells[nearest].green;
1726 color->blue = cells[nearest].blue;
1727 rc = XAllocColor (dpy, cmap, color);
1729 else
1731 /* If allocation succeeded, and the allocated pixel color is not
1732 equal to a cached pixel color recorded earlier, there was a
1733 change in the colormap, so clear the color cache. */
1734 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1735 XColor *cached_color;
1737 if (dpyinfo->color_cells
1738 && (cached_color = &dpyinfo->color_cells[color->pixel],
1739 (cached_color->red != color->red
1740 || cached_color->blue != color->blue
1741 || cached_color->green != color->green)))
1743 xfree (dpyinfo->color_cells);
1744 dpyinfo->color_cells = NULL;
1745 dpyinfo->ncolor_cells = 0;
1749 #ifdef DEBUG_X_COLORS
1750 if (rc)
1751 register_color (color->pixel);
1752 #endif /* DEBUG_X_COLORS */
1754 return rc;
1758 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1759 exact match can't be allocated, try the nearest color available.
1760 Value is non-zero if successful. Set *COLOR to the color
1761 allocated. */
1764 x_alloc_nearest_color (f, cmap, color)
1765 struct frame *f;
1766 Colormap cmap;
1767 XColor *color;
1769 gamma_correct (f, color);
1770 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1774 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1775 It's necessary to do this instead of just using PIXEL directly to
1776 get color reference counts right. */
1778 unsigned long
1779 x_copy_color (f, pixel)
1780 struct frame *f;
1781 unsigned long pixel;
1783 XColor color;
1785 color.pixel = pixel;
1786 BLOCK_INPUT;
1787 x_query_color (f, &color);
1788 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1789 UNBLOCK_INPUT;
1790 #ifdef DEBUG_X_COLORS
1791 register_color (pixel);
1792 #endif
1793 return color.pixel;
1797 /* Allocate color PIXEL on display DPY. PIXEL must already be allocated.
1798 It's necessary to do this instead of just using PIXEL directly to
1799 get color reference counts right. */
1801 unsigned long
1802 x_copy_dpy_color (dpy, cmap, pixel)
1803 Display *dpy;
1804 Colormap cmap;
1805 unsigned long pixel;
1807 XColor color;
1809 color.pixel = pixel;
1810 BLOCK_INPUT;
1811 XQueryColor (dpy, cmap, &color);
1812 XAllocColor (dpy, cmap, &color);
1813 UNBLOCK_INPUT;
1814 #ifdef DEBUG_X_COLORS
1815 register_color (pixel);
1816 #endif
1817 return color.pixel;
1821 /* Brightness beyond which a color won't have its highlight brightness
1822 boosted.
1824 Nominally, highlight colors for `3d' faces are calculated by
1825 brightening an object's color by a constant scale factor, but this
1826 doesn't yield good results for dark colors, so for colors who's
1827 brightness is less than this value (on a scale of 0-65535) have an
1828 use an additional additive factor.
1830 The value here is set so that the default menu-bar/mode-line color
1831 (grey75) will not have its highlights changed at all. */
1832 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1835 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1836 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1837 If this produces the same color as PIXEL, try a color where all RGB
1838 values have DELTA added. Return the allocated color in *PIXEL.
1839 DISPLAY is the X display, CMAP is the colormap to operate on.
1840 Value is non-zero if successful. */
1842 static int
1843 x_alloc_lighter_color (f, display, cmap, pixel, factor, delta)
1844 struct frame *f;
1845 Display *display;
1846 Colormap cmap;
1847 unsigned long *pixel;
1848 double factor;
1849 int delta;
1851 XColor color, new;
1852 long bright;
1853 int success_p;
1855 /* Get RGB color values. */
1856 color.pixel = *pixel;
1857 x_query_color (f, &color);
1859 /* Change RGB values by specified FACTOR. Avoid overflow! */
1860 xassert (factor >= 0);
1861 new.red = min (0xffff, factor * color.red);
1862 new.green = min (0xffff, factor * color.green);
1863 new.blue = min (0xffff, factor * color.blue);
1865 /* Calculate brightness of COLOR. */
1866 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1868 /* We only boost colors that are darker than
1869 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1870 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1871 /* Make an additive adjustment to NEW, because it's dark enough so
1872 that scaling by FACTOR alone isn't enough. */
1874 /* How far below the limit this color is (0 - 1, 1 being darker). */
1875 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1876 /* The additive adjustment. */
1877 int min_delta = delta * dimness * factor / 2;
1879 if (factor < 1)
1881 new.red = max (0, new.red - min_delta);
1882 new.green = max (0, new.green - min_delta);
1883 new.blue = max (0, new.blue - min_delta);
1885 else
1887 new.red = min (0xffff, min_delta + new.red);
1888 new.green = min (0xffff, min_delta + new.green);
1889 new.blue = min (0xffff, min_delta + new.blue);
1893 /* Try to allocate the color. */
1894 success_p = x_alloc_nearest_color (f, cmap, &new);
1895 if (success_p)
1897 if (new.pixel == *pixel)
1899 /* If we end up with the same color as before, try adding
1900 delta to the RGB values. */
1901 x_free_colors (f, &new.pixel, 1);
1903 new.red = min (0xffff, delta + color.red);
1904 new.green = min (0xffff, delta + color.green);
1905 new.blue = min (0xffff, delta + color.blue);
1906 success_p = x_alloc_nearest_color (f, cmap, &new);
1908 else
1909 success_p = 1;
1910 *pixel = new.pixel;
1913 return success_p;
1917 /* Set up the foreground color for drawing relief lines of glyph
1918 string S. RELIEF is a pointer to a struct relief containing the GC
1919 with which lines will be drawn. Use a color that is FACTOR or
1920 DELTA lighter or darker than the relief's background which is found
1921 in S->f->output_data.x->relief_background. If such a color cannot
1922 be allocated, use DEFAULT_PIXEL, instead. */
1924 static void
1925 x_setup_relief_color (f, relief, factor, delta, default_pixel)
1926 struct frame *f;
1927 struct relief *relief;
1928 double factor;
1929 int delta;
1930 unsigned long default_pixel;
1932 XGCValues xgcv;
1933 struct x_output *di = f->output_data.x;
1934 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1935 unsigned long pixel;
1936 unsigned long background = di->relief_background;
1937 Colormap cmap = FRAME_X_COLORMAP (f);
1938 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1939 Display *dpy = FRAME_X_DISPLAY (f);
1941 xgcv.graphics_exposures = False;
1942 xgcv.line_width = 1;
1944 /* Free previously allocated color. The color cell will be reused
1945 when it has been freed as many times as it was allocated, so this
1946 doesn't affect faces using the same colors. */
1947 if (relief->gc
1948 && relief->allocated_p)
1950 x_free_colors (f, &relief->pixel, 1);
1951 relief->allocated_p = 0;
1954 /* Allocate new color. */
1955 xgcv.foreground = default_pixel;
1956 pixel = background;
1957 if (dpyinfo->n_planes != 1
1958 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1960 relief->allocated_p = 1;
1961 xgcv.foreground = relief->pixel = pixel;
1964 if (relief->gc == 0)
1966 xgcv.stipple = dpyinfo->gray;
1967 mask |= GCStipple;
1968 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1970 else
1971 XChangeGC (dpy, relief->gc, mask, &xgcv);
1975 /* Set up colors for the relief lines around glyph string S. */
1977 static void
1978 x_setup_relief_colors (s)
1979 struct glyph_string *s;
1981 struct x_output *di = s->f->output_data.x;
1982 unsigned long color;
1984 if (s->face->use_box_color_for_shadows_p)
1985 color = s->face->box_color;
1986 else if (s->first_glyph->type == IMAGE_GLYPH
1987 && s->img->pixmap
1988 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
1989 color = IMAGE_BACKGROUND (s->img, s->f, 0);
1990 else
1992 XGCValues xgcv;
1994 /* Get the background color of the face. */
1995 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
1996 color = xgcv.background;
1999 if (di->white_relief.gc == 0
2000 || color != di->relief_background)
2002 di->relief_background = color;
2003 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
2004 WHITE_PIX_DEFAULT (s->f));
2005 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
2006 BLACK_PIX_DEFAULT (s->f));
2011 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
2012 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
2013 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
2014 relief. LEFT_P non-zero means draw a relief on the left side of
2015 the rectangle. RIGHT_P non-zero means draw a relief on the right
2016 side of the rectangle. CLIP_RECT is the clipping rectangle to use
2017 when drawing. */
2019 static void
2020 x_draw_relief_rect (f, left_x, top_y, right_x, bottom_y, width,
2021 raised_p, top_p, bot_p, left_p, right_p, clip_rect)
2022 struct frame *f;
2023 int left_x, top_y, right_x, bottom_y, width;
2024 int top_p, bot_p, left_p, right_p, raised_p;
2025 XRectangle *clip_rect;
2027 Display *dpy = FRAME_X_DISPLAY (f);
2028 Window window = FRAME_X_WINDOW (f);
2029 int i;
2030 GC gc;
2032 if (raised_p)
2033 gc = f->output_data.x->white_relief.gc;
2034 else
2035 gc = f->output_data.x->black_relief.gc;
2036 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2038 /* Top. */
2039 if (top_p)
2040 for (i = 0; i < width; ++i)
2041 XDrawLine (dpy, window, gc,
2042 left_x + i * left_p, top_y + i,
2043 right_x + 1 - i * right_p, top_y + i);
2045 /* Left. */
2046 if (left_p)
2047 for (i = 0; i < width; ++i)
2048 XDrawLine (dpy, window, gc,
2049 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
2051 XSetClipMask (dpy, gc, None);
2052 if (raised_p)
2053 gc = f->output_data.x->black_relief.gc;
2054 else
2055 gc = f->output_data.x->white_relief.gc;
2056 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2058 /* Bottom. */
2059 if (bot_p)
2060 for (i = 0; i < width; ++i)
2061 XDrawLine (dpy, window, gc,
2062 left_x + i * left_p, bottom_y - i,
2063 right_x + 1 - i * right_p, bottom_y - i);
2065 /* Right. */
2066 if (right_p)
2067 for (i = 0; i < width; ++i)
2068 XDrawLine (dpy, window, gc,
2069 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
2071 XSetClipMask (dpy, gc, None);
2075 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2076 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2077 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2078 left side of the rectangle. RIGHT_P non-zero means draw a line
2079 on the right side of the rectangle. CLIP_RECT is the clipping
2080 rectangle to use when drawing. */
2082 static void
2083 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2084 left_p, right_p, clip_rect)
2085 struct glyph_string *s;
2086 int left_x, top_y, right_x, bottom_y, width, left_p, right_p;
2087 XRectangle *clip_rect;
2089 XGCValues xgcv;
2091 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2092 XSetForeground (s->display, s->gc, s->face->box_color);
2093 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2095 /* Top. */
2096 XFillRectangle (s->display, s->window, s->gc,
2097 left_x, top_y, right_x - left_x + 1, width);
2099 /* Left. */
2100 if (left_p)
2101 XFillRectangle (s->display, s->window, s->gc,
2102 left_x, top_y, width, bottom_y - top_y + 1);
2104 /* Bottom. */
2105 XFillRectangle (s->display, s->window, s->gc,
2106 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2108 /* Right. */
2109 if (right_p)
2110 XFillRectangle (s->display, s->window, s->gc,
2111 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2113 XSetForeground (s->display, s->gc, xgcv.foreground);
2114 XSetClipMask (s->display, s->gc, None);
2118 /* Draw a box around glyph string S. */
2120 static void
2121 x_draw_glyph_string_box (s)
2122 struct glyph_string *s;
2124 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2125 int left_p, right_p;
2126 struct glyph *last_glyph;
2127 XRectangle clip_rect;
2129 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2130 ? WINDOW_RIGHT_EDGE_X (s->w)
2131 : window_box_right (s->w, s->area));
2133 /* The glyph that may have a right box line. */
2134 last_glyph = (s->cmp || s->img
2135 ? s->first_glyph
2136 : s->first_glyph + s->nchars - 1);
2138 width = abs (s->face->box_line_width);
2139 raised_p = s->face->box == FACE_RAISED_BOX;
2140 left_x = s->x;
2141 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2142 ? last_x - 1
2143 : min (last_x, s->x + s->background_width) - 1);
2144 top_y = s->y;
2145 bottom_y = top_y + s->height - 1;
2147 left_p = (s->first_glyph->left_box_line_p
2148 || (s->hl == DRAW_MOUSE_FACE
2149 && (s->prev == NULL
2150 || s->prev->hl != s->hl)));
2151 right_p = (last_glyph->right_box_line_p
2152 || (s->hl == DRAW_MOUSE_FACE
2153 && (s->next == NULL
2154 || s->next->hl != s->hl)));
2156 get_glyph_string_clip_rect (s, &clip_rect);
2158 if (s->face->box == FACE_SIMPLE_BOX)
2159 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2160 left_p, right_p, &clip_rect);
2161 else
2163 x_setup_relief_colors (s);
2164 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2165 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2170 /* Draw foreground of image glyph string S. */
2172 static void
2173 x_draw_image_foreground (s)
2174 struct glyph_string *s;
2176 int x = s->x;
2177 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2179 /* If first glyph of S has a left box line, start drawing it to the
2180 right of that line. */
2181 if (s->face->box != FACE_NO_BOX
2182 && s->first_glyph->left_box_line_p
2183 && s->slice.x == 0)
2184 x += abs (s->face->box_line_width);
2186 /* If there is a margin around the image, adjust x- and y-position
2187 by that margin. */
2188 if (s->slice.x == 0)
2189 x += s->img->hmargin;
2190 if (s->slice.y == 0)
2191 y += s->img->vmargin;
2193 if (s->img->pixmap)
2195 if (s->img->mask)
2197 /* We can't set both a clip mask and use XSetClipRectangles
2198 because the latter also sets a clip mask. We also can't
2199 trust on the shape extension to be available
2200 (XShapeCombineRegion). So, compute the rectangle to draw
2201 manually. */
2202 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2203 | GCFunction);
2204 XGCValues xgcv;
2205 XRectangle clip_rect, image_rect, r;
2207 xgcv.clip_mask = s->img->mask;
2208 xgcv.clip_x_origin = x;
2209 xgcv.clip_y_origin = y;
2210 xgcv.function = GXcopy;
2211 XChangeGC (s->display, s->gc, mask, &xgcv);
2213 get_glyph_string_clip_rect (s, &clip_rect);
2214 image_rect.x = x;
2215 image_rect.y = y;
2216 image_rect.width = s->slice.width;
2217 image_rect.height = s->slice.height;
2218 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2219 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2220 s->slice.x + r.x - x, s->slice.y + r.y - y,
2221 r.width, r.height, r.x, r.y);
2223 else
2225 XRectangle clip_rect, image_rect, r;
2227 get_glyph_string_clip_rect (s, &clip_rect);
2228 image_rect.x = x;
2229 image_rect.y = y;
2230 image_rect.width = s->slice.width;
2231 image_rect.height = s->slice.height;
2232 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2233 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2234 s->slice.x + r.x - x, s->slice.y + r.y - y,
2235 r.width, r.height, r.x, r.y);
2237 /* When the image has a mask, we can expect that at
2238 least part of a mouse highlight or a block cursor will
2239 be visible. If the image doesn't have a mask, make
2240 a block cursor visible by drawing a rectangle around
2241 the image. I believe it's looking better if we do
2242 nothing here for mouse-face. */
2243 if (s->hl == DRAW_CURSOR)
2245 int r = s->img->relief;
2246 if (r < 0) r = -r;
2247 XDrawRectangle (s->display, s->window, s->gc,
2248 x - r, y - r,
2249 s->slice.width + r*2 - 1,
2250 s->slice.height + r*2 - 1);
2254 else
2255 /* Draw a rectangle if image could not be loaded. */
2256 XDrawRectangle (s->display, s->window, s->gc, x, y,
2257 s->slice.width - 1, s->slice.height - 1);
2261 /* Draw a relief around the image glyph string S. */
2263 static void
2264 x_draw_image_relief (s)
2265 struct glyph_string *s;
2267 int x0, y0, x1, y1, thick, raised_p;
2268 XRectangle r;
2269 int x = s->x;
2270 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2272 /* If first glyph of S has a left box line, start drawing it to the
2273 right of that line. */
2274 if (s->face->box != FACE_NO_BOX
2275 && s->first_glyph->left_box_line_p
2276 && s->slice.x == 0)
2277 x += abs (s->face->box_line_width);
2279 /* If there is a margin around the image, adjust x- and y-position
2280 by that margin. */
2281 if (s->slice.x == 0)
2282 x += s->img->hmargin;
2283 if (s->slice.y == 0)
2284 y += s->img->vmargin;
2286 if (s->hl == DRAW_IMAGE_SUNKEN
2287 || s->hl == DRAW_IMAGE_RAISED)
2289 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2290 raised_p = s->hl == DRAW_IMAGE_RAISED;
2292 else
2294 thick = abs (s->img->relief);
2295 raised_p = s->img->relief > 0;
2298 x0 = x - thick;
2299 y0 = y - thick;
2300 x1 = x + s->slice.width + thick - 1;
2301 y1 = y + s->slice.height + thick - 1;
2303 x_setup_relief_colors (s);
2304 get_glyph_string_clip_rect (s, &r);
2305 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2306 s->slice.y == 0,
2307 s->slice.y + s->slice.height == s->img->height,
2308 s->slice.x == 0,
2309 s->slice.x + s->slice.width == s->img->width,
2310 &r);
2314 /* Draw the foreground of image glyph string S to PIXMAP. */
2316 static void
2317 x_draw_image_foreground_1 (s, pixmap)
2318 struct glyph_string *s;
2319 Pixmap pixmap;
2321 int x = 0;
2322 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2324 /* If first glyph of S has a left box line, start drawing it to the
2325 right of that line. */
2326 if (s->face->box != FACE_NO_BOX
2327 && s->first_glyph->left_box_line_p
2328 && s->slice.x == 0)
2329 x += abs (s->face->box_line_width);
2331 /* If there is a margin around the image, adjust x- and y-position
2332 by that margin. */
2333 if (s->slice.x == 0)
2334 x += s->img->hmargin;
2335 if (s->slice.y == 0)
2336 y += s->img->vmargin;
2338 if (s->img->pixmap)
2340 if (s->img->mask)
2342 /* We can't set both a clip mask and use XSetClipRectangles
2343 because the latter also sets a clip mask. We also can't
2344 trust on the shape extension to be available
2345 (XShapeCombineRegion). So, compute the rectangle to draw
2346 manually. */
2347 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2348 | GCFunction);
2349 XGCValues xgcv;
2351 xgcv.clip_mask = s->img->mask;
2352 xgcv.clip_x_origin = x - s->slice.x;
2353 xgcv.clip_y_origin = y - s->slice.y;
2354 xgcv.function = GXcopy;
2355 XChangeGC (s->display, s->gc, mask, &xgcv);
2357 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2358 s->slice.x, s->slice.y,
2359 s->slice.width, s->slice.height, x, y);
2360 XSetClipMask (s->display, s->gc, None);
2362 else
2364 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2365 s->slice.x, s->slice.y,
2366 s->slice.width, s->slice.height, x, y);
2368 /* When the image has a mask, we can expect that at
2369 least part of a mouse highlight or a block cursor will
2370 be visible. If the image doesn't have a mask, make
2371 a block cursor visible by drawing a rectangle around
2372 the image. I believe it's looking better if we do
2373 nothing here for mouse-face. */
2374 if (s->hl == DRAW_CURSOR)
2376 int r = s->img->relief;
2377 if (r < 0) r = -r;
2378 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2379 s->slice.width + r*2 - 1,
2380 s->slice.height + r*2 - 1);
2384 else
2385 /* Draw a rectangle if image could not be loaded. */
2386 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2387 s->slice.width - 1, s->slice.height - 1);
2391 /* Draw part of the background of glyph string S. X, Y, W, and H
2392 give the rectangle to draw. */
2394 static void
2395 x_draw_glyph_string_bg_rect (s, x, y, w, h)
2396 struct glyph_string *s;
2397 int x, y, w, h;
2399 if (s->stippled_p)
2401 /* Fill background with a stipple pattern. */
2402 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2403 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2404 XSetFillStyle (s->display, s->gc, FillSolid);
2406 else
2407 x_clear_glyph_string_rect (s, x, y, w, h);
2411 /* Draw image glyph string S.
2413 s->y
2414 s->x +-------------------------
2415 | s->face->box
2417 | +-------------------------
2418 | | s->img->margin
2420 | | +-------------------
2421 | | | the image
2425 static void
2426 x_draw_image_glyph_string (s)
2427 struct glyph_string *s;
2429 int box_line_hwidth = abs (s->face->box_line_width);
2430 int box_line_vwidth = max (s->face->box_line_width, 0);
2431 int height;
2432 Pixmap pixmap = None;
2434 height = s->height;
2435 if (s->slice.y == 0)
2436 height -= box_line_vwidth;
2437 if (s->slice.y + s->slice.height >= s->img->height)
2438 height -= box_line_vwidth;
2440 /* Fill background with face under the image. Do it only if row is
2441 taller than image or if image has a clip mask to reduce
2442 flickering. */
2443 s->stippled_p = s->face->stipple != 0;
2444 if (height > s->slice.height
2445 || s->img->hmargin
2446 || s->img->vmargin
2447 || s->img->mask
2448 || s->img->pixmap == 0
2449 || s->width != s->background_width)
2451 if (s->img->mask)
2453 /* Create a pixmap as large as the glyph string. Fill it
2454 with the background color. Copy the image to it, using
2455 its mask. Copy the temporary pixmap to the display. */
2456 Screen *screen = FRAME_X_SCREEN (s->f);
2457 int depth = DefaultDepthOfScreen (screen);
2459 /* Create a pixmap as large as the glyph string. */
2460 pixmap = XCreatePixmap (s->display, s->window,
2461 s->background_width,
2462 s->height, depth);
2464 /* Don't clip in the following because we're working on the
2465 pixmap. */
2466 XSetClipMask (s->display, s->gc, None);
2468 /* Fill the pixmap with the background color/stipple. */
2469 if (s->stippled_p)
2471 /* Fill background with a stipple pattern. */
2472 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2473 XFillRectangle (s->display, pixmap, s->gc,
2474 0, 0, s->background_width, s->height);
2475 XSetFillStyle (s->display, s->gc, FillSolid);
2477 else
2479 XGCValues xgcv;
2480 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2481 &xgcv);
2482 XSetForeground (s->display, s->gc, xgcv.background);
2483 XFillRectangle (s->display, pixmap, s->gc,
2484 0, 0, s->background_width, s->height);
2485 XSetForeground (s->display, s->gc, xgcv.foreground);
2488 else
2490 int x = s->x;
2491 int y = s->y;
2493 if (s->first_glyph->left_box_line_p
2494 && s->slice.x == 0)
2495 x += box_line_hwidth;
2497 if (s->slice.y == 0)
2498 y += box_line_vwidth;
2500 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2503 s->background_filled_p = 1;
2506 /* Draw the foreground. */
2507 if (pixmap != None)
2509 x_draw_image_foreground_1 (s, pixmap);
2510 x_set_glyph_string_clipping (s);
2511 XCopyArea (s->display, pixmap, s->window, s->gc,
2512 0, 0, s->background_width, s->height, s->x, s->y);
2513 XFreePixmap (s->display, pixmap);
2515 else
2516 x_draw_image_foreground (s);
2518 /* If we must draw a relief around the image, do it. */
2519 if (s->img->relief
2520 || s->hl == DRAW_IMAGE_RAISED
2521 || s->hl == DRAW_IMAGE_SUNKEN)
2522 x_draw_image_relief (s);
2526 /* Draw stretch glyph string S. */
2528 static void
2529 x_draw_stretch_glyph_string (s)
2530 struct glyph_string *s;
2532 xassert (s->first_glyph->type == STRETCH_GLYPH);
2533 s->stippled_p = s->face->stipple != 0;
2535 if (s->hl == DRAW_CURSOR
2536 && !x_stretch_cursor_p)
2538 /* If `x-stretch-block-cursor' is nil, don't draw a block cursor
2539 as wide as the stretch glyph. */
2540 int width = min (FRAME_COLUMN_WIDTH (s->f), s->background_width);
2542 /* Draw cursor. */
2543 x_draw_glyph_string_bg_rect (s, s->x, s->y, width, s->height);
2545 /* Clear rest using the GC of the original non-cursor face. */
2546 if (width < s->background_width)
2548 int x = s->x + width, y = s->y;
2549 int w = s->background_width - width, h = s->height;
2550 XRectangle r;
2551 GC gc;
2553 if (s->row->mouse_face_p
2554 && cursor_in_mouse_face_p (s->w))
2556 x_set_mouse_face_gc (s);
2557 gc = s->gc;
2559 else
2560 gc = s->face->gc;
2562 get_glyph_string_clip_rect (s, &r);
2563 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2565 if (s->face->stipple)
2567 /* Fill background with a stipple pattern. */
2568 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2569 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2570 XSetFillStyle (s->display, gc, FillSolid);
2572 else
2574 XGCValues xgcv;
2575 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2576 XSetForeground (s->display, gc, xgcv.background);
2577 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2578 XSetForeground (s->display, gc, xgcv.foreground);
2582 else if (!s->background_filled_p)
2583 x_draw_glyph_string_bg_rect (s, s->x, s->y, s->background_width,
2584 s->height);
2586 s->background_filled_p = 1;
2590 /* Draw glyph string S. */
2592 static void
2593 x_draw_glyph_string (s)
2594 struct glyph_string *s;
2596 int relief_drawn_p = 0;
2598 /* If S draws into the background of its successor, draw the
2599 background of the successor first so that S can draw into it.
2600 This makes S->next use XDrawString instead of XDrawImageString. */
2601 if (s->next && s->right_overhang && !s->for_overlaps_p)
2603 xassert (s->next->img == NULL);
2604 x_set_glyph_string_gc (s->next);
2605 x_set_glyph_string_clipping (s->next);
2606 x_draw_glyph_string_background (s->next, 1);
2609 /* Set up S->gc, set clipping and draw S. */
2610 x_set_glyph_string_gc (s);
2612 /* Draw relief (if any) in advance for char/composition so that the
2613 glyph string can be drawn over it. */
2614 if (!s->for_overlaps_p
2615 && s->face->box != FACE_NO_BOX
2616 && (s->first_glyph->type == CHAR_GLYPH
2617 || s->first_glyph->type == COMPOSITE_GLYPH))
2620 x_set_glyph_string_clipping (s);
2621 x_draw_glyph_string_background (s, 1);
2622 x_draw_glyph_string_box (s);
2623 x_set_glyph_string_clipping (s);
2624 relief_drawn_p = 1;
2626 else
2627 x_set_glyph_string_clipping (s);
2629 switch (s->first_glyph->type)
2631 case IMAGE_GLYPH:
2632 x_draw_image_glyph_string (s);
2633 break;
2635 case STRETCH_GLYPH:
2636 x_draw_stretch_glyph_string (s);
2637 break;
2639 case CHAR_GLYPH:
2640 if (s->for_overlaps_p)
2641 s->background_filled_p = 1;
2642 else
2643 x_draw_glyph_string_background (s, 0);
2644 x_draw_glyph_string_foreground (s);
2645 break;
2647 case COMPOSITE_GLYPH:
2648 if (s->for_overlaps_p || s->gidx > 0)
2649 s->background_filled_p = 1;
2650 else
2651 x_draw_glyph_string_background (s, 1);
2652 x_draw_composite_glyph_string_foreground (s);
2653 break;
2655 default:
2656 abort ();
2659 if (!s->for_overlaps_p)
2661 /* Draw underline. */
2662 if (s->face->underline_p)
2664 unsigned long tem, h;
2665 int y;
2667 /* Get the underline thickness. Default is 1 pixel. */
2668 if (!XGetFontProperty (s->font, XA_UNDERLINE_THICKNESS, &h))
2669 h = 1;
2671 /* Get the underline position. This is the recommended
2672 vertical offset in pixels from the baseline to the top of
2673 the underline. This is a signed value according to the
2674 specs, and its default is
2676 ROUND ((maximum descent) / 2), with
2677 ROUND(x) = floor (x + 0.5) */
2679 if (x_use_underline_position_properties
2680 && XGetFontProperty (s->font, XA_UNDERLINE_POSITION, &tem))
2681 y = s->ybase + (long) tem;
2682 else if (s->face->font)
2683 y = s->ybase + (s->face->font->max_bounds.descent + 1) / 2;
2684 else
2685 y = s->y + s->height - h;
2687 if (s->face->underline_defaulted_p)
2688 XFillRectangle (s->display, s->window, s->gc,
2689 s->x, y, s->width, h);
2690 else
2692 XGCValues xgcv;
2693 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2694 XSetForeground (s->display, s->gc, s->face->underline_color);
2695 XFillRectangle (s->display, s->window, s->gc,
2696 s->x, y, s->width, h);
2697 XSetForeground (s->display, s->gc, xgcv.foreground);
2701 /* Draw overline. */
2702 if (s->face->overline_p)
2704 unsigned long dy = 0, h = 1;
2706 if (s->face->overline_color_defaulted_p)
2707 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2708 s->width, h);
2709 else
2711 XGCValues xgcv;
2712 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2713 XSetForeground (s->display, s->gc, s->face->overline_color);
2714 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2715 s->width, h);
2716 XSetForeground (s->display, s->gc, xgcv.foreground);
2720 /* Draw strike-through. */
2721 if (s->face->strike_through_p)
2723 unsigned long h = 1;
2724 unsigned long dy = (s->height - h) / 2;
2726 if (s->face->strike_through_color_defaulted_p)
2727 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2728 s->width, h);
2729 else
2731 XGCValues xgcv;
2732 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2733 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2734 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2735 s->width, h);
2736 XSetForeground (s->display, s->gc, xgcv.foreground);
2740 /* Draw relief if not yet drawn. */
2741 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2742 x_draw_glyph_string_box (s);
2745 /* Reset clipping. */
2746 XSetClipMask (s->display, s->gc, None);
2749 /* Shift display to make room for inserted glyphs. */
2751 void
2752 x_shift_glyphs_for_insert (f, x, y, width, height, shift_by)
2753 struct frame *f;
2754 int x, y, width, height, shift_by;
2756 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2757 f->output_data.x->normal_gc,
2758 x, y, width, height,
2759 x + shift_by, y);
2762 /* Delete N glyphs at the nominal cursor position. Not implemented
2763 for X frames. */
2765 static void
2766 x_delete_glyphs (n)
2767 register int n;
2769 abort ();
2773 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2774 If they are <= 0, this is probably an error. */
2776 void
2777 x_clear_area (dpy, window, x, y, width, height, exposures)
2778 Display *dpy;
2779 Window window;
2780 int x, y;
2781 int width, height;
2782 int exposures;
2784 xassert (width > 0 && height > 0);
2785 XClearArea (dpy, window, x, y, width, height, exposures);
2789 /* Clear entire frame. If updating_frame is non-null, clear that
2790 frame. Otherwise clear the selected frame. */
2792 static void
2793 x_clear_frame ()
2795 struct frame *f;
2797 if (updating_frame)
2798 f = updating_frame;
2799 else
2800 f = SELECTED_FRAME ();
2802 /* Clearing the frame will erase any cursor, so mark them all as no
2803 longer visible. */
2804 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2805 output_cursor.hpos = output_cursor.vpos = 0;
2806 output_cursor.x = -1;
2808 /* We don't set the output cursor here because there will always
2809 follow an explicit cursor_to. */
2810 BLOCK_INPUT;
2811 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
2813 /* We have to clear the scroll bars, too. If we have changed
2814 colors or something like that, then they should be notified. */
2815 x_scroll_bar_clear (f);
2817 XFlush (FRAME_X_DISPLAY (f));
2819 UNBLOCK_INPUT;
2824 /* Invert the middle quarter of the frame for .15 sec. */
2826 /* We use the select system call to do the waiting, so we have to make
2827 sure it's available. If it isn't, we just won't do visual bells. */
2829 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
2832 /* Subtract the `struct timeval' values X and Y, storing the result in
2833 *RESULT. Return 1 if the difference is negative, otherwise 0. */
2835 static int
2836 timeval_subtract (result, x, y)
2837 struct timeval *result, x, y;
2839 /* Perform the carry for the later subtraction by updating y. This
2840 is safer because on some systems the tv_sec member is unsigned. */
2841 if (x.tv_usec < y.tv_usec)
2843 int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
2844 y.tv_usec -= 1000000 * nsec;
2845 y.tv_sec += nsec;
2848 if (x.tv_usec - y.tv_usec > 1000000)
2850 int nsec = (y.tv_usec - x.tv_usec) / 1000000;
2851 y.tv_usec += 1000000 * nsec;
2852 y.tv_sec -= nsec;
2855 /* Compute the time remaining to wait. tv_usec is certainly
2856 positive. */
2857 result->tv_sec = x.tv_sec - y.tv_sec;
2858 result->tv_usec = x.tv_usec - y.tv_usec;
2860 /* Return indication of whether the result should be considered
2861 negative. */
2862 return x.tv_sec < y.tv_sec;
2865 void
2866 XTflash (f)
2867 struct frame *f;
2869 BLOCK_INPUT;
2872 GC gc;
2874 /* Create a GC that will use the GXxor function to flip foreground
2875 pixels into background pixels. */
2877 XGCValues values;
2879 values.function = GXxor;
2880 values.foreground = (f->output_data.x->foreground_pixel
2881 ^ f->output_data.x->background_pixel);
2883 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
2884 GCFunction | GCForeground, &values);
2888 /* Get the height not including a menu bar widget. */
2889 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
2890 /* Height of each line to flash. */
2891 int flash_height = FRAME_LINE_HEIGHT (f);
2892 /* These will be the left and right margins of the rectangles. */
2893 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
2894 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
2896 int width;
2898 /* Don't flash the area between a scroll bar and the frame
2899 edge it is next to. */
2900 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
2902 case vertical_scroll_bar_left:
2903 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
2904 break;
2906 case vertical_scroll_bar_right:
2907 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
2908 break;
2910 default:
2911 break;
2914 width = flash_right - flash_left;
2916 /* If window is tall, flash top and bottom line. */
2917 if (height > 3 * FRAME_LINE_HEIGHT (f))
2919 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
2920 flash_left,
2921 (FRAME_INTERNAL_BORDER_WIDTH (f)
2922 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
2923 width, flash_height);
2924 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
2925 flash_left,
2926 (height - flash_height
2927 - FRAME_INTERNAL_BORDER_WIDTH (f)),
2928 width, flash_height);
2930 else
2931 /* If it is short, flash it all. */
2932 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
2933 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
2934 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
2936 x_flush (f);
2939 struct timeval wakeup;
2941 EMACS_GET_TIME (wakeup);
2943 /* Compute time to wait until, propagating carry from usecs. */
2944 wakeup.tv_usec += 150000;
2945 wakeup.tv_sec += (wakeup.tv_usec / 1000000);
2946 wakeup.tv_usec %= 1000000;
2948 /* Keep waiting until past the time wakeup or any input gets
2949 available. */
2950 while (! detect_input_pending ())
2952 struct timeval current;
2953 struct timeval timeout;
2955 EMACS_GET_TIME (current);
2957 /* Break if result would be negative. */
2958 if (timeval_subtract (&current, wakeup, current))
2959 break;
2961 /* How long `select' should wait. */
2962 timeout.tv_sec = 0;
2963 timeout.tv_usec = 10000;
2965 /* Try to wait that long--but we might wake up sooner. */
2966 select (0, NULL, NULL, NULL, &timeout);
2970 /* If window is tall, flash top and bottom line. */
2971 if (height > 3 * FRAME_LINE_HEIGHT (f))
2973 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
2974 flash_left,
2975 (FRAME_INTERNAL_BORDER_WIDTH (f)
2976 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
2977 width, flash_height);
2978 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
2979 flash_left,
2980 (height - flash_height
2981 - FRAME_INTERNAL_BORDER_WIDTH (f)),
2982 width, flash_height);
2984 else
2985 /* If it is short, flash it all. */
2986 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
2987 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
2988 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
2990 XFreeGC (FRAME_X_DISPLAY (f), gc);
2991 x_flush (f);
2995 UNBLOCK_INPUT;
2998 #endif /* defined (HAVE_TIMEVAL) && defined (HAVE_SELECT) */
3001 /* Make audible bell. */
3003 void
3004 XTring_bell ()
3006 struct frame *f = SELECTED_FRAME ();
3008 if (FRAME_X_DISPLAY (f))
3010 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
3011 if (visible_bell)
3012 XTflash (f);
3013 else
3014 #endif
3016 BLOCK_INPUT;
3017 XBell (FRAME_X_DISPLAY (f), 0);
3018 XFlush (FRAME_X_DISPLAY (f));
3019 UNBLOCK_INPUT;
3025 /* Specify how many text lines, from the top of the window,
3026 should be affected by insert-lines and delete-lines operations.
3027 This, and those operations, are used only within an update
3028 that is bounded by calls to x_update_begin and x_update_end. */
3030 static void
3031 XTset_terminal_window (n)
3032 register int n;
3034 /* This function intentionally left blank. */
3039 /***********************************************************************
3040 Line Dance
3041 ***********************************************************************/
3043 /* Perform an insert-lines or delete-lines operation, inserting N
3044 lines or deleting -N lines at vertical position VPOS. */
3046 static void
3047 x_ins_del_lines (vpos, n)
3048 int vpos, n;
3050 abort ();
3054 /* Scroll part of the display as described by RUN. */
3056 static void
3057 x_scroll_run (w, run)
3058 struct window *w;
3059 struct run *run;
3061 struct frame *f = XFRAME (w->frame);
3062 int x, y, width, height, from_y, to_y, bottom_y;
3064 /* Get frame-relative bounding box of the text display area of W,
3065 without mode lines. Include in this box the left and right
3066 fringe of W. */
3067 window_box (w, -1, &x, &y, &width, &height);
3069 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3070 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3071 bottom_y = y + height;
3073 if (to_y < from_y)
3075 /* Scrolling up. Make sure we don't copy part of the mode
3076 line at the bottom. */
3077 if (from_y + run->height > bottom_y)
3078 height = bottom_y - from_y;
3079 else
3080 height = run->height;
3082 else
3084 /* Scolling down. Make sure we don't copy over the mode line.
3085 at the bottom. */
3086 if (to_y + run->height > bottom_y)
3087 height = bottom_y - to_y;
3088 else
3089 height = run->height;
3092 BLOCK_INPUT;
3094 /* Cursor off. Will be switched on again in x_update_window_end. */
3095 updated_window = w;
3096 x_clear_cursor (w);
3098 XCopyArea (FRAME_X_DISPLAY (f),
3099 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3100 f->output_data.x->normal_gc,
3101 x, from_y,
3102 width, height,
3103 x, to_y);
3105 UNBLOCK_INPUT;
3110 /***********************************************************************
3111 Exposure Events
3112 ***********************************************************************/
3115 static void
3116 frame_highlight (f)
3117 struct frame *f;
3119 /* We used to only do this if Vx_no_window_manager was non-nil, but
3120 the ICCCM (section 4.1.6) says that the window's border pixmap
3121 and border pixel are window attributes which are "private to the
3122 client", so we can always change it to whatever we want. */
3123 BLOCK_INPUT;
3124 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3125 f->output_data.x->border_pixel);
3126 UNBLOCK_INPUT;
3127 x_update_cursor (f, 1);
3130 static void
3131 frame_unhighlight (f)
3132 struct frame *f;
3134 /* We used to only do this if Vx_no_window_manager was non-nil, but
3135 the ICCCM (section 4.1.6) says that the window's border pixmap
3136 and border pixel are window attributes which are "private to the
3137 client", so we can always change it to whatever we want. */
3138 BLOCK_INPUT;
3139 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3140 f->output_data.x->border_tile);
3141 UNBLOCK_INPUT;
3142 x_update_cursor (f, 1);
3145 /* The focus has changed. Update the frames as necessary to reflect
3146 the new situation. Note that we can't change the selected frame
3147 here, because the Lisp code we are interrupting might become confused.
3148 Each event gets marked with the frame in which it occurred, so the
3149 Lisp code can tell when the switch took place by examining the events. */
3151 static void
3152 x_new_focus_frame (dpyinfo, frame)
3153 struct x_display_info *dpyinfo;
3154 struct frame *frame;
3156 struct frame *old_focus = dpyinfo->x_focus_frame;
3158 if (frame != dpyinfo->x_focus_frame)
3160 /* Set this before calling other routines, so that they see
3161 the correct value of x_focus_frame. */
3162 dpyinfo->x_focus_frame = frame;
3164 if (old_focus && old_focus->auto_lower)
3165 x_lower_frame (old_focus);
3167 #if 0
3168 selected_frame = frame;
3169 XSETFRAME (XWINDOW (selected_frame->selected_window)->frame,
3170 selected_frame);
3171 Fselect_window (selected_frame->selected_window, Qnil);
3172 choose_minibuf_frame ();
3173 #endif /* ! 0 */
3175 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3176 pending_autoraise_frame = dpyinfo->x_focus_frame;
3177 else
3178 pending_autoraise_frame = 0;
3181 x_frame_rehighlight (dpyinfo);
3184 /* Handle FocusIn and FocusOut state changes for FRAME.
3185 If FRAME has focus and there exists more than one frame, puts
3186 a FOCUS_IN_EVENT into *BUFP. */
3188 static void
3189 x_focus_changed (type, state, dpyinfo, frame, bufp)
3190 int type;
3191 int state;
3192 struct x_display_info *dpyinfo;
3193 struct frame *frame;
3194 struct input_event *bufp;
3196 if (type == FocusIn)
3198 if (dpyinfo->x_focus_event_frame != frame)
3200 x_new_focus_frame (dpyinfo, frame);
3201 dpyinfo->x_focus_event_frame = frame;
3203 /* Don't stop displaying the initial startup message
3204 for a switch-frame event we don't need. */
3205 if (GC_NILP (Vterminal_frame)
3206 && GC_CONSP (Vframe_list)
3207 && !GC_NILP (XCDR (Vframe_list)))
3209 bufp->kind = FOCUS_IN_EVENT;
3210 XSETFRAME (bufp->frame_or_window, frame);
3214 frame->output_data.x->focus_state |= state;
3216 #ifdef HAVE_X_I18N
3217 if (FRAME_XIC (frame))
3218 XSetICFocus (FRAME_XIC (frame));
3219 #endif
3221 else if (type == FocusOut)
3223 frame->output_data.x->focus_state &= ~state;
3225 if (dpyinfo->x_focus_event_frame == frame)
3227 dpyinfo->x_focus_event_frame = 0;
3228 x_new_focus_frame (dpyinfo, 0);
3231 #ifdef HAVE_X_I18N
3232 if (FRAME_XIC (frame))
3233 XUnsetICFocus (FRAME_XIC (frame));
3234 #endif
3238 /* The focus may have changed. Figure out if it is a real focus change,
3239 by checking both FocusIn/Out and Enter/LeaveNotify events.
3241 Returns FOCUS_IN_EVENT event in *BUFP. */
3243 static void
3244 x_detect_focus_change (dpyinfo, event, bufp)
3245 struct x_display_info *dpyinfo;
3246 XEvent *event;
3247 struct input_event *bufp;
3249 struct frame *frame;
3251 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3252 if (! frame)
3253 return;
3255 switch (event->type)
3257 case EnterNotify:
3258 case LeaveNotify:
3260 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3261 int focus_state
3262 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3264 if (event->xcrossing.detail != NotifyInferior
3265 && event->xcrossing.focus
3266 && ! (focus_state & FOCUS_EXPLICIT))
3267 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3268 FOCUS_IMPLICIT,
3269 dpyinfo, frame, bufp);
3271 break;
3273 case FocusIn:
3274 case FocusOut:
3275 x_focus_changed (event->type,
3276 (event->xfocus.detail == NotifyPointer ?
3277 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3278 dpyinfo, frame, bufp);
3279 break;
3284 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3286 void
3287 x_mouse_leave (dpyinfo)
3288 struct x_display_info *dpyinfo;
3290 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3293 /* The focus has changed, or we have redirected a frame's focus to
3294 another frame (this happens when a frame uses a surrogate
3295 mini-buffer frame). Shift the highlight as appropriate.
3297 The FRAME argument doesn't necessarily have anything to do with which
3298 frame is being highlighted or un-highlighted; we only use it to find
3299 the appropriate X display info. */
3301 static void
3302 XTframe_rehighlight (frame)
3303 struct frame *frame;
3305 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3308 static void
3309 x_frame_rehighlight (dpyinfo)
3310 struct x_display_info *dpyinfo;
3312 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3314 if (dpyinfo->x_focus_frame)
3316 dpyinfo->x_highlight_frame
3317 = ((GC_FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3318 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3319 : dpyinfo->x_focus_frame);
3320 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3322 FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
3323 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3326 else
3327 dpyinfo->x_highlight_frame = 0;
3329 if (dpyinfo->x_highlight_frame != old_highlight)
3331 if (old_highlight)
3332 frame_unhighlight (old_highlight);
3333 if (dpyinfo->x_highlight_frame)
3334 frame_highlight (dpyinfo->x_highlight_frame);
3340 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3342 /* Initialize mode_switch_bit and modifier_meaning. */
3343 static void
3344 x_find_modifier_meanings (dpyinfo)
3345 struct x_display_info *dpyinfo;
3347 int min_code, max_code;
3348 KeySym *syms;
3349 int syms_per_code;
3350 XModifierKeymap *mods;
3352 dpyinfo->meta_mod_mask = 0;
3353 dpyinfo->shift_lock_mask = 0;
3354 dpyinfo->alt_mod_mask = 0;
3355 dpyinfo->super_mod_mask = 0;
3356 dpyinfo->hyper_mod_mask = 0;
3358 #ifdef HAVE_X11R4
3359 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3360 #else
3361 min_code = dpyinfo->display->min_keycode;
3362 max_code = dpyinfo->display->max_keycode;
3363 #endif
3365 syms = XGetKeyboardMapping (dpyinfo->display,
3366 min_code, max_code - min_code + 1,
3367 &syms_per_code);
3368 mods = XGetModifierMapping (dpyinfo->display);
3370 /* Scan the modifier table to see which modifier bits the Meta and
3371 Alt keysyms are on. */
3373 int row, col; /* The row and column in the modifier table. */
3374 int found_alt_or_meta;
3376 for (row = 3; row < 8; row++)
3378 found_alt_or_meta = 0;
3379 for (col = 0; col < mods->max_keypermod; col++)
3381 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3383 /* Zeroes are used for filler. Skip them. */
3384 if (code == 0)
3385 continue;
3387 /* Are any of this keycode's keysyms a meta key? */
3389 int code_col;
3391 for (code_col = 0; code_col < syms_per_code; code_col++)
3393 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3395 switch (sym)
3397 case XK_Meta_L:
3398 case XK_Meta_R:
3399 found_alt_or_meta = 1;
3400 dpyinfo->meta_mod_mask |= (1 << row);
3401 break;
3403 case XK_Alt_L:
3404 case XK_Alt_R:
3405 found_alt_or_meta = 1;
3406 dpyinfo->alt_mod_mask |= (1 << row);
3407 break;
3409 case XK_Hyper_L:
3410 case XK_Hyper_R:
3411 if (!found_alt_or_meta)
3412 dpyinfo->hyper_mod_mask |= (1 << row);
3413 code_col = syms_per_code;
3414 col = mods->max_keypermod;
3415 break;
3417 case XK_Super_L:
3418 case XK_Super_R:
3419 if (!found_alt_or_meta)
3420 dpyinfo->super_mod_mask |= (1 << row);
3421 code_col = syms_per_code;
3422 col = mods->max_keypermod;
3423 break;
3425 case XK_Shift_Lock:
3426 /* Ignore this if it's not on the lock modifier. */
3427 if (!found_alt_or_meta && ((1 << row) == LockMask))
3428 dpyinfo->shift_lock_mask = LockMask;
3429 code_col = syms_per_code;
3430 col = mods->max_keypermod;
3431 break;
3439 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3440 if (! dpyinfo->meta_mod_mask)
3442 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3443 dpyinfo->alt_mod_mask = 0;
3446 /* If some keys are both alt and meta,
3447 make them just meta, not alt. */
3448 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3450 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3453 XFree ((char *) syms);
3454 XFreeModifiermap (mods);
3457 /* Convert between the modifier bits X uses and the modifier bits
3458 Emacs uses. */
3460 static unsigned int
3461 x_x_to_emacs_modifiers (dpyinfo, state)
3462 struct x_display_info *dpyinfo;
3463 unsigned int state;
3465 EMACS_UINT mod_meta = meta_modifier;
3466 EMACS_UINT mod_alt = alt_modifier;
3467 EMACS_UINT mod_hyper = hyper_modifier;
3468 EMACS_UINT mod_super = super_modifier;
3469 Lisp_Object tem;
3471 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3472 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3473 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3474 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3475 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3476 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3477 tem = Fget (Vx_super_keysym, Qmodifier_value);
3478 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3481 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3482 | ((state & ControlMask) ? ctrl_modifier : 0)
3483 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3484 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3485 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3486 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3489 static unsigned int
3490 x_emacs_to_x_modifiers (dpyinfo, state)
3491 struct x_display_info *dpyinfo;
3492 unsigned int state;
3494 EMACS_UINT mod_meta = meta_modifier;
3495 EMACS_UINT mod_alt = alt_modifier;
3496 EMACS_UINT mod_hyper = hyper_modifier;
3497 EMACS_UINT mod_super = super_modifier;
3499 Lisp_Object tem;
3501 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3502 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3503 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3504 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3505 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3506 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3507 tem = Fget (Vx_super_keysym, Qmodifier_value);
3508 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3511 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3512 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3513 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3514 | ((state & shift_modifier) ? ShiftMask : 0)
3515 | ((state & ctrl_modifier) ? ControlMask : 0)
3516 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3519 /* Convert a keysym to its name. */
3521 char *
3522 x_get_keysym_name (keysym)
3523 KeySym keysym;
3525 char *value;
3527 BLOCK_INPUT;
3528 value = XKeysymToString (keysym);
3529 UNBLOCK_INPUT;
3531 return value;
3536 /* Mouse clicks and mouse movement. Rah. */
3538 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3540 If the event is a button press, then note that we have grabbed
3541 the mouse. */
3543 static Lisp_Object
3544 construct_mouse_click (result, event, f)
3545 struct input_event *result;
3546 XButtonEvent *event;
3547 struct frame *f;
3549 /* Make the event type NO_EVENT; we'll change that when we decide
3550 otherwise. */
3551 result->kind = MOUSE_CLICK_EVENT;
3552 result->code = event->button - Button1;
3553 result->timestamp = event->time;
3554 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3555 event->state)
3556 | (event->type == ButtonRelease
3557 ? up_modifier
3558 : down_modifier));
3560 XSETINT (result->x, event->x);
3561 XSETINT (result->y, event->y);
3562 XSETFRAME (result->frame_or_window, f);
3563 result->arg = Qnil;
3564 return Qnil;
3568 /* Function to report a mouse movement to the mainstream Emacs code.
3569 The input handler calls this.
3571 We have received a mouse movement event, which is given in *event.
3572 If the mouse is over a different glyph than it was last time, tell
3573 the mainstream emacs code by setting mouse_moved. If not, ask for
3574 another motion event, so we can check again the next time it moves. */
3576 static XMotionEvent last_mouse_motion_event;
3577 static Lisp_Object last_mouse_motion_frame;
3579 static void
3580 note_mouse_movement (frame, event)
3581 FRAME_PTR frame;
3582 XMotionEvent *event;
3584 last_mouse_movement_time = event->time;
3585 last_mouse_motion_event = *event;
3586 XSETFRAME (last_mouse_motion_frame, frame);
3588 if (event->window != FRAME_X_WINDOW (frame))
3590 frame->mouse_moved = 1;
3591 last_mouse_scroll_bar = Qnil;
3592 note_mouse_highlight (frame, -1, -1);
3595 /* Has the mouse moved off the glyph it was on at the last sighting? */
3596 else if (event->x < last_mouse_glyph.x
3597 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3598 || event->y < last_mouse_glyph.y
3599 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3601 frame->mouse_moved = 1;
3602 last_mouse_scroll_bar = Qnil;
3603 note_mouse_highlight (frame, event->x, event->y);
3608 /************************************************************************
3609 Mouse Face
3610 ************************************************************************/
3612 static void
3613 redo_mouse_highlight ()
3615 if (!NILP (last_mouse_motion_frame)
3616 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3617 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3618 last_mouse_motion_event.x,
3619 last_mouse_motion_event.y);
3623 static int glyph_rect P_ ((struct frame *f, int, int, XRectangle *));
3626 /* Try to determine frame pixel position and size of the glyph under
3627 frame pixel coordinates X/Y on frame F . Return the position and
3628 size in *RECT. Value is non-zero if we could compute these
3629 values. */
3631 static int
3632 glyph_rect (f, x, y, rect)
3633 struct frame *f;
3634 int x, y;
3635 XRectangle *rect;
3637 Lisp_Object window;
3638 struct window *w;
3639 struct glyph_row *r, *end_row;
3641 window = window_from_coordinates (f, x, y, 0, &x, &y, 0);
3642 if (NILP (window))
3643 return 0;
3645 w = XWINDOW (window);
3646 r = MATRIX_FIRST_TEXT_ROW (w->current_matrix);
3647 end_row = r + w->current_matrix->nrows - 1;
3649 for (; r < end_row && r->enabled_p; ++r)
3651 if (r->y >= y)
3653 struct glyph *g = r->glyphs[TEXT_AREA];
3654 struct glyph *end = g + r->used[TEXT_AREA];
3655 int gx = r->x;
3656 while (g < end && gx < x)
3657 gx += g->pixel_width, ++g;
3658 if (g < end)
3660 rect->width = g->pixel_width;
3661 rect->height = r->height;
3662 rect->x = WINDOW_TO_FRAME_PIXEL_X (w, gx);
3663 rect->y = WINDOW_TO_FRAME_PIXEL_Y (w, r->y);
3664 return 1;
3666 break;
3670 return 0;
3674 /* Return the current position of the mouse.
3675 *FP should be a frame which indicates which display to ask about.
3677 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3678 and *PART to the frame, window, and scroll bar part that the mouse
3679 is over. Set *X and *Y to the portion and whole of the mouse's
3680 position on the scroll bar.
3682 If the mouse movement started elsewhere, set *FP to the frame the
3683 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3684 the mouse is over.
3686 Set *TIME to the server time-stamp for the time at which the mouse
3687 was at this position.
3689 Don't store anything if we don't have a valid set of values to report.
3691 This clears the mouse_moved flag, so we can wait for the next mouse
3692 movement. */
3694 static void
3695 XTmouse_position (fp, insist, bar_window, part, x, y, time)
3696 FRAME_PTR *fp;
3697 int insist;
3698 Lisp_Object *bar_window;
3699 enum scroll_bar_part *part;
3700 Lisp_Object *x, *y;
3701 unsigned long *time;
3703 FRAME_PTR f1;
3705 BLOCK_INPUT;
3707 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3708 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time);
3709 else
3711 Window root;
3712 int root_x, root_y;
3714 Window dummy_window;
3715 int dummy;
3717 Lisp_Object frame, tail;
3719 /* Clear the mouse-moved flag for every frame on this display. */
3720 FOR_EACH_FRAME (tail, frame)
3721 if (FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3722 XFRAME (frame)->mouse_moved = 0;
3724 last_mouse_scroll_bar = Qnil;
3726 /* Figure out which root window we're on. */
3727 XQueryPointer (FRAME_X_DISPLAY (*fp),
3728 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3730 /* The root window which contains the pointer. */
3731 &root,
3733 /* Trash which we can't trust if the pointer is on
3734 a different screen. */
3735 &dummy_window,
3737 /* The position on that root window. */
3738 &root_x, &root_y,
3740 /* More trash we can't trust. */
3741 &dummy, &dummy,
3743 /* Modifier keys and pointer buttons, about which
3744 we don't care. */
3745 (unsigned int *) &dummy);
3747 /* Now we have a position on the root; find the innermost window
3748 containing the pointer. */
3750 Window win, child;
3751 int win_x, win_y;
3752 int parent_x = 0, parent_y = 0;
3753 int count;
3755 win = root;
3757 /* XTranslateCoordinates can get errors if the window
3758 structure is changing at the same time this function
3759 is running. So at least we must not crash from them. */
3761 count = x_catch_errors (FRAME_X_DISPLAY (*fp));
3763 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3764 && FRAME_LIVE_P (last_mouse_frame))
3766 /* If mouse was grabbed on a frame, give coords for that frame
3767 even if the mouse is now outside it. */
3768 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3770 /* From-window, to-window. */
3771 root, FRAME_X_WINDOW (last_mouse_frame),
3773 /* From-position, to-position. */
3774 root_x, root_y, &win_x, &win_y,
3776 /* Child of win. */
3777 &child);
3778 f1 = last_mouse_frame;
3780 else
3782 while (1)
3784 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3786 /* From-window, to-window. */
3787 root, win,
3789 /* From-position, to-position. */
3790 root_x, root_y, &win_x, &win_y,
3792 /* Child of win. */
3793 &child);
3795 if (child == None || child == win)
3796 break;
3798 win = child;
3799 parent_x = win_x;
3800 parent_y = win_y;
3803 /* Now we know that:
3804 win is the innermost window containing the pointer
3805 (XTC says it has no child containing the pointer),
3806 win_x and win_y are the pointer's position in it
3807 (XTC did this the last time through), and
3808 parent_x and parent_y are the pointer's position in win's parent.
3809 (They are what win_x and win_y were when win was child.
3810 If win is the root window, it has no parent, and
3811 parent_{x,y} are invalid, but that's okay, because we'll
3812 never use them in that case.) */
3814 /* Is win one of our frames? */
3815 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3817 #ifdef USE_X_TOOLKIT
3818 /* If we end up with the menu bar window, say it's not
3819 on the frame. */
3820 if (f1 != NULL
3821 && f1->output_data.x->menubar_widget
3822 && win == XtWindow (f1->output_data.x->menubar_widget))
3823 f1 = NULL;
3824 #endif /* USE_X_TOOLKIT */
3827 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
3828 f1 = 0;
3830 x_uncatch_errors (FRAME_X_DISPLAY (*fp), count);
3832 /* If not, is it one of our scroll bars? */
3833 if (! f1)
3835 struct scroll_bar *bar;
3837 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
3839 if (bar)
3841 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3842 win_x = parent_x;
3843 win_y = parent_y;
3847 if (f1 == 0 && insist > 0)
3848 f1 = SELECTED_FRAME ();
3850 if (f1)
3852 /* Ok, we found a frame. Store all the values.
3853 last_mouse_glyph is a rectangle used to reduce the
3854 generation of mouse events. To not miss any motion
3855 events, we must divide the frame into rectangles of the
3856 size of the smallest character that could be displayed
3857 on it, i.e. into the same rectangles that matrices on
3858 the frame are divided into. */
3860 int width, height, gx, gy;
3861 XRectangle rect;
3863 if (glyph_rect (f1, win_x, win_y, &rect))
3864 last_mouse_glyph = rect;
3865 else
3867 width = FRAME_SMALLEST_CHAR_WIDTH (f1);
3868 height = FRAME_SMALLEST_FONT_HEIGHT (f1);
3869 gx = win_x;
3870 gy = win_y;
3872 /* Arrange for the division in FRAME_PIXEL_X_TO_COL etc. to
3873 round down even for negative values. */
3874 if (gx < 0)
3875 gx -= width - 1;
3876 if (gy < 0)
3877 gy -= height - 1;
3878 gx = (gx + width - 1) / width * width;
3879 gy = (gy + height - 1) / height * height;
3881 last_mouse_glyph.width = width;
3882 last_mouse_glyph.height = height;
3883 last_mouse_glyph.x = gx;
3884 last_mouse_glyph.y = gy;
3887 *bar_window = Qnil;
3888 *part = 0;
3889 *fp = f1;
3890 XSETINT (*x, win_x);
3891 XSETINT (*y, win_y);
3892 *time = last_mouse_movement_time;
3897 UNBLOCK_INPUT;
3902 /***********************************************************************
3903 Scroll bars
3904 ***********************************************************************/
3906 /* Scroll bar support. */
3908 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
3909 manages it.
3910 This can be called in GC, so we have to make sure to strip off mark
3911 bits. */
3913 static struct scroll_bar *
3914 x_window_to_scroll_bar (display, window_id)
3915 Display *display;
3916 Window window_id;
3918 Lisp_Object tail;
3920 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3921 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
3922 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
3924 for (tail = Vframe_list;
3925 XGCTYPE (tail) == Lisp_Cons;
3926 tail = XCDR (tail))
3928 Lisp_Object frame, bar, condemned;
3930 frame = XCAR (tail);
3931 /* All elements of Vframe_list should be frames. */
3932 if (! GC_FRAMEP (frame))
3933 abort ();
3935 /* Scan this frame's scroll bar list for a scroll bar with the
3936 right window ID. */
3937 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
3938 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
3939 /* This trick allows us to search both the ordinary and
3940 condemned scroll bar lists with one loop. */
3941 ! GC_NILP (bar) || (bar = condemned,
3942 condemned = Qnil,
3943 ! GC_NILP (bar));
3944 bar = XSCROLL_BAR (bar)->next)
3945 if (SCROLL_BAR_X_WINDOW (XSCROLL_BAR (bar)) == window_id &&
3946 FRAME_X_DISPLAY (XFRAME (frame)) == display)
3947 return XSCROLL_BAR (bar);
3950 return 0;
3954 #if defined USE_LUCID
3956 /* Return the Lucid menu bar WINDOW is part of. Return null
3957 if WINDOW is not part of a menu bar. */
3959 static Widget
3960 x_window_to_menu_bar (window)
3961 Window window;
3963 Lisp_Object tail;
3965 for (tail = Vframe_list;
3966 XGCTYPE (tail) == Lisp_Cons;
3967 tail = XCDR (tail))
3969 Lisp_Object frame = XCAR (tail);
3970 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
3972 if (menu_bar && xlwmenu_window_p (menu_bar, window))
3973 return menu_bar;
3976 return NULL;
3979 #endif /* USE_LUCID */
3982 /************************************************************************
3983 Toolkit scroll bars
3984 ************************************************************************/
3986 #ifdef USE_TOOLKIT_SCROLL_BARS
3988 static void x_scroll_bar_to_input_event P_ ((XEvent *, struct input_event *));
3989 static void x_send_scroll_bar_event P_ ((Lisp_Object, int, int, int));
3990 static void x_create_toolkit_scroll_bar P_ ((struct frame *,
3991 struct scroll_bar *));
3992 static void x_set_toolkit_scroll_bar_thumb P_ ((struct scroll_bar *,
3993 int, int, int));
3996 /* Lisp window being scrolled. Set when starting to interact with
3997 a toolkit scroll bar, reset to nil when ending the interaction. */
3999 static Lisp_Object window_being_scrolled;
4001 /* Last scroll bar part sent in xm_scroll_callback. */
4003 static int last_scroll_bar_part;
4005 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4006 that movements of 1/20 of the screen size are mapped to up/down. */
4008 #ifndef USE_GTK
4009 /* Id of action hook installed for scroll bars. */
4011 static XtActionHookId action_hook_id;
4013 static Boolean xaw3d_arrow_scroll;
4015 /* Whether the drag scrolling maintains the mouse at the top of the
4016 thumb. If not, resizing the thumb needs to be done more carefully
4017 to avoid jerkyness. */
4019 static Boolean xaw3d_pick_top;
4021 extern void set_vertical_scroll_bar P_ ((struct window *));
4023 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4024 bars are used.. The hook is responsible for detecting when
4025 the user ends an interaction with the scroll bar, and generates
4026 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4028 static void
4029 xt_action_hook (widget, client_data, action_name, event, params,
4030 num_params)
4031 Widget widget;
4032 XtPointer client_data;
4033 String action_name;
4034 XEvent *event;
4035 String *params;
4036 Cardinal *num_params;
4038 int scroll_bar_p;
4039 char *end_action;
4041 #ifdef USE_MOTIF
4042 scroll_bar_p = XmIsScrollBar (widget);
4043 end_action = "Release";
4044 #else /* !USE_MOTIF i.e. use Xaw */
4045 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4046 end_action = "EndScroll";
4047 #endif /* USE_MOTIF */
4049 if (scroll_bar_p
4050 && strcmp (action_name, end_action) == 0
4051 && WINDOWP (window_being_scrolled))
4053 struct window *w;
4055 x_send_scroll_bar_event (window_being_scrolled,
4056 scroll_bar_end_scroll, 0, 0);
4057 w = XWINDOW (window_being_scrolled);
4059 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4061 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4062 /* The thumb size is incorrect while dragging: fix it. */
4063 set_vertical_scroll_bar (w);
4065 window_being_scrolled = Qnil;
4066 last_scroll_bar_part = -1;
4068 /* Xt timeouts no longer needed. */
4069 toolkit_scroll_bar_interaction = 0;
4072 #endif /* not USE_GTK */
4074 /* A vector of windows used for communication between
4075 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4077 static struct window **scroll_bar_windows;
4078 static int scroll_bar_windows_size;
4081 /* Send a client message with message type Xatom_Scrollbar for a
4082 scroll action to the frame of WINDOW. PART is a value identifying
4083 the part of the scroll bar that was clicked on. PORTION is the
4084 amount to scroll of a whole of WHOLE. */
4086 static void
4087 x_send_scroll_bar_event (window, part, portion, whole)
4088 Lisp_Object window;
4089 int part, portion, whole;
4091 XEvent event;
4092 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4093 struct window *w = XWINDOW (window);
4094 struct frame *f = XFRAME (w->frame);
4095 int i;
4097 BLOCK_INPUT;
4099 /* Construct a ClientMessage event to send to the frame. */
4100 ev->type = ClientMessage;
4101 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4102 ev->display = FRAME_X_DISPLAY (f);
4103 ev->window = FRAME_X_WINDOW (f);
4104 ev->format = 32;
4106 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4107 not enough to store a pointer or Lisp_Object on a 64 bit system.
4108 So, store the window in scroll_bar_windows and pass the index
4109 into that array in the event. */
4110 for (i = 0; i < scroll_bar_windows_size; ++i)
4111 if (scroll_bar_windows[i] == NULL)
4112 break;
4114 if (i == scroll_bar_windows_size)
4116 int new_size = max (10, 2 * scroll_bar_windows_size);
4117 size_t nbytes = new_size * sizeof *scroll_bar_windows;
4118 size_t old_nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4120 scroll_bar_windows = (struct window **) xrealloc (scroll_bar_windows,
4121 nbytes);
4122 bzero (&scroll_bar_windows[i], nbytes - old_nbytes);
4123 scroll_bar_windows_size = new_size;
4126 scroll_bar_windows[i] = w;
4127 ev->data.l[0] = (long) i;
4128 ev->data.l[1] = (long) part;
4129 ev->data.l[2] = (long) 0;
4130 ev->data.l[3] = (long) portion;
4131 ev->data.l[4] = (long) whole;
4133 /* Make Xt timeouts work while the scroll bar is active. */
4134 toolkit_scroll_bar_interaction = 1;
4136 /* Setting the event mask to zero means that the message will
4137 be sent to the client that created the window, and if that
4138 window no longer exists, no event will be sent. */
4139 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4140 UNBLOCK_INPUT;
4144 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4145 in *IEVENT. */
4147 static void
4148 x_scroll_bar_to_input_event (event, ievent)
4149 XEvent *event;
4150 struct input_event *ievent;
4152 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4153 Lisp_Object window;
4154 struct frame *f;
4155 struct window *w;
4157 w = scroll_bar_windows[ev->data.l[0]];
4158 scroll_bar_windows[ev->data.l[0]] = NULL;
4160 XSETWINDOW (window, w);
4161 f = XFRAME (w->frame);
4163 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4164 ievent->frame_or_window = window;
4165 ievent->arg = Qnil;
4166 #ifdef USE_GTK
4167 ievent->timestamp = CurrentTime;
4168 #else
4169 ievent->timestamp = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
4170 #endif
4171 ievent->part = ev->data.l[1];
4172 ievent->code = ev->data.l[2];
4173 ievent->x = make_number ((int) ev->data.l[3]);
4174 ievent->y = make_number ((int) ev->data.l[4]);
4175 ievent->modifiers = 0;
4179 #ifdef USE_MOTIF
4181 /* Minimum and maximum values used for Motif scroll bars. */
4183 #define XM_SB_MAX 10000000
4186 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4187 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4188 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4190 static void
4191 xm_scroll_callback (widget, client_data, call_data)
4192 Widget widget;
4193 XtPointer client_data, call_data;
4195 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4196 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4197 int part = -1, whole = 0, portion = 0;
4199 switch (cs->reason)
4201 case XmCR_DECREMENT:
4202 bar->dragging = Qnil;
4203 part = scroll_bar_up_arrow;
4204 break;
4206 case XmCR_INCREMENT:
4207 bar->dragging = Qnil;
4208 part = scroll_bar_down_arrow;
4209 break;
4211 case XmCR_PAGE_DECREMENT:
4212 bar->dragging = Qnil;
4213 part = scroll_bar_above_handle;
4214 break;
4216 case XmCR_PAGE_INCREMENT:
4217 bar->dragging = Qnil;
4218 part = scroll_bar_below_handle;
4219 break;
4221 case XmCR_TO_TOP:
4222 bar->dragging = Qnil;
4223 part = scroll_bar_to_top;
4224 break;
4226 case XmCR_TO_BOTTOM:
4227 bar->dragging = Qnil;
4228 part = scroll_bar_to_bottom;
4229 break;
4231 case XmCR_DRAG:
4233 int slider_size;
4235 /* Get the slider size. */
4236 BLOCK_INPUT;
4237 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4238 UNBLOCK_INPUT;
4240 whole = XM_SB_MAX - slider_size;
4241 portion = min (cs->value, whole);
4242 part = scroll_bar_handle;
4243 bar->dragging = make_number (cs->value);
4245 break;
4247 case XmCR_VALUE_CHANGED:
4248 break;
4251 if (part >= 0)
4253 window_being_scrolled = bar->window;
4254 last_scroll_bar_part = part;
4255 x_send_scroll_bar_event (bar->window, part, portion, whole);
4260 #else /* !USE_MOTIF, i.e. Xaw or GTK */
4261 #ifdef USE_GTK
4262 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4263 bar widget. DATA is a pointer to the scroll_bar structure. */
4265 static void
4266 xg_scroll_callback (widget, data)
4267 GtkRange *widget;
4268 gpointer data;
4270 struct scroll_bar *bar = (struct scroll_bar *) data;
4271 gdouble previous;
4272 gdouble position;
4273 gdouble *p;
4274 int diff;
4276 int part = -1, whole = 0, portion = 0;
4277 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (widget));
4279 position = gtk_adjustment_get_value (adj);
4281 p = g_object_get_data (G_OBJECT (widget), XG_LAST_SB_DATA);
4282 if (! p)
4284 p = (gdouble*) xmalloc (sizeof (gdouble));
4285 *p = XG_SB_MIN;
4286 g_object_set_data (G_OBJECT (widget), XG_LAST_SB_DATA, p);
4289 previous = *p;
4290 *p = position;
4292 if (xg_ignore_gtk_scrollbar) return;
4294 diff = (int) (position - previous);
4296 if (diff == (int) adj->step_increment)
4298 part = scroll_bar_down_arrow;
4299 bar->dragging = Qnil;
4301 else if (-diff == (int) adj->step_increment)
4303 part = scroll_bar_up_arrow;
4304 bar->dragging = Qnil;
4306 else if (diff == (int) adj->page_increment)
4308 part = scroll_bar_below_handle;
4309 bar->dragging = Qnil;
4311 else if (-diff == (int) adj->page_increment)
4313 part = scroll_bar_above_handle;
4314 bar->dragging = Qnil;
4316 else
4318 part = scroll_bar_handle;
4319 whole = adj->upper - adj->page_size;
4320 portion = min ((int)position, whole);
4321 bar->dragging = make_number ((int)portion);
4324 if (part >= 0)
4326 window_being_scrolled = bar->window;
4327 last_scroll_bar_part = part;
4328 x_send_scroll_bar_event (bar->window, part, portion, whole);
4332 #else /* not USE_GTK */
4334 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4335 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4336 scroll bar struct. CALL_DATA is a pointer to a float saying where
4337 the thumb is. */
4339 static void
4340 xaw_jump_callback (widget, client_data, call_data)
4341 Widget widget;
4342 XtPointer client_data, call_data;
4344 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4345 float top = *(float *) call_data;
4346 float shown;
4347 int whole, portion, height;
4348 int part;
4350 /* Get the size of the thumb, a value between 0 and 1. */
4351 BLOCK_INPUT;
4352 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4353 UNBLOCK_INPUT;
4355 whole = 10000000;
4356 portion = shown < 1 ? top * whole : 0;
4358 if (shown < 1 && (abs (top + shown - 1) < 1.0/height))
4359 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4360 the bottom, so we force the scrolling whenever we see that we're
4361 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4362 we try to ensure that we always stay two pixels away from the
4363 bottom). */
4364 part = scroll_bar_down_arrow;
4365 else
4366 part = scroll_bar_handle;
4368 window_being_scrolled = bar->window;
4369 bar->dragging = make_number (portion);
4370 last_scroll_bar_part = part;
4371 x_send_scroll_bar_event (bar->window, part, portion, whole);
4375 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4376 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4377 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4378 the scroll bar. CALL_DATA is an integer specifying the action that
4379 has taken place. Its magnitude is in the range 0..height of the
4380 scroll bar. Negative values mean scroll towards buffer start.
4381 Values < height of scroll bar mean line-wise movement. */
4383 static void
4384 xaw_scroll_callback (widget, client_data, call_data)
4385 Widget widget;
4386 XtPointer client_data, call_data;
4388 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4389 /* The position really is stored cast to a pointer. */
4390 int position = (long) call_data;
4391 Dimension height;
4392 int part;
4394 /* Get the height of the scroll bar. */
4395 BLOCK_INPUT;
4396 XtVaGetValues (widget, XtNheight, &height, NULL);
4397 UNBLOCK_INPUT;
4399 if (abs (position) >= height)
4400 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4402 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4403 it maps line-movement to call_data = max(5, height/20). */
4404 else if (xaw3d_arrow_scroll && abs (position) <= max (5, height / 20))
4405 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4406 else
4407 part = scroll_bar_move_ratio;
4409 window_being_scrolled = bar->window;
4410 bar->dragging = Qnil;
4411 last_scroll_bar_part = part;
4412 x_send_scroll_bar_event (bar->window, part, position, height);
4415 #endif /* not USE_GTK */
4416 #endif /* not USE_MOTIF */
4418 #define SCROLL_BAR_NAME "verticalScrollBar"
4420 /* Create the widget for scroll bar BAR on frame F. Record the widget
4421 and X window of the scroll bar in BAR. */
4423 #ifdef USE_GTK
4424 static void
4425 x_create_toolkit_scroll_bar (f, bar)
4426 struct frame *f;
4427 struct scroll_bar *bar;
4429 char *scroll_bar_name = SCROLL_BAR_NAME;
4431 BLOCK_INPUT;
4432 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4433 scroll_bar_name);
4434 UNBLOCK_INPUT;
4437 #else /* not USE_GTK */
4439 static void
4440 x_create_toolkit_scroll_bar (f, bar)
4441 struct frame *f;
4442 struct scroll_bar *bar;
4444 Window xwindow;
4445 Widget widget;
4446 Arg av[20];
4447 int ac = 0;
4448 char *scroll_bar_name = SCROLL_BAR_NAME;
4449 unsigned long pixel;
4451 BLOCK_INPUT;
4453 #ifdef USE_MOTIF
4454 /* Set resources. Create the widget. */
4455 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4456 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4457 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4458 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4459 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4460 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4461 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4463 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4464 if (pixel != -1)
4466 XtSetArg (av[ac], XmNforeground, pixel);
4467 ++ac;
4470 pixel = f->output_data.x->scroll_bar_background_pixel;
4471 if (pixel != -1)
4473 XtSetArg (av[ac], XmNbackground, pixel);
4474 ++ac;
4477 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4478 scroll_bar_name, av, ac);
4480 /* Add one callback for everything that can happen. */
4481 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4482 (XtPointer) bar);
4483 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4484 (XtPointer) bar);
4485 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4486 (XtPointer) bar);
4487 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4488 (XtPointer) bar);
4489 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4490 (XtPointer) bar);
4491 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4492 (XtPointer) bar);
4493 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4494 (XtPointer) bar);
4496 /* Realize the widget. Only after that is the X window created. */
4497 XtRealizeWidget (widget);
4499 /* Set the cursor to an arrow. I didn't find a resource to do that.
4500 And I'm wondering why it hasn't an arrow cursor by default. */
4501 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4502 f->output_data.x->nontext_cursor);
4504 #else /* !USE_MOTIF i.e. use Xaw */
4506 /* Set resources. Create the widget. The background of the
4507 Xaw3d scroll bar widget is a little bit light for my taste.
4508 We don't alter it here to let users change it according
4509 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4510 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4511 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4512 /* For smoother scrolling with Xaw3d -sm */
4513 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4515 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4516 if (pixel != -1)
4518 XtSetArg (av[ac], XtNforeground, pixel);
4519 ++ac;
4522 pixel = f->output_data.x->scroll_bar_background_pixel;
4523 if (pixel != -1)
4525 XtSetArg (av[ac], XtNbackground, pixel);
4526 ++ac;
4529 /* Top/bottom shadow colors. */
4531 /* Allocate them, if necessary. */
4532 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4534 pixel = f->output_data.x->scroll_bar_background_pixel;
4535 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
4536 &pixel, 1.2, 0x8000))
4537 pixel = -1;
4538 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4540 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4542 pixel = f->output_data.x->scroll_bar_background_pixel;
4543 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
4544 &pixel, 0.6, 0x4000))
4545 pixel = -1;
4546 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4549 #ifdef XtNbeNiceToColormap
4550 /* Tell the toolkit about them. */
4551 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4552 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4553 /* We tried to allocate a color for the top/bottom shadow, and
4554 failed, so tell Xaw3d to use dithering instead. */
4556 XtSetArg (av[ac], XtNbeNiceToColormap, True);
4557 ++ac;
4559 else
4560 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4561 be more consistent with other emacs 3d colors, and since Xaw3d is
4562 not good at dealing with allocation failure. */
4564 /* This tells Xaw3d to use real colors instead of dithering for
4565 the shadows. */
4566 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4567 ++ac;
4569 /* Specify the colors. */
4570 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4571 if (pixel != -1)
4573 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4574 ++ac;
4576 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4577 if (pixel != -1)
4579 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4580 ++ac;
4583 #endif
4585 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4586 f->output_data.x->edit_widget, av, ac);
4589 char *initial = "";
4590 char *val = initial;
4591 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4592 #ifdef XtNarrowScrollbars
4593 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4594 #endif
4595 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4596 if (xaw3d_arrow_scroll || val == initial)
4597 { /* ARROW_SCROLL */
4598 xaw3d_arrow_scroll = True;
4599 /* Isn't that just a personal preference ? --Stef */
4600 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4604 /* Define callbacks. */
4605 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4606 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4607 (XtPointer) bar);
4609 /* Realize the widget. Only after that is the X window created. */
4610 XtRealizeWidget (widget);
4612 #endif /* !USE_MOTIF */
4614 /* Install an action hook that lets us detect when the user
4615 finishes interacting with a scroll bar. */
4616 if (action_hook_id == 0)
4617 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4619 /* Remember X window and widget in the scroll bar vector. */
4620 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4621 xwindow = XtWindow (widget);
4622 SET_SCROLL_BAR_X_WINDOW (bar, xwindow);
4624 UNBLOCK_INPUT;
4626 #endif /* not USE_GTK */
4629 /* Set the thumb size and position of scroll bar BAR. We are currently
4630 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4632 #ifdef USE_GTK
4633 static void
4634 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4635 struct scroll_bar *bar;
4636 int portion, position, whole;
4638 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4641 #else /* not USE_GTK */
4642 static void
4643 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4644 struct scroll_bar *bar;
4645 int portion, position, whole;
4647 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4648 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4649 float top, shown;
4651 BLOCK_INPUT;
4653 #ifdef USE_MOTIF
4655 /* We use an estimate of 30 chars per line rather than the real
4656 `portion' value. This has the disadvantage that the thumb size
4657 is not very representative, but it makes our life a lot easier.
4658 Otherwise, we have to constantly adjust the thumb size, which
4659 we can't always do quickly enough: while dragging, the size of
4660 the thumb might prevent the user from dragging the thumb all the
4661 way to the end. but Motif and some versions of Xaw3d don't allow
4662 updating the thumb size while dragging. Also, even if we can update
4663 its size, the update will often happen too late.
4664 If you don't believe it, check out revision 1.650 of xterm.c to see
4665 what hoops we were going through and the still poor behavior we got. */
4666 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4667 /* When the thumb is at the bottom, position == whole.
4668 So we need to increase `whole' to make space for the thumb. */
4669 whole += portion;
4671 if (whole <= 0)
4672 top = 0, shown = 1;
4673 else
4675 top = (float) position / whole;
4676 shown = (float) portion / whole;
4679 if (NILP (bar->dragging))
4681 int size, value;
4683 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4684 is the scroll bar's maximum and MIN is the scroll bar's minimum
4685 value. */
4686 size = shown * XM_SB_MAX;
4687 size = min (size, XM_SB_MAX);
4688 size = max (size, 1);
4690 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4691 value = top * XM_SB_MAX;
4692 value = min (value, XM_SB_MAX - size);
4694 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4696 #else /* !USE_MOTIF i.e. use Xaw */
4698 if (whole == 0)
4699 top = 0, shown = 1;
4700 else
4702 top = (float) position / whole;
4703 shown = (float) portion / whole;
4707 float old_top, old_shown;
4708 Dimension height;
4709 XtVaGetValues (widget,
4710 XtNtopOfThumb, &old_top,
4711 XtNshown, &old_shown,
4712 XtNheight, &height,
4713 NULL);
4715 /* Massage the top+shown values. */
4716 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4717 top = max (0, min (1, top));
4718 else
4719 top = old_top;
4720 /* Keep two pixels available for moving the thumb down. */
4721 shown = max (0, min (1 - top - (2.0 / height), shown));
4723 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4724 check that your system's configuration file contains a define
4725 for `NARROWPROTO'. See s/freebsd.h for an example. */
4726 if (top != old_top || shown != old_shown)
4728 if (NILP (bar->dragging))
4729 XawScrollbarSetThumb (widget, top, shown);
4730 else
4732 /* Try to make the scrolling a tad smoother. */
4733 if (!xaw3d_pick_top)
4734 shown = min (shown, old_shown);
4736 XawScrollbarSetThumb (widget, top, shown);
4740 #endif /* !USE_MOTIF */
4742 UNBLOCK_INPUT;
4744 #endif /* not USE_GTK */
4746 #endif /* USE_TOOLKIT_SCROLL_BARS */
4750 /************************************************************************
4751 Scroll bars, general
4752 ************************************************************************/
4754 /* Create a scroll bar and return the scroll bar vector for it. W is
4755 the Emacs window on which to create the scroll bar. TOP, LEFT,
4756 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4757 scroll bar. */
4759 static struct scroll_bar *
4760 x_scroll_bar_create (w, top, left, width, height)
4761 struct window *w;
4762 int top, left, width, height;
4764 struct frame *f = XFRAME (w->frame);
4765 struct scroll_bar *bar
4766 = XSCROLL_BAR (Fmake_vector (make_number (SCROLL_BAR_VEC_SIZE), Qnil));
4768 BLOCK_INPUT;
4770 #ifdef USE_TOOLKIT_SCROLL_BARS
4771 x_create_toolkit_scroll_bar (f, bar);
4772 #else /* not USE_TOOLKIT_SCROLL_BARS */
4774 XSetWindowAttributes a;
4775 unsigned long mask;
4776 Window window;
4778 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4779 if (a.background_pixel == -1)
4780 a.background_pixel = f->output_data.x->background_pixel;
4782 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4783 | ButtonMotionMask | PointerMotionHintMask
4784 | ExposureMask);
4785 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4787 mask = (CWBackPixel | CWEventMask | CWCursor);
4789 /* Clear the area of W that will serve as a scroll bar. This is
4790 for the case that a window has been split horizontally. In
4791 this case, no clear_frame is generated to reduce flickering. */
4792 if (width > 0 && height > 0)
4793 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4794 left, top, width,
4795 window_box_height (w), False);
4797 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4798 /* Position and size of scroll bar. */
4799 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4800 top,
4801 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4802 height,
4803 /* Border width, depth, class, and visual. */
4805 CopyFromParent,
4806 CopyFromParent,
4807 CopyFromParent,
4808 /* Attributes. */
4809 mask, &a);
4810 SET_SCROLL_BAR_X_WINDOW (bar, window);
4812 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4814 XSETWINDOW (bar->window, w);
4815 XSETINT (bar->top, top);
4816 XSETINT (bar->left, left);
4817 XSETINT (bar->width, width);
4818 XSETINT (bar->height, height);
4819 XSETINT (bar->start, 0);
4820 XSETINT (bar->end, 0);
4821 bar->dragging = Qnil;
4823 /* Add bar to its frame's list of scroll bars. */
4824 bar->next = FRAME_SCROLL_BARS (f);
4825 bar->prev = Qnil;
4826 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4827 if (!NILP (bar->next))
4828 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4830 /* Map the window/widget. */
4831 #ifdef USE_TOOLKIT_SCROLL_BARS
4833 #ifdef USE_GTK
4834 xg_update_scrollbar_pos (f,
4835 SCROLL_BAR_X_WINDOW (bar),
4836 top,
4837 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4838 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4839 max (height, 1));
4840 xg_show_scroll_bar (SCROLL_BAR_X_WINDOW (bar));
4841 #else /* not USE_GTK */
4842 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4843 XtConfigureWidget (scroll_bar,
4844 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4845 top,
4846 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4847 max (height, 1), 0);
4848 XtMapWidget (scroll_bar);
4849 #endif /* not USE_GTK */
4851 #else /* not USE_TOOLKIT_SCROLL_BARS */
4852 XMapRaised (FRAME_X_DISPLAY (f), SCROLL_BAR_X_WINDOW (bar));
4853 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4855 UNBLOCK_INPUT;
4856 return bar;
4860 /* Draw BAR's handle in the proper position.
4862 If the handle is already drawn from START to END, don't bother
4863 redrawing it, unless REBUILD is non-zero; in that case, always
4864 redraw it. (REBUILD is handy for drawing the handle after expose
4865 events.)
4867 Normally, we want to constrain the start and end of the handle to
4868 fit inside its rectangle, but if the user is dragging the scroll
4869 bar handle, we want to let them drag it down all the way, so that
4870 the bar's top is as far down as it goes; otherwise, there's no way
4871 to move to the very end of the buffer. */
4873 #ifndef USE_TOOLKIT_SCROLL_BARS
4875 static void
4876 x_scroll_bar_set_handle (bar, start, end, rebuild)
4877 struct scroll_bar *bar;
4878 int start, end;
4879 int rebuild;
4881 int dragging = ! NILP (bar->dragging);
4882 Window w = SCROLL_BAR_X_WINDOW (bar);
4883 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4884 GC gc = f->output_data.x->normal_gc;
4886 /* If the display is already accurate, do nothing. */
4887 if (! rebuild
4888 && start == XINT (bar->start)
4889 && end == XINT (bar->end))
4890 return;
4892 BLOCK_INPUT;
4895 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, XINT (bar->width));
4896 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, XINT (bar->height));
4897 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, XINT (bar->height));
4899 /* Make sure the values are reasonable, and try to preserve
4900 the distance between start and end. */
4902 int length = end - start;
4904 if (start < 0)
4905 start = 0;
4906 else if (start > top_range)
4907 start = top_range;
4908 end = start + length;
4910 if (end < start)
4911 end = start;
4912 else if (end > top_range && ! dragging)
4913 end = top_range;
4916 /* Store the adjusted setting in the scroll bar. */
4917 XSETINT (bar->start, start);
4918 XSETINT (bar->end, end);
4920 /* Clip the end position, just for display. */
4921 if (end > top_range)
4922 end = top_range;
4924 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
4925 below top positions, to make sure the handle is always at least
4926 that many pixels tall. */
4927 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
4929 /* Draw the empty space above the handle. Note that we can't clear
4930 zero-height areas; that means "clear to end of window." */
4931 if (0 < start)
4932 x_clear_area (FRAME_X_DISPLAY (f), w,
4933 /* x, y, width, height, and exposures. */
4934 VERTICAL_SCROLL_BAR_LEFT_BORDER,
4935 VERTICAL_SCROLL_BAR_TOP_BORDER,
4936 inside_width, start,
4937 False);
4939 /* Change to proper foreground color if one is specified. */
4940 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
4941 XSetForeground (FRAME_X_DISPLAY (f), gc,
4942 f->output_data.x->scroll_bar_foreground_pixel);
4944 /* Draw the handle itself. */
4945 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
4946 /* x, y, width, height */
4947 VERTICAL_SCROLL_BAR_LEFT_BORDER,
4948 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
4949 inside_width, end - start);
4951 /* Restore the foreground color of the GC if we changed it above. */
4952 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
4953 XSetForeground (FRAME_X_DISPLAY (f), gc,
4954 f->output_data.x->foreground_pixel);
4956 /* Draw the empty space below the handle. Note that we can't
4957 clear zero-height areas; that means "clear to end of window." */
4958 if (end < inside_height)
4959 x_clear_area (FRAME_X_DISPLAY (f), w,
4960 /* x, y, width, height, and exposures. */
4961 VERTICAL_SCROLL_BAR_LEFT_BORDER,
4962 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
4963 inside_width, inside_height - end,
4964 False);
4968 UNBLOCK_INPUT;
4971 #endif /* !USE_TOOLKIT_SCROLL_BARS */
4973 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
4974 nil. */
4976 static void
4977 x_scroll_bar_remove (bar)
4978 struct scroll_bar *bar;
4980 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4981 BLOCK_INPUT;
4983 #ifdef USE_TOOLKIT_SCROLL_BARS
4984 #ifdef USE_GTK
4985 xg_remove_scroll_bar (f, SCROLL_BAR_X_WINDOW (bar));
4986 #else /* not USE_GTK */
4987 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
4988 #endif /* not USE_GTK */
4989 #else
4990 XDestroyWindow (FRAME_X_DISPLAY (f), SCROLL_BAR_X_WINDOW (bar));
4991 #endif
4993 /* Disassociate this scroll bar from its window. */
4994 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
4996 UNBLOCK_INPUT;
5000 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5001 that we are displaying PORTION characters out of a total of WHOLE
5002 characters, starting at POSITION. If WINDOW has no scroll bar,
5003 create one. */
5005 static void
5006 XTset_vertical_scroll_bar (w, portion, whole, position)
5007 struct window *w;
5008 int portion, whole, position;
5010 struct frame *f = XFRAME (w->frame);
5011 struct scroll_bar *bar;
5012 int top, height, left, sb_left, width, sb_width;
5013 int window_y, window_height;
5015 /* Get window dimensions. */
5016 window_box (w, -1, 0, &window_y, 0, &window_height);
5017 top = window_y;
5018 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5019 height = window_height;
5021 /* Compute the left edge of the scroll bar area. */
5022 left = WINDOW_SCROLL_BAR_AREA_X (w);
5024 /* Compute the width of the scroll bar which might be less than
5025 the width of the area reserved for the scroll bar. */
5026 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5027 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5028 else
5029 sb_width = width;
5031 /* Compute the left edge of the scroll bar. */
5032 #ifdef USE_TOOLKIT_SCROLL_BARS
5033 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5034 sb_left = (left +
5035 (WINDOW_RIGHTMOST_P (w)
5036 ? width - sb_width - (width - sb_width) / 2
5037 : 0));
5038 else
5039 sb_left = (left +
5040 (WINDOW_LEFTMOST_P (w)
5041 ? (width - sb_width) / 2
5042 : width - sb_width));
5043 #else
5044 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5045 sb_left = left + width - sb_width;
5046 else
5047 sb_left = left;
5048 #endif
5050 /* Does the scroll bar exist yet? */
5051 if (NILP (w->vertical_scroll_bar))
5053 if (width > 0 && height > 0)
5055 BLOCK_INPUT;
5056 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5057 left, top, width, height, False);
5058 UNBLOCK_INPUT;
5061 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5063 else
5065 /* It may just need to be moved and resized. */
5066 unsigned int mask = 0;
5068 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5070 BLOCK_INPUT;
5072 if (sb_left != XINT (bar->left))
5073 mask |= CWX;
5074 if (top != XINT (bar->top))
5075 mask |= CWY;
5076 if (sb_width != XINT (bar->width))
5077 mask |= CWWidth;
5078 if (height != XINT (bar->height))
5079 mask |= CWHeight;
5081 #ifdef USE_TOOLKIT_SCROLL_BARS
5083 /* Move/size the scroll bar widget. */
5084 if (mask)
5086 /* Since toolkit scroll bars are smaller than the space reserved
5087 for them on the frame, we have to clear "under" them. */
5088 if (width > 0 && height > 0)
5089 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5090 left, top, width, height, False);
5091 #ifdef USE_GTK
5092 xg_update_scrollbar_pos (f,
5093 SCROLL_BAR_X_WINDOW (bar),
5094 top,
5095 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5096 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5097 max (height, 1));
5098 #else /* not USE_GTK */
5099 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5100 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5101 top,
5102 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5103 max (height, 1), 0);
5104 #endif /* not USE_GTK */
5106 #else /* not USE_TOOLKIT_SCROLL_BARS */
5108 /* Clear areas not covered by the scroll bar because of
5109 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5110 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5112 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5113 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5114 height, False);
5115 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5116 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5117 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5118 height, False);
5121 /* Clear areas not covered by the scroll bar because it's not as
5122 wide as the area reserved for it. This makes sure a
5123 previous mode line display is cleared after C-x 2 C-x 1, for
5124 example. */
5126 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5127 int rest = area_width - sb_width;
5128 if (rest > 0 && height > 0)
5130 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5131 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5132 left + area_width - rest, top,
5133 rest, height, False);
5134 else
5135 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5136 left, top, rest, height, False);
5140 /* Move/size the scroll bar window. */
5141 if (mask)
5143 XWindowChanges wc;
5145 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5146 wc.y = top;
5147 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5148 wc.height = height;
5149 XConfigureWindow (FRAME_X_DISPLAY (f), SCROLL_BAR_X_WINDOW (bar),
5150 mask, &wc);
5153 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5155 /* Remember new settings. */
5156 XSETINT (bar->left, sb_left);
5157 XSETINT (bar->top, top);
5158 XSETINT (bar->width, sb_width);
5159 XSETINT (bar->height, height);
5161 UNBLOCK_INPUT;
5164 #ifdef USE_TOOLKIT_SCROLL_BARS
5165 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5166 #else /* not USE_TOOLKIT_SCROLL_BARS */
5167 /* Set the scroll bar's current state, unless we're currently being
5168 dragged. */
5169 if (NILP (bar->dragging))
5171 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5173 if (whole == 0)
5174 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5175 else
5177 int start = ((double) position * top_range) / whole;
5178 int end = ((double) (position + portion) * top_range) / whole;
5179 x_scroll_bar_set_handle (bar, start, end, 0);
5182 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5184 XSETVECTOR (w->vertical_scroll_bar, bar);
5188 /* The following three hooks are used when we're doing a thorough
5189 redisplay of the frame. We don't explicitly know which scroll bars
5190 are going to be deleted, because keeping track of when windows go
5191 away is a real pain - "Can you say set-window-configuration, boys
5192 and girls?" Instead, we just assert at the beginning of redisplay
5193 that *all* scroll bars are to be removed, and then save a scroll bar
5194 from the fiery pit when we actually redisplay its window. */
5196 /* Arrange for all scroll bars on FRAME to be removed at the next call
5197 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5198 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5200 static void
5201 XTcondemn_scroll_bars (frame)
5202 FRAME_PTR frame;
5204 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5205 while (! NILP (FRAME_SCROLL_BARS (frame)))
5207 Lisp_Object bar;
5208 bar = FRAME_SCROLL_BARS (frame);
5209 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5210 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5211 XSCROLL_BAR (bar)->prev = Qnil;
5212 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5213 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5214 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5219 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5220 Note that WINDOW isn't necessarily condemned at all. */
5222 static void
5223 XTredeem_scroll_bar (window)
5224 struct window *window;
5226 struct scroll_bar *bar;
5227 struct frame *f;
5229 /* We can't redeem this window's scroll bar if it doesn't have one. */
5230 if (NILP (window->vertical_scroll_bar))
5231 abort ();
5233 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5235 /* Unlink it from the condemned list. */
5236 f = XFRAME (WINDOW_FRAME (window));
5237 if (NILP (bar->prev))
5239 /* If the prev pointer is nil, it must be the first in one of
5240 the lists. */
5241 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5242 /* It's not condemned. Everything's fine. */
5243 return;
5244 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5245 window->vertical_scroll_bar))
5246 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5247 else
5248 /* If its prev pointer is nil, it must be at the front of
5249 one or the other! */
5250 abort ();
5252 else
5253 XSCROLL_BAR (bar->prev)->next = bar->next;
5255 if (! NILP (bar->next))
5256 XSCROLL_BAR (bar->next)->prev = bar->prev;
5258 bar->next = FRAME_SCROLL_BARS (f);
5259 bar->prev = Qnil;
5260 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5261 if (! NILP (bar->next))
5262 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5265 /* Remove all scroll bars on FRAME that haven't been saved since the
5266 last call to `*condemn_scroll_bars_hook'. */
5268 static void
5269 XTjudge_scroll_bars (f)
5270 FRAME_PTR f;
5272 Lisp_Object bar, next;
5274 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5276 /* Clear out the condemned list now so we won't try to process any
5277 more events on the hapless scroll bars. */
5278 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5280 for (; ! NILP (bar); bar = next)
5282 struct scroll_bar *b = XSCROLL_BAR (bar);
5284 x_scroll_bar_remove (b);
5286 next = b->next;
5287 b->next = b->prev = Qnil;
5290 /* Now there should be no references to the condemned scroll bars,
5291 and they should get garbage-collected. */
5295 #ifndef USE_TOOLKIT_SCROLL_BARS
5296 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5297 is a no-op when using toolkit scroll bars.
5299 This may be called from a signal handler, so we have to ignore GC
5300 mark bits. */
5302 static void
5303 x_scroll_bar_expose (bar, event)
5304 struct scroll_bar *bar;
5305 XEvent *event;
5307 Window w = SCROLL_BAR_X_WINDOW (bar);
5308 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5309 GC gc = f->output_data.x->normal_gc;
5310 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5312 BLOCK_INPUT;
5314 x_scroll_bar_set_handle (bar, XINT (bar->start), XINT (bar->end), 1);
5316 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5317 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5319 /* x, y, width, height */
5320 0, 0,
5321 XINT (bar->width) - 1 - width_trim - width_trim,
5322 XINT (bar->height) - 1);
5324 UNBLOCK_INPUT;
5327 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5329 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5330 is set to something other than NO_EVENT, it is enqueued.
5332 This may be called from a signal handler, so we have to ignore GC
5333 mark bits. */
5336 static void
5337 x_scroll_bar_handle_click (bar, event, emacs_event)
5338 struct scroll_bar *bar;
5339 XEvent *event;
5340 struct input_event *emacs_event;
5342 if (! GC_WINDOWP (bar->window))
5343 abort ();
5345 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5346 emacs_event->code = event->xbutton.button - Button1;
5347 emacs_event->modifiers
5348 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5349 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5350 event->xbutton.state)
5351 | (event->type == ButtonRelease
5352 ? up_modifier
5353 : down_modifier));
5354 emacs_event->frame_or_window = bar->window;
5355 emacs_event->arg = Qnil;
5356 emacs_event->timestamp = event->xbutton.time;
5358 #if 0
5359 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5360 int internal_height
5361 = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, XINT (bar->height));
5362 #endif
5363 int top_range
5364 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, XINT (bar->height));
5365 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5367 if (y < 0) y = 0;
5368 if (y > top_range) y = top_range;
5370 if (y < XINT (bar->start))
5371 emacs_event->part = scroll_bar_above_handle;
5372 else if (y < XINT (bar->end) + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5373 emacs_event->part = scroll_bar_handle;
5374 else
5375 emacs_event->part = scroll_bar_below_handle;
5377 /* Just because the user has clicked on the handle doesn't mean
5378 they want to drag it. Lisp code needs to be able to decide
5379 whether or not we're dragging. */
5380 #if 0
5381 /* If the user has just clicked on the handle, record where they're
5382 holding it. */
5383 if (event->type == ButtonPress
5384 && emacs_event->part == scroll_bar_handle)
5385 XSETINT (bar->dragging, y - XINT (bar->start));
5386 #endif
5388 #ifndef USE_TOOLKIT_SCROLL_BARS
5389 /* If the user has released the handle, set it to its final position. */
5390 if (event->type == ButtonRelease
5391 && ! NILP (bar->dragging))
5393 int new_start = y - XINT (bar->dragging);
5394 int new_end = new_start + (XINT (bar->end) - XINT (bar->start));
5396 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5397 bar->dragging = Qnil;
5399 #endif
5401 /* Same deal here as the other #if 0. */
5402 #if 0
5403 /* Clicks on the handle are always reported as occurring at the top of
5404 the handle. */
5405 if (emacs_event->part == scroll_bar_handle)
5406 emacs_event->x = bar->start;
5407 else
5408 XSETINT (emacs_event->x, y);
5409 #else
5410 XSETINT (emacs_event->x, y);
5411 #endif
5413 XSETINT (emacs_event->y, top_range);
5417 #ifndef USE_TOOLKIT_SCROLL_BARS
5419 /* Handle some mouse motion while someone is dragging the scroll bar.
5421 This may be called from a signal handler, so we have to ignore GC
5422 mark bits. */
5424 static void
5425 x_scroll_bar_note_movement (bar, event)
5426 struct scroll_bar *bar;
5427 XEvent *event;
5429 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5431 last_mouse_movement_time = event->xmotion.time;
5433 f->mouse_moved = 1;
5434 XSETVECTOR (last_mouse_scroll_bar, bar);
5436 /* If we're dragging the bar, display it. */
5437 if (! GC_NILP (bar->dragging))
5439 /* Where should the handle be now? */
5440 int new_start = event->xmotion.y - XINT (bar->dragging);
5442 if (new_start != XINT (bar->start))
5444 int new_end = new_start + (XINT (bar->end) - XINT (bar->start));
5446 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5451 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5453 /* Return information to the user about the current position of the mouse
5454 on the scroll bar. */
5456 static void
5457 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time)
5458 FRAME_PTR *fp;
5459 Lisp_Object *bar_window;
5460 enum scroll_bar_part *part;
5461 Lisp_Object *x, *y;
5462 unsigned long *time;
5464 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5465 Window w = SCROLL_BAR_X_WINDOW (bar);
5466 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5467 int win_x, win_y;
5468 Window dummy_window;
5469 int dummy_coord;
5470 unsigned int dummy_mask;
5472 BLOCK_INPUT;
5474 /* Get the mouse's position relative to the scroll bar window, and
5475 report that. */
5476 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5478 /* Root, child, root x and root y. */
5479 &dummy_window, &dummy_window,
5480 &dummy_coord, &dummy_coord,
5482 /* Position relative to scroll bar. */
5483 &win_x, &win_y,
5485 /* Mouse buttons and modifier keys. */
5486 &dummy_mask))
5488 else
5490 #if 0
5491 int inside_height
5492 = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, XINT (bar->height));
5493 #endif
5494 int top_range
5495 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, XINT (bar->height));
5497 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5499 if (! NILP (bar->dragging))
5500 win_y -= XINT (bar->dragging);
5502 if (win_y < 0)
5503 win_y = 0;
5504 if (win_y > top_range)
5505 win_y = top_range;
5507 *fp = f;
5508 *bar_window = bar->window;
5510 if (! NILP (bar->dragging))
5511 *part = scroll_bar_handle;
5512 else if (win_y < XINT (bar->start))
5513 *part = scroll_bar_above_handle;
5514 else if (win_y < XINT (bar->end) + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5515 *part = scroll_bar_handle;
5516 else
5517 *part = scroll_bar_below_handle;
5519 XSETINT (*x, win_y);
5520 XSETINT (*y, top_range);
5522 f->mouse_moved = 0;
5523 last_mouse_scroll_bar = Qnil;
5526 *time = last_mouse_movement_time;
5528 UNBLOCK_INPUT;
5532 /* The screen has been cleared so we may have changed foreground or
5533 background colors, and the scroll bars may need to be redrawn.
5534 Clear out the scroll bars, and ask for expose events, so we can
5535 redraw them. */
5537 void
5538 x_scroll_bar_clear (f)
5539 FRAME_PTR f;
5541 #ifndef USE_TOOLKIT_SCROLL_BARS
5542 Lisp_Object bar;
5544 /* We can have scroll bars even if this is 0,
5545 if we just turned off scroll bar mode.
5546 But in that case we should not clear them. */
5547 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5548 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5549 bar = XSCROLL_BAR (bar)->next)
5550 XClearArea (FRAME_X_DISPLAY (f),
5551 SCROLL_BAR_X_WINDOW (XSCROLL_BAR (bar)),
5552 0, 0, 0, 0, True);
5553 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5557 /* The main X event-reading loop - XTread_socket. */
5559 #if 0
5560 /* Time stamp of enter window event. This is only used by XTread_socket,
5561 but we have to put it out here, since static variables within functions
5562 sometimes don't work. */
5564 static Time enter_timestamp;
5565 #endif
5567 /* This holds the state XLookupString needs to implement dead keys
5568 and other tricks known as "compose processing". _X Window System_
5569 says that a portable program can't use this, but Stephen Gildea assures
5570 me that letting the compiler initialize it to zeros will work okay.
5572 This must be defined outside of XTread_socket, for the same reasons
5573 given for enter_timestamp, above. */
5575 static XComposeStatus compose_status;
5577 /* Record the last 100 characters stored
5578 to help debug the loss-of-chars-during-GC problem. */
5580 static int temp_index;
5581 static short temp_buffer[100];
5583 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5584 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5585 temp_index = 0; \
5586 temp_buffer[temp_index++] = (keysym)
5588 /* Set this to nonzero to fake an "X I/O error"
5589 on a particular display. */
5591 struct x_display_info *XTread_socket_fake_io_error;
5593 /* When we find no input here, we occasionally do a no-op command
5594 to verify that the X server is still running and we can still talk with it.
5595 We try all the open displays, one by one.
5596 This variable is used for cycling thru the displays. */
5598 static struct x_display_info *next_noop_dpyinfo;
5600 #define SET_SAVED_MENU_EVENT(size) \
5601 do \
5603 if (f->output_data.x->saved_menu_event == 0) \
5604 f->output_data.x->saved_menu_event \
5605 = (XEvent *) xmalloc (sizeof (XEvent)); \
5606 bcopy (&event, f->output_data.x->saved_menu_event, size); \
5607 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5608 XSETFRAME (inev.ie.frame_or_window, f); \
5610 while (0)
5612 #define SET_SAVED_BUTTON_EVENT SET_SAVED_MENU_EVENT (sizeof (XButtonEvent))
5613 #define SET_SAVED_KEY_EVENT SET_SAVED_MENU_EVENT (sizeof (XKeyEvent))
5616 enum
5618 X_EVENT_NORMAL,
5619 X_EVENT_GOTO_OUT,
5620 X_EVENT_DROP
5623 /* Filter events for the current X input method.
5624 DPYINFO is the display this event is for.
5625 EVENT is the X event to filter.
5627 Returns non-zero if the event was filtered, caller shall not process
5628 this event further.
5629 Returns zero if event is wasn't filtered. */
5631 #ifdef HAVE_X_I18N
5632 static int
5633 x_filter_event (dpyinfo, event)
5634 struct x_display_info *dpyinfo;
5635 XEvent *event;
5637 /* XFilterEvent returns non-zero if the input method has
5638 consumed the event. We pass the frame's X window to
5639 XFilterEvent because that's the one for which the IC
5640 was created. */
5642 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5643 event->xclient.window);
5645 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5647 #endif
5649 #ifdef USE_GTK
5650 static int current_count;
5651 static int current_finish;
5652 static struct input_event *current_hold_quit;
5654 /* This is the filter function invoked by the GTK event loop.
5655 It is invoked before the XEvent is translated to a GdkEvent,
5656 so we have a chance to act on the event before GTK. */
5657 static GdkFilterReturn
5658 event_handler_gdk (gxev, ev, data)
5659 GdkXEvent *gxev;
5660 GdkEvent *ev;
5661 gpointer data;
5663 XEvent *xev = (XEvent *) gxev;
5665 if (current_count >= 0)
5667 struct x_display_info *dpyinfo;
5669 dpyinfo = x_display_info_for_display (xev->xany.display);
5671 #ifdef HAVE_X_I18N
5672 /* Filter events for the current X input method.
5673 GTK calls XFilterEvent but not for key press and release,
5674 so we do it here. */
5675 if (xev->type == KeyPress || xev->type == KeyRelease)
5676 if (dpyinfo && x_filter_event (dpyinfo, xev))
5677 return GDK_FILTER_REMOVE;
5678 #endif
5680 if (! dpyinfo)
5681 current_finish = X_EVENT_NORMAL;
5682 else
5684 current_count +=
5685 handle_one_xevent (dpyinfo, xev, &current_finish,
5686 current_hold_quit);
5689 else
5690 current_finish = x_dispatch_event (xev, xev->xany.display);
5692 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5693 return GDK_FILTER_REMOVE;
5695 return GDK_FILTER_CONTINUE;
5697 #endif /* USE_GTK */
5700 /* Handles the XEvent EVENT on display DPYINFO.
5702 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5703 *FINISH is zero if caller should continue reading events.
5704 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5706 We return the number of characters stored into the buffer. */
5708 static int
5709 handle_one_xevent (dpyinfo, eventp, finish, hold_quit)
5710 struct x_display_info *dpyinfo;
5711 XEvent *eventp;
5712 int *finish;
5713 struct input_event *hold_quit;
5715 union {
5716 struct input_event ie;
5717 struct selection_input_event sie;
5718 } inev;
5719 int count = 0;
5720 int do_help = 0;
5721 int nbytes = 0;
5722 struct frame *f;
5723 struct coding_system coding;
5724 XEvent event = *eventp;
5726 *finish = X_EVENT_NORMAL;
5728 EVENT_INIT (inev.ie);
5729 inev.ie.kind = NO_EVENT;
5730 inev.ie.arg = Qnil;
5732 switch (event.type)
5734 case ClientMessage:
5736 if (event.xclient.message_type
5737 == dpyinfo->Xatom_wm_protocols
5738 && event.xclient.format == 32)
5740 if (event.xclient.data.l[0]
5741 == dpyinfo->Xatom_wm_take_focus)
5743 /* Use x_any_window_to_frame because this
5744 could be the shell widget window
5745 if the frame has no title bar. */
5746 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5747 #ifdef HAVE_X_I18N
5748 /* Not quite sure this is needed -pd */
5749 if (f && FRAME_XIC (f))
5750 XSetICFocus (FRAME_XIC (f));
5751 #endif
5752 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5753 instructs the WM to set the input focus automatically for
5754 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5755 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5756 it has set the focus. So, XSetInputFocus below is not
5757 needed.
5759 The call to XSetInputFocus below has also caused trouble. In
5760 cases where the XSetInputFocus done by the WM and the one
5761 below are temporally close (on a fast machine), the call
5762 below can generate additional FocusIn events which confuse
5763 Emacs. */
5765 /* Since we set WM_TAKE_FOCUS, we must call
5766 XSetInputFocus explicitly. But not if f is null,
5767 since that might be an event for a deleted frame. */
5768 if (f)
5770 Display *d = event.xclient.display;
5771 /* Catch and ignore errors, in case window has been
5772 iconified by a window manager such as GWM. */
5773 int count = x_catch_errors (d);
5774 XSetInputFocus (d, event.xclient.window,
5775 /* The ICCCM says this is
5776 the only valid choice. */
5777 RevertToParent,
5778 event.xclient.data.l[1]);
5779 /* This is needed to detect the error
5780 if there is an error. */
5781 XSync (d, False);
5782 x_uncatch_errors (d, count);
5784 /* Not certain about handling scroll bars here */
5785 #endif /* 0 */
5786 goto done;
5789 if (event.xclient.data.l[0]
5790 == dpyinfo->Xatom_wm_save_yourself)
5792 /* Save state modify the WM_COMMAND property to
5793 something which can reinstate us. This notifies
5794 the session manager, who's looking for such a
5795 PropertyNotify. Can restart processing when
5796 a keyboard or mouse event arrives. */
5797 /* If we have a session manager, don't set this.
5798 KDE will then start two Emacsen, one for the
5799 session manager and one for this. */
5800 #ifdef HAVE_X_SM
5801 if (! x_session_have_connection ())
5802 #endif
5804 f = x_top_window_to_frame (dpyinfo,
5805 event.xclient.window);
5806 /* This is just so we only give real data once
5807 for a single Emacs process. */
5808 if (f == SELECTED_FRAME ())
5809 XSetCommand (FRAME_X_DISPLAY (f),
5810 event.xclient.window,
5811 initial_argv, initial_argc);
5812 else if (f)
5813 XSetCommand (FRAME_X_DISPLAY (f),
5814 event.xclient.window,
5815 0, 0);
5817 goto done;
5820 if (event.xclient.data.l[0]
5821 == dpyinfo->Xatom_wm_delete_window)
5823 f = x_any_window_to_frame (dpyinfo,
5824 event.xclient.window);
5825 if (!f)
5826 goto OTHER; /* May be a dialog that is to be removed */
5828 inev.ie.kind = DELETE_WINDOW_EVENT;
5829 XSETFRAME (inev.ie.frame_or_window, f);
5830 goto done;
5833 goto done;
5836 if (event.xclient.message_type
5837 == dpyinfo->Xatom_wm_configure_denied)
5839 goto done;
5842 if (event.xclient.message_type
5843 == dpyinfo->Xatom_wm_window_moved)
5845 int new_x, new_y;
5846 f = x_window_to_frame (dpyinfo, event.xclient.window);
5848 new_x = event.xclient.data.s[0];
5849 new_y = event.xclient.data.s[1];
5851 if (f)
5853 f->left_pos = new_x;
5854 f->top_pos = new_y;
5856 goto done;
5859 #ifdef HACK_EDITRES
5860 if (event.xclient.message_type
5861 == dpyinfo->Xatom_editres)
5863 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5864 _XEditResCheckMessages (f->output_data.x->widget, NULL,
5865 &event, NULL);
5866 goto done;
5868 #endif /* HACK_EDITRES */
5870 if ((event.xclient.message_type
5871 == dpyinfo->Xatom_DONE)
5872 || (event.xclient.message_type
5873 == dpyinfo->Xatom_PAGE))
5875 /* Ghostview job completed. Kill it. We could
5876 reply with "Next" if we received "Page", but we
5877 currently never do because we are interested in
5878 images, only, which should have 1 page. */
5879 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
5880 f = x_window_to_frame (dpyinfo, event.xclient.window);
5881 x_kill_gs_process (pixmap, f);
5882 expose_frame (f, 0, 0, 0, 0);
5883 goto done;
5886 #ifdef USE_TOOLKIT_SCROLL_BARS
5887 /* Scroll bar callbacks send a ClientMessage from which
5888 we construct an input_event. */
5889 if (event.xclient.message_type
5890 == dpyinfo->Xatom_Scrollbar)
5892 x_scroll_bar_to_input_event (&event, &inev.ie);
5893 *finish = X_EVENT_GOTO_OUT;
5894 goto done;
5896 #endif /* USE_TOOLKIT_SCROLL_BARS */
5898 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5900 if (!f)
5901 goto OTHER;
5903 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
5904 *finish = X_EVENT_DROP;
5906 break;
5908 case SelectionNotify:
5909 #ifdef USE_X_TOOLKIT
5910 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
5911 goto OTHER;
5912 #endif /* not USE_X_TOOLKIT */
5913 x_handle_selection_notify (&event.xselection);
5914 break;
5916 case SelectionClear: /* Someone has grabbed ownership. */
5917 #ifdef USE_X_TOOLKIT
5918 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
5919 goto OTHER;
5920 #endif /* USE_X_TOOLKIT */
5922 XSelectionClearEvent *eventp = (XSelectionClearEvent *) &event;
5924 inev.ie.kind = SELECTION_CLEAR_EVENT;
5925 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
5926 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
5927 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
5928 inev.ie.frame_or_window = Qnil;
5930 break;
5932 case SelectionRequest: /* Someone wants our selection. */
5933 #ifdef USE_X_TOOLKIT
5934 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
5935 goto OTHER;
5936 #endif /* USE_X_TOOLKIT */
5938 XSelectionRequestEvent *eventp
5939 = (XSelectionRequestEvent *) &event;
5941 inev.ie.kind = SELECTION_REQUEST_EVENT;
5942 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
5943 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
5944 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
5945 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
5946 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
5947 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
5948 inev.ie.frame_or_window = Qnil;
5950 break;
5952 case PropertyNotify:
5953 #if 0 /* This is plain wrong. In the case that we are waiting for a
5954 PropertyNotify used as an ACK in incremental selection
5955 transfer, the property will be on the receiver's window. */
5956 #if defined USE_X_TOOLKIT
5957 if (!x_any_window_to_frame (dpyinfo, event.xproperty.window))
5958 goto OTHER;
5959 #endif
5960 #endif
5961 x_handle_property_notify (&event.xproperty);
5962 goto OTHER;
5964 case ReparentNotify:
5965 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
5966 if (f)
5968 int x, y;
5969 f->output_data.x->parent_desc = event.xreparent.parent;
5970 x_real_positions (f, &x, &y);
5971 f->left_pos = x;
5972 f->top_pos = y;
5974 /* Perhaps reparented due to a WM restart. Reset this. */
5975 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
5977 goto OTHER;
5979 case Expose:
5980 f = x_window_to_frame (dpyinfo, event.xexpose.window);
5981 if (f)
5983 x_check_fullscreen (f);
5985 #ifdef USE_GTK
5986 /* This seems to be needed for GTK 2.6. */
5987 x_clear_area (event.xexpose.display,
5988 event.xexpose.window,
5989 event.xexpose.x, event.xexpose.y,
5990 event.xexpose.width, event.xexpose.height,
5991 FALSE);
5992 #endif
5993 if (f->async_visible == 0)
5995 f->async_visible = 1;
5996 f->async_iconified = 0;
5997 f->output_data.x->has_been_visible = 1;
5998 SET_FRAME_GARBAGED (f);
6000 else
6001 expose_frame (f,
6002 event.xexpose.x, event.xexpose.y,
6003 event.xexpose.width, event.xexpose.height);
6005 else
6007 #ifndef USE_TOOLKIT_SCROLL_BARS
6008 struct scroll_bar *bar;
6009 #endif
6010 #if defined USE_LUCID
6011 /* Submenus of the Lucid menu bar aren't widgets
6012 themselves, so there's no way to dispatch events
6013 to them. Recognize this case separately. */
6015 Widget widget
6016 = x_window_to_menu_bar (event.xexpose.window);
6017 if (widget)
6018 xlwmenu_redisplay (widget);
6020 #endif /* USE_LUCID */
6022 #ifdef USE_TOOLKIT_SCROLL_BARS
6023 /* Dispatch event to the widget. */
6024 goto OTHER;
6025 #else /* not USE_TOOLKIT_SCROLL_BARS */
6026 bar = x_window_to_scroll_bar (event.xexpose.display,
6027 event.xexpose.window);
6029 if (bar)
6030 x_scroll_bar_expose (bar, &event);
6031 #ifdef USE_X_TOOLKIT
6032 else
6033 goto OTHER;
6034 #endif /* USE_X_TOOLKIT */
6035 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6037 break;
6039 case GraphicsExpose: /* This occurs when an XCopyArea's
6040 source area was obscured or not
6041 available. */
6042 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6043 if (f)
6045 expose_frame (f,
6046 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6047 event.xgraphicsexpose.width,
6048 event.xgraphicsexpose.height);
6050 #ifdef USE_X_TOOLKIT
6051 else
6052 goto OTHER;
6053 #endif /* USE_X_TOOLKIT */
6054 break;
6056 case NoExpose: /* This occurs when an XCopyArea's
6057 source area was completely
6058 available. */
6059 break;
6061 case UnmapNotify:
6062 /* Redo the mouse-highlight after the tooltip has gone. */
6063 if (event.xmap.window == tip_window)
6065 tip_window = 0;
6066 redo_mouse_highlight ();
6069 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6070 if (f) /* F may no longer exist if
6071 the frame was deleted. */
6073 /* While a frame is unmapped, display generation is
6074 disabled; you don't want to spend time updating a
6075 display that won't ever be seen. */
6076 f->async_visible = 0;
6077 /* We can't distinguish, from the event, whether the window
6078 has become iconified or invisible. So assume, if it
6079 was previously visible, than now it is iconified.
6080 But x_make_frame_invisible clears both
6081 the visible flag and the iconified flag;
6082 and that way, we know the window is not iconified now. */
6083 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6085 f->async_iconified = 1;
6087 inev.ie.kind = ICONIFY_EVENT;
6088 XSETFRAME (inev.ie.frame_or_window, f);
6091 goto OTHER;
6093 case MapNotify:
6094 if (event.xmap.window == tip_window)
6095 /* The tooltip has been drawn already. Avoid
6096 the SET_FRAME_GARBAGED below. */
6097 goto OTHER;
6099 /* We use x_top_window_to_frame because map events can
6100 come for sub-windows and they don't mean that the
6101 frame is visible. */
6102 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6103 if (f)
6105 /* wait_reading_process_output will notice this and update
6106 the frame's display structures.
6107 If we where iconified, we should not set garbaged,
6108 because that stops redrawing on Expose events. This looks
6109 bad if we are called from a recursive event loop
6110 (x_dispatch_event), for example when a dialog is up. */
6111 if (! f->async_iconified)
6112 SET_FRAME_GARBAGED (f);
6114 f->async_visible = 1;
6115 f->async_iconified = 0;
6116 f->output_data.x->has_been_visible = 1;
6118 if (f->iconified)
6120 inev.ie.kind = DEICONIFY_EVENT;
6121 XSETFRAME (inev.ie.frame_or_window, f);
6123 else if (! NILP (Vframe_list)
6124 && ! NILP (XCDR (Vframe_list)))
6125 /* Force a redisplay sooner or later
6126 to update the frame titles
6127 in case this is the second frame. */
6128 record_asynch_buffer_change ();
6130 goto OTHER;
6132 case KeyPress:
6134 ignore_next_mouse_click_timeout = 0;
6136 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6137 /* Dispatch KeyPress events when in menu. */
6138 if (popup_activated ())
6139 goto OTHER;
6140 #endif
6142 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6144 if (!dpyinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight))
6146 clear_mouse_face (dpyinfo);
6147 dpyinfo->mouse_face_hidden = 1;
6150 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6151 if (f == 0)
6153 /* Scroll bars consume key events, but we want
6154 the keys to go to the scroll bar's frame. */
6155 Widget widget = XtWindowToWidget (dpyinfo->display,
6156 event.xkey.window);
6157 if (widget && XmIsScrollBar (widget))
6159 widget = XtParent (widget);
6160 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6163 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6165 if (f != 0)
6167 KeySym keysym, orig_keysym;
6168 /* al%imercury@uunet.uu.net says that making this 81
6169 instead of 80 fixed a bug whereby meta chars made
6170 his Emacs hang.
6172 It seems that some version of XmbLookupString has
6173 a bug of not returning XBufferOverflow in
6174 status_return even if the input is too long to
6175 fit in 81 bytes. So, we must prepare sufficient
6176 bytes for copy_buffer. 513 bytes (256 chars for
6177 two-byte character set) seems to be a fairly good
6178 approximation. -- 2000.8.10 handa@etl.go.jp */
6179 unsigned char copy_buffer[513];
6180 unsigned char *copy_bufptr = copy_buffer;
6181 int copy_bufsiz = sizeof (copy_buffer);
6182 int modifiers;
6183 Lisp_Object coding_system = Qlatin_1;
6184 Lisp_Object c;
6186 #ifdef USE_GTK
6187 /* Don't pass keys to GTK. A Tab will shift focus to the
6188 tool bar in GTK 2.4. Keys will still go to menus and
6189 dialogs because in that case popup_activated is TRUE
6190 (see above). */
6191 *finish = X_EVENT_DROP;
6192 #endif
6194 event.xkey.state
6195 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6196 extra_keyboard_modifiers);
6197 modifiers = event.xkey.state;
6199 /* This will have to go some day... */
6201 /* make_lispy_event turns chars into control chars.
6202 Don't do it here because XLookupString is too eager. */
6203 event.xkey.state &= ~ControlMask;
6204 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6205 | dpyinfo->super_mod_mask
6206 | dpyinfo->hyper_mod_mask
6207 | dpyinfo->alt_mod_mask);
6209 /* In case Meta is ComposeCharacter,
6210 clear its status. According to Markus Ehrnsperger
6211 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6212 this enables ComposeCharacter to work whether or
6213 not it is combined with Meta. */
6214 if (modifiers & dpyinfo->meta_mod_mask)
6215 bzero (&compose_status, sizeof (compose_status));
6217 #ifdef HAVE_X_I18N
6218 if (FRAME_XIC (f))
6220 Status status_return;
6222 coding_system = Vlocale_coding_system;
6223 nbytes = XmbLookupString (FRAME_XIC (f),
6224 &event.xkey, copy_bufptr,
6225 copy_bufsiz, &keysym,
6226 &status_return);
6227 if (status_return == XBufferOverflow)
6229 copy_bufsiz = nbytes + 1;
6230 copy_bufptr = (char *) alloca (copy_bufsiz);
6231 nbytes = XmbLookupString (FRAME_XIC (f),
6232 &event.xkey, copy_bufptr,
6233 copy_bufsiz, &keysym,
6234 &status_return);
6236 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6237 #if 0 && defined X_HAVE_UTF8_STRING
6238 else if (status_return == XLookupKeySym)
6239 { /* Try again but with utf-8. */
6240 coding_system = Qutf_8;
6241 nbytes = Xutf8LookupString (FRAME_XIC (f),
6242 &event.xkey, copy_bufptr,
6243 copy_bufsiz, &keysym,
6244 &status_return);
6245 if (status_return == XBufferOverflow)
6247 copy_bufsiz = nbytes + 1;
6248 copy_bufptr = (char *) alloca (copy_bufsiz);
6249 nbytes = Xutf8LookupString (FRAME_XIC (f),
6250 &event.xkey,
6251 copy_bufptr,
6252 copy_bufsiz, &keysym,
6253 &status_return);
6256 #endif
6258 if (status_return == XLookupNone)
6259 break;
6260 else if (status_return == XLookupChars)
6262 keysym = NoSymbol;
6263 modifiers = 0;
6265 else if (status_return != XLookupKeySym
6266 && status_return != XLookupBoth)
6267 abort ();
6269 else
6270 nbytes = XLookupString (&event.xkey, copy_bufptr,
6271 copy_bufsiz, &keysym,
6272 &compose_status);
6273 #else
6274 nbytes = XLookupString (&event.xkey, copy_bufptr,
6275 copy_bufsiz, &keysym,
6276 &compose_status);
6277 #endif
6279 /* If not using XIM/XIC, and a compose sequence is in progress,
6280 we break here. Otherwise, chars_matched is always 0. */
6281 if (compose_status.chars_matched > 0 && nbytes == 0)
6282 break;
6284 orig_keysym = keysym;
6286 /* Common for all keysym input events. */
6287 XSETFRAME (inev.ie.frame_or_window, f);
6288 inev.ie.modifiers
6289 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6290 inev.ie.timestamp = event.xkey.time;
6292 /* First deal with keysyms which have defined
6293 translations to characters. */
6294 if (keysym >= 32 && keysym < 128)
6295 /* Avoid explicitly decoding each ASCII character. */
6297 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6298 inev.ie.code = keysym;
6299 goto done_keysym;
6302 /* Now non-ASCII. */
6303 if (HASH_TABLE_P (Vx_keysym_table)
6304 && (NATNUMP (c = Fgethash (make_number (keysym),
6305 Vx_keysym_table,
6306 Qnil))))
6308 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6309 ? ASCII_KEYSTROKE_EVENT
6310 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6311 inev.ie.code = XFASTINT (c);
6312 goto done_keysym;
6315 /* Random non-modifier sorts of keysyms. */
6316 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6317 || keysym == XK_Delete
6318 #ifdef XK_ISO_Left_Tab
6319 || (keysym >= XK_ISO_Left_Tab
6320 && keysym <= XK_ISO_Enter)
6321 #endif
6322 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6323 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6324 #ifdef HPUX
6325 /* This recognizes the "extended function
6326 keys". It seems there's no cleaner way.
6327 Test IsModifierKey to avoid handling
6328 mode_switch incorrectly. */
6329 || ((unsigned) (keysym) >= XK_Select
6330 && (unsigned)(keysym) < XK_KP_Space)
6331 #endif
6332 #ifdef XK_dead_circumflex
6333 || orig_keysym == XK_dead_circumflex
6334 #endif
6335 #ifdef XK_dead_grave
6336 || orig_keysym == XK_dead_grave
6337 #endif
6338 #ifdef XK_dead_tilde
6339 || orig_keysym == XK_dead_tilde
6340 #endif
6341 #ifdef XK_dead_diaeresis
6342 || orig_keysym == XK_dead_diaeresis
6343 #endif
6344 #ifdef XK_dead_macron
6345 || orig_keysym == XK_dead_macron
6346 #endif
6347 #ifdef XK_dead_degree
6348 || orig_keysym == XK_dead_degree
6349 #endif
6350 #ifdef XK_dead_acute
6351 || orig_keysym == XK_dead_acute
6352 #endif
6353 #ifdef XK_dead_cedilla
6354 || orig_keysym == XK_dead_cedilla
6355 #endif
6356 #ifdef XK_dead_breve
6357 || orig_keysym == XK_dead_breve
6358 #endif
6359 #ifdef XK_dead_ogonek
6360 || orig_keysym == XK_dead_ogonek
6361 #endif
6362 #ifdef XK_dead_caron
6363 || orig_keysym == XK_dead_caron
6364 #endif
6365 #ifdef XK_dead_doubleacute
6366 || orig_keysym == XK_dead_doubleacute
6367 #endif
6368 #ifdef XK_dead_abovedot
6369 || orig_keysym == XK_dead_abovedot
6370 #endif
6371 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6372 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6373 /* Any "vendor-specific" key is ok. */
6374 || (orig_keysym & (1 << 28))
6375 || (keysym != NoSymbol && nbytes == 0))
6376 && ! (IsModifierKey (orig_keysym)
6377 #ifndef HAVE_X11R5
6378 #ifdef XK_Mode_switch
6379 || ((unsigned)(orig_keysym) == XK_Mode_switch)
6380 #endif
6381 #ifdef XK_Num_Lock
6382 || ((unsigned)(orig_keysym) == XK_Num_Lock)
6383 #endif
6384 #endif /* not HAVE_X11R5 */
6385 /* The symbols from XK_ISO_Lock
6386 to XK_ISO_Last_Group_Lock
6387 don't have real modifiers but
6388 should be treated similarly to
6389 Mode_switch by Emacs. */
6390 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6391 || ((unsigned)(orig_keysym)
6392 >= XK_ISO_Lock
6393 && (unsigned)(orig_keysym)
6394 <= XK_ISO_Last_Group_Lock)
6395 #endif
6398 STORE_KEYSYM_FOR_DEBUG (keysym);
6399 /* make_lispy_event will convert this to a symbolic
6400 key. */
6401 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6402 inev.ie.code = keysym;
6403 goto done_keysym;
6406 { /* Raw bytes, not keysym. */
6407 register int i;
6408 register int c;
6409 int nchars, len;
6411 /* The input should be decoded with `coding_system'
6412 which depends on which X*LookupString function
6413 we used just above and the locale. */
6414 setup_coding_system (coding_system, &coding);
6415 coding.src_multibyte = 0;
6416 coding.dst_multibyte = 1;
6417 /* The input is converted to events, thus we can't
6418 handle composition. Anyway, there's no XIM that
6419 gives us composition information. */
6420 coding.composing = COMPOSITION_DISABLED;
6422 for (i = 0; i < nbytes; i++)
6424 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6428 /* Decode the input data. */
6429 int require;
6430 unsigned char *p;
6432 require = decoding_buffer_size (&coding, nbytes);
6433 p = (unsigned char *) alloca (require);
6434 coding.mode |= CODING_MODE_LAST_BLOCK;
6435 /* We explicitly disable composition handling because
6436 key data should not contain any composition sequence. */
6437 coding.composing = COMPOSITION_DISABLED;
6438 decode_coding (&coding, copy_bufptr, p, nbytes, require);
6439 nbytes = coding.produced;
6440 nchars = coding.produced_char;
6441 copy_bufptr = p;
6444 /* Convert the input data to a sequence of
6445 character events. */
6446 for (i = 0; i < nbytes; i += len)
6448 if (nchars == nbytes)
6449 c = copy_bufptr[i], len = 1;
6450 else
6451 c = STRING_CHAR_AND_LENGTH (copy_bufptr + i,
6452 nbytes - i, len);
6453 inev.ie.kind = (SINGLE_BYTE_CHAR_P (c)
6454 ? ASCII_KEYSTROKE_EVENT
6455 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6456 inev.ie.code = c;
6457 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6460 /* Previous code updated count by nchars rather than nbytes,
6461 but that seems bogus to me. ++kfs */
6462 count += nbytes;
6464 inev.ie.kind = NO_EVENT; /* Already stored above. */
6466 if (keysym == NoSymbol)
6467 break;
6470 done_keysym:
6471 #ifdef HAVE_X_I18N
6472 /* Don't dispatch this event since XtDispatchEvent calls
6473 XFilterEvent, and two calls in a row may freeze the
6474 client. */
6475 break;
6476 #else
6477 goto OTHER;
6478 #endif
6480 case KeyRelease:
6481 #ifdef HAVE_X_I18N
6482 /* Don't dispatch this event since XtDispatchEvent calls
6483 XFilterEvent, and two calls in a row may freeze the
6484 client. */
6485 break;
6486 #else
6487 goto OTHER;
6488 #endif
6490 case EnterNotify:
6491 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6493 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6495 if (f && x_mouse_click_focus_ignore_position)
6496 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6498 #if 0
6499 if (event.xcrossing.focus)
6501 /* Avoid nasty pop/raise loops. */
6502 if (f && (!(f->auto_raise)
6503 || !(f->auto_lower)
6504 || (event.xcrossing.time - enter_timestamp) > 500))
6506 x_new_focus_frame (dpyinfo, f);
6507 enter_timestamp = event.xcrossing.time;
6510 else if (f == dpyinfo->x_focus_frame)
6511 x_new_focus_frame (dpyinfo, 0);
6512 #endif
6514 /* EnterNotify counts as mouse movement,
6515 so update things that depend on mouse position. */
6516 if (f && !f->output_data.x->hourglass_p)
6517 note_mouse_movement (f, &event.xmotion);
6518 goto OTHER;
6520 case FocusIn:
6521 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6522 goto OTHER;
6524 case LeaveNotify:
6525 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6527 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6528 if (f)
6530 if (f == dpyinfo->mouse_face_mouse_frame)
6532 /* If we move outside the frame, then we're
6533 certainly no longer on any text in the frame. */
6534 clear_mouse_face (dpyinfo);
6535 dpyinfo->mouse_face_mouse_frame = 0;
6538 /* Generate a nil HELP_EVENT to cancel a help-echo.
6539 Do it only if there's something to cancel.
6540 Otherwise, the startup message is cleared when
6541 the mouse leaves the frame. */
6542 if (any_help_event_p)
6543 do_help = -1;
6545 goto OTHER;
6547 case FocusOut:
6548 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6549 goto OTHER;
6551 case MotionNotify:
6553 previous_help_echo_string = help_echo_string;
6554 help_echo_string = help_echo_object = help_echo_window = Qnil;
6555 help_echo_pos = -1;
6557 if (dpyinfo->grabbed && last_mouse_frame
6558 && FRAME_LIVE_P (last_mouse_frame))
6559 f = last_mouse_frame;
6560 else
6561 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6563 if (dpyinfo->mouse_face_hidden)
6565 dpyinfo->mouse_face_hidden = 0;
6566 clear_mouse_face (dpyinfo);
6569 if (f)
6572 /* Generate SELECT_WINDOW_EVENTs when needed. */
6573 if (mouse_autoselect_window)
6575 Lisp_Object window;
6577 window = window_from_coordinates (f,
6578 event.xmotion.x, event.xmotion.y,
6579 0, 0, 0, 0);
6581 /* Window will be selected only when it is not selected now and
6582 last mouse movement event was not in it. Minibuffer window
6583 will be selected iff it is active. */
6584 if (WINDOWP (window)
6585 && !EQ (window, last_window)
6586 && !EQ (window, selected_window))
6588 inev.ie.kind = SELECT_WINDOW_EVENT;
6589 inev.ie.frame_or_window = window;
6592 last_window=window;
6594 note_mouse_movement (f, &event.xmotion);
6596 else
6598 #ifndef USE_TOOLKIT_SCROLL_BARS
6599 struct scroll_bar *bar
6600 = x_window_to_scroll_bar (event.xmotion.display,
6601 event.xmotion.window);
6603 if (bar)
6604 x_scroll_bar_note_movement (bar, &event);
6605 #endif /* USE_TOOLKIT_SCROLL_BARS */
6607 /* If we move outside the frame, then we're
6608 certainly no longer on any text in the frame. */
6609 clear_mouse_face (dpyinfo);
6612 /* If the contents of the global variable help_echo_string
6613 has changed, generate a HELP_EVENT. */
6614 if (!NILP (help_echo_string)
6615 || !NILP (previous_help_echo_string))
6616 do_help = 1;
6617 goto OTHER;
6620 case ConfigureNotify:
6621 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6622 if (f)
6624 #ifndef USE_X_TOOLKIT
6625 #ifdef USE_GTK
6626 xg_resize_widgets (f, event.xconfigure.width,
6627 event.xconfigure.height);
6628 #else /* not USE_GTK */
6629 /* If there is a pending resize for fullscreen, don't
6630 do this one, the right one will come later.
6631 The toolkit version doesn't seem to need this, but we
6632 need to reset it below. */
6633 int dont_resize
6634 = ((f->want_fullscreen & FULLSCREEN_WAIT)
6635 && f->new_text_cols != 0);
6636 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6637 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6639 if (dont_resize)
6640 goto OTHER;
6642 /* In the toolkit version, change_frame_size
6643 is called by the code that handles resizing
6644 of the EmacsFrame widget. */
6646 /* Even if the number of character rows and columns has
6647 not changed, the font size may have changed, so we need
6648 to check the pixel dimensions as well. */
6649 if (columns != FRAME_COLS (f)
6650 || rows != FRAME_LINES (f)
6651 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6652 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6654 change_frame_size (f, rows, columns, 0, 1, 0);
6655 SET_FRAME_GARBAGED (f);
6656 cancel_mouse_face (f);
6658 #endif /* not USE_GTK */
6659 #endif
6661 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6662 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6664 #ifdef USE_GTK
6665 /* GTK creates windows but doesn't map them.
6666 Only get real positions and check fullscreen when mapped. */
6667 if (FRAME_GTK_OUTER_WIDGET (f)
6668 && GTK_WIDGET_MAPPED (FRAME_GTK_OUTER_WIDGET (f)))
6669 #endif
6671 /* What we have now is the position of Emacs's own window.
6672 Convert that to the position of the window manager window. */
6673 x_real_positions (f, &f->left_pos, &f->top_pos);
6675 x_check_expected_move (f);
6676 if (f->want_fullscreen & FULLSCREEN_WAIT)
6677 f->want_fullscreen &= ~(FULLSCREEN_WAIT|FULLSCREEN_BOTH);
6680 #ifdef HAVE_X_I18N
6681 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6682 xic_set_statusarea (f);
6683 #endif
6685 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
6687 /* Since the WM decorations come below top_pos now,
6688 we must put them below top_pos in the future. */
6689 f->win_gravity = NorthWestGravity;
6690 x_wm_set_size_hint (f, (long) 0, 0);
6693 goto OTHER;
6695 case ButtonRelease:
6696 case ButtonPress:
6698 /* If we decide we want to generate an event to be seen
6699 by the rest of Emacs, we put it here. */
6700 int tool_bar_p = 0;
6702 bzero (&compose_status, sizeof (compose_status));
6704 if (dpyinfo->grabbed
6705 && last_mouse_frame
6706 && FRAME_LIVE_P (last_mouse_frame))
6707 f = last_mouse_frame;
6708 else
6709 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6711 if (f)
6713 /* Is this in the tool-bar? */
6714 if (WINDOWP (f->tool_bar_window)
6715 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6717 Lisp_Object window;
6718 int x = event.xbutton.x;
6719 int y = event.xbutton.y;
6721 window = window_from_coordinates (f, x, y, 0, 0, 0, 1);
6722 if (EQ (window, f->tool_bar_window))
6724 if (event.xbutton.type == ButtonPress)
6725 handle_tool_bar_click (f, x, y, 1, 0);
6726 else
6727 handle_tool_bar_click (f, x, y, 0,
6728 x_x_to_emacs_modifiers (dpyinfo,
6729 event.xbutton.state));
6730 tool_bar_p = 1;
6734 if (!tool_bar_p)
6735 if (!dpyinfo->x_focus_frame
6736 || f == dpyinfo->x_focus_frame)
6738 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6739 if (! popup_activated ())
6740 #endif
6742 if (ignore_next_mouse_click_timeout)
6744 if (event.type == ButtonPress
6745 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6747 ignore_next_mouse_click_timeout = 0;
6748 construct_mouse_click (&inev.ie, &event, f);
6750 if (event.type == ButtonRelease)
6751 ignore_next_mouse_click_timeout = 0;
6753 else
6754 construct_mouse_click (&inev.ie, &event, f);
6758 else
6760 struct scroll_bar *bar
6761 = x_window_to_scroll_bar (event.xbutton.display,
6762 event.xbutton.window);
6764 #ifdef USE_TOOLKIT_SCROLL_BARS
6765 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6766 scroll bars. */
6767 if (bar && event.xbutton.state & ControlMask)
6769 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6770 *finish = X_EVENT_DROP;
6772 #else /* not USE_TOOLKIT_SCROLL_BARS */
6773 if (bar)
6774 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6775 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6778 if (event.type == ButtonPress)
6780 dpyinfo->grabbed |= (1 << event.xbutton.button);
6781 last_mouse_frame = f;
6783 if (!tool_bar_p)
6784 last_tool_bar_item = -1;
6786 else
6787 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6789 /* Ignore any mouse motion that happened before this event;
6790 any subsequent mouse-movement Emacs events should reflect
6791 only motion after the ButtonPress/Release. */
6792 if (f != 0)
6793 f->mouse_moved = 0;
6795 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6796 f = x_menubar_window_to_frame (dpyinfo, event.xbutton.window);
6797 /* For a down-event in the menu bar,
6798 don't pass it to Xt right now.
6799 Instead, save it away
6800 and we will pass it to Xt from kbd_buffer_get_event.
6801 That way, we can run some Lisp code first. */
6802 if (
6803 #ifdef USE_GTK
6804 ! popup_activated ()
6806 #endif
6807 f && event.type == ButtonPress
6808 /* Verify the event is really within the menu bar
6809 and not just sent to it due to grabbing. */
6810 && event.xbutton.x >= 0
6811 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6812 && event.xbutton.y >= 0
6813 && event.xbutton.y < f->output_data.x->menubar_height
6814 && event.xbutton.same_screen)
6816 SET_SAVED_BUTTON_EVENT;
6817 XSETFRAME (last_mouse_press_frame, f);
6818 #ifdef USE_GTK
6819 *finish = X_EVENT_DROP;
6820 #endif
6822 else if (event.type == ButtonPress)
6824 last_mouse_press_frame = Qnil;
6825 goto OTHER;
6828 #ifdef USE_MOTIF /* This should do not harm for Lucid,
6829 but I am trying to be cautious. */
6830 else if (event.type == ButtonRelease)
6832 if (!NILP (last_mouse_press_frame))
6834 f = XFRAME (last_mouse_press_frame);
6835 if (f->output_data.x)
6836 SET_SAVED_BUTTON_EVENT;
6838 else
6839 goto OTHER;
6841 #endif /* USE_MOTIF */
6842 else
6843 goto OTHER;
6844 #endif /* USE_X_TOOLKIT || USE_GTK */
6846 break;
6848 case CirculateNotify:
6849 goto OTHER;
6851 case CirculateRequest:
6852 goto OTHER;
6854 case VisibilityNotify:
6855 goto OTHER;
6857 case MappingNotify:
6858 /* Someone has changed the keyboard mapping - update the
6859 local cache. */
6860 switch (event.xmapping.request)
6862 case MappingModifier:
6863 x_find_modifier_meanings (dpyinfo);
6864 /* This is meant to fall through. */
6865 case MappingKeyboard:
6866 XRefreshKeyboardMapping (&event.xmapping);
6868 goto OTHER;
6870 default:
6871 OTHER:
6872 #ifdef USE_X_TOOLKIT
6873 BLOCK_INPUT;
6874 if (*finish != X_EVENT_DROP)
6875 XtDispatchEvent (&event);
6876 UNBLOCK_INPUT;
6877 #endif /* USE_X_TOOLKIT */
6878 break;
6881 done:
6882 if (inev.ie.kind != NO_EVENT)
6884 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6885 count++;
6888 if (do_help
6889 && !(hold_quit && hold_quit->kind != NO_EVENT))
6891 Lisp_Object frame;
6893 if (f)
6894 XSETFRAME (frame, f);
6895 else
6896 frame = Qnil;
6898 if (do_help > 0)
6900 any_help_event_p = 1;
6901 gen_help_event (help_echo_string, frame, help_echo_window,
6902 help_echo_object, help_echo_pos);
6904 else
6906 help_echo_string = Qnil;
6907 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
6909 count++;
6912 *eventp = event;
6913 return count;
6917 /* Handles the XEvent EVENT on display DISPLAY.
6918 This is used for event loops outside the normal event handling,
6919 i.e. looping while a popup menu or a dialog is posted.
6921 Returns the value handle_one_xevent sets in the finish argument. */
6923 x_dispatch_event (event, display)
6924 XEvent *event;
6925 Display *display;
6927 struct x_display_info *dpyinfo;
6928 int finish = X_EVENT_NORMAL;
6930 dpyinfo = x_display_info_for_display (display);
6932 if (dpyinfo)
6933 handle_one_xevent (dpyinfo, event, &finish, 0);
6935 return finish;
6939 /* Read events coming from the X server.
6940 This routine is called by the SIGIO handler.
6941 We return as soon as there are no more events to be read.
6943 We return the number of characters stored into the buffer,
6944 thus pretending to be `read'.
6946 EXPECTED is nonzero if the caller knows input is available. */
6948 static int
6949 XTread_socket (sd, expected, hold_quit)
6950 register int sd;
6951 int expected;
6952 struct input_event *hold_quit;
6954 int count = 0;
6955 XEvent event;
6956 int event_found = 0;
6957 struct x_display_info *dpyinfo;
6959 if (interrupt_input_blocked)
6961 interrupt_input_pending = 1;
6962 return -1;
6965 interrupt_input_pending = 0;
6966 BLOCK_INPUT;
6968 /* So people can tell when we have read the available input. */
6969 input_signal_count++;
6971 ++handling_signal;
6973 /* Find the display we are supposed to read input for.
6974 It's the one communicating on descriptor SD. */
6975 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
6977 #if 0 /* This ought to be unnecessary; let's verify it. */
6978 #ifdef FIOSNBIO
6979 /* If available, Xlib uses FIOSNBIO to make the socket
6980 non-blocking, and then looks for EWOULDBLOCK. If O_NDELAY is set,
6981 FIOSNBIO is ignored, and instead of signaling EWOULDBLOCK,
6982 a read returns 0, which Xlib interprets as equivalent to EPIPE. */
6983 fcntl (dpyinfo->connection, F_SETFL, 0);
6984 #endif /* ! defined (FIOSNBIO) */
6985 #endif
6987 #if 0 /* This code can't be made to work, with multiple displays,
6988 and appears not to be used on any system any more.
6989 Also keyboard.c doesn't turn O_NDELAY on and off
6990 for X connections. */
6991 #ifndef SIGIO
6992 #ifndef HAVE_SELECT
6993 if (! (fcntl (dpyinfo->connection, F_GETFL, 0) & O_NDELAY))
6995 extern int read_alarm_should_throw;
6996 read_alarm_should_throw = 1;
6997 XPeekEvent (dpyinfo->display, &event);
6998 read_alarm_should_throw = 0;
7000 #endif /* HAVE_SELECT */
7001 #endif /* SIGIO */
7002 #endif
7004 /* For debugging, this gives a way to fake an I/O error. */
7005 if (dpyinfo == XTread_socket_fake_io_error)
7007 XTread_socket_fake_io_error = 0;
7008 x_io_error_quitter (dpyinfo->display);
7011 #ifdef HAVE_X_SM
7013 struct input_event inev;
7014 BLOCK_INPUT;
7015 /* We don't need to EVENT_INIT (inev) here, as
7016 x_session_check_input copies an entire input_event. */
7017 if (x_session_check_input (&inev))
7019 kbd_buffer_store_event_hold (&inev, hold_quit);
7020 count++;
7022 UNBLOCK_INPUT;
7024 #endif
7026 #ifndef USE_GTK
7027 while (XPending (dpyinfo->display))
7029 int finish;
7031 XNextEvent (dpyinfo->display, &event);
7033 #ifdef HAVE_X_I18N
7034 /* Filter events for the current X input method. */
7035 if (x_filter_event (dpyinfo, &event))
7036 break;
7037 #endif
7038 event_found = 1;
7040 count += handle_one_xevent (dpyinfo, &event, &finish, hold_quit);
7042 if (finish == X_EVENT_GOTO_OUT)
7043 goto out;
7045 #endif /* not USE_GTK */
7048 #ifdef USE_GTK
7050 /* For GTK we must use the GTK event loop. But XEvents gets passed
7051 to our filter function above, and then to the big event switch.
7052 We use a bunch of globals to communicate with our filter function,
7053 that is kind of ugly, but it works.
7055 There is no way to do one display at the time, GTK just does events
7056 from all displays. */
7058 while (gtk_events_pending ())
7060 current_count = count;
7061 current_hold_quit = hold_quit;
7063 gtk_main_iteration ();
7065 count = current_count;
7066 current_count = -1;
7067 current_hold_quit = 0;
7069 if (current_finish == X_EVENT_GOTO_OUT)
7070 break;
7072 #endif /* USE_GTK */
7074 out:;
7076 /* On some systems, an X bug causes Emacs to get no more events
7077 when the window is destroyed. Detect that. (1994.) */
7078 if (! event_found)
7080 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7081 One XNOOP in 100 loops will make Emacs terminate.
7082 B. Bretthauer, 1994 */
7083 x_noop_count++;
7084 if (x_noop_count >= 100)
7086 x_noop_count=0;
7088 if (next_noop_dpyinfo == 0)
7089 next_noop_dpyinfo = x_display_list;
7091 XNoOp (next_noop_dpyinfo->display);
7093 /* Each time we get here, cycle through the displays now open. */
7094 next_noop_dpyinfo = next_noop_dpyinfo->next;
7098 /* If the focus was just given to an auto-raising frame,
7099 raise it now. */
7100 /* ??? This ought to be able to handle more than one such frame. */
7101 if (pending_autoraise_frame)
7103 x_raise_frame (pending_autoraise_frame);
7104 pending_autoraise_frame = 0;
7107 --handling_signal;
7108 UNBLOCK_INPUT;
7110 return count;
7116 /***********************************************************************
7117 Text Cursor
7118 ***********************************************************************/
7120 /* Set clipping for output in glyph row ROW. W is the window in which
7121 we operate. GC is the graphics context to set clipping in.
7123 ROW may be a text row or, e.g., a mode line. Text rows must be
7124 clipped to the interior of the window dedicated to text display,
7125 mode lines must be clipped to the whole window. */
7127 static void
7128 x_clip_to_row (w, row, area, gc)
7129 struct window *w;
7130 struct glyph_row *row;
7131 int area;
7132 GC gc;
7134 struct frame *f = XFRAME (WINDOW_FRAME (w));
7135 XRectangle clip_rect;
7136 int window_x, window_y, window_width;
7138 window_box (w, area, &window_x, &window_y, &window_width, 0);
7140 clip_rect.x = window_x;
7141 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7142 clip_rect.y = max (clip_rect.y, window_y);
7143 clip_rect.width = window_width;
7144 clip_rect.height = row->visible_height;
7146 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7150 /* Draw a hollow box cursor on window W in glyph row ROW. */
7152 static void
7153 x_draw_hollow_cursor (w, row)
7154 struct window *w;
7155 struct glyph_row *row;
7157 struct frame *f = XFRAME (WINDOW_FRAME (w));
7158 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7159 Display *dpy = FRAME_X_DISPLAY (f);
7160 int x, y, wd, h;
7161 XGCValues xgcv;
7162 struct glyph *cursor_glyph;
7163 GC gc;
7165 /* Get the glyph the cursor is on. If we can't tell because
7166 the current matrix is invalid or such, give up. */
7167 cursor_glyph = get_phys_cursor_glyph (w);
7168 if (cursor_glyph == NULL)
7169 return;
7171 /* Compute frame-relative coordinates for phys cursor. */
7172 x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x);
7173 y = get_phys_cursor_geometry (w, row, cursor_glyph, &h);
7174 wd = w->phys_cursor_width;
7176 /* The foreground of cursor_gc is typically the same as the normal
7177 background color, which can cause the cursor box to be invisible. */
7178 xgcv.foreground = f->output_data.x->cursor_pixel;
7179 if (dpyinfo->scratch_cursor_gc)
7180 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7181 else
7182 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7183 GCForeground, &xgcv);
7184 gc = dpyinfo->scratch_cursor_gc;
7186 /* Set clipping, draw the rectangle, and reset clipping again. */
7187 x_clip_to_row (w, row, TEXT_AREA, gc);
7188 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h);
7189 XSetClipMask (dpy, gc, None);
7193 /* Draw a bar cursor on window W in glyph row ROW.
7195 Implementation note: One would like to draw a bar cursor with an
7196 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7197 Unfortunately, I didn't find a font yet that has this property set.
7198 --gerd. */
7200 static void
7201 x_draw_bar_cursor (w, row, width, kind)
7202 struct window *w;
7203 struct glyph_row *row;
7204 int width;
7205 enum text_cursor_kinds kind;
7207 struct frame *f = XFRAME (w->frame);
7208 struct glyph *cursor_glyph;
7210 /* If cursor is out of bounds, don't draw garbage. This can happen
7211 in mini-buffer windows when switching between echo area glyphs
7212 and mini-buffer. */
7213 cursor_glyph = get_phys_cursor_glyph (w);
7214 if (cursor_glyph == NULL)
7215 return;
7217 /* If on an image, draw like a normal cursor. That's usually better
7218 visible than drawing a bar, esp. if the image is large so that
7219 the bar might not be in the window. */
7220 if (cursor_glyph->type == IMAGE_GLYPH)
7222 struct glyph_row *row;
7223 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7224 draw_phys_cursor_glyph (w, row, DRAW_CURSOR);
7226 else
7228 Display *dpy = FRAME_X_DISPLAY (f);
7229 Window window = FRAME_X_WINDOW (f);
7230 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7231 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7232 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7233 XGCValues xgcv;
7235 /* If the glyph's background equals the color we normally draw
7236 the bar cursor in, the bar cursor in its normal color is
7237 invisible. Use the glyph's foreground color instead in this
7238 case, on the assumption that the glyph's colors are chosen so
7239 that the glyph is legible. */
7240 if (face->background == f->output_data.x->cursor_pixel)
7241 xgcv.background = xgcv.foreground = face->foreground;
7242 else
7243 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7244 xgcv.graphics_exposures = 0;
7246 if (gc)
7247 XChangeGC (dpy, gc, mask, &xgcv);
7248 else
7250 gc = XCreateGC (dpy, window, mask, &xgcv);
7251 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7254 if (width < 0)
7255 width = FRAME_CURSOR_WIDTH (f);
7256 width = min (cursor_glyph->pixel_width, width);
7258 w->phys_cursor_width = width;
7259 x_clip_to_row (w, row, TEXT_AREA, gc);
7261 if (kind == BAR_CURSOR)
7262 XFillRectangle (dpy, window, gc,
7263 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7264 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7265 width, row->height);
7266 else
7267 XFillRectangle (dpy, window, gc,
7268 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7269 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7270 row->height - width),
7271 cursor_glyph->pixel_width,
7272 width);
7274 XSetClipMask (dpy, gc, None);
7279 /* RIF: Define cursor CURSOR on frame F. */
7281 static void
7282 x_define_frame_cursor (f, cursor)
7283 struct frame *f;
7284 Cursor cursor;
7286 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7290 /* RIF: Clear area on frame F. */
7292 static void
7293 x_clear_frame_area (f, x, y, width, height)
7294 struct frame *f;
7295 int x, y, width, height;
7297 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7298 x, y, width, height, False);
7302 /* RIF: Draw cursor on window W. */
7304 static void
7305 x_draw_window_cursor (w, glyph_row, x, y, cursor_type, cursor_width, on_p, active_p)
7306 struct window *w;
7307 struct glyph_row *glyph_row;
7308 int x, y;
7309 int cursor_type, cursor_width;
7310 int on_p, active_p;
7312 struct frame *f = XFRAME (WINDOW_FRAME (w));
7314 if (on_p)
7316 w->phys_cursor_type = cursor_type;
7317 w->phys_cursor_on_p = 1;
7319 if (glyph_row->exact_window_width_line_p
7320 && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
7322 glyph_row->cursor_in_fringe_p = 1;
7323 draw_fringe_bitmap (w, glyph_row, 0);
7325 else
7326 switch (cursor_type)
7328 case HOLLOW_BOX_CURSOR:
7329 x_draw_hollow_cursor (w, glyph_row);
7330 break;
7332 case FILLED_BOX_CURSOR:
7333 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7334 break;
7336 case BAR_CURSOR:
7337 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7338 break;
7340 case HBAR_CURSOR:
7341 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7342 break;
7344 case NO_CURSOR:
7345 w->phys_cursor_width = 0;
7346 break;
7348 default:
7349 abort ();
7352 #ifdef HAVE_X_I18N
7353 if (w == XWINDOW (f->selected_window))
7354 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7355 xic_set_preeditarea (w, x, y);
7356 #endif
7359 #ifndef XFlush
7360 if (updating_frame != f)
7361 XFlush (FRAME_X_DISPLAY (f));
7362 #endif
7366 /* Icons. */
7368 /* Make the x-window of frame F use the gnu icon bitmap. */
7371 x_bitmap_icon (f, file)
7372 struct frame *f;
7373 Lisp_Object file;
7375 int bitmap_id;
7377 if (FRAME_X_WINDOW (f) == 0)
7378 return 1;
7380 /* Free up our existing icon bitmap and mask if any. */
7381 if (f->output_data.x->icon_bitmap > 0)
7382 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7383 f->output_data.x->icon_bitmap = 0;
7385 if (STRINGP (file))
7387 #ifdef USE_GTK
7388 /* Use gtk_window_set_icon_from_file () if available,
7389 It's not restricted to bitmaps */
7390 if (xg_set_icon (f, file))
7391 return 0;
7392 #endif /* USE_GTK */
7393 bitmap_id = x_create_bitmap_from_file (f, file);
7394 x_create_bitmap_mask (f, bitmap_id);
7396 else
7398 /* Create the GNU bitmap and mask if necessary. */
7399 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7401 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id
7402 = x_create_bitmap_from_data (f, gnu_bits,
7403 gnu_width, gnu_height);
7404 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7407 /* The first time we create the GNU bitmap and mask,
7408 this increments the ref-count one extra time.
7409 As a result, the GNU bitmap and mask are never freed.
7410 That way, we don't have to worry about allocating it again. */
7411 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7413 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7416 x_wm_set_icon_pixmap (f, bitmap_id);
7417 f->output_data.x->icon_bitmap = bitmap_id;
7419 return 0;
7423 /* Make the x-window of frame F use a rectangle with text.
7424 Use ICON_NAME as the text. */
7427 x_text_icon (f, icon_name)
7428 struct frame *f;
7429 char *icon_name;
7431 if (FRAME_X_WINDOW (f) == 0)
7432 return 1;
7434 #ifdef HAVE_X11R4
7436 XTextProperty text;
7437 text.value = (unsigned char *) icon_name;
7438 text.encoding = XA_STRING;
7439 text.format = 8;
7440 text.nitems = strlen (icon_name);
7441 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7443 #else /* not HAVE_X11R4 */
7444 XSetIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), icon_name);
7445 #endif /* not HAVE_X11R4 */
7447 if (f->output_data.x->icon_bitmap > 0)
7448 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7449 f->output_data.x->icon_bitmap = 0;
7450 x_wm_set_icon_pixmap (f, 0);
7452 return 0;
7455 #define X_ERROR_MESSAGE_SIZE 200
7457 /* If non-nil, this should be a string.
7458 It means catch X errors and store the error message in this string. */
7460 static Lisp_Object x_error_message_string;
7462 /* An X error handler which stores the error message in
7463 x_error_message_string. This is called from x_error_handler if
7464 x_catch_errors is in effect. */
7466 static void
7467 x_error_catcher (display, error)
7468 Display *display;
7469 XErrorEvent *error;
7471 XGetErrorText (display, error->error_code,
7472 SDATA (x_error_message_string),
7473 X_ERROR_MESSAGE_SIZE);
7476 /* Begin trapping X errors for display DPY. Actually we trap X errors
7477 for all displays, but DPY should be the display you are actually
7478 operating on.
7480 After calling this function, X protocol errors no longer cause
7481 Emacs to exit; instead, they are recorded in the string
7482 stored in x_error_message_string.
7484 Calling x_check_errors signals an Emacs error if an X error has
7485 occurred since the last call to x_catch_errors or x_check_errors.
7487 Calling x_uncatch_errors resumes the normal error handling. */
7489 void x_check_errors ();
7490 static Lisp_Object x_catch_errors_unwind ();
7493 x_catch_errors (dpy)
7494 Display *dpy;
7496 int count = SPECPDL_INDEX ();
7498 /* Make sure any errors from previous requests have been dealt with. */
7499 XSync (dpy, False);
7501 record_unwind_protect (x_catch_errors_unwind,
7502 Fcons (make_save_value (dpy, 0),
7503 x_error_message_string));
7505 x_error_message_string = make_uninit_string (X_ERROR_MESSAGE_SIZE);
7506 SSET (x_error_message_string, 0, 0);
7508 return count;
7511 /* Unbind the binding that we made to check for X errors. */
7513 static Lisp_Object
7514 x_catch_errors_unwind (old_val)
7515 Lisp_Object old_val;
7517 Lisp_Object first = XCAR (old_val);
7518 Display *dpy = XSAVE_VALUE (first)->pointer;
7520 /* The display may have been closed before this function is called.
7521 Check if it is still open before calling XSync. */
7522 if (x_display_info_for_display (dpy) != 0)
7524 BLOCK_INPUT;
7525 XSync (dpy, False);
7526 UNBLOCK_INPUT;
7529 x_error_message_string = XCDR (old_val);
7530 return Qnil;
7533 /* If any X protocol errors have arrived since the last call to
7534 x_catch_errors or x_check_errors, signal an Emacs error using
7535 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7537 void
7538 x_check_errors (dpy, format)
7539 Display *dpy;
7540 char *format;
7542 /* Make sure to catch any errors incurred so far. */
7543 XSync (dpy, False);
7545 if (SREF (x_error_message_string, 0))
7546 error (format, SDATA (x_error_message_string));
7549 /* Nonzero if we had any X protocol errors
7550 since we did x_catch_errors on DPY. */
7553 x_had_errors_p (dpy)
7554 Display *dpy;
7556 /* Make sure to catch any errors incurred so far. */
7557 XSync (dpy, False);
7559 return SREF (x_error_message_string, 0) != 0;
7562 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7564 void
7565 x_clear_errors (dpy)
7566 Display *dpy;
7568 SSET (x_error_message_string, 0, 0);
7571 /* Stop catching X protocol errors and let them make Emacs die.
7572 DPY should be the display that was passed to x_catch_errors.
7573 COUNT should be the value that was returned by
7574 the corresponding call to x_catch_errors. */
7576 void
7577 x_uncatch_errors (dpy, count)
7578 Display *dpy;
7579 int count;
7581 unbind_to (count, Qnil);
7584 #if 0
7585 static unsigned int x_wire_count;
7586 x_trace_wire ()
7588 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7590 #endif /* ! 0 */
7593 /* Handle SIGPIPE, which can happen when the connection to a server
7594 simply goes away. SIGPIPE is handled by x_connection_signal.
7595 Don't need to do anything, because the write which caused the
7596 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7597 which will do the appropriate cleanup for us. */
7599 static SIGTYPE
7600 x_connection_signal (signalnum) /* If we don't have an argument, */
7601 int signalnum; /* some compilers complain in signal calls. */
7603 #ifdef USG
7604 /* USG systems forget handlers when they are used;
7605 must reestablish each time */
7606 signal (signalnum, x_connection_signal);
7607 #endif /* USG */
7611 /************************************************************************
7612 Handling X errors
7613 ************************************************************************/
7615 /* Error message passed to x_connection_closed. */
7617 static char *error_msg;
7619 /* Function installed as fatal_error_signal_hook in
7620 x_connection_closed. Print the X error message, and exit normally,
7621 instead of dumping core when XtCloseDisplay fails. */
7623 static void
7624 x_fatal_error_signal ()
7626 fprintf (stderr, "%s\n", error_msg);
7627 exit (70);
7630 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7631 the text of an error message that lead to the connection loss. */
7633 static SIGTYPE
7634 x_connection_closed (dpy, error_message)
7635 Display *dpy;
7636 char *error_message;
7638 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7639 Lisp_Object frame, tail;
7640 int count;
7642 error_msg = (char *) alloca (strlen (error_message) + 1);
7643 strcpy (error_msg, error_message);
7644 handling_signal = 0;
7646 /* Prevent being called recursively because of an error condition
7647 below. Otherwise, we might end up with printing ``can't find per
7648 display information'' in the recursive call instead of printing
7649 the original message here. */
7650 count = x_catch_errors (dpy);
7652 /* We have to close the display to inform Xt that it doesn't
7653 exist anymore. If we don't, Xt will continue to wait for
7654 events from the display. As a consequence, a sequence of
7656 M-x make-frame-on-display RET :1 RET
7657 ...kill the new frame, so that we get an IO error...
7658 M-x make-frame-on-display RET :1 RET
7660 will indefinitely wait in Xt for events for display `:1', opened
7661 in the first class to make-frame-on-display.
7663 Closing the display is reported to lead to a bus error on
7664 OpenWindows in certain situations. I suspect that is a bug
7665 in OpenWindows. I don't know how to cicumvent it here. */
7667 #ifdef USE_X_TOOLKIT
7668 /* If DPYINFO is null, this means we didn't open the display
7669 in the first place, so don't try to close it. */
7670 if (dpyinfo)
7672 extern void (*fatal_error_signal_hook) P_ ((void));
7673 fatal_error_signal_hook = x_fatal_error_signal;
7674 XtCloseDisplay (dpy);
7675 fatal_error_signal_hook = NULL;
7677 #endif
7679 #ifdef USE_GTK
7680 if (dpyinfo)
7681 xg_display_close (dpyinfo->display);
7682 #endif
7684 /* Indicate that this display is dead. */
7685 if (dpyinfo)
7686 dpyinfo->display = 0;
7688 /* First delete frames whose mini-buffers are on frames
7689 that are on the dead display. */
7690 FOR_EACH_FRAME (tail, frame)
7692 Lisp_Object minibuf_frame;
7693 minibuf_frame
7694 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7695 if (FRAME_X_P (XFRAME (frame))
7696 && FRAME_X_P (XFRAME (minibuf_frame))
7697 && ! EQ (frame, minibuf_frame)
7698 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7699 Fdelete_frame (frame, Qt);
7702 /* Now delete all remaining frames on the dead display.
7703 We are now sure none of these is used as the mini-buffer
7704 for another frame that we need to delete. */
7705 FOR_EACH_FRAME (tail, frame)
7706 if (FRAME_X_P (XFRAME (frame))
7707 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7709 /* Set this to t so that Fdelete_frame won't get confused
7710 trying to find a replacement. */
7711 FRAME_KBOARD (XFRAME (frame))->Vdefault_minibuffer_frame = Qt;
7712 Fdelete_frame (frame, Qt);
7715 if (dpyinfo)
7716 x_delete_display (dpyinfo);
7718 x_uncatch_errors (dpy, count);
7720 if (x_display_list == 0)
7722 fprintf (stderr, "%s\n", error_msg);
7723 shut_down_emacs (0, 0, Qnil);
7724 exit (70);
7727 /* Ordinary stack unwind doesn't deal with these. */
7728 #ifdef SIGIO
7729 sigunblock (sigmask (SIGIO));
7730 #endif
7731 sigunblock (sigmask (SIGALRM));
7732 TOTALLY_UNBLOCK_INPUT;
7734 clear_waiting_for_input ();
7735 error ("%s", error_msg);
7738 /* We specifically use it before defining it, so that gcc doesn't inline it,
7739 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7740 static void x_error_quitter (Display *display, XErrorEvent *error);
7742 /* This is the first-level handler for X protocol errors.
7743 It calls x_error_quitter or x_error_catcher. */
7745 static int
7746 x_error_handler (display, error)
7747 Display *display;
7748 XErrorEvent *error;
7750 if (! NILP (x_error_message_string))
7751 x_error_catcher (display, error);
7752 else
7753 x_error_quitter (display, error);
7754 return 0;
7757 /* This is the usual handler for X protocol errors.
7758 It kills all frames on the display that we got the error for.
7759 If that was the only one, it prints an error message and kills Emacs. */
7761 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7763 #if __GNUC__ >= 3 /* On GCC 3.0 we might get a warning. */
7764 #define NO_INLINE __attribute__((noinline))
7765 #else
7766 #define NO_INLINE
7767 #endif
7769 /* Some versions of GNU/Linux define noinline in their headers. */
7771 #ifdef noinline
7772 #undef noinline
7773 #endif
7775 /* On older GCC versions, just putting x_error_quitter
7776 after x_error_handler prevents inlining into the former. */
7778 static void NO_INLINE
7779 x_error_quitter (display, error)
7780 Display *display;
7781 XErrorEvent *error;
7783 char buf[256], buf1[356];
7785 /* Note that there is no real way portable across R3/R4 to get the
7786 original error handler. */
7788 XGetErrorText (display, error->error_code, buf, sizeof (buf));
7789 sprintf (buf1, "X protocol error: %s on protocol request %d",
7790 buf, error->request_code);
7791 x_connection_closed (display, buf1);
7795 /* This is the handler for X IO errors, always.
7796 It kills all frames on the display that we lost touch with.
7797 If that was the only one, it prints an error message and kills Emacs. */
7799 static int
7800 x_io_error_quitter (display)
7801 Display *display;
7803 char buf[256];
7805 sprintf (buf, "Connection lost to X server `%s'", DisplayString (display));
7806 x_connection_closed (display, buf);
7807 return 0;
7810 /* Changing the font of the frame. */
7812 /* Give frame F the font named FONTNAME as its default font, and
7813 return the full name of that font. FONTNAME may be a wildcard
7814 pattern; in that case, we choose some font that fits the pattern.
7815 The return value shows which font we chose. */
7817 Lisp_Object
7818 x_new_font (f, fontname)
7819 struct frame *f;
7820 register char *fontname;
7822 struct font_info *fontp
7823 = FS_LOAD_FONT (f, 0, fontname, -1);
7825 if (!fontp)
7826 return Qnil;
7828 FRAME_FONT (f) = (XFontStruct *) (fontp->font);
7829 FRAME_BASELINE_OFFSET (f) = fontp->baseline_offset;
7830 FRAME_FONTSET (f) = -1;
7832 FRAME_COLUMN_WIDTH (f) = fontp->average_width;
7833 FRAME_SPACE_WIDTH (f) = fontp->space_width;
7834 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (FRAME_FONT (f));
7836 compute_fringe_widths (f, 1);
7838 /* Compute the scroll bar width in character columns. */
7839 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7841 int wid = FRAME_COLUMN_WIDTH (f);
7842 FRAME_CONFIG_SCROLL_BAR_COLS (f)
7843 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
7845 else
7847 int wid = FRAME_COLUMN_WIDTH (f);
7848 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7851 /* Now make the frame display the given font. */
7852 if (FRAME_X_WINDOW (f) != 0)
7854 XSetFont (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
7855 FRAME_FONT (f)->fid);
7856 XSetFont (FRAME_X_DISPLAY (f), f->output_data.x->reverse_gc,
7857 FRAME_FONT (f)->fid);
7858 XSetFont (FRAME_X_DISPLAY (f), f->output_data.x->cursor_gc,
7859 FRAME_FONT (f)->fid);
7861 /* Don't change the size of a tip frame; there's no point in
7862 doing it because it's done in Fx_show_tip, and it leads to
7863 problems because the tip frame has no widget. */
7864 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
7865 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7868 return build_string (fontp->full_name);
7871 /* Give frame F the fontset named FONTSETNAME as its default font, and
7872 return the full name of that fontset. FONTSETNAME may be a wildcard
7873 pattern; in that case, we choose some fontset that fits the pattern.
7874 The return value shows which fontset we chose. */
7876 Lisp_Object
7877 x_new_fontset (f, fontsetname)
7878 struct frame *f;
7879 char *fontsetname;
7881 int fontset = fs_query_fontset (build_string (fontsetname), 0);
7882 Lisp_Object result;
7884 if (fontset < 0)
7885 return Qnil;
7887 if (FRAME_FONTSET (f) == fontset)
7888 /* This fontset is already set in frame F. There's nothing more
7889 to do. */
7890 return fontset_name (fontset);
7892 result = x_new_font (f, (SDATA (fontset_ascii (fontset))));
7894 if (!STRINGP (result))
7895 /* Can't load ASCII font. */
7896 return Qnil;
7898 /* Since x_new_font doesn't update any fontset information, do it now. */
7899 FRAME_FONTSET (f) = fontset;
7901 #ifdef HAVE_X_I18N
7902 if (FRAME_XIC (f)
7903 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
7904 xic_set_xfontset (f, SDATA (fontset_ascii (fontset)));
7905 #endif
7907 return build_string (fontsetname);
7911 /***********************************************************************
7912 X Input Methods
7913 ***********************************************************************/
7915 #ifdef HAVE_X_I18N
7917 #ifdef HAVE_X11R6
7919 /* XIM destroy callback function, which is called whenever the
7920 connection to input method XIM dies. CLIENT_DATA contains a
7921 pointer to the x_display_info structure corresponding to XIM. */
7923 static void
7924 xim_destroy_callback (xim, client_data, call_data)
7925 XIM xim;
7926 XPointer client_data;
7927 XPointer call_data;
7929 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
7930 Lisp_Object frame, tail;
7932 BLOCK_INPUT;
7934 /* No need to call XDestroyIC.. */
7935 FOR_EACH_FRAME (tail, frame)
7937 struct frame *f = XFRAME (frame);
7938 if (FRAME_X_DISPLAY_INFO (f) == dpyinfo)
7940 FRAME_XIC (f) = NULL;
7941 xic_free_xfontset (f);
7945 /* No need to call XCloseIM. */
7946 dpyinfo->xim = NULL;
7947 XFree (dpyinfo->xim_styles);
7948 UNBLOCK_INPUT;
7951 #endif /* HAVE_X11R6 */
7953 #ifdef HAVE_X11R6
7954 /* This isn't prototyped in OSF 5.0 or 5.1a. */
7955 extern char *XSetIMValues P_ ((XIM, ...));
7956 #endif
7958 /* Open the connection to the XIM server on display DPYINFO.
7959 RESOURCE_NAME is the resource name Emacs uses. */
7961 static void
7962 xim_open_dpy (dpyinfo, resource_name)
7963 struct x_display_info *dpyinfo;
7964 char *resource_name;
7966 XIM xim;
7968 #ifdef HAVE_XIM
7969 if (use_xim)
7971 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
7972 EMACS_CLASS);
7973 dpyinfo->xim = xim;
7975 if (xim)
7977 #ifdef HAVE_X11R6
7978 XIMCallback destroy;
7979 #endif
7981 /* Get supported styles and XIM values. */
7982 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
7984 #ifdef HAVE_X11R6
7985 destroy.callback = xim_destroy_callback;
7986 destroy.client_data = (XPointer)dpyinfo;
7987 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
7988 #endif
7992 else
7993 #endif /* HAVE_XIM */
7994 dpyinfo->xim = NULL;
7998 #ifdef HAVE_X11R6_XIM
8000 struct xim_inst_t
8002 struct x_display_info *dpyinfo;
8003 char *resource_name;
8006 /* XIM instantiate callback function, which is called whenever an XIM
8007 server is available. DISPLAY is the display of the XIM.
8008 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8009 when the callback was registered. */
8011 static void
8012 xim_instantiate_callback (display, client_data, call_data)
8013 Display *display;
8014 XPointer client_data;
8015 XPointer call_data;
8017 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8018 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8020 /* We don't support multiple XIM connections. */
8021 if (dpyinfo->xim)
8022 return;
8024 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8026 /* Create XIC for the existing frames on the same display, as long
8027 as they have no XIC. */
8028 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8030 Lisp_Object tail, frame;
8032 BLOCK_INPUT;
8033 FOR_EACH_FRAME (tail, frame)
8035 struct frame *f = XFRAME (frame);
8037 if (FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8038 if (FRAME_XIC (f) == NULL)
8040 create_frame_xic (f);
8041 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8042 xic_set_statusarea (f);
8043 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8045 struct window *w = XWINDOW (f->selected_window);
8046 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8051 UNBLOCK_INPUT;
8055 #endif /* HAVE_X11R6_XIM */
8058 /* Open a connection to the XIM server on display DPYINFO.
8059 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8060 connection only at the first time. On X11R6, open the connection
8061 in the XIM instantiate callback function. */
8063 static void
8064 xim_initialize (dpyinfo, resource_name)
8065 struct x_display_info *dpyinfo;
8066 char *resource_name;
8068 #ifdef HAVE_XIM
8069 if (use_xim)
8071 #ifdef HAVE_X11R6_XIM
8072 struct xim_inst_t *xim_inst;
8073 int len;
8075 dpyinfo->xim = NULL;
8076 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
8077 xim_inst->dpyinfo = dpyinfo;
8078 len = strlen (resource_name);
8079 xim_inst->resource_name = (char *) xmalloc (len + 1);
8080 bcopy (resource_name, xim_inst->resource_name, len + 1);
8081 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8082 resource_name, EMACS_CLASS,
8083 xim_instantiate_callback,
8084 /* This is XPointer in XFree86
8085 but (XPointer *) on Tru64, at
8086 least, hence the configure test. */
8087 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8088 #else /* not HAVE_X11R6_XIM */
8089 dpyinfo->xim = NULL;
8090 xim_open_dpy (dpyinfo, resource_name);
8091 #endif /* not HAVE_X11R6_XIM */
8094 else
8095 #endif /* HAVE_XIM */
8096 dpyinfo->xim = NULL;
8100 /* Close the connection to the XIM server on display DPYINFO. */
8102 static void
8103 xim_close_dpy (dpyinfo)
8104 struct x_display_info *dpyinfo;
8106 #ifdef HAVE_XIM
8107 if (use_xim)
8109 #ifdef HAVE_X11R6_XIM
8110 if (dpyinfo->display)
8111 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8112 NULL, EMACS_CLASS,
8113 xim_instantiate_callback, NULL);
8114 #endif /* not HAVE_X11R6_XIM */
8115 if (dpyinfo->display)
8116 XCloseIM (dpyinfo->xim);
8117 dpyinfo->xim = NULL;
8118 XFree (dpyinfo->xim_styles);
8120 #endif /* HAVE_XIM */
8123 #endif /* not HAVE_X11R6_XIM */
8127 /* Calculate the absolute position in frame F
8128 from its current recorded position values and gravity. */
8130 void
8131 x_calc_absolute_position (f)
8132 struct frame *f;
8134 int win_x = 0, win_y = 0;
8135 int flags = f->size_hint_flags;
8137 /* We have nothing to do if the current position
8138 is already for the top-left corner. */
8139 if (! ((flags & XNegative) || (flags & YNegative)))
8140 return;
8142 /* Treat negative positions as relative to the leftmost bottommost
8143 position that fits on the screen. */
8144 if (flags & XNegative)
8145 f->left_pos = (FRAME_X_DISPLAY_INFO (f)->width
8146 - FRAME_PIXEL_WIDTH (f) + f->left_pos);
8149 int height = FRAME_PIXEL_HEIGHT (f);
8151 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8152 /* Something is fishy here. When using Motif, starting Emacs with
8153 `-g -0-0', the frame appears too low by a few pixels.
8155 This seems to be so because initially, while Emacs is starting,
8156 the column widget's height and the frame's pixel height are
8157 different. The column widget's height is the right one. In
8158 later invocations, when Emacs is up, the frame's pixel height
8159 is right, though.
8161 It's not obvious where the initial small difference comes from.
8162 2000-12-01, gerd. */
8164 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8165 #endif
8167 if (flags & YNegative)
8168 f->top_pos = (FRAME_X_DISPLAY_INFO (f)->height - height + f->top_pos);
8171 /* The left_pos and top_pos
8172 are now relative to the top and left screen edges,
8173 so the flags should correspond. */
8174 f->size_hint_flags &= ~ (XNegative | YNegative);
8177 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8178 to really change the position, and 0 when calling from
8179 x_make_frame_visible (in that case, XOFF and YOFF are the current
8180 position values). It is -1 when calling from x_set_frame_parameters,
8181 which means, do adjust for borders but don't change the gravity. */
8183 void
8184 x_set_offset (f, xoff, yoff, change_gravity)
8185 struct frame *f;
8186 register int xoff, yoff;
8187 int change_gravity;
8189 int modified_top, modified_left;
8191 if (change_gravity > 0)
8193 f->top_pos = yoff;
8194 f->left_pos = xoff;
8195 f->size_hint_flags &= ~ (XNegative | YNegative);
8196 if (xoff < 0)
8197 f->size_hint_flags |= XNegative;
8198 if (yoff < 0)
8199 f->size_hint_flags |= YNegative;
8200 f->win_gravity = NorthWestGravity;
8202 x_calc_absolute_position (f);
8204 BLOCK_INPUT;
8205 x_wm_set_size_hint (f, (long) 0, 0);
8207 modified_left = f->left_pos;
8208 modified_top = f->top_pos;
8210 if (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8212 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8213 than the WM decorations. So we use the calculated offset instead
8214 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8215 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8216 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8219 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8220 modified_left, modified_top);
8222 if (FRAME_VISIBLE_P (f)
8223 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN)
8225 FRAME_X_OUTPUT (f)->check_expected_move = 1;
8226 FRAME_X_OUTPUT (f)->expected_top = f->top_pos;
8227 FRAME_X_OUTPUT (f)->expected_left = f->left_pos;
8230 UNBLOCK_INPUT;
8233 /* Check if we need to resize the frame due to a fullscreen request.
8234 If so needed, resize the frame. */
8235 static void
8236 x_check_fullscreen (f)
8237 struct frame *f;
8239 if (f->want_fullscreen & FULLSCREEN_BOTH)
8241 int width, height, ign;
8243 x_real_positions (f, &f->left_pos, &f->top_pos);
8245 x_fullscreen_adjust (f, &width, &height, &ign, &ign);
8247 /* We do not need to move the window, it shall be taken care of
8248 when setting WM manager hints.
8249 If the frame is visible already, the position is checked by
8250 x_check_expected_move. */
8251 if (FRAME_COLS (f) != width || FRAME_LINES (f) != height)
8253 change_frame_size (f, height, width, 0, 1, 0);
8254 SET_FRAME_GARBAGED (f);
8255 cancel_mouse_face (f);
8257 /* Wait for the change of frame size to occur */
8258 f->want_fullscreen |= FULLSCREEN_WAIT;
8263 /* If frame parameters are set after the frame is mapped, we need to move
8264 the window.
8265 Some window managers moves the window to the right position, some
8266 moves the outer window manager window to the specified position.
8267 Here we check that we are in the right spot. If not, make a second
8268 move, assuming we are dealing with the second kind of window manager. */
8269 static void
8270 x_check_expected_move (f)
8271 struct frame *f;
8273 if (FRAME_X_OUTPUT (f)->check_expected_move)
8275 int expect_top = FRAME_X_OUTPUT (f)->expected_top;
8276 int expect_left = FRAME_X_OUTPUT (f)->expected_left;
8278 if (expect_top != f->top_pos || expect_left != f->left_pos)
8280 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8281 FRAME_X_OUTPUT (f)->move_offset_left = expect_left - f->left_pos;
8282 FRAME_X_OUTPUT (f)->move_offset_top = expect_top - f->top_pos;
8284 f->left_pos = expect_left;
8285 f->top_pos = expect_top;
8286 x_set_offset (f, expect_left, expect_top, 0);
8288 else if (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN)
8289 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8291 /* Just do this once */
8292 FRAME_X_OUTPUT (f)->check_expected_move = 0;
8297 /* Change the size of frame F's X window to COLS/ROWS in the case F
8298 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8299 top-left-corner window gravity for this size change and subsequent
8300 size changes. Otherwise we leave the window gravity unchanged. */
8302 static void
8303 x_set_window_size_1 (f, change_gravity, cols, rows)
8304 struct frame *f;
8305 int change_gravity;
8306 int cols, rows;
8308 int pixelwidth, pixelheight;
8310 check_frame_size (f, &rows, &cols);
8311 f->scroll_bar_actual_width
8312 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8314 : FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0
8315 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)
8316 : (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)));
8318 compute_fringe_widths (f, 0);
8320 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols);
8321 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows);
8323 f->win_gravity = NorthWestGravity;
8324 x_wm_set_size_hint (f, (long) 0, 0);
8326 XSync (FRAME_X_DISPLAY (f), False);
8327 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8328 pixelwidth, pixelheight);
8330 /* Now, strictly speaking, we can't be sure that this is accurate,
8331 but the window manager will get around to dealing with the size
8332 change request eventually, and we'll hear how it went when the
8333 ConfigureNotify event gets here.
8335 We could just not bother storing any of this information here,
8336 and let the ConfigureNotify event set everything up, but that
8337 might be kind of confusing to the Lisp code, since size changes
8338 wouldn't be reported in the frame parameters until some random
8339 point in the future when the ConfigureNotify event arrives.
8341 We pass 1 for DELAY since we can't run Lisp code inside of
8342 a BLOCK_INPUT. */
8343 change_frame_size (f, rows, cols, 0, 1, 0);
8344 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8345 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8347 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8348 receive in the ConfigureNotify event; if we get what we asked
8349 for, then the event won't cause the screen to become garbaged, so
8350 we have to make sure to do it here. */
8351 SET_FRAME_GARBAGED (f);
8353 XFlush (FRAME_X_DISPLAY (f));
8357 /* Call this to change the size of frame F's x-window.
8358 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8359 for this size change and subsequent size changes.
8360 Otherwise we leave the window gravity unchanged. */
8362 void
8363 x_set_window_size (f, change_gravity, cols, rows)
8364 struct frame *f;
8365 int change_gravity;
8366 int cols, rows;
8368 BLOCK_INPUT;
8370 #ifdef USE_GTK
8371 if (FRAME_GTK_WIDGET (f))
8372 xg_frame_set_char_size (f, cols, rows);
8373 else
8374 x_set_window_size_1 (f, change_gravity, cols, rows);
8375 #elif USE_X_TOOLKIT
8377 if (f->output_data.x->widget != NULL)
8379 /* The x and y position of the widget is clobbered by the
8380 call to XtSetValues within EmacsFrameSetCharSize.
8381 This is a real kludge, but I don't understand Xt so I can't
8382 figure out a correct fix. Can anyone else tell me? -- rms. */
8383 int xpos = f->output_data.x->widget->core.x;
8384 int ypos = f->output_data.x->widget->core.y;
8385 EmacsFrameSetCharSize (f->output_data.x->edit_widget, cols, rows);
8386 f->output_data.x->widget->core.x = xpos;
8387 f->output_data.x->widget->core.y = ypos;
8389 else
8390 x_set_window_size_1 (f, change_gravity, cols, rows);
8392 #else /* not USE_X_TOOLKIT */
8394 x_set_window_size_1 (f, change_gravity, cols, rows);
8396 #endif /* not USE_X_TOOLKIT */
8398 /* If cursor was outside the new size, mark it as off. */
8399 mark_window_cursors_off (XWINDOW (f->root_window));
8401 /* Clear out any recollection of where the mouse highlighting was,
8402 since it might be in a place that's outside the new frame size.
8403 Actually checking whether it is outside is a pain in the neck,
8404 so don't try--just let the highlighting be done afresh with new size. */
8405 cancel_mouse_face (f);
8407 UNBLOCK_INPUT;
8410 /* Mouse warping. */
8412 void
8413 x_set_mouse_position (f, x, y)
8414 struct frame *f;
8415 int x, y;
8417 int pix_x, pix_y;
8419 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8420 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8422 if (pix_x < 0) pix_x = 0;
8423 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8425 if (pix_y < 0) pix_y = 0;
8426 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8428 BLOCK_INPUT;
8430 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8431 0, 0, 0, 0, pix_x, pix_y);
8432 UNBLOCK_INPUT;
8435 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8437 void
8438 x_set_mouse_pixel_position (f, pix_x, pix_y)
8439 struct frame *f;
8440 int pix_x, pix_y;
8442 BLOCK_INPUT;
8444 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8445 0, 0, 0, 0, pix_x, pix_y);
8446 UNBLOCK_INPUT;
8449 /* focus shifting, raising and lowering. */
8451 void
8452 x_focus_on_frame (f)
8453 struct frame *f;
8455 #if 0 /* This proves to be unpleasant. */
8456 x_raise_frame (f);
8457 #endif
8458 #if 0
8459 /* I don't think that the ICCCM allows programs to do things like this
8460 without the interaction of the window manager. Whatever you end up
8461 doing with this code, do it to x_unfocus_frame too. */
8462 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8463 RevertToPointerRoot, CurrentTime);
8464 #endif /* ! 0 */
8467 void
8468 x_unfocus_frame (f)
8469 struct frame *f;
8471 #if 0
8472 /* Look at the remarks in x_focus_on_frame. */
8473 if (FRAME_X_DISPLAY_INFO (f)->x_focus_frame == f)
8474 XSetInputFocus (FRAME_X_DISPLAY (f), PointerRoot,
8475 RevertToPointerRoot, CurrentTime);
8476 #endif /* ! 0 */
8479 /* Raise frame F. */
8481 void
8482 x_raise_frame (f)
8483 struct frame *f;
8485 if (f->async_visible)
8487 BLOCK_INPUT;
8488 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8489 XFlush (FRAME_X_DISPLAY (f));
8490 UNBLOCK_INPUT;
8494 /* Lower frame F. */
8496 void
8497 x_lower_frame (f)
8498 struct frame *f;
8500 if (f->async_visible)
8502 BLOCK_INPUT;
8503 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8504 XFlush (FRAME_X_DISPLAY (f));
8505 UNBLOCK_INPUT;
8509 static void
8510 XTframe_raise_lower (f, raise_flag)
8511 FRAME_PTR f;
8512 int raise_flag;
8514 if (raise_flag)
8515 x_raise_frame (f);
8516 else
8517 x_lower_frame (f);
8520 /* Change of visibility. */
8522 /* This tries to wait until the frame is really visible.
8523 However, if the window manager asks the user where to position
8524 the frame, this will return before the user finishes doing that.
8525 The frame will not actually be visible at that time,
8526 but it will become visible later when the window manager
8527 finishes with it. */
8529 void
8530 x_make_frame_visible (f)
8531 struct frame *f;
8533 Lisp_Object type;
8534 int original_top, original_left;
8535 int retry_count = 2;
8537 retry:
8539 BLOCK_INPUT;
8541 type = x_icon_type (f);
8542 if (!NILP (type))
8543 x_bitmap_icon (f, type);
8545 if (! FRAME_VISIBLE_P (f))
8547 /* We test FRAME_GARBAGED_P here to make sure we don't
8548 call x_set_offset a second time
8549 if we get to x_make_frame_visible a second time
8550 before the window gets really visible. */
8551 if (! FRAME_ICONIFIED_P (f)
8552 && ! f->output_data.x->asked_for_visible)
8553 x_set_offset (f, f->left_pos, f->top_pos, 0);
8555 f->output_data.x->asked_for_visible = 1;
8557 if (! EQ (Vx_no_window_manager, Qt))
8558 x_wm_set_window_state (f, NormalState);
8559 #ifdef USE_X_TOOLKIT
8560 /* This was XtPopup, but that did nothing for an iconified frame. */
8561 XtMapWidget (f->output_data.x->widget);
8562 #else /* not USE_X_TOOLKIT */
8563 #ifdef USE_GTK
8564 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
8565 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
8566 #else
8567 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
8568 #endif /* not USE_GTK */
8569 #endif /* not USE_X_TOOLKIT */
8570 #if 0 /* This seems to bring back scroll bars in the wrong places
8571 if the window configuration has changed. They seem
8572 to come back ok without this. */
8573 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
8574 XMapSubwindows (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
8575 #endif
8578 XFlush (FRAME_X_DISPLAY (f));
8580 /* Synchronize to ensure Emacs knows the frame is visible
8581 before we do anything else. We do this loop with input not blocked
8582 so that incoming events are handled. */
8584 Lisp_Object frame;
8585 int count;
8586 /* This must be before UNBLOCK_INPUT
8587 since events that arrive in response to the actions above
8588 will set it when they are handled. */
8589 int previously_visible = f->output_data.x->has_been_visible;
8591 original_left = f->left_pos;
8592 original_top = f->top_pos;
8594 /* This must come after we set COUNT. */
8595 UNBLOCK_INPUT;
8597 /* We unblock here so that arriving X events are processed. */
8599 /* Now move the window back to where it was "supposed to be".
8600 But don't do it if the gravity is negative.
8601 When the gravity is negative, this uses a position
8602 that is 3 pixels too low. Perhaps that's really the border width.
8604 Don't do this if the window has never been visible before,
8605 because the window manager may choose the position
8606 and we don't want to override it. */
8608 if (! FRAME_VISIBLE_P (f) && ! FRAME_ICONIFIED_P (f)
8609 && f->win_gravity == NorthWestGravity
8610 && previously_visible)
8612 Drawable rootw;
8613 int x, y;
8614 unsigned int width, height, border, depth;
8616 BLOCK_INPUT;
8618 /* On some window managers (such as FVWM) moving an existing
8619 window, even to the same place, causes the window manager
8620 to introduce an offset. This can cause the window to move
8621 to an unexpected location. Check the geometry (a little
8622 slow here) and then verify that the window is in the right
8623 place. If the window is not in the right place, move it
8624 there, and take the potential window manager hit. */
8625 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8626 &rootw, &x, &y, &width, &height, &border, &depth);
8628 if (original_left != x || original_top != y)
8629 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8630 original_left, original_top);
8632 UNBLOCK_INPUT;
8635 XSETFRAME (frame, f);
8637 /* Wait until the frame is visible. Process X events until a
8638 MapNotify event has been seen, or until we think we won't get a
8639 MapNotify at all.. */
8640 for (count = input_signal_count + 10;
8641 input_signal_count < count && !FRAME_VISIBLE_P (f);)
8643 /* Force processing of queued events. */
8644 x_sync (f);
8646 /* Machines that do polling rather than SIGIO have been
8647 observed to go into a busy-wait here. So we'll fake an
8648 alarm signal to let the handler know that there's something
8649 to be read. We used to raise a real alarm, but it seems
8650 that the handler isn't always enabled here. This is
8651 probably a bug. */
8652 if (input_polling_used ())
8654 /* It could be confusing if a real alarm arrives while
8655 processing the fake one. Turn it off and let the
8656 handler reset it. */
8657 extern void poll_for_input_1 P_ ((void));
8658 int old_poll_suppress_count = poll_suppress_count;
8659 poll_suppress_count = 1;
8660 poll_for_input_1 ();
8661 poll_suppress_count = old_poll_suppress_count;
8664 /* See if a MapNotify event has been processed. */
8665 FRAME_SAMPLE_VISIBILITY (f);
8668 /* 2000-09-28: In
8670 (let ((f (selected-frame)))
8671 (iconify-frame f)
8672 (raise-frame f))
8674 the frame is not raised with various window managers on
8675 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
8676 unknown reason, the call to XtMapWidget is completely ignored.
8677 Mapping the widget a second time works. */
8679 if (!FRAME_VISIBLE_P (f) && --retry_count > 0)
8680 goto retry;
8684 /* Change from mapped state to withdrawn state. */
8686 /* Make the frame visible (mapped and not iconified). */
8688 void
8689 x_make_frame_invisible (f)
8690 struct frame *f;
8692 Window window;
8694 /* Use the frame's outermost window, not the one we normally draw on. */
8695 window = FRAME_OUTER_WINDOW (f);
8697 /* Don't keep the highlight on an invisible frame. */
8698 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
8699 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
8701 #if 0/* This might add unreliability; I don't trust it -- rms. */
8702 if (! f->async_visible && ! f->async_iconified)
8703 return;
8704 #endif
8706 BLOCK_INPUT;
8708 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
8709 that the current position of the window is user-specified, rather than
8710 program-specified, so that when the window is mapped again, it will be
8711 placed at the same location, without forcing the user to position it
8712 by hand again (they have already done that once for this window.) */
8713 x_wm_set_size_hint (f, (long) 0, 1);
8715 #ifdef USE_GTK
8716 if (FRAME_GTK_OUTER_WIDGET (f))
8717 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
8718 else
8719 #endif
8721 #ifdef HAVE_X11R4
8723 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
8724 DefaultScreen (FRAME_X_DISPLAY (f))))
8726 UNBLOCK_INPUT_RESIGNAL;
8727 error ("Can't notify window manager of window withdrawal");
8729 #else /* ! defined (HAVE_X11R4) */
8731 /* Tell the window manager what we're going to do. */
8732 if (! EQ (Vx_no_window_manager, Qt))
8734 XEvent unmap;
8736 unmap.xunmap.type = UnmapNotify;
8737 unmap.xunmap.window = window;
8738 unmap.xunmap.event = DefaultRootWindow (FRAME_X_DISPLAY (f));
8739 unmap.xunmap.from_configure = False;
8740 if (! XSendEvent (FRAME_X_DISPLAY (f),
8741 DefaultRootWindow (FRAME_X_DISPLAY (f)),
8742 False,
8743 SubstructureRedirectMaskSubstructureNotifyMask,
8744 &unmap))
8746 UNBLOCK_INPUT_RESIGNAL;
8747 error ("Can't notify window manager of withdrawal");
8751 /* Unmap the window ourselves. Cheeky! */
8752 XUnmapWindow (FRAME_X_DISPLAY (f), window);
8753 #endif /* ! defined (HAVE_X11R4) */
8756 /* We can't distinguish this from iconification
8757 just by the event that we get from the server.
8758 So we can't win using the usual strategy of letting
8759 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
8760 and synchronize with the server to make sure we agree. */
8761 f->visible = 0;
8762 FRAME_ICONIFIED_P (f) = 0;
8763 f->async_visible = 0;
8764 f->async_iconified = 0;
8766 x_sync (f);
8768 UNBLOCK_INPUT;
8771 /* Change window state from mapped to iconified. */
8773 void
8774 x_iconify_frame (f)
8775 struct frame *f;
8777 int result;
8778 Lisp_Object type;
8780 /* Don't keep the highlight on an invisible frame. */
8781 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
8782 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
8784 if (f->async_iconified)
8785 return;
8787 BLOCK_INPUT;
8789 FRAME_SAMPLE_VISIBILITY (f);
8791 type = x_icon_type (f);
8792 if (!NILP (type))
8793 x_bitmap_icon (f, type);
8795 #ifdef USE_GTK
8796 if (FRAME_GTK_OUTER_WIDGET (f))
8798 if (! FRAME_VISIBLE_P (f))
8799 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
8801 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
8802 f->iconified = 1;
8803 f->visible = 1;
8804 f->async_iconified = 1;
8805 f->async_visible = 0;
8806 UNBLOCK_INPUT;
8807 return;
8809 #endif
8811 #ifdef USE_X_TOOLKIT
8813 if (! FRAME_VISIBLE_P (f))
8815 if (! EQ (Vx_no_window_manager, Qt))
8816 x_wm_set_window_state (f, IconicState);
8817 /* This was XtPopup, but that did nothing for an iconified frame. */
8818 XtMapWidget (f->output_data.x->widget);
8819 /* The server won't give us any event to indicate
8820 that an invisible frame was changed to an icon,
8821 so we have to record it here. */
8822 f->iconified = 1;
8823 f->visible = 1;
8824 f->async_iconified = 1;
8825 f->async_visible = 0;
8826 UNBLOCK_INPUT;
8827 return;
8830 result = XIconifyWindow (FRAME_X_DISPLAY (f),
8831 XtWindow (f->output_data.x->widget),
8832 DefaultScreen (FRAME_X_DISPLAY (f)));
8833 UNBLOCK_INPUT;
8835 if (!result)
8836 error ("Can't notify window manager of iconification");
8838 f->async_iconified = 1;
8839 f->async_visible = 0;
8842 BLOCK_INPUT;
8843 XFlush (FRAME_X_DISPLAY (f));
8844 UNBLOCK_INPUT;
8845 #else /* not USE_X_TOOLKIT */
8847 /* Make sure the X server knows where the window should be positioned,
8848 in case the user deiconifies with the window manager. */
8849 if (! FRAME_VISIBLE_P (f) && !FRAME_ICONIFIED_P (f))
8850 x_set_offset (f, f->left_pos, f->top_pos, 0);
8852 /* Since we don't know which revision of X we're running, we'll use both
8853 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
8855 /* X11R4: send a ClientMessage to the window manager using the
8856 WM_CHANGE_STATE type. */
8858 XEvent message;
8860 message.xclient.window = FRAME_X_WINDOW (f);
8861 message.xclient.type = ClientMessage;
8862 message.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
8863 message.xclient.format = 32;
8864 message.xclient.data.l[0] = IconicState;
8866 if (! XSendEvent (FRAME_X_DISPLAY (f),
8867 DefaultRootWindow (FRAME_X_DISPLAY (f)),
8868 False,
8869 SubstructureRedirectMask | SubstructureNotifyMask,
8870 &message))
8872 UNBLOCK_INPUT_RESIGNAL;
8873 error ("Can't notify window manager of iconification");
8877 /* X11R3: set the initial_state field of the window manager hints to
8878 IconicState. */
8879 x_wm_set_window_state (f, IconicState);
8881 if (!FRAME_VISIBLE_P (f))
8883 /* If the frame was withdrawn, before, we must map it. */
8884 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
8887 f->async_iconified = 1;
8888 f->async_visible = 0;
8890 XFlush (FRAME_X_DISPLAY (f));
8891 UNBLOCK_INPUT;
8892 #endif /* not USE_X_TOOLKIT */
8896 /* Free X resources of frame F. */
8898 void
8899 x_free_frame_resources (f)
8900 struct frame *f;
8902 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8903 Lisp_Object bar;
8904 struct scroll_bar *b;
8906 BLOCK_INPUT;
8908 /* If a display connection is dead, don't try sending more
8909 commands to the X server. */
8910 if (dpyinfo->display)
8912 if (f->output_data.x->icon_desc)
8913 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
8915 #ifdef USE_X_TOOLKIT
8916 /* Explicitly destroy the scroll bars of the frame. Without
8917 this, we get "BadDrawable" errors from the toolkit later on,
8918 presumably from expose events generated for the disappearing
8919 toolkit scroll bars. */
8920 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
8922 b = XSCROLL_BAR (bar);
8923 x_scroll_bar_remove (b);
8925 #endif
8927 #ifdef HAVE_X_I18N
8928 if (FRAME_XIC (f))
8929 free_frame_xic (f);
8930 #endif
8932 #ifdef USE_X_TOOLKIT
8933 if (f->output_data.x->widget)
8935 XtDestroyWidget (f->output_data.x->widget);
8936 f->output_data.x->widget = NULL;
8938 /* Tooltips don't have widgets, only a simple X window, even if
8939 we are using a toolkit. */
8940 else if (FRAME_X_WINDOW (f))
8941 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
8943 free_frame_menubar (f);
8944 #else /* !USE_X_TOOLKIT */
8946 #ifdef USE_GTK
8947 /* In the GTK version, tooltips are normal X
8948 frames. We must check and free both types. */
8949 if (FRAME_GTK_OUTER_WIDGET (f))
8951 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
8952 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow below */
8953 FRAME_GTK_OUTER_WIDGET (f) = 0;
8955 #endif /* USE_GTK */
8957 if (FRAME_X_WINDOW (f))
8958 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
8959 #endif /* !USE_X_TOOLKIT */
8961 unload_color (f, f->output_data.x->foreground_pixel);
8962 unload_color (f, f->output_data.x->background_pixel);
8963 unload_color (f, f->output_data.x->cursor_pixel);
8964 unload_color (f, f->output_data.x->cursor_foreground_pixel);
8965 unload_color (f, f->output_data.x->border_pixel);
8966 unload_color (f, f->output_data.x->mouse_pixel);
8968 if (f->output_data.x->scroll_bar_background_pixel != -1)
8969 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
8970 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
8971 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
8972 #ifdef USE_TOOLKIT_SCROLL_BARS
8973 /* Scrollbar shadow colors. */
8974 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
8975 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
8976 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
8977 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
8978 #endif /* USE_TOOLKIT_SCROLL_BARS */
8979 if (f->output_data.x->white_relief.allocated_p)
8980 unload_color (f, f->output_data.x->white_relief.pixel);
8981 if (f->output_data.x->black_relief.allocated_p)
8982 unload_color (f, f->output_data.x->black_relief.pixel);
8984 if (FRAME_FACE_CACHE (f))
8985 free_frame_faces (f);
8987 x_free_gcs (f);
8988 XFlush (FRAME_X_DISPLAY (f));
8991 if (f->output_data.x->saved_menu_event)
8992 xfree (f->output_data.x->saved_menu_event);
8994 xfree (f->output_data.x);
8995 f->output_data.x = NULL;
8997 if (f == dpyinfo->x_focus_frame)
8998 dpyinfo->x_focus_frame = 0;
8999 if (f == dpyinfo->x_focus_event_frame)
9000 dpyinfo->x_focus_event_frame = 0;
9001 if (f == dpyinfo->x_highlight_frame)
9002 dpyinfo->x_highlight_frame = 0;
9004 if (f == dpyinfo->mouse_face_mouse_frame)
9006 dpyinfo->mouse_face_beg_row
9007 = dpyinfo->mouse_face_beg_col = -1;
9008 dpyinfo->mouse_face_end_row
9009 = dpyinfo->mouse_face_end_col = -1;
9010 dpyinfo->mouse_face_window = Qnil;
9011 dpyinfo->mouse_face_deferred_gc = 0;
9012 dpyinfo->mouse_face_mouse_frame = 0;
9015 UNBLOCK_INPUT;
9019 /* Destroy the X window of frame F. */
9021 void
9022 x_destroy_window (f)
9023 struct frame *f;
9025 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9027 /* If a display connection is dead, don't try sending more
9028 commands to the X server. */
9029 if (dpyinfo->display != 0)
9030 x_free_frame_resources (f);
9032 dpyinfo->reference_count--;
9036 /* Setting window manager hints. */
9038 /* Set the normal size hints for the window manager, for frame F.
9039 FLAGS is the flags word to use--or 0 meaning preserve the flags
9040 that the window now has.
9041 If USER_POSITION is nonzero, we set the USPosition
9042 flag (this is useful when FLAGS is 0).
9043 The GTK version is in gtkutils.c */
9045 #ifndef USE_GTK
9046 void
9047 x_wm_set_size_hint (f, flags, user_position)
9048 struct frame *f;
9049 long flags;
9050 int user_position;
9052 XSizeHints size_hints;
9054 #ifdef USE_X_TOOLKIT
9055 Arg al[2];
9056 int ac = 0;
9057 Dimension widget_width, widget_height;
9058 #endif
9060 Window window = FRAME_OUTER_WINDOW (f);
9062 /* Setting PMaxSize caused various problems. */
9063 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9065 size_hints.x = f->left_pos;
9066 size_hints.y = f->top_pos;
9068 #ifdef USE_X_TOOLKIT
9069 XtSetArg (al[ac], XtNwidth, &widget_width); ac++;
9070 XtSetArg (al[ac], XtNheight, &widget_height); ac++;
9071 XtGetValues (f->output_data.x->widget, al, ac);
9072 size_hints.height = widget_height;
9073 size_hints.width = widget_width;
9074 #else /* not USE_X_TOOLKIT */
9075 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9076 size_hints.width = FRAME_PIXEL_WIDTH (f);
9077 #endif /* not USE_X_TOOLKIT */
9079 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9080 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9081 size_hints.max_width
9082 = FRAME_X_DISPLAY_INFO (f)->width - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9083 size_hints.max_height
9084 = FRAME_X_DISPLAY_INFO (f)->height - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9086 /* Calculate the base and minimum sizes.
9088 (When we use the X toolkit, we don't do it here.
9089 Instead we copy the values that the widgets are using, below.) */
9090 #ifndef USE_X_TOOLKIT
9092 int base_width, base_height;
9093 int min_rows = 0, min_cols = 0;
9095 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9096 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9098 check_frame_size (f, &min_rows, &min_cols);
9100 /* The window manager uses the base width hints to calculate the
9101 current number of rows and columns in the frame while
9102 resizing; min_width and min_height aren't useful for this
9103 purpose, since they might not give the dimensions for a
9104 zero-row, zero-column frame.
9106 We use the base_width and base_height members if we have
9107 them; otherwise, we set the min_width and min_height members
9108 to the size for a zero x zero frame. */
9110 #ifdef HAVE_X11R4
9111 size_hints.flags |= PBaseSize;
9112 size_hints.base_width = base_width;
9113 size_hints.base_height = base_height;
9114 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9115 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9116 #else
9117 size_hints.min_width = base_width;
9118 size_hints.min_height = base_height;
9119 #endif
9122 /* If we don't need the old flags, we don't need the old hint at all. */
9123 if (flags)
9125 size_hints.flags |= flags;
9126 goto no_read;
9128 #endif /* not USE_X_TOOLKIT */
9131 XSizeHints hints; /* Sometimes I hate X Windows... */
9132 long supplied_return;
9133 int value;
9135 #ifdef HAVE_X11R4
9136 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9137 &supplied_return);
9138 #else
9139 value = XGetNormalHints (FRAME_X_DISPLAY (f), window, &hints);
9140 #endif
9142 #ifdef USE_X_TOOLKIT
9143 size_hints.base_height = hints.base_height;
9144 size_hints.base_width = hints.base_width;
9145 size_hints.min_height = hints.min_height;
9146 size_hints.min_width = hints.min_width;
9147 #endif
9149 if (flags)
9150 size_hints.flags |= flags;
9151 else
9153 if (value == 0)
9154 hints.flags = 0;
9155 if (hints.flags & PSize)
9156 size_hints.flags |= PSize;
9157 if (hints.flags & PPosition)
9158 size_hints.flags |= PPosition;
9159 if (hints.flags & USPosition)
9160 size_hints.flags |= USPosition;
9161 if (hints.flags & USSize)
9162 size_hints.flags |= USSize;
9166 #ifndef USE_X_TOOLKIT
9167 no_read:
9168 #endif
9170 #ifdef PWinGravity
9171 size_hints.win_gravity = f->win_gravity;
9172 size_hints.flags |= PWinGravity;
9174 if (user_position)
9176 size_hints.flags &= ~ PPosition;
9177 size_hints.flags |= USPosition;
9179 #endif /* PWinGravity */
9181 #ifdef HAVE_X11R4
9182 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9183 #else
9184 XSetNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9185 #endif
9187 #endif /* not USE_GTK */
9189 /* Used for IconicState or NormalState */
9191 void
9192 x_wm_set_window_state (f, state)
9193 struct frame *f;
9194 int state;
9196 #ifdef USE_X_TOOLKIT
9197 Arg al[1];
9199 XtSetArg (al[0], XtNinitialState, state);
9200 XtSetValues (f->output_data.x->widget, al, 1);
9201 #else /* not USE_X_TOOLKIT */
9202 Window window = FRAME_X_WINDOW (f);
9204 f->output_data.x->wm_hints.flags |= StateHint;
9205 f->output_data.x->wm_hints.initial_state = state;
9207 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9208 #endif /* not USE_X_TOOLKIT */
9211 void
9212 x_wm_set_icon_pixmap (f, pixmap_id)
9213 struct frame *f;
9214 int pixmap_id;
9216 Pixmap icon_pixmap, icon_mask;
9218 #ifndef USE_X_TOOLKIT
9219 Window window = FRAME_OUTER_WINDOW (f);
9220 #endif
9222 if (pixmap_id > 0)
9224 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9225 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9226 icon_mask = x_bitmap_mask (f, pixmap_id);
9227 f->output_data.x->wm_hints.icon_mask = icon_mask;
9229 else
9231 /* It seems there is no way to turn off use of an icon pixmap.
9232 The following line does it, only if no icon has yet been created,
9233 for some window managers. But with mwm it crashes.
9234 Some people say it should clear the IconPixmapHint bit in this case,
9235 but that doesn't work, and the X consortium said it isn't the
9236 right thing at all. Since there is no way to win,
9237 best to explicitly give up. */
9238 #if 0
9239 f->output_data.x->wm_hints.icon_pixmap = None;
9240 f->output_data.x->wm_hints.icon_mask = None;
9241 #else
9242 return;
9243 #endif
9246 #ifdef USE_X_TOOLKIT /* same as in x_wm_set_window_state. */
9249 Arg al[1];
9250 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9251 XtSetValues (f->output_data.x->widget, al, 1);
9252 XtSetArg (al[0], XtNiconMask, icon_mask);
9253 XtSetValues (f->output_data.x->widget, al, 1);
9256 #else /* not USE_X_TOOLKIT */
9258 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9259 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9261 #endif /* not USE_X_TOOLKIT */
9264 void
9265 x_wm_set_icon_position (f, icon_x, icon_y)
9266 struct frame *f;
9267 int icon_x, icon_y;
9269 Window window = FRAME_OUTER_WINDOW (f);
9271 f->output_data.x->wm_hints.flags |= IconPositionHint;
9272 f->output_data.x->wm_hints.icon_x = icon_x;
9273 f->output_data.x->wm_hints.icon_y = icon_y;
9275 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9279 /***********************************************************************
9280 Fonts
9281 ***********************************************************************/
9283 /* Return a pointer to struct font_info of font FONT_IDX of frame F. */
9285 struct font_info *
9286 x_get_font_info (f, font_idx)
9287 FRAME_PTR f;
9288 int font_idx;
9290 return (FRAME_X_FONT_TABLE (f) + font_idx);
9294 /* Return a list of names of available fonts matching PATTERN on frame F.
9296 If SIZE is > 0, it is the size (maximum bounds width) of fonts
9297 to be listed.
9299 SIZE < 0 means include scalable fonts.
9301 Frame F null means we have not yet created any frame on X, and
9302 consult the first display in x_display_list. MAXNAMES sets a limit
9303 on how many fonts to match. */
9305 Lisp_Object
9306 x_list_fonts (f, pattern, size, maxnames)
9307 struct frame *f;
9308 Lisp_Object pattern;
9309 int size;
9310 int maxnames;
9312 Lisp_Object list = Qnil, patterns, newlist = Qnil, key = Qnil;
9313 Lisp_Object tem, second_best;
9314 struct x_display_info *dpyinfo
9315 = f ? FRAME_X_DISPLAY_INFO (f) : x_display_list;
9316 Display *dpy = dpyinfo->display;
9317 int try_XLoadQueryFont = 0;
9318 int count;
9319 int allow_auto_scaled_font = 0;
9321 if (size < 0)
9323 allow_auto_scaled_font = 1;
9324 size = 0;
9327 patterns = Fassoc (pattern, Valternate_fontname_alist);
9328 if (NILP (patterns))
9329 patterns = Fcons (pattern, Qnil);
9331 if (maxnames == 1 && !size)
9332 /* We can return any single font matching PATTERN. */
9333 try_XLoadQueryFont = 1;
9335 for (; CONSP (patterns); patterns = XCDR (patterns))
9337 int num_fonts;
9338 char **names = NULL;
9340 pattern = XCAR (patterns);
9341 /* See if we cached the result for this particular query.
9342 The cache is an alist of the form:
9343 ((((PATTERN . MAXNAMES) . SCALABLE) (FONTNAME . WIDTH) ...) ...) */
9344 tem = XCDR (dpyinfo->name_list_element);
9345 key = Fcons (Fcons (pattern, make_number (maxnames)),
9346 allow_auto_scaled_font ? Qt : Qnil);
9347 list = Fassoc (key, tem);
9348 if (!NILP (list))
9350 list = Fcdr_safe (list);
9351 /* We have a cashed list. Don't have to get the list again. */
9352 goto label_cached;
9355 /* At first, put PATTERN in the cache. */
9357 BLOCK_INPUT;
9358 count = x_catch_errors (dpy);
9360 if (try_XLoadQueryFont)
9362 XFontStruct *font;
9363 unsigned long value;
9365 font = XLoadQueryFont (dpy, SDATA (pattern));
9366 if (x_had_errors_p (dpy))
9368 /* This error is perhaps due to insufficient memory on X
9369 server. Let's just ignore it. */
9370 font = NULL;
9371 x_clear_errors (dpy);
9374 if (font
9375 && XGetFontProperty (font, XA_FONT, &value))
9377 char *name = (char *) XGetAtomName (dpy, (Atom) value);
9378 int len = strlen (name);
9379 char *tmp;
9381 /* If DXPC (a Differential X Protocol Compressor)
9382 Ver.3.7 is running, XGetAtomName will return null
9383 string. We must avoid such a name. */
9384 if (len == 0)
9385 try_XLoadQueryFont = 0;
9386 else
9388 num_fonts = 1;
9389 names = (char **) alloca (sizeof (char *));
9390 /* Some systems only allow alloca assigned to a
9391 simple var. */
9392 tmp = (char *) alloca (len + 1); names[0] = tmp;
9393 bcopy (name, names[0], len + 1);
9394 XFree (name);
9397 else
9398 try_XLoadQueryFont = 0;
9400 if (font)
9401 XFreeFont (dpy, font);
9404 if (!try_XLoadQueryFont)
9406 /* We try at least 10 fonts because XListFonts will return
9407 auto-scaled fonts at the head. */
9408 if (maxnames < 0)
9410 int limit;
9412 for (limit = 500;;)
9414 names = XListFonts (dpy, SDATA (pattern), limit, &num_fonts);
9415 if (num_fonts == limit)
9417 BLOCK_INPUT;
9418 XFreeFontNames (names);
9419 UNBLOCK_INPUT;
9420 limit *= 2;
9422 else
9423 break;
9426 else
9427 names = XListFonts (dpy, SDATA (pattern), max (maxnames, 10),
9428 &num_fonts);
9430 if (x_had_errors_p (dpy))
9432 /* This error is perhaps due to insufficient memory on X
9433 server. Let's just ignore it. */
9434 names = NULL;
9435 x_clear_errors (dpy);
9439 x_uncatch_errors (dpy, count);
9440 UNBLOCK_INPUT;
9442 if (names)
9444 int i;
9446 /* Make a list of all the fonts we got back.
9447 Store that in the font cache for the display. */
9448 for (i = 0; i < num_fonts; i++)
9450 int width = 0;
9451 char *p = names[i];
9452 int average_width = -1, resx = 0, dashes = 0;
9454 /* Count the number of dashes in NAMES[I]. If there are
9455 14 dashes, the field value following 9th dash
9456 (RESOLUTION_X) is nonzero, and the field value
9457 following 12th dash (AVERAGE_WIDTH) is 0, this is a
9458 auto-scaled font which is usually too ugly to be used
9459 for editing. Let's ignore it. */
9460 while (*p)
9461 if (*p++ == '-')
9463 dashes++;
9464 if (dashes == 7) /* PIXEL_SIZE field */
9465 width = atoi (p);
9466 else if (dashes == 9)
9467 resx = atoi (p);
9468 else if (dashes == 12) /* AVERAGE_WIDTH field */
9469 average_width = atoi (p);
9472 if (allow_auto_scaled_font
9473 || dashes < 14 || average_width != 0 || resx == 0)
9475 tem = build_string (names[i]);
9476 if (NILP (Fassoc (tem, list)))
9478 if (STRINGP (Vx_pixel_size_width_font_regexp)
9479 && ((fast_c_string_match_ignore_case
9480 (Vx_pixel_size_width_font_regexp, names[i]))
9481 >= 0))
9482 /* We can set the value of PIXEL_SIZE to the
9483 width of this font. */
9484 list = Fcons (Fcons (tem, make_number (width)), list);
9485 else
9486 /* For the moment, width is not known. */
9487 list = Fcons (Fcons (tem, Qnil), list);
9492 if (!try_XLoadQueryFont)
9494 BLOCK_INPUT;
9495 XFreeFontNames (names);
9496 UNBLOCK_INPUT;
9500 /* Now store the result in the cache. */
9501 XSETCDR (dpyinfo->name_list_element,
9502 Fcons (Fcons (key, list), XCDR (dpyinfo->name_list_element)));
9504 label_cached:
9505 if (NILP (list)) continue; /* Try the remaining alternatives. */
9507 newlist = second_best = Qnil;
9508 /* Make a list of the fonts that have the right width. */
9509 for (; CONSP (list); list = XCDR (list))
9511 int found_size;
9513 tem = XCAR (list);
9515 if (!CONSP (tem) || NILP (XCAR (tem)))
9516 continue;
9517 if (!size)
9519 newlist = Fcons (XCAR (tem), newlist);
9520 continue;
9523 if (!INTEGERP (XCDR (tem)))
9525 /* Since we have not yet known the size of this font, we
9526 must try slow function call XLoadQueryFont. */
9527 XFontStruct *thisinfo;
9529 BLOCK_INPUT;
9530 count = x_catch_errors (dpy);
9531 thisinfo = XLoadQueryFont (dpy,
9532 SDATA (XCAR (tem)));
9533 if (x_had_errors_p (dpy))
9535 /* This error is perhaps due to insufficient memory on X
9536 server. Let's just ignore it. */
9537 thisinfo = NULL;
9538 x_clear_errors (dpy);
9540 x_uncatch_errors (dpy, count);
9541 UNBLOCK_INPUT;
9543 if (thisinfo)
9545 XSETCDR (tem,
9546 (thisinfo->min_bounds.width == 0
9547 ? make_number (0)
9548 : make_number (thisinfo->max_bounds.width)));
9549 BLOCK_INPUT;
9550 XFreeFont (dpy, thisinfo);
9551 UNBLOCK_INPUT;
9553 else
9554 /* For unknown reason, the previous call of XListFont had
9555 returned a font which can't be opened. Record the size
9556 as 0 not to try to open it again. */
9557 XSETCDR (tem, make_number (0));
9560 found_size = XINT (XCDR (tem));
9561 if (found_size == size)
9562 newlist = Fcons (XCAR (tem), newlist);
9563 else if (found_size > 0)
9565 if (NILP (second_best))
9566 second_best = tem;
9567 else if (found_size < size)
9569 if (XINT (XCDR (second_best)) > size
9570 || XINT (XCDR (second_best)) < found_size)
9571 second_best = tem;
9573 else
9575 if (XINT (XCDR (second_best)) > size
9576 && XINT (XCDR (second_best)) > found_size)
9577 second_best = tem;
9581 if (!NILP (newlist))
9582 break;
9583 else if (!NILP (second_best))
9585 newlist = Fcons (XCAR (second_best), Qnil);
9586 break;
9590 return newlist;
9594 #if GLYPH_DEBUG
9596 /* Check that FONT is valid on frame F. It is if it can be found in F's
9597 font table. */
9599 static void
9600 x_check_font (f, font)
9601 struct frame *f;
9602 XFontStruct *font;
9604 int i;
9605 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9607 xassert (font != NULL);
9609 for (i = 0; i < dpyinfo->n_fonts; i++)
9610 if (dpyinfo->font_table[i].name
9611 && font == dpyinfo->font_table[i].font)
9612 break;
9614 xassert (i < dpyinfo->n_fonts);
9617 #endif /* GLYPH_DEBUG != 0 */
9619 /* Set *W to the minimum width, *H to the minimum font height of FONT.
9620 Note: There are (broken) X fonts out there with invalid XFontStruct
9621 min_bounds contents. For example, handa@etl.go.jp reports that
9622 "-adobe-courier-medium-r-normal--*-180-*-*-m-*-iso8859-1" fonts
9623 have font->min_bounds.width == 0. */
9625 static INLINE void
9626 x_font_min_bounds (font, w, h)
9627 XFontStruct *font;
9628 int *w, *h;
9630 *h = FONT_HEIGHT (font);
9631 *w = font->min_bounds.width;
9633 /* Try to handle the case where FONT->min_bounds has invalid
9634 contents. Since the only font known to have invalid min_bounds
9635 is fixed-width, use max_bounds if min_bounds seems to be invalid. */
9636 if (*w <= 0)
9637 *w = font->max_bounds.width;
9641 /* Compute the smallest character width and smallest font height over
9642 all fonts available on frame F. Set the members smallest_char_width
9643 and smallest_font_height in F's x_display_info structure to
9644 the values computed. Value is non-zero if smallest_font_height or
9645 smallest_char_width become smaller than they were before. */
9647 static int
9648 x_compute_min_glyph_bounds (f)
9649 struct frame *f;
9651 int i;
9652 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9653 XFontStruct *font;
9654 int old_width = dpyinfo->smallest_char_width;
9655 int old_height = dpyinfo->smallest_font_height;
9657 dpyinfo->smallest_font_height = 100000;
9658 dpyinfo->smallest_char_width = 100000;
9660 for (i = 0; i < dpyinfo->n_fonts; ++i)
9661 if (dpyinfo->font_table[i].name)
9663 struct font_info *fontp = dpyinfo->font_table + i;
9664 int w, h;
9666 font = (XFontStruct *) fontp->font;
9667 xassert (font != (XFontStruct *) ~0);
9668 x_font_min_bounds (font, &w, &h);
9670 dpyinfo->smallest_font_height = min (dpyinfo->smallest_font_height, h);
9671 dpyinfo->smallest_char_width = min (dpyinfo->smallest_char_width, w);
9674 xassert (dpyinfo->smallest_char_width > 0
9675 && dpyinfo->smallest_font_height > 0);
9677 return (dpyinfo->n_fonts == 1
9678 || dpyinfo->smallest_char_width < old_width
9679 || dpyinfo->smallest_font_height < old_height);
9683 /* Load font named FONTNAME of the size SIZE for frame F, and return a
9684 pointer to the structure font_info while allocating it dynamically.
9685 If SIZE is 0, load any size of font.
9686 If loading is failed, return NULL. */
9688 struct font_info *
9689 x_load_font (f, fontname, size)
9690 struct frame *f;
9691 register char *fontname;
9692 int size;
9694 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9695 Lisp_Object font_names;
9696 int count;
9698 /* Get a list of all the fonts that match this name. Once we
9699 have a list of matching fonts, we compare them against the fonts
9700 we already have by comparing names. */
9701 font_names = x_list_fonts (f, build_string (fontname), size, 1);
9703 if (!NILP (font_names))
9705 Lisp_Object tail;
9706 int i;
9708 for (i = 0; i < dpyinfo->n_fonts; i++)
9709 for (tail = font_names; CONSP (tail); tail = XCDR (tail))
9710 if (dpyinfo->font_table[i].name
9711 && (!strcmp (dpyinfo->font_table[i].name,
9712 SDATA (XCAR (tail)))
9713 || !strcmp (dpyinfo->font_table[i].full_name,
9714 SDATA (XCAR (tail)))))
9715 return (dpyinfo->font_table + i);
9718 /* Load the font and add it to the table. */
9720 char *full_name;
9721 XFontStruct *font;
9722 struct font_info *fontp;
9723 unsigned long value;
9724 int i;
9726 /* If we have found fonts by x_list_font, load one of them. If
9727 not, we still try to load a font by the name given as FONTNAME
9728 because XListFonts (called in x_list_font) of some X server has
9729 a bug of not finding a font even if the font surely exists and
9730 is loadable by XLoadQueryFont. */
9731 if (size > 0 && !NILP (font_names))
9732 fontname = (char *) SDATA (XCAR (font_names));
9734 BLOCK_INPUT;
9735 count = x_catch_errors (FRAME_X_DISPLAY (f));
9736 font = (XFontStruct *) XLoadQueryFont (FRAME_X_DISPLAY (f), fontname);
9737 if (x_had_errors_p (FRAME_X_DISPLAY (f)))
9739 /* This error is perhaps due to insufficient memory on X
9740 server. Let's just ignore it. */
9741 font = NULL;
9742 x_clear_errors (FRAME_X_DISPLAY (f));
9744 x_uncatch_errors (FRAME_X_DISPLAY (f), count);
9745 UNBLOCK_INPUT;
9746 if (!font)
9747 return NULL;
9749 /* Find a free slot in the font table. */
9750 for (i = 0; i < dpyinfo->n_fonts; ++i)
9751 if (dpyinfo->font_table[i].name == NULL)
9752 break;
9754 /* If no free slot found, maybe enlarge the font table. */
9755 if (i == dpyinfo->n_fonts
9756 && dpyinfo->n_fonts == dpyinfo->font_table_size)
9758 int sz;
9759 dpyinfo->font_table_size = max (16, 2 * dpyinfo->font_table_size);
9760 sz = dpyinfo->font_table_size * sizeof *dpyinfo->font_table;
9761 dpyinfo->font_table
9762 = (struct font_info *) xrealloc (dpyinfo->font_table, sz);
9765 fontp = dpyinfo->font_table + i;
9766 if (i == dpyinfo->n_fonts)
9767 ++dpyinfo->n_fonts;
9769 /* Now fill in the slots of *FONTP. */
9770 BLOCK_INPUT;
9771 bzero (fontp, sizeof (*fontp));
9772 fontp->font = font;
9773 fontp->font_idx = i;
9774 fontp->name = (char *) xmalloc (strlen (fontname) + 1);
9775 bcopy (fontname, fontp->name, strlen (fontname) + 1);
9777 if (font->min_bounds.width == font->max_bounds.width)
9779 /* Fixed width font. */
9780 fontp->average_width = fontp->space_width = font->min_bounds.width;
9782 else
9784 XChar2b char2b;
9785 XCharStruct *pcm;
9787 char2b.byte1 = 0x00, char2b.byte2 = 0x20;
9788 pcm = x_per_char_metric (font, &char2b, 0);
9789 if (pcm)
9790 fontp->space_width = pcm->width;
9791 else
9792 fontp->space_width = FONT_WIDTH (font);
9794 fontp->average_width
9795 = (XGetFontProperty (font, dpyinfo->Xatom_AVERAGE_WIDTH, &value)
9796 ? (long) value / 10 : 0);
9797 if (fontp->average_width < 0)
9798 fontp->average_width = - fontp->average_width;
9799 if (fontp->average_width == 0)
9801 if (pcm)
9803 int width = pcm->width;
9804 for (char2b.byte2 = 33; char2b.byte2 <= 126; char2b.byte2++)
9805 if ((pcm = x_per_char_metric (font, &char2b, 0)) != NULL)
9806 width += pcm->width;
9807 fontp->average_width = width / 95;
9809 else
9810 fontp->average_width = FONT_WIDTH (font);
9814 /* Try to get the full name of FONT. Put it in FULL_NAME. */
9815 full_name = 0;
9816 if (XGetFontProperty (font, XA_FONT, &value))
9818 char *name = (char *) XGetAtomName (FRAME_X_DISPLAY (f), (Atom) value);
9819 char *p = name;
9820 int dashes = 0;
9822 /* Count the number of dashes in the "full name".
9823 If it is too few, this isn't really the font's full name,
9824 so don't use it.
9825 In X11R4, the fonts did not come with their canonical names
9826 stored in them. */
9827 while (*p)
9829 if (*p == '-')
9830 dashes++;
9831 p++;
9834 if (dashes >= 13)
9836 full_name = (char *) xmalloc (p - name + 1);
9837 bcopy (name, full_name, p - name + 1);
9840 XFree (name);
9843 if (full_name != 0)
9844 fontp->full_name = full_name;
9845 else
9846 fontp->full_name = fontp->name;
9848 fontp->size = font->max_bounds.width;
9849 fontp->height = FONT_HEIGHT (font);
9851 if (NILP (font_names))
9853 /* We come here because of a bug of XListFonts mentioned at
9854 the head of this block. Let's store this information in
9855 the cache for x_list_fonts. */
9856 Lisp_Object lispy_name = build_string (fontname);
9857 Lisp_Object lispy_full_name = build_string (fontp->full_name);
9858 Lisp_Object key = Fcons (Fcons (lispy_name, make_number (256)),
9859 Qnil);
9861 XSETCDR (dpyinfo->name_list_element,
9862 Fcons (Fcons (key,
9863 Fcons (Fcons (lispy_full_name,
9864 make_number (fontp->size)),
9865 Qnil)),
9866 XCDR (dpyinfo->name_list_element)));
9867 if (full_name)
9869 key = Fcons (Fcons (lispy_full_name, make_number (256)),
9870 Qnil);
9871 XSETCDR (dpyinfo->name_list_element,
9872 Fcons (Fcons (key,
9873 Fcons (Fcons (lispy_full_name,
9874 make_number (fontp->size)),
9875 Qnil)),
9876 XCDR (dpyinfo->name_list_element)));
9880 /* The slot `encoding' specifies how to map a character
9881 code-points (0x20..0x7F or 0x2020..0x7F7F) of each charset to
9882 the font code-points (0:0x20..0x7F, 1:0xA0..0xFF), or
9883 (0:0x2020..0x7F7F, 1:0xA0A0..0xFFFF, 3:0x20A0..0x7FFF,
9884 2:0xA020..0xFF7F). For the moment, we don't know which charset
9885 uses this font. So, we set information in fontp->encoding[1]
9886 which is never used by any charset. If mapping can't be
9887 decided, set FONT_ENCODING_NOT_DECIDED. */
9888 fontp->encoding[1]
9889 = (font->max_byte1 == 0
9890 /* 1-byte font */
9891 ? (font->min_char_or_byte2 < 0x80
9892 ? (font->max_char_or_byte2 < 0x80
9893 ? 0 /* 0x20..0x7F */
9894 : FONT_ENCODING_NOT_DECIDED) /* 0x20..0xFF */
9895 : 1) /* 0xA0..0xFF */
9896 /* 2-byte font */
9897 : (font->min_byte1 < 0x80
9898 ? (font->max_byte1 < 0x80
9899 ? (font->min_char_or_byte2 < 0x80
9900 ? (font->max_char_or_byte2 < 0x80
9901 ? 0 /* 0x2020..0x7F7F */
9902 : FONT_ENCODING_NOT_DECIDED) /* 0x2020..0x7FFF */
9903 : 3) /* 0x20A0..0x7FFF */
9904 : FONT_ENCODING_NOT_DECIDED) /* 0x20??..0xA0?? */
9905 : (font->min_char_or_byte2 < 0x80
9906 ? (font->max_char_or_byte2 < 0x80
9907 ? 2 /* 0xA020..0xFF7F */
9908 : FONT_ENCODING_NOT_DECIDED) /* 0xA020..0xFFFF */
9909 : 1))); /* 0xA0A0..0xFFFF */
9911 fontp->baseline_offset
9912 = (XGetFontProperty (font, dpyinfo->Xatom_MULE_BASELINE_OFFSET, &value)
9913 ? (long) value : 0);
9914 fontp->relative_compose
9915 = (XGetFontProperty (font, dpyinfo->Xatom_MULE_RELATIVE_COMPOSE, &value)
9916 ? (long) value : 0);
9917 fontp->default_ascent
9918 = (XGetFontProperty (font, dpyinfo->Xatom_MULE_DEFAULT_ASCENT, &value)
9919 ? (long) value : 0);
9921 /* Set global flag fonts_changed_p to non-zero if the font loaded
9922 has a character with a smaller width than any other character
9923 before, or if the font loaded has a smaller height than any
9924 other font loaded before. If this happens, it will make a
9925 glyph matrix reallocation necessary. */
9926 fonts_changed_p |= x_compute_min_glyph_bounds (f);
9927 UNBLOCK_INPUT;
9928 return fontp;
9933 /* Return a pointer to struct font_info of a font named FONTNAME for
9934 frame F. If no such font is loaded, return NULL. */
9936 struct font_info *
9937 x_query_font (f, fontname)
9938 struct frame *f;
9939 register char *fontname;
9941 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9942 int i;
9944 for (i = 0; i < dpyinfo->n_fonts; i++)
9945 if (dpyinfo->font_table[i].name
9946 && (!strcmp (dpyinfo->font_table[i].name, fontname)
9947 || !strcmp (dpyinfo->font_table[i].full_name, fontname)))
9948 return (dpyinfo->font_table + i);
9949 return NULL;
9953 /* Find a CCL program for a font specified by FONTP, and set the member
9954 `encoder' of the structure. */
9956 void
9957 x_find_ccl_program (fontp)
9958 struct font_info *fontp;
9960 Lisp_Object list, elt;
9962 elt = Qnil;
9963 for (list = Vfont_ccl_encoder_alist; CONSP (list); list = XCDR (list))
9965 elt = XCAR (list);
9966 if (CONSP (elt)
9967 && STRINGP (XCAR (elt))
9968 && ((fast_c_string_match_ignore_case (XCAR (elt), fontp->name)
9969 >= 0)
9970 || (fast_c_string_match_ignore_case (XCAR (elt), fontp->full_name)
9971 >= 0)))
9972 break;
9975 if (! NILP (list))
9977 struct ccl_program *ccl
9978 = (struct ccl_program *) xmalloc (sizeof (struct ccl_program));
9980 if (setup_ccl_program (ccl, XCDR (elt)) < 0)
9981 xfree (ccl);
9982 else
9983 fontp->font_encoder = ccl;
9989 /***********************************************************************
9990 Initialization
9991 ***********************************************************************/
9993 #ifdef USE_X_TOOLKIT
9994 static XrmOptionDescRec emacs_options[] = {
9995 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9996 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9998 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9999 XrmoptionSepArg, NULL},
10000 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
10002 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
10003 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
10004 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
10005 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
10006 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
10007 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
10008 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
10010 #endif /* USE_X_TOOLKIT */
10012 static int x_initialized;
10014 #ifdef MULTI_KBOARD
10015 /* Test whether two display-name strings agree up to the dot that separates
10016 the screen number from the server number. */
10017 static int
10018 same_x_server (name1, name2)
10019 const char *name1, *name2;
10021 int seen_colon = 0;
10022 const unsigned char *system_name = SDATA (Vsystem_name);
10023 int system_name_length = strlen (system_name);
10024 int length_until_period = 0;
10026 while (system_name[length_until_period] != 0
10027 && system_name[length_until_period] != '.')
10028 length_until_period++;
10030 /* Treat `unix' like an empty host name. */
10031 if (! strncmp (name1, "unix:", 5))
10032 name1 += 4;
10033 if (! strncmp (name2, "unix:", 5))
10034 name2 += 4;
10035 /* Treat this host's name like an empty host name. */
10036 if (! strncmp (name1, system_name, system_name_length)
10037 && name1[system_name_length] == ':')
10038 name1 += system_name_length;
10039 if (! strncmp (name2, system_name, system_name_length)
10040 && name2[system_name_length] == ':')
10041 name2 += system_name_length;
10042 /* Treat this host's domainless name like an empty host name. */
10043 if (! strncmp (name1, system_name, length_until_period)
10044 && name1[length_until_period] == ':')
10045 name1 += length_until_period;
10046 if (! strncmp (name2, system_name, length_until_period)
10047 && name2[length_until_period] == ':')
10048 name2 += length_until_period;
10050 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
10052 if (*name1 == ':')
10053 seen_colon++;
10054 if (seen_colon && *name1 == '.')
10055 return 1;
10057 return (seen_colon
10058 && (*name1 == '.' || *name1 == '\0')
10059 && (*name2 == '.' || *name2 == '\0'));
10061 #endif
10063 /* Count number of set bits in mask and number of bits to shift to
10064 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
10065 to 5. */
10066 static void
10067 get_bits_and_offset (mask, bits, offset)
10068 unsigned long mask;
10069 int *bits;
10070 int *offset;
10072 int nr = 0;
10073 int off = 0;
10075 while (!(mask & 1))
10077 off++;
10078 mask >>= 1;
10081 while (mask & 1)
10083 nr++;
10084 mask >>= 1;
10087 *offset = off;
10088 *bits = nr;
10091 struct x_display_info *
10092 x_term_init (display_name, xrm_option, resource_name)
10093 Lisp_Object display_name;
10094 char *xrm_option;
10095 char *resource_name;
10097 int connection;
10098 Display *dpy;
10099 struct x_display_info *dpyinfo;
10100 XrmDatabase xrdb;
10102 BLOCK_INPUT;
10104 if (!x_initialized)
10106 x_initialize ();
10107 ++x_initialized;
10110 #ifdef USE_GTK
10112 #define NUM_ARGV 10
10113 int argc;
10114 char *argv[NUM_ARGV];
10115 char **argv2 = argv;
10116 GdkAtom atom;
10118 if (x_initialized++ > 1)
10120 /* Opening another display. If xg_display_open returns less
10121 than zero, we are probably on GTK 2.0, which can only handle
10122 one display. GTK 2.2 or later can handle more than one. */
10123 if (xg_display_open (SDATA (display_name), &dpy) < 0)
10124 error ("Sorry, this version of GTK can only handle one display");
10126 else
10128 for (argc = 0; argc < NUM_ARGV; ++argc)
10129 argv[argc] = 0;
10131 argc = 0;
10132 argv[argc++] = initial_argv[0];
10134 if (! NILP (display_name))
10136 argv[argc++] = "--display";
10137 argv[argc++] = SDATA (display_name);
10140 argv[argc++] = "--name";
10141 argv[argc++] = resource_name;
10143 #ifdef HAVE_X11R5
10144 XSetLocaleModifiers ("");
10145 #endif
10147 gtk_init (&argc, &argv2);
10149 /* gtk_init does set_locale. We must fix locale after calling it. */
10150 fixup_locale ();
10151 xg_initialize ();
10153 dpy = GDK_DISPLAY ();
10155 /* NULL window -> events for all windows go to our function */
10156 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
10158 /* Load our own gtkrc if it exists. */
10160 struct gcpro gcpro1, gcpro2;
10161 char *file = "~/.emacs.d/gtkrc";
10162 Lisp_Object s, abs_file;
10164 GCPRO2 (s, abs_file);
10165 s = make_string (file, strlen (file));
10166 abs_file = Fexpand_file_name (s, Qnil);
10168 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
10169 gtk_rc_parse (SDATA (abs_file));
10171 UNGCPRO;
10174 XSetErrorHandler (x_error_handler);
10175 XSetIOErrorHandler (x_io_error_quitter);
10178 #else /* not USE_GTK */
10179 #ifdef USE_X_TOOLKIT
10180 /* weiner@footloose.sps.mot.com reports that this causes
10181 errors with X11R5:
10182 X protocol error: BadAtom (invalid Atom parameter)
10183 on protocol request 18skiloaf.
10184 So let's not use it until R6. */
10185 #ifdef HAVE_X11XTR6
10186 XtSetLanguageProc (NULL, NULL, NULL);
10187 #endif
10190 int argc = 0;
10191 char *argv[3];
10193 argv[0] = "";
10194 argc = 1;
10195 if (xrm_option)
10197 argv[argc++] = "-xrm";
10198 argv[argc++] = xrm_option;
10200 turn_on_atimers (0);
10201 dpy = XtOpenDisplay (Xt_app_con, SDATA (display_name),
10202 resource_name, EMACS_CLASS,
10203 emacs_options, XtNumber (emacs_options),
10204 &argc, argv);
10205 turn_on_atimers (1);
10207 #ifdef HAVE_X11XTR6
10208 /* I think this is to compensate for XtSetLanguageProc. */
10209 fixup_locale ();
10210 #endif
10213 #else /* not USE_X_TOOLKIT */
10214 #ifdef HAVE_X11R5
10215 XSetLocaleModifiers ("");
10216 #endif
10217 dpy = XOpenDisplay (SDATA (display_name));
10218 #endif /* not USE_X_TOOLKIT */
10219 #endif /* not USE_GTK*/
10221 /* Detect failure. */
10222 if (dpy == 0)
10224 UNBLOCK_INPUT;
10225 return 0;
10228 /* We have definitely succeeded. Record the new connection. */
10230 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
10231 bzero (dpyinfo, sizeof *dpyinfo);
10233 #ifdef MULTI_KBOARD
10235 struct x_display_info *share;
10236 Lisp_Object tail;
10238 for (share = x_display_list, tail = x_display_name_list; share;
10239 share = share->next, tail = XCDR (tail))
10240 if (same_x_server (SDATA (XCAR (XCAR (tail))),
10241 SDATA (display_name)))
10242 break;
10243 if (share)
10244 dpyinfo->kboard = share->kboard;
10245 else
10247 dpyinfo->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
10248 init_kboard (dpyinfo->kboard);
10249 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10251 char *vendor = ServerVendor (dpy);
10252 UNBLOCK_INPUT;
10253 dpyinfo->kboard->Vsystem_key_alist
10254 = call1 (Qvendor_specific_keysyms,
10255 build_string (vendor ? vendor : ""));
10256 BLOCK_INPUT;
10259 dpyinfo->kboard->next_kboard = all_kboards;
10260 all_kboards = dpyinfo->kboard;
10261 /* Don't let the initial kboard remain current longer than necessary.
10262 That would cause problems if a file loaded on startup tries to
10263 prompt in the mini-buffer. */
10264 if (current_kboard == initial_kboard)
10265 current_kboard = dpyinfo->kboard;
10267 dpyinfo->kboard->reference_count++;
10269 #endif
10271 /* Put this display on the chain. */
10272 dpyinfo->next = x_display_list;
10273 x_display_list = dpyinfo;
10275 /* Put it on x_display_name_list as well, to keep them parallel. */
10276 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10277 x_display_name_list);
10278 dpyinfo->name_list_element = XCAR (x_display_name_list);
10280 dpyinfo->display = dpy;
10282 #if 0
10283 XSetAfterFunction (x_current_display, x_trace_wire);
10284 #endif /* ! 0 */
10286 dpyinfo->x_id_name
10287 = (char *) xmalloc (SBYTES (Vinvocation_name)
10288 + SBYTES (Vsystem_name)
10289 + 2);
10290 sprintf (dpyinfo->x_id_name, "%s@%s",
10291 SDATA (Vinvocation_name), SDATA (Vsystem_name));
10293 /* Figure out which modifier bits mean what. */
10294 x_find_modifier_meanings (dpyinfo);
10296 /* Get the scroll bar cursor. */
10297 #ifdef USE_GTK
10298 /* We must create a GTK cursor, it is required for GTK widgets. */
10299 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10300 #endif /* USE_GTK */
10302 dpyinfo->vertical_scroll_bar_cursor
10303 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10305 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10306 resource_name, EMACS_CLASS);
10307 #ifdef HAVE_XRMSETDATABASE
10308 XrmSetDatabase (dpyinfo->display, xrdb);
10309 #else
10310 dpyinfo->display->db = xrdb;
10311 #endif
10312 /* Put the rdb where we can find it in a way that works on
10313 all versions. */
10314 dpyinfo->xrdb = xrdb;
10316 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10317 DefaultScreen (dpyinfo->display));
10318 select_visual (dpyinfo);
10319 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10320 dpyinfo->height = HeightOfScreen (dpyinfo->screen);
10321 dpyinfo->width = WidthOfScreen (dpyinfo->screen);
10322 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10323 dpyinfo->client_leader_window = 0;
10324 dpyinfo->grabbed = 0;
10325 dpyinfo->reference_count = 0;
10326 dpyinfo->icon_bitmap_id = -1;
10327 dpyinfo->font_table = NULL;
10328 dpyinfo->n_fonts = 0;
10329 dpyinfo->font_table_size = 0;
10330 dpyinfo->bitmaps = 0;
10331 dpyinfo->bitmaps_size = 0;
10332 dpyinfo->bitmaps_last = 0;
10333 dpyinfo->scratch_cursor_gc = 0;
10334 dpyinfo->mouse_face_mouse_frame = 0;
10335 dpyinfo->mouse_face_deferred_gc = 0;
10336 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
10337 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
10338 dpyinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10339 dpyinfo->mouse_face_window = Qnil;
10340 dpyinfo->mouse_face_overlay = Qnil;
10341 dpyinfo->mouse_face_mouse_x = dpyinfo->mouse_face_mouse_y = 0;
10342 dpyinfo->mouse_face_defer = 0;
10343 dpyinfo->mouse_face_hidden = 0;
10344 dpyinfo->x_focus_frame = 0;
10345 dpyinfo->x_focus_event_frame = 0;
10346 dpyinfo->x_highlight_frame = 0;
10347 dpyinfo->image_cache = make_image_cache ();
10348 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10350 /* See if we can construct pixel values from RGB values. */
10351 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10352 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10354 if (dpyinfo->visual->class == TrueColor)
10356 get_bits_and_offset (dpyinfo->visual->red_mask,
10357 &dpyinfo->red_bits, &dpyinfo->red_offset);
10358 get_bits_and_offset (dpyinfo->visual->blue_mask,
10359 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10360 get_bits_and_offset (dpyinfo->visual->green_mask,
10361 &dpyinfo->green_bits, &dpyinfo->green_offset);
10364 /* See if a private colormap is requested. */
10365 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10367 if (dpyinfo->visual->class == PseudoColor)
10369 Lisp_Object value;
10370 value = display_x_get_resource (dpyinfo,
10371 build_string ("privateColormap"),
10372 build_string ("PrivateColormap"),
10373 Qnil, Qnil);
10374 if (STRINGP (value)
10375 && (!strcmp (SDATA (value), "true")
10376 || !strcmp (SDATA (value), "on")))
10377 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10380 else
10381 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10382 dpyinfo->visual, AllocNone);
10385 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10386 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10387 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10388 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10389 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10390 pixels = DisplayWidth (dpyinfo->display, screen_number);
10391 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10392 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10393 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10396 dpyinfo->Xatom_wm_protocols
10397 = XInternAtom (dpyinfo->display, "WM_PROTOCOLS", False);
10398 dpyinfo->Xatom_wm_take_focus
10399 = XInternAtom (dpyinfo->display, "WM_TAKE_FOCUS", False);
10400 dpyinfo->Xatom_wm_save_yourself
10401 = XInternAtom (dpyinfo->display, "WM_SAVE_YOURSELF", False);
10402 dpyinfo->Xatom_wm_delete_window
10403 = XInternAtom (dpyinfo->display, "WM_DELETE_WINDOW", False);
10404 dpyinfo->Xatom_wm_change_state
10405 = XInternAtom (dpyinfo->display, "WM_CHANGE_STATE", False);
10406 dpyinfo->Xatom_wm_configure_denied
10407 = XInternAtom (dpyinfo->display, "WM_CONFIGURE_DENIED", False);
10408 dpyinfo->Xatom_wm_window_moved
10409 = XInternAtom (dpyinfo->display, "WM_MOVED", False);
10410 dpyinfo->Xatom_wm_client_leader
10411 = XInternAtom (dpyinfo->display, "WM_CLIENT_LEADER", False);
10412 dpyinfo->Xatom_editres
10413 = XInternAtom (dpyinfo->display, "Editres", False);
10414 dpyinfo->Xatom_CLIPBOARD
10415 = XInternAtom (dpyinfo->display, "CLIPBOARD", False);
10416 dpyinfo->Xatom_TIMESTAMP
10417 = XInternAtom (dpyinfo->display, "TIMESTAMP", False);
10418 dpyinfo->Xatom_TEXT
10419 = XInternAtom (dpyinfo->display, "TEXT", False);
10420 dpyinfo->Xatom_COMPOUND_TEXT
10421 = XInternAtom (dpyinfo->display, "COMPOUND_TEXT", False);
10422 dpyinfo->Xatom_UTF8_STRING
10423 = XInternAtom (dpyinfo->display, "UTF8_STRING", False);
10424 dpyinfo->Xatom_DELETE
10425 = XInternAtom (dpyinfo->display, "DELETE", False);
10426 dpyinfo->Xatom_MULTIPLE
10427 = XInternAtom (dpyinfo->display, "MULTIPLE", False);
10428 dpyinfo->Xatom_INCR
10429 = XInternAtom (dpyinfo->display, "INCR", False);
10430 dpyinfo->Xatom_EMACS_TMP
10431 = XInternAtom (dpyinfo->display, "_EMACS_TMP_", False);
10432 dpyinfo->Xatom_TARGETS
10433 = XInternAtom (dpyinfo->display, "TARGETS", False);
10434 dpyinfo->Xatom_NULL
10435 = XInternAtom (dpyinfo->display, "NULL", False);
10436 dpyinfo->Xatom_ATOM_PAIR
10437 = XInternAtom (dpyinfo->display, "ATOM_PAIR", False);
10438 /* For properties of font. */
10439 dpyinfo->Xatom_PIXEL_SIZE
10440 = XInternAtom (dpyinfo->display, "PIXEL_SIZE", False);
10441 dpyinfo->Xatom_AVERAGE_WIDTH
10442 = XInternAtom (dpyinfo->display, "AVERAGE_WIDTH", False);
10443 dpyinfo->Xatom_MULE_BASELINE_OFFSET
10444 = XInternAtom (dpyinfo->display, "_MULE_BASELINE_OFFSET", False);
10445 dpyinfo->Xatom_MULE_RELATIVE_COMPOSE
10446 = XInternAtom (dpyinfo->display, "_MULE_RELATIVE_COMPOSE", False);
10447 dpyinfo->Xatom_MULE_DEFAULT_ASCENT
10448 = XInternAtom (dpyinfo->display, "_MULE_DEFAULT_ASCENT", False);
10450 /* Ghostscript support. */
10451 dpyinfo->Xatom_PAGE = XInternAtom (dpyinfo->display, "PAGE", False);
10452 dpyinfo->Xatom_DONE = XInternAtom (dpyinfo->display, "DONE", False);
10454 dpyinfo->Xatom_Scrollbar = XInternAtom (dpyinfo->display, "SCROLLBAR",
10455 False);
10457 dpyinfo->cut_buffers_initialized = 0;
10459 connection = ConnectionNumber (dpyinfo->display);
10460 dpyinfo->connection = connection;
10463 char null_bits[1];
10465 null_bits[0] = 0x00;
10467 dpyinfo->null_pixel
10468 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10469 null_bits, 1, 1, (long) 0, (long) 0,
10474 extern int gray_bitmap_width, gray_bitmap_height;
10475 extern char *gray_bitmap_bits;
10476 dpyinfo->gray
10477 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10478 gray_bitmap_bits,
10479 gray_bitmap_width, gray_bitmap_height,
10480 (unsigned long) 1, (unsigned long) 0, 1);
10483 #ifdef HAVE_X_I18N
10484 xim_initialize (dpyinfo, resource_name);
10485 #endif
10487 #ifdef subprocesses
10488 /* This is only needed for distinguishing keyboard and process input. */
10489 if (connection != 0)
10490 add_keyboard_wait_descriptor (connection);
10491 #endif
10493 #ifndef F_SETOWN_BUG
10494 #ifdef F_SETOWN
10495 #ifdef F_SETOWN_SOCK_NEG
10496 /* stdin is a socket here */
10497 fcntl (connection, F_SETOWN, -getpid ());
10498 #else /* ! defined (F_SETOWN_SOCK_NEG) */
10499 fcntl (connection, F_SETOWN, getpid ());
10500 #endif /* ! defined (F_SETOWN_SOCK_NEG) */
10501 #endif /* ! defined (F_SETOWN) */
10502 #endif /* F_SETOWN_BUG */
10504 #ifdef SIGIO
10505 if (interrupt_input)
10506 init_sigio (connection);
10507 #endif /* ! defined (SIGIO) */
10509 #ifdef USE_LUCID
10510 #ifdef HAVE_X11R5 /* It seems X11R4 lacks XtCvtStringToFont, and XPointer. */
10511 /* Make sure that we have a valid font for dialog boxes
10512 so that Xt does not crash. */
10514 Display *dpy = dpyinfo->display;
10515 XrmValue d, fr, to;
10516 Font font;
10517 int count;
10519 d.addr = (XPointer)&dpy;
10520 d.size = sizeof (Display *);
10521 fr.addr = XtDefaultFont;
10522 fr.size = sizeof (XtDefaultFont);
10523 to.size = sizeof (Font *);
10524 to.addr = (XPointer)&font;
10525 count = x_catch_errors (dpy);
10526 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10527 abort ();
10528 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10529 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10530 x_uncatch_errors (dpy, count);
10532 #endif
10533 #endif
10535 /* See if we should run in synchronous mode. This is useful
10536 for debugging X code. */
10538 Lisp_Object value;
10539 value = display_x_get_resource (dpyinfo,
10540 build_string ("synchronous"),
10541 build_string ("Synchronous"),
10542 Qnil, Qnil);
10543 if (STRINGP (value)
10544 && (!strcmp (SDATA (value), "true")
10545 || !strcmp (SDATA (value), "on")))
10546 XSynchronize (dpyinfo->display, True);
10550 Lisp_Object value;
10551 value = display_x_get_resource (dpyinfo,
10552 build_string ("useXIM"),
10553 build_string ("UseXIM"),
10554 Qnil, Qnil);
10555 #ifdef USE_XIM
10556 if (STRINGP (value)
10557 && (!strcmp (XSTRING (value)->data, "false")
10558 || !strcmp (XSTRING (value)->data, "off")))
10559 use_xim = 0;
10560 #else
10561 if (STRINGP (value)
10562 && (!strcmp (XSTRING (value)->data, "true")
10563 || !strcmp (XSTRING (value)->data, "on")))
10564 use_xim = 1;
10565 #endif
10568 #ifdef HAVE_X_SM
10569 /* Only do this for the first display. */
10570 if (x_initialized == 1)
10571 x_session_initialize (dpyinfo);
10572 #endif
10574 UNBLOCK_INPUT;
10576 return dpyinfo;
10579 /* Get rid of display DPYINFO, assuming all frames are already gone,
10580 and without sending any more commands to the X server. */
10582 void
10583 x_delete_display (dpyinfo)
10584 struct x_display_info *dpyinfo;
10586 int i;
10588 delete_keyboard_wait_descriptor (dpyinfo->connection);
10590 /* Discard this display from x_display_name_list and x_display_list.
10591 We can't use Fdelq because that can quit. */
10592 if (! NILP (x_display_name_list)
10593 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10594 x_display_name_list = XCDR (x_display_name_list);
10595 else
10597 Lisp_Object tail;
10599 tail = x_display_name_list;
10600 while (CONSP (tail) && CONSP (XCDR (tail)))
10602 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10604 XSETCDR (tail, XCDR (XCDR (tail)));
10605 break;
10607 tail = XCDR (tail);
10611 if (next_noop_dpyinfo == dpyinfo)
10612 next_noop_dpyinfo = dpyinfo->next;
10614 if (x_display_list == dpyinfo)
10615 x_display_list = dpyinfo->next;
10616 else
10618 struct x_display_info *tail;
10620 for (tail = x_display_list; tail; tail = tail->next)
10621 if (tail->next == dpyinfo)
10622 tail->next = tail->next->next;
10625 #ifndef USE_X_TOOLKIT /* I'm told Xt does this itself. */
10626 #ifndef AIX /* On AIX, XCloseDisplay calls this. */
10627 XrmDestroyDatabase (dpyinfo->xrdb);
10628 #endif
10629 #endif
10630 #ifdef MULTI_KBOARD
10631 if (--dpyinfo->kboard->reference_count == 0)
10632 delete_kboard (dpyinfo->kboard);
10633 #endif
10634 #ifdef HAVE_X_I18N
10635 if (dpyinfo->xim)
10636 xim_close_dpy (dpyinfo);
10637 #endif
10639 /* Free the font names in the font table. */
10640 for (i = 0; i < dpyinfo->n_fonts; i++)
10641 if (dpyinfo->font_table[i].name)
10643 if (dpyinfo->font_table[i].name != dpyinfo->font_table[i].full_name)
10644 xfree (dpyinfo->font_table[i].full_name);
10645 xfree (dpyinfo->font_table[i].name);
10648 if (dpyinfo->font_table->font_encoder)
10649 xfree (dpyinfo->font_table->font_encoder);
10651 xfree (dpyinfo->font_table);
10652 xfree (dpyinfo->x_id_name);
10653 xfree (dpyinfo->color_cells);
10654 xfree (dpyinfo);
10657 #ifdef USE_X_TOOLKIT
10659 /* Atimer callback function for TIMER. Called every 0.1s to process
10660 Xt timeouts, if needed. We must avoid calling XtAppPending as
10661 much as possible because that function does an implicit XFlush
10662 that slows us down. */
10664 static void
10665 x_process_timeouts (timer)
10666 struct atimer *timer;
10668 if (toolkit_scroll_bar_interaction || popup_activated ())
10670 BLOCK_INPUT;
10671 while (XtAppPending (Xt_app_con) & XtIMTimer)
10672 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10673 UNBLOCK_INPUT;
10677 #endif /* USE_X_TOOLKIT */
10680 /* Set up use of X before we make the first connection. */
10682 extern frame_parm_handler x_frame_parm_handlers[];
10684 static struct redisplay_interface x_redisplay_interface =
10686 x_frame_parm_handlers,
10687 x_produce_glyphs,
10688 x_write_glyphs,
10689 x_insert_glyphs,
10690 x_clear_end_of_line,
10691 x_scroll_run,
10692 x_after_update_window_line,
10693 x_update_window_begin,
10694 x_update_window_end,
10695 x_cursor_to,
10696 x_flush,
10697 #ifdef XFlush
10698 x_flush,
10699 #else
10700 0, /* flush_display_optional */
10701 #endif
10702 x_clear_window_mouse_face,
10703 x_get_glyph_overhangs,
10704 x_fix_overlapping_area,
10705 x_draw_fringe_bitmap,
10706 0, /* define_fringe_bitmap */
10707 0, /* destroy_fringe_bitmap */
10708 x_per_char_metric,
10709 x_encode_char,
10710 x_compute_glyph_string_overhangs,
10711 x_draw_glyph_string,
10712 x_define_frame_cursor,
10713 x_clear_frame_area,
10714 x_draw_window_cursor,
10715 x_draw_vertical_window_border,
10716 x_shift_glyphs_for_insert
10719 void
10720 x_initialize ()
10722 rif = &x_redisplay_interface;
10724 clear_frame_hook = x_clear_frame;
10725 ins_del_lines_hook = x_ins_del_lines;
10726 delete_glyphs_hook = x_delete_glyphs;
10727 ring_bell_hook = XTring_bell;
10728 reset_terminal_modes_hook = XTreset_terminal_modes;
10729 set_terminal_modes_hook = XTset_terminal_modes;
10730 update_begin_hook = x_update_begin;
10731 update_end_hook = x_update_end;
10732 set_terminal_window_hook = XTset_terminal_window;
10733 read_socket_hook = XTread_socket;
10734 frame_up_to_date_hook = XTframe_up_to_date;
10735 mouse_position_hook = XTmouse_position;
10736 frame_rehighlight_hook = XTframe_rehighlight;
10737 frame_raise_lower_hook = XTframe_raise_lower;
10738 set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10739 condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10740 redeem_scroll_bar_hook = XTredeem_scroll_bar;
10741 judge_scroll_bars_hook = XTjudge_scroll_bars;
10743 scroll_region_ok = 1; /* we'll scroll partial frames */
10744 char_ins_del_ok = 1;
10745 line_ins_del_ok = 1; /* we'll just blt 'em */
10746 fast_clear_end_of_line = 1; /* X does this well */
10747 memory_below_frame = 0; /* we don't remember what scrolls
10748 off the bottom */
10749 baud_rate = 19200;
10751 x_noop_count = 0;
10752 last_tool_bar_item = -1;
10753 any_help_event_p = 0;
10754 ignore_next_mouse_click_timeout = 0;
10756 #ifdef USE_GTK
10757 current_count = -1;
10758 #endif
10760 /* Try to use interrupt input; if we can't, then start polling. */
10761 Fset_input_mode (Qt, Qnil, Qt, Qnil);
10763 #ifdef USE_X_TOOLKIT
10764 XtToolkitInitialize ();
10766 Xt_app_con = XtCreateApplicationContext ();
10768 /* Register a converter from strings to pixels, which uses
10769 Emacs' color allocation infrastructure. */
10770 XtAppSetTypeConverter (Xt_app_con,
10771 XtRString, XtRPixel, cvt_string_to_pixel,
10772 cvt_string_to_pixel_args,
10773 XtNumber (cvt_string_to_pixel_args),
10774 XtCacheByDisplay, cvt_pixel_dtor);
10776 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10778 /* Install an asynchronous timer that processes Xt timeout events
10779 every 0.1s. This is necessary because some widget sets use
10780 timeouts internally, for example the LessTif menu bar, or the
10781 Xaw3d scroll bar. When Xt timouts aren't processed, these
10782 widgets don't behave normally. */
10784 EMACS_TIME interval;
10785 EMACS_SET_SECS_USECS (interval, 0, 100000);
10786 start_atimer (ATIMER_CONTINUOUS, interval, x_process_timeouts, 0);
10788 #endif
10790 #ifdef USE_TOOLKIT_SCROLL_BARS
10791 #ifndef USE_GTK
10792 xaw3d_arrow_scroll = False;
10793 xaw3d_pick_top = True;
10794 #endif
10795 #endif
10797 /* Note that there is no real way portable across R3/R4 to get the
10798 original error handler. */
10799 XSetErrorHandler (x_error_handler);
10800 XSetIOErrorHandler (x_io_error_quitter);
10802 /* Disable Window Change signals; they are handled by X events. */
10803 #ifdef SIGWINCH
10804 signal (SIGWINCH, SIG_DFL);
10805 #endif /* SIGWINCH */
10807 signal (SIGPIPE, x_connection_signal);
10811 void
10812 syms_of_xterm ()
10814 staticpro (&x_error_message_string);
10815 x_error_message_string = Qnil;
10817 staticpro (&x_display_name_list);
10818 x_display_name_list = Qnil;
10820 staticpro (&last_mouse_scroll_bar);
10821 last_mouse_scroll_bar = Qnil;
10823 staticpro (&Qvendor_specific_keysyms);
10824 Qvendor_specific_keysyms = intern ("vendor-specific-keysyms");
10826 staticpro (&Qutf_8);
10827 Qutf_8 = intern ("utf-8");
10828 staticpro (&Qlatin_1);
10829 Qlatin_1 = intern ("latin-1");
10831 staticpro (&last_mouse_press_frame);
10832 last_mouse_press_frame = Qnil;
10834 DEFVAR_BOOL ("x-use-underline-position-properties",
10835 &x_use_underline_position_properties,
10836 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
10837 nil means ignore them. If you encounter fonts with bogus
10838 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10839 to 4.1, set this to nil. */);
10840 x_use_underline_position_properties = 1;
10842 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10843 &x_mouse_click_focus_ignore_position,
10844 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10845 This variable is only used when the window manager requires that you
10846 click on a frame to select it (give it focus). In that case, a value
10847 of nil, means that the selected window and cursor position changes to
10848 reflect the mouse click position, while a non-nil value means that the
10849 selected window or cursor position is preserved. */);
10850 x_mouse_click_focus_ignore_position = 0;
10852 DEFVAR_LISP ("x-toolkit-scroll-bars", &Vx_toolkit_scroll_bars,
10853 doc: /* What X toolkit scroll bars Emacs uses.
10854 A value of nil means Emacs doesn't use X toolkit scroll bars.
10855 Otherwise, value is a symbol describing the X toolkit. */);
10856 #ifdef USE_TOOLKIT_SCROLL_BARS
10857 #ifdef USE_MOTIF
10858 Vx_toolkit_scroll_bars = intern ("motif");
10859 #elif defined HAVE_XAW3D
10860 Vx_toolkit_scroll_bars = intern ("xaw3d");
10861 #elif USE_GTK
10862 Vx_toolkit_scroll_bars = intern ("gtk");
10863 #else
10864 Vx_toolkit_scroll_bars = intern ("xaw");
10865 #endif
10866 #else
10867 Vx_toolkit_scroll_bars = Qnil;
10868 #endif
10870 staticpro (&last_mouse_motion_frame);
10871 last_mouse_motion_frame = Qnil;
10873 Qmodifier_value = intern ("modifier-value");
10874 Qalt = intern ("alt");
10875 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10876 Qhyper = intern ("hyper");
10877 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10878 Qmeta = intern ("meta");
10879 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10880 Qsuper = intern ("super");
10881 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10883 DEFVAR_LISP ("x-alt-keysym", &Vx_alt_keysym,
10884 doc: /* Which keys Emacs uses for the alt modifier.
10885 This should be one of the symbols `alt', `hyper', `meta', `super'.
10886 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10887 is nil, which is the same as `alt'. */);
10888 Vx_alt_keysym = Qnil;
10890 DEFVAR_LISP ("x-hyper-keysym", &Vx_hyper_keysym,
10891 doc: /* Which keys Emacs uses for the hyper modifier.
10892 This should be one of the symbols `alt', `hyper', `meta', `super'.
10893 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10894 default is nil, which is the same as `hyper'. */);
10895 Vx_hyper_keysym = Qnil;
10897 DEFVAR_LISP ("x-meta-keysym", &Vx_meta_keysym,
10898 doc: /* Which keys Emacs uses for the meta modifier.
10899 This should be one of the symbols `alt', `hyper', `meta', `super'.
10900 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10901 default is nil, which is the same as `meta'. */);
10902 Vx_meta_keysym = Qnil;
10904 DEFVAR_LISP ("x-super-keysym", &Vx_super_keysym,
10905 doc: /* Which keys Emacs uses for the super modifier.
10906 This should be one of the symbols `alt', `hyper', `meta', `super'.
10907 For example, `super' means use the Super_L and Super_R keysyms. The
10908 default is nil, which is the same as `super'. */);
10909 Vx_super_keysym = Qnil;
10911 DEFVAR_LISP ("x-keysym-table", &Vx_keysym_table,
10912 doc: /* Hash table of character codes indexed by X keysym codes. */);
10913 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10914 make_float (DEFAULT_REHASH_SIZE),
10915 make_float (DEFAULT_REHASH_THRESHOLD),
10916 Qnil, Qnil, Qnil);
10919 #endif /* HAVE_X_WINDOWS */
10921 /* arch-tag: 6d4e4cb7-abc1-4302-9585-d84dcfb09d0f
10922 (do not change this comment) */