(list-faces-display): Improve the formatting by computing the maximum length
[emacs.git] / src / xterm.c
blob4f9081425f327c6b182ed76cf449e98ef0f68067
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 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4593 if (val == initial)
4594 { /* ARROW_SCROLL */
4595 xaw3d_arrow_scroll = True;
4596 /* Isn't that just a personal preference ? -sm */
4597 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4601 /* Define callbacks. */
4602 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4603 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4604 (XtPointer) bar);
4606 /* Realize the widget. Only after that is the X window created. */
4607 XtRealizeWidget (widget);
4609 #endif /* !USE_MOTIF */
4611 /* Install an action hook that lets us detect when the user
4612 finishes interacting with a scroll bar. */
4613 if (action_hook_id == 0)
4614 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4616 /* Remember X window and widget in the scroll bar vector. */
4617 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4618 xwindow = XtWindow (widget);
4619 SET_SCROLL_BAR_X_WINDOW (bar, xwindow);
4621 UNBLOCK_INPUT;
4623 #endif /* not USE_GTK */
4626 /* Set the thumb size and position of scroll bar BAR. We are currently
4627 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4629 #ifdef USE_GTK
4630 static void
4631 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4632 struct scroll_bar *bar;
4633 int portion, position, whole;
4635 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4638 #else /* not USE_GTK */
4639 static void
4640 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4641 struct scroll_bar *bar;
4642 int portion, position, whole;
4644 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4645 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4646 float top, shown;
4648 BLOCK_INPUT;
4650 #ifdef USE_MOTIF
4652 /* We use an estimate of 30 chars per line rather than the real
4653 `portion' value. This has the disadvantage that the thumb size
4654 is not very representative, but it makes our life a lot easier.
4655 Otherwise, we have to constantly adjust the thumb size, which
4656 we can't always do quickly enough: while dragging, the size of
4657 the thumb might prevent the user from dragging the thumb all the
4658 way to the end. but Motif and some versions of Xaw3d don't allow
4659 updating the thumb size while dragging. Also, even if we can update
4660 its size, the update will often happen too late.
4661 If you don't believe it, check out revision 1.650 of xterm.c to see
4662 what hoops we were going through and the still poor behavior we got. */
4663 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4664 /* When the thumb is at the bottom, position == whole.
4665 So we need to increase `whole' to make space for the thumb. */
4666 whole += portion;
4668 if (whole <= 0)
4669 top = 0, shown = 1;
4670 else
4672 top = (float) position / whole;
4673 shown = (float) portion / whole;
4676 if (NILP (bar->dragging))
4678 int size, value;
4680 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4681 is the scroll bar's maximum and MIN is the scroll bar's minimum
4682 value. */
4683 size = shown * XM_SB_MAX;
4684 size = min (size, XM_SB_MAX);
4685 size = max (size, 1);
4687 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4688 value = top * XM_SB_MAX;
4689 value = min (value, XM_SB_MAX - size);
4691 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4693 #else /* !USE_MOTIF i.e. use Xaw */
4695 if (whole == 0)
4696 top = 0, shown = 1;
4697 else
4699 top = (float) position / whole;
4700 shown = (float) portion / whole;
4704 float old_top, old_shown;
4705 Dimension height;
4706 XtVaGetValues (widget,
4707 XtNtopOfThumb, &old_top,
4708 XtNshown, &old_shown,
4709 XtNheight, &height,
4710 NULL);
4712 /* Massage the top+shown values. */
4713 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4714 top = max (0, min (1, top));
4715 else
4716 top = old_top;
4717 /* Keep two pixels available for moving the thumb down. */
4718 shown = max (0, min (1 - top - (2.0 / height), shown));
4720 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4721 check that your system's configuration file contains a define
4722 for `NARROWPROTO'. See s/freebsd.h for an example. */
4723 if (top != old_top || shown != old_shown)
4725 if (NILP (bar->dragging))
4726 XawScrollbarSetThumb (widget, top, shown);
4727 else
4729 /* Try to make the scrolling a tad smoother. */
4730 if (!xaw3d_pick_top)
4731 shown = min (shown, old_shown);
4733 XawScrollbarSetThumb (widget, top, shown);
4737 #endif /* !USE_MOTIF */
4739 UNBLOCK_INPUT;
4741 #endif /* not USE_GTK */
4743 #endif /* USE_TOOLKIT_SCROLL_BARS */
4747 /************************************************************************
4748 Scroll bars, general
4749 ************************************************************************/
4751 /* Create a scroll bar and return the scroll bar vector for it. W is
4752 the Emacs window on which to create the scroll bar. TOP, LEFT,
4753 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4754 scroll bar. */
4756 static struct scroll_bar *
4757 x_scroll_bar_create (w, top, left, width, height)
4758 struct window *w;
4759 int top, left, width, height;
4761 struct frame *f = XFRAME (w->frame);
4762 struct scroll_bar *bar
4763 = XSCROLL_BAR (Fmake_vector (make_number (SCROLL_BAR_VEC_SIZE), Qnil));
4765 BLOCK_INPUT;
4767 #ifdef USE_TOOLKIT_SCROLL_BARS
4768 x_create_toolkit_scroll_bar (f, bar);
4769 #else /* not USE_TOOLKIT_SCROLL_BARS */
4771 XSetWindowAttributes a;
4772 unsigned long mask;
4773 Window window;
4775 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4776 if (a.background_pixel == -1)
4777 a.background_pixel = f->output_data.x->background_pixel;
4779 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4780 | ButtonMotionMask | PointerMotionHintMask
4781 | ExposureMask);
4782 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4784 mask = (CWBackPixel | CWEventMask | CWCursor);
4786 /* Clear the area of W that will serve as a scroll bar. This is
4787 for the case that a window has been split horizontally. In
4788 this case, no clear_frame is generated to reduce flickering. */
4789 if (width > 0 && height > 0)
4790 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4791 left, top, width,
4792 window_box_height (w), False);
4794 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4795 /* Position and size of scroll bar. */
4796 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4797 top,
4798 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4799 height,
4800 /* Border width, depth, class, and visual. */
4802 CopyFromParent,
4803 CopyFromParent,
4804 CopyFromParent,
4805 /* Attributes. */
4806 mask, &a);
4807 SET_SCROLL_BAR_X_WINDOW (bar, window);
4809 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4811 XSETWINDOW (bar->window, w);
4812 XSETINT (bar->top, top);
4813 XSETINT (bar->left, left);
4814 XSETINT (bar->width, width);
4815 XSETINT (bar->height, height);
4816 XSETINT (bar->start, 0);
4817 XSETINT (bar->end, 0);
4818 bar->dragging = Qnil;
4820 /* Add bar to its frame's list of scroll bars. */
4821 bar->next = FRAME_SCROLL_BARS (f);
4822 bar->prev = Qnil;
4823 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4824 if (!NILP (bar->next))
4825 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4827 /* Map the window/widget. */
4828 #ifdef USE_TOOLKIT_SCROLL_BARS
4830 #ifdef USE_GTK
4831 xg_update_scrollbar_pos (f,
4832 SCROLL_BAR_X_WINDOW (bar),
4833 top,
4834 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4835 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4836 max (height, 1));
4837 xg_show_scroll_bar (SCROLL_BAR_X_WINDOW (bar));
4838 #else /* not USE_GTK */
4839 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4840 XtConfigureWidget (scroll_bar,
4841 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4842 top,
4843 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4844 max (height, 1), 0);
4845 XtMapWidget (scroll_bar);
4846 #endif /* not USE_GTK */
4848 #else /* not USE_TOOLKIT_SCROLL_BARS */
4849 XMapRaised (FRAME_X_DISPLAY (f), SCROLL_BAR_X_WINDOW (bar));
4850 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4852 UNBLOCK_INPUT;
4853 return bar;
4857 /* Draw BAR's handle in the proper position.
4859 If the handle is already drawn from START to END, don't bother
4860 redrawing it, unless REBUILD is non-zero; in that case, always
4861 redraw it. (REBUILD is handy for drawing the handle after expose
4862 events.)
4864 Normally, we want to constrain the start and end of the handle to
4865 fit inside its rectangle, but if the user is dragging the scroll
4866 bar handle, we want to let them drag it down all the way, so that
4867 the bar's top is as far down as it goes; otherwise, there's no way
4868 to move to the very end of the buffer. */
4870 #ifndef USE_TOOLKIT_SCROLL_BARS
4872 static void
4873 x_scroll_bar_set_handle (bar, start, end, rebuild)
4874 struct scroll_bar *bar;
4875 int start, end;
4876 int rebuild;
4878 int dragging = ! NILP (bar->dragging);
4879 Window w = SCROLL_BAR_X_WINDOW (bar);
4880 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4881 GC gc = f->output_data.x->normal_gc;
4883 /* If the display is already accurate, do nothing. */
4884 if (! rebuild
4885 && start == XINT (bar->start)
4886 && end == XINT (bar->end))
4887 return;
4889 BLOCK_INPUT;
4892 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, XINT (bar->width));
4893 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, XINT (bar->height));
4894 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, XINT (bar->height));
4896 /* Make sure the values are reasonable, and try to preserve
4897 the distance between start and end. */
4899 int length = end - start;
4901 if (start < 0)
4902 start = 0;
4903 else if (start > top_range)
4904 start = top_range;
4905 end = start + length;
4907 if (end < start)
4908 end = start;
4909 else if (end > top_range && ! dragging)
4910 end = top_range;
4913 /* Store the adjusted setting in the scroll bar. */
4914 XSETINT (bar->start, start);
4915 XSETINT (bar->end, end);
4917 /* Clip the end position, just for display. */
4918 if (end > top_range)
4919 end = top_range;
4921 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
4922 below top positions, to make sure the handle is always at least
4923 that many pixels tall. */
4924 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
4926 /* Draw the empty space above the handle. Note that we can't clear
4927 zero-height areas; that means "clear to end of window." */
4928 if (0 < start)
4929 x_clear_area (FRAME_X_DISPLAY (f), w,
4930 /* x, y, width, height, and exposures. */
4931 VERTICAL_SCROLL_BAR_LEFT_BORDER,
4932 VERTICAL_SCROLL_BAR_TOP_BORDER,
4933 inside_width, start,
4934 False);
4936 /* Change to proper foreground color if one is specified. */
4937 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
4938 XSetForeground (FRAME_X_DISPLAY (f), gc,
4939 f->output_data.x->scroll_bar_foreground_pixel);
4941 /* Draw the handle itself. */
4942 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
4943 /* x, y, width, height */
4944 VERTICAL_SCROLL_BAR_LEFT_BORDER,
4945 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
4946 inside_width, end - start);
4948 /* Restore the foreground color of the GC if we changed it above. */
4949 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
4950 XSetForeground (FRAME_X_DISPLAY (f), gc,
4951 f->output_data.x->foreground_pixel);
4953 /* Draw the empty space below the handle. Note that we can't
4954 clear zero-height areas; that means "clear to end of window." */
4955 if (end < inside_height)
4956 x_clear_area (FRAME_X_DISPLAY (f), w,
4957 /* x, y, width, height, and exposures. */
4958 VERTICAL_SCROLL_BAR_LEFT_BORDER,
4959 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
4960 inside_width, inside_height - end,
4961 False);
4965 UNBLOCK_INPUT;
4968 #endif /* !USE_TOOLKIT_SCROLL_BARS */
4970 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
4971 nil. */
4973 static void
4974 x_scroll_bar_remove (bar)
4975 struct scroll_bar *bar;
4977 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4978 BLOCK_INPUT;
4980 #ifdef USE_TOOLKIT_SCROLL_BARS
4981 #ifdef USE_GTK
4982 xg_remove_scroll_bar (f, SCROLL_BAR_X_WINDOW (bar));
4983 #else /* not USE_GTK */
4984 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
4985 #endif /* not USE_GTK */
4986 #else
4987 XDestroyWindow (FRAME_X_DISPLAY (f), SCROLL_BAR_X_WINDOW (bar));
4988 #endif
4990 /* Disassociate this scroll bar from its window. */
4991 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
4993 UNBLOCK_INPUT;
4997 /* Set the handle of the vertical scroll bar for WINDOW to indicate
4998 that we are displaying PORTION characters out of a total of WHOLE
4999 characters, starting at POSITION. If WINDOW has no scroll bar,
5000 create one. */
5002 static void
5003 XTset_vertical_scroll_bar (w, portion, whole, position)
5004 struct window *w;
5005 int portion, whole, position;
5007 struct frame *f = XFRAME (w->frame);
5008 struct scroll_bar *bar;
5009 int top, height, left, sb_left, width, sb_width;
5010 int window_y, window_height;
5012 /* Get window dimensions. */
5013 window_box (w, -1, 0, &window_y, 0, &window_height);
5014 top = window_y;
5015 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5016 height = window_height;
5018 /* Compute the left edge of the scroll bar area. */
5019 left = WINDOW_SCROLL_BAR_AREA_X (w);
5021 /* Compute the width of the scroll bar which might be less than
5022 the width of the area reserved for the scroll bar. */
5023 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5024 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5025 else
5026 sb_width = width;
5028 /* Compute the left edge of the scroll bar. */
5029 #ifdef USE_TOOLKIT_SCROLL_BARS
5030 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5031 sb_left = (left +
5032 (WINDOW_RIGHTMOST_P (w)
5033 ? width - sb_width - (width - sb_width) / 2
5034 : 0));
5035 else
5036 sb_left = (left +
5037 (WINDOW_LEFTMOST_P (w)
5038 ? (width - sb_width) / 2
5039 : width - sb_width));
5040 #else
5041 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5042 sb_left = left + width - sb_width;
5043 else
5044 sb_left = left;
5045 #endif
5047 /* Does the scroll bar exist yet? */
5048 if (NILP (w->vertical_scroll_bar))
5050 if (width > 0 && height > 0)
5052 BLOCK_INPUT;
5053 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5054 left, top, width, height, False);
5055 UNBLOCK_INPUT;
5058 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5060 else
5062 /* It may just need to be moved and resized. */
5063 unsigned int mask = 0;
5065 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5067 BLOCK_INPUT;
5069 if (sb_left != XINT (bar->left))
5070 mask |= CWX;
5071 if (top != XINT (bar->top))
5072 mask |= CWY;
5073 if (sb_width != XINT (bar->width))
5074 mask |= CWWidth;
5075 if (height != XINT (bar->height))
5076 mask |= CWHeight;
5078 #ifdef USE_TOOLKIT_SCROLL_BARS
5080 /* Move/size the scroll bar widget. */
5081 if (mask)
5083 /* Since toolkit scroll bars are smaller than the space reserved
5084 for them on the frame, we have to clear "under" them. */
5085 if (width > 0 && height > 0)
5086 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5087 left, top, width, height, False);
5088 #ifdef USE_GTK
5089 xg_update_scrollbar_pos (f,
5090 SCROLL_BAR_X_WINDOW (bar),
5091 top,
5092 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5093 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5094 max (height, 1));
5095 #else /* not USE_GTK */
5096 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5097 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5098 top,
5099 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5100 max (height, 1), 0);
5101 #endif /* not USE_GTK */
5103 #else /* not USE_TOOLKIT_SCROLL_BARS */
5105 /* Clear areas not covered by the scroll bar because of
5106 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5107 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5109 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5110 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5111 height, False);
5112 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5113 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5114 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5115 height, False);
5118 /* Clear areas not covered by the scroll bar because it's not as
5119 wide as the area reserved for it. This makes sure a
5120 previous mode line display is cleared after C-x 2 C-x 1, for
5121 example. */
5123 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5124 int rest = area_width - sb_width;
5125 if (rest > 0 && height > 0)
5127 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5128 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5129 left + area_width - rest, top,
5130 rest, height, False);
5131 else
5132 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5133 left, top, rest, height, False);
5137 /* Move/size the scroll bar window. */
5138 if (mask)
5140 XWindowChanges wc;
5142 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5143 wc.y = top;
5144 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5145 wc.height = height;
5146 XConfigureWindow (FRAME_X_DISPLAY (f), SCROLL_BAR_X_WINDOW (bar),
5147 mask, &wc);
5150 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5152 /* Remember new settings. */
5153 XSETINT (bar->left, sb_left);
5154 XSETINT (bar->top, top);
5155 XSETINT (bar->width, sb_width);
5156 XSETINT (bar->height, height);
5158 UNBLOCK_INPUT;
5161 #ifdef USE_TOOLKIT_SCROLL_BARS
5162 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5163 #else /* not USE_TOOLKIT_SCROLL_BARS */
5164 /* Set the scroll bar's current state, unless we're currently being
5165 dragged. */
5166 if (NILP (bar->dragging))
5168 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5170 if (whole == 0)
5171 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5172 else
5174 int start = ((double) position * top_range) / whole;
5175 int end = ((double) (position + portion) * top_range) / whole;
5176 x_scroll_bar_set_handle (bar, start, end, 0);
5179 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5181 XSETVECTOR (w->vertical_scroll_bar, bar);
5185 /* The following three hooks are used when we're doing a thorough
5186 redisplay of the frame. We don't explicitly know which scroll bars
5187 are going to be deleted, because keeping track of when windows go
5188 away is a real pain - "Can you say set-window-configuration, boys
5189 and girls?" Instead, we just assert at the beginning of redisplay
5190 that *all* scroll bars are to be removed, and then save a scroll bar
5191 from the fiery pit when we actually redisplay its window. */
5193 /* Arrange for all scroll bars on FRAME to be removed at the next call
5194 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5195 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5197 static void
5198 XTcondemn_scroll_bars (frame)
5199 FRAME_PTR frame;
5201 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5202 while (! NILP (FRAME_SCROLL_BARS (frame)))
5204 Lisp_Object bar;
5205 bar = FRAME_SCROLL_BARS (frame);
5206 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5207 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5208 XSCROLL_BAR (bar)->prev = Qnil;
5209 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5210 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5211 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5216 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5217 Note that WINDOW isn't necessarily condemned at all. */
5219 static void
5220 XTredeem_scroll_bar (window)
5221 struct window *window;
5223 struct scroll_bar *bar;
5224 struct frame *f;
5226 /* We can't redeem this window's scroll bar if it doesn't have one. */
5227 if (NILP (window->vertical_scroll_bar))
5228 abort ();
5230 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5232 /* Unlink it from the condemned list. */
5233 f = XFRAME (WINDOW_FRAME (window));
5234 if (NILP (bar->prev))
5236 /* If the prev pointer is nil, it must be the first in one of
5237 the lists. */
5238 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5239 /* It's not condemned. Everything's fine. */
5240 return;
5241 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5242 window->vertical_scroll_bar))
5243 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5244 else
5245 /* If its prev pointer is nil, it must be at the front of
5246 one or the other! */
5247 abort ();
5249 else
5250 XSCROLL_BAR (bar->prev)->next = bar->next;
5252 if (! NILP (bar->next))
5253 XSCROLL_BAR (bar->next)->prev = bar->prev;
5255 bar->next = FRAME_SCROLL_BARS (f);
5256 bar->prev = Qnil;
5257 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5258 if (! NILP (bar->next))
5259 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5262 /* Remove all scroll bars on FRAME that haven't been saved since the
5263 last call to `*condemn_scroll_bars_hook'. */
5265 static void
5266 XTjudge_scroll_bars (f)
5267 FRAME_PTR f;
5269 Lisp_Object bar, next;
5271 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5273 /* Clear out the condemned list now so we won't try to process any
5274 more events on the hapless scroll bars. */
5275 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5277 for (; ! NILP (bar); bar = next)
5279 struct scroll_bar *b = XSCROLL_BAR (bar);
5281 x_scroll_bar_remove (b);
5283 next = b->next;
5284 b->next = b->prev = Qnil;
5287 /* Now there should be no references to the condemned scroll bars,
5288 and they should get garbage-collected. */
5292 #ifndef USE_TOOLKIT_SCROLL_BARS
5293 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5294 is a no-op when using toolkit scroll bars.
5296 This may be called from a signal handler, so we have to ignore GC
5297 mark bits. */
5299 static void
5300 x_scroll_bar_expose (bar, event)
5301 struct scroll_bar *bar;
5302 XEvent *event;
5304 Window w = SCROLL_BAR_X_WINDOW (bar);
5305 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5306 GC gc = f->output_data.x->normal_gc;
5307 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5309 BLOCK_INPUT;
5311 x_scroll_bar_set_handle (bar, XINT (bar->start), XINT (bar->end), 1);
5313 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5314 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5316 /* x, y, width, height */
5317 0, 0,
5318 XINT (bar->width) - 1 - width_trim - width_trim,
5319 XINT (bar->height) - 1);
5321 UNBLOCK_INPUT;
5324 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5326 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5327 is set to something other than NO_EVENT, it is enqueued.
5329 This may be called from a signal handler, so we have to ignore GC
5330 mark bits. */
5333 static void
5334 x_scroll_bar_handle_click (bar, event, emacs_event)
5335 struct scroll_bar *bar;
5336 XEvent *event;
5337 struct input_event *emacs_event;
5339 if (! GC_WINDOWP (bar->window))
5340 abort ();
5342 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5343 emacs_event->code = event->xbutton.button - Button1;
5344 emacs_event->modifiers
5345 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5346 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5347 event->xbutton.state)
5348 | (event->type == ButtonRelease
5349 ? up_modifier
5350 : down_modifier));
5351 emacs_event->frame_or_window = bar->window;
5352 emacs_event->arg = Qnil;
5353 emacs_event->timestamp = event->xbutton.time;
5355 #if 0
5356 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5357 int internal_height
5358 = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, XINT (bar->height));
5359 #endif
5360 int top_range
5361 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, XINT (bar->height));
5362 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5364 if (y < 0) y = 0;
5365 if (y > top_range) y = top_range;
5367 if (y < XINT (bar->start))
5368 emacs_event->part = scroll_bar_above_handle;
5369 else if (y < XINT (bar->end) + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5370 emacs_event->part = scroll_bar_handle;
5371 else
5372 emacs_event->part = scroll_bar_below_handle;
5374 /* Just because the user has clicked on the handle doesn't mean
5375 they want to drag it. Lisp code needs to be able to decide
5376 whether or not we're dragging. */
5377 #if 0
5378 /* If the user has just clicked on the handle, record where they're
5379 holding it. */
5380 if (event->type == ButtonPress
5381 && emacs_event->part == scroll_bar_handle)
5382 XSETINT (bar->dragging, y - XINT (bar->start));
5383 #endif
5385 #ifndef USE_TOOLKIT_SCROLL_BARS
5386 /* If the user has released the handle, set it to its final position. */
5387 if (event->type == ButtonRelease
5388 && ! NILP (bar->dragging))
5390 int new_start = y - XINT (bar->dragging);
5391 int new_end = new_start + (XINT (bar->end) - XINT (bar->start));
5393 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5394 bar->dragging = Qnil;
5396 #endif
5398 /* Same deal here as the other #if 0. */
5399 #if 0
5400 /* Clicks on the handle are always reported as occurring at the top of
5401 the handle. */
5402 if (emacs_event->part == scroll_bar_handle)
5403 emacs_event->x = bar->start;
5404 else
5405 XSETINT (emacs_event->x, y);
5406 #else
5407 XSETINT (emacs_event->x, y);
5408 #endif
5410 XSETINT (emacs_event->y, top_range);
5414 #ifndef USE_TOOLKIT_SCROLL_BARS
5416 /* Handle some mouse motion while someone is dragging the scroll bar.
5418 This may be called from a signal handler, so we have to ignore GC
5419 mark bits. */
5421 static void
5422 x_scroll_bar_note_movement (bar, event)
5423 struct scroll_bar *bar;
5424 XEvent *event;
5426 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5428 last_mouse_movement_time = event->xmotion.time;
5430 f->mouse_moved = 1;
5431 XSETVECTOR (last_mouse_scroll_bar, bar);
5433 /* If we're dragging the bar, display it. */
5434 if (! GC_NILP (bar->dragging))
5436 /* Where should the handle be now? */
5437 int new_start = event->xmotion.y - XINT (bar->dragging);
5439 if (new_start != XINT (bar->start))
5441 int new_end = new_start + (XINT (bar->end) - XINT (bar->start));
5443 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5448 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5450 /* Return information to the user about the current position of the mouse
5451 on the scroll bar. */
5453 static void
5454 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time)
5455 FRAME_PTR *fp;
5456 Lisp_Object *bar_window;
5457 enum scroll_bar_part *part;
5458 Lisp_Object *x, *y;
5459 unsigned long *time;
5461 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5462 Window w = SCROLL_BAR_X_WINDOW (bar);
5463 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5464 int win_x, win_y;
5465 Window dummy_window;
5466 int dummy_coord;
5467 unsigned int dummy_mask;
5469 BLOCK_INPUT;
5471 /* Get the mouse's position relative to the scroll bar window, and
5472 report that. */
5473 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5475 /* Root, child, root x and root y. */
5476 &dummy_window, &dummy_window,
5477 &dummy_coord, &dummy_coord,
5479 /* Position relative to scroll bar. */
5480 &win_x, &win_y,
5482 /* Mouse buttons and modifier keys. */
5483 &dummy_mask))
5485 else
5487 #if 0
5488 int inside_height
5489 = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, XINT (bar->height));
5490 #endif
5491 int top_range
5492 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, XINT (bar->height));
5494 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5496 if (! NILP (bar->dragging))
5497 win_y -= XINT (bar->dragging);
5499 if (win_y < 0)
5500 win_y = 0;
5501 if (win_y > top_range)
5502 win_y = top_range;
5504 *fp = f;
5505 *bar_window = bar->window;
5507 if (! NILP (bar->dragging))
5508 *part = scroll_bar_handle;
5509 else if (win_y < XINT (bar->start))
5510 *part = scroll_bar_above_handle;
5511 else if (win_y < XINT (bar->end) + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5512 *part = scroll_bar_handle;
5513 else
5514 *part = scroll_bar_below_handle;
5516 XSETINT (*x, win_y);
5517 XSETINT (*y, top_range);
5519 f->mouse_moved = 0;
5520 last_mouse_scroll_bar = Qnil;
5523 *time = last_mouse_movement_time;
5525 UNBLOCK_INPUT;
5529 /* The screen has been cleared so we may have changed foreground or
5530 background colors, and the scroll bars may need to be redrawn.
5531 Clear out the scroll bars, and ask for expose events, so we can
5532 redraw them. */
5534 void
5535 x_scroll_bar_clear (f)
5536 FRAME_PTR f;
5538 #ifndef USE_TOOLKIT_SCROLL_BARS
5539 Lisp_Object bar;
5541 /* We can have scroll bars even if this is 0,
5542 if we just turned off scroll bar mode.
5543 But in that case we should not clear them. */
5544 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5545 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5546 bar = XSCROLL_BAR (bar)->next)
5547 XClearArea (FRAME_X_DISPLAY (f),
5548 SCROLL_BAR_X_WINDOW (XSCROLL_BAR (bar)),
5549 0, 0, 0, 0, True);
5550 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5554 /* The main X event-reading loop - XTread_socket. */
5556 #if 0
5557 /* Time stamp of enter window event. This is only used by XTread_socket,
5558 but we have to put it out here, since static variables within functions
5559 sometimes don't work. */
5561 static Time enter_timestamp;
5562 #endif
5564 /* This holds the state XLookupString needs to implement dead keys
5565 and other tricks known as "compose processing". _X Window System_
5566 says that a portable program can't use this, but Stephen Gildea assures
5567 me that letting the compiler initialize it to zeros will work okay.
5569 This must be defined outside of XTread_socket, for the same reasons
5570 given for enter_timestamp, above. */
5572 static XComposeStatus compose_status;
5574 /* Record the last 100 characters stored
5575 to help debug the loss-of-chars-during-GC problem. */
5577 static int temp_index;
5578 static short temp_buffer[100];
5580 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5581 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5582 temp_index = 0; \
5583 temp_buffer[temp_index++] = (keysym)
5585 /* Set this to nonzero to fake an "X I/O error"
5586 on a particular display. */
5588 struct x_display_info *XTread_socket_fake_io_error;
5590 /* When we find no input here, we occasionally do a no-op command
5591 to verify that the X server is still running and we can still talk with it.
5592 We try all the open displays, one by one.
5593 This variable is used for cycling thru the displays. */
5595 static struct x_display_info *next_noop_dpyinfo;
5597 #define SET_SAVED_MENU_EVENT(size) \
5598 do \
5600 if (f->output_data.x->saved_menu_event == 0) \
5601 f->output_data.x->saved_menu_event \
5602 = (XEvent *) xmalloc (sizeof (XEvent)); \
5603 bcopy (&event, f->output_data.x->saved_menu_event, size); \
5604 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5605 XSETFRAME (inev.ie.frame_or_window, f); \
5607 while (0)
5609 #define SET_SAVED_BUTTON_EVENT SET_SAVED_MENU_EVENT (sizeof (XButtonEvent))
5610 #define SET_SAVED_KEY_EVENT SET_SAVED_MENU_EVENT (sizeof (XKeyEvent))
5613 enum
5615 X_EVENT_NORMAL,
5616 X_EVENT_GOTO_OUT,
5617 X_EVENT_DROP
5620 /* Filter events for the current X input method.
5621 DPYINFO is the display this event is for.
5622 EVENT is the X event to filter.
5624 Returns non-zero if the event was filtered, caller shall not process
5625 this event further.
5626 Returns zero if event is wasn't filtered. */
5628 #ifdef HAVE_X_I18N
5629 static int
5630 x_filter_event (dpyinfo, event)
5631 struct x_display_info *dpyinfo;
5632 XEvent *event;
5634 /* XFilterEvent returns non-zero if the input method has
5635 consumed the event. We pass the frame's X window to
5636 XFilterEvent because that's the one for which the IC
5637 was created. */
5639 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5640 event->xclient.window);
5642 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5644 #endif
5646 #ifdef USE_GTK
5647 static int current_count;
5648 static int current_finish;
5649 static struct input_event *current_hold_quit;
5651 /* This is the filter function invoked by the GTK event loop.
5652 It is invoked before the XEvent is translated to a GdkEvent,
5653 so we have a chance to act on the event before GTK. */
5654 static GdkFilterReturn
5655 event_handler_gdk (gxev, ev, data)
5656 GdkXEvent *gxev;
5657 GdkEvent *ev;
5658 gpointer data;
5660 XEvent *xev = (XEvent *) gxev;
5662 if (current_count >= 0)
5664 struct x_display_info *dpyinfo;
5666 dpyinfo = x_display_info_for_display (xev->xany.display);
5668 #ifdef HAVE_X_I18N
5669 /* Filter events for the current X input method.
5670 GTK calls XFilterEvent but not for key press and release,
5671 so we do it here. */
5672 if (xev->type == KeyPress || xev->type == KeyRelease)
5673 if (dpyinfo && x_filter_event (dpyinfo, xev))
5674 return GDK_FILTER_REMOVE;
5675 #endif
5677 if (! dpyinfo)
5678 current_finish = X_EVENT_NORMAL;
5679 else
5681 current_count +=
5682 handle_one_xevent (dpyinfo, xev, &current_finish,
5683 current_hold_quit);
5686 else
5687 current_finish = x_dispatch_event (xev, xev->xany.display);
5689 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5690 return GDK_FILTER_REMOVE;
5692 return GDK_FILTER_CONTINUE;
5694 #endif /* USE_GTK */
5697 /* Handles the XEvent EVENT on display DPYINFO.
5699 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5700 *FINISH is zero if caller should continue reading events.
5701 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5703 We return the number of characters stored into the buffer. */
5705 static int
5706 handle_one_xevent (dpyinfo, eventp, finish, hold_quit)
5707 struct x_display_info *dpyinfo;
5708 XEvent *eventp;
5709 int *finish;
5710 struct input_event *hold_quit;
5712 union {
5713 struct input_event ie;
5714 struct selection_input_event sie;
5715 } inev;
5716 int count = 0;
5717 int do_help = 0;
5718 int nbytes = 0;
5719 struct frame *f;
5720 struct coding_system coding;
5721 XEvent event = *eventp;
5723 *finish = X_EVENT_NORMAL;
5725 EVENT_INIT (inev.ie);
5726 inev.ie.kind = NO_EVENT;
5727 inev.ie.arg = Qnil;
5729 switch (event.type)
5731 case ClientMessage:
5733 if (event.xclient.message_type
5734 == dpyinfo->Xatom_wm_protocols
5735 && event.xclient.format == 32)
5737 if (event.xclient.data.l[0]
5738 == dpyinfo->Xatom_wm_take_focus)
5740 /* Use x_any_window_to_frame because this
5741 could be the shell widget window
5742 if the frame has no title bar. */
5743 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5744 #ifdef HAVE_X_I18N
5745 /* Not quite sure this is needed -pd */
5746 if (f && FRAME_XIC (f))
5747 XSetICFocus (FRAME_XIC (f));
5748 #endif
5749 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5750 instructs the WM to set the input focus automatically for
5751 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5752 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5753 it has set the focus. So, XSetInputFocus below is not
5754 needed.
5756 The call to XSetInputFocus below has also caused trouble. In
5757 cases where the XSetInputFocus done by the WM and the one
5758 below are temporally close (on a fast machine), the call
5759 below can generate additional FocusIn events which confuse
5760 Emacs. */
5762 /* Since we set WM_TAKE_FOCUS, we must call
5763 XSetInputFocus explicitly. But not if f is null,
5764 since that might be an event for a deleted frame. */
5765 if (f)
5767 Display *d = event.xclient.display;
5768 /* Catch and ignore errors, in case window has been
5769 iconified by a window manager such as GWM. */
5770 int count = x_catch_errors (d);
5771 XSetInputFocus (d, event.xclient.window,
5772 /* The ICCCM says this is
5773 the only valid choice. */
5774 RevertToParent,
5775 event.xclient.data.l[1]);
5776 /* This is needed to detect the error
5777 if there is an error. */
5778 XSync (d, False);
5779 x_uncatch_errors (d, count);
5781 /* Not certain about handling scroll bars here */
5782 #endif /* 0 */
5783 goto done;
5786 if (event.xclient.data.l[0]
5787 == dpyinfo->Xatom_wm_save_yourself)
5789 /* Save state modify the WM_COMMAND property to
5790 something which can reinstate us. This notifies
5791 the session manager, who's looking for such a
5792 PropertyNotify. Can restart processing when
5793 a keyboard or mouse event arrives. */
5794 /* If we have a session manager, don't set this.
5795 KDE will then start two Emacsen, one for the
5796 session manager and one for this. */
5797 #ifdef HAVE_X_SM
5798 if (! x_session_have_connection ())
5799 #endif
5801 f = x_top_window_to_frame (dpyinfo,
5802 event.xclient.window);
5803 /* This is just so we only give real data once
5804 for a single Emacs process. */
5805 if (f == SELECTED_FRAME ())
5806 XSetCommand (FRAME_X_DISPLAY (f),
5807 event.xclient.window,
5808 initial_argv, initial_argc);
5809 else if (f)
5810 XSetCommand (FRAME_X_DISPLAY (f),
5811 event.xclient.window,
5812 0, 0);
5814 goto done;
5817 if (event.xclient.data.l[0]
5818 == dpyinfo->Xatom_wm_delete_window)
5820 f = x_any_window_to_frame (dpyinfo,
5821 event.xclient.window);
5822 if (!f)
5823 goto OTHER; /* May be a dialog that is to be removed */
5825 inev.ie.kind = DELETE_WINDOW_EVENT;
5826 XSETFRAME (inev.ie.frame_or_window, f);
5827 goto done;
5830 goto done;
5833 if (event.xclient.message_type
5834 == dpyinfo->Xatom_wm_configure_denied)
5836 goto done;
5839 if (event.xclient.message_type
5840 == dpyinfo->Xatom_wm_window_moved)
5842 int new_x, new_y;
5843 f = x_window_to_frame (dpyinfo, event.xclient.window);
5845 new_x = event.xclient.data.s[0];
5846 new_y = event.xclient.data.s[1];
5848 if (f)
5850 f->left_pos = new_x;
5851 f->top_pos = new_y;
5853 goto done;
5856 #ifdef HACK_EDITRES
5857 if (event.xclient.message_type
5858 == dpyinfo->Xatom_editres)
5860 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5861 _XEditResCheckMessages (f->output_data.x->widget, NULL,
5862 &event, NULL);
5863 goto done;
5865 #endif /* HACK_EDITRES */
5867 if ((event.xclient.message_type
5868 == dpyinfo->Xatom_DONE)
5869 || (event.xclient.message_type
5870 == dpyinfo->Xatom_PAGE))
5872 /* Ghostview job completed. Kill it. We could
5873 reply with "Next" if we received "Page", but we
5874 currently never do because we are interested in
5875 images, only, which should have 1 page. */
5876 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
5877 f = x_window_to_frame (dpyinfo, event.xclient.window);
5878 x_kill_gs_process (pixmap, f);
5879 expose_frame (f, 0, 0, 0, 0);
5880 goto done;
5883 #ifdef USE_TOOLKIT_SCROLL_BARS
5884 /* Scroll bar callbacks send a ClientMessage from which
5885 we construct an input_event. */
5886 if (event.xclient.message_type
5887 == dpyinfo->Xatom_Scrollbar)
5889 x_scroll_bar_to_input_event (&event, &inev.ie);
5890 *finish = X_EVENT_GOTO_OUT;
5891 goto done;
5893 #endif /* USE_TOOLKIT_SCROLL_BARS */
5895 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5897 if (!f)
5898 goto OTHER;
5900 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
5901 *finish = X_EVENT_DROP;
5903 break;
5905 case SelectionNotify:
5906 #ifdef USE_X_TOOLKIT
5907 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
5908 goto OTHER;
5909 #endif /* not USE_X_TOOLKIT */
5910 x_handle_selection_notify (&event.xselection);
5911 break;
5913 case SelectionClear: /* Someone has grabbed ownership. */
5914 #ifdef USE_X_TOOLKIT
5915 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
5916 goto OTHER;
5917 #endif /* USE_X_TOOLKIT */
5919 XSelectionClearEvent *eventp = (XSelectionClearEvent *) &event;
5921 inev.ie.kind = SELECTION_CLEAR_EVENT;
5922 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
5923 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
5924 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
5925 inev.ie.frame_or_window = Qnil;
5927 break;
5929 case SelectionRequest: /* Someone wants our selection. */
5930 #ifdef USE_X_TOOLKIT
5931 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
5932 goto OTHER;
5933 #endif /* USE_X_TOOLKIT */
5935 XSelectionRequestEvent *eventp
5936 = (XSelectionRequestEvent *) &event;
5938 inev.ie.kind = SELECTION_REQUEST_EVENT;
5939 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
5940 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
5941 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
5942 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
5943 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
5944 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
5945 inev.ie.frame_or_window = Qnil;
5947 break;
5949 case PropertyNotify:
5950 #if 0 /* This is plain wrong. In the case that we are waiting for a
5951 PropertyNotify used as an ACK in incremental selection
5952 transfer, the property will be on the receiver's window. */
5953 #if defined USE_X_TOOLKIT
5954 if (!x_any_window_to_frame (dpyinfo, event.xproperty.window))
5955 goto OTHER;
5956 #endif
5957 #endif
5958 x_handle_property_notify (&event.xproperty);
5959 goto OTHER;
5961 case ReparentNotify:
5962 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
5963 if (f)
5965 int x, y;
5966 f->output_data.x->parent_desc = event.xreparent.parent;
5967 x_real_positions (f, &x, &y);
5968 f->left_pos = x;
5969 f->top_pos = y;
5971 /* Perhaps reparented due to a WM restart. Reset this. */
5972 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
5974 goto OTHER;
5976 case Expose:
5977 f = x_window_to_frame (dpyinfo, event.xexpose.window);
5978 if (f)
5980 x_check_fullscreen (f);
5982 #ifdef USE_GTK
5983 /* This seems to be needed for GTK 2.6. */
5984 x_clear_area (event.xexpose.display,
5985 event.xexpose.window,
5986 event.xexpose.x, event.xexpose.y,
5987 event.xexpose.width, event.xexpose.height,
5988 FALSE);
5989 #endif
5990 if (f->async_visible == 0)
5992 f->async_visible = 1;
5993 f->async_iconified = 0;
5994 f->output_data.x->has_been_visible = 1;
5995 SET_FRAME_GARBAGED (f);
5997 else
5998 expose_frame (f,
5999 event.xexpose.x, event.xexpose.y,
6000 event.xexpose.width, event.xexpose.height);
6002 else
6004 #ifndef USE_TOOLKIT_SCROLL_BARS
6005 struct scroll_bar *bar;
6006 #endif
6007 #if defined USE_LUCID
6008 /* Submenus of the Lucid menu bar aren't widgets
6009 themselves, so there's no way to dispatch events
6010 to them. Recognize this case separately. */
6012 Widget widget
6013 = x_window_to_menu_bar (event.xexpose.window);
6014 if (widget)
6015 xlwmenu_redisplay (widget);
6017 #endif /* USE_LUCID */
6019 #ifdef USE_TOOLKIT_SCROLL_BARS
6020 /* Dispatch event to the widget. */
6021 goto OTHER;
6022 #else /* not USE_TOOLKIT_SCROLL_BARS */
6023 bar = x_window_to_scroll_bar (event.xexpose.display,
6024 event.xexpose.window);
6026 if (bar)
6027 x_scroll_bar_expose (bar, &event);
6028 #ifdef USE_X_TOOLKIT
6029 else
6030 goto OTHER;
6031 #endif /* USE_X_TOOLKIT */
6032 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6034 break;
6036 case GraphicsExpose: /* This occurs when an XCopyArea's
6037 source area was obscured or not
6038 available. */
6039 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6040 if (f)
6042 expose_frame (f,
6043 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6044 event.xgraphicsexpose.width,
6045 event.xgraphicsexpose.height);
6047 #ifdef USE_X_TOOLKIT
6048 else
6049 goto OTHER;
6050 #endif /* USE_X_TOOLKIT */
6051 break;
6053 case NoExpose: /* This occurs when an XCopyArea's
6054 source area was completely
6055 available. */
6056 break;
6058 case UnmapNotify:
6059 /* Redo the mouse-highlight after the tooltip has gone. */
6060 if (event.xmap.window == tip_window)
6062 tip_window = 0;
6063 redo_mouse_highlight ();
6066 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6067 if (f) /* F may no longer exist if
6068 the frame was deleted. */
6070 /* While a frame is unmapped, display generation is
6071 disabled; you don't want to spend time updating a
6072 display that won't ever be seen. */
6073 f->async_visible = 0;
6074 /* We can't distinguish, from the event, whether the window
6075 has become iconified or invisible. So assume, if it
6076 was previously visible, than now it is iconified.
6077 But x_make_frame_invisible clears both
6078 the visible flag and the iconified flag;
6079 and that way, we know the window is not iconified now. */
6080 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6082 f->async_iconified = 1;
6084 inev.ie.kind = ICONIFY_EVENT;
6085 XSETFRAME (inev.ie.frame_or_window, f);
6088 goto OTHER;
6090 case MapNotify:
6091 if (event.xmap.window == tip_window)
6092 /* The tooltip has been drawn already. Avoid
6093 the SET_FRAME_GARBAGED below. */
6094 goto OTHER;
6096 /* We use x_top_window_to_frame because map events can
6097 come for sub-windows and they don't mean that the
6098 frame is visible. */
6099 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6100 if (f)
6102 /* wait_reading_process_output will notice this and update
6103 the frame's display structures.
6104 If we where iconified, we should not set garbaged,
6105 because that stops redrawing on Expose events. This looks
6106 bad if we are called from a recursive event loop
6107 (x_dispatch_event), for example when a dialog is up. */
6108 if (! f->async_iconified)
6109 SET_FRAME_GARBAGED (f);
6111 f->async_visible = 1;
6112 f->async_iconified = 0;
6113 f->output_data.x->has_been_visible = 1;
6115 if (f->iconified)
6117 inev.ie.kind = DEICONIFY_EVENT;
6118 XSETFRAME (inev.ie.frame_or_window, f);
6120 else if (! NILP (Vframe_list)
6121 && ! NILP (XCDR (Vframe_list)))
6122 /* Force a redisplay sooner or later
6123 to update the frame titles
6124 in case this is the second frame. */
6125 record_asynch_buffer_change ();
6127 goto OTHER;
6129 case KeyPress:
6131 ignore_next_mouse_click_timeout = 0;
6133 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6134 /* Dispatch KeyPress events when in menu. */
6135 if (popup_activated ())
6136 goto OTHER;
6137 #endif
6139 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6141 if (!dpyinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight))
6143 clear_mouse_face (dpyinfo);
6144 dpyinfo->mouse_face_hidden = 1;
6147 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6148 if (f == 0)
6150 /* Scroll bars consume key events, but we want
6151 the keys to go to the scroll bar's frame. */
6152 Widget widget = XtWindowToWidget (dpyinfo->display,
6153 event.xkey.window);
6154 if (widget && XmIsScrollBar (widget))
6156 widget = XtParent (widget);
6157 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6160 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6162 if (f != 0)
6164 KeySym keysym, orig_keysym;
6165 /* al%imercury@uunet.uu.net says that making this 81
6166 instead of 80 fixed a bug whereby meta chars made
6167 his Emacs hang.
6169 It seems that some version of XmbLookupString has
6170 a bug of not returning XBufferOverflow in
6171 status_return even if the input is too long to
6172 fit in 81 bytes. So, we must prepare sufficient
6173 bytes for copy_buffer. 513 bytes (256 chars for
6174 two-byte character set) seems to be a fairly good
6175 approximation. -- 2000.8.10 handa@etl.go.jp */
6176 unsigned char copy_buffer[513];
6177 unsigned char *copy_bufptr = copy_buffer;
6178 int copy_bufsiz = sizeof (copy_buffer);
6179 int modifiers;
6180 Lisp_Object coding_system = Qlatin_1;
6181 Lisp_Object c;
6183 #ifdef USE_GTK
6184 /* Don't pass keys to GTK. A Tab will shift focus to the
6185 tool bar in GTK 2.4. Keys will still go to menus and
6186 dialogs because in that case popup_activated is TRUE
6187 (see above). */
6188 *finish = X_EVENT_DROP;
6189 #endif
6191 event.xkey.state
6192 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6193 extra_keyboard_modifiers);
6194 modifiers = event.xkey.state;
6196 /* This will have to go some day... */
6198 /* make_lispy_event turns chars into control chars.
6199 Don't do it here because XLookupString is too eager. */
6200 event.xkey.state &= ~ControlMask;
6201 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6202 | dpyinfo->super_mod_mask
6203 | dpyinfo->hyper_mod_mask
6204 | dpyinfo->alt_mod_mask);
6206 /* In case Meta is ComposeCharacter,
6207 clear its status. According to Markus Ehrnsperger
6208 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6209 this enables ComposeCharacter to work whether or
6210 not it is combined with Meta. */
6211 if (modifiers & dpyinfo->meta_mod_mask)
6212 bzero (&compose_status, sizeof (compose_status));
6214 #ifdef HAVE_X_I18N
6215 if (FRAME_XIC (f))
6217 Status status_return;
6219 coding_system = Vlocale_coding_system;
6220 nbytes = XmbLookupString (FRAME_XIC (f),
6221 &event.xkey, copy_bufptr,
6222 copy_bufsiz, &keysym,
6223 &status_return);
6224 if (status_return == XBufferOverflow)
6226 copy_bufsiz = nbytes + 1;
6227 copy_bufptr = (char *) alloca (copy_bufsiz);
6228 nbytes = XmbLookupString (FRAME_XIC (f),
6229 &event.xkey, copy_bufptr,
6230 copy_bufsiz, &keysym,
6231 &status_return);
6233 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6234 #if 0 && defined X_HAVE_UTF8_STRING
6235 else if (status_return == XLookupKeySym)
6236 { /* Try again but with utf-8. */
6237 coding_system = Qutf_8;
6238 nbytes = Xutf8LookupString (FRAME_XIC (f),
6239 &event.xkey, copy_bufptr,
6240 copy_bufsiz, &keysym,
6241 &status_return);
6242 if (status_return == XBufferOverflow)
6244 copy_bufsiz = nbytes + 1;
6245 copy_bufptr = (char *) alloca (copy_bufsiz);
6246 nbytes = Xutf8LookupString (FRAME_XIC (f),
6247 &event.xkey,
6248 copy_bufptr,
6249 copy_bufsiz, &keysym,
6250 &status_return);
6253 #endif
6255 if (status_return == XLookupNone)
6256 break;
6257 else if (status_return == XLookupChars)
6259 keysym = NoSymbol;
6260 modifiers = 0;
6262 else if (status_return != XLookupKeySym
6263 && status_return != XLookupBoth)
6264 abort ();
6266 else
6267 nbytes = XLookupString (&event.xkey, copy_bufptr,
6268 copy_bufsiz, &keysym,
6269 &compose_status);
6270 #else
6271 nbytes = XLookupString (&event.xkey, copy_bufptr,
6272 copy_bufsiz, &keysym,
6273 &compose_status);
6274 #endif
6276 /* If not using XIM/XIC, and a compose sequence is in progress,
6277 we break here. Otherwise, chars_matched is always 0. */
6278 if (compose_status.chars_matched > 0 && nbytes == 0)
6279 break;
6281 orig_keysym = keysym;
6283 /* Common for all keysym input events. */
6284 XSETFRAME (inev.ie.frame_or_window, f);
6285 inev.ie.modifiers
6286 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6287 inev.ie.timestamp = event.xkey.time;
6289 /* First deal with keysyms which have defined
6290 translations to characters. */
6291 if (keysym >= 32 && keysym < 128)
6292 /* Avoid explicitly decoding each ASCII character. */
6294 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6295 inev.ie.code = keysym;
6296 goto done_keysym;
6299 /* Now non-ASCII. */
6300 if (HASH_TABLE_P (Vx_keysym_table)
6301 && (NATNUMP (c = Fgethash (make_number (keysym),
6302 Vx_keysym_table,
6303 Qnil))))
6305 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6306 ? ASCII_KEYSTROKE_EVENT
6307 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6308 inev.ie.code = XFASTINT (c);
6309 goto done_keysym;
6312 /* Random non-modifier sorts of keysyms. */
6313 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6314 || keysym == XK_Delete
6315 #ifdef XK_ISO_Left_Tab
6316 || (keysym >= XK_ISO_Left_Tab
6317 && keysym <= XK_ISO_Enter)
6318 #endif
6319 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6320 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6321 #ifdef HPUX
6322 /* This recognizes the "extended function
6323 keys". It seems there's no cleaner way.
6324 Test IsModifierKey to avoid handling
6325 mode_switch incorrectly. */
6326 || ((unsigned) (keysym) >= XK_Select
6327 && (unsigned)(keysym) < XK_KP_Space)
6328 #endif
6329 #ifdef XK_dead_circumflex
6330 || orig_keysym == XK_dead_circumflex
6331 #endif
6332 #ifdef XK_dead_grave
6333 || orig_keysym == XK_dead_grave
6334 #endif
6335 #ifdef XK_dead_tilde
6336 || orig_keysym == XK_dead_tilde
6337 #endif
6338 #ifdef XK_dead_diaeresis
6339 || orig_keysym == XK_dead_diaeresis
6340 #endif
6341 #ifdef XK_dead_macron
6342 || orig_keysym == XK_dead_macron
6343 #endif
6344 #ifdef XK_dead_degree
6345 || orig_keysym == XK_dead_degree
6346 #endif
6347 #ifdef XK_dead_acute
6348 || orig_keysym == XK_dead_acute
6349 #endif
6350 #ifdef XK_dead_cedilla
6351 || orig_keysym == XK_dead_cedilla
6352 #endif
6353 #ifdef XK_dead_breve
6354 || orig_keysym == XK_dead_breve
6355 #endif
6356 #ifdef XK_dead_ogonek
6357 || orig_keysym == XK_dead_ogonek
6358 #endif
6359 #ifdef XK_dead_caron
6360 || orig_keysym == XK_dead_caron
6361 #endif
6362 #ifdef XK_dead_doubleacute
6363 || orig_keysym == XK_dead_doubleacute
6364 #endif
6365 #ifdef XK_dead_abovedot
6366 || orig_keysym == XK_dead_abovedot
6367 #endif
6368 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6369 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6370 /* Any "vendor-specific" key is ok. */
6371 || (orig_keysym & (1 << 28))
6372 || (keysym != NoSymbol && nbytes == 0))
6373 && ! (IsModifierKey (orig_keysym)
6374 #ifndef HAVE_X11R5
6375 #ifdef XK_Mode_switch
6376 || ((unsigned)(orig_keysym) == XK_Mode_switch)
6377 #endif
6378 #ifdef XK_Num_Lock
6379 || ((unsigned)(orig_keysym) == XK_Num_Lock)
6380 #endif
6381 #endif /* not HAVE_X11R5 */
6382 /* The symbols from XK_ISO_Lock
6383 to XK_ISO_Last_Group_Lock
6384 don't have real modifiers but
6385 should be treated similarly to
6386 Mode_switch by Emacs. */
6387 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6388 || ((unsigned)(orig_keysym)
6389 >= XK_ISO_Lock
6390 && (unsigned)(orig_keysym)
6391 <= XK_ISO_Last_Group_Lock)
6392 #endif
6395 STORE_KEYSYM_FOR_DEBUG (keysym);
6396 /* make_lispy_event will convert this to a symbolic
6397 key. */
6398 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6399 inev.ie.code = keysym;
6400 goto done_keysym;
6403 { /* Raw bytes, not keysym. */
6404 register int i;
6405 register int c;
6406 int nchars, len;
6408 /* The input should be decoded with `coding_system'
6409 which depends on which X*LookupString function
6410 we used just above and the locale. */
6411 setup_coding_system (coding_system, &coding);
6412 coding.src_multibyte = 0;
6413 coding.dst_multibyte = 1;
6414 /* The input is converted to events, thus we can't
6415 handle composition. Anyway, there's no XIM that
6416 gives us composition information. */
6417 coding.composing = COMPOSITION_DISABLED;
6419 for (i = 0; i < nbytes; i++)
6421 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6425 /* Decode the input data. */
6426 int require;
6427 unsigned char *p;
6429 require = decoding_buffer_size (&coding, nbytes);
6430 p = (unsigned char *) alloca (require);
6431 coding.mode |= CODING_MODE_LAST_BLOCK;
6432 /* We explicitly disable composition handling because
6433 key data should not contain any composition sequence. */
6434 coding.composing = COMPOSITION_DISABLED;
6435 decode_coding (&coding, copy_bufptr, p, nbytes, require);
6436 nbytes = coding.produced;
6437 nchars = coding.produced_char;
6438 copy_bufptr = p;
6441 /* Convert the input data to a sequence of
6442 character events. */
6443 for (i = 0; i < nbytes; i += len)
6445 if (nchars == nbytes)
6446 c = copy_bufptr[i], len = 1;
6447 else
6448 c = STRING_CHAR_AND_LENGTH (copy_bufptr + i,
6449 nbytes - i, len);
6450 inev.ie.kind = (SINGLE_BYTE_CHAR_P (c)
6451 ? ASCII_KEYSTROKE_EVENT
6452 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6453 inev.ie.code = c;
6454 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6457 /* Previous code updated count by nchars rather than nbytes,
6458 but that seems bogus to me. ++kfs */
6459 count += nbytes;
6461 inev.ie.kind = NO_EVENT; /* Already stored above. */
6463 if (keysym == NoSymbol)
6464 break;
6467 done_keysym:
6468 #ifdef HAVE_X_I18N
6469 /* Don't dispatch this event since XtDispatchEvent calls
6470 XFilterEvent, and two calls in a row may freeze the
6471 client. */
6472 break;
6473 #else
6474 goto OTHER;
6475 #endif
6477 case KeyRelease:
6478 #ifdef HAVE_X_I18N
6479 /* Don't dispatch this event since XtDispatchEvent calls
6480 XFilterEvent, and two calls in a row may freeze the
6481 client. */
6482 break;
6483 #else
6484 goto OTHER;
6485 #endif
6487 case EnterNotify:
6488 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6490 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6492 if (f && x_mouse_click_focus_ignore_position)
6493 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6495 #if 0
6496 if (event.xcrossing.focus)
6498 /* Avoid nasty pop/raise loops. */
6499 if (f && (!(f->auto_raise)
6500 || !(f->auto_lower)
6501 || (event.xcrossing.time - enter_timestamp) > 500))
6503 x_new_focus_frame (dpyinfo, f);
6504 enter_timestamp = event.xcrossing.time;
6507 else if (f == dpyinfo->x_focus_frame)
6508 x_new_focus_frame (dpyinfo, 0);
6509 #endif
6511 /* EnterNotify counts as mouse movement,
6512 so update things that depend on mouse position. */
6513 if (f && !f->output_data.x->hourglass_p)
6514 note_mouse_movement (f, &event.xmotion);
6515 goto OTHER;
6517 case FocusIn:
6518 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6519 goto OTHER;
6521 case LeaveNotify:
6522 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6524 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6525 if (f)
6527 if (f == dpyinfo->mouse_face_mouse_frame)
6529 /* If we move outside the frame, then we're
6530 certainly no longer on any text in the frame. */
6531 clear_mouse_face (dpyinfo);
6532 dpyinfo->mouse_face_mouse_frame = 0;
6535 /* Generate a nil HELP_EVENT to cancel a help-echo.
6536 Do it only if there's something to cancel.
6537 Otherwise, the startup message is cleared when
6538 the mouse leaves the frame. */
6539 if (any_help_event_p)
6540 do_help = -1;
6542 goto OTHER;
6544 case FocusOut:
6545 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6546 goto OTHER;
6548 case MotionNotify:
6550 previous_help_echo_string = help_echo_string;
6551 help_echo_string = help_echo_object = help_echo_window = Qnil;
6552 help_echo_pos = -1;
6554 if (dpyinfo->grabbed && last_mouse_frame
6555 && FRAME_LIVE_P (last_mouse_frame))
6556 f = last_mouse_frame;
6557 else
6558 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6560 if (dpyinfo->mouse_face_hidden)
6562 dpyinfo->mouse_face_hidden = 0;
6563 clear_mouse_face (dpyinfo);
6566 if (f)
6569 /* Generate SELECT_WINDOW_EVENTs when needed. */
6570 if (mouse_autoselect_window)
6572 Lisp_Object window;
6574 window = window_from_coordinates (f,
6575 event.xmotion.x, event.xmotion.y,
6576 0, 0, 0, 0);
6578 /* Window will be selected only when it is not selected now and
6579 last mouse movement event was not in it. Minibuffer window
6580 will be selected iff it is active. */
6581 if (WINDOWP (window)
6582 && !EQ (window, last_window)
6583 && !EQ (window, selected_window))
6585 inev.ie.kind = SELECT_WINDOW_EVENT;
6586 inev.ie.frame_or_window = window;
6589 last_window=window;
6591 note_mouse_movement (f, &event.xmotion);
6593 else
6595 #ifndef USE_TOOLKIT_SCROLL_BARS
6596 struct scroll_bar *bar
6597 = x_window_to_scroll_bar (event.xmotion.display,
6598 event.xmotion.window);
6600 if (bar)
6601 x_scroll_bar_note_movement (bar, &event);
6602 #endif /* USE_TOOLKIT_SCROLL_BARS */
6604 /* If we move outside the frame, then we're
6605 certainly no longer on any text in the frame. */
6606 clear_mouse_face (dpyinfo);
6609 /* If the contents of the global variable help_echo_string
6610 has changed, generate a HELP_EVENT. */
6611 if (!NILP (help_echo_string)
6612 || !NILP (previous_help_echo_string))
6613 do_help = 1;
6614 goto OTHER;
6617 case ConfigureNotify:
6618 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6619 if (f)
6621 #ifndef USE_X_TOOLKIT
6622 #ifdef USE_GTK
6623 xg_resize_widgets (f, event.xconfigure.width,
6624 event.xconfigure.height);
6625 #else /* not USE_GTK */
6626 /* If there is a pending resize for fullscreen, don't
6627 do this one, the right one will come later.
6628 The toolkit version doesn't seem to need this, but we
6629 need to reset it below. */
6630 int dont_resize
6631 = ((f->want_fullscreen & FULLSCREEN_WAIT)
6632 && f->new_text_cols != 0);
6633 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6634 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6636 if (dont_resize)
6637 goto OTHER;
6639 /* In the toolkit version, change_frame_size
6640 is called by the code that handles resizing
6641 of the EmacsFrame widget. */
6643 /* Even if the number of character rows and columns has
6644 not changed, the font size may have changed, so we need
6645 to check the pixel dimensions as well. */
6646 if (columns != FRAME_COLS (f)
6647 || rows != FRAME_LINES (f)
6648 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6649 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6651 change_frame_size (f, rows, columns, 0, 1, 0);
6652 SET_FRAME_GARBAGED (f);
6653 cancel_mouse_face (f);
6655 #endif /* not USE_GTK */
6656 #endif
6658 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6659 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6661 #ifdef USE_GTK
6662 /* GTK creates windows but doesn't map them.
6663 Only get real positions and check fullscreen when mapped. */
6664 if (FRAME_GTK_OUTER_WIDGET (f)
6665 && GTK_WIDGET_MAPPED (FRAME_GTK_OUTER_WIDGET (f)))
6666 #endif
6668 /* What we have now is the position of Emacs's own window.
6669 Convert that to the position of the window manager window. */
6670 x_real_positions (f, &f->left_pos, &f->top_pos);
6672 x_check_expected_move (f);
6673 if (f->want_fullscreen & FULLSCREEN_WAIT)
6674 f->want_fullscreen &= ~(FULLSCREEN_WAIT|FULLSCREEN_BOTH);
6677 #ifdef HAVE_X_I18N
6678 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6679 xic_set_statusarea (f);
6680 #endif
6682 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
6684 /* Since the WM decorations come below top_pos now,
6685 we must put them below top_pos in the future. */
6686 f->win_gravity = NorthWestGravity;
6687 x_wm_set_size_hint (f, (long) 0, 0);
6690 goto OTHER;
6692 case ButtonRelease:
6693 case ButtonPress:
6695 /* If we decide we want to generate an event to be seen
6696 by the rest of Emacs, we put it here. */
6697 int tool_bar_p = 0;
6699 bzero (&compose_status, sizeof (compose_status));
6701 if (dpyinfo->grabbed
6702 && last_mouse_frame
6703 && FRAME_LIVE_P (last_mouse_frame))
6704 f = last_mouse_frame;
6705 else
6706 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6708 if (f)
6710 /* Is this in the tool-bar? */
6711 if (WINDOWP (f->tool_bar_window)
6712 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6714 Lisp_Object window;
6715 int x = event.xbutton.x;
6716 int y = event.xbutton.y;
6718 window = window_from_coordinates (f, x, y, 0, 0, 0, 1);
6719 if (EQ (window, f->tool_bar_window))
6721 if (event.xbutton.type == ButtonPress)
6722 handle_tool_bar_click (f, x, y, 1, 0);
6723 else
6724 handle_tool_bar_click (f, x, y, 0,
6725 x_x_to_emacs_modifiers (dpyinfo,
6726 event.xbutton.state));
6727 tool_bar_p = 1;
6731 if (!tool_bar_p)
6732 if (!dpyinfo->x_focus_frame
6733 || f == dpyinfo->x_focus_frame)
6735 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6736 if (! popup_activated ())
6737 #endif
6739 if (ignore_next_mouse_click_timeout)
6741 if (event.type == ButtonPress
6742 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6744 ignore_next_mouse_click_timeout = 0;
6745 construct_mouse_click (&inev.ie, &event, f);
6747 if (event.type == ButtonRelease)
6748 ignore_next_mouse_click_timeout = 0;
6750 else
6751 construct_mouse_click (&inev.ie, &event, f);
6755 else
6757 struct scroll_bar *bar
6758 = x_window_to_scroll_bar (event.xbutton.display,
6759 event.xbutton.window);
6761 #ifdef USE_TOOLKIT_SCROLL_BARS
6762 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6763 scroll bars. */
6764 if (bar && event.xbutton.state & ControlMask)
6766 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6767 *finish = X_EVENT_DROP;
6769 #else /* not USE_TOOLKIT_SCROLL_BARS */
6770 if (bar)
6771 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6772 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6775 if (event.type == ButtonPress)
6777 dpyinfo->grabbed |= (1 << event.xbutton.button);
6778 last_mouse_frame = f;
6779 /* Ignore any mouse motion that happened
6780 before this event; any subsequent mouse-movement
6781 Emacs events should reflect only motion after
6782 the ButtonPress. */
6783 if (f != 0)
6784 f->mouse_moved = 0;
6786 if (!tool_bar_p)
6787 last_tool_bar_item = -1;
6789 else
6790 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6792 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6793 f = x_menubar_window_to_frame (dpyinfo, event.xbutton.window);
6794 /* For a down-event in the menu bar,
6795 don't pass it to Xt right now.
6796 Instead, save it away
6797 and we will pass it to Xt from kbd_buffer_get_event.
6798 That way, we can run some Lisp code first. */
6799 if (
6800 #ifdef USE_GTK
6801 ! popup_activated ()
6803 #endif
6804 f && event.type == ButtonPress
6805 /* Verify the event is really within the menu bar
6806 and not just sent to it due to grabbing. */
6807 && event.xbutton.x >= 0
6808 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6809 && event.xbutton.y >= 0
6810 && event.xbutton.y < f->output_data.x->menubar_height
6811 && event.xbutton.same_screen)
6813 SET_SAVED_BUTTON_EVENT;
6814 XSETFRAME (last_mouse_press_frame, f);
6815 #ifdef USE_GTK
6816 *finish = X_EVENT_DROP;
6817 #endif
6819 else if (event.type == ButtonPress)
6821 last_mouse_press_frame = Qnil;
6822 goto OTHER;
6825 #ifdef USE_MOTIF /* This should do not harm for Lucid,
6826 but I am trying to be cautious. */
6827 else if (event.type == ButtonRelease)
6829 if (!NILP (last_mouse_press_frame))
6831 f = XFRAME (last_mouse_press_frame);
6832 if (f->output_data.x)
6833 SET_SAVED_BUTTON_EVENT;
6835 else
6836 goto OTHER;
6838 #endif /* USE_MOTIF */
6839 else
6840 goto OTHER;
6841 #endif /* USE_X_TOOLKIT || USE_GTK */
6843 break;
6845 case CirculateNotify:
6846 goto OTHER;
6848 case CirculateRequest:
6849 goto OTHER;
6851 case VisibilityNotify:
6852 goto OTHER;
6854 case MappingNotify:
6855 /* Someone has changed the keyboard mapping - update the
6856 local cache. */
6857 switch (event.xmapping.request)
6859 case MappingModifier:
6860 x_find_modifier_meanings (dpyinfo);
6861 /* This is meant to fall through. */
6862 case MappingKeyboard:
6863 XRefreshKeyboardMapping (&event.xmapping);
6865 goto OTHER;
6867 default:
6868 OTHER:
6869 #ifdef USE_X_TOOLKIT
6870 BLOCK_INPUT;
6871 if (*finish != X_EVENT_DROP)
6872 XtDispatchEvent (&event);
6873 UNBLOCK_INPUT;
6874 #endif /* USE_X_TOOLKIT */
6875 break;
6878 done:
6879 if (inev.ie.kind != NO_EVENT)
6881 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6882 count++;
6885 if (do_help
6886 && !(hold_quit && hold_quit->kind != NO_EVENT))
6888 Lisp_Object frame;
6890 if (f)
6891 XSETFRAME (frame, f);
6892 else
6893 frame = Qnil;
6895 if (do_help > 0)
6897 any_help_event_p = 1;
6898 gen_help_event (help_echo_string, frame, help_echo_window,
6899 help_echo_object, help_echo_pos);
6901 else
6903 help_echo_string = Qnil;
6904 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
6906 count++;
6909 *eventp = event;
6910 return count;
6914 /* Handles the XEvent EVENT on display DISPLAY.
6915 This is used for event loops outside the normal event handling,
6916 i.e. looping while a popup menu or a dialog is posted.
6918 Returns the value handle_one_xevent sets in the finish argument. */
6920 x_dispatch_event (event, display)
6921 XEvent *event;
6922 Display *display;
6924 struct x_display_info *dpyinfo;
6925 int finish = X_EVENT_NORMAL;
6927 dpyinfo = x_display_info_for_display (display);
6929 if (dpyinfo)
6930 handle_one_xevent (dpyinfo, event, &finish, 0);
6932 return finish;
6936 /* Read events coming from the X server.
6937 This routine is called by the SIGIO handler.
6938 We return as soon as there are no more events to be read.
6940 We return the number of characters stored into the buffer,
6941 thus pretending to be `read'.
6943 EXPECTED is nonzero if the caller knows input is available. */
6945 static int
6946 XTread_socket (sd, expected, hold_quit)
6947 register int sd;
6948 int expected;
6949 struct input_event *hold_quit;
6951 int count = 0;
6952 XEvent event;
6953 int event_found = 0;
6954 struct x_display_info *dpyinfo;
6956 if (interrupt_input_blocked)
6958 interrupt_input_pending = 1;
6959 return -1;
6962 interrupt_input_pending = 0;
6963 BLOCK_INPUT;
6965 /* So people can tell when we have read the available input. */
6966 input_signal_count++;
6968 ++handling_signal;
6970 /* Find the display we are supposed to read input for.
6971 It's the one communicating on descriptor SD. */
6972 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
6974 #if 0 /* This ought to be unnecessary; let's verify it. */
6975 #ifdef FIOSNBIO
6976 /* If available, Xlib uses FIOSNBIO to make the socket
6977 non-blocking, and then looks for EWOULDBLOCK. If O_NDELAY is set,
6978 FIOSNBIO is ignored, and instead of signaling EWOULDBLOCK,
6979 a read returns 0, which Xlib interprets as equivalent to EPIPE. */
6980 fcntl (dpyinfo->connection, F_SETFL, 0);
6981 #endif /* ! defined (FIOSNBIO) */
6982 #endif
6984 #if 0 /* This code can't be made to work, with multiple displays,
6985 and appears not to be used on any system any more.
6986 Also keyboard.c doesn't turn O_NDELAY on and off
6987 for X connections. */
6988 #ifndef SIGIO
6989 #ifndef HAVE_SELECT
6990 if (! (fcntl (dpyinfo->connection, F_GETFL, 0) & O_NDELAY))
6992 extern int read_alarm_should_throw;
6993 read_alarm_should_throw = 1;
6994 XPeekEvent (dpyinfo->display, &event);
6995 read_alarm_should_throw = 0;
6997 #endif /* HAVE_SELECT */
6998 #endif /* SIGIO */
6999 #endif
7001 /* For debugging, this gives a way to fake an I/O error. */
7002 if (dpyinfo == XTread_socket_fake_io_error)
7004 XTread_socket_fake_io_error = 0;
7005 x_io_error_quitter (dpyinfo->display);
7008 #ifdef HAVE_X_SM
7010 struct input_event inev;
7011 BLOCK_INPUT;
7012 /* We don't need to EVENT_INIT (inev) here, as
7013 x_session_check_input copies an entire input_event. */
7014 if (x_session_check_input (&inev))
7016 kbd_buffer_store_event_hold (&inev, hold_quit);
7017 count++;
7019 UNBLOCK_INPUT;
7021 #endif
7023 #ifndef USE_GTK
7024 while (XPending (dpyinfo->display))
7026 int finish;
7028 XNextEvent (dpyinfo->display, &event);
7030 #ifdef HAVE_X_I18N
7031 /* Filter events for the current X input method. */
7032 if (x_filter_event (dpyinfo, &event))
7033 break;
7034 #endif
7035 event_found = 1;
7037 count += handle_one_xevent (dpyinfo, &event, &finish, hold_quit);
7039 if (finish == X_EVENT_GOTO_OUT)
7040 goto out;
7042 #endif /* not USE_GTK */
7045 #ifdef USE_GTK
7047 /* For GTK we must use the GTK event loop. But XEvents gets passed
7048 to our filter function above, and then to the big event switch.
7049 We use a bunch of globals to communicate with our filter function,
7050 that is kind of ugly, but it works.
7052 There is no way to do one display at the time, GTK just does events
7053 from all displays. */
7055 while (gtk_events_pending ())
7057 current_count = count;
7058 current_hold_quit = hold_quit;
7060 gtk_main_iteration ();
7062 count = current_count;
7063 current_count = -1;
7064 current_hold_quit = 0;
7066 if (current_finish == X_EVENT_GOTO_OUT)
7067 break;
7069 #endif /* USE_GTK */
7071 out:;
7073 /* On some systems, an X bug causes Emacs to get no more events
7074 when the window is destroyed. Detect that. (1994.) */
7075 if (! event_found)
7077 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7078 One XNOOP in 100 loops will make Emacs terminate.
7079 B. Bretthauer, 1994 */
7080 x_noop_count++;
7081 if (x_noop_count >= 100)
7083 x_noop_count=0;
7085 if (next_noop_dpyinfo == 0)
7086 next_noop_dpyinfo = x_display_list;
7088 XNoOp (next_noop_dpyinfo->display);
7090 /* Each time we get here, cycle through the displays now open. */
7091 next_noop_dpyinfo = next_noop_dpyinfo->next;
7095 /* If the focus was just given to an auto-raising frame,
7096 raise it now. */
7097 /* ??? This ought to be able to handle more than one such frame. */
7098 if (pending_autoraise_frame)
7100 x_raise_frame (pending_autoraise_frame);
7101 pending_autoraise_frame = 0;
7104 --handling_signal;
7105 UNBLOCK_INPUT;
7107 return count;
7113 /***********************************************************************
7114 Text Cursor
7115 ***********************************************************************/
7117 /* Set clipping for output in glyph row ROW. W is the window in which
7118 we operate. GC is the graphics context to set clipping in.
7120 ROW may be a text row or, e.g., a mode line. Text rows must be
7121 clipped to the interior of the window dedicated to text display,
7122 mode lines must be clipped to the whole window. */
7124 static void
7125 x_clip_to_row (w, row, area, gc)
7126 struct window *w;
7127 struct glyph_row *row;
7128 int area;
7129 GC gc;
7131 struct frame *f = XFRAME (WINDOW_FRAME (w));
7132 XRectangle clip_rect;
7133 int window_x, window_y, window_width;
7135 window_box (w, area, &window_x, &window_y, &window_width, 0);
7137 clip_rect.x = window_x;
7138 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7139 clip_rect.y = max (clip_rect.y, window_y);
7140 clip_rect.width = window_width;
7141 clip_rect.height = row->visible_height;
7143 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7147 /* Draw a hollow box cursor on window W in glyph row ROW. */
7149 static void
7150 x_draw_hollow_cursor (w, row)
7151 struct window *w;
7152 struct glyph_row *row;
7154 struct frame *f = XFRAME (WINDOW_FRAME (w));
7155 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7156 Display *dpy = FRAME_X_DISPLAY (f);
7157 int x, y, wd, h;
7158 XGCValues xgcv;
7159 struct glyph *cursor_glyph;
7160 GC gc;
7162 /* Get the glyph the cursor is on. If we can't tell because
7163 the current matrix is invalid or such, give up. */
7164 cursor_glyph = get_phys_cursor_glyph (w);
7165 if (cursor_glyph == NULL)
7166 return;
7168 /* Compute frame-relative coordinates for phys cursor. */
7169 x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x);
7170 y = get_phys_cursor_geometry (w, row, cursor_glyph, &h);
7171 wd = w->phys_cursor_width;
7173 /* The foreground of cursor_gc is typically the same as the normal
7174 background color, which can cause the cursor box to be invisible. */
7175 xgcv.foreground = f->output_data.x->cursor_pixel;
7176 if (dpyinfo->scratch_cursor_gc)
7177 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7178 else
7179 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7180 GCForeground, &xgcv);
7181 gc = dpyinfo->scratch_cursor_gc;
7183 /* Set clipping, draw the rectangle, and reset clipping again. */
7184 x_clip_to_row (w, row, TEXT_AREA, gc);
7185 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h);
7186 XSetClipMask (dpy, gc, None);
7190 /* Draw a bar cursor on window W in glyph row ROW.
7192 Implementation note: One would like to draw a bar cursor with an
7193 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7194 Unfortunately, I didn't find a font yet that has this property set.
7195 --gerd. */
7197 static void
7198 x_draw_bar_cursor (w, row, width, kind)
7199 struct window *w;
7200 struct glyph_row *row;
7201 int width;
7202 enum text_cursor_kinds kind;
7204 struct frame *f = XFRAME (w->frame);
7205 struct glyph *cursor_glyph;
7207 /* If cursor is out of bounds, don't draw garbage. This can happen
7208 in mini-buffer windows when switching between echo area glyphs
7209 and mini-buffer. */
7210 cursor_glyph = get_phys_cursor_glyph (w);
7211 if (cursor_glyph == NULL)
7212 return;
7214 /* If on an image, draw like a normal cursor. That's usually better
7215 visible than drawing a bar, esp. if the image is large so that
7216 the bar might not be in the window. */
7217 if (cursor_glyph->type == IMAGE_GLYPH)
7219 struct glyph_row *row;
7220 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7221 draw_phys_cursor_glyph (w, row, DRAW_CURSOR);
7223 else
7225 Display *dpy = FRAME_X_DISPLAY (f);
7226 Window window = FRAME_X_WINDOW (f);
7227 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7228 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7229 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7230 XGCValues xgcv;
7232 /* If the glyph's background equals the color we normally draw
7233 the bar cursor in, the bar cursor in its normal color is
7234 invisible. Use the glyph's foreground color instead in this
7235 case, on the assumption that the glyph's colors are chosen so
7236 that the glyph is legible. */
7237 if (face->background == f->output_data.x->cursor_pixel)
7238 xgcv.background = xgcv.foreground = face->foreground;
7239 else
7240 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7241 xgcv.graphics_exposures = 0;
7243 if (gc)
7244 XChangeGC (dpy, gc, mask, &xgcv);
7245 else
7247 gc = XCreateGC (dpy, window, mask, &xgcv);
7248 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7251 if (width < 0)
7252 width = FRAME_CURSOR_WIDTH (f);
7253 width = min (cursor_glyph->pixel_width, width);
7255 w->phys_cursor_width = width;
7256 x_clip_to_row (w, row, TEXT_AREA, gc);
7258 if (kind == BAR_CURSOR)
7259 XFillRectangle (dpy, window, gc,
7260 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7261 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7262 width, row->height);
7263 else
7264 XFillRectangle (dpy, window, gc,
7265 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7266 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7267 row->height - width),
7268 cursor_glyph->pixel_width,
7269 width);
7271 XSetClipMask (dpy, gc, None);
7276 /* RIF: Define cursor CURSOR on frame F. */
7278 static void
7279 x_define_frame_cursor (f, cursor)
7280 struct frame *f;
7281 Cursor cursor;
7283 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7287 /* RIF: Clear area on frame F. */
7289 static void
7290 x_clear_frame_area (f, x, y, width, height)
7291 struct frame *f;
7292 int x, y, width, height;
7294 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7295 x, y, width, height, False);
7299 /* RIF: Draw cursor on window W. */
7301 static void
7302 x_draw_window_cursor (w, glyph_row, x, y, cursor_type, cursor_width, on_p, active_p)
7303 struct window *w;
7304 struct glyph_row *glyph_row;
7305 int x, y;
7306 int cursor_type, cursor_width;
7307 int on_p, active_p;
7309 struct frame *f = XFRAME (WINDOW_FRAME (w));
7311 if (on_p)
7313 w->phys_cursor_type = cursor_type;
7314 w->phys_cursor_on_p = 1;
7316 if (glyph_row->exact_window_width_line_p
7317 && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
7319 glyph_row->cursor_in_fringe_p = 1;
7320 draw_fringe_bitmap (w, glyph_row, 0);
7322 else
7323 switch (cursor_type)
7325 case HOLLOW_BOX_CURSOR:
7326 x_draw_hollow_cursor (w, glyph_row);
7327 break;
7329 case FILLED_BOX_CURSOR:
7330 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7331 break;
7333 case BAR_CURSOR:
7334 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7335 break;
7337 case HBAR_CURSOR:
7338 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7339 break;
7341 case NO_CURSOR:
7342 w->phys_cursor_width = 0;
7343 break;
7345 default:
7346 abort ();
7349 #ifdef HAVE_X_I18N
7350 if (w == XWINDOW (f->selected_window))
7351 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7352 xic_set_preeditarea (w, x, y);
7353 #endif
7356 #ifndef XFlush
7357 if (updating_frame != f)
7358 XFlush (FRAME_X_DISPLAY (f));
7359 #endif
7363 /* Icons. */
7365 /* Make the x-window of frame F use the gnu icon bitmap. */
7368 x_bitmap_icon (f, file)
7369 struct frame *f;
7370 Lisp_Object file;
7372 int bitmap_id;
7374 if (FRAME_X_WINDOW (f) == 0)
7375 return 1;
7377 /* Free up our existing icon bitmap and mask if any. */
7378 if (f->output_data.x->icon_bitmap > 0)
7379 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7380 f->output_data.x->icon_bitmap = 0;
7382 if (STRINGP (file))
7384 #ifdef USE_GTK
7385 /* Use gtk_window_set_icon_from_file () if available,
7386 It's not restricted to bitmaps */
7387 if (xg_set_icon (f, file))
7388 return 0;
7389 #endif /* USE_GTK */
7390 bitmap_id = x_create_bitmap_from_file (f, file);
7391 x_create_bitmap_mask (f, bitmap_id);
7393 else
7395 /* Create the GNU bitmap and mask if necessary. */
7396 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7398 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id
7399 = x_create_bitmap_from_data (f, gnu_bits,
7400 gnu_width, gnu_height);
7401 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7404 /* The first time we create the GNU bitmap and mask,
7405 this increments the ref-count one extra time.
7406 As a result, the GNU bitmap and mask are never freed.
7407 That way, we don't have to worry about allocating it again. */
7408 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7410 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7413 x_wm_set_icon_pixmap (f, bitmap_id);
7414 f->output_data.x->icon_bitmap = bitmap_id;
7416 return 0;
7420 /* Make the x-window of frame F use a rectangle with text.
7421 Use ICON_NAME as the text. */
7424 x_text_icon (f, icon_name)
7425 struct frame *f;
7426 char *icon_name;
7428 if (FRAME_X_WINDOW (f) == 0)
7429 return 1;
7431 #ifdef HAVE_X11R4
7433 XTextProperty text;
7434 text.value = (unsigned char *) icon_name;
7435 text.encoding = XA_STRING;
7436 text.format = 8;
7437 text.nitems = strlen (icon_name);
7438 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7440 #else /* not HAVE_X11R4 */
7441 XSetIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), icon_name);
7442 #endif /* not HAVE_X11R4 */
7444 if (f->output_data.x->icon_bitmap > 0)
7445 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7446 f->output_data.x->icon_bitmap = 0;
7447 x_wm_set_icon_pixmap (f, 0);
7449 return 0;
7452 #define X_ERROR_MESSAGE_SIZE 200
7454 /* If non-nil, this should be a string.
7455 It means catch X errors and store the error message in this string. */
7457 static Lisp_Object x_error_message_string;
7459 /* An X error handler which stores the error message in
7460 x_error_message_string. This is called from x_error_handler if
7461 x_catch_errors is in effect. */
7463 static void
7464 x_error_catcher (display, error)
7465 Display *display;
7466 XErrorEvent *error;
7468 XGetErrorText (display, error->error_code,
7469 SDATA (x_error_message_string),
7470 X_ERROR_MESSAGE_SIZE);
7473 /* Begin trapping X errors for display DPY. Actually we trap X errors
7474 for all displays, but DPY should be the display you are actually
7475 operating on.
7477 After calling this function, X protocol errors no longer cause
7478 Emacs to exit; instead, they are recorded in the string
7479 stored in x_error_message_string.
7481 Calling x_check_errors signals an Emacs error if an X error has
7482 occurred since the last call to x_catch_errors or x_check_errors.
7484 Calling x_uncatch_errors resumes the normal error handling. */
7486 void x_check_errors ();
7487 static Lisp_Object x_catch_errors_unwind ();
7490 x_catch_errors (dpy)
7491 Display *dpy;
7493 int count = SPECPDL_INDEX ();
7495 /* Make sure any errors from previous requests have been dealt with. */
7496 XSync (dpy, False);
7498 record_unwind_protect (x_catch_errors_unwind,
7499 Fcons (make_save_value (dpy, 0),
7500 x_error_message_string));
7502 x_error_message_string = make_uninit_string (X_ERROR_MESSAGE_SIZE);
7503 SSET (x_error_message_string, 0, 0);
7505 return count;
7508 /* Unbind the binding that we made to check for X errors. */
7510 static Lisp_Object
7511 x_catch_errors_unwind (old_val)
7512 Lisp_Object old_val;
7514 Lisp_Object first = XCAR (old_val);
7515 Display *dpy = XSAVE_VALUE (first)->pointer;
7517 /* The display may have been closed before this function is called.
7518 Check if it is still open before calling XSync. */
7519 if (x_display_info_for_display (dpy) != 0)
7521 BLOCK_INPUT;
7522 XSync (dpy, False);
7523 UNBLOCK_INPUT;
7526 x_error_message_string = XCDR (old_val);
7527 return Qnil;
7530 /* If any X protocol errors have arrived since the last call to
7531 x_catch_errors or x_check_errors, signal an Emacs error using
7532 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7534 void
7535 x_check_errors (dpy, format)
7536 Display *dpy;
7537 char *format;
7539 /* Make sure to catch any errors incurred so far. */
7540 XSync (dpy, False);
7542 if (SREF (x_error_message_string, 0))
7543 error (format, SDATA (x_error_message_string));
7546 /* Nonzero if we had any X protocol errors
7547 since we did x_catch_errors on DPY. */
7550 x_had_errors_p (dpy)
7551 Display *dpy;
7553 /* Make sure to catch any errors incurred so far. */
7554 XSync (dpy, False);
7556 return SREF (x_error_message_string, 0) != 0;
7559 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7561 void
7562 x_clear_errors (dpy)
7563 Display *dpy;
7565 SSET (x_error_message_string, 0, 0);
7568 /* Stop catching X protocol errors and let them make Emacs die.
7569 DPY should be the display that was passed to x_catch_errors.
7570 COUNT should be the value that was returned by
7571 the corresponding call to x_catch_errors. */
7573 void
7574 x_uncatch_errors (dpy, count)
7575 Display *dpy;
7576 int count;
7578 unbind_to (count, Qnil);
7581 #if 0
7582 static unsigned int x_wire_count;
7583 x_trace_wire ()
7585 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7587 #endif /* ! 0 */
7590 /* Handle SIGPIPE, which can happen when the connection to a server
7591 simply goes away. SIGPIPE is handled by x_connection_signal.
7592 Don't need to do anything, because the write which caused the
7593 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7594 which will do the appropriate cleanup for us. */
7596 static SIGTYPE
7597 x_connection_signal (signalnum) /* If we don't have an argument, */
7598 int signalnum; /* some compilers complain in signal calls. */
7600 #ifdef USG
7601 /* USG systems forget handlers when they are used;
7602 must reestablish each time */
7603 signal (signalnum, x_connection_signal);
7604 #endif /* USG */
7608 /************************************************************************
7609 Handling X errors
7610 ************************************************************************/
7612 /* Error message passed to x_connection_closed. */
7614 static char *error_msg;
7616 /* Function installed as fatal_error_signal_hook in
7617 x_connection_closed. Print the X error message, and exit normally,
7618 instead of dumping core when XtCloseDisplay fails. */
7620 static void
7621 x_fatal_error_signal ()
7623 fprintf (stderr, "%s\n", error_msg);
7624 exit (70);
7627 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7628 the text of an error message that lead to the connection loss. */
7630 static SIGTYPE
7631 x_connection_closed (dpy, error_message)
7632 Display *dpy;
7633 char *error_message;
7635 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7636 Lisp_Object frame, tail;
7637 int count;
7639 error_msg = (char *) alloca (strlen (error_message) + 1);
7640 strcpy (error_msg, error_message);
7641 handling_signal = 0;
7643 /* Prevent being called recursively because of an error condition
7644 below. Otherwise, we might end up with printing ``can't find per
7645 display information'' in the recursive call instead of printing
7646 the original message here. */
7647 count = x_catch_errors (dpy);
7649 /* We have to close the display to inform Xt that it doesn't
7650 exist anymore. If we don't, Xt will continue to wait for
7651 events from the display. As a consequence, a sequence of
7653 M-x make-frame-on-display RET :1 RET
7654 ...kill the new frame, so that we get an IO error...
7655 M-x make-frame-on-display RET :1 RET
7657 will indefinitely wait in Xt for events for display `:1', opened
7658 in the first class to make-frame-on-display.
7660 Closing the display is reported to lead to a bus error on
7661 OpenWindows in certain situations. I suspect that is a bug
7662 in OpenWindows. I don't know how to cicumvent it here. */
7664 #ifdef USE_X_TOOLKIT
7665 /* If DPYINFO is null, this means we didn't open the display
7666 in the first place, so don't try to close it. */
7667 if (dpyinfo)
7669 extern void (*fatal_error_signal_hook) P_ ((void));
7670 fatal_error_signal_hook = x_fatal_error_signal;
7671 XtCloseDisplay (dpy);
7672 fatal_error_signal_hook = NULL;
7674 #endif
7676 #ifdef USE_GTK
7677 if (dpyinfo)
7678 xg_display_close (dpyinfo->display);
7679 #endif
7681 /* Indicate that this display is dead. */
7682 if (dpyinfo)
7683 dpyinfo->display = 0;
7685 /* First delete frames whose mini-buffers are on frames
7686 that are on the dead display. */
7687 FOR_EACH_FRAME (tail, frame)
7689 Lisp_Object minibuf_frame;
7690 minibuf_frame
7691 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7692 if (FRAME_X_P (XFRAME (frame))
7693 && FRAME_X_P (XFRAME (minibuf_frame))
7694 && ! EQ (frame, minibuf_frame)
7695 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7696 Fdelete_frame (frame, Qt);
7699 /* Now delete all remaining frames on the dead display.
7700 We are now sure none of these is used as the mini-buffer
7701 for another frame that we need to delete. */
7702 FOR_EACH_FRAME (tail, frame)
7703 if (FRAME_X_P (XFRAME (frame))
7704 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7706 /* Set this to t so that Fdelete_frame won't get confused
7707 trying to find a replacement. */
7708 FRAME_KBOARD (XFRAME (frame))->Vdefault_minibuffer_frame = Qt;
7709 Fdelete_frame (frame, Qt);
7712 if (dpyinfo)
7713 x_delete_display (dpyinfo);
7715 x_uncatch_errors (dpy, count);
7717 if (x_display_list == 0)
7719 fprintf (stderr, "%s\n", error_msg);
7720 shut_down_emacs (0, 0, Qnil);
7721 exit (70);
7724 /* Ordinary stack unwind doesn't deal with these. */
7725 #ifdef SIGIO
7726 sigunblock (sigmask (SIGIO));
7727 #endif
7728 sigunblock (sigmask (SIGALRM));
7729 TOTALLY_UNBLOCK_INPUT;
7731 clear_waiting_for_input ();
7732 error ("%s", error_msg);
7735 /* We specifically use it before defining it, so that gcc doesn't inline it,
7736 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7737 static void x_error_quitter (Display *display, XErrorEvent *error);
7739 /* This is the first-level handler for X protocol errors.
7740 It calls x_error_quitter or x_error_catcher. */
7742 static int
7743 x_error_handler (display, error)
7744 Display *display;
7745 XErrorEvent *error;
7747 if (! NILP (x_error_message_string))
7748 x_error_catcher (display, error);
7749 else
7750 x_error_quitter (display, error);
7751 return 0;
7754 /* This is the usual handler for X protocol errors.
7755 It kills all frames on the display that we got the error for.
7756 If that was the only one, it prints an error message and kills Emacs. */
7758 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7760 #if __GNUC__ >= 3 /* On GCC 3.0 we might get a warning. */
7761 #define NO_INLINE __attribute__((noinline))
7762 #else
7763 #define NO_INLINE
7764 #endif
7766 /* Some versions of GNU/Linux define noinline in their headers. */
7768 #ifdef noinline
7769 #undef noinline
7770 #endif
7772 /* On older GCC versions, just putting x_error_quitter
7773 after x_error_handler prevents inlining into the former. */
7775 static void NO_INLINE
7776 x_error_quitter (display, error)
7777 Display *display;
7778 XErrorEvent *error;
7780 char buf[256], buf1[356];
7782 /* Note that there is no real way portable across R3/R4 to get the
7783 original error handler. */
7785 XGetErrorText (display, error->error_code, buf, sizeof (buf));
7786 sprintf (buf1, "X protocol error: %s on protocol request %d",
7787 buf, error->request_code);
7788 x_connection_closed (display, buf1);
7792 /* This is the handler for X IO errors, always.
7793 It kills all frames on the display that we lost touch with.
7794 If that was the only one, it prints an error message and kills Emacs. */
7796 static int
7797 x_io_error_quitter (display)
7798 Display *display;
7800 char buf[256];
7802 sprintf (buf, "Connection lost to X server `%s'", DisplayString (display));
7803 x_connection_closed (display, buf);
7804 return 0;
7807 /* Changing the font of the frame. */
7809 /* Give frame F the font named FONTNAME as its default font, and
7810 return the full name of that font. FONTNAME may be a wildcard
7811 pattern; in that case, we choose some font that fits the pattern.
7812 The return value shows which font we chose. */
7814 Lisp_Object
7815 x_new_font (f, fontname)
7816 struct frame *f;
7817 register char *fontname;
7819 struct font_info *fontp
7820 = FS_LOAD_FONT (f, 0, fontname, -1);
7822 if (!fontp)
7823 return Qnil;
7825 FRAME_FONT (f) = (XFontStruct *) (fontp->font);
7826 FRAME_BASELINE_OFFSET (f) = fontp->baseline_offset;
7827 FRAME_FONTSET (f) = -1;
7829 FRAME_COLUMN_WIDTH (f) = fontp->average_width;
7830 FRAME_SPACE_WIDTH (f) = fontp->space_width;
7831 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (FRAME_FONT (f));
7833 compute_fringe_widths (f, 1);
7835 /* Compute the scroll bar width in character columns. */
7836 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7838 int wid = FRAME_COLUMN_WIDTH (f);
7839 FRAME_CONFIG_SCROLL_BAR_COLS (f)
7840 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
7842 else
7844 int wid = FRAME_COLUMN_WIDTH (f);
7845 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7848 /* Now make the frame display the given font. */
7849 if (FRAME_X_WINDOW (f) != 0)
7851 XSetFont (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
7852 FRAME_FONT (f)->fid);
7853 XSetFont (FRAME_X_DISPLAY (f), f->output_data.x->reverse_gc,
7854 FRAME_FONT (f)->fid);
7855 XSetFont (FRAME_X_DISPLAY (f), f->output_data.x->cursor_gc,
7856 FRAME_FONT (f)->fid);
7858 /* Don't change the size of a tip frame; there's no point in
7859 doing it because it's done in Fx_show_tip, and it leads to
7860 problems because the tip frame has no widget. */
7861 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
7862 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7865 return build_string (fontp->full_name);
7868 /* Give frame F the fontset named FONTSETNAME as its default font, and
7869 return the full name of that fontset. FONTSETNAME may be a wildcard
7870 pattern; in that case, we choose some fontset that fits the pattern.
7871 The return value shows which fontset we chose. */
7873 Lisp_Object
7874 x_new_fontset (f, fontsetname)
7875 struct frame *f;
7876 char *fontsetname;
7878 int fontset = fs_query_fontset (build_string (fontsetname), 0);
7879 Lisp_Object result;
7881 if (fontset < 0)
7882 return Qnil;
7884 if (FRAME_FONTSET (f) == fontset)
7885 /* This fontset is already set in frame F. There's nothing more
7886 to do. */
7887 return fontset_name (fontset);
7889 result = x_new_font (f, (SDATA (fontset_ascii (fontset))));
7891 if (!STRINGP (result))
7892 /* Can't load ASCII font. */
7893 return Qnil;
7895 /* Since x_new_font doesn't update any fontset information, do it now. */
7896 FRAME_FONTSET (f) = fontset;
7898 #ifdef HAVE_X_I18N
7899 if (FRAME_XIC (f)
7900 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
7901 xic_set_xfontset (f, SDATA (fontset_ascii (fontset)));
7902 #endif
7904 return build_string (fontsetname);
7908 /***********************************************************************
7909 X Input Methods
7910 ***********************************************************************/
7912 #ifdef HAVE_X_I18N
7914 #ifdef HAVE_X11R6
7916 /* XIM destroy callback function, which is called whenever the
7917 connection to input method XIM dies. CLIENT_DATA contains a
7918 pointer to the x_display_info structure corresponding to XIM. */
7920 static void
7921 xim_destroy_callback (xim, client_data, call_data)
7922 XIM xim;
7923 XPointer client_data;
7924 XPointer call_data;
7926 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
7927 Lisp_Object frame, tail;
7929 BLOCK_INPUT;
7931 /* No need to call XDestroyIC.. */
7932 FOR_EACH_FRAME (tail, frame)
7934 struct frame *f = XFRAME (frame);
7935 if (FRAME_X_DISPLAY_INFO (f) == dpyinfo)
7937 FRAME_XIC (f) = NULL;
7938 xic_free_xfontset (f);
7942 /* No need to call XCloseIM. */
7943 dpyinfo->xim = NULL;
7944 XFree (dpyinfo->xim_styles);
7945 UNBLOCK_INPUT;
7948 #endif /* HAVE_X11R6 */
7950 #ifdef HAVE_X11R6
7951 /* This isn't prototyped in OSF 5.0 or 5.1a. */
7952 extern char *XSetIMValues P_ ((XIM, ...));
7953 #endif
7955 /* Open the connection to the XIM server on display DPYINFO.
7956 RESOURCE_NAME is the resource name Emacs uses. */
7958 static void
7959 xim_open_dpy (dpyinfo, resource_name)
7960 struct x_display_info *dpyinfo;
7961 char *resource_name;
7963 XIM xim;
7965 #ifdef HAVE_XIM
7966 if (use_xim)
7968 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
7969 EMACS_CLASS);
7970 dpyinfo->xim = xim;
7972 if (xim)
7974 #ifdef HAVE_X11R6
7975 XIMCallback destroy;
7976 #endif
7978 /* Get supported styles and XIM values. */
7979 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
7981 #ifdef HAVE_X11R6
7982 destroy.callback = xim_destroy_callback;
7983 destroy.client_data = (XPointer)dpyinfo;
7984 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
7985 #endif
7989 else
7990 #endif /* HAVE_XIM */
7991 dpyinfo->xim = NULL;
7995 #ifdef HAVE_X11R6_XIM
7997 struct xim_inst_t
7999 struct x_display_info *dpyinfo;
8000 char *resource_name;
8003 /* XIM instantiate callback function, which is called whenever an XIM
8004 server is available. DISPLAY is the display of the XIM.
8005 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8006 when the callback was registered. */
8008 static void
8009 xim_instantiate_callback (display, client_data, call_data)
8010 Display *display;
8011 XPointer client_data;
8012 XPointer call_data;
8014 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8015 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8017 /* We don't support multiple XIM connections. */
8018 if (dpyinfo->xim)
8019 return;
8021 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8023 /* Create XIC for the existing frames on the same display, as long
8024 as they have no XIC. */
8025 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8027 Lisp_Object tail, frame;
8029 BLOCK_INPUT;
8030 FOR_EACH_FRAME (tail, frame)
8032 struct frame *f = XFRAME (frame);
8034 if (FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8035 if (FRAME_XIC (f) == NULL)
8037 create_frame_xic (f);
8038 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8039 xic_set_statusarea (f);
8040 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8042 struct window *w = XWINDOW (f->selected_window);
8043 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8048 UNBLOCK_INPUT;
8052 #endif /* HAVE_X11R6_XIM */
8055 /* Open a connection to the XIM server on display DPYINFO.
8056 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8057 connection only at the first time. On X11R6, open the connection
8058 in the XIM instantiate callback function. */
8060 static void
8061 xim_initialize (dpyinfo, resource_name)
8062 struct x_display_info *dpyinfo;
8063 char *resource_name;
8065 #ifdef HAVE_XIM
8066 if (use_xim)
8068 #ifdef HAVE_X11R6_XIM
8069 struct xim_inst_t *xim_inst;
8070 int len;
8072 dpyinfo->xim = NULL;
8073 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
8074 xim_inst->dpyinfo = dpyinfo;
8075 len = strlen (resource_name);
8076 xim_inst->resource_name = (char *) xmalloc (len + 1);
8077 bcopy (resource_name, xim_inst->resource_name, len + 1);
8078 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8079 resource_name, EMACS_CLASS,
8080 xim_instantiate_callback,
8081 /* This is XPointer in XFree86
8082 but (XPointer *) on Tru64, at
8083 least, hence the configure test. */
8084 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8085 #else /* not HAVE_X11R6_XIM */
8086 dpyinfo->xim = NULL;
8087 xim_open_dpy (dpyinfo, resource_name);
8088 #endif /* not HAVE_X11R6_XIM */
8091 else
8092 #endif /* HAVE_XIM */
8093 dpyinfo->xim = NULL;
8097 /* Close the connection to the XIM server on display DPYINFO. */
8099 static void
8100 xim_close_dpy (dpyinfo)
8101 struct x_display_info *dpyinfo;
8103 #ifdef HAVE_XIM
8104 if (use_xim)
8106 #ifdef HAVE_X11R6_XIM
8107 if (dpyinfo->display)
8108 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8109 NULL, EMACS_CLASS,
8110 xim_instantiate_callback, NULL);
8111 #endif /* not HAVE_X11R6_XIM */
8112 if (dpyinfo->display)
8113 XCloseIM (dpyinfo->xim);
8114 dpyinfo->xim = NULL;
8115 XFree (dpyinfo->xim_styles);
8117 #endif /* HAVE_XIM */
8120 #endif /* not HAVE_X11R6_XIM */
8124 /* Calculate the absolute position in frame F
8125 from its current recorded position values and gravity. */
8127 void
8128 x_calc_absolute_position (f)
8129 struct frame *f;
8131 int win_x = 0, win_y = 0;
8132 int flags = f->size_hint_flags;
8134 /* We have nothing to do if the current position
8135 is already for the top-left corner. */
8136 if (! ((flags & XNegative) || (flags & YNegative)))
8137 return;
8139 /* Treat negative positions as relative to the leftmost bottommost
8140 position that fits on the screen. */
8141 if (flags & XNegative)
8142 f->left_pos = (FRAME_X_DISPLAY_INFO (f)->width
8143 - FRAME_PIXEL_WIDTH (f) + f->left_pos);
8146 int height = FRAME_PIXEL_HEIGHT (f);
8148 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8149 /* Something is fishy here. When using Motif, starting Emacs with
8150 `-g -0-0', the frame appears too low by a few pixels.
8152 This seems to be so because initially, while Emacs is starting,
8153 the column widget's height and the frame's pixel height are
8154 different. The column widget's height is the right one. In
8155 later invocations, when Emacs is up, the frame's pixel height
8156 is right, though.
8158 It's not obvious where the initial small difference comes from.
8159 2000-12-01, gerd. */
8161 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8162 #endif
8164 if (flags & YNegative)
8165 f->top_pos = (FRAME_X_DISPLAY_INFO (f)->height - height + f->top_pos);
8168 /* The left_pos and top_pos
8169 are now relative to the top and left screen edges,
8170 so the flags should correspond. */
8171 f->size_hint_flags &= ~ (XNegative | YNegative);
8174 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8175 to really change the position, and 0 when calling from
8176 x_make_frame_visible (in that case, XOFF and YOFF are the current
8177 position values). It is -1 when calling from x_set_frame_parameters,
8178 which means, do adjust for borders but don't change the gravity. */
8180 void
8181 x_set_offset (f, xoff, yoff, change_gravity)
8182 struct frame *f;
8183 register int xoff, yoff;
8184 int change_gravity;
8186 int modified_top, modified_left;
8188 if (change_gravity > 0)
8190 f->top_pos = yoff;
8191 f->left_pos = xoff;
8192 f->size_hint_flags &= ~ (XNegative | YNegative);
8193 if (xoff < 0)
8194 f->size_hint_flags |= XNegative;
8195 if (yoff < 0)
8196 f->size_hint_flags |= YNegative;
8197 f->win_gravity = NorthWestGravity;
8199 x_calc_absolute_position (f);
8201 BLOCK_INPUT;
8202 x_wm_set_size_hint (f, (long) 0, 0);
8204 modified_left = f->left_pos;
8205 modified_top = f->top_pos;
8207 if (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8209 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8210 than the WM decorations. So we use the calculated offset instead
8211 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8212 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8213 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8216 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8217 modified_left, modified_top);
8219 if (FRAME_VISIBLE_P (f)
8220 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN)
8222 FRAME_X_OUTPUT (f)->check_expected_move = 1;
8223 FRAME_X_OUTPUT (f)->expected_top = f->top_pos;
8224 FRAME_X_OUTPUT (f)->expected_left = f->left_pos;
8227 UNBLOCK_INPUT;
8230 /* Check if we need to resize the frame due to a fullscreen request.
8231 If so needed, resize the frame. */
8232 static void
8233 x_check_fullscreen (f)
8234 struct frame *f;
8236 if (f->want_fullscreen & FULLSCREEN_BOTH)
8238 int width, height, ign;
8240 x_real_positions (f, &f->left_pos, &f->top_pos);
8242 x_fullscreen_adjust (f, &width, &height, &ign, &ign);
8244 /* We do not need to move the window, it shall be taken care of
8245 when setting WM manager hints.
8246 If the frame is visible already, the position is checked by
8247 x_check_expected_move. */
8248 if (FRAME_COLS (f) != width || FRAME_LINES (f) != height)
8250 change_frame_size (f, height, width, 0, 1, 0);
8251 SET_FRAME_GARBAGED (f);
8252 cancel_mouse_face (f);
8254 /* Wait for the change of frame size to occur */
8255 f->want_fullscreen |= FULLSCREEN_WAIT;
8260 /* If frame parameters are set after the frame is mapped, we need to move
8261 the window.
8262 Some window managers moves the window to the right position, some
8263 moves the outer window manager window to the specified position.
8264 Here we check that we are in the right spot. If not, make a second
8265 move, assuming we are dealing with the second kind of window manager. */
8266 static void
8267 x_check_expected_move (f)
8268 struct frame *f;
8270 if (FRAME_X_OUTPUT (f)->check_expected_move)
8272 int expect_top = FRAME_X_OUTPUT (f)->expected_top;
8273 int expect_left = FRAME_X_OUTPUT (f)->expected_left;
8275 if (expect_top != f->top_pos || expect_left != f->left_pos)
8277 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8278 FRAME_X_OUTPUT (f)->move_offset_left = expect_left - f->left_pos;
8279 FRAME_X_OUTPUT (f)->move_offset_top = expect_top - f->top_pos;
8281 f->left_pos = expect_left;
8282 f->top_pos = expect_top;
8283 x_set_offset (f, expect_left, expect_top, 0);
8285 else if (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN)
8286 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8288 /* Just do this once */
8289 FRAME_X_OUTPUT (f)->check_expected_move = 0;
8294 /* Change the size of frame F's X window to COLS/ROWS in the case F
8295 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8296 top-left-corner window gravity for this size change and subsequent
8297 size changes. Otherwise we leave the window gravity unchanged. */
8299 static void
8300 x_set_window_size_1 (f, change_gravity, cols, rows)
8301 struct frame *f;
8302 int change_gravity;
8303 int cols, rows;
8305 int pixelwidth, pixelheight;
8307 check_frame_size (f, &rows, &cols);
8308 f->scroll_bar_actual_width
8309 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8311 : FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0
8312 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)
8313 : (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)));
8315 compute_fringe_widths (f, 0);
8317 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols);
8318 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows);
8320 f->win_gravity = NorthWestGravity;
8321 x_wm_set_size_hint (f, (long) 0, 0);
8323 XSync (FRAME_X_DISPLAY (f), False);
8324 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8325 pixelwidth, pixelheight);
8327 /* Now, strictly speaking, we can't be sure that this is accurate,
8328 but the window manager will get around to dealing with the size
8329 change request eventually, and we'll hear how it went when the
8330 ConfigureNotify event gets here.
8332 We could just not bother storing any of this information here,
8333 and let the ConfigureNotify event set everything up, but that
8334 might be kind of confusing to the Lisp code, since size changes
8335 wouldn't be reported in the frame parameters until some random
8336 point in the future when the ConfigureNotify event arrives.
8338 We pass 1 for DELAY since we can't run Lisp code inside of
8339 a BLOCK_INPUT. */
8340 change_frame_size (f, rows, cols, 0, 1, 0);
8341 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8342 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8344 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8345 receive in the ConfigureNotify event; if we get what we asked
8346 for, then the event won't cause the screen to become garbaged, so
8347 we have to make sure to do it here. */
8348 SET_FRAME_GARBAGED (f);
8350 XFlush (FRAME_X_DISPLAY (f));
8354 /* Call this to change the size of frame F's x-window.
8355 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8356 for this size change and subsequent size changes.
8357 Otherwise we leave the window gravity unchanged. */
8359 void
8360 x_set_window_size (f, change_gravity, cols, rows)
8361 struct frame *f;
8362 int change_gravity;
8363 int cols, rows;
8365 BLOCK_INPUT;
8367 #ifdef USE_GTK
8368 if (FRAME_GTK_WIDGET (f))
8369 xg_frame_set_char_size (f, cols, rows);
8370 else
8371 x_set_window_size_1 (f, change_gravity, cols, rows);
8372 #elif USE_X_TOOLKIT
8374 if (f->output_data.x->widget != NULL)
8376 /* The x and y position of the widget is clobbered by the
8377 call to XtSetValues within EmacsFrameSetCharSize.
8378 This is a real kludge, but I don't understand Xt so I can't
8379 figure out a correct fix. Can anyone else tell me? -- rms. */
8380 int xpos = f->output_data.x->widget->core.x;
8381 int ypos = f->output_data.x->widget->core.y;
8382 EmacsFrameSetCharSize (f->output_data.x->edit_widget, cols, rows);
8383 f->output_data.x->widget->core.x = xpos;
8384 f->output_data.x->widget->core.y = ypos;
8386 else
8387 x_set_window_size_1 (f, change_gravity, cols, rows);
8389 #else /* not USE_X_TOOLKIT */
8391 x_set_window_size_1 (f, change_gravity, cols, rows);
8393 #endif /* not USE_X_TOOLKIT */
8395 /* If cursor was outside the new size, mark it as off. */
8396 mark_window_cursors_off (XWINDOW (f->root_window));
8398 /* Clear out any recollection of where the mouse highlighting was,
8399 since it might be in a place that's outside the new frame size.
8400 Actually checking whether it is outside is a pain in the neck,
8401 so don't try--just let the highlighting be done afresh with new size. */
8402 cancel_mouse_face (f);
8404 UNBLOCK_INPUT;
8407 /* Mouse warping. */
8409 void
8410 x_set_mouse_position (f, x, y)
8411 struct frame *f;
8412 int x, y;
8414 int pix_x, pix_y;
8416 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8417 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8419 if (pix_x < 0) pix_x = 0;
8420 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8422 if (pix_y < 0) pix_y = 0;
8423 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8425 BLOCK_INPUT;
8427 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8428 0, 0, 0, 0, pix_x, pix_y);
8429 UNBLOCK_INPUT;
8432 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8434 void
8435 x_set_mouse_pixel_position (f, pix_x, pix_y)
8436 struct frame *f;
8437 int pix_x, pix_y;
8439 BLOCK_INPUT;
8441 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8442 0, 0, 0, 0, pix_x, pix_y);
8443 UNBLOCK_INPUT;
8446 /* focus shifting, raising and lowering. */
8448 void
8449 x_focus_on_frame (f)
8450 struct frame *f;
8452 #if 0 /* This proves to be unpleasant. */
8453 x_raise_frame (f);
8454 #endif
8455 #if 0
8456 /* I don't think that the ICCCM allows programs to do things like this
8457 without the interaction of the window manager. Whatever you end up
8458 doing with this code, do it to x_unfocus_frame too. */
8459 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8460 RevertToPointerRoot, CurrentTime);
8461 #endif /* ! 0 */
8464 void
8465 x_unfocus_frame (f)
8466 struct frame *f;
8468 #if 0
8469 /* Look at the remarks in x_focus_on_frame. */
8470 if (FRAME_X_DISPLAY_INFO (f)->x_focus_frame == f)
8471 XSetInputFocus (FRAME_X_DISPLAY (f), PointerRoot,
8472 RevertToPointerRoot, CurrentTime);
8473 #endif /* ! 0 */
8476 /* Raise frame F. */
8478 void
8479 x_raise_frame (f)
8480 struct frame *f;
8482 if (f->async_visible)
8484 BLOCK_INPUT;
8485 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8486 XFlush (FRAME_X_DISPLAY (f));
8487 UNBLOCK_INPUT;
8491 /* Lower frame F. */
8493 void
8494 x_lower_frame (f)
8495 struct frame *f;
8497 if (f->async_visible)
8499 BLOCK_INPUT;
8500 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8501 XFlush (FRAME_X_DISPLAY (f));
8502 UNBLOCK_INPUT;
8506 static void
8507 XTframe_raise_lower (f, raise_flag)
8508 FRAME_PTR f;
8509 int raise_flag;
8511 if (raise_flag)
8512 x_raise_frame (f);
8513 else
8514 x_lower_frame (f);
8517 /* Change of visibility. */
8519 /* This tries to wait until the frame is really visible.
8520 However, if the window manager asks the user where to position
8521 the frame, this will return before the user finishes doing that.
8522 The frame will not actually be visible at that time,
8523 but it will become visible later when the window manager
8524 finishes with it. */
8526 void
8527 x_make_frame_visible (f)
8528 struct frame *f;
8530 Lisp_Object type;
8531 int original_top, original_left;
8532 int retry_count = 2;
8534 retry:
8536 BLOCK_INPUT;
8538 type = x_icon_type (f);
8539 if (!NILP (type))
8540 x_bitmap_icon (f, type);
8542 if (! FRAME_VISIBLE_P (f))
8544 /* We test FRAME_GARBAGED_P here to make sure we don't
8545 call x_set_offset a second time
8546 if we get to x_make_frame_visible a second time
8547 before the window gets really visible. */
8548 if (! FRAME_ICONIFIED_P (f)
8549 && ! f->output_data.x->asked_for_visible)
8550 x_set_offset (f, f->left_pos, f->top_pos, 0);
8552 f->output_data.x->asked_for_visible = 1;
8554 if (! EQ (Vx_no_window_manager, Qt))
8555 x_wm_set_window_state (f, NormalState);
8556 #ifdef USE_X_TOOLKIT
8557 /* This was XtPopup, but that did nothing for an iconified frame. */
8558 XtMapWidget (f->output_data.x->widget);
8559 #else /* not USE_X_TOOLKIT */
8560 #ifdef USE_GTK
8561 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
8562 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
8563 #else
8564 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
8565 #endif /* not USE_GTK */
8566 #endif /* not USE_X_TOOLKIT */
8567 #if 0 /* This seems to bring back scroll bars in the wrong places
8568 if the window configuration has changed. They seem
8569 to come back ok without this. */
8570 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
8571 XMapSubwindows (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
8572 #endif
8575 XFlush (FRAME_X_DISPLAY (f));
8577 /* Synchronize to ensure Emacs knows the frame is visible
8578 before we do anything else. We do this loop with input not blocked
8579 so that incoming events are handled. */
8581 Lisp_Object frame;
8582 int count;
8583 /* This must be before UNBLOCK_INPUT
8584 since events that arrive in response to the actions above
8585 will set it when they are handled. */
8586 int previously_visible = f->output_data.x->has_been_visible;
8588 original_left = f->left_pos;
8589 original_top = f->top_pos;
8591 /* This must come after we set COUNT. */
8592 UNBLOCK_INPUT;
8594 /* We unblock here so that arriving X events are processed. */
8596 /* Now move the window back to where it was "supposed to be".
8597 But don't do it if the gravity is negative.
8598 When the gravity is negative, this uses a position
8599 that is 3 pixels too low. Perhaps that's really the border width.
8601 Don't do this if the window has never been visible before,
8602 because the window manager may choose the position
8603 and we don't want to override it. */
8605 if (! FRAME_VISIBLE_P (f) && ! FRAME_ICONIFIED_P (f)
8606 && f->win_gravity == NorthWestGravity
8607 && previously_visible)
8609 Drawable rootw;
8610 int x, y;
8611 unsigned int width, height, border, depth;
8613 BLOCK_INPUT;
8615 /* On some window managers (such as FVWM) moving an existing
8616 window, even to the same place, causes the window manager
8617 to introduce an offset. This can cause the window to move
8618 to an unexpected location. Check the geometry (a little
8619 slow here) and then verify that the window is in the right
8620 place. If the window is not in the right place, move it
8621 there, and take the potential window manager hit. */
8622 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8623 &rootw, &x, &y, &width, &height, &border, &depth);
8625 if (original_left != x || original_top != y)
8626 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8627 original_left, original_top);
8629 UNBLOCK_INPUT;
8632 XSETFRAME (frame, f);
8634 /* Wait until the frame is visible. Process X events until a
8635 MapNotify event has been seen, or until we think we won't get a
8636 MapNotify at all.. */
8637 for (count = input_signal_count + 10;
8638 input_signal_count < count && !FRAME_VISIBLE_P (f);)
8640 /* Force processing of queued events. */
8641 x_sync (f);
8643 /* Machines that do polling rather than SIGIO have been
8644 observed to go into a busy-wait here. So we'll fake an
8645 alarm signal to let the handler know that there's something
8646 to be read. We used to raise a real alarm, but it seems
8647 that the handler isn't always enabled here. This is
8648 probably a bug. */
8649 if (input_polling_used ())
8651 /* It could be confusing if a real alarm arrives while
8652 processing the fake one. Turn it off and let the
8653 handler reset it. */
8654 extern void poll_for_input_1 P_ ((void));
8655 int old_poll_suppress_count = poll_suppress_count;
8656 poll_suppress_count = 1;
8657 poll_for_input_1 ();
8658 poll_suppress_count = old_poll_suppress_count;
8661 /* See if a MapNotify event has been processed. */
8662 FRAME_SAMPLE_VISIBILITY (f);
8665 /* 2000-09-28: In
8667 (let ((f (selected-frame)))
8668 (iconify-frame f)
8669 (raise-frame f))
8671 the frame is not raised with various window managers on
8672 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
8673 unknown reason, the call to XtMapWidget is completely ignored.
8674 Mapping the widget a second time works. */
8676 if (!FRAME_VISIBLE_P (f) && --retry_count > 0)
8677 goto retry;
8681 /* Change from mapped state to withdrawn state. */
8683 /* Make the frame visible (mapped and not iconified). */
8685 void
8686 x_make_frame_invisible (f)
8687 struct frame *f;
8689 Window window;
8691 /* Use the frame's outermost window, not the one we normally draw on. */
8692 window = FRAME_OUTER_WINDOW (f);
8694 /* Don't keep the highlight on an invisible frame. */
8695 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
8696 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
8698 #if 0/* This might add unreliability; I don't trust it -- rms. */
8699 if (! f->async_visible && ! f->async_iconified)
8700 return;
8701 #endif
8703 BLOCK_INPUT;
8705 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
8706 that the current position of the window is user-specified, rather than
8707 program-specified, so that when the window is mapped again, it will be
8708 placed at the same location, without forcing the user to position it
8709 by hand again (they have already done that once for this window.) */
8710 x_wm_set_size_hint (f, (long) 0, 1);
8712 #ifdef USE_GTK
8713 if (FRAME_GTK_OUTER_WIDGET (f))
8714 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
8715 else
8716 #endif
8718 #ifdef HAVE_X11R4
8720 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
8721 DefaultScreen (FRAME_X_DISPLAY (f))))
8723 UNBLOCK_INPUT_RESIGNAL;
8724 error ("Can't notify window manager of window withdrawal");
8726 #else /* ! defined (HAVE_X11R4) */
8728 /* Tell the window manager what we're going to do. */
8729 if (! EQ (Vx_no_window_manager, Qt))
8731 XEvent unmap;
8733 unmap.xunmap.type = UnmapNotify;
8734 unmap.xunmap.window = window;
8735 unmap.xunmap.event = DefaultRootWindow (FRAME_X_DISPLAY (f));
8736 unmap.xunmap.from_configure = False;
8737 if (! XSendEvent (FRAME_X_DISPLAY (f),
8738 DefaultRootWindow (FRAME_X_DISPLAY (f)),
8739 False,
8740 SubstructureRedirectMaskSubstructureNotifyMask,
8741 &unmap))
8743 UNBLOCK_INPUT_RESIGNAL;
8744 error ("Can't notify window manager of withdrawal");
8748 /* Unmap the window ourselves. Cheeky! */
8749 XUnmapWindow (FRAME_X_DISPLAY (f), window);
8750 #endif /* ! defined (HAVE_X11R4) */
8753 /* We can't distinguish this from iconification
8754 just by the event that we get from the server.
8755 So we can't win using the usual strategy of letting
8756 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
8757 and synchronize with the server to make sure we agree. */
8758 f->visible = 0;
8759 FRAME_ICONIFIED_P (f) = 0;
8760 f->async_visible = 0;
8761 f->async_iconified = 0;
8763 x_sync (f);
8765 UNBLOCK_INPUT;
8768 /* Change window state from mapped to iconified. */
8770 void
8771 x_iconify_frame (f)
8772 struct frame *f;
8774 int result;
8775 Lisp_Object type;
8777 /* Don't keep the highlight on an invisible frame. */
8778 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
8779 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
8781 if (f->async_iconified)
8782 return;
8784 BLOCK_INPUT;
8786 FRAME_SAMPLE_VISIBILITY (f);
8788 type = x_icon_type (f);
8789 if (!NILP (type))
8790 x_bitmap_icon (f, type);
8792 #ifdef USE_GTK
8793 if (FRAME_GTK_OUTER_WIDGET (f))
8795 if (! FRAME_VISIBLE_P (f))
8796 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
8798 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
8799 f->iconified = 1;
8800 f->visible = 1;
8801 f->async_iconified = 1;
8802 f->async_visible = 0;
8803 UNBLOCK_INPUT;
8804 return;
8806 #endif
8808 #ifdef USE_X_TOOLKIT
8810 if (! FRAME_VISIBLE_P (f))
8812 if (! EQ (Vx_no_window_manager, Qt))
8813 x_wm_set_window_state (f, IconicState);
8814 /* This was XtPopup, but that did nothing for an iconified frame. */
8815 XtMapWidget (f->output_data.x->widget);
8816 /* The server won't give us any event to indicate
8817 that an invisible frame was changed to an icon,
8818 so we have to record it here. */
8819 f->iconified = 1;
8820 f->visible = 1;
8821 f->async_iconified = 1;
8822 f->async_visible = 0;
8823 UNBLOCK_INPUT;
8824 return;
8827 result = XIconifyWindow (FRAME_X_DISPLAY (f),
8828 XtWindow (f->output_data.x->widget),
8829 DefaultScreen (FRAME_X_DISPLAY (f)));
8830 UNBLOCK_INPUT;
8832 if (!result)
8833 error ("Can't notify window manager of iconification");
8835 f->async_iconified = 1;
8836 f->async_visible = 0;
8839 BLOCK_INPUT;
8840 XFlush (FRAME_X_DISPLAY (f));
8841 UNBLOCK_INPUT;
8842 #else /* not USE_X_TOOLKIT */
8844 /* Make sure the X server knows where the window should be positioned,
8845 in case the user deiconifies with the window manager. */
8846 if (! FRAME_VISIBLE_P (f) && !FRAME_ICONIFIED_P (f))
8847 x_set_offset (f, f->left_pos, f->top_pos, 0);
8849 /* Since we don't know which revision of X we're running, we'll use both
8850 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
8852 /* X11R4: send a ClientMessage to the window manager using the
8853 WM_CHANGE_STATE type. */
8855 XEvent message;
8857 message.xclient.window = FRAME_X_WINDOW (f);
8858 message.xclient.type = ClientMessage;
8859 message.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
8860 message.xclient.format = 32;
8861 message.xclient.data.l[0] = IconicState;
8863 if (! XSendEvent (FRAME_X_DISPLAY (f),
8864 DefaultRootWindow (FRAME_X_DISPLAY (f)),
8865 False,
8866 SubstructureRedirectMask | SubstructureNotifyMask,
8867 &message))
8869 UNBLOCK_INPUT_RESIGNAL;
8870 error ("Can't notify window manager of iconification");
8874 /* X11R3: set the initial_state field of the window manager hints to
8875 IconicState. */
8876 x_wm_set_window_state (f, IconicState);
8878 if (!FRAME_VISIBLE_P (f))
8880 /* If the frame was withdrawn, before, we must map it. */
8881 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
8884 f->async_iconified = 1;
8885 f->async_visible = 0;
8887 XFlush (FRAME_X_DISPLAY (f));
8888 UNBLOCK_INPUT;
8889 #endif /* not USE_X_TOOLKIT */
8893 /* Free X resources of frame F. */
8895 void
8896 x_free_frame_resources (f)
8897 struct frame *f;
8899 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8900 Lisp_Object bar;
8901 struct scroll_bar *b;
8903 BLOCK_INPUT;
8905 /* If a display connection is dead, don't try sending more
8906 commands to the X server. */
8907 if (dpyinfo->display)
8909 if (f->output_data.x->icon_desc)
8910 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
8912 #ifdef USE_X_TOOLKIT
8913 /* Explicitly destroy the scroll bars of the frame. Without
8914 this, we get "BadDrawable" errors from the toolkit later on,
8915 presumably from expose events generated for the disappearing
8916 toolkit scroll bars. */
8917 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
8919 b = XSCROLL_BAR (bar);
8920 x_scroll_bar_remove (b);
8922 #endif
8924 #ifdef HAVE_X_I18N
8925 if (FRAME_XIC (f))
8926 free_frame_xic (f);
8927 #endif
8929 #ifdef USE_X_TOOLKIT
8930 if (f->output_data.x->widget)
8932 XtDestroyWidget (f->output_data.x->widget);
8933 f->output_data.x->widget = NULL;
8935 /* Tooltips don't have widgets, only a simple X window, even if
8936 we are using a toolkit. */
8937 else if (FRAME_X_WINDOW (f))
8938 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
8940 free_frame_menubar (f);
8941 #else /* !USE_X_TOOLKIT */
8943 #ifdef USE_GTK
8944 /* In the GTK version, tooltips are normal X
8945 frames. We must check and free both types. */
8946 if (FRAME_GTK_OUTER_WIDGET (f))
8948 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
8949 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow below */
8950 FRAME_GTK_OUTER_WIDGET (f) = 0;
8952 #endif /* USE_GTK */
8954 if (FRAME_X_WINDOW (f))
8955 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
8956 #endif /* !USE_X_TOOLKIT */
8958 unload_color (f, f->output_data.x->foreground_pixel);
8959 unload_color (f, f->output_data.x->background_pixel);
8960 unload_color (f, f->output_data.x->cursor_pixel);
8961 unload_color (f, f->output_data.x->cursor_foreground_pixel);
8962 unload_color (f, f->output_data.x->border_pixel);
8963 unload_color (f, f->output_data.x->mouse_pixel);
8965 if (f->output_data.x->scroll_bar_background_pixel != -1)
8966 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
8967 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
8968 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
8969 #ifdef USE_TOOLKIT_SCROLL_BARS
8970 /* Scrollbar shadow colors. */
8971 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
8972 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
8973 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
8974 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
8975 #endif /* USE_TOOLKIT_SCROLL_BARS */
8976 if (f->output_data.x->white_relief.allocated_p)
8977 unload_color (f, f->output_data.x->white_relief.pixel);
8978 if (f->output_data.x->black_relief.allocated_p)
8979 unload_color (f, f->output_data.x->black_relief.pixel);
8981 if (FRAME_FACE_CACHE (f))
8982 free_frame_faces (f);
8984 x_free_gcs (f);
8985 XFlush (FRAME_X_DISPLAY (f));
8988 if (f->output_data.x->saved_menu_event)
8989 xfree (f->output_data.x->saved_menu_event);
8991 xfree (f->output_data.x);
8992 f->output_data.x = NULL;
8994 if (f == dpyinfo->x_focus_frame)
8995 dpyinfo->x_focus_frame = 0;
8996 if (f == dpyinfo->x_focus_event_frame)
8997 dpyinfo->x_focus_event_frame = 0;
8998 if (f == dpyinfo->x_highlight_frame)
8999 dpyinfo->x_highlight_frame = 0;
9001 if (f == dpyinfo->mouse_face_mouse_frame)
9003 dpyinfo->mouse_face_beg_row
9004 = dpyinfo->mouse_face_beg_col = -1;
9005 dpyinfo->mouse_face_end_row
9006 = dpyinfo->mouse_face_end_col = -1;
9007 dpyinfo->mouse_face_window = Qnil;
9008 dpyinfo->mouse_face_deferred_gc = 0;
9009 dpyinfo->mouse_face_mouse_frame = 0;
9012 UNBLOCK_INPUT;
9016 /* Destroy the X window of frame F. */
9018 void
9019 x_destroy_window (f)
9020 struct frame *f;
9022 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9024 /* If a display connection is dead, don't try sending more
9025 commands to the X server. */
9026 if (dpyinfo->display != 0)
9027 x_free_frame_resources (f);
9029 dpyinfo->reference_count--;
9033 /* Setting window manager hints. */
9035 /* Set the normal size hints for the window manager, for frame F.
9036 FLAGS is the flags word to use--or 0 meaning preserve the flags
9037 that the window now has.
9038 If USER_POSITION is nonzero, we set the USPosition
9039 flag (this is useful when FLAGS is 0).
9040 The GTK version is in gtkutils.c */
9042 #ifndef USE_GTK
9043 void
9044 x_wm_set_size_hint (f, flags, user_position)
9045 struct frame *f;
9046 long flags;
9047 int user_position;
9049 XSizeHints size_hints;
9051 #ifdef USE_X_TOOLKIT
9052 Arg al[2];
9053 int ac = 0;
9054 Dimension widget_width, widget_height;
9055 #endif
9057 Window window = FRAME_OUTER_WINDOW (f);
9059 /* Setting PMaxSize caused various problems. */
9060 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9062 size_hints.x = f->left_pos;
9063 size_hints.y = f->top_pos;
9065 #ifdef USE_X_TOOLKIT
9066 XtSetArg (al[ac], XtNwidth, &widget_width); ac++;
9067 XtSetArg (al[ac], XtNheight, &widget_height); ac++;
9068 XtGetValues (f->output_data.x->widget, al, ac);
9069 size_hints.height = widget_height;
9070 size_hints.width = widget_width;
9071 #else /* not USE_X_TOOLKIT */
9072 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9073 size_hints.width = FRAME_PIXEL_WIDTH (f);
9074 #endif /* not USE_X_TOOLKIT */
9076 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9077 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9078 size_hints.max_width
9079 = FRAME_X_DISPLAY_INFO (f)->width - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9080 size_hints.max_height
9081 = FRAME_X_DISPLAY_INFO (f)->height - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9083 /* Calculate the base and minimum sizes.
9085 (When we use the X toolkit, we don't do it here.
9086 Instead we copy the values that the widgets are using, below.) */
9087 #ifndef USE_X_TOOLKIT
9089 int base_width, base_height;
9090 int min_rows = 0, min_cols = 0;
9092 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9093 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9095 check_frame_size (f, &min_rows, &min_cols);
9097 /* The window manager uses the base width hints to calculate the
9098 current number of rows and columns in the frame while
9099 resizing; min_width and min_height aren't useful for this
9100 purpose, since they might not give the dimensions for a
9101 zero-row, zero-column frame.
9103 We use the base_width and base_height members if we have
9104 them; otherwise, we set the min_width and min_height members
9105 to the size for a zero x zero frame. */
9107 #ifdef HAVE_X11R4
9108 size_hints.flags |= PBaseSize;
9109 size_hints.base_width = base_width;
9110 size_hints.base_height = base_height;
9111 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9112 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9113 #else
9114 size_hints.min_width = base_width;
9115 size_hints.min_height = base_height;
9116 #endif
9119 /* If we don't need the old flags, we don't need the old hint at all. */
9120 if (flags)
9122 size_hints.flags |= flags;
9123 goto no_read;
9125 #endif /* not USE_X_TOOLKIT */
9128 XSizeHints hints; /* Sometimes I hate X Windows... */
9129 long supplied_return;
9130 int value;
9132 #ifdef HAVE_X11R4
9133 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9134 &supplied_return);
9135 #else
9136 value = XGetNormalHints (FRAME_X_DISPLAY (f), window, &hints);
9137 #endif
9139 #ifdef USE_X_TOOLKIT
9140 size_hints.base_height = hints.base_height;
9141 size_hints.base_width = hints.base_width;
9142 size_hints.min_height = hints.min_height;
9143 size_hints.min_width = hints.min_width;
9144 #endif
9146 if (flags)
9147 size_hints.flags |= flags;
9148 else
9150 if (value == 0)
9151 hints.flags = 0;
9152 if (hints.flags & PSize)
9153 size_hints.flags |= PSize;
9154 if (hints.flags & PPosition)
9155 size_hints.flags |= PPosition;
9156 if (hints.flags & USPosition)
9157 size_hints.flags |= USPosition;
9158 if (hints.flags & USSize)
9159 size_hints.flags |= USSize;
9163 #ifndef USE_X_TOOLKIT
9164 no_read:
9165 #endif
9167 #ifdef PWinGravity
9168 size_hints.win_gravity = f->win_gravity;
9169 size_hints.flags |= PWinGravity;
9171 if (user_position)
9173 size_hints.flags &= ~ PPosition;
9174 size_hints.flags |= USPosition;
9176 #endif /* PWinGravity */
9178 #ifdef HAVE_X11R4
9179 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9180 #else
9181 XSetNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9182 #endif
9184 #endif /* not USE_GTK */
9186 /* Used for IconicState or NormalState */
9188 void
9189 x_wm_set_window_state (f, state)
9190 struct frame *f;
9191 int state;
9193 #ifdef USE_X_TOOLKIT
9194 Arg al[1];
9196 XtSetArg (al[0], XtNinitialState, state);
9197 XtSetValues (f->output_data.x->widget, al, 1);
9198 #else /* not USE_X_TOOLKIT */
9199 Window window = FRAME_X_WINDOW (f);
9201 f->output_data.x->wm_hints.flags |= StateHint;
9202 f->output_data.x->wm_hints.initial_state = state;
9204 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9205 #endif /* not USE_X_TOOLKIT */
9208 void
9209 x_wm_set_icon_pixmap (f, pixmap_id)
9210 struct frame *f;
9211 int pixmap_id;
9213 Pixmap icon_pixmap, icon_mask;
9215 #ifndef USE_X_TOOLKIT
9216 Window window = FRAME_OUTER_WINDOW (f);
9217 #endif
9219 if (pixmap_id > 0)
9221 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9222 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9223 icon_mask = x_bitmap_mask (f, pixmap_id);
9224 f->output_data.x->wm_hints.icon_mask = icon_mask;
9226 else
9228 /* It seems there is no way to turn off use of an icon pixmap.
9229 The following line does it, only if no icon has yet been created,
9230 for some window managers. But with mwm it crashes.
9231 Some people say it should clear the IconPixmapHint bit in this case,
9232 but that doesn't work, and the X consortium said it isn't the
9233 right thing at all. Since there is no way to win,
9234 best to explicitly give up. */
9235 #if 0
9236 f->output_data.x->wm_hints.icon_pixmap = None;
9237 f->output_data.x->wm_hints.icon_mask = None;
9238 #else
9239 return;
9240 #endif
9243 #ifdef USE_X_TOOLKIT /* same as in x_wm_set_window_state. */
9246 Arg al[1];
9247 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9248 XtSetValues (f->output_data.x->widget, al, 1);
9249 XtSetArg (al[0], XtNiconMask, icon_mask);
9250 XtSetValues (f->output_data.x->widget, al, 1);
9253 #else /* not USE_X_TOOLKIT */
9255 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9256 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9258 #endif /* not USE_X_TOOLKIT */
9261 void
9262 x_wm_set_icon_position (f, icon_x, icon_y)
9263 struct frame *f;
9264 int icon_x, icon_y;
9266 Window window = FRAME_OUTER_WINDOW (f);
9268 f->output_data.x->wm_hints.flags |= IconPositionHint;
9269 f->output_data.x->wm_hints.icon_x = icon_x;
9270 f->output_data.x->wm_hints.icon_y = icon_y;
9272 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9276 /***********************************************************************
9277 Fonts
9278 ***********************************************************************/
9280 /* Return a pointer to struct font_info of font FONT_IDX of frame F. */
9282 struct font_info *
9283 x_get_font_info (f, font_idx)
9284 FRAME_PTR f;
9285 int font_idx;
9287 return (FRAME_X_FONT_TABLE (f) + font_idx);
9291 /* Return a list of names of available fonts matching PATTERN on frame F.
9293 If SIZE is > 0, it is the size (maximum bounds width) of fonts
9294 to be listed.
9296 SIZE < 0 means include scalable fonts.
9298 Frame F null means we have not yet created any frame on X, and
9299 consult the first display in x_display_list. MAXNAMES sets a limit
9300 on how many fonts to match. */
9302 Lisp_Object
9303 x_list_fonts (f, pattern, size, maxnames)
9304 struct frame *f;
9305 Lisp_Object pattern;
9306 int size;
9307 int maxnames;
9309 Lisp_Object list = Qnil, patterns, newlist = Qnil, key = Qnil;
9310 Lisp_Object tem, second_best;
9311 struct x_display_info *dpyinfo
9312 = f ? FRAME_X_DISPLAY_INFO (f) : x_display_list;
9313 Display *dpy = dpyinfo->display;
9314 int try_XLoadQueryFont = 0;
9315 int count;
9316 int allow_auto_scaled_font = 0;
9318 if (size < 0)
9320 allow_auto_scaled_font = 1;
9321 size = 0;
9324 patterns = Fassoc (pattern, Valternate_fontname_alist);
9325 if (NILP (patterns))
9326 patterns = Fcons (pattern, Qnil);
9328 if (maxnames == 1 && !size)
9329 /* We can return any single font matching PATTERN. */
9330 try_XLoadQueryFont = 1;
9332 for (; CONSP (patterns); patterns = XCDR (patterns))
9334 int num_fonts;
9335 char **names = NULL;
9337 pattern = XCAR (patterns);
9338 /* See if we cached the result for this particular query.
9339 The cache is an alist of the form:
9340 ((((PATTERN . MAXNAMES) . SCALABLE) (FONTNAME . WIDTH) ...) ...) */
9341 tem = XCDR (dpyinfo->name_list_element);
9342 key = Fcons (Fcons (pattern, make_number (maxnames)),
9343 allow_auto_scaled_font ? Qt : Qnil);
9344 list = Fassoc (key, tem);
9345 if (!NILP (list))
9347 list = Fcdr_safe (list);
9348 /* We have a cashed list. Don't have to get the list again. */
9349 goto label_cached;
9352 /* At first, put PATTERN in the cache. */
9354 BLOCK_INPUT;
9355 count = x_catch_errors (dpy);
9357 if (try_XLoadQueryFont)
9359 XFontStruct *font;
9360 unsigned long value;
9362 font = XLoadQueryFont (dpy, SDATA (pattern));
9363 if (x_had_errors_p (dpy))
9365 /* This error is perhaps due to insufficient memory on X
9366 server. Let's just ignore it. */
9367 font = NULL;
9368 x_clear_errors (dpy);
9371 if (font
9372 && XGetFontProperty (font, XA_FONT, &value))
9374 char *name = (char *) XGetAtomName (dpy, (Atom) value);
9375 int len = strlen (name);
9376 char *tmp;
9378 /* If DXPC (a Differential X Protocol Compressor)
9379 Ver.3.7 is running, XGetAtomName will return null
9380 string. We must avoid such a name. */
9381 if (len == 0)
9382 try_XLoadQueryFont = 0;
9383 else
9385 num_fonts = 1;
9386 names = (char **) alloca (sizeof (char *));
9387 /* Some systems only allow alloca assigned to a
9388 simple var. */
9389 tmp = (char *) alloca (len + 1); names[0] = tmp;
9390 bcopy (name, names[0], len + 1);
9391 XFree (name);
9394 else
9395 try_XLoadQueryFont = 0;
9397 if (font)
9398 XFreeFont (dpy, font);
9401 if (!try_XLoadQueryFont)
9403 /* We try at least 10 fonts because XListFonts will return
9404 auto-scaled fonts at the head. */
9405 if (maxnames < 0)
9407 int limit;
9409 for (limit = 500;;)
9411 names = XListFonts (dpy, SDATA (pattern), limit, &num_fonts);
9412 if (num_fonts == limit)
9414 BLOCK_INPUT;
9415 XFreeFontNames (names);
9416 UNBLOCK_INPUT;
9417 limit *= 2;
9419 else
9420 break;
9423 else
9424 names = XListFonts (dpy, SDATA (pattern), max (maxnames, 10),
9425 &num_fonts);
9427 if (x_had_errors_p (dpy))
9429 /* This error is perhaps due to insufficient memory on X
9430 server. Let's just ignore it. */
9431 names = NULL;
9432 x_clear_errors (dpy);
9436 x_uncatch_errors (dpy, count);
9437 UNBLOCK_INPUT;
9439 if (names)
9441 int i;
9443 /* Make a list of all the fonts we got back.
9444 Store that in the font cache for the display. */
9445 for (i = 0; i < num_fonts; i++)
9447 int width = 0;
9448 char *p = names[i];
9449 int average_width = -1, resx = 0, dashes = 0;
9451 /* Count the number of dashes in NAMES[I]. If there are
9452 14 dashes, the field value following 9th dash
9453 (RESOLUTION_X) is nonzero, and the field value
9454 following 12th dash (AVERAGE_WIDTH) is 0, this is a
9455 auto-scaled font which is usually too ugly to be used
9456 for editing. Let's ignore it. */
9457 while (*p)
9458 if (*p++ == '-')
9460 dashes++;
9461 if (dashes == 7) /* PIXEL_SIZE field */
9462 width = atoi (p);
9463 else if (dashes == 9)
9464 resx = atoi (p);
9465 else if (dashes == 12) /* AVERAGE_WIDTH field */
9466 average_width = atoi (p);
9469 if (allow_auto_scaled_font
9470 || dashes < 14 || average_width != 0 || resx == 0)
9472 tem = build_string (names[i]);
9473 if (NILP (Fassoc (tem, list)))
9475 if (STRINGP (Vx_pixel_size_width_font_regexp)
9476 && ((fast_c_string_match_ignore_case
9477 (Vx_pixel_size_width_font_regexp, names[i]))
9478 >= 0))
9479 /* We can set the value of PIXEL_SIZE to the
9480 width of this font. */
9481 list = Fcons (Fcons (tem, make_number (width)), list);
9482 else
9483 /* For the moment, width is not known. */
9484 list = Fcons (Fcons (tem, Qnil), list);
9489 if (!try_XLoadQueryFont)
9491 BLOCK_INPUT;
9492 XFreeFontNames (names);
9493 UNBLOCK_INPUT;
9497 /* Now store the result in the cache. */
9498 XSETCDR (dpyinfo->name_list_element,
9499 Fcons (Fcons (key, list), XCDR (dpyinfo->name_list_element)));
9501 label_cached:
9502 if (NILP (list)) continue; /* Try the remaining alternatives. */
9504 newlist = second_best = Qnil;
9505 /* Make a list of the fonts that have the right width. */
9506 for (; CONSP (list); list = XCDR (list))
9508 int found_size;
9510 tem = XCAR (list);
9512 if (!CONSP (tem) || NILP (XCAR (tem)))
9513 continue;
9514 if (!size)
9516 newlist = Fcons (XCAR (tem), newlist);
9517 continue;
9520 if (!INTEGERP (XCDR (tem)))
9522 /* Since we have not yet known the size of this font, we
9523 must try slow function call XLoadQueryFont. */
9524 XFontStruct *thisinfo;
9526 BLOCK_INPUT;
9527 count = x_catch_errors (dpy);
9528 thisinfo = XLoadQueryFont (dpy,
9529 SDATA (XCAR (tem)));
9530 if (x_had_errors_p (dpy))
9532 /* This error is perhaps due to insufficient memory on X
9533 server. Let's just ignore it. */
9534 thisinfo = NULL;
9535 x_clear_errors (dpy);
9537 x_uncatch_errors (dpy, count);
9538 UNBLOCK_INPUT;
9540 if (thisinfo)
9542 XSETCDR (tem,
9543 (thisinfo->min_bounds.width == 0
9544 ? make_number (0)
9545 : make_number (thisinfo->max_bounds.width)));
9546 BLOCK_INPUT;
9547 XFreeFont (dpy, thisinfo);
9548 UNBLOCK_INPUT;
9550 else
9551 /* For unknown reason, the previous call of XListFont had
9552 returned a font which can't be opened. Record the size
9553 as 0 not to try to open it again. */
9554 XSETCDR (tem, make_number (0));
9557 found_size = XINT (XCDR (tem));
9558 if (found_size == size)
9559 newlist = Fcons (XCAR (tem), newlist);
9560 else if (found_size > 0)
9562 if (NILP (second_best))
9563 second_best = tem;
9564 else if (found_size < size)
9566 if (XINT (XCDR (second_best)) > size
9567 || XINT (XCDR (second_best)) < found_size)
9568 second_best = tem;
9570 else
9572 if (XINT (XCDR (second_best)) > size
9573 && XINT (XCDR (second_best)) > found_size)
9574 second_best = tem;
9578 if (!NILP (newlist))
9579 break;
9580 else if (!NILP (second_best))
9582 newlist = Fcons (XCAR (second_best), Qnil);
9583 break;
9587 return newlist;
9591 #if GLYPH_DEBUG
9593 /* Check that FONT is valid on frame F. It is if it can be found in F's
9594 font table. */
9596 static void
9597 x_check_font (f, font)
9598 struct frame *f;
9599 XFontStruct *font;
9601 int i;
9602 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9604 xassert (font != NULL);
9606 for (i = 0; i < dpyinfo->n_fonts; i++)
9607 if (dpyinfo->font_table[i].name
9608 && font == dpyinfo->font_table[i].font)
9609 break;
9611 xassert (i < dpyinfo->n_fonts);
9614 #endif /* GLYPH_DEBUG != 0 */
9616 /* Set *W to the minimum width, *H to the minimum font height of FONT.
9617 Note: There are (broken) X fonts out there with invalid XFontStruct
9618 min_bounds contents. For example, handa@etl.go.jp reports that
9619 "-adobe-courier-medium-r-normal--*-180-*-*-m-*-iso8859-1" fonts
9620 have font->min_bounds.width == 0. */
9622 static INLINE void
9623 x_font_min_bounds (font, w, h)
9624 XFontStruct *font;
9625 int *w, *h;
9627 *h = FONT_HEIGHT (font);
9628 *w = font->min_bounds.width;
9630 /* Try to handle the case where FONT->min_bounds has invalid
9631 contents. Since the only font known to have invalid min_bounds
9632 is fixed-width, use max_bounds if min_bounds seems to be invalid. */
9633 if (*w <= 0)
9634 *w = font->max_bounds.width;
9638 /* Compute the smallest character width and smallest font height over
9639 all fonts available on frame F. Set the members smallest_char_width
9640 and smallest_font_height in F's x_display_info structure to
9641 the values computed. Value is non-zero if smallest_font_height or
9642 smallest_char_width become smaller than they were before. */
9644 static int
9645 x_compute_min_glyph_bounds (f)
9646 struct frame *f;
9648 int i;
9649 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9650 XFontStruct *font;
9651 int old_width = dpyinfo->smallest_char_width;
9652 int old_height = dpyinfo->smallest_font_height;
9654 dpyinfo->smallest_font_height = 100000;
9655 dpyinfo->smallest_char_width = 100000;
9657 for (i = 0; i < dpyinfo->n_fonts; ++i)
9658 if (dpyinfo->font_table[i].name)
9660 struct font_info *fontp = dpyinfo->font_table + i;
9661 int w, h;
9663 font = (XFontStruct *) fontp->font;
9664 xassert (font != (XFontStruct *) ~0);
9665 x_font_min_bounds (font, &w, &h);
9667 dpyinfo->smallest_font_height = min (dpyinfo->smallest_font_height, h);
9668 dpyinfo->smallest_char_width = min (dpyinfo->smallest_char_width, w);
9671 xassert (dpyinfo->smallest_char_width > 0
9672 && dpyinfo->smallest_font_height > 0);
9674 return (dpyinfo->n_fonts == 1
9675 || dpyinfo->smallest_char_width < old_width
9676 || dpyinfo->smallest_font_height < old_height);
9680 /* Load font named FONTNAME of the size SIZE for frame F, and return a
9681 pointer to the structure font_info while allocating it dynamically.
9682 If SIZE is 0, load any size of font.
9683 If loading is failed, return NULL. */
9685 struct font_info *
9686 x_load_font (f, fontname, size)
9687 struct frame *f;
9688 register char *fontname;
9689 int size;
9691 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9692 Lisp_Object font_names;
9693 int count;
9695 /* Get a list of all the fonts that match this name. Once we
9696 have a list of matching fonts, we compare them against the fonts
9697 we already have by comparing names. */
9698 font_names = x_list_fonts (f, build_string (fontname), size, 1);
9700 if (!NILP (font_names))
9702 Lisp_Object tail;
9703 int i;
9705 for (i = 0; i < dpyinfo->n_fonts; i++)
9706 for (tail = font_names; CONSP (tail); tail = XCDR (tail))
9707 if (dpyinfo->font_table[i].name
9708 && (!strcmp (dpyinfo->font_table[i].name,
9709 SDATA (XCAR (tail)))
9710 || !strcmp (dpyinfo->font_table[i].full_name,
9711 SDATA (XCAR (tail)))))
9712 return (dpyinfo->font_table + i);
9715 /* Load the font and add it to the table. */
9717 char *full_name;
9718 XFontStruct *font;
9719 struct font_info *fontp;
9720 unsigned long value;
9721 int i;
9723 /* If we have found fonts by x_list_font, load one of them. If
9724 not, we still try to load a font by the name given as FONTNAME
9725 because XListFonts (called in x_list_font) of some X server has
9726 a bug of not finding a font even if the font surely exists and
9727 is loadable by XLoadQueryFont. */
9728 if (size > 0 && !NILP (font_names))
9729 fontname = (char *) SDATA (XCAR (font_names));
9731 BLOCK_INPUT;
9732 count = x_catch_errors (FRAME_X_DISPLAY (f));
9733 font = (XFontStruct *) XLoadQueryFont (FRAME_X_DISPLAY (f), fontname);
9734 if (x_had_errors_p (FRAME_X_DISPLAY (f)))
9736 /* This error is perhaps due to insufficient memory on X
9737 server. Let's just ignore it. */
9738 font = NULL;
9739 x_clear_errors (FRAME_X_DISPLAY (f));
9741 x_uncatch_errors (FRAME_X_DISPLAY (f), count);
9742 UNBLOCK_INPUT;
9743 if (!font)
9744 return NULL;
9746 /* Find a free slot in the font table. */
9747 for (i = 0; i < dpyinfo->n_fonts; ++i)
9748 if (dpyinfo->font_table[i].name == NULL)
9749 break;
9751 /* If no free slot found, maybe enlarge the font table. */
9752 if (i == dpyinfo->n_fonts
9753 && dpyinfo->n_fonts == dpyinfo->font_table_size)
9755 int sz;
9756 dpyinfo->font_table_size = max (16, 2 * dpyinfo->font_table_size);
9757 sz = dpyinfo->font_table_size * sizeof *dpyinfo->font_table;
9758 dpyinfo->font_table
9759 = (struct font_info *) xrealloc (dpyinfo->font_table, sz);
9762 fontp = dpyinfo->font_table + i;
9763 if (i == dpyinfo->n_fonts)
9764 ++dpyinfo->n_fonts;
9766 /* Now fill in the slots of *FONTP. */
9767 BLOCK_INPUT;
9768 bzero (fontp, sizeof (*fontp));
9769 fontp->font = font;
9770 fontp->font_idx = i;
9771 fontp->name = (char *) xmalloc (strlen (fontname) + 1);
9772 bcopy (fontname, fontp->name, strlen (fontname) + 1);
9774 if (font->min_bounds.width == font->max_bounds.width)
9776 /* Fixed width font. */
9777 fontp->average_width = fontp->space_width = font->min_bounds.width;
9779 else
9781 XChar2b char2b;
9782 XCharStruct *pcm;
9784 char2b.byte1 = 0x00, char2b.byte2 = 0x20;
9785 pcm = x_per_char_metric (font, &char2b, 0);
9786 if (pcm)
9787 fontp->space_width = pcm->width;
9788 else
9789 fontp->space_width = FONT_WIDTH (font);
9791 fontp->average_width
9792 = (XGetFontProperty (font, dpyinfo->Xatom_AVERAGE_WIDTH, &value)
9793 ? (long) value / 10 : 0);
9794 if (fontp->average_width < 0)
9795 fontp->average_width = - fontp->average_width;
9796 if (fontp->average_width == 0)
9798 if (pcm)
9800 int width = pcm->width;
9801 for (char2b.byte2 = 33; char2b.byte2 <= 126; char2b.byte2++)
9802 if ((pcm = x_per_char_metric (font, &char2b, 0)) != NULL)
9803 width += pcm->width;
9804 fontp->average_width = width / 95;
9806 else
9807 fontp->average_width = FONT_WIDTH (font);
9811 /* Try to get the full name of FONT. Put it in FULL_NAME. */
9812 full_name = 0;
9813 if (XGetFontProperty (font, XA_FONT, &value))
9815 char *name = (char *) XGetAtomName (FRAME_X_DISPLAY (f), (Atom) value);
9816 char *p = name;
9817 int dashes = 0;
9819 /* Count the number of dashes in the "full name".
9820 If it is too few, this isn't really the font's full name,
9821 so don't use it.
9822 In X11R4, the fonts did not come with their canonical names
9823 stored in them. */
9824 while (*p)
9826 if (*p == '-')
9827 dashes++;
9828 p++;
9831 if (dashes >= 13)
9833 full_name = (char *) xmalloc (p - name + 1);
9834 bcopy (name, full_name, p - name + 1);
9837 XFree (name);
9840 if (full_name != 0)
9841 fontp->full_name = full_name;
9842 else
9843 fontp->full_name = fontp->name;
9845 fontp->size = font->max_bounds.width;
9846 fontp->height = FONT_HEIGHT (font);
9848 if (NILP (font_names))
9850 /* We come here because of a bug of XListFonts mentioned at
9851 the head of this block. Let's store this information in
9852 the cache for x_list_fonts. */
9853 Lisp_Object lispy_name = build_string (fontname);
9854 Lisp_Object lispy_full_name = build_string (fontp->full_name);
9855 Lisp_Object key = Fcons (Fcons (lispy_name, make_number (256)),
9856 Qnil);
9858 XSETCDR (dpyinfo->name_list_element,
9859 Fcons (Fcons (key,
9860 Fcons (Fcons (lispy_full_name,
9861 make_number (fontp->size)),
9862 Qnil)),
9863 XCDR (dpyinfo->name_list_element)));
9864 if (full_name)
9866 key = Fcons (Fcons (lispy_full_name, make_number (256)),
9867 Qnil);
9868 XSETCDR (dpyinfo->name_list_element,
9869 Fcons (Fcons (key,
9870 Fcons (Fcons (lispy_full_name,
9871 make_number (fontp->size)),
9872 Qnil)),
9873 XCDR (dpyinfo->name_list_element)));
9877 /* The slot `encoding' specifies how to map a character
9878 code-points (0x20..0x7F or 0x2020..0x7F7F) of each charset to
9879 the font code-points (0:0x20..0x7F, 1:0xA0..0xFF), or
9880 (0:0x2020..0x7F7F, 1:0xA0A0..0xFFFF, 3:0x20A0..0x7FFF,
9881 2:0xA020..0xFF7F). For the moment, we don't know which charset
9882 uses this font. So, we set information in fontp->encoding[1]
9883 which is never used by any charset. If mapping can't be
9884 decided, set FONT_ENCODING_NOT_DECIDED. */
9885 fontp->encoding[1]
9886 = (font->max_byte1 == 0
9887 /* 1-byte font */
9888 ? (font->min_char_or_byte2 < 0x80
9889 ? (font->max_char_or_byte2 < 0x80
9890 ? 0 /* 0x20..0x7F */
9891 : FONT_ENCODING_NOT_DECIDED) /* 0x20..0xFF */
9892 : 1) /* 0xA0..0xFF */
9893 /* 2-byte font */
9894 : (font->min_byte1 < 0x80
9895 ? (font->max_byte1 < 0x80
9896 ? (font->min_char_or_byte2 < 0x80
9897 ? (font->max_char_or_byte2 < 0x80
9898 ? 0 /* 0x2020..0x7F7F */
9899 : FONT_ENCODING_NOT_DECIDED) /* 0x2020..0x7FFF */
9900 : 3) /* 0x20A0..0x7FFF */
9901 : FONT_ENCODING_NOT_DECIDED) /* 0x20??..0xA0?? */
9902 : (font->min_char_or_byte2 < 0x80
9903 ? (font->max_char_or_byte2 < 0x80
9904 ? 2 /* 0xA020..0xFF7F */
9905 : FONT_ENCODING_NOT_DECIDED) /* 0xA020..0xFFFF */
9906 : 1))); /* 0xA0A0..0xFFFF */
9908 fontp->baseline_offset
9909 = (XGetFontProperty (font, dpyinfo->Xatom_MULE_BASELINE_OFFSET, &value)
9910 ? (long) value : 0);
9911 fontp->relative_compose
9912 = (XGetFontProperty (font, dpyinfo->Xatom_MULE_RELATIVE_COMPOSE, &value)
9913 ? (long) value : 0);
9914 fontp->default_ascent
9915 = (XGetFontProperty (font, dpyinfo->Xatom_MULE_DEFAULT_ASCENT, &value)
9916 ? (long) value : 0);
9918 /* Set global flag fonts_changed_p to non-zero if the font loaded
9919 has a character with a smaller width than any other character
9920 before, or if the font loaded has a smaller height than any
9921 other font loaded before. If this happens, it will make a
9922 glyph matrix reallocation necessary. */
9923 fonts_changed_p |= x_compute_min_glyph_bounds (f);
9924 UNBLOCK_INPUT;
9925 return fontp;
9930 /* Return a pointer to struct font_info of a font named FONTNAME for
9931 frame F. If no such font is loaded, return NULL. */
9933 struct font_info *
9934 x_query_font (f, fontname)
9935 struct frame *f;
9936 register char *fontname;
9938 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9939 int i;
9941 for (i = 0; i < dpyinfo->n_fonts; i++)
9942 if (dpyinfo->font_table[i].name
9943 && (!strcmp (dpyinfo->font_table[i].name, fontname)
9944 || !strcmp (dpyinfo->font_table[i].full_name, fontname)))
9945 return (dpyinfo->font_table + i);
9946 return NULL;
9950 /* Find a CCL program for a font specified by FONTP, and set the member
9951 `encoder' of the structure. */
9953 void
9954 x_find_ccl_program (fontp)
9955 struct font_info *fontp;
9957 Lisp_Object list, elt;
9959 elt = Qnil;
9960 for (list = Vfont_ccl_encoder_alist; CONSP (list); list = XCDR (list))
9962 elt = XCAR (list);
9963 if (CONSP (elt)
9964 && STRINGP (XCAR (elt))
9965 && ((fast_c_string_match_ignore_case (XCAR (elt), fontp->name)
9966 >= 0)
9967 || (fast_c_string_match_ignore_case (XCAR (elt), fontp->full_name)
9968 >= 0)))
9969 break;
9972 if (! NILP (list))
9974 struct ccl_program *ccl
9975 = (struct ccl_program *) xmalloc (sizeof (struct ccl_program));
9977 if (setup_ccl_program (ccl, XCDR (elt)) < 0)
9978 xfree (ccl);
9979 else
9980 fontp->font_encoder = ccl;
9986 /***********************************************************************
9987 Initialization
9988 ***********************************************************************/
9990 #ifdef USE_X_TOOLKIT
9991 static XrmOptionDescRec emacs_options[] = {
9992 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9993 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9995 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9996 XrmoptionSepArg, NULL},
9997 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9999 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
10000 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
10001 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
10002 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
10003 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
10004 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
10005 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
10007 #endif /* USE_X_TOOLKIT */
10009 static int x_initialized;
10011 #ifdef MULTI_KBOARD
10012 /* Test whether two display-name strings agree up to the dot that separates
10013 the screen number from the server number. */
10014 static int
10015 same_x_server (name1, name2)
10016 const char *name1, *name2;
10018 int seen_colon = 0;
10019 const unsigned char *system_name = SDATA (Vsystem_name);
10020 int system_name_length = strlen (system_name);
10021 int length_until_period = 0;
10023 while (system_name[length_until_period] != 0
10024 && system_name[length_until_period] != '.')
10025 length_until_period++;
10027 /* Treat `unix' like an empty host name. */
10028 if (! strncmp (name1, "unix:", 5))
10029 name1 += 4;
10030 if (! strncmp (name2, "unix:", 5))
10031 name2 += 4;
10032 /* Treat this host's name like an empty host name. */
10033 if (! strncmp (name1, system_name, system_name_length)
10034 && name1[system_name_length] == ':')
10035 name1 += system_name_length;
10036 if (! strncmp (name2, system_name, system_name_length)
10037 && name2[system_name_length] == ':')
10038 name2 += system_name_length;
10039 /* Treat this host's domainless name like an empty host name. */
10040 if (! strncmp (name1, system_name, length_until_period)
10041 && name1[length_until_period] == ':')
10042 name1 += length_until_period;
10043 if (! strncmp (name2, system_name, length_until_period)
10044 && name2[length_until_period] == ':')
10045 name2 += length_until_period;
10047 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
10049 if (*name1 == ':')
10050 seen_colon++;
10051 if (seen_colon && *name1 == '.')
10052 return 1;
10054 return (seen_colon
10055 && (*name1 == '.' || *name1 == '\0')
10056 && (*name2 == '.' || *name2 == '\0'));
10058 #endif
10060 /* Count number of set bits in mask and number of bits to shift to
10061 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
10062 to 5. */
10063 static void
10064 get_bits_and_offset (mask, bits, offset)
10065 unsigned long mask;
10066 int *bits;
10067 int *offset;
10069 int nr = 0;
10070 int off = 0;
10072 while (!(mask & 1))
10074 off++;
10075 mask >>= 1;
10078 while (mask & 1)
10080 nr++;
10081 mask >>= 1;
10084 *offset = off;
10085 *bits = nr;
10088 struct x_display_info *
10089 x_term_init (display_name, xrm_option, resource_name)
10090 Lisp_Object display_name;
10091 char *xrm_option;
10092 char *resource_name;
10094 int connection;
10095 Display *dpy;
10096 struct x_display_info *dpyinfo;
10097 XrmDatabase xrdb;
10099 BLOCK_INPUT;
10101 if (!x_initialized)
10103 x_initialize ();
10104 ++x_initialized;
10107 #ifdef USE_GTK
10109 #define NUM_ARGV 10
10110 int argc;
10111 char *argv[NUM_ARGV];
10112 char **argv2 = argv;
10113 GdkAtom atom;
10115 if (x_initialized++ > 1)
10117 /* Opening another display. If xg_display_open returns less
10118 than zero, we are probably on GTK 2.0, which can only handle
10119 one display. GTK 2.2 or later can handle more than one. */
10120 if (xg_display_open (SDATA (display_name), &dpy) < 0)
10121 error ("Sorry, this version of GTK can only handle one display");
10123 else
10125 for (argc = 0; argc < NUM_ARGV; ++argc)
10126 argv[argc] = 0;
10128 argc = 0;
10129 argv[argc++] = initial_argv[0];
10131 if (! NILP (display_name))
10133 argv[argc++] = "--display";
10134 argv[argc++] = SDATA (display_name);
10137 argv[argc++] = "--name";
10138 argv[argc++] = resource_name;
10140 #ifdef HAVE_X11R5
10141 XSetLocaleModifiers ("");
10142 #endif
10144 gtk_init (&argc, &argv2);
10146 /* gtk_init does set_locale. We must fix locale after calling it. */
10147 fixup_locale ();
10148 xg_initialize ();
10150 dpy = GDK_DISPLAY ();
10152 /* NULL window -> events for all windows go to our function */
10153 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
10155 /* Load our own gtkrc if it exists. */
10157 struct gcpro gcpro1, gcpro2;
10158 char *file = "~/.emacs.d/gtkrc";
10159 Lisp_Object s, abs_file;
10161 GCPRO2 (s, abs_file);
10162 s = make_string (file, strlen (file));
10163 abs_file = Fexpand_file_name (s, Qnil);
10165 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
10166 gtk_rc_parse (SDATA (abs_file));
10168 UNGCPRO;
10171 XSetErrorHandler (x_error_handler);
10172 XSetIOErrorHandler (x_io_error_quitter);
10175 #else /* not USE_GTK */
10176 #ifdef USE_X_TOOLKIT
10177 /* weiner@footloose.sps.mot.com reports that this causes
10178 errors with X11R5:
10179 X protocol error: BadAtom (invalid Atom parameter)
10180 on protocol request 18skiloaf.
10181 So let's not use it until R6. */
10182 #ifdef HAVE_X11XTR6
10183 XtSetLanguageProc (NULL, NULL, NULL);
10184 #endif
10187 int argc = 0;
10188 char *argv[3];
10190 argv[0] = "";
10191 argc = 1;
10192 if (xrm_option)
10194 argv[argc++] = "-xrm";
10195 argv[argc++] = xrm_option;
10197 turn_on_atimers (0);
10198 dpy = XtOpenDisplay (Xt_app_con, SDATA (display_name),
10199 resource_name, EMACS_CLASS,
10200 emacs_options, XtNumber (emacs_options),
10201 &argc, argv);
10202 turn_on_atimers (1);
10204 #ifdef HAVE_X11XTR6
10205 /* I think this is to compensate for XtSetLanguageProc. */
10206 fixup_locale ();
10207 #endif
10210 #else /* not USE_X_TOOLKIT */
10211 #ifdef HAVE_X11R5
10212 XSetLocaleModifiers ("");
10213 #endif
10214 dpy = XOpenDisplay (SDATA (display_name));
10215 #endif /* not USE_X_TOOLKIT */
10216 #endif /* not USE_GTK*/
10218 /* Detect failure. */
10219 if (dpy == 0)
10221 UNBLOCK_INPUT;
10222 return 0;
10225 /* We have definitely succeeded. Record the new connection. */
10227 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
10228 bzero (dpyinfo, sizeof *dpyinfo);
10230 #ifdef MULTI_KBOARD
10232 struct x_display_info *share;
10233 Lisp_Object tail;
10235 for (share = x_display_list, tail = x_display_name_list; share;
10236 share = share->next, tail = XCDR (tail))
10237 if (same_x_server (SDATA (XCAR (XCAR (tail))),
10238 SDATA (display_name)))
10239 break;
10240 if (share)
10241 dpyinfo->kboard = share->kboard;
10242 else
10244 dpyinfo->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
10245 init_kboard (dpyinfo->kboard);
10246 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10248 char *vendor = ServerVendor (dpy);
10249 UNBLOCK_INPUT;
10250 dpyinfo->kboard->Vsystem_key_alist
10251 = call1 (Qvendor_specific_keysyms,
10252 build_string (vendor ? vendor : ""));
10253 BLOCK_INPUT;
10256 dpyinfo->kboard->next_kboard = all_kboards;
10257 all_kboards = dpyinfo->kboard;
10258 /* Don't let the initial kboard remain current longer than necessary.
10259 That would cause problems if a file loaded on startup tries to
10260 prompt in the mini-buffer. */
10261 if (current_kboard == initial_kboard)
10262 current_kboard = dpyinfo->kboard;
10264 dpyinfo->kboard->reference_count++;
10266 #endif
10268 /* Put this display on the chain. */
10269 dpyinfo->next = x_display_list;
10270 x_display_list = dpyinfo;
10272 /* Put it on x_display_name_list as well, to keep them parallel. */
10273 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10274 x_display_name_list);
10275 dpyinfo->name_list_element = XCAR (x_display_name_list);
10277 dpyinfo->display = dpy;
10279 #if 0
10280 XSetAfterFunction (x_current_display, x_trace_wire);
10281 #endif /* ! 0 */
10283 dpyinfo->x_id_name
10284 = (char *) xmalloc (SBYTES (Vinvocation_name)
10285 + SBYTES (Vsystem_name)
10286 + 2);
10287 sprintf (dpyinfo->x_id_name, "%s@%s",
10288 SDATA (Vinvocation_name), SDATA (Vsystem_name));
10290 /* Figure out which modifier bits mean what. */
10291 x_find_modifier_meanings (dpyinfo);
10293 /* Get the scroll bar cursor. */
10294 #ifdef USE_GTK
10295 /* We must create a GTK cursor, it is required for GTK widgets. */
10296 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10297 #endif /* USE_GTK */
10299 dpyinfo->vertical_scroll_bar_cursor
10300 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10302 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10303 resource_name, EMACS_CLASS);
10304 #ifdef HAVE_XRMSETDATABASE
10305 XrmSetDatabase (dpyinfo->display, xrdb);
10306 #else
10307 dpyinfo->display->db = xrdb;
10308 #endif
10309 /* Put the rdb where we can find it in a way that works on
10310 all versions. */
10311 dpyinfo->xrdb = xrdb;
10313 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10314 DefaultScreen (dpyinfo->display));
10315 select_visual (dpyinfo);
10316 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10317 dpyinfo->height = HeightOfScreen (dpyinfo->screen);
10318 dpyinfo->width = WidthOfScreen (dpyinfo->screen);
10319 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10320 dpyinfo->client_leader_window = 0;
10321 dpyinfo->grabbed = 0;
10322 dpyinfo->reference_count = 0;
10323 dpyinfo->icon_bitmap_id = -1;
10324 dpyinfo->font_table = NULL;
10325 dpyinfo->n_fonts = 0;
10326 dpyinfo->font_table_size = 0;
10327 dpyinfo->bitmaps = 0;
10328 dpyinfo->bitmaps_size = 0;
10329 dpyinfo->bitmaps_last = 0;
10330 dpyinfo->scratch_cursor_gc = 0;
10331 dpyinfo->mouse_face_mouse_frame = 0;
10332 dpyinfo->mouse_face_deferred_gc = 0;
10333 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
10334 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
10335 dpyinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10336 dpyinfo->mouse_face_window = Qnil;
10337 dpyinfo->mouse_face_overlay = Qnil;
10338 dpyinfo->mouse_face_mouse_x = dpyinfo->mouse_face_mouse_y = 0;
10339 dpyinfo->mouse_face_defer = 0;
10340 dpyinfo->mouse_face_hidden = 0;
10341 dpyinfo->x_focus_frame = 0;
10342 dpyinfo->x_focus_event_frame = 0;
10343 dpyinfo->x_highlight_frame = 0;
10344 dpyinfo->image_cache = make_image_cache ();
10345 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10347 /* See if we can construct pixel values from RGB values. */
10348 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10349 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10351 if (dpyinfo->visual->class == TrueColor)
10353 get_bits_and_offset (dpyinfo->visual->red_mask,
10354 &dpyinfo->red_bits, &dpyinfo->red_offset);
10355 get_bits_and_offset (dpyinfo->visual->blue_mask,
10356 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10357 get_bits_and_offset (dpyinfo->visual->green_mask,
10358 &dpyinfo->green_bits, &dpyinfo->green_offset);
10361 /* See if a private colormap is requested. */
10362 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10364 if (dpyinfo->visual->class == PseudoColor)
10366 Lisp_Object value;
10367 value = display_x_get_resource (dpyinfo,
10368 build_string ("privateColormap"),
10369 build_string ("PrivateColormap"),
10370 Qnil, Qnil);
10371 if (STRINGP (value)
10372 && (!strcmp (SDATA (value), "true")
10373 || !strcmp (SDATA (value), "on")))
10374 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10377 else
10378 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10379 dpyinfo->visual, AllocNone);
10382 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10383 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10384 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10385 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10386 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10387 pixels = DisplayWidth (dpyinfo->display, screen_number);
10388 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10389 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10390 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10393 dpyinfo->Xatom_wm_protocols
10394 = XInternAtom (dpyinfo->display, "WM_PROTOCOLS", False);
10395 dpyinfo->Xatom_wm_take_focus
10396 = XInternAtom (dpyinfo->display, "WM_TAKE_FOCUS", False);
10397 dpyinfo->Xatom_wm_save_yourself
10398 = XInternAtom (dpyinfo->display, "WM_SAVE_YOURSELF", False);
10399 dpyinfo->Xatom_wm_delete_window
10400 = XInternAtom (dpyinfo->display, "WM_DELETE_WINDOW", False);
10401 dpyinfo->Xatom_wm_change_state
10402 = XInternAtom (dpyinfo->display, "WM_CHANGE_STATE", False);
10403 dpyinfo->Xatom_wm_configure_denied
10404 = XInternAtom (dpyinfo->display, "WM_CONFIGURE_DENIED", False);
10405 dpyinfo->Xatom_wm_window_moved
10406 = XInternAtom (dpyinfo->display, "WM_MOVED", False);
10407 dpyinfo->Xatom_wm_client_leader
10408 = XInternAtom (dpyinfo->display, "WM_CLIENT_LEADER", False);
10409 dpyinfo->Xatom_editres
10410 = XInternAtom (dpyinfo->display, "Editres", False);
10411 dpyinfo->Xatom_CLIPBOARD
10412 = XInternAtom (dpyinfo->display, "CLIPBOARD", False);
10413 dpyinfo->Xatom_TIMESTAMP
10414 = XInternAtom (dpyinfo->display, "TIMESTAMP", False);
10415 dpyinfo->Xatom_TEXT
10416 = XInternAtom (dpyinfo->display, "TEXT", False);
10417 dpyinfo->Xatom_COMPOUND_TEXT
10418 = XInternAtom (dpyinfo->display, "COMPOUND_TEXT", False);
10419 dpyinfo->Xatom_UTF8_STRING
10420 = XInternAtom (dpyinfo->display, "UTF8_STRING", False);
10421 dpyinfo->Xatom_DELETE
10422 = XInternAtom (dpyinfo->display, "DELETE", False);
10423 dpyinfo->Xatom_MULTIPLE
10424 = XInternAtom (dpyinfo->display, "MULTIPLE", False);
10425 dpyinfo->Xatom_INCR
10426 = XInternAtom (dpyinfo->display, "INCR", False);
10427 dpyinfo->Xatom_EMACS_TMP
10428 = XInternAtom (dpyinfo->display, "_EMACS_TMP_", False);
10429 dpyinfo->Xatom_TARGETS
10430 = XInternAtom (dpyinfo->display, "TARGETS", False);
10431 dpyinfo->Xatom_NULL
10432 = XInternAtom (dpyinfo->display, "NULL", False);
10433 dpyinfo->Xatom_ATOM_PAIR
10434 = XInternAtom (dpyinfo->display, "ATOM_PAIR", False);
10435 /* For properties of font. */
10436 dpyinfo->Xatom_PIXEL_SIZE
10437 = XInternAtom (dpyinfo->display, "PIXEL_SIZE", False);
10438 dpyinfo->Xatom_AVERAGE_WIDTH
10439 = XInternAtom (dpyinfo->display, "AVERAGE_WIDTH", False);
10440 dpyinfo->Xatom_MULE_BASELINE_OFFSET
10441 = XInternAtom (dpyinfo->display, "_MULE_BASELINE_OFFSET", False);
10442 dpyinfo->Xatom_MULE_RELATIVE_COMPOSE
10443 = XInternAtom (dpyinfo->display, "_MULE_RELATIVE_COMPOSE", False);
10444 dpyinfo->Xatom_MULE_DEFAULT_ASCENT
10445 = XInternAtom (dpyinfo->display, "_MULE_DEFAULT_ASCENT", False);
10447 /* Ghostscript support. */
10448 dpyinfo->Xatom_PAGE = XInternAtom (dpyinfo->display, "PAGE", False);
10449 dpyinfo->Xatom_DONE = XInternAtom (dpyinfo->display, "DONE", False);
10451 dpyinfo->Xatom_Scrollbar = XInternAtom (dpyinfo->display, "SCROLLBAR",
10452 False);
10454 dpyinfo->cut_buffers_initialized = 0;
10456 connection = ConnectionNumber (dpyinfo->display);
10457 dpyinfo->connection = connection;
10460 char null_bits[1];
10462 null_bits[0] = 0x00;
10464 dpyinfo->null_pixel
10465 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10466 null_bits, 1, 1, (long) 0, (long) 0,
10471 extern int gray_bitmap_width, gray_bitmap_height;
10472 extern char *gray_bitmap_bits;
10473 dpyinfo->gray
10474 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10475 gray_bitmap_bits,
10476 gray_bitmap_width, gray_bitmap_height,
10477 (unsigned long) 1, (unsigned long) 0, 1);
10480 #ifdef HAVE_X_I18N
10481 xim_initialize (dpyinfo, resource_name);
10482 #endif
10484 #ifdef subprocesses
10485 /* This is only needed for distinguishing keyboard and process input. */
10486 if (connection != 0)
10487 add_keyboard_wait_descriptor (connection);
10488 #endif
10490 #ifndef F_SETOWN_BUG
10491 #ifdef F_SETOWN
10492 #ifdef F_SETOWN_SOCK_NEG
10493 /* stdin is a socket here */
10494 fcntl (connection, F_SETOWN, -getpid ());
10495 #else /* ! defined (F_SETOWN_SOCK_NEG) */
10496 fcntl (connection, F_SETOWN, getpid ());
10497 #endif /* ! defined (F_SETOWN_SOCK_NEG) */
10498 #endif /* ! defined (F_SETOWN) */
10499 #endif /* F_SETOWN_BUG */
10501 #ifdef SIGIO
10502 if (interrupt_input)
10503 init_sigio (connection);
10504 #endif /* ! defined (SIGIO) */
10506 #ifdef USE_LUCID
10507 #ifdef HAVE_X11R5 /* It seems X11R4 lacks XtCvtStringToFont, and XPointer. */
10508 /* Make sure that we have a valid font for dialog boxes
10509 so that Xt does not crash. */
10511 Display *dpy = dpyinfo->display;
10512 XrmValue d, fr, to;
10513 Font font;
10514 int count;
10516 d.addr = (XPointer)&dpy;
10517 d.size = sizeof (Display *);
10518 fr.addr = XtDefaultFont;
10519 fr.size = sizeof (XtDefaultFont);
10520 to.size = sizeof (Font *);
10521 to.addr = (XPointer)&font;
10522 count = x_catch_errors (dpy);
10523 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10524 abort ();
10525 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10526 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10527 x_uncatch_errors (dpy, count);
10529 #endif
10530 #endif
10532 /* See if we should run in synchronous mode. This is useful
10533 for debugging X code. */
10535 Lisp_Object value;
10536 value = display_x_get_resource (dpyinfo,
10537 build_string ("synchronous"),
10538 build_string ("Synchronous"),
10539 Qnil, Qnil);
10540 if (STRINGP (value)
10541 && (!strcmp (SDATA (value), "true")
10542 || !strcmp (SDATA (value), "on")))
10543 XSynchronize (dpyinfo->display, True);
10547 Lisp_Object value;
10548 value = display_x_get_resource (dpyinfo,
10549 build_string ("useXIM"),
10550 build_string ("UseXIM"),
10551 Qnil, Qnil);
10552 #ifdef USE_XIM
10553 if (STRINGP (value)
10554 && (!strcmp (XSTRING (value)->data, "false")
10555 || !strcmp (XSTRING (value)->data, "off")))
10556 use_xim = 0;
10557 #else
10558 if (STRINGP (value)
10559 && (!strcmp (XSTRING (value)->data, "true")
10560 || !strcmp (XSTRING (value)->data, "on")))
10561 use_xim = 1;
10562 #endif
10565 #ifdef HAVE_X_SM
10566 /* Only do this for the first display. */
10567 if (x_initialized == 1)
10568 x_session_initialize (dpyinfo);
10569 #endif
10571 UNBLOCK_INPUT;
10573 return dpyinfo;
10576 /* Get rid of display DPYINFO, assuming all frames are already gone,
10577 and without sending any more commands to the X server. */
10579 void
10580 x_delete_display (dpyinfo)
10581 struct x_display_info *dpyinfo;
10583 int i;
10585 delete_keyboard_wait_descriptor (dpyinfo->connection);
10587 /* Discard this display from x_display_name_list and x_display_list.
10588 We can't use Fdelq because that can quit. */
10589 if (! NILP (x_display_name_list)
10590 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10591 x_display_name_list = XCDR (x_display_name_list);
10592 else
10594 Lisp_Object tail;
10596 tail = x_display_name_list;
10597 while (CONSP (tail) && CONSP (XCDR (tail)))
10599 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10601 XSETCDR (tail, XCDR (XCDR (tail)));
10602 break;
10604 tail = XCDR (tail);
10608 if (next_noop_dpyinfo == dpyinfo)
10609 next_noop_dpyinfo = dpyinfo->next;
10611 if (x_display_list == dpyinfo)
10612 x_display_list = dpyinfo->next;
10613 else
10615 struct x_display_info *tail;
10617 for (tail = x_display_list; tail; tail = tail->next)
10618 if (tail->next == dpyinfo)
10619 tail->next = tail->next->next;
10622 #ifndef USE_X_TOOLKIT /* I'm told Xt does this itself. */
10623 #ifndef AIX /* On AIX, XCloseDisplay calls this. */
10624 XrmDestroyDatabase (dpyinfo->xrdb);
10625 #endif
10626 #endif
10627 #ifdef MULTI_KBOARD
10628 if (--dpyinfo->kboard->reference_count == 0)
10629 delete_kboard (dpyinfo->kboard);
10630 #endif
10631 #ifdef HAVE_X_I18N
10632 if (dpyinfo->xim)
10633 xim_close_dpy (dpyinfo);
10634 #endif
10636 /* Free the font names in the font table. */
10637 for (i = 0; i < dpyinfo->n_fonts; i++)
10638 if (dpyinfo->font_table[i].name)
10640 if (dpyinfo->font_table[i].name != dpyinfo->font_table[i].full_name)
10641 xfree (dpyinfo->font_table[i].full_name);
10642 xfree (dpyinfo->font_table[i].name);
10645 if (dpyinfo->font_table->font_encoder)
10646 xfree (dpyinfo->font_table->font_encoder);
10648 xfree (dpyinfo->font_table);
10649 xfree (dpyinfo->x_id_name);
10650 xfree (dpyinfo->color_cells);
10651 xfree (dpyinfo);
10654 #ifdef USE_X_TOOLKIT
10656 /* Atimer callback function for TIMER. Called every 0.1s to process
10657 Xt timeouts, if needed. We must avoid calling XtAppPending as
10658 much as possible because that function does an implicit XFlush
10659 that slows us down. */
10661 static void
10662 x_process_timeouts (timer)
10663 struct atimer *timer;
10665 if (toolkit_scroll_bar_interaction || popup_activated ())
10667 BLOCK_INPUT;
10668 while (XtAppPending (Xt_app_con) & XtIMTimer)
10669 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10670 UNBLOCK_INPUT;
10674 #endif /* USE_X_TOOLKIT */
10677 /* Set up use of X before we make the first connection. */
10679 extern frame_parm_handler x_frame_parm_handlers[];
10681 static struct redisplay_interface x_redisplay_interface =
10683 x_frame_parm_handlers,
10684 x_produce_glyphs,
10685 x_write_glyphs,
10686 x_insert_glyphs,
10687 x_clear_end_of_line,
10688 x_scroll_run,
10689 x_after_update_window_line,
10690 x_update_window_begin,
10691 x_update_window_end,
10692 x_cursor_to,
10693 x_flush,
10694 #ifdef XFlush
10695 x_flush,
10696 #else
10697 0, /* flush_display_optional */
10698 #endif
10699 x_clear_window_mouse_face,
10700 x_get_glyph_overhangs,
10701 x_fix_overlapping_area,
10702 x_draw_fringe_bitmap,
10703 0, /* define_fringe_bitmap */
10704 0, /* destroy_fringe_bitmap */
10705 x_per_char_metric,
10706 x_encode_char,
10707 x_compute_glyph_string_overhangs,
10708 x_draw_glyph_string,
10709 x_define_frame_cursor,
10710 x_clear_frame_area,
10711 x_draw_window_cursor,
10712 x_draw_vertical_window_border,
10713 x_shift_glyphs_for_insert
10716 void
10717 x_initialize ()
10719 rif = &x_redisplay_interface;
10721 clear_frame_hook = x_clear_frame;
10722 ins_del_lines_hook = x_ins_del_lines;
10723 delete_glyphs_hook = x_delete_glyphs;
10724 ring_bell_hook = XTring_bell;
10725 reset_terminal_modes_hook = XTreset_terminal_modes;
10726 set_terminal_modes_hook = XTset_terminal_modes;
10727 update_begin_hook = x_update_begin;
10728 update_end_hook = x_update_end;
10729 set_terminal_window_hook = XTset_terminal_window;
10730 read_socket_hook = XTread_socket;
10731 frame_up_to_date_hook = XTframe_up_to_date;
10732 mouse_position_hook = XTmouse_position;
10733 frame_rehighlight_hook = XTframe_rehighlight;
10734 frame_raise_lower_hook = XTframe_raise_lower;
10735 set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10736 condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10737 redeem_scroll_bar_hook = XTredeem_scroll_bar;
10738 judge_scroll_bars_hook = XTjudge_scroll_bars;
10740 scroll_region_ok = 1; /* we'll scroll partial frames */
10741 char_ins_del_ok = 1;
10742 line_ins_del_ok = 1; /* we'll just blt 'em */
10743 fast_clear_end_of_line = 1; /* X does this well */
10744 memory_below_frame = 0; /* we don't remember what scrolls
10745 off the bottom */
10746 baud_rate = 19200;
10748 x_noop_count = 0;
10749 last_tool_bar_item = -1;
10750 any_help_event_p = 0;
10751 ignore_next_mouse_click_timeout = 0;
10753 #ifdef USE_GTK
10754 current_count = -1;
10755 #endif
10757 /* Try to use interrupt input; if we can't, then start polling. */
10758 Fset_input_mode (Qt, Qnil, Qt, Qnil);
10760 #ifdef USE_X_TOOLKIT
10761 XtToolkitInitialize ();
10763 Xt_app_con = XtCreateApplicationContext ();
10765 /* Register a converter from strings to pixels, which uses
10766 Emacs' color allocation infrastructure. */
10767 XtAppSetTypeConverter (Xt_app_con,
10768 XtRString, XtRPixel, cvt_string_to_pixel,
10769 cvt_string_to_pixel_args,
10770 XtNumber (cvt_string_to_pixel_args),
10771 XtCacheByDisplay, cvt_pixel_dtor);
10773 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10775 /* Install an asynchronous timer that processes Xt timeout events
10776 every 0.1s. This is necessary because some widget sets use
10777 timeouts internally, for example the LessTif menu bar, or the
10778 Xaw3d scroll bar. When Xt timouts aren't processed, these
10779 widgets don't behave normally. */
10781 EMACS_TIME interval;
10782 EMACS_SET_SECS_USECS (interval, 0, 100000);
10783 start_atimer (ATIMER_CONTINUOUS, interval, x_process_timeouts, 0);
10785 #endif
10787 #ifdef USE_TOOLKIT_SCROLL_BARS
10788 #ifndef USE_GTK
10789 xaw3d_arrow_scroll = False;
10790 xaw3d_pick_top = True;
10791 #endif
10792 #endif
10794 /* Note that there is no real way portable across R3/R4 to get the
10795 original error handler. */
10796 XSetErrorHandler (x_error_handler);
10797 XSetIOErrorHandler (x_io_error_quitter);
10799 /* Disable Window Change signals; they are handled by X events. */
10800 #ifdef SIGWINCH
10801 signal (SIGWINCH, SIG_DFL);
10802 #endif /* SIGWINCH */
10804 signal (SIGPIPE, x_connection_signal);
10808 void
10809 syms_of_xterm ()
10811 staticpro (&x_error_message_string);
10812 x_error_message_string = Qnil;
10814 staticpro (&x_display_name_list);
10815 x_display_name_list = Qnil;
10817 staticpro (&last_mouse_scroll_bar);
10818 last_mouse_scroll_bar = Qnil;
10820 staticpro (&Qvendor_specific_keysyms);
10821 Qvendor_specific_keysyms = intern ("vendor-specific-keysyms");
10823 staticpro (&Qutf_8);
10824 Qutf_8 = intern ("utf-8");
10825 staticpro (&Qlatin_1);
10826 Qlatin_1 = intern ("latin-1");
10828 staticpro (&last_mouse_press_frame);
10829 last_mouse_press_frame = Qnil;
10831 DEFVAR_BOOL ("x-use-underline-position-properties",
10832 &x_use_underline_position_properties,
10833 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
10834 nil means ignore them. If you encounter fonts with bogus
10835 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10836 to 4.1, set this to nil. */);
10837 x_use_underline_position_properties = 1;
10839 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10840 &x_mouse_click_focus_ignore_position,
10841 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10842 This variable is only used when the window manager requires that you
10843 click on a frame to select it (give it focus). In that case, a value
10844 of nil, means that the selected window and cursor position changes to
10845 reflect the mouse click position, while a non-nil value means that the
10846 selected window or cursor position is preserved. */);
10847 x_mouse_click_focus_ignore_position = 0;
10849 DEFVAR_LISP ("x-toolkit-scroll-bars", &Vx_toolkit_scroll_bars,
10850 doc: /* What X toolkit scroll bars Emacs uses.
10851 A value of nil means Emacs doesn't use X toolkit scroll bars.
10852 Otherwise, value is a symbol describing the X toolkit. */);
10853 #ifdef USE_TOOLKIT_SCROLL_BARS
10854 #ifdef USE_MOTIF
10855 Vx_toolkit_scroll_bars = intern ("motif");
10856 #elif defined HAVE_XAW3D
10857 Vx_toolkit_scroll_bars = intern ("xaw3d");
10858 #elif USE_GTK
10859 Vx_toolkit_scroll_bars = intern ("gtk");
10860 #else
10861 Vx_toolkit_scroll_bars = intern ("xaw");
10862 #endif
10863 #else
10864 Vx_toolkit_scroll_bars = Qnil;
10865 #endif
10867 staticpro (&last_mouse_motion_frame);
10868 last_mouse_motion_frame = Qnil;
10870 Qmodifier_value = intern ("modifier-value");
10871 Qalt = intern ("alt");
10872 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10873 Qhyper = intern ("hyper");
10874 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10875 Qmeta = intern ("meta");
10876 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10877 Qsuper = intern ("super");
10878 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10880 DEFVAR_LISP ("x-alt-keysym", &Vx_alt_keysym,
10881 doc: /* Which keys Emacs uses for the alt modifier.
10882 This should be one of the symbols `alt', `hyper', `meta', `super'.
10883 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10884 is nil, which is the same as `alt'. */);
10885 Vx_alt_keysym = Qnil;
10887 DEFVAR_LISP ("x-hyper-keysym", &Vx_hyper_keysym,
10888 doc: /* Which keys Emacs uses for the hyper modifier.
10889 This should be one of the symbols `alt', `hyper', `meta', `super'.
10890 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10891 default is nil, which is the same as `hyper'. */);
10892 Vx_hyper_keysym = Qnil;
10894 DEFVAR_LISP ("x-meta-keysym", &Vx_meta_keysym,
10895 doc: /* Which keys Emacs uses for the meta modifier.
10896 This should be one of the symbols `alt', `hyper', `meta', `super'.
10897 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10898 default is nil, which is the same as `meta'. */);
10899 Vx_meta_keysym = Qnil;
10901 DEFVAR_LISP ("x-super-keysym", &Vx_super_keysym,
10902 doc: /* Which keys Emacs uses for the super modifier.
10903 This should be one of the symbols `alt', `hyper', `meta', `super'.
10904 For example, `super' means use the Super_L and Super_R keysyms. The
10905 default is nil, which is the same as `super'. */);
10906 Vx_super_keysym = Qnil;
10908 DEFVAR_LISP ("x-keysym-table", &Vx_keysym_table,
10909 doc: /* Hash table of character codes indexed by X keysym codes. */);
10910 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10911 make_float (DEFAULT_REHASH_SIZE),
10912 make_float (DEFAULT_REHASH_THRESHOLD),
10913 Qnil, Qnil, Qnil);
10916 #endif /* HAVE_X_WINDOWS */
10918 /* arch-tag: 6d4e4cb7-abc1-4302-9585-d84dcfb09d0f
10919 (do not change this comment) */