* emacs.c (USAGE3, standard_args): Add -mm and --maximized.
[emacs.git] / src / xterm.c
blob32ee15966799db988458728aa9f43207e6411b55
1 /* X Communication module for terminals which understand the X protocol.
2 Copyright (C) 1989, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
3 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
21 /* New display code by Gerd Moellmann <gerd@gnu.org>. */
22 /* Xt features made by Fred Pierresteguy. */
24 #include <config.h>
26 /* On 4.3 these lose if they come after xterm.h. */
27 /* Putting these at the beginning seems to be standard for other .c files. */
28 #include <signal.h>
30 #include <stdio.h>
32 #ifdef HAVE_X_WINDOWS
34 #include "lisp.h"
35 #include "blockinput.h"
37 /* Need syssignal.h for various externs and definitions that may be required
38 by some configurations for calls to signal later in this source file. */
39 #include "syssignal.h"
41 /* This may include sys/types.h, and that somehow loses
42 if this is not done before the other system files. */
43 #include "xterm.h"
44 #include <X11/cursorfont.h>
46 /* Load sys/types.h if not already loaded.
47 In some systems loading it twice is suicidal. */
48 #ifndef makedev
49 #include <sys/types.h>
50 #endif /* makedev */
52 #ifdef BSD_SYSTEM
53 #include <sys/ioctl.h>
54 #endif /* ! defined (BSD_SYSTEM) */
56 #include "systime.h"
58 #ifndef INCLUDED_FCNTL
59 #include <fcntl.h>
60 #endif
61 #include <ctype.h>
62 #include <errno.h>
63 #include <setjmp.h>
64 #include <sys/stat.h>
65 /* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed. */
66 /* #include <sys/param.h> */
68 #include "charset.h"
69 #include "character.h"
70 #include "coding.h"
71 #include "frame.h"
72 #include "dispextern.h"
73 #include "fontset.h"
74 #include "termhooks.h"
75 #include "termopts.h"
76 #include "termchar.h"
77 #include "emacs-icon.h"
78 #include "disptab.h"
79 #include "buffer.h"
80 #include "window.h"
81 #include "keyboard.h"
82 #include "intervals.h"
83 #include "process.h"
84 #include "atimer.h"
85 #include "keymap.h"
86 #include "font.h"
87 #include "fontset.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 /* Default to using XIM if available. */
159 #ifdef USE_XIM
160 int use_xim = 1;
161 #else
162 int use_xim = 0; /* configure --without-xim */
163 #endif
167 /* Non-nil means Emacs uses toolkit scroll bars. */
169 Lisp_Object Vx_toolkit_scroll_bars;
171 /* Non-zero means that a HELP_EVENT has been generated since Emacs
172 start. */
174 static int any_help_event_p;
176 /* Last window where we saw the mouse. Used by mouse-autoselect-window. */
177 static Lisp_Object last_window;
179 /* Non-zero means make use of UNDERLINE_POSITION font properties. */
181 int x_use_underline_position_properties;
183 /* Non-zero means to draw the underline at the same place as the descent line. */
185 int x_underline_at_descent_line;
187 /* This is a chain of structures for all the X displays currently in
188 use. */
190 struct x_display_info *x_display_list;
192 /* This is a list of cons cells, each of the form (NAME
193 . FONT-LIST-CACHE), one for each element of x_display_list and in
194 the same order. NAME is the name of the frame. FONT-LIST-CACHE
195 records previous values returned by x-list-fonts. */
197 Lisp_Object x_display_name_list;
199 /* Frame being updated by update_frame. This is declared in term.c.
200 This is set by update_begin and looked at by all the XT functions.
201 It is zero while not inside an update. In that case, the XT
202 functions assume that `selected_frame' is the frame to apply to. */
204 extern struct frame *updating_frame;
206 /* This is a frame waiting to be auto-raised, within XTread_socket. */
208 struct frame *pending_autoraise_frame;
210 #ifdef USE_X_TOOLKIT
211 /* The application context for Xt use. */
212 XtAppContext Xt_app_con;
213 static String Xt_default_resources[] = {0};
214 #endif /* USE_X_TOOLKIT */
216 /* Non-zero means user is interacting with a toolkit scroll bar. */
218 static int toolkit_scroll_bar_interaction;
220 /* Non-zero means to not move point as a result of clicking on a
221 frame to focus it (when focus-follows-mouse is nil). */
223 int x_mouse_click_focus_ignore_position;
225 /* Non-zero timeout value means ignore next mouse click if it arrives
226 before that timeout elapses (i.e. as part of the same sequence of
227 events resulting from clicking on a frame to select it). */
229 static unsigned long ignore_next_mouse_click_timeout;
231 /* Mouse movement.
233 Formerly, we used PointerMotionHintMask (in standard_event_mask)
234 so that we would have to call XQueryPointer after each MotionNotify
235 event to ask for another such event. However, this made mouse tracking
236 slow, and there was a bug that made it eventually stop.
238 Simply asking for MotionNotify all the time seems to work better.
240 In order to avoid asking for motion events and then throwing most
241 of them away or busy-polling the server for mouse positions, we ask
242 the server for pointer motion hints. This means that we get only
243 one event per group of mouse movements. "Groups" are delimited by
244 other kinds of events (focus changes and button clicks, for
245 example), or by XQueryPointer calls; when one of these happens, we
246 get another MotionNotify event the next time the mouse moves. This
247 is at least as efficient as getting motion events when mouse
248 tracking is on, and I suspect only negligibly worse when tracking
249 is off. */
251 /* Where the mouse was last time we reported a mouse event. */
253 static XRectangle last_mouse_glyph;
254 static FRAME_PTR last_mouse_glyph_frame;
255 static Lisp_Object last_mouse_press_frame;
257 /* The scroll bar in which the last X motion event occurred.
259 If the last X motion event occurred in a scroll bar, we set this so
260 XTmouse_position can know whether to report a scroll bar motion or
261 an ordinary motion.
263 If the last X motion event didn't occur in a scroll bar, we set
264 this to Qnil, to tell XTmouse_position to return an ordinary motion
265 event. */
267 static Lisp_Object last_mouse_scroll_bar;
269 /* This is a hack. We would really prefer that XTmouse_position would
270 return the time associated with the position it returns, but there
271 doesn't seem to be any way to wrest the time-stamp from the server
272 along with the position query. So, we just keep track of the time
273 of the last movement we received, and return that in hopes that
274 it's somewhat accurate. */
276 static Time last_mouse_movement_time;
278 /* Time for last user interaction as returned in X events. */
280 static Time last_user_time;
282 /* Incremented by XTread_socket whenever it really tries to read
283 events. */
285 #ifdef __STDC__
286 static int volatile input_signal_count;
287 #else
288 static int input_signal_count;
289 #endif
291 /* Used locally within XTread_socket. */
293 static int x_noop_count;
295 /* Initial values of argv and argc. */
297 extern char **initial_argv;
298 extern int initial_argc;
300 extern Lisp_Object Vcommand_line_args, Vsystem_name;
302 /* Tells if a window manager is present or not. */
304 extern Lisp_Object Vx_no_window_manager;
306 extern Lisp_Object Qeql;
308 extern int errno;
310 /* A mask of extra modifier bits to put into every keyboard char. */
312 extern EMACS_INT extra_keyboard_modifiers;
314 /* The keysyms to use for the various modifiers. */
316 Lisp_Object Vx_alt_keysym, Vx_hyper_keysym, Vx_meta_keysym, Vx_super_keysym;
317 Lisp_Object Vx_keysym_table;
318 static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;
320 static Lisp_Object Qvendor_specific_keysyms;
321 static Lisp_Object Qlatin_1;
323 #ifdef USE_GTK
324 /* The name of the Emacs icon file. */
325 static Lisp_Object xg_default_icon_file;
326 #endif
328 /* Used in x_flush. */
330 extern Lisp_Object Vinhibit_redisplay;
332 extern XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
333 extern int x_bitmap_mask P_ ((FRAME_PTR, int));
335 static int x_alloc_nearest_color_1 P_ ((Display *, Colormap, XColor *));
336 static void x_set_window_size_1 P_ ((struct frame *, int, int, int));
337 static const XColor *x_color_cells P_ ((Display *, int *));
338 static void x_update_window_end P_ ((struct window *, int, int));
340 static int x_io_error_quitter P_ ((Display *));
341 static struct terminal *x_create_terminal P_ ((struct x_display_info *));
342 void x_delete_terminal P_ ((struct terminal *));
343 static void x_update_end P_ ((struct frame *));
344 static void XTframe_up_to_date P_ ((struct frame *));
345 static void XTset_terminal_modes P_ ((struct terminal *));
346 static void XTreset_terminal_modes P_ ((struct terminal *));
347 static void x_clear_frame P_ ((struct frame *));
348 static void frame_highlight P_ ((struct frame *));
349 static void frame_unhighlight P_ ((struct frame *));
350 static void x_new_focus_frame P_ ((struct x_display_info *, struct frame *));
351 static void x_focus_changed P_ ((int, int, struct x_display_info *,
352 struct frame *, struct input_event *));
353 static void x_detect_focus_change P_ ((struct x_display_info *,
354 XEvent *, struct input_event *));
355 static void XTframe_rehighlight P_ ((struct frame *));
356 static void x_frame_rehighlight P_ ((struct x_display_info *));
357 static void x_draw_hollow_cursor P_ ((struct window *, struct glyph_row *));
358 static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int,
359 enum text_cursor_kinds));
361 static void x_clip_to_row P_ ((struct window *, struct glyph_row *, int, GC));
362 static void x_flush P_ ((struct frame *f));
363 static void x_update_begin P_ ((struct frame *));
364 static void x_update_window_begin P_ ((struct window *));
365 static void x_after_update_window_line P_ ((struct glyph_row *));
366 static struct scroll_bar *x_window_to_scroll_bar P_ ((Display *, Window));
367 static void x_scroll_bar_report_motion P_ ((struct frame **, Lisp_Object *,
368 enum scroll_bar_part *,
369 Lisp_Object *, Lisp_Object *,
370 unsigned long *));
371 static void x_handle_net_wm_state P_ ((struct frame *, XPropertyEvent *));
372 static void x_check_fullscreen P_ ((struct frame *));
373 static void x_check_expected_move P_ ((struct frame *, int, int));
374 static void x_sync_with_move P_ ((struct frame *, int, int, int));
375 static int handle_one_xevent P_ ((struct x_display_info *, XEvent *,
376 int *, struct input_event *));
377 /* Don't declare this NO_RETURN because we want no
378 interference with debugging failing X calls. */
379 static SIGTYPE x_connection_closed P_ ((Display *, char *));
382 /* Flush display of frame F, or of all frames if F is null. */
384 static void
385 x_flush (f)
386 struct frame *f;
388 /* Don't call XFlush when it is not safe to redisplay; the X
389 connection may be broken. */
390 if (!NILP (Vinhibit_redisplay))
391 return;
393 BLOCK_INPUT;
394 if (f == NULL)
396 Lisp_Object rest, frame;
397 FOR_EACH_FRAME (rest, frame)
398 if (FRAME_X_P (XFRAME (frame)))
399 x_flush (XFRAME (frame));
401 else if (FRAME_X_P (f))
402 XFlush (FRAME_X_DISPLAY (f));
403 UNBLOCK_INPUT;
407 /* Remove calls to XFlush by defining XFlush to an empty replacement.
408 Calls to XFlush should be unnecessary because the X output buffer
409 is flushed automatically as needed by calls to XPending,
410 XNextEvent, or XWindowEvent according to the XFlush man page.
411 XTread_socket calls XPending. Removing XFlush improves
412 performance. */
414 #define XFlush(DISPLAY) (void) 0
417 /***********************************************************************
418 Debugging
419 ***********************************************************************/
421 #if 0
423 /* This is a function useful for recording debugging information about
424 the sequence of occurrences in this file. */
426 struct record
428 char *locus;
429 int type;
432 struct record event_record[100];
434 int event_record_index;
436 record_event (locus, type)
437 char *locus;
438 int type;
440 if (event_record_index == sizeof (event_record) / sizeof (struct record))
441 event_record_index = 0;
443 event_record[event_record_index].locus = locus;
444 event_record[event_record_index].type = type;
445 event_record_index++;
448 #endif /* 0 */
452 /* Return the struct x_display_info corresponding to DPY. */
454 struct x_display_info *
455 x_display_info_for_display (dpy)
456 Display *dpy;
458 struct x_display_info *dpyinfo;
460 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
461 if (dpyinfo->display == dpy)
462 return dpyinfo;
464 return 0;
467 #define OPAQUE 0xffffffff
468 #define OPACITY "_NET_WM_WINDOW_OPACITY"
470 void
471 x_set_frame_alpha (f)
472 struct frame *f;
474 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
475 Display *dpy = FRAME_X_DISPLAY (f);
476 Window win = FRAME_OUTER_WINDOW (f);
477 double alpha = 1.0;
478 double alpha_min = 1.0;
479 unsigned long opac;
481 if (FRAME_X_DISPLAY_INFO (f)->root_window != FRAME_X_OUTPUT (f)->parent_desc)
482 /* Since the WM decoration lies under the FRAME_OUTER_WINDOW,
483 we must treat the former instead of the latter. */
484 win = FRAME_X_OUTPUT(f)->parent_desc;
486 if (dpyinfo->x_highlight_frame == f)
487 alpha = f->alpha[0];
488 else
489 alpha = f->alpha[1];
491 if (FLOATP (Vframe_alpha_lower_limit))
492 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
493 else if (INTEGERP (Vframe_alpha_lower_limit))
494 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
496 if (alpha < 0.0)
497 return;
498 else if (alpha > 1.0)
499 alpha = 1.0;
500 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
501 alpha = alpha_min;
503 opac = alpha * OPAQUE;
505 /* return unless necessary */
507 unsigned char *data;
508 Atom actual;
509 int rc, format;
510 unsigned long n, left;
512 x_catch_errors (dpy);
513 rc = XGetWindowProperty(dpy, win, XInternAtom(dpy, OPACITY, False),
514 0L, 1L, False, XA_CARDINAL,
515 &actual, &format, &n, &left,
516 &data);
518 if (rc == Success && actual != None)
519 if (*(unsigned long *)data == opac)
521 XFree ((void *) data);
522 x_uncatch_errors ();
523 return;
525 else
526 XFree ((void *) data);
527 x_uncatch_errors ();
530 x_catch_errors (dpy);
531 XChangeProperty (dpy, win, XInternAtom (dpy, OPACITY, False),
532 XA_CARDINAL, 32, PropModeReplace,
533 (unsigned char *) &opac, 1L);
534 x_uncatch_errors ();
538 x_display_pixel_height (dpyinfo)
539 struct x_display_info *dpyinfo;
541 return HeightOfScreen (dpyinfo->screen);
545 x_display_pixel_width (dpyinfo)
546 struct x_display_info *dpyinfo;
548 return WidthOfScreen (dpyinfo->screen);
552 /***********************************************************************
553 Starting and ending an update
554 ***********************************************************************/
556 /* Start an update of frame F. This function is installed as a hook
557 for update_begin, i.e. it is called when update_begin is called.
558 This function is called prior to calls to x_update_window_begin for
559 each window being updated. Currently, there is nothing to do here
560 because all interesting stuff is done on a window basis. */
562 static void
563 x_update_begin (f)
564 struct frame *f;
566 /* Nothing to do. */
570 /* Start update of window W. Set the global variable updated_window
571 to the window being updated and set output_cursor to the cursor
572 position of W. */
574 static void
575 x_update_window_begin (w)
576 struct window *w;
578 struct frame *f = XFRAME (WINDOW_FRAME (w));
579 struct x_display_info *display_info = FRAME_X_DISPLAY_INFO (f);
581 updated_window = w;
582 set_output_cursor (&w->cursor);
584 BLOCK_INPUT;
586 if (f == display_info->mouse_face_mouse_frame)
588 /* Don't do highlighting for mouse motion during the update. */
589 display_info->mouse_face_defer = 1;
591 /* If F needs to be redrawn, simply forget about any prior mouse
592 highlighting. */
593 if (FRAME_GARBAGED_P (f))
594 display_info->mouse_face_window = Qnil;
597 UNBLOCK_INPUT;
601 /* Draw a vertical window border from (x,y0) to (x,y1) */
603 static void
604 x_draw_vertical_window_border (w, x, y0, y1)
605 struct window *w;
606 int x, y0, y1;
608 struct frame *f = XFRAME (WINDOW_FRAME (w));
609 struct face *face;
611 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
612 if (face)
613 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
614 face->foreground);
616 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
617 f->output_data.x->normal_gc, x, y0, x, y1);
620 /* End update of window W (which is equal to updated_window).
622 Draw vertical borders between horizontally adjacent windows, and
623 display W's cursor if CURSOR_ON_P is non-zero.
625 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
626 glyphs in mouse-face were overwritten. In that case we have to
627 make sure that the mouse-highlight is properly redrawn.
629 W may be a menu bar pseudo-window in case we don't have X toolkit
630 support. Such windows don't have a cursor, so don't display it
631 here. */
633 static void
634 x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
635 struct window *w;
636 int cursor_on_p, mouse_face_overwritten_p;
638 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
640 if (!w->pseudo_window_p)
642 BLOCK_INPUT;
644 if (cursor_on_p)
645 display_and_set_cursor (w, 1, output_cursor.hpos,
646 output_cursor.vpos,
647 output_cursor.x, output_cursor.y);
649 if (draw_window_fringes (w, 1))
650 x_draw_vertical_border (w);
652 UNBLOCK_INPUT;
655 /* If a row with mouse-face was overwritten, arrange for
656 XTframe_up_to_date to redisplay the mouse highlight. */
657 if (mouse_face_overwritten_p)
659 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
660 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
661 dpyinfo->mouse_face_window = Qnil;
664 updated_window = NULL;
668 /* End update of frame F. This function is installed as a hook in
669 update_end. */
671 static void
672 x_update_end (f)
673 struct frame *f;
675 /* Mouse highlight may be displayed again. */
676 FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
678 #ifndef XFlush
679 BLOCK_INPUT;
680 XFlush (FRAME_X_DISPLAY (f));
681 UNBLOCK_INPUT;
682 #endif
686 /* This function is called from various places in xdisp.c whenever a
687 complete update has been performed. The global variable
688 updated_window is not available here. */
690 static void
691 XTframe_up_to_date (f)
692 struct frame *f;
694 if (FRAME_X_P (f))
696 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
698 if (dpyinfo->mouse_face_deferred_gc
699 || f == dpyinfo->mouse_face_mouse_frame)
701 BLOCK_INPUT;
702 if (dpyinfo->mouse_face_mouse_frame)
703 note_mouse_highlight (dpyinfo->mouse_face_mouse_frame,
704 dpyinfo->mouse_face_mouse_x,
705 dpyinfo->mouse_face_mouse_y);
706 dpyinfo->mouse_face_deferred_gc = 0;
707 UNBLOCK_INPUT;
713 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
714 arrow bitmaps, or clear the fringes if no bitmaps are required
715 before DESIRED_ROW is made current. The window being updated is
716 found in updated_window. This function It is called from
717 update_window_line only if it is known that there are differences
718 between bitmaps to be drawn between current row and DESIRED_ROW. */
720 static void
721 x_after_update_window_line (desired_row)
722 struct glyph_row *desired_row;
724 struct window *w = updated_window;
725 struct frame *f;
726 int width, height;
728 xassert (w);
730 if (!desired_row->mode_line_p && !w->pseudo_window_p)
731 desired_row->redraw_fringe_bitmaps_p = 1;
733 /* When a window has disappeared, make sure that no rest of
734 full-width rows stays visible in the internal border. Could
735 check here if updated_window is the leftmost/rightmost window,
736 but I guess it's not worth doing since vertically split windows
737 are almost never used, internal border is rarely set, and the
738 overhead is very small. */
739 if (windows_or_buffers_changed
740 && desired_row->full_width_p
741 && (f = XFRAME (w->frame),
742 width = FRAME_INTERNAL_BORDER_WIDTH (f),
743 width != 0)
744 && (height = desired_row->visible_height,
745 height > 0))
747 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
749 /* Internal border is drawn below the tool bar. */
750 if (WINDOWP (f->tool_bar_window)
751 && w == XWINDOW (f->tool_bar_window))
752 y -= width;
754 BLOCK_INPUT;
755 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
756 0, y, width, height, False);
757 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
758 FRAME_PIXEL_WIDTH (f) - width,
759 y, width, height, False);
760 UNBLOCK_INPUT;
764 static void
765 x_draw_fringe_bitmap (w, row, p)
766 struct window *w;
767 struct glyph_row *row;
768 struct draw_fringe_bitmap_params *p;
770 struct frame *f = XFRAME (WINDOW_FRAME (w));
771 Display *display = FRAME_X_DISPLAY (f);
772 Window window = FRAME_X_WINDOW (f);
773 GC gc = f->output_data.x->normal_gc;
774 struct face *face = p->face;
775 int rowY;
777 /* Must clip because of partially visible lines. */
778 rowY = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
779 if (p->y < rowY)
781 /* Adjust position of "bottom aligned" bitmap on partially
782 visible last row. */
783 int oldY = row->y;
784 int oldVH = row->visible_height;
785 row->visible_height = p->h;
786 row->y -= rowY - p->y;
787 x_clip_to_row (w, row, -1, gc);
788 row->y = oldY;
789 row->visible_height = oldVH;
791 else
792 x_clip_to_row (w, row, -1, gc);
794 if (!p->overlay_p)
796 int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;
798 /* In case the same realized face is used for fringes and
799 for something displayed in the text (e.g. face `region' on
800 mono-displays, the fill style may have been changed to
801 FillSolid in x_draw_glyph_string_background. */
802 if (face->stipple)
803 XSetFillStyle (display, face->gc, FillOpaqueStippled);
804 else
805 XSetForeground (display, face->gc, face->background);
807 #ifdef USE_TOOLKIT_SCROLL_BARS
808 /* If the fringe is adjacent to the left (right) scroll bar of a
809 leftmost (rightmost, respectively) window, then extend its
810 background to the gap between the fringe and the bar. */
811 if ((WINDOW_LEFTMOST_P (w)
812 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
813 || (WINDOW_RIGHTMOST_P (w)
814 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
816 int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
818 if (sb_width > 0)
820 int left = WINDOW_SCROLL_BAR_AREA_X (w);
821 int width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
822 * FRAME_COLUMN_WIDTH (f));
824 if (bx < 0)
826 /* Bitmap fills the fringe. */
827 if (left + width == p->x)
828 bx = left + sb_width;
829 else if (p->x + p->wd == left)
830 bx = left;
831 if (bx >= 0)
833 int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);
835 nx = width - sb_width;
836 by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
837 row->y));
838 ny = row->visible_height;
841 else
843 if (left + width == bx)
845 bx = left + sb_width;
846 nx += width - sb_width;
848 else if (bx + nx == left)
849 nx += width - sb_width;
853 #endif
854 if (bx >= 0 && nx > 0)
855 XFillRectangle (display, window, face->gc, bx, by, nx, ny);
857 if (!face->stipple)
858 XSetForeground (display, face->gc, face->foreground);
861 if (p->which)
863 unsigned char *bits;
864 Pixmap pixmap, clipmask = (Pixmap) 0;
865 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
866 XGCValues gcv;
868 if (p->wd > 8)
869 bits = (unsigned char *)(p->bits + p->dh);
870 else
871 bits = (unsigned char *)p->bits + p->dh;
873 /* Draw the bitmap. I believe these small pixmaps can be cached
874 by the server. */
875 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
876 (p->cursor_p
877 ? (p->overlay_p ? face->background
878 : f->output_data.x->cursor_pixel)
879 : face->foreground),
880 face->background, depth);
882 if (p->overlay_p)
884 clipmask = XCreatePixmapFromBitmapData (display,
885 FRAME_X_DISPLAY_INFO (f)->root_window,
886 bits, p->wd, p->h,
887 1, 0, 1);
888 gcv.clip_mask = clipmask;
889 gcv.clip_x_origin = p->x;
890 gcv.clip_y_origin = p->y;
891 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
894 XCopyArea (display, pixmap, window, gc, 0, 0,
895 p->wd, p->h, p->x, p->y);
896 XFreePixmap (display, pixmap);
898 if (p->overlay_p)
900 gcv.clip_mask = (Pixmap) 0;
901 XChangeGC (display, gc, GCClipMask, &gcv);
902 XFreePixmap (display, clipmask);
906 XSetClipMask (display, gc, None);
911 /* This is called when starting Emacs and when restarting after
912 suspend. When starting Emacs, no X window is mapped. And nothing
913 must be done to Emacs's own window if it is suspended (though that
914 rarely happens). */
916 static void
917 XTset_terminal_modes (struct terminal *terminal)
921 /* This is called when exiting or suspending Emacs. Exiting will make
922 the X-windows go away, and suspending requires no action. */
924 static void
925 XTreset_terminal_modes (struct terminal *terminal)
930 /***********************************************************************
931 Glyph display
932 ***********************************************************************/
936 static void x_set_glyph_string_clipping P_ ((struct glyph_string *));
937 static void x_set_glyph_string_gc P_ ((struct glyph_string *));
938 static void x_draw_glyph_string_background P_ ((struct glyph_string *,
939 int));
940 static void x_draw_glyph_string_foreground P_ ((struct glyph_string *));
941 static void x_draw_composite_glyph_string_foreground P_ ((struct glyph_string *));
942 static void x_draw_glyph_string_box P_ ((struct glyph_string *));
943 static void x_draw_glyph_string P_ ((struct glyph_string *));
944 static void x_compute_glyph_string_overhangs P_ ((struct glyph_string *));
945 static void x_set_cursor_gc P_ ((struct glyph_string *));
946 static void x_set_mode_line_face_gc P_ ((struct glyph_string *));
947 static void x_set_mouse_face_gc P_ ((struct glyph_string *));
948 static int x_alloc_lighter_color P_ ((struct frame *, Display *, Colormap,
949 unsigned long *, double, int));
950 static void x_setup_relief_color P_ ((struct frame *, struct relief *,
951 double, int, unsigned long));
952 static void x_setup_relief_colors P_ ((struct glyph_string *));
953 static void x_draw_image_glyph_string P_ ((struct glyph_string *));
954 static void x_draw_image_relief P_ ((struct glyph_string *));
955 static void x_draw_image_foreground P_ ((struct glyph_string *));
956 static void x_draw_image_foreground_1 P_ ((struct glyph_string *, Pixmap));
957 static void x_clear_glyph_string_rect P_ ((struct glyph_string *, int,
958 int, int, int));
959 static void x_draw_relief_rect P_ ((struct frame *, int, int, int, int,
960 int, int, int, int, int, int,
961 XRectangle *));
962 static void x_draw_box_rect P_ ((struct glyph_string *, int, int, int, int,
963 int, int, int, XRectangle *));
965 #if GLYPH_DEBUG
966 static void x_check_font P_ ((struct frame *, struct font *));
967 #endif
970 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
971 face. */
973 static void
974 x_set_cursor_gc (s)
975 struct glyph_string *s;
977 if (s->font == FRAME_FONT (s->f)
978 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
979 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
980 && !s->cmp)
981 s->gc = s->f->output_data.x->cursor_gc;
982 else
984 /* Cursor on non-default face: must merge. */
985 XGCValues xgcv;
986 unsigned long mask;
988 xgcv.background = s->f->output_data.x->cursor_pixel;
989 xgcv.foreground = s->face->background;
991 /* If the glyph would be invisible, try a different foreground. */
992 if (xgcv.foreground == xgcv.background)
993 xgcv.foreground = s->face->foreground;
994 if (xgcv.foreground == xgcv.background)
995 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
996 if (xgcv.foreground == xgcv.background)
997 xgcv.foreground = s->face->foreground;
999 /* Make sure the cursor is distinct from text in this face. */
1000 if (xgcv.background == s->face->background
1001 && xgcv.foreground == s->face->foreground)
1003 xgcv.background = s->face->foreground;
1004 xgcv.foreground = s->face->background;
1007 IF_DEBUG (x_check_font (s->f, s->font));
1008 xgcv.graphics_exposures = False;
1009 mask = GCForeground | GCBackground | GCGraphicsExposures;
1011 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1012 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1013 mask, &xgcv);
1014 else
1015 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1016 = XCreateGC (s->display, s->window, mask, &xgcv);
1018 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1023 /* Set up S->gc of glyph string S for drawing text in mouse face. */
1025 static void
1026 x_set_mouse_face_gc (s)
1027 struct glyph_string *s;
1029 int face_id;
1030 struct face *face;
1032 /* What face has to be used last for the mouse face? */
1033 face_id = FRAME_X_DISPLAY_INFO (s->f)->mouse_face_face_id;
1034 face = FACE_FROM_ID (s->f, face_id);
1035 if (face == NULL)
1036 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
1038 if (s->first_glyph->type == CHAR_GLYPH)
1039 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1040 else
1041 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1042 s->face = FACE_FROM_ID (s->f, face_id);
1043 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1045 if (s->font == s->face->font)
1046 s->gc = s->face->gc;
1047 else
1049 /* Otherwise construct scratch_cursor_gc with values from FACE
1050 except for FONT. */
1051 XGCValues xgcv;
1052 unsigned long mask;
1054 xgcv.background = s->face->background;
1055 xgcv.foreground = s->face->foreground;
1056 xgcv.graphics_exposures = False;
1057 mask = GCForeground | GCBackground | GCGraphicsExposures;
1059 if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1060 XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1061 mask, &xgcv);
1062 else
1063 FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
1064 = XCreateGC (s->display, s->window, mask, &xgcv);
1066 s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1069 xassert (s->gc != 0);
1073 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1074 Faces to use in the mode line have already been computed when the
1075 matrix was built, so there isn't much to do, here. */
1077 static INLINE void
1078 x_set_mode_line_face_gc (s)
1079 struct glyph_string *s;
1081 s->gc = s->face->gc;
1085 /* Set S->gc of glyph string S for drawing that glyph string. Set
1086 S->stippled_p to a non-zero value if the face of S has a stipple
1087 pattern. */
1089 static INLINE void
1090 x_set_glyph_string_gc (s)
1091 struct glyph_string *s;
1093 PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1095 if (s->hl == DRAW_NORMAL_TEXT)
1097 s->gc = s->face->gc;
1098 s->stippled_p = s->face->stipple != 0;
1100 else if (s->hl == DRAW_INVERSE_VIDEO)
1102 x_set_mode_line_face_gc (s);
1103 s->stippled_p = s->face->stipple != 0;
1105 else if (s->hl == DRAW_CURSOR)
1107 x_set_cursor_gc (s);
1108 s->stippled_p = 0;
1110 else if (s->hl == DRAW_MOUSE_FACE)
1112 x_set_mouse_face_gc (s);
1113 s->stippled_p = s->face->stipple != 0;
1115 else if (s->hl == DRAW_IMAGE_RAISED
1116 || s->hl == DRAW_IMAGE_SUNKEN)
1118 s->gc = s->face->gc;
1119 s->stippled_p = s->face->stipple != 0;
1121 else
1123 s->gc = s->face->gc;
1124 s->stippled_p = s->face->stipple != 0;
1127 /* GC must have been set. */
1128 xassert (s->gc != 0);
1132 /* Set clipping for output of glyph string S. S may be part of a mode
1133 line or menu if we don't have X toolkit support. */
1135 static INLINE void
1136 x_set_glyph_string_clipping (s)
1137 struct glyph_string *s;
1139 XRectangle *r = s->clip;
1140 int n = get_glyph_string_clip_rects (s, r, 2);
1142 if (n > 0)
1143 XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
1144 s->num_clips = n;
1148 /* Set SRC's clipping for output of glyph string DST. This is called
1149 when we are drawing DST's left_overhang or right_overhang only in
1150 the area of SRC. */
1152 static void
1153 x_set_glyph_string_clipping_exactly (src, dst)
1154 struct glyph_string *src, *dst;
1156 XRectangle r;
1158 r.x = src->x;
1159 r.width = src->width;
1160 r.y = src->y;
1161 r.height = src->height;
1162 dst->clip[0] = r;
1163 dst->num_clips = 1;
1164 XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
1168 /* RIF:
1169 Compute left and right overhang of glyph string S. */
1171 static void
1172 x_compute_glyph_string_overhangs (s)
1173 struct glyph_string *s;
1175 if (s->cmp == NULL
1176 && (s->first_glyph->type == CHAR_GLYPH
1177 || s->first_glyph->type == COMPOSITE_GLYPH))
1179 struct font_metrics metrics;
1181 if (s->first_glyph->type == CHAR_GLYPH)
1183 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1184 struct font *font = s->font;
1185 int i;
1187 for (i = 0; i < s->nchars; i++)
1188 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1189 font->driver->text_extents (font, code, s->nchars, &metrics);
1191 else
1193 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1195 composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
1197 s->right_overhang = (metrics.rbearing > metrics.width
1198 ? metrics.rbearing - metrics.width : 0);
1199 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1201 else if (s->cmp)
1203 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1204 s->left_overhang = - s->cmp->lbearing;
1209 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1211 static INLINE void
1212 x_clear_glyph_string_rect (s, x, y, w, h)
1213 struct glyph_string *s;
1214 int x, y, w, h;
1216 XGCValues xgcv;
1217 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1218 XSetForeground (s->display, s->gc, xgcv.background);
1219 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
1220 XSetForeground (s->display, s->gc, xgcv.foreground);
1224 /* Draw the background of glyph_string S. If S->background_filled_p
1225 is non-zero don't draw it. FORCE_P non-zero means draw the
1226 background even if it wouldn't be drawn normally. This is used
1227 when a string preceding S draws into the background of S, or S
1228 contains the first component of a composition. */
1230 static void
1231 x_draw_glyph_string_background (s, force_p)
1232 struct glyph_string *s;
1233 int force_p;
1235 /* Nothing to do if background has already been drawn or if it
1236 shouldn't be drawn in the first place. */
1237 if (!s->background_filled_p)
1239 int box_line_width = max (s->face->box_line_width, 0);
1241 if (s->stippled_p)
1243 /* Fill background with a stipple pattern. */
1244 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1245 XFillRectangle (s->display, s->window, s->gc, s->x,
1246 s->y + box_line_width,
1247 s->background_width,
1248 s->height - 2 * box_line_width);
1249 XSetFillStyle (s->display, s->gc, FillSolid);
1250 s->background_filled_p = 1;
1252 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1253 || s->font_not_found_p
1254 || s->extends_to_end_of_line_p
1255 || force_p)
1257 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1258 s->background_width,
1259 s->height - 2 * box_line_width);
1260 s->background_filled_p = 1;
1266 /* Draw the foreground of glyph string S. */
1268 static void
1269 x_draw_glyph_string_foreground (s)
1270 struct glyph_string *s;
1272 int i, x;
1274 /* If first glyph of S has a left box line, start drawing the text
1275 of S to the right of that box line. */
1276 if (s->face->box != FACE_NO_BOX
1277 && s->first_glyph->left_box_line_p)
1278 x = s->x + eabs (s->face->box_line_width);
1279 else
1280 x = s->x;
1282 /* Draw characters of S as rectangles if S's font could not be
1283 loaded. */
1284 if (s->font_not_found_p)
1286 for (i = 0; i < s->nchars; ++i)
1288 struct glyph *g = s->first_glyph + i;
1289 XDrawRectangle (s->display, s->window,
1290 s->gc, x, s->y, g->pixel_width - 1,
1291 s->height - 1);
1292 x += g->pixel_width;
1295 else
1297 struct font *font = s->font;
1298 int boff = font->baseline_offset;
1299 int y;
1301 if (font->vertical_centering)
1302 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1304 y = s->ybase - boff;
1305 if (s->for_overlaps
1306 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1307 font->driver->draw (s, 0, s->nchars, x, y, 0);
1308 else
1309 font->driver->draw (s, 0, s->nchars, x, y, 1);
1310 if (s->face->overstrike)
1311 font->driver->draw (s, 0, s->nchars, x + 1, y, 0);
1315 /* Draw the foreground of composite glyph string S. */
1317 static void
1318 x_draw_composite_glyph_string_foreground (s)
1319 struct glyph_string *s;
1321 int i, j, x;
1322 struct font *font = s->font;
1324 /* If first glyph of S has a left box line, start drawing the text
1325 of S to the right of that box line. */
1326 if (s->face && s->face->box != FACE_NO_BOX
1327 && s->first_glyph->left_box_line_p)
1328 x = s->x + eabs (s->face->box_line_width);
1329 else
1330 x = s->x;
1332 /* S is a glyph string for a composition. S->cmp_from is the index
1333 of the first character drawn for glyphs of this composition.
1334 S->cmp_from == 0 means we are drawing the very first character of
1335 this composition. */
1337 /* Draw a rectangle for the composition if the font for the very
1338 first character of the composition could not be loaded. */
1339 if (s->font_not_found_p)
1341 if (s->cmp_from == 0)
1342 XDrawRectangle (s->display, s->window, s->gc, x, s->y,
1343 s->width - 1, s->height - 1);
1345 else if (! s->first_glyph->u.cmp.automatic)
1347 int y = s->ybase;
1349 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1350 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1352 int xx = x + s->cmp->offsets[j * 2];
1353 int yy = y - s->cmp->offsets[j * 2 + 1];
1355 font->driver->draw (s, j, j + 1, xx, yy, 0);
1356 if (s->face->overstrike)
1357 font->driver->draw (s, j, j + 1, xx + 1, yy, 0);
1360 else
1362 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1363 Lisp_Object glyph;
1364 int y = s->ybase;
1365 int width = 0;
1367 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1369 glyph = LGSTRING_GLYPH (gstring, i);
1370 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1371 width += LGLYPH_WIDTH (glyph);
1372 else
1374 int xoff, yoff, wadjust;
1376 if (j < i)
1378 font->driver->draw (s, j, i, x, y, 0);
1379 x += width;
1381 xoff = LGLYPH_XOFF (glyph);
1382 yoff = LGLYPH_YOFF (glyph);
1383 wadjust = LGLYPH_WADJUST (glyph);
1384 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, 0);
1385 x += wadjust;
1386 j = i + 1;
1387 width = 0;
1390 if (j < i)
1391 font->driver->draw (s, j, i, x, y, 0);
1396 #ifdef USE_X_TOOLKIT
1398 static struct frame *x_frame_of_widget P_ ((Widget));
1399 static Boolean cvt_string_to_pixel P_ ((Display *, XrmValue *, Cardinal *,
1400 XrmValue *, XrmValue *, XtPointer *));
1401 static void cvt_pixel_dtor P_ ((XtAppContext, XrmValue *, XtPointer,
1402 XrmValue *, Cardinal *));
1405 /* Return the frame on which widget WIDGET is used.. Abort if frame
1406 cannot be determined. */
1408 static struct frame *
1409 x_frame_of_widget (widget)
1410 Widget widget;
1412 struct x_display_info *dpyinfo;
1413 Lisp_Object tail;
1414 struct frame *f;
1416 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1418 /* Find the top-level shell of the widget. Note that this function
1419 can be called when the widget is not yet realized, so XtWindow
1420 (widget) == 0. That's the reason we can't simply use
1421 x_any_window_to_frame. */
1422 while (!XtIsTopLevelShell (widget))
1423 widget = XtParent (widget);
1425 /* Look for a frame with that top-level widget. Allocate the color
1426 on that frame to get the right gamma correction value. */
1427 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
1428 if (FRAMEP (XCAR (tail))
1429 && (f = XFRAME (XCAR (tail)),
1430 (FRAME_X_P (f)
1431 && f->output_data.nothing != 1
1432 && FRAME_X_DISPLAY_INFO (f) == dpyinfo))
1433 && f->output_data.x->widget == widget)
1434 return f;
1436 abort ();
1440 /* Allocate the color COLOR->pixel on the screen and display of
1441 widget WIDGET in colormap CMAP. If an exact match cannot be
1442 allocated, try the nearest color available. Value is non-zero
1443 if successful. This is called from lwlib. */
1446 x_alloc_nearest_color_for_widget (widget, cmap, color)
1447 Widget widget;
1448 Colormap cmap;
1449 XColor *color;
1451 struct frame *f = x_frame_of_widget (widget);
1452 return x_alloc_nearest_color (f, cmap, color);
1456 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1457 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1458 If this produces the same color as PIXEL, try a color where all RGB
1459 values have DELTA added. Return the allocated color in *PIXEL.
1460 DISPLAY is the X display, CMAP is the colormap to operate on.
1461 Value is non-zero if successful. */
1464 x_alloc_lighter_color_for_widget (widget, display, cmap, pixel, factor, delta)
1465 Widget widget;
1466 Display *display;
1467 Colormap cmap;
1468 unsigned long *pixel;
1469 double factor;
1470 int delta;
1472 struct frame *f = x_frame_of_widget (widget);
1473 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
1477 /* Structure specifying which arguments should be passed by Xt to
1478 cvt_string_to_pixel. We want the widget's screen and colormap. */
1480 static XtConvertArgRec cvt_string_to_pixel_args[] =
1482 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.screen),
1483 sizeof (Screen *)},
1484 {XtWidgetBaseOffset, (XtPointer) XtOffset (Widget, core.colormap),
1485 sizeof (Colormap)}
1489 /* The address of this variable is returned by
1490 cvt_string_to_pixel. */
1492 static Pixel cvt_string_to_pixel_value;
1495 /* Convert a color name to a pixel color.
1497 DPY is the display we are working on.
1499 ARGS is an array of *NARGS XrmValue structures holding additional
1500 information about the widget for which the conversion takes place.
1501 The contents of this array are determined by the specification
1502 in cvt_string_to_pixel_args.
1504 FROM is a pointer to an XrmValue which points to the color name to
1505 convert. TO is an XrmValue in which to return the pixel color.
1507 CLOSURE_RET is a pointer to user-data, in which we record if
1508 we allocated the color or not.
1510 Value is True if successful, False otherwise. */
1512 static Boolean
1513 cvt_string_to_pixel (dpy, args, nargs, from, to, closure_ret)
1514 Display *dpy;
1515 XrmValue *args;
1516 Cardinal *nargs;
1517 XrmValue *from, *to;
1518 XtPointer *closure_ret;
1520 Screen *screen;
1521 Colormap cmap;
1522 Pixel pixel;
1523 String color_name;
1524 XColor color;
1526 if (*nargs != 2)
1528 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1529 "wrongParameters", "cvt_string_to_pixel",
1530 "XtToolkitError",
1531 "Screen and colormap args required", NULL, NULL);
1532 return False;
1535 screen = *(Screen **) args[0].addr;
1536 cmap = *(Colormap *) args[1].addr;
1537 color_name = (String) from->addr;
1539 if (strcmp (color_name, XtDefaultBackground) == 0)
1541 *closure_ret = (XtPointer) False;
1542 pixel = WhitePixelOfScreen (screen);
1544 else if (strcmp (color_name, XtDefaultForeground) == 0)
1546 *closure_ret = (XtPointer) False;
1547 pixel = BlackPixelOfScreen (screen);
1549 else if (XParseColor (dpy, cmap, color_name, &color)
1550 && x_alloc_nearest_color_1 (dpy, cmap, &color))
1552 pixel = color.pixel;
1553 *closure_ret = (XtPointer) True;
1555 else
1557 String params[1];
1558 Cardinal nparams = 1;
1560 params[0] = color_name;
1561 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
1562 "badValue", "cvt_string_to_pixel",
1563 "XtToolkitError", "Invalid color `%s'",
1564 params, &nparams);
1565 return False;
1568 if (to->addr != NULL)
1570 if (to->size < sizeof (Pixel))
1572 to->size = sizeof (Pixel);
1573 return False;
1576 *(Pixel *) to->addr = pixel;
1578 else
1580 cvt_string_to_pixel_value = pixel;
1581 to->addr = (XtPointer) &cvt_string_to_pixel_value;
1584 to->size = sizeof (Pixel);
1585 return True;
1589 /* Free a pixel color which was previously allocated via
1590 cvt_string_to_pixel. This is registered as the destructor
1591 for this type of resource via XtSetTypeConverter.
1593 APP is the application context in which we work.
1595 TO is a pointer to an XrmValue holding the color to free.
1596 CLOSURE is the value we stored in CLOSURE_RET for this color
1597 in cvt_string_to_pixel.
1599 ARGS and NARGS are like for cvt_string_to_pixel. */
1601 static void
1602 cvt_pixel_dtor (app, to, closure, args, nargs)
1603 XtAppContext app;
1604 XrmValuePtr to;
1605 XtPointer closure;
1606 XrmValuePtr args;
1607 Cardinal *nargs;
1609 if (*nargs != 2)
1611 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
1612 "XtToolkitError",
1613 "Screen and colormap arguments required",
1614 NULL, NULL);
1616 else if (closure != NULL)
1618 /* We did allocate the pixel, so free it. */
1619 Screen *screen = *(Screen **) args[0].addr;
1620 Colormap cmap = *(Colormap *) args[1].addr;
1621 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
1622 (Pixel *) to->addr, 1);
1627 #endif /* USE_X_TOOLKIT */
1630 /* Value is an array of XColor structures for the contents of the
1631 color map of display DPY. Set *NCELLS to the size of the array.
1632 Note that this probably shouldn't be called for large color maps,
1633 say a 24-bit TrueColor map. */
1635 static const XColor *
1636 x_color_cells (dpy, ncells)
1637 Display *dpy;
1638 int *ncells;
1640 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1642 if (dpyinfo->color_cells == NULL)
1644 Screen *screen = dpyinfo->screen;
1645 int i;
1647 dpyinfo->ncolor_cells
1648 = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
1649 dpyinfo->color_cells
1650 = (XColor *) xmalloc (dpyinfo->ncolor_cells
1651 * sizeof *dpyinfo->color_cells);
1653 for (i = 0; i < dpyinfo->ncolor_cells; ++i)
1654 dpyinfo->color_cells[i].pixel = i;
1656 XQueryColors (dpy, dpyinfo->cmap,
1657 dpyinfo->color_cells, dpyinfo->ncolor_cells);
1660 *ncells = dpyinfo->ncolor_cells;
1661 return dpyinfo->color_cells;
1665 /* On frame F, translate pixel colors to RGB values for the NCOLORS
1666 colors in COLORS. Use cached information, if available. */
1668 void
1669 x_query_colors (f, colors, ncolors)
1670 struct frame *f;
1671 XColor *colors;
1672 int ncolors;
1674 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1676 if (dpyinfo->color_cells)
1678 int i;
1679 for (i = 0; i < ncolors; ++i)
1681 unsigned long pixel = colors[i].pixel;
1682 xassert (pixel < dpyinfo->ncolor_cells);
1683 xassert (dpyinfo->color_cells[pixel].pixel == pixel);
1684 colors[i] = dpyinfo->color_cells[pixel];
1687 else
1688 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
1692 /* On frame F, translate pixel color to RGB values for the color in
1693 COLOR. Use cached information, if available. */
1695 void
1696 x_query_color (f, color)
1697 struct frame *f;
1698 XColor *color;
1700 x_query_colors (f, color, 1);
1704 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
1705 exact match can't be allocated, try the nearest color available.
1706 Value is non-zero if successful. Set *COLOR to the color
1707 allocated. */
1709 static int
1710 x_alloc_nearest_color_1 (dpy, cmap, color)
1711 Display *dpy;
1712 Colormap cmap;
1713 XColor *color;
1715 int rc;
1717 rc = XAllocColor (dpy, cmap, color);
1718 if (rc == 0)
1720 /* If we got to this point, the colormap is full, so we're going
1721 to try to get the next closest color. The algorithm used is
1722 a least-squares matching, which is what X uses for closest
1723 color matching with StaticColor visuals. */
1724 int nearest, i;
1725 unsigned long nearest_delta = ~0;
1726 int ncells;
1727 const XColor *cells = x_color_cells (dpy, &ncells);
1729 for (nearest = i = 0; i < ncells; ++i)
1731 long dred = (color->red >> 8) - (cells[i].red >> 8);
1732 long dgreen = (color->green >> 8) - (cells[i].green >> 8);
1733 long dblue = (color->blue >> 8) - (cells[i].blue >> 8);
1734 unsigned long delta = dred * dred + dgreen * dgreen + dblue * dblue;
1736 if (delta < nearest_delta)
1738 nearest = i;
1739 nearest_delta = delta;
1743 color->red = cells[nearest].red;
1744 color->green = cells[nearest].green;
1745 color->blue = cells[nearest].blue;
1746 rc = XAllocColor (dpy, cmap, color);
1748 else
1750 /* If allocation succeeded, and the allocated pixel color is not
1751 equal to a cached pixel color recorded earlier, there was a
1752 change in the colormap, so clear the color cache. */
1753 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
1754 XColor *cached_color;
1756 if (dpyinfo->color_cells
1757 && (cached_color = &dpyinfo->color_cells[color->pixel],
1758 (cached_color->red != color->red
1759 || cached_color->blue != color->blue
1760 || cached_color->green != color->green)))
1762 xfree (dpyinfo->color_cells);
1763 dpyinfo->color_cells = NULL;
1764 dpyinfo->ncolor_cells = 0;
1768 #ifdef DEBUG_X_COLORS
1769 if (rc)
1770 register_color (color->pixel);
1771 #endif /* DEBUG_X_COLORS */
1773 return rc;
1777 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
1778 exact match can't be allocated, try the nearest color available.
1779 Value is non-zero if successful. Set *COLOR to the color
1780 allocated. */
1783 x_alloc_nearest_color (f, cmap, color)
1784 struct frame *f;
1785 Colormap cmap;
1786 XColor *color;
1788 gamma_correct (f, color);
1789 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
1793 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
1794 It's necessary to do this instead of just using PIXEL directly to
1795 get color reference counts right. */
1797 unsigned long
1798 x_copy_color (f, pixel)
1799 struct frame *f;
1800 unsigned long pixel;
1802 XColor color;
1804 color.pixel = pixel;
1805 BLOCK_INPUT;
1806 x_query_color (f, &color);
1807 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
1808 UNBLOCK_INPUT;
1809 #ifdef DEBUG_X_COLORS
1810 register_color (pixel);
1811 #endif
1812 return color.pixel;
1816 /* Allocate color PIXEL on display DPY. PIXEL must already be allocated.
1817 It's necessary to do this instead of just using PIXEL directly to
1818 get color reference counts right. */
1820 unsigned long
1821 x_copy_dpy_color (dpy, cmap, pixel)
1822 Display *dpy;
1823 Colormap cmap;
1824 unsigned long pixel;
1826 XColor color;
1828 color.pixel = pixel;
1829 BLOCK_INPUT;
1830 XQueryColor (dpy, cmap, &color);
1831 XAllocColor (dpy, cmap, &color);
1832 UNBLOCK_INPUT;
1833 #ifdef DEBUG_X_COLORS
1834 register_color (pixel);
1835 #endif
1836 return color.pixel;
1840 /* Brightness beyond which a color won't have its highlight brightness
1841 boosted.
1843 Nominally, highlight colors for `3d' faces are calculated by
1844 brightening an object's color by a constant scale factor, but this
1845 doesn't yield good results for dark colors, so for colors who's
1846 brightness is less than this value (on a scale of 0-65535) have an
1847 use an additional additive factor.
1849 The value here is set so that the default menu-bar/mode-line color
1850 (grey75) will not have its highlights changed at all. */
1851 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
1854 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1855 or DELTA. Try a color with RGB values multiplied by FACTOR first.
1856 If this produces the same color as PIXEL, try a color where all RGB
1857 values have DELTA added. Return the allocated color in *PIXEL.
1858 DISPLAY is the X display, CMAP is the colormap to operate on.
1859 Value is non-zero if successful. */
1861 static int
1862 x_alloc_lighter_color (f, display, cmap, pixel, factor, delta)
1863 struct frame *f;
1864 Display *display;
1865 Colormap cmap;
1866 unsigned long *pixel;
1867 double factor;
1868 int delta;
1870 XColor color, new;
1871 long bright;
1872 int success_p;
1874 /* Get RGB color values. */
1875 color.pixel = *pixel;
1876 x_query_color (f, &color);
1878 /* Change RGB values by specified FACTOR. Avoid overflow! */
1879 xassert (factor >= 0);
1880 new.red = min (0xffff, factor * color.red);
1881 new.green = min (0xffff, factor * color.green);
1882 new.blue = min (0xffff, factor * color.blue);
1884 /* Calculate brightness of COLOR. */
1885 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
1887 /* We only boost colors that are darker than
1888 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
1889 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
1890 /* Make an additive adjustment to NEW, because it's dark enough so
1891 that scaling by FACTOR alone isn't enough. */
1893 /* How far below the limit this color is (0 - 1, 1 being darker). */
1894 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
1895 /* The additive adjustment. */
1896 int min_delta = delta * dimness * factor / 2;
1898 if (factor < 1)
1900 new.red = max (0, new.red - min_delta);
1901 new.green = max (0, new.green - min_delta);
1902 new.blue = max (0, new.blue - min_delta);
1904 else
1906 new.red = min (0xffff, min_delta + new.red);
1907 new.green = min (0xffff, min_delta + new.green);
1908 new.blue = min (0xffff, min_delta + new.blue);
1912 /* Try to allocate the color. */
1913 success_p = x_alloc_nearest_color (f, cmap, &new);
1914 if (success_p)
1916 if (new.pixel == *pixel)
1918 /* If we end up with the same color as before, try adding
1919 delta to the RGB values. */
1920 x_free_colors (f, &new.pixel, 1);
1922 new.red = min (0xffff, delta + color.red);
1923 new.green = min (0xffff, delta + color.green);
1924 new.blue = min (0xffff, delta + color.blue);
1925 success_p = x_alloc_nearest_color (f, cmap, &new);
1927 else
1928 success_p = 1;
1929 *pixel = new.pixel;
1932 return success_p;
1936 /* Set up the foreground color for drawing relief lines of glyph
1937 string S. RELIEF is a pointer to a struct relief containing the GC
1938 with which lines will be drawn. Use a color that is FACTOR or
1939 DELTA lighter or darker than the relief's background which is found
1940 in S->f->output_data.x->relief_background. If such a color cannot
1941 be allocated, use DEFAULT_PIXEL, instead. */
1943 static void
1944 x_setup_relief_color (f, relief, factor, delta, default_pixel)
1945 struct frame *f;
1946 struct relief *relief;
1947 double factor;
1948 int delta;
1949 unsigned long default_pixel;
1951 XGCValues xgcv;
1952 struct x_output *di = f->output_data.x;
1953 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
1954 unsigned long pixel;
1955 unsigned long background = di->relief_background;
1956 Colormap cmap = FRAME_X_COLORMAP (f);
1957 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
1958 Display *dpy = FRAME_X_DISPLAY (f);
1960 xgcv.graphics_exposures = False;
1961 xgcv.line_width = 1;
1963 /* Free previously allocated color. The color cell will be reused
1964 when it has been freed as many times as it was allocated, so this
1965 doesn't affect faces using the same colors. */
1966 if (relief->gc
1967 && relief->allocated_p)
1969 x_free_colors (f, &relief->pixel, 1);
1970 relief->allocated_p = 0;
1973 /* Allocate new color. */
1974 xgcv.foreground = default_pixel;
1975 pixel = background;
1976 if (dpyinfo->n_planes != 1
1977 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
1979 relief->allocated_p = 1;
1980 xgcv.foreground = relief->pixel = pixel;
1983 if (relief->gc == 0)
1985 xgcv.stipple = dpyinfo->gray;
1986 mask |= GCStipple;
1987 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
1989 else
1990 XChangeGC (dpy, relief->gc, mask, &xgcv);
1994 /* Set up colors for the relief lines around glyph string S. */
1996 static void
1997 x_setup_relief_colors (s)
1998 struct glyph_string *s;
2000 struct x_output *di = s->f->output_data.x;
2001 unsigned long color;
2003 if (s->face->use_box_color_for_shadows_p)
2004 color = s->face->box_color;
2005 else if (s->first_glyph->type == IMAGE_GLYPH
2006 && s->img->pixmap
2007 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2008 color = IMAGE_BACKGROUND (s->img, s->f, 0);
2009 else
2011 XGCValues xgcv;
2013 /* Get the background color of the face. */
2014 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
2015 color = xgcv.background;
2018 if (di->white_relief.gc == 0
2019 || color != di->relief_background)
2021 di->relief_background = color;
2022 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
2023 WHITE_PIX_DEFAULT (s->f));
2024 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
2025 BLACK_PIX_DEFAULT (s->f));
2030 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
2031 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
2032 to draw, it must be >= 0. RAISED_P non-zero means draw a raised
2033 relief. LEFT_P non-zero means draw a relief on the left side of
2034 the rectangle. RIGHT_P non-zero means draw a relief on the right
2035 side of the rectangle. CLIP_RECT is the clipping rectangle to use
2036 when drawing. */
2038 static void
2039 x_draw_relief_rect (f, left_x, top_y, right_x, bottom_y, width,
2040 raised_p, top_p, bot_p, left_p, right_p, clip_rect)
2041 struct frame *f;
2042 int left_x, top_y, right_x, bottom_y, width;
2043 int top_p, bot_p, left_p, right_p, raised_p;
2044 XRectangle *clip_rect;
2046 Display *dpy = FRAME_X_DISPLAY (f);
2047 Window window = FRAME_X_WINDOW (f);
2048 int i;
2049 GC gc;
2051 if (raised_p)
2052 gc = f->output_data.x->white_relief.gc;
2053 else
2054 gc = f->output_data.x->black_relief.gc;
2055 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2057 /* Top. */
2058 if (top_p)
2059 for (i = 0; i < width; ++i)
2060 XDrawLine (dpy, window, gc,
2061 left_x + i * left_p, top_y + i,
2062 right_x + 1 - i * right_p, top_y + i);
2064 /* Left. */
2065 if (left_p)
2066 for (i = 0; i < width; ++i)
2067 XDrawLine (dpy, window, gc,
2068 left_x + i, top_y + i, left_x + i, bottom_y - i + 1);
2070 XSetClipMask (dpy, gc, None);
2071 if (raised_p)
2072 gc = f->output_data.x->black_relief.gc;
2073 else
2074 gc = f->output_data.x->white_relief.gc;
2075 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2077 /* Bottom. */
2078 if (bot_p)
2079 for (i = 0; i < width; ++i)
2080 XDrawLine (dpy, window, gc,
2081 left_x + i * left_p, bottom_y - i,
2082 right_x + 1 - i * right_p, bottom_y - i);
2084 /* Right. */
2085 if (right_p)
2086 for (i = 0; i < width; ++i)
2087 XDrawLine (dpy, window, gc,
2088 right_x - i, top_y + i + 1, right_x - i, bottom_y - i);
2090 XSetClipMask (dpy, gc, None);
2094 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2095 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2096 draw, it must be >= 0. LEFT_P non-zero means draw a line on the
2097 left side of the rectangle. RIGHT_P non-zero means draw a line
2098 on the right side of the rectangle. CLIP_RECT is the clipping
2099 rectangle to use when drawing. */
2101 static void
2102 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2103 left_p, right_p, clip_rect)
2104 struct glyph_string *s;
2105 int left_x, top_y, right_x, bottom_y, width, left_p, right_p;
2106 XRectangle *clip_rect;
2108 XGCValues xgcv;
2110 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2111 XSetForeground (s->display, s->gc, s->face->box_color);
2112 XSetClipRectangles (s->display, s->gc, 0, 0, clip_rect, 1, Unsorted);
2114 /* Top. */
2115 XFillRectangle (s->display, s->window, s->gc,
2116 left_x, top_y, right_x - left_x + 1, width);
2118 /* Left. */
2119 if (left_p)
2120 XFillRectangle (s->display, s->window, s->gc,
2121 left_x, top_y, width, bottom_y - top_y + 1);
2123 /* Bottom. */
2124 XFillRectangle (s->display, s->window, s->gc,
2125 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2127 /* Right. */
2128 if (right_p)
2129 XFillRectangle (s->display, s->window, s->gc,
2130 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2132 XSetForeground (s->display, s->gc, xgcv.foreground);
2133 XSetClipMask (s->display, s->gc, None);
2137 /* Draw a box around glyph string S. */
2139 static void
2140 x_draw_glyph_string_box (s)
2141 struct glyph_string *s;
2143 int width, left_x, right_x, top_y, bottom_y, last_x, raised_p;
2144 int left_p, right_p;
2145 struct glyph *last_glyph;
2146 XRectangle clip_rect;
2148 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2149 ? WINDOW_RIGHT_EDGE_X (s->w)
2150 : window_box_right (s->w, s->area));
2152 /* The glyph that may have a right box line. */
2153 last_glyph = (s->cmp || s->img
2154 ? s->first_glyph
2155 : s->first_glyph + s->nchars - 1);
2157 width = eabs (s->face->box_line_width);
2158 raised_p = s->face->box == FACE_RAISED_BOX;
2159 left_x = s->x;
2160 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2161 ? last_x - 1
2162 : min (last_x, s->x + s->background_width) - 1);
2163 top_y = s->y;
2164 bottom_y = top_y + s->height - 1;
2166 left_p = (s->first_glyph->left_box_line_p
2167 || (s->hl == DRAW_MOUSE_FACE
2168 && (s->prev == NULL
2169 || s->prev->hl != s->hl)));
2170 right_p = (last_glyph->right_box_line_p
2171 || (s->hl == DRAW_MOUSE_FACE
2172 && (s->next == NULL
2173 || s->next->hl != s->hl)));
2175 get_glyph_string_clip_rect (s, &clip_rect);
2177 if (s->face->box == FACE_SIMPLE_BOX)
2178 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2179 left_p, right_p, &clip_rect);
2180 else
2182 x_setup_relief_colors (s);
2183 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2184 width, raised_p, 1, 1, left_p, right_p, &clip_rect);
2189 /* Draw foreground of image glyph string S. */
2191 static void
2192 x_draw_image_foreground (s)
2193 struct glyph_string *s;
2195 int x = s->x;
2196 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2198 /* If first glyph of S has a left box line, start drawing it to the
2199 right of that line. */
2200 if (s->face->box != FACE_NO_BOX
2201 && s->first_glyph->left_box_line_p
2202 && s->slice.x == 0)
2203 x += eabs (s->face->box_line_width);
2205 /* If there is a margin around the image, adjust x- and y-position
2206 by that margin. */
2207 if (s->slice.x == 0)
2208 x += s->img->hmargin;
2209 if (s->slice.y == 0)
2210 y += s->img->vmargin;
2212 if (s->img->pixmap)
2214 if (s->img->mask)
2216 /* We can't set both a clip mask and use XSetClipRectangles
2217 because the latter also sets a clip mask. We also can't
2218 trust on the shape extension to be available
2219 (XShapeCombineRegion). So, compute the rectangle to draw
2220 manually. */
2221 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2222 | GCFunction);
2223 XGCValues xgcv;
2224 XRectangle clip_rect, image_rect, r;
2226 xgcv.clip_mask = s->img->mask;
2227 xgcv.clip_x_origin = x;
2228 xgcv.clip_y_origin = y;
2229 xgcv.function = GXcopy;
2230 XChangeGC (s->display, s->gc, mask, &xgcv);
2232 get_glyph_string_clip_rect (s, &clip_rect);
2233 image_rect.x = x;
2234 image_rect.y = y;
2235 image_rect.width = s->slice.width;
2236 image_rect.height = s->slice.height;
2237 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2238 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2239 s->slice.x + r.x - x, s->slice.y + r.y - y,
2240 r.width, r.height, r.x, r.y);
2242 else
2244 XRectangle clip_rect, image_rect, r;
2246 get_glyph_string_clip_rect (s, &clip_rect);
2247 image_rect.x = x;
2248 image_rect.y = y;
2249 image_rect.width = s->slice.width;
2250 image_rect.height = s->slice.height;
2251 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2252 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2253 s->slice.x + r.x - x, s->slice.y + r.y - y,
2254 r.width, r.height, r.x, r.y);
2256 /* When the image has a mask, we can expect that at
2257 least part of a mouse highlight or a block cursor will
2258 be visible. If the image doesn't have a mask, make
2259 a block cursor visible by drawing a rectangle around
2260 the image. I believe it's looking better if we do
2261 nothing here for mouse-face. */
2262 if (s->hl == DRAW_CURSOR)
2264 int r = s->img->relief;
2265 if (r < 0) r = -r;
2266 XDrawRectangle (s->display, s->window, s->gc,
2267 x - r, y - r,
2268 s->slice.width + r*2 - 1,
2269 s->slice.height + r*2 - 1);
2273 else
2274 /* Draw a rectangle if image could not be loaded. */
2275 XDrawRectangle (s->display, s->window, s->gc, x, y,
2276 s->slice.width - 1, s->slice.height - 1);
2280 /* Draw a relief around the image glyph string S. */
2282 static void
2283 x_draw_image_relief (s)
2284 struct glyph_string *s;
2286 int x0, y0, x1, y1, thick, raised_p;
2287 XRectangle r;
2288 int x = s->x;
2289 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2291 /* If first glyph of S has a left box line, start drawing it to the
2292 right of that line. */
2293 if (s->face->box != FACE_NO_BOX
2294 && s->first_glyph->left_box_line_p
2295 && s->slice.x == 0)
2296 x += eabs (s->face->box_line_width);
2298 /* If there is a margin around the image, adjust x- and y-position
2299 by that margin. */
2300 if (s->slice.x == 0)
2301 x += s->img->hmargin;
2302 if (s->slice.y == 0)
2303 y += s->img->vmargin;
2305 if (s->hl == DRAW_IMAGE_SUNKEN
2306 || s->hl == DRAW_IMAGE_RAISED)
2308 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2309 raised_p = s->hl == DRAW_IMAGE_RAISED;
2311 else
2313 thick = eabs (s->img->relief);
2314 raised_p = s->img->relief > 0;
2317 x0 = x - thick;
2318 y0 = y - thick;
2319 x1 = x + s->slice.width + thick - 1;
2320 y1 = y + s->slice.height + thick - 1;
2322 x_setup_relief_colors (s);
2323 get_glyph_string_clip_rect (s, &r);
2324 x_draw_relief_rect (s->f, x0, y0, x1, y1, thick, raised_p,
2325 s->slice.y == 0,
2326 s->slice.y + s->slice.height == s->img->height,
2327 s->slice.x == 0,
2328 s->slice.x + s->slice.width == s->img->width,
2329 &r);
2333 /* Draw the foreground of image glyph string S to PIXMAP. */
2335 static void
2336 x_draw_image_foreground_1 (s, pixmap)
2337 struct glyph_string *s;
2338 Pixmap pixmap;
2340 int x = 0;
2341 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2343 /* If first glyph of S has a left box line, start drawing it to the
2344 right of that line. */
2345 if (s->face->box != FACE_NO_BOX
2346 && s->first_glyph->left_box_line_p
2347 && s->slice.x == 0)
2348 x += eabs (s->face->box_line_width);
2350 /* If there is a margin around the image, adjust x- and y-position
2351 by that margin. */
2352 if (s->slice.x == 0)
2353 x += s->img->hmargin;
2354 if (s->slice.y == 0)
2355 y += s->img->vmargin;
2357 if (s->img->pixmap)
2359 if (s->img->mask)
2361 /* We can't set both a clip mask and use XSetClipRectangles
2362 because the latter also sets a clip mask. We also can't
2363 trust on the shape extension to be available
2364 (XShapeCombineRegion). So, compute the rectangle to draw
2365 manually. */
2366 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2367 | GCFunction);
2368 XGCValues xgcv;
2370 xgcv.clip_mask = s->img->mask;
2371 xgcv.clip_x_origin = x - s->slice.x;
2372 xgcv.clip_y_origin = y - s->slice.y;
2373 xgcv.function = GXcopy;
2374 XChangeGC (s->display, s->gc, mask, &xgcv);
2376 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2377 s->slice.x, s->slice.y,
2378 s->slice.width, s->slice.height, x, y);
2379 XSetClipMask (s->display, s->gc, None);
2381 else
2383 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2384 s->slice.x, s->slice.y,
2385 s->slice.width, s->slice.height, x, y);
2387 /* When the image has a mask, we can expect that at
2388 least part of a mouse highlight or a block cursor will
2389 be visible. If the image doesn't have a mask, make
2390 a block cursor visible by drawing a rectangle around
2391 the image. I believe it's looking better if we do
2392 nothing here for mouse-face. */
2393 if (s->hl == DRAW_CURSOR)
2395 int r = s->img->relief;
2396 if (r < 0) r = -r;
2397 XDrawRectangle (s->display, s->window, s->gc, x - r, y - r,
2398 s->slice.width + r*2 - 1,
2399 s->slice.height + r*2 - 1);
2403 else
2404 /* Draw a rectangle if image could not be loaded. */
2405 XDrawRectangle (s->display, pixmap, s->gc, x, y,
2406 s->slice.width - 1, s->slice.height - 1);
2410 /* Draw part of the background of glyph string S. X, Y, W, and H
2411 give the rectangle to draw. */
2413 static void
2414 x_draw_glyph_string_bg_rect (s, x, y, w, h)
2415 struct glyph_string *s;
2416 int x, y, w, h;
2418 if (s->stippled_p)
2420 /* Fill background with a stipple pattern. */
2421 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2422 XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
2423 XSetFillStyle (s->display, s->gc, FillSolid);
2425 else
2426 x_clear_glyph_string_rect (s, x, y, w, h);
2430 /* Draw image glyph string S.
2432 s->y
2433 s->x +-------------------------
2434 | s->face->box
2436 | +-------------------------
2437 | | s->img->margin
2439 | | +-------------------
2440 | | | the image
2444 static void
2445 x_draw_image_glyph_string (s)
2446 struct glyph_string *s;
2448 int box_line_hwidth = eabs (s->face->box_line_width);
2449 int box_line_vwidth = max (s->face->box_line_width, 0);
2450 int height;
2451 Pixmap pixmap = None;
2453 height = s->height;
2454 if (s->slice.y == 0)
2455 height -= box_line_vwidth;
2456 if (s->slice.y + s->slice.height >= s->img->height)
2457 height -= box_line_vwidth;
2459 /* Fill background with face under the image. Do it only if row is
2460 taller than image or if image has a clip mask to reduce
2461 flickering. */
2462 s->stippled_p = s->face->stipple != 0;
2463 if (height > s->slice.height
2464 || s->img->hmargin
2465 || s->img->vmargin
2466 || s->img->mask
2467 || s->img->pixmap == 0
2468 || s->width != s->background_width)
2470 if (s->img->mask)
2472 /* Create a pixmap as large as the glyph string. Fill it
2473 with the background color. Copy the image to it, using
2474 its mask. Copy the temporary pixmap to the display. */
2475 Screen *screen = FRAME_X_SCREEN (s->f);
2476 int depth = DefaultDepthOfScreen (screen);
2478 /* Create a pixmap as large as the glyph string. */
2479 pixmap = XCreatePixmap (s->display, s->window,
2480 s->background_width,
2481 s->height, depth);
2483 /* Don't clip in the following because we're working on the
2484 pixmap. */
2485 XSetClipMask (s->display, s->gc, None);
2487 /* Fill the pixmap with the background color/stipple. */
2488 if (s->stippled_p)
2490 /* Fill background with a stipple pattern. */
2491 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
2492 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
2493 XFillRectangle (s->display, pixmap, s->gc,
2494 0, 0, s->background_width, s->height);
2495 XSetFillStyle (s->display, s->gc, FillSolid);
2496 XSetTSOrigin (s->display, s->gc, 0, 0);
2498 else
2500 XGCValues xgcv;
2501 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
2502 &xgcv);
2503 XSetForeground (s->display, s->gc, xgcv.background);
2504 XFillRectangle (s->display, pixmap, s->gc,
2505 0, 0, s->background_width, s->height);
2506 XSetForeground (s->display, s->gc, xgcv.foreground);
2509 else
2511 int x = s->x;
2512 int y = s->y;
2514 if (s->first_glyph->left_box_line_p
2515 && s->slice.x == 0)
2516 x += box_line_hwidth;
2518 if (s->slice.y == 0)
2519 y += box_line_vwidth;
2521 x_draw_glyph_string_bg_rect (s, x, y, s->background_width, height);
2524 s->background_filled_p = 1;
2527 /* Draw the foreground. */
2528 if (pixmap != None)
2530 x_draw_image_foreground_1 (s, pixmap);
2531 x_set_glyph_string_clipping (s);
2532 XCopyArea (s->display, pixmap, s->window, s->gc,
2533 0, 0, s->background_width, s->height, s->x, s->y);
2534 XFreePixmap (s->display, pixmap);
2536 else
2537 x_draw_image_foreground (s);
2539 /* If we must draw a relief around the image, do it. */
2540 if (s->img->relief
2541 || s->hl == DRAW_IMAGE_RAISED
2542 || s->hl == DRAW_IMAGE_SUNKEN)
2543 x_draw_image_relief (s);
2547 /* Draw stretch glyph string S. */
2549 static void
2550 x_draw_stretch_glyph_string (s)
2551 struct glyph_string *s;
2553 xassert (s->first_glyph->type == STRETCH_GLYPH);
2555 if (s->hl == DRAW_CURSOR
2556 && !x_stretch_cursor_p)
2558 /* If `x-stretch-block-cursor' is nil, don't draw a block cursor
2559 as wide as the stretch glyph. */
2560 int width, background_width = s->background_width;
2561 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2563 if (x < left_x)
2565 background_width -= left_x - x;
2566 x = left_x;
2568 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
2570 /* Draw cursor. */
2571 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
2573 /* Clear rest using the GC of the original non-cursor face. */
2574 if (width < background_width)
2576 int y = s->y;
2577 int w = background_width - width, h = s->height;
2578 XRectangle r;
2579 GC gc;
2581 x += width;
2582 if (s->row->mouse_face_p
2583 && cursor_in_mouse_face_p (s->w))
2585 x_set_mouse_face_gc (s);
2586 gc = s->gc;
2588 else
2589 gc = s->face->gc;
2591 get_glyph_string_clip_rect (s, &r);
2592 XSetClipRectangles (s->display, gc, 0, 0, &r, 1, Unsorted);
2594 if (s->face->stipple)
2596 /* Fill background with a stipple pattern. */
2597 XSetFillStyle (s->display, gc, FillOpaqueStippled);
2598 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2599 XSetFillStyle (s->display, gc, FillSolid);
2601 else
2603 XGCValues xgcv;
2604 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
2605 XSetForeground (s->display, gc, xgcv.background);
2606 XFillRectangle (s->display, s->window, gc, x, y, w, h);
2607 XSetForeground (s->display, gc, xgcv.foreground);
2611 else if (!s->background_filled_p)
2613 int background_width = s->background_width;
2614 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
2616 /* Don't draw into left margin, fringe or scrollbar area
2617 except for header line and mode line. */
2618 if (x < left_x && !s->row->mode_line_p)
2620 background_width -= left_x - x;
2621 x = left_x;
2623 if (background_width > 0)
2624 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
2627 s->background_filled_p = 1;
2631 /* Draw glyph string S. */
2633 static void
2634 x_draw_glyph_string (s)
2635 struct glyph_string *s;
2637 int relief_drawn_p = 0;
2639 /* If S draws into the background of its successors, draw the
2640 background of the successors first so that S can draw into it.
2641 This makes S->next use XDrawString instead of XDrawImageString. */
2642 if (s->next && s->right_overhang && !s->for_overlaps)
2644 int width;
2645 struct glyph_string *next;
2647 for (width = 0, next = s->next;
2648 next && width < s->right_overhang;
2649 width += next->width, next = next->next)
2650 if (next->first_glyph->type != IMAGE_GLYPH)
2652 x_set_glyph_string_gc (next);
2653 x_set_glyph_string_clipping (next);
2654 if (next->first_glyph->type == STRETCH_GLYPH)
2655 x_draw_stretch_glyph_string (next);
2656 else
2657 x_draw_glyph_string_background (next, 1);
2658 next->num_clips = 0;
2662 /* Set up S->gc, set clipping and draw S. */
2663 x_set_glyph_string_gc (s);
2665 /* Draw relief (if any) in advance for char/composition so that the
2666 glyph string can be drawn over it. */
2667 if (!s->for_overlaps
2668 && s->face->box != FACE_NO_BOX
2669 && (s->first_glyph->type == CHAR_GLYPH
2670 || s->first_glyph->type == COMPOSITE_GLYPH))
2673 x_set_glyph_string_clipping (s);
2674 x_draw_glyph_string_background (s, 1);
2675 x_draw_glyph_string_box (s);
2676 x_set_glyph_string_clipping (s);
2677 relief_drawn_p = 1;
2679 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
2680 && !s->clip_tail
2681 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
2682 || (s->next && s->next->hl != s->hl && s->right_overhang)))
2683 /* We must clip just this glyph. left_overhang part has already
2684 drawn when s->prev was drawn, and right_overhang part will be
2685 drawn later when s->next is drawn. */
2686 x_set_glyph_string_clipping_exactly (s, s);
2687 else
2688 x_set_glyph_string_clipping (s);
2690 switch (s->first_glyph->type)
2692 case IMAGE_GLYPH:
2693 x_draw_image_glyph_string (s);
2694 break;
2696 case STRETCH_GLYPH:
2697 x_draw_stretch_glyph_string (s);
2698 break;
2700 case CHAR_GLYPH:
2701 if (s->for_overlaps)
2702 s->background_filled_p = 1;
2703 else
2704 x_draw_glyph_string_background (s, 0);
2705 x_draw_glyph_string_foreground (s);
2706 break;
2708 case COMPOSITE_GLYPH:
2709 if (s->for_overlaps || (s->cmp_from > 0
2710 && ! s->first_glyph->u.cmp.automatic))
2711 s->background_filled_p = 1;
2712 else
2713 x_draw_glyph_string_background (s, 1);
2714 x_draw_composite_glyph_string_foreground (s);
2715 break;
2717 default:
2718 abort ();
2721 if (!s->for_overlaps)
2723 /* Draw underline. */
2724 if (s->face->underline_p)
2726 unsigned long thickness, position;
2727 int y;
2729 if (s->prev && s->prev->face->underline_p)
2731 /* We use the same underline style as the previous one. */
2732 thickness = s->prev->underline_thickness;
2733 position = s->prev->underline_position;
2735 else
2737 /* Get the underline thickness. Default is 1 pixel. */
2738 if (s->font && s->font->underline_thickness > 0)
2739 thickness = s->font->underline_thickness;
2740 else
2741 thickness = 1;
2742 if (x_underline_at_descent_line)
2743 position = (s->height - thickness) - (s->ybase - s->y);
2744 else
2746 /* Get the underline position. This is the recommended
2747 vertical offset in pixels from the baseline to the top of
2748 the underline. This is a signed value according to the
2749 specs, and its default is
2751 ROUND ((maximum descent) / 2), with
2752 ROUND(x) = floor (x + 0.5) */
2754 if (x_use_underline_position_properties
2755 && s->font && s->font->underline_position >= 0)
2756 position = s->font->underline_position;
2757 else if (s->font)
2758 position = (s->font->descent + 1) / 2;
2759 else
2760 position = underline_minimum_offset;
2762 position = max (position, underline_minimum_offset);
2764 /* Check the sanity of thickness and position. We should
2765 avoid drawing underline out of the current line area. */
2766 if (s->y + s->height <= s->ybase + position)
2767 position = (s->height - 1) - (s->ybase - s->y);
2768 if (s->y + s->height < s->ybase + position + thickness)
2769 thickness = (s->y + s->height) - (s->ybase + position);
2770 s->underline_thickness = thickness;
2771 s->underline_position = position;
2772 y = s->ybase + position;
2773 if (s->face->underline_defaulted_p)
2774 XFillRectangle (s->display, s->window, s->gc,
2775 s->x, y, s->width, thickness);
2776 else
2778 XGCValues xgcv;
2779 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2780 XSetForeground (s->display, s->gc, s->face->underline_color);
2781 XFillRectangle (s->display, s->window, s->gc,
2782 s->x, y, s->width, thickness);
2783 XSetForeground (s->display, s->gc, xgcv.foreground);
2787 /* Draw overline. */
2788 if (s->face->overline_p)
2790 unsigned long dy = 0, h = 1;
2792 if (s->face->overline_color_defaulted_p)
2793 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2794 s->width, h);
2795 else
2797 XGCValues xgcv;
2798 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2799 XSetForeground (s->display, s->gc, s->face->overline_color);
2800 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2801 s->width, h);
2802 XSetForeground (s->display, s->gc, xgcv.foreground);
2806 /* Draw strike-through. */
2807 if (s->face->strike_through_p)
2809 unsigned long h = 1;
2810 unsigned long dy = (s->height - h) / 2;
2812 if (s->face->strike_through_color_defaulted_p)
2813 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2814 s->width, h);
2815 else
2817 XGCValues xgcv;
2818 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2819 XSetForeground (s->display, s->gc, s->face->strike_through_color);
2820 XFillRectangle (s->display, s->window, s->gc, s->x, s->y + dy,
2821 s->width, h);
2822 XSetForeground (s->display, s->gc, xgcv.foreground);
2826 /* Draw relief if not yet drawn. */
2827 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
2828 x_draw_glyph_string_box (s);
2830 if (s->prev)
2832 struct glyph_string *prev;
2834 for (prev = s->prev; prev; prev = prev->prev)
2835 if (prev->hl != s->hl
2836 && prev->x + prev->width + prev->right_overhang > s->x)
2838 /* As prev was drawn while clipped to its own area, we
2839 must draw the right_overhang part using s->hl now. */
2840 enum draw_glyphs_face save = prev->hl;
2842 prev->hl = s->hl;
2843 x_set_glyph_string_gc (prev);
2844 x_set_glyph_string_clipping_exactly (s, prev);
2845 if (prev->first_glyph->type == CHAR_GLYPH)
2846 x_draw_glyph_string_foreground (prev);
2847 else
2848 x_draw_composite_glyph_string_foreground (prev);
2849 XSetClipMask (prev->display, prev->gc, None);
2850 prev->hl = save;
2851 prev->num_clips = 0;
2855 if (s->next)
2857 struct glyph_string *next;
2859 for (next = s->next; next; next = next->next)
2860 if (next->hl != s->hl
2861 && next->x - next->left_overhang < s->x + s->width)
2863 /* As next will be drawn while clipped to its own area,
2864 we must draw the left_overhang part using s->hl now. */
2865 enum draw_glyphs_face save = next->hl;
2867 next->hl = s->hl;
2868 x_set_glyph_string_gc (next);
2869 x_set_glyph_string_clipping_exactly (s, next);
2870 if (next->first_glyph->type == CHAR_GLYPH)
2871 x_draw_glyph_string_foreground (next);
2872 else
2873 x_draw_composite_glyph_string_foreground (next);
2874 XSetClipMask (next->display, next->gc, None);
2875 next->hl = save;
2876 next->num_clips = 0;
2881 /* Reset clipping. */
2882 XSetClipMask (s->display, s->gc, None);
2883 s->num_clips = 0;
2886 /* Shift display to make room for inserted glyphs. */
2888 void
2889 x_shift_glyphs_for_insert (f, x, y, width, height, shift_by)
2890 struct frame *f;
2891 int x, y, width, height, shift_by;
2893 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
2894 f->output_data.x->normal_gc,
2895 x, y, width, height,
2896 x + shift_by, y);
2899 /* Delete N glyphs at the nominal cursor position. Not implemented
2900 for X frames. */
2902 static void
2903 x_delete_glyphs (f, n)
2904 struct frame *f;
2905 register int n;
2907 abort ();
2911 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
2912 If they are <= 0, this is probably an error. */
2914 void
2915 x_clear_area (dpy, window, x, y, width, height, exposures)
2916 Display *dpy;
2917 Window window;
2918 int x, y;
2919 int width, height;
2920 int exposures;
2922 xassert (width > 0 && height > 0);
2923 XClearArea (dpy, window, x, y, width, height, exposures);
2927 /* Clear an entire frame. */
2929 static void
2930 x_clear_frame (struct frame *f)
2932 /* Clearing the frame will erase any cursor, so mark them all as no
2933 longer visible. */
2934 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
2935 output_cursor.hpos = output_cursor.vpos = 0;
2936 output_cursor.x = -1;
2938 /* We don't set the output cursor here because there will always
2939 follow an explicit cursor_to. */
2940 BLOCK_INPUT;
2941 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
2943 /* We have to clear the scroll bars, too. If we have changed
2944 colors or something like that, then they should be notified. */
2945 x_scroll_bar_clear (f);
2947 XFlush (FRAME_X_DISPLAY (f));
2949 UNBLOCK_INPUT;
2954 /* Invert the middle quarter of the frame for .15 sec. */
2956 /* We use the select system call to do the waiting, so we have to make
2957 sure it's available. If it isn't, we just won't do visual bells. */
2959 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
2962 /* Subtract the `struct timeval' values X and Y, storing the result in
2963 *RESULT. Return 1 if the difference is negative, otherwise 0. */
2965 static int
2966 timeval_subtract (result, x, y)
2967 struct timeval *result, x, y;
2969 /* Perform the carry for the later subtraction by updating y. This
2970 is safer because on some systems the tv_sec member is unsigned. */
2971 if (x.tv_usec < y.tv_usec)
2973 int nsec = (y.tv_usec - x.tv_usec) / 1000000 + 1;
2974 y.tv_usec -= 1000000 * nsec;
2975 y.tv_sec += nsec;
2978 if (x.tv_usec - y.tv_usec > 1000000)
2980 int nsec = (y.tv_usec - x.tv_usec) / 1000000;
2981 y.tv_usec += 1000000 * nsec;
2982 y.tv_sec -= nsec;
2985 /* Compute the time remaining to wait. tv_usec is certainly
2986 positive. */
2987 result->tv_sec = x.tv_sec - y.tv_sec;
2988 result->tv_usec = x.tv_usec - y.tv_usec;
2990 /* Return indication of whether the result should be considered
2991 negative. */
2992 return x.tv_sec < y.tv_sec;
2995 void
2996 XTflash (f)
2997 struct frame *f;
2999 BLOCK_INPUT;
3002 GC gc;
3004 /* Create a GC that will use the GXxor function to flip foreground
3005 pixels into background pixels. */
3007 XGCValues values;
3009 values.function = GXxor;
3010 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3011 ^ FRAME_BACKGROUND_PIXEL (f));
3013 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3014 GCFunction | GCForeground, &values);
3018 /* Get the height not including a menu bar widget. */
3019 int height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, FRAME_LINES (f));
3020 /* Height of each line to flash. */
3021 int flash_height = FRAME_LINE_HEIGHT (f);
3022 /* These will be the left and right margins of the rectangles. */
3023 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3024 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3026 int width;
3028 /* Don't flash the area between a scroll bar and the frame
3029 edge it is next to. */
3030 switch (FRAME_VERTICAL_SCROLL_BAR_TYPE (f))
3032 case vertical_scroll_bar_left:
3033 flash_left += VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3034 break;
3036 case vertical_scroll_bar_right:
3037 flash_right -= VERTICAL_SCROLL_BAR_WIDTH_TRIM;
3038 break;
3040 default:
3041 break;
3044 width = flash_right - flash_left;
3046 /* If window is tall, flash top and bottom line. */
3047 if (height > 3 * FRAME_LINE_HEIGHT (f))
3049 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3050 flash_left,
3051 (FRAME_INTERNAL_BORDER_WIDTH (f)
3052 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
3053 width, flash_height);
3054 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3055 flash_left,
3056 (height - flash_height
3057 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3058 width, flash_height);
3060 else
3061 /* If it is short, flash it all. */
3062 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3063 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3064 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3066 x_flush (f);
3069 struct timeval wakeup;
3071 EMACS_GET_TIME (wakeup);
3073 /* Compute time to wait until, propagating carry from usecs. */
3074 wakeup.tv_usec += 150000;
3075 wakeup.tv_sec += (wakeup.tv_usec / 1000000);
3076 wakeup.tv_usec %= 1000000;
3078 /* Keep waiting until past the time wakeup or any input gets
3079 available. */
3080 while (! detect_input_pending ())
3082 struct timeval current;
3083 struct timeval timeout;
3085 EMACS_GET_TIME (current);
3087 /* Break if result would be negative. */
3088 if (timeval_subtract (&current, wakeup, current))
3089 break;
3091 /* How long `select' should wait. */
3092 timeout.tv_sec = 0;
3093 timeout.tv_usec = 10000;
3095 /* Try to wait that long--but we might wake up sooner. */
3096 select (0, NULL, NULL, NULL, &timeout);
3100 /* If window is tall, flash top and bottom line. */
3101 if (height > 3 * FRAME_LINE_HEIGHT (f))
3103 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3104 flash_left,
3105 (FRAME_INTERNAL_BORDER_WIDTH (f)
3106 + FRAME_TOOL_BAR_LINES (f) * FRAME_LINE_HEIGHT (f)),
3107 width, flash_height);
3108 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3109 flash_left,
3110 (height - flash_height
3111 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3112 width, flash_height);
3114 else
3115 /* If it is short, flash it all. */
3116 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3117 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3118 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3120 XFreeGC (FRAME_X_DISPLAY (f), gc);
3121 x_flush (f);
3125 UNBLOCK_INPUT;
3128 #endif /* defined (HAVE_TIMEVAL) && defined (HAVE_SELECT) */
3131 /* Make audible bell. */
3133 void
3134 XTring_bell ()
3136 struct frame *f = SELECTED_FRAME ();
3138 if (FRAME_X_DISPLAY (f))
3140 #if defined (HAVE_TIMEVAL) && defined (HAVE_SELECT)
3141 if (visible_bell)
3142 XTflash (f);
3143 else
3144 #endif
3146 BLOCK_INPUT;
3147 XBell (FRAME_X_DISPLAY (f), 0);
3148 XFlush (FRAME_X_DISPLAY (f));
3149 UNBLOCK_INPUT;
3155 /* Specify how many text lines, from the top of the window,
3156 should be affected by insert-lines and delete-lines operations.
3157 This, and those operations, are used only within an update
3158 that is bounded by calls to x_update_begin and x_update_end. */
3160 static void
3161 XTset_terminal_window (n)
3162 register int n;
3164 /* This function intentionally left blank. */
3169 /***********************************************************************
3170 Line Dance
3171 ***********************************************************************/
3173 /* Perform an insert-lines or delete-lines operation, inserting N
3174 lines or deleting -N lines at vertical position VPOS. */
3176 static void
3177 x_ins_del_lines (f, vpos, n)
3178 struct frame *f;
3179 int vpos, n;
3181 abort ();
3185 /* Scroll part of the display as described by RUN. */
3187 static void
3188 x_scroll_run (w, run)
3189 struct window *w;
3190 struct run *run;
3192 struct frame *f = XFRAME (w->frame);
3193 int x, y, width, height, from_y, to_y, bottom_y;
3195 /* Get frame-relative bounding box of the text display area of W,
3196 without mode lines. Include in this box the left and right
3197 fringe of W. */
3198 window_box (w, -1, &x, &y, &width, &height);
3200 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3201 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3202 bottom_y = y + height;
3204 if (to_y < from_y)
3206 /* Scrolling up. Make sure we don't copy part of the mode
3207 line at the bottom. */
3208 if (from_y + run->height > bottom_y)
3209 height = bottom_y - from_y;
3210 else
3211 height = run->height;
3213 else
3215 /* Scolling down. Make sure we don't copy over the mode line.
3216 at the bottom. */
3217 if (to_y + run->height > bottom_y)
3218 height = bottom_y - to_y;
3219 else
3220 height = run->height;
3223 BLOCK_INPUT;
3225 /* Cursor off. Will be switched on again in x_update_window_end. */
3226 updated_window = w;
3227 x_clear_cursor (w);
3229 XCopyArea (FRAME_X_DISPLAY (f),
3230 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3231 f->output_data.x->normal_gc,
3232 x, from_y,
3233 width, height,
3234 x, to_y);
3236 UNBLOCK_INPUT;
3241 /***********************************************************************
3242 Exposure Events
3243 ***********************************************************************/
3246 static void
3247 frame_highlight (f)
3248 struct frame *f;
3250 /* We used to only do this if Vx_no_window_manager was non-nil, but
3251 the ICCCM (section 4.1.6) says that the window's border pixmap
3252 and border pixel are window attributes which are "private to the
3253 client", so we can always change it to whatever we want. */
3254 BLOCK_INPUT;
3255 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3256 f->output_data.x->border_pixel);
3257 UNBLOCK_INPUT;
3258 x_update_cursor (f, 1);
3259 x_set_frame_alpha (f);
3262 static void
3263 frame_unhighlight (f)
3264 struct frame *f;
3266 /* We used to only do this if Vx_no_window_manager was non-nil, but
3267 the ICCCM (section 4.1.6) says that the window's border pixmap
3268 and border pixel are window attributes which are "private to the
3269 client", so we can always change it to whatever we want. */
3270 BLOCK_INPUT;
3271 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3272 f->output_data.x->border_tile);
3273 UNBLOCK_INPUT;
3274 x_update_cursor (f, 1);
3275 x_set_frame_alpha (f);
3278 /* The focus has changed. Update the frames as necessary to reflect
3279 the new situation. Note that we can't change the selected frame
3280 here, because the Lisp code we are interrupting might become confused.
3281 Each event gets marked with the frame in which it occurred, so the
3282 Lisp code can tell when the switch took place by examining the events. */
3284 static void
3285 x_new_focus_frame (dpyinfo, frame)
3286 struct x_display_info *dpyinfo;
3287 struct frame *frame;
3289 struct frame *old_focus = dpyinfo->x_focus_frame;
3291 if (frame != dpyinfo->x_focus_frame)
3293 /* Set this before calling other routines, so that they see
3294 the correct value of x_focus_frame. */
3295 dpyinfo->x_focus_frame = frame;
3297 if (old_focus && old_focus->auto_lower)
3298 x_lower_frame (old_focus);
3300 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
3301 pending_autoraise_frame = dpyinfo->x_focus_frame;
3302 else
3303 pending_autoraise_frame = 0;
3306 x_frame_rehighlight (dpyinfo);
3309 /* Handle FocusIn and FocusOut state changes for FRAME.
3310 If FRAME has focus and there exists more than one frame, puts
3311 a FOCUS_IN_EVENT into *BUFP. */
3313 static void
3314 x_focus_changed (type, state, dpyinfo, frame, bufp)
3315 int type;
3316 int state;
3317 struct x_display_info *dpyinfo;
3318 struct frame *frame;
3319 struct input_event *bufp;
3321 if (type == FocusIn)
3323 if (dpyinfo->x_focus_event_frame != frame)
3325 x_new_focus_frame (dpyinfo, frame);
3326 dpyinfo->x_focus_event_frame = frame;
3328 /* Don't stop displaying the initial startup message
3329 for a switch-frame event we don't need. */
3330 if (NILP (Vterminal_frame)
3331 && CONSP (Vframe_list)
3332 && !NILP (XCDR (Vframe_list)))
3334 bufp->kind = FOCUS_IN_EVENT;
3335 XSETFRAME (bufp->frame_or_window, frame);
3339 frame->output_data.x->focus_state |= state;
3341 #ifdef HAVE_X_I18N
3342 if (FRAME_XIC (frame))
3343 XSetICFocus (FRAME_XIC (frame));
3344 #endif
3346 else if (type == FocusOut)
3348 frame->output_data.x->focus_state &= ~state;
3350 if (dpyinfo->x_focus_event_frame == frame)
3352 dpyinfo->x_focus_event_frame = 0;
3353 x_new_focus_frame (dpyinfo, 0);
3356 #ifdef HAVE_X_I18N
3357 if (FRAME_XIC (frame))
3358 XUnsetICFocus (FRAME_XIC (frame));
3359 #endif
3363 /* The focus may have changed. Figure out if it is a real focus change,
3364 by checking both FocusIn/Out and Enter/LeaveNotify events.
3366 Returns FOCUS_IN_EVENT event in *BUFP. */
3368 static void
3369 x_detect_focus_change (dpyinfo, event, bufp)
3370 struct x_display_info *dpyinfo;
3371 XEvent *event;
3372 struct input_event *bufp;
3374 struct frame *frame;
3376 frame = x_any_window_to_frame (dpyinfo, event->xany.window);
3377 if (! frame)
3378 return;
3380 switch (event->type)
3382 case EnterNotify:
3383 case LeaveNotify:
3385 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
3386 int focus_state
3387 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
3389 if (event->xcrossing.detail != NotifyInferior
3390 && event->xcrossing.focus
3391 && ! (focus_state & FOCUS_EXPLICIT))
3392 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
3393 FOCUS_IMPLICIT,
3394 dpyinfo, frame, bufp);
3396 break;
3398 case FocusIn:
3399 case FocusOut:
3400 x_focus_changed (event->type,
3401 (event->xfocus.detail == NotifyPointer ?
3402 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
3403 dpyinfo, frame, bufp);
3404 break;
3406 case ClientMessage:
3407 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
3409 enum xembed_message msg = event->xclient.data.l[1];
3410 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
3411 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
3413 break;
3418 /* Handle an event saying the mouse has moved out of an Emacs frame. */
3420 void
3421 x_mouse_leave (dpyinfo)
3422 struct x_display_info *dpyinfo;
3424 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
3427 /* The focus has changed, or we have redirected a frame's focus to
3428 another frame (this happens when a frame uses a surrogate
3429 mini-buffer frame). Shift the highlight as appropriate.
3431 The FRAME argument doesn't necessarily have anything to do with which
3432 frame is being highlighted or un-highlighted; we only use it to find
3433 the appropriate X display info. */
3435 static void
3436 XTframe_rehighlight (frame)
3437 struct frame *frame;
3439 x_frame_rehighlight (FRAME_X_DISPLAY_INFO (frame));
3442 static void
3443 x_frame_rehighlight (dpyinfo)
3444 struct x_display_info *dpyinfo;
3446 struct frame *old_highlight = dpyinfo->x_highlight_frame;
3448 if (dpyinfo->x_focus_frame)
3450 dpyinfo->x_highlight_frame
3451 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
3452 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
3453 : dpyinfo->x_focus_frame);
3454 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
3456 FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame) = Qnil;
3457 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
3460 else
3461 dpyinfo->x_highlight_frame = 0;
3463 if (dpyinfo->x_highlight_frame != old_highlight)
3465 if (old_highlight)
3466 frame_unhighlight (old_highlight);
3467 if (dpyinfo->x_highlight_frame)
3468 frame_highlight (dpyinfo->x_highlight_frame);
3474 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
3476 /* Initialize mode_switch_bit and modifier_meaning. */
3477 static void
3478 x_find_modifier_meanings (dpyinfo)
3479 struct x_display_info *dpyinfo;
3481 int min_code, max_code;
3482 KeySym *syms;
3483 int syms_per_code;
3484 XModifierKeymap *mods;
3486 dpyinfo->meta_mod_mask = 0;
3487 dpyinfo->shift_lock_mask = 0;
3488 dpyinfo->alt_mod_mask = 0;
3489 dpyinfo->super_mod_mask = 0;
3490 dpyinfo->hyper_mod_mask = 0;
3492 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
3494 syms = XGetKeyboardMapping (dpyinfo->display,
3495 min_code, max_code - min_code + 1,
3496 &syms_per_code);
3497 mods = XGetModifierMapping (dpyinfo->display);
3499 /* Scan the modifier table to see which modifier bits the Meta and
3500 Alt keysyms are on. */
3502 int row, col; /* The row and column in the modifier table. */
3503 int found_alt_or_meta;
3505 for (row = 3; row < 8; row++)
3507 found_alt_or_meta = 0;
3508 for (col = 0; col < mods->max_keypermod; col++)
3510 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
3512 /* Zeroes are used for filler. Skip them. */
3513 if (code == 0)
3514 continue;
3516 /* Are any of this keycode's keysyms a meta key? */
3518 int code_col;
3520 for (code_col = 0; code_col < syms_per_code; code_col++)
3522 int sym = syms[((code - min_code) * syms_per_code) + code_col];
3524 switch (sym)
3526 case XK_Meta_L:
3527 case XK_Meta_R:
3528 found_alt_or_meta = 1;
3529 dpyinfo->meta_mod_mask |= (1 << row);
3530 break;
3532 case XK_Alt_L:
3533 case XK_Alt_R:
3534 found_alt_or_meta = 1;
3535 dpyinfo->alt_mod_mask |= (1 << row);
3536 break;
3538 case XK_Hyper_L:
3539 case XK_Hyper_R:
3540 if (!found_alt_or_meta)
3541 dpyinfo->hyper_mod_mask |= (1 << row);
3542 code_col = syms_per_code;
3543 col = mods->max_keypermod;
3544 break;
3546 case XK_Super_L:
3547 case XK_Super_R:
3548 if (!found_alt_or_meta)
3549 dpyinfo->super_mod_mask |= (1 << row);
3550 code_col = syms_per_code;
3551 col = mods->max_keypermod;
3552 break;
3554 case XK_Shift_Lock:
3555 /* Ignore this if it's not on the lock modifier. */
3556 if (!found_alt_or_meta && ((1 << row) == LockMask))
3557 dpyinfo->shift_lock_mask = LockMask;
3558 code_col = syms_per_code;
3559 col = mods->max_keypermod;
3560 break;
3568 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
3569 if (! dpyinfo->meta_mod_mask)
3571 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
3572 dpyinfo->alt_mod_mask = 0;
3575 /* If some keys are both alt and meta,
3576 make them just meta, not alt. */
3577 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
3579 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
3582 XFree ((char *) syms);
3583 XFreeModifiermap (mods);
3586 /* Convert between the modifier bits X uses and the modifier bits
3587 Emacs uses. */
3589 unsigned int
3590 x_x_to_emacs_modifiers (dpyinfo, state)
3591 struct x_display_info *dpyinfo;
3592 unsigned int state;
3594 EMACS_UINT mod_meta = meta_modifier;
3595 EMACS_UINT mod_alt = alt_modifier;
3596 EMACS_UINT mod_hyper = hyper_modifier;
3597 EMACS_UINT mod_super = super_modifier;
3598 Lisp_Object tem;
3600 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3601 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3602 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3603 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3604 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3605 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3606 tem = Fget (Vx_super_keysym, Qmodifier_value);
3607 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3610 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
3611 | ((state & ControlMask) ? ctrl_modifier : 0)
3612 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
3613 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
3614 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
3615 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
3618 static unsigned int
3619 x_emacs_to_x_modifiers (dpyinfo, state)
3620 struct x_display_info *dpyinfo;
3621 unsigned int state;
3623 EMACS_UINT mod_meta = meta_modifier;
3624 EMACS_UINT mod_alt = alt_modifier;
3625 EMACS_UINT mod_hyper = hyper_modifier;
3626 EMACS_UINT mod_super = super_modifier;
3628 Lisp_Object tem;
3630 tem = Fget (Vx_alt_keysym, Qmodifier_value);
3631 if (! EQ (tem, Qnil)) mod_alt = XUINT (tem);
3632 tem = Fget (Vx_meta_keysym, Qmodifier_value);
3633 if (! EQ (tem, Qnil)) mod_meta = XUINT (tem);
3634 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
3635 if (! EQ (tem, Qnil)) mod_hyper = XUINT (tem);
3636 tem = Fget (Vx_super_keysym, Qmodifier_value);
3637 if (! EQ (tem, Qnil)) mod_super = XUINT (tem);
3640 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
3641 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
3642 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
3643 | ((state & shift_modifier) ? ShiftMask : 0)
3644 | ((state & ctrl_modifier) ? ControlMask : 0)
3645 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
3648 /* Convert a keysym to its name. */
3650 char *
3651 x_get_keysym_name (keysym)
3652 KeySym keysym;
3654 char *value;
3656 BLOCK_INPUT;
3657 value = XKeysymToString (keysym);
3658 UNBLOCK_INPUT;
3660 return value;
3665 /* Mouse clicks and mouse movement. Rah. */
3667 /* Prepare a mouse-event in *RESULT for placement in the input queue.
3669 If the event is a button press, then note that we have grabbed
3670 the mouse. */
3672 static Lisp_Object
3673 construct_mouse_click (result, event, f)
3674 struct input_event *result;
3675 XButtonEvent *event;
3676 struct frame *f;
3678 /* Make the event type NO_EVENT; we'll change that when we decide
3679 otherwise. */
3680 result->kind = MOUSE_CLICK_EVENT;
3681 result->code = event->button - Button1;
3682 result->timestamp = event->time;
3683 result->modifiers = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f),
3684 event->state)
3685 | (event->type == ButtonRelease
3686 ? up_modifier
3687 : down_modifier));
3689 XSETINT (result->x, event->x);
3690 XSETINT (result->y, event->y);
3691 XSETFRAME (result->frame_or_window, f);
3692 result->arg = Qnil;
3693 return Qnil;
3697 /* Function to report a mouse movement to the mainstream Emacs code.
3698 The input handler calls this.
3700 We have received a mouse movement event, which is given in *event.
3701 If the mouse is over a different glyph than it was last time, tell
3702 the mainstream emacs code by setting mouse_moved. If not, ask for
3703 another motion event, so we can check again the next time it moves. */
3705 static XMotionEvent last_mouse_motion_event;
3706 static Lisp_Object last_mouse_motion_frame;
3708 static int
3709 note_mouse_movement (frame, event)
3710 FRAME_PTR frame;
3711 XMotionEvent *event;
3713 last_mouse_movement_time = event->time;
3714 last_mouse_motion_event = *event;
3715 XSETFRAME (last_mouse_motion_frame, frame);
3717 if (!FRAME_X_OUTPUT (frame))
3718 return 0;
3720 if (event->window != FRAME_X_WINDOW (frame))
3722 frame->mouse_moved = 1;
3723 last_mouse_scroll_bar = Qnil;
3724 note_mouse_highlight (frame, -1, -1);
3725 last_mouse_glyph_frame = 0;
3726 return 1;
3730 /* Has the mouse moved off the glyph it was on at the last sighting? */
3731 if (frame != last_mouse_glyph_frame
3732 || event->x < last_mouse_glyph.x
3733 || event->x >= last_mouse_glyph.x + last_mouse_glyph.width
3734 || event->y < last_mouse_glyph.y
3735 || event->y >= last_mouse_glyph.y + last_mouse_glyph.height)
3737 frame->mouse_moved = 1;
3738 last_mouse_scroll_bar = Qnil;
3739 note_mouse_highlight (frame, event->x, event->y);
3740 /* Remember which glyph we're now on. */
3741 remember_mouse_glyph (frame, event->x, event->y, &last_mouse_glyph);
3742 last_mouse_glyph_frame = frame;
3743 return 1;
3746 return 0;
3750 /************************************************************************
3751 Mouse Face
3752 ************************************************************************/
3754 static void
3755 redo_mouse_highlight ()
3757 if (!NILP (last_mouse_motion_frame)
3758 && FRAME_LIVE_P (XFRAME (last_mouse_motion_frame)))
3759 note_mouse_highlight (XFRAME (last_mouse_motion_frame),
3760 last_mouse_motion_event.x,
3761 last_mouse_motion_event.y);
3766 /* Return the current position of the mouse.
3767 *FP should be a frame which indicates which display to ask about.
3769 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
3770 and *PART to the frame, window, and scroll bar part that the mouse
3771 is over. Set *X and *Y to the portion and whole of the mouse's
3772 position on the scroll bar.
3774 If the mouse movement started elsewhere, set *FP to the frame the
3775 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
3776 the mouse is over.
3778 Set *TIME to the server time-stamp for the time at which the mouse
3779 was at this position.
3781 Don't store anything if we don't have a valid set of values to report.
3783 This clears the mouse_moved flag, so we can wait for the next mouse
3784 movement. */
3786 static void
3787 XTmouse_position (fp, insist, bar_window, part, x, y, time)
3788 FRAME_PTR *fp;
3789 int insist;
3790 Lisp_Object *bar_window;
3791 enum scroll_bar_part *part;
3792 Lisp_Object *x, *y;
3793 unsigned long *time;
3795 FRAME_PTR f1;
3797 BLOCK_INPUT;
3799 if (! NILP (last_mouse_scroll_bar) && insist == 0)
3800 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time);
3801 else
3803 Window root;
3804 int root_x, root_y;
3806 Window dummy_window;
3807 int dummy;
3809 Lisp_Object frame, tail;
3811 /* Clear the mouse-moved flag for every frame on this display. */
3812 FOR_EACH_FRAME (tail, frame)
3813 if (FRAME_X_P (XFRAME (frame))
3814 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
3815 XFRAME (frame)->mouse_moved = 0;
3817 last_mouse_scroll_bar = Qnil;
3819 /* Figure out which root window we're on. */
3820 XQueryPointer (FRAME_X_DISPLAY (*fp),
3821 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
3823 /* The root window which contains the pointer. */
3824 &root,
3826 /* Trash which we can't trust if the pointer is on
3827 a different screen. */
3828 &dummy_window,
3830 /* The position on that root window. */
3831 &root_x, &root_y,
3833 /* More trash we can't trust. */
3834 &dummy, &dummy,
3836 /* Modifier keys and pointer buttons, about which
3837 we don't care. */
3838 (unsigned int *) &dummy);
3840 /* Now we have a position on the root; find the innermost window
3841 containing the pointer. */
3843 Window win, child;
3844 int win_x, win_y;
3845 int parent_x = 0, parent_y = 0;
3847 win = root;
3849 /* XTranslateCoordinates can get errors if the window
3850 structure is changing at the same time this function
3851 is running. So at least we must not crash from them. */
3853 x_catch_errors (FRAME_X_DISPLAY (*fp));
3855 if (FRAME_X_DISPLAY_INFO (*fp)->grabbed && last_mouse_frame
3856 && FRAME_LIVE_P (last_mouse_frame))
3858 /* If mouse was grabbed on a frame, give coords for that frame
3859 even if the mouse is now outside it. */
3860 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3862 /* From-window, to-window. */
3863 root, FRAME_X_WINDOW (last_mouse_frame),
3865 /* From-position, to-position. */
3866 root_x, root_y, &win_x, &win_y,
3868 /* Child of win. */
3869 &child);
3870 f1 = last_mouse_frame;
3872 else
3874 while (1)
3876 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
3878 /* From-window, to-window. */
3879 root, win,
3881 /* From-position, to-position. */
3882 root_x, root_y, &win_x, &win_y,
3884 /* Child of win. */
3885 &child);
3887 if (child == None || child == win)
3888 break;
3890 win = child;
3891 parent_x = win_x;
3892 parent_y = win_y;
3895 /* Now we know that:
3896 win is the innermost window containing the pointer
3897 (XTC says it has no child containing the pointer),
3898 win_x and win_y are the pointer's position in it
3899 (XTC did this the last time through), and
3900 parent_x and parent_y are the pointer's position in win's parent.
3901 (They are what win_x and win_y were when win was child.
3902 If win is the root window, it has no parent, and
3903 parent_{x,y} are invalid, but that's okay, because we'll
3904 never use them in that case.) */
3906 /* Is win one of our frames? */
3907 f1 = x_any_window_to_frame (FRAME_X_DISPLAY_INFO (*fp), win);
3909 #ifdef USE_X_TOOLKIT
3910 /* If we end up with the menu bar window, say it's not
3911 on the frame. */
3912 if (f1 != NULL
3913 && f1->output_data.x->menubar_widget
3914 && win == XtWindow (f1->output_data.x->menubar_widget))
3915 f1 = NULL;
3916 #endif /* USE_X_TOOLKIT */
3919 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
3920 f1 = 0;
3922 x_uncatch_errors ();
3924 /* If not, is it one of our scroll bars? */
3925 if (! f1)
3927 struct scroll_bar *bar;
3929 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win);
3931 if (bar)
3933 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
3934 win_x = parent_x;
3935 win_y = parent_y;
3939 if (f1 == 0 && insist > 0)
3940 f1 = SELECTED_FRAME ();
3942 if (f1)
3944 /* Ok, we found a frame. Store all the values.
3945 last_mouse_glyph is a rectangle used to reduce the
3946 generation of mouse events. To not miss any motion
3947 events, we must divide the frame into rectangles of the
3948 size of the smallest character that could be displayed
3949 on it, i.e. into the same rectangles that matrices on
3950 the frame are divided into. */
3952 remember_mouse_glyph (f1, win_x, win_y, &last_mouse_glyph);
3953 last_mouse_glyph_frame = f1;
3955 *bar_window = Qnil;
3956 *part = 0;
3957 *fp = f1;
3958 XSETINT (*x, win_x);
3959 XSETINT (*y, win_y);
3960 *time = last_mouse_movement_time;
3965 UNBLOCK_INPUT;
3970 /***********************************************************************
3971 Scroll bars
3972 ***********************************************************************/
3974 /* Scroll bar support. */
3976 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
3977 manages it.
3978 This can be called in GC, so we have to make sure to strip off mark
3979 bits. */
3981 static struct scroll_bar *
3982 x_window_to_scroll_bar (display, window_id)
3983 Display *display;
3984 Window window_id;
3986 Lisp_Object tail;
3988 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3989 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
3990 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
3992 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
3994 Lisp_Object frame, bar, condemned;
3996 frame = XCAR (tail);
3997 /* All elements of Vframe_list should be frames. */
3998 if (! FRAMEP (frame))
3999 abort ();
4001 if (! FRAME_X_P (XFRAME (frame)))
4002 continue;
4004 /* Scan this frame's scroll bar list for a scroll bar with the
4005 right window ID. */
4006 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4007 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4008 /* This trick allows us to search both the ordinary and
4009 condemned scroll bar lists with one loop. */
4010 ! NILP (bar) || (bar = condemned,
4011 condemned = Qnil,
4012 ! NILP (bar));
4013 bar = XSCROLL_BAR (bar)->next)
4014 if (XSCROLL_BAR (bar)->x_window == window_id &&
4015 FRAME_X_DISPLAY (XFRAME (frame)) == display)
4016 return XSCROLL_BAR (bar);
4019 return 0;
4023 #if defined USE_LUCID
4025 /* Return the Lucid menu bar WINDOW is part of. Return null
4026 if WINDOW is not part of a menu bar. */
4028 static Widget
4029 x_window_to_menu_bar (window)
4030 Window window;
4032 Lisp_Object tail;
4034 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
4036 if (FRAME_X_P (XFRAME (XCAR (tail))))
4038 Lisp_Object frame = XCAR (tail);
4039 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
4041 if (menu_bar && xlwmenu_window_p (menu_bar, window))
4042 return menu_bar;
4046 return NULL;
4049 #endif /* USE_LUCID */
4052 /************************************************************************
4053 Toolkit scroll bars
4054 ************************************************************************/
4056 #ifdef USE_TOOLKIT_SCROLL_BARS
4058 static void x_scroll_bar_to_input_event P_ ((XEvent *, struct input_event *));
4059 static void x_send_scroll_bar_event P_ ((Lisp_Object, int, int, int));
4060 static void x_create_toolkit_scroll_bar P_ ((struct frame *,
4061 struct scroll_bar *));
4062 static void x_set_toolkit_scroll_bar_thumb P_ ((struct scroll_bar *,
4063 int, int, int));
4066 /* Lisp window being scrolled. Set when starting to interact with
4067 a toolkit scroll bar, reset to nil when ending the interaction. */
4069 static Lisp_Object window_being_scrolled;
4071 /* Last scroll bar part sent in xm_scroll_callback. */
4073 static int last_scroll_bar_part;
4075 /* Whether this is an Xaw with arrow-scrollbars. This should imply
4076 that movements of 1/20 of the screen size are mapped to up/down. */
4078 #ifndef USE_GTK
4079 /* Id of action hook installed for scroll bars. */
4081 static XtActionHookId action_hook_id;
4083 static Boolean xaw3d_arrow_scroll;
4085 /* Whether the drag scrolling maintains the mouse at the top of the
4086 thumb. If not, resizing the thumb needs to be done more carefully
4087 to avoid jerkyness. */
4089 static Boolean xaw3d_pick_top;
4091 /* Action hook installed via XtAppAddActionHook when toolkit scroll
4092 bars are used.. The hook is responsible for detecting when
4093 the user ends an interaction with the scroll bar, and generates
4094 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
4096 static void
4097 xt_action_hook (widget, client_data, action_name, event, params,
4098 num_params)
4099 Widget widget;
4100 XtPointer client_data;
4101 String action_name;
4102 XEvent *event;
4103 String *params;
4104 Cardinal *num_params;
4106 int scroll_bar_p;
4107 char *end_action;
4109 #ifdef USE_MOTIF
4110 scroll_bar_p = XmIsScrollBar (widget);
4111 end_action = "Release";
4112 #else /* !USE_MOTIF i.e. use Xaw */
4113 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
4114 end_action = "EndScroll";
4115 #endif /* USE_MOTIF */
4117 if (scroll_bar_p
4118 && strcmp (action_name, end_action) == 0
4119 && WINDOWP (window_being_scrolled))
4121 struct window *w;
4123 x_send_scroll_bar_event (window_being_scrolled,
4124 scroll_bar_end_scroll, 0, 0);
4125 w = XWINDOW (window_being_scrolled);
4127 if (!NILP (XSCROLL_BAR (w->vertical_scroll_bar)->dragging))
4129 XSCROLL_BAR (w->vertical_scroll_bar)->dragging = Qnil;
4130 /* The thumb size is incorrect while dragging: fix it. */
4131 set_vertical_scroll_bar (w);
4133 window_being_scrolled = Qnil;
4134 last_scroll_bar_part = -1;
4136 /* Xt timeouts no longer needed. */
4137 toolkit_scroll_bar_interaction = 0;
4140 #endif /* not USE_GTK */
4142 /* A vector of windows used for communication between
4143 x_send_scroll_bar_event and x_scroll_bar_to_input_event. */
4145 static struct window **scroll_bar_windows;
4146 static int scroll_bar_windows_size;
4149 /* Send a client message with message type Xatom_Scrollbar for a
4150 scroll action to the frame of WINDOW. PART is a value identifying
4151 the part of the scroll bar that was clicked on. PORTION is the
4152 amount to scroll of a whole of WHOLE. */
4154 static void
4155 x_send_scroll_bar_event (window, part, portion, whole)
4156 Lisp_Object window;
4157 int part, portion, whole;
4159 XEvent event;
4160 XClientMessageEvent *ev = (XClientMessageEvent *) &event;
4161 struct window *w = XWINDOW (window);
4162 struct frame *f = XFRAME (w->frame);
4163 int i;
4165 BLOCK_INPUT;
4167 /* Construct a ClientMessage event to send to the frame. */
4168 ev->type = ClientMessage;
4169 ev->message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_Scrollbar;
4170 ev->display = FRAME_X_DISPLAY (f);
4171 ev->window = FRAME_X_WINDOW (f);
4172 ev->format = 32;
4174 /* We can only transfer 32 bits in the XClientMessageEvent, which is
4175 not enough to store a pointer or Lisp_Object on a 64 bit system.
4176 So, store the window in scroll_bar_windows and pass the index
4177 into that array in the event. */
4178 for (i = 0; i < scroll_bar_windows_size; ++i)
4179 if (scroll_bar_windows[i] == NULL)
4180 break;
4182 if (i == scroll_bar_windows_size)
4184 int new_size = max (10, 2 * scroll_bar_windows_size);
4185 size_t nbytes = new_size * sizeof *scroll_bar_windows;
4186 size_t old_nbytes = scroll_bar_windows_size * sizeof *scroll_bar_windows;
4188 scroll_bar_windows = (struct window **) xrealloc (scroll_bar_windows,
4189 nbytes);
4190 bzero (&scroll_bar_windows[i], nbytes - old_nbytes);
4191 scroll_bar_windows_size = new_size;
4194 scroll_bar_windows[i] = w;
4195 ev->data.l[0] = (long) i;
4196 ev->data.l[1] = (long) part;
4197 ev->data.l[2] = (long) 0;
4198 ev->data.l[3] = (long) portion;
4199 ev->data.l[4] = (long) whole;
4201 /* Make Xt timeouts work while the scroll bar is active. */
4202 toolkit_scroll_bar_interaction = 1;
4203 #ifdef USE_X_TOOLKIT
4204 x_activate_timeout_atimer ();
4205 #endif
4207 /* Setting the event mask to zero means that the message will
4208 be sent to the client that created the window, and if that
4209 window no longer exists, no event will be sent. */
4210 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
4211 UNBLOCK_INPUT;
4215 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
4216 in *IEVENT. */
4218 static void
4219 x_scroll_bar_to_input_event (event, ievent)
4220 XEvent *event;
4221 struct input_event *ievent;
4223 XClientMessageEvent *ev = (XClientMessageEvent *) event;
4224 Lisp_Object window;
4225 struct frame *f;
4226 struct window *w;
4228 w = scroll_bar_windows[ev->data.l[0]];
4229 scroll_bar_windows[ev->data.l[0]] = NULL;
4231 XSETWINDOW (window, w);
4232 f = XFRAME (w->frame);
4234 ievent->kind = SCROLL_BAR_CLICK_EVENT;
4235 ievent->frame_or_window = window;
4236 ievent->arg = Qnil;
4237 #ifdef USE_GTK
4238 ievent->timestamp = CurrentTime;
4239 #else
4240 ievent->timestamp = XtLastTimestampProcessed (FRAME_X_DISPLAY (f));
4241 #endif
4242 ievent->part = ev->data.l[1];
4243 ievent->code = ev->data.l[2];
4244 ievent->x = make_number ((int) ev->data.l[3]);
4245 ievent->y = make_number ((int) ev->data.l[4]);
4246 ievent->modifiers = 0;
4250 #ifdef USE_MOTIF
4252 /* Minimum and maximum values used for Motif scroll bars. */
4254 #define XM_SB_MAX 10000000
4257 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
4258 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
4259 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
4261 static void
4262 xm_scroll_callback (widget, client_data, call_data)
4263 Widget widget;
4264 XtPointer client_data, call_data;
4266 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4267 XmScrollBarCallbackStruct *cs = (XmScrollBarCallbackStruct *) call_data;
4268 int part = -1, whole = 0, portion = 0;
4270 switch (cs->reason)
4272 case XmCR_DECREMENT:
4273 bar->dragging = Qnil;
4274 part = scroll_bar_up_arrow;
4275 break;
4277 case XmCR_INCREMENT:
4278 bar->dragging = Qnil;
4279 part = scroll_bar_down_arrow;
4280 break;
4282 case XmCR_PAGE_DECREMENT:
4283 bar->dragging = Qnil;
4284 part = scroll_bar_above_handle;
4285 break;
4287 case XmCR_PAGE_INCREMENT:
4288 bar->dragging = Qnil;
4289 part = scroll_bar_below_handle;
4290 break;
4292 case XmCR_TO_TOP:
4293 bar->dragging = Qnil;
4294 part = scroll_bar_to_top;
4295 break;
4297 case XmCR_TO_BOTTOM:
4298 bar->dragging = Qnil;
4299 part = scroll_bar_to_bottom;
4300 break;
4302 case XmCR_DRAG:
4304 int slider_size;
4306 /* Get the slider size. */
4307 BLOCK_INPUT;
4308 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
4309 UNBLOCK_INPUT;
4311 whole = XM_SB_MAX - slider_size;
4312 portion = min (cs->value, whole);
4313 part = scroll_bar_handle;
4314 bar->dragging = make_number (cs->value);
4316 break;
4318 case XmCR_VALUE_CHANGED:
4319 break;
4322 if (part >= 0)
4324 window_being_scrolled = bar->window;
4325 last_scroll_bar_part = part;
4326 x_send_scroll_bar_event (bar->window, part, portion, whole);
4330 #elif defined USE_GTK
4332 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
4333 bar widget. DATA is a pointer to the scroll_bar structure. */
4335 static void
4336 xg_scroll_callback (widget, data)
4337 GtkRange *widget;
4338 gpointer data;
4340 struct scroll_bar *bar = (struct scroll_bar *) data;
4341 gdouble previous;
4342 gdouble position;
4343 gdouble *p;
4344 int diff;
4346 int part = -1, whole = 0, portion = 0;
4347 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (widget));
4349 position = gtk_adjustment_get_value (adj);
4351 p = g_object_get_data (G_OBJECT (widget), XG_LAST_SB_DATA);
4352 if (! p)
4354 p = (gdouble*) xmalloc (sizeof (gdouble));
4355 *p = XG_SB_MIN;
4356 g_object_set_data (G_OBJECT (widget), XG_LAST_SB_DATA, p);
4359 previous = *p;
4360 *p = position;
4362 if (xg_ignore_gtk_scrollbar) return;
4364 diff = (int) (position - previous);
4366 if (diff == (int) adj->step_increment)
4368 part = scroll_bar_down_arrow;
4369 bar->dragging = Qnil;
4371 else if (-diff == (int) adj->step_increment)
4373 part = scroll_bar_up_arrow;
4374 bar->dragging = Qnil;
4376 else if (diff == (int) adj->page_increment)
4378 part = scroll_bar_below_handle;
4379 bar->dragging = Qnil;
4381 else if (-diff == (int) adj->page_increment)
4383 part = scroll_bar_above_handle;
4384 bar->dragging = Qnil;
4386 else
4388 part = scroll_bar_handle;
4389 whole = adj->upper - adj->page_size;
4390 portion = min ((int)position, whole);
4391 bar->dragging = make_number ((int)portion);
4394 if (part >= 0)
4396 window_being_scrolled = bar->window;
4397 last_scroll_bar_part = part;
4398 x_send_scroll_bar_event (bar->window, part, portion, whole);
4402 #else /* not USE_GTK and not USE_MOTIF */
4404 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
4405 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
4406 scroll bar struct. CALL_DATA is a pointer to a float saying where
4407 the thumb is. */
4409 static void
4410 xaw_jump_callback (widget, client_data, call_data)
4411 Widget widget;
4412 XtPointer client_data, call_data;
4414 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4415 float top = *(float *) call_data;
4416 float shown;
4417 int whole, portion, height;
4418 int part;
4420 /* Get the size of the thumb, a value between 0 and 1. */
4421 BLOCK_INPUT;
4422 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
4423 UNBLOCK_INPUT;
4425 whole = 10000000;
4426 portion = shown < 1 ? top * whole : 0;
4428 if (shown < 1 && (eabs (top + shown - 1) < 1.0/height))
4429 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
4430 the bottom, so we force the scrolling whenever we see that we're
4431 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
4432 we try to ensure that we always stay two pixels away from the
4433 bottom). */
4434 part = scroll_bar_down_arrow;
4435 else
4436 part = scroll_bar_handle;
4438 window_being_scrolled = bar->window;
4439 bar->dragging = make_number (portion);
4440 last_scroll_bar_part = part;
4441 x_send_scroll_bar_event (bar->window, part, portion, whole);
4445 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
4446 i.e. line or page up or down. WIDGET is the Xaw scroll bar
4447 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
4448 the scroll bar. CALL_DATA is an integer specifying the action that
4449 has taken place. Its magnitude is in the range 0..height of the
4450 scroll bar. Negative values mean scroll towards buffer start.
4451 Values < height of scroll bar mean line-wise movement. */
4453 static void
4454 xaw_scroll_callback (widget, client_data, call_data)
4455 Widget widget;
4456 XtPointer client_data, call_data;
4458 struct scroll_bar *bar = (struct scroll_bar *) client_data;
4459 /* The position really is stored cast to a pointer. */
4460 int position = (long) call_data;
4461 Dimension height;
4462 int part;
4464 /* Get the height of the scroll bar. */
4465 BLOCK_INPUT;
4466 XtVaGetValues (widget, XtNheight, &height, NULL);
4467 UNBLOCK_INPUT;
4469 if (eabs (position) >= height)
4470 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
4472 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
4473 it maps line-movement to call_data = max(5, height/20). */
4474 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
4475 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
4476 else
4477 part = scroll_bar_move_ratio;
4479 window_being_scrolled = bar->window;
4480 bar->dragging = Qnil;
4481 last_scroll_bar_part = part;
4482 x_send_scroll_bar_event (bar->window, part, position, height);
4485 #endif /* not USE_GTK and not USE_MOTIF */
4487 #define SCROLL_BAR_NAME "verticalScrollBar"
4489 /* Create the widget for scroll bar BAR on frame F. Record the widget
4490 and X window of the scroll bar in BAR. */
4492 #ifdef USE_GTK
4493 static void
4494 x_create_toolkit_scroll_bar (f, bar)
4495 struct frame *f;
4496 struct scroll_bar *bar;
4498 char *scroll_bar_name = SCROLL_BAR_NAME;
4500 BLOCK_INPUT;
4501 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
4502 scroll_bar_name);
4503 UNBLOCK_INPUT;
4506 #else /* not USE_GTK */
4508 static void
4509 x_create_toolkit_scroll_bar (f, bar)
4510 struct frame *f;
4511 struct scroll_bar *bar;
4513 Window xwindow;
4514 Widget widget;
4515 Arg av[20];
4516 int ac = 0;
4517 char *scroll_bar_name = SCROLL_BAR_NAME;
4518 unsigned long pixel;
4520 BLOCK_INPUT;
4522 #ifdef USE_MOTIF
4523 /* Set resources. Create the widget. */
4524 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4525 XtSetArg (av[ac], XmNminimum, 0); ++ac;
4526 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
4527 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
4528 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
4529 XtSetArg (av[ac], XmNincrement, 1); ++ac;
4530 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
4532 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4533 if (pixel != -1)
4535 XtSetArg (av[ac], XmNforeground, pixel);
4536 ++ac;
4539 pixel = f->output_data.x->scroll_bar_background_pixel;
4540 if (pixel != -1)
4542 XtSetArg (av[ac], XmNbackground, pixel);
4543 ++ac;
4546 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
4547 scroll_bar_name, av, ac);
4549 /* Add one callback for everything that can happen. */
4550 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
4551 (XtPointer) bar);
4552 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
4553 (XtPointer) bar);
4554 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
4555 (XtPointer) bar);
4556 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
4557 (XtPointer) bar);
4558 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
4559 (XtPointer) bar);
4560 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
4561 (XtPointer) bar);
4562 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
4563 (XtPointer) bar);
4565 /* Realize the widget. Only after that is the X window created. */
4566 XtRealizeWidget (widget);
4568 /* Set the cursor to an arrow. I didn't find a resource to do that.
4569 And I'm wondering why it hasn't an arrow cursor by default. */
4570 XDefineCursor (XtDisplay (widget), XtWindow (widget),
4571 f->output_data.x->nontext_cursor);
4573 #else /* !USE_MOTIF i.e. use Xaw */
4575 /* Set resources. Create the widget. The background of the
4576 Xaw3d scroll bar widget is a little bit light for my taste.
4577 We don't alter it here to let users change it according
4578 to their taste with `emacs*verticalScrollBar.background: xxx'. */
4579 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
4580 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
4581 /* For smoother scrolling with Xaw3d -sm */
4582 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
4584 pixel = f->output_data.x->scroll_bar_foreground_pixel;
4585 if (pixel != -1)
4587 XtSetArg (av[ac], XtNforeground, pixel);
4588 ++ac;
4591 pixel = f->output_data.x->scroll_bar_background_pixel;
4592 if (pixel != -1)
4594 XtSetArg (av[ac], XtNbackground, pixel);
4595 ++ac;
4598 /* Top/bottom shadow colors. */
4600 /* Allocate them, if necessary. */
4601 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
4603 pixel = f->output_data.x->scroll_bar_background_pixel;
4604 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
4605 &pixel, 1.2, 0x8000))
4606 pixel = -1;
4607 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
4609 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4611 pixel = f->output_data.x->scroll_bar_background_pixel;
4612 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f),
4613 &pixel, 0.6, 0x4000))
4614 pixel = -1;
4615 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
4618 #ifdef XtNbeNiceToColormap
4619 /* Tell the toolkit about them. */
4620 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
4621 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
4622 /* We tried to allocate a color for the top/bottom shadow, and
4623 failed, so tell Xaw3d to use dithering instead. */
4625 XtSetArg (av[ac], XtNbeNiceToColormap, True);
4626 ++ac;
4628 else
4629 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
4630 be more consistent with other emacs 3d colors, and since Xaw3d is
4631 not good at dealing with allocation failure. */
4633 /* This tells Xaw3d to use real colors instead of dithering for
4634 the shadows. */
4635 XtSetArg (av[ac], XtNbeNiceToColormap, False);
4636 ++ac;
4638 /* Specify the colors. */
4639 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
4640 if (pixel != -1)
4642 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
4643 ++ac;
4645 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
4646 if (pixel != -1)
4648 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
4649 ++ac;
4652 #endif
4654 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
4655 f->output_data.x->edit_widget, av, ac);
4658 char *initial = "";
4659 char *val = initial;
4660 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
4661 #ifdef XtNarrowScrollbars
4662 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
4663 #endif
4664 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
4665 if (xaw3d_arrow_scroll || val == initial)
4666 { /* ARROW_SCROLL */
4667 xaw3d_arrow_scroll = True;
4668 /* Isn't that just a personal preference ? --Stef */
4669 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
4673 /* Define callbacks. */
4674 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
4675 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
4676 (XtPointer) bar);
4678 /* Realize the widget. Only after that is the X window created. */
4679 XtRealizeWidget (widget);
4681 #endif /* !USE_MOTIF */
4683 /* Install an action hook that lets us detect when the user
4684 finishes interacting with a scroll bar. */
4685 if (action_hook_id == 0)
4686 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
4688 /* Remember X window and widget in the scroll bar vector. */
4689 SET_SCROLL_BAR_X_WIDGET (bar, widget);
4690 xwindow = XtWindow (widget);
4691 bar->x_window = xwindow;
4693 UNBLOCK_INPUT;
4695 #endif /* not USE_GTK */
4698 /* Set the thumb size and position of scroll bar BAR. We are currently
4699 displaying PORTION out of a whole WHOLE, and our position POSITION. */
4701 #ifdef USE_GTK
4702 static void
4703 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4704 struct scroll_bar *bar;
4705 int portion, position, whole;
4707 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
4710 #else /* not USE_GTK */
4711 static void
4712 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole)
4713 struct scroll_bar *bar;
4714 int portion, position, whole;
4716 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4717 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4718 float top, shown;
4720 BLOCK_INPUT;
4722 #ifdef USE_MOTIF
4724 /* We use an estimate of 30 chars per line rather than the real
4725 `portion' value. This has the disadvantage that the thumb size
4726 is not very representative, but it makes our life a lot easier.
4727 Otherwise, we have to constantly adjust the thumb size, which
4728 we can't always do quickly enough: while dragging, the size of
4729 the thumb might prevent the user from dragging the thumb all the
4730 way to the end. but Motif and some versions of Xaw3d don't allow
4731 updating the thumb size while dragging. Also, even if we can update
4732 its size, the update will often happen too late.
4733 If you don't believe it, check out revision 1.650 of xterm.c to see
4734 what hoops we were going through and the still poor behavior we got. */
4735 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
4736 /* When the thumb is at the bottom, position == whole.
4737 So we need to increase `whole' to make space for the thumb. */
4738 whole += portion;
4740 if (whole <= 0)
4741 top = 0, shown = 1;
4742 else
4744 top = (float) position / whole;
4745 shown = (float) portion / whole;
4748 if (NILP (bar->dragging))
4750 int size, value;
4752 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
4753 is the scroll bar's maximum and MIN is the scroll bar's minimum
4754 value. */
4755 size = shown * XM_SB_MAX;
4756 size = min (size, XM_SB_MAX);
4757 size = max (size, 1);
4759 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
4760 value = top * XM_SB_MAX;
4761 value = min (value, XM_SB_MAX - size);
4763 XmScrollBarSetValues (widget, value, size, 0, 0, False);
4765 #else /* !USE_MOTIF i.e. use Xaw */
4767 if (whole == 0)
4768 top = 0, shown = 1;
4769 else
4771 top = (float) position / whole;
4772 shown = (float) portion / whole;
4776 float old_top, old_shown;
4777 Dimension height;
4778 XtVaGetValues (widget,
4779 XtNtopOfThumb, &old_top,
4780 XtNshown, &old_shown,
4781 XtNheight, &height,
4782 NULL);
4784 /* Massage the top+shown values. */
4785 if (NILP (bar->dragging) || last_scroll_bar_part == scroll_bar_down_arrow)
4786 top = max (0, min (1, top));
4787 else
4788 top = old_top;
4789 /* Keep two pixels available for moving the thumb down. */
4790 shown = max (0, min (1 - top - (2.0 / height), shown));
4792 /* If the call to XawScrollbarSetThumb below doesn't seem to work,
4793 check that your system's configuration file contains a define
4794 for `NARROWPROTO'. See s/freebsd.h for an example. */
4795 if (top != old_top || shown != old_shown)
4797 if (NILP (bar->dragging))
4798 XawScrollbarSetThumb (widget, top, shown);
4799 else
4801 /* Try to make the scrolling a tad smoother. */
4802 if (!xaw3d_pick_top)
4803 shown = min (shown, old_shown);
4805 XawScrollbarSetThumb (widget, top, shown);
4809 #endif /* !USE_MOTIF */
4811 UNBLOCK_INPUT;
4813 #endif /* not USE_GTK */
4815 #endif /* USE_TOOLKIT_SCROLL_BARS */
4819 /************************************************************************
4820 Scroll bars, general
4821 ************************************************************************/
4823 /* Create a scroll bar and return the scroll bar vector for it. W is
4824 the Emacs window on which to create the scroll bar. TOP, LEFT,
4825 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
4826 scroll bar. */
4828 static struct scroll_bar *
4829 x_scroll_bar_create (w, top, left, width, height)
4830 struct window *w;
4831 int top, left, width, height;
4833 struct frame *f = XFRAME (w->frame);
4834 struct scroll_bar *bar
4835 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
4837 BLOCK_INPUT;
4839 #ifdef USE_TOOLKIT_SCROLL_BARS
4840 x_create_toolkit_scroll_bar (f, bar);
4841 #else /* not USE_TOOLKIT_SCROLL_BARS */
4843 XSetWindowAttributes a;
4844 unsigned long mask;
4845 Window window;
4847 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
4848 if (a.background_pixel == -1)
4849 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
4851 a.event_mask = (ButtonPressMask | ButtonReleaseMask
4852 | ButtonMotionMask | PointerMotionHintMask
4853 | ExposureMask);
4854 a.cursor = FRAME_X_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
4856 mask = (CWBackPixel | CWEventMask | CWCursor);
4858 /* Clear the area of W that will serve as a scroll bar. This is
4859 for the case that a window has been split horizontally. In
4860 this case, no clear_frame is generated to reduce flickering. */
4861 if (width > 0 && height > 0)
4862 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4863 left, top, width,
4864 window_box_height (w), False);
4866 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4867 /* Position and size of scroll bar. */
4868 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4869 top,
4870 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4871 height,
4872 /* Border width, depth, class, and visual. */
4874 CopyFromParent,
4875 CopyFromParent,
4876 CopyFromParent,
4877 /* Attributes. */
4878 mask, &a);
4879 bar->x_window = window;
4881 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4883 XSETWINDOW (bar->window, w);
4884 bar->top = top;
4885 bar->left = left;
4886 bar->width = width;
4887 bar->height = height;
4888 bar->start = 0;
4889 bar->end = 0;
4890 bar->dragging = Qnil;
4891 bar->fringe_extended_p = 0;
4893 /* Add bar to its frame's list of scroll bars. */
4894 bar->next = FRAME_SCROLL_BARS (f);
4895 bar->prev = Qnil;
4896 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
4897 if (!NILP (bar->next))
4898 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
4900 /* Map the window/widget. */
4901 #ifdef USE_TOOLKIT_SCROLL_BARS
4903 #ifdef USE_GTK
4904 xg_update_scrollbar_pos (f,
4905 bar->x_window,
4906 top,
4907 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4908 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4909 max (height, 1));
4910 xg_show_scroll_bar (bar->x_window);
4911 #else /* not USE_GTK */
4912 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
4913 XtConfigureWidget (scroll_bar,
4914 left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
4915 top,
4916 width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
4917 max (height, 1), 0);
4918 XtMapWidget (scroll_bar);
4919 #endif /* not USE_GTK */
4921 #else /* not USE_TOOLKIT_SCROLL_BARS */
4922 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
4923 #endif /* not USE_TOOLKIT_SCROLL_BARS */
4925 UNBLOCK_INPUT;
4926 return bar;
4930 #ifndef USE_TOOLKIT_SCROLL_BARS
4932 /* Draw BAR's handle in the proper position.
4934 If the handle is already drawn from START to END, don't bother
4935 redrawing it, unless REBUILD is non-zero; in that case, always
4936 redraw it. (REBUILD is handy for drawing the handle after expose
4937 events.)
4939 Normally, we want to constrain the start and end of the handle to
4940 fit inside its rectangle, but if the user is dragging the scroll
4941 bar handle, we want to let them drag it down all the way, so that
4942 the bar's top is as far down as it goes; otherwise, there's no way
4943 to move to the very end of the buffer. */
4945 static void
4946 x_scroll_bar_set_handle (bar, start, end, rebuild)
4947 struct scroll_bar *bar;
4948 int start, end;
4949 int rebuild;
4951 int dragging = ! NILP (bar->dragging);
4952 Window w = bar->x_window;
4953 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4954 GC gc = f->output_data.x->normal_gc;
4956 /* If the display is already accurate, do nothing. */
4957 if (! rebuild
4958 && start == bar->start
4959 && end == bar->end)
4960 return;
4962 BLOCK_INPUT;
4965 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
4966 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
4967 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
4969 /* Make sure the values are reasonable, and try to preserve
4970 the distance between start and end. */
4972 int length = end - start;
4974 if (start < 0)
4975 start = 0;
4976 else if (start > top_range)
4977 start = top_range;
4978 end = start + length;
4980 if (end < start)
4981 end = start;
4982 else if (end > top_range && ! dragging)
4983 end = top_range;
4986 /* Store the adjusted setting in the scroll bar. */
4987 bar->start = start;
4988 bar->end = end;
4990 /* Clip the end position, just for display. */
4991 if (end > top_range)
4992 end = top_range;
4994 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
4995 below top positions, to make sure the handle is always at least
4996 that many pixels tall. */
4997 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
4999 /* Draw the empty space above the handle. Note that we can't clear
5000 zero-height areas; that means "clear to end of window." */
5001 if (0 < start)
5002 x_clear_area (FRAME_X_DISPLAY (f), w,
5003 /* x, y, width, height, and exposures. */
5004 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5005 VERTICAL_SCROLL_BAR_TOP_BORDER,
5006 inside_width, start,
5007 False);
5009 /* Change to proper foreground color if one is specified. */
5010 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5011 XSetForeground (FRAME_X_DISPLAY (f), gc,
5012 f->output_data.x->scroll_bar_foreground_pixel);
5014 /* Draw the handle itself. */
5015 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
5016 /* x, y, width, height */
5017 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5018 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
5019 inside_width, end - start);
5021 /* Restore the foreground color of the GC if we changed it above. */
5022 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5023 XSetForeground (FRAME_X_DISPLAY (f), gc,
5024 FRAME_FOREGROUND_PIXEL (f));
5026 /* Draw the empty space below the handle. Note that we can't
5027 clear zero-height areas; that means "clear to end of window." */
5028 if (end < inside_height)
5029 x_clear_area (FRAME_X_DISPLAY (f), w,
5030 /* x, y, width, height, and exposures. */
5031 VERTICAL_SCROLL_BAR_LEFT_BORDER,
5032 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
5033 inside_width, inside_height - end,
5034 False);
5038 UNBLOCK_INPUT;
5041 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5043 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
5044 nil. */
5046 static void
5047 x_scroll_bar_remove (bar)
5048 struct scroll_bar *bar;
5050 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5051 BLOCK_INPUT;
5053 #ifdef USE_TOOLKIT_SCROLL_BARS
5054 #ifdef USE_GTK
5055 xg_remove_scroll_bar (f, bar->x_window);
5056 #else /* not USE_GTK */
5057 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
5058 #endif /* not USE_GTK */
5059 #else
5060 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
5061 #endif
5063 /* Disassociate this scroll bar from its window. */
5064 XWINDOW (bar->window)->vertical_scroll_bar = Qnil;
5066 UNBLOCK_INPUT;
5070 /* Set the handle of the vertical scroll bar for WINDOW to indicate
5071 that we are displaying PORTION characters out of a total of WHOLE
5072 characters, starting at POSITION. If WINDOW has no scroll bar,
5073 create one. */
5075 static void
5076 XTset_vertical_scroll_bar (w, portion, whole, position)
5077 struct window *w;
5078 int portion, whole, position;
5080 struct frame *f = XFRAME (w->frame);
5081 struct scroll_bar *bar;
5082 int top, height, left, sb_left, width, sb_width;
5083 int window_y, window_height;
5084 #ifdef USE_TOOLKIT_SCROLL_BARS
5085 int fringe_extended_p;
5086 #endif
5088 /* Get window dimensions. */
5089 window_box (w, -1, 0, &window_y, 0, &window_height);
5090 top = window_y;
5091 width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5092 height = window_height;
5094 /* Compute the left edge of the scroll bar area. */
5095 left = WINDOW_SCROLL_BAR_AREA_X (w);
5097 /* Compute the width of the scroll bar which might be less than
5098 the width of the area reserved for the scroll bar. */
5099 if (WINDOW_CONFIG_SCROLL_BAR_WIDTH (w) > 0)
5100 sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);
5101 else
5102 sb_width = width;
5104 /* Compute the left edge of the scroll bar. */
5105 #ifdef USE_TOOLKIT_SCROLL_BARS
5106 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5107 sb_left = left + (WINDOW_RIGHTMOST_P (w) ? width - sb_width : 0);
5108 else
5109 sb_left = left + (WINDOW_LEFTMOST_P (w) ? 0 : width - sb_width);
5110 #else
5111 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w))
5112 sb_left = left + width - sb_width;
5113 else
5114 sb_left = left;
5115 #endif
5117 #ifdef USE_TOOLKIT_SCROLL_BARS
5118 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5119 fringe_extended_p = (WINDOW_LEFTMOST_P (w)
5120 && WINDOW_LEFT_FRINGE_WIDTH (w)
5121 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5122 || WINDOW_LEFT_MARGIN_COLS (w) == 0));
5123 else
5124 fringe_extended_p = (WINDOW_RIGHTMOST_P (w)
5125 && WINDOW_RIGHT_FRINGE_WIDTH (w)
5126 && (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w)
5127 || WINDOW_RIGHT_MARGIN_COLS (w) == 0));
5128 #endif
5130 /* Does the scroll bar exist yet? */
5131 if (NILP (w->vertical_scroll_bar))
5133 if (width > 0 && height > 0)
5135 BLOCK_INPUT;
5136 #ifdef USE_TOOLKIT_SCROLL_BARS
5137 if (fringe_extended_p)
5138 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5139 sb_left, top, sb_width, height, False);
5140 else
5141 #endif
5142 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5143 left, top, width, height, False);
5144 UNBLOCK_INPUT;
5147 bar = x_scroll_bar_create (w, top, sb_left, sb_width, height);
5149 else
5151 /* It may just need to be moved and resized. */
5152 unsigned int mask = 0;
5154 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5156 BLOCK_INPUT;
5158 if (sb_left != bar->left)
5159 mask |= CWX;
5160 if (top != bar->top)
5161 mask |= CWY;
5162 if (sb_width != bar->width)
5163 mask |= CWWidth;
5164 if (height != bar->height)
5165 mask |= CWHeight;
5167 #ifdef USE_TOOLKIT_SCROLL_BARS
5169 /* Move/size the scroll bar widget. */
5170 if (mask || bar->fringe_extended_p != fringe_extended_p)
5172 /* Since toolkit scroll bars are smaller than the space reserved
5173 for them on the frame, we have to clear "under" them. */
5174 if (width > 0 && height > 0)
5176 if (fringe_extended_p)
5177 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5178 sb_left, top, sb_width, height, False);
5179 else
5180 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5181 left, top, width, height, False);
5183 #ifdef USE_GTK
5184 xg_update_scrollbar_pos (f,
5185 bar->x_window,
5186 top,
5187 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5188 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM *2,
5189 max (height, 1));
5190 #else /* not USE_GTK */
5191 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
5192 sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5193 top,
5194 sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
5195 max (height, 1), 0);
5196 #endif /* not USE_GTK */
5198 #else /* not USE_TOOLKIT_SCROLL_BARS */
5200 /* Clear areas not covered by the scroll bar because of
5201 VERTICAL_SCROLL_BAR_WIDTH_TRIM. */
5202 if (VERTICAL_SCROLL_BAR_WIDTH_TRIM)
5204 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5205 left, top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5206 height, False);
5207 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5208 left + width - VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5209 top, VERTICAL_SCROLL_BAR_WIDTH_TRIM,
5210 height, False);
5213 /* Clear areas not covered by the scroll bar because it's not as
5214 wide as the area reserved for it. This makes sure a
5215 previous mode line display is cleared after C-x 2 C-x 1, for
5216 example. */
5218 int area_width = WINDOW_CONFIG_SCROLL_BAR_COLS (w) * FRAME_COLUMN_WIDTH (f);
5219 int rest = area_width - sb_width;
5220 if (rest > 0 && height > 0)
5222 if (WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
5223 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5224 left + area_width - rest, top,
5225 rest, height, False);
5226 else
5227 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
5228 left, top, rest, height, False);
5232 /* Move/size the scroll bar window. */
5233 if (mask)
5235 XWindowChanges wc;
5237 wc.x = sb_left + VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5238 wc.y = top;
5239 wc.width = sb_width - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2;
5240 wc.height = height;
5241 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
5242 mask, &wc);
5245 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5247 /* Remember new settings. */
5248 bar->left = sb_left;
5249 bar->top = top;
5250 bar->width = sb_width;
5251 bar->height = height;
5253 UNBLOCK_INPUT;
5256 #ifdef USE_TOOLKIT_SCROLL_BARS
5257 bar->fringe_extended_p = fringe_extended_p;
5259 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
5260 #else /* not USE_TOOLKIT_SCROLL_BARS */
5261 /* Set the scroll bar's current state, unless we're currently being
5262 dragged. */
5263 if (NILP (bar->dragging))
5265 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
5267 if (whole == 0)
5268 x_scroll_bar_set_handle (bar, 0, top_range, 0);
5269 else
5271 int start = ((double) position * top_range) / whole;
5272 int end = ((double) (position + portion) * top_range) / whole;
5273 x_scroll_bar_set_handle (bar, start, end, 0);
5276 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5278 XSETVECTOR (w->vertical_scroll_bar, bar);
5282 /* The following three hooks are used when we're doing a thorough
5283 redisplay of the frame. We don't explicitly know which scroll bars
5284 are going to be deleted, because keeping track of when windows go
5285 away is a real pain - "Can you say set-window-configuration, boys
5286 and girls?" Instead, we just assert at the beginning of redisplay
5287 that *all* scroll bars are to be removed, and then save a scroll bar
5288 from the fiery pit when we actually redisplay its window. */
5290 /* Arrange for all scroll bars on FRAME to be removed at the next call
5291 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
5292 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
5294 static void
5295 XTcondemn_scroll_bars (frame)
5296 FRAME_PTR frame;
5298 /* Transfer all the scroll bars to FRAME_CONDEMNED_SCROLL_BARS. */
5299 while (! NILP (FRAME_SCROLL_BARS (frame)))
5301 Lisp_Object bar;
5302 bar = FRAME_SCROLL_BARS (frame);
5303 FRAME_SCROLL_BARS (frame) = XSCROLL_BAR (bar)->next;
5304 XSCROLL_BAR (bar)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
5305 XSCROLL_BAR (bar)->prev = Qnil;
5306 if (! NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
5307 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = bar;
5308 FRAME_CONDEMNED_SCROLL_BARS (frame) = bar;
5313 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
5314 Note that WINDOW isn't necessarily condemned at all. */
5316 static void
5317 XTredeem_scroll_bar (window)
5318 struct window *window;
5320 struct scroll_bar *bar;
5321 struct frame *f;
5323 /* We can't redeem this window's scroll bar if it doesn't have one. */
5324 if (NILP (window->vertical_scroll_bar))
5325 abort ();
5327 bar = XSCROLL_BAR (window->vertical_scroll_bar);
5329 /* Unlink it from the condemned list. */
5330 f = XFRAME (WINDOW_FRAME (window));
5331 if (NILP (bar->prev))
5333 /* If the prev pointer is nil, it must be the first in one of
5334 the lists. */
5335 if (EQ (FRAME_SCROLL_BARS (f), window->vertical_scroll_bar))
5336 /* It's not condemned. Everything's fine. */
5337 return;
5338 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
5339 window->vertical_scroll_bar))
5340 FRAME_CONDEMNED_SCROLL_BARS (f) = bar->next;
5341 else
5342 /* If its prev pointer is nil, it must be at the front of
5343 one or the other! */
5344 abort ();
5346 else
5347 XSCROLL_BAR (bar->prev)->next = bar->next;
5349 if (! NILP (bar->next))
5350 XSCROLL_BAR (bar->next)->prev = bar->prev;
5352 bar->next = FRAME_SCROLL_BARS (f);
5353 bar->prev = Qnil;
5354 XSETVECTOR (FRAME_SCROLL_BARS (f), bar);
5355 if (! NILP (bar->next))
5356 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
5359 /* Remove all scroll bars on FRAME that haven't been saved since the
5360 last call to `*condemn_scroll_bars_hook'. */
5362 static void
5363 XTjudge_scroll_bars (f)
5364 FRAME_PTR f;
5366 Lisp_Object bar, next;
5368 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
5370 /* Clear out the condemned list now so we won't try to process any
5371 more events on the hapless scroll bars. */
5372 FRAME_CONDEMNED_SCROLL_BARS (f) = Qnil;
5374 for (; ! NILP (bar); bar = next)
5376 struct scroll_bar *b = XSCROLL_BAR (bar);
5378 x_scroll_bar_remove (b);
5380 next = b->next;
5381 b->next = b->prev = Qnil;
5384 /* Now there should be no references to the condemned scroll bars,
5385 and they should get garbage-collected. */
5389 #ifndef USE_TOOLKIT_SCROLL_BARS
5390 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
5391 is a no-op when using toolkit scroll bars.
5393 This may be called from a signal handler, so we have to ignore GC
5394 mark bits. */
5396 static void
5397 x_scroll_bar_expose (bar, event)
5398 struct scroll_bar *bar;
5399 XEvent *event;
5401 Window w = bar->x_window;
5402 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5403 GC gc = f->output_data.x->normal_gc;
5404 int width_trim = VERTICAL_SCROLL_BAR_WIDTH_TRIM;
5406 BLOCK_INPUT;
5408 x_scroll_bar_set_handle (bar, bar->start, bar->end, 1);
5410 /* Switch to scroll bar foreground color. */
5411 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5412 XSetForeground (FRAME_X_DISPLAY (f), gc,
5413 f->output_data.x->scroll_bar_foreground_pixel);
5415 /* Draw a one-pixel border just inside the edges of the scroll bar. */
5416 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
5418 /* x, y, width, height */
5419 0, 0,
5420 bar->width - 1 - width_trim - width_trim,
5421 bar->height - 1);
5423 /* Restore the foreground color of the GC if we changed it above. */
5424 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
5425 XSetForeground (FRAME_X_DISPLAY (f), gc,
5426 FRAME_FOREGROUND_PIXEL (f));
5428 UNBLOCK_INPUT;
5431 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5433 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
5434 is set to something other than NO_EVENT, it is enqueued.
5436 This may be called from a signal handler, so we have to ignore GC
5437 mark bits. */
5440 static void
5441 x_scroll_bar_handle_click (bar, event, emacs_event)
5442 struct scroll_bar *bar;
5443 XEvent *event;
5444 struct input_event *emacs_event;
5446 if (! WINDOWP (bar->window))
5447 abort ();
5449 emacs_event->kind = SCROLL_BAR_CLICK_EVENT;
5450 emacs_event->code = event->xbutton.button - Button1;
5451 emacs_event->modifiers
5452 = (x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO
5453 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
5454 event->xbutton.state)
5455 | (event->type == ButtonRelease
5456 ? up_modifier
5457 : down_modifier));
5458 emacs_event->frame_or_window = bar->window;
5459 emacs_event->arg = Qnil;
5460 emacs_event->timestamp = event->xbutton.time;
5462 int top_range
5463 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5464 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
5466 if (y < 0) y = 0;
5467 if (y > top_range) y = top_range;
5469 if (y < bar->start)
5470 emacs_event->part = scroll_bar_above_handle;
5471 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5472 emacs_event->part = scroll_bar_handle;
5473 else
5474 emacs_event->part = scroll_bar_below_handle;
5476 #ifndef USE_TOOLKIT_SCROLL_BARS
5477 /* If the user has released the handle, set it to its final position. */
5478 if (event->type == ButtonRelease
5479 && ! NILP (bar->dragging))
5481 int new_start = y - XINT (bar->dragging);
5482 int new_end = new_start + bar->end - bar->start;
5484 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5485 bar->dragging = Qnil;
5487 #endif
5489 XSETINT (emacs_event->x, y);
5490 XSETINT (emacs_event->y, top_range);
5494 #ifndef USE_TOOLKIT_SCROLL_BARS
5496 /* Handle some mouse motion while someone is dragging the scroll bar.
5498 This may be called from a signal handler, so we have to ignore GC
5499 mark bits. */
5501 static void
5502 x_scroll_bar_note_movement (bar, event)
5503 struct scroll_bar *bar;
5504 XEvent *event;
5506 FRAME_PTR f = XFRAME (XWINDOW (bar->window)->frame);
5508 last_mouse_movement_time = event->xmotion.time;
5510 f->mouse_moved = 1;
5511 XSETVECTOR (last_mouse_scroll_bar, bar);
5513 /* If we're dragging the bar, display it. */
5514 if (! NILP (bar->dragging))
5516 /* Where should the handle be now? */
5517 int new_start = event->xmotion.y - XINT (bar->dragging);
5519 if (new_start != bar->start)
5521 int new_end = new_start + bar->end - bar->start;
5523 x_scroll_bar_set_handle (bar, new_start, new_end, 0);
5528 #endif /* !USE_TOOLKIT_SCROLL_BARS */
5530 /* Return information to the user about the current position of the mouse
5531 on the scroll bar. */
5533 static void
5534 x_scroll_bar_report_motion (fp, bar_window, part, x, y, time)
5535 FRAME_PTR *fp;
5536 Lisp_Object *bar_window;
5537 enum scroll_bar_part *part;
5538 Lisp_Object *x, *y;
5539 unsigned long *time;
5541 struct scroll_bar *bar = XSCROLL_BAR (last_mouse_scroll_bar);
5542 Window w = bar->x_window;
5543 FRAME_PTR f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
5544 int win_x, win_y;
5545 Window dummy_window;
5546 int dummy_coord;
5547 unsigned int dummy_mask;
5549 BLOCK_INPUT;
5551 /* Get the mouse's position relative to the scroll bar window, and
5552 report that. */
5553 if (! XQueryPointer (FRAME_X_DISPLAY (f), w,
5555 /* Root, child, root x and root y. */
5556 &dummy_window, &dummy_window,
5557 &dummy_coord, &dummy_coord,
5559 /* Position relative to scroll bar. */
5560 &win_x, &win_y,
5562 /* Mouse buttons and modifier keys. */
5563 &dummy_mask))
5565 else
5567 int top_range
5568 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
5570 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
5572 if (! NILP (bar->dragging))
5573 win_y -= XINT (bar->dragging);
5575 if (win_y < 0)
5576 win_y = 0;
5577 if (win_y > top_range)
5578 win_y = top_range;
5580 *fp = f;
5581 *bar_window = bar->window;
5583 if (! NILP (bar->dragging))
5584 *part = scroll_bar_handle;
5585 else if (win_y < bar->start)
5586 *part = scroll_bar_above_handle;
5587 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
5588 *part = scroll_bar_handle;
5589 else
5590 *part = scroll_bar_below_handle;
5592 XSETINT (*x, win_y);
5593 XSETINT (*y, top_range);
5595 f->mouse_moved = 0;
5596 last_mouse_scroll_bar = Qnil;
5599 *time = last_mouse_movement_time;
5601 UNBLOCK_INPUT;
5605 /* The screen has been cleared so we may have changed foreground or
5606 background colors, and the scroll bars may need to be redrawn.
5607 Clear out the scroll bars, and ask for expose events, so we can
5608 redraw them. */
5610 void
5611 x_scroll_bar_clear (f)
5612 FRAME_PTR f;
5614 #ifndef USE_TOOLKIT_SCROLL_BARS
5615 Lisp_Object bar;
5617 /* We can have scroll bars even if this is 0,
5618 if we just turned off scroll bar mode.
5619 But in that case we should not clear them. */
5620 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
5621 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
5622 bar = XSCROLL_BAR (bar)->next)
5623 XClearArea (FRAME_X_DISPLAY (f),
5624 XSCROLL_BAR (bar)->x_window,
5625 0, 0, 0, 0, True);
5626 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5630 /* The main X event-reading loop - XTread_socket. */
5632 /* This holds the state XLookupString needs to implement dead keys
5633 and other tricks known as "compose processing". _X Window System_
5634 says that a portable program can't use this, but Stephen Gildea assures
5635 me that letting the compiler initialize it to zeros will work okay.
5637 This must be defined outside of XTread_socket, for the same reasons
5638 given for enter_timestamp, above. */
5640 static XComposeStatus compose_status;
5642 /* Record the last 100 characters stored
5643 to help debug the loss-of-chars-during-GC problem. */
5645 static int temp_index;
5646 static short temp_buffer[100];
5648 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
5649 if (temp_index == sizeof temp_buffer / sizeof (short)) \
5650 temp_index = 0; \
5651 temp_buffer[temp_index++] = (keysym)
5653 /* Set this to nonzero to fake an "X I/O error"
5654 on a particular display. */
5656 struct x_display_info *XTread_socket_fake_io_error;
5658 /* When we find no input here, we occasionally do a no-op command
5659 to verify that the X server is still running and we can still talk with it.
5660 We try all the open displays, one by one.
5661 This variable is used for cycling thru the displays. */
5663 static struct x_display_info *next_noop_dpyinfo;
5665 #define SET_SAVED_MENU_EVENT(size) \
5666 do \
5668 if (f->output_data.x->saved_menu_event == 0) \
5669 f->output_data.x->saved_menu_event \
5670 = (XEvent *) xmalloc (sizeof (XEvent)); \
5671 bcopy (&event, f->output_data.x->saved_menu_event, size); \
5672 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT; \
5673 XSETFRAME (inev.ie.frame_or_window, f); \
5675 while (0)
5677 #define SET_SAVED_BUTTON_EVENT SET_SAVED_MENU_EVENT (sizeof (XButtonEvent))
5678 #define SET_SAVED_KEY_EVENT SET_SAVED_MENU_EVENT (sizeof (XKeyEvent))
5681 enum
5683 X_EVENT_NORMAL,
5684 X_EVENT_GOTO_OUT,
5685 X_EVENT_DROP
5688 /* Filter events for the current X input method.
5689 DPYINFO is the display this event is for.
5690 EVENT is the X event to filter.
5692 Returns non-zero if the event was filtered, caller shall not process
5693 this event further.
5694 Returns zero if event is wasn't filtered. */
5696 #ifdef HAVE_X_I18N
5697 static int
5698 x_filter_event (dpyinfo, event)
5699 struct x_display_info *dpyinfo;
5700 XEvent *event;
5702 /* XFilterEvent returns non-zero if the input method has
5703 consumed the event. We pass the frame's X window to
5704 XFilterEvent because that's the one for which the IC
5705 was created. */
5707 struct frame *f1 = x_any_window_to_frame (dpyinfo,
5708 event->xclient.window);
5710 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
5712 #endif
5714 #ifdef USE_GTK
5715 static int current_count;
5716 static int current_finish;
5717 static struct input_event *current_hold_quit;
5719 /* This is the filter function invoked by the GTK event loop.
5720 It is invoked before the XEvent is translated to a GdkEvent,
5721 so we have a chance to act on the event before GTK. */
5722 static GdkFilterReturn
5723 event_handler_gdk (gxev, ev, data)
5724 GdkXEvent *gxev;
5725 GdkEvent *ev;
5726 gpointer data;
5728 XEvent *xev = (XEvent *) gxev;
5730 if (current_count >= 0)
5732 struct x_display_info *dpyinfo;
5734 dpyinfo = x_display_info_for_display (xev->xany.display);
5736 #ifdef HAVE_X_I18N
5737 /* Filter events for the current X input method.
5738 GTK calls XFilterEvent but not for key press and release,
5739 so we do it here. */
5740 if (xev->type == KeyPress || xev->type == KeyRelease)
5741 if (dpyinfo && x_filter_event (dpyinfo, xev))
5742 return GDK_FILTER_REMOVE;
5743 #endif
5745 if (! dpyinfo)
5746 current_finish = X_EVENT_NORMAL;
5747 else
5749 current_count +=
5750 handle_one_xevent (dpyinfo, xev, &current_finish,
5751 current_hold_quit);
5754 else
5755 current_finish = x_dispatch_event (xev, xev->xany.display);
5757 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
5758 return GDK_FILTER_REMOVE;
5760 return GDK_FILTER_CONTINUE;
5762 #endif /* USE_GTK */
5765 /* Handles the XEvent EVENT on display DPYINFO.
5767 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
5768 *FINISH is zero if caller should continue reading events.
5769 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
5771 We return the number of characters stored into the buffer. */
5773 static int
5774 handle_one_xevent (dpyinfo, eventp, finish, hold_quit)
5775 struct x_display_info *dpyinfo;
5776 XEvent *eventp;
5777 int *finish;
5778 struct input_event *hold_quit;
5780 union {
5781 struct input_event ie;
5782 struct selection_input_event sie;
5783 } inev;
5784 int count = 0;
5785 int do_help = 0;
5786 int nbytes = 0;
5787 struct frame *f = NULL;
5788 struct coding_system coding;
5789 XEvent event = *eventp;
5791 *finish = X_EVENT_NORMAL;
5793 EVENT_INIT (inev.ie);
5794 inev.ie.kind = NO_EVENT;
5795 inev.ie.arg = Qnil;
5797 switch (event.type)
5799 case ClientMessage:
5801 if (event.xclient.message_type
5802 == dpyinfo->Xatom_wm_protocols
5803 && event.xclient.format == 32)
5805 if (event.xclient.data.l[0]
5806 == dpyinfo->Xatom_wm_take_focus)
5808 /* Use x_any_window_to_frame because this
5809 could be the shell widget window
5810 if the frame has no title bar. */
5811 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5812 #ifdef HAVE_X_I18N
5813 /* Not quite sure this is needed -pd */
5814 if (f && FRAME_XIC (f))
5815 XSetICFocus (FRAME_XIC (f));
5816 #endif
5817 #if 0 /* Emacs sets WM hints whose `input' field is `true'. This
5818 instructs the WM to set the input focus automatically for
5819 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
5820 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
5821 it has set the focus. So, XSetInputFocus below is not
5822 needed.
5824 The call to XSetInputFocus below has also caused trouble. In
5825 cases where the XSetInputFocus done by the WM and the one
5826 below are temporally close (on a fast machine), the call
5827 below can generate additional FocusIn events which confuse
5828 Emacs. */
5830 /* Since we set WM_TAKE_FOCUS, we must call
5831 XSetInputFocus explicitly. But not if f is null,
5832 since that might be an event for a deleted frame. */
5833 if (f)
5835 Display *d = event.xclient.display;
5836 /* Catch and ignore errors, in case window has been
5837 iconified by a window manager such as GWM. */
5838 x_catch_errors (d);
5839 XSetInputFocus (d, event.xclient.window,
5840 /* The ICCCM says this is
5841 the only valid choice. */
5842 RevertToParent,
5843 event.xclient.data.l[1]);
5844 /* This is needed to detect the error
5845 if there is an error. */
5846 XSync (d, False);
5847 x_uncatch_errors ();
5849 /* Not certain about handling scroll bars here */
5850 #endif /* 0 */
5851 goto done;
5854 if (event.xclient.data.l[0]
5855 == dpyinfo->Xatom_wm_save_yourself)
5857 /* Save state modify the WM_COMMAND property to
5858 something which can reinstate us. This notifies
5859 the session manager, who's looking for such a
5860 PropertyNotify. Can restart processing when
5861 a keyboard or mouse event arrives. */
5862 /* If we have a session manager, don't set this.
5863 KDE will then start two Emacsen, one for the
5864 session manager and one for this. */
5865 #ifdef HAVE_X_SM
5866 if (! x_session_have_connection ())
5867 #endif
5869 f = x_top_window_to_frame (dpyinfo,
5870 event.xclient.window);
5871 /* This is just so we only give real data once
5872 for a single Emacs process. */
5873 if (f == SELECTED_FRAME ())
5874 XSetCommand (FRAME_X_DISPLAY (f),
5875 event.xclient.window,
5876 initial_argv, initial_argc);
5877 else if (f)
5878 XSetCommand (FRAME_X_DISPLAY (f),
5879 event.xclient.window,
5880 0, 0);
5882 goto done;
5885 if (event.xclient.data.l[0]
5886 == dpyinfo->Xatom_wm_delete_window)
5888 f = x_any_window_to_frame (dpyinfo,
5889 event.xclient.window);
5890 if (!f)
5891 goto OTHER; /* May be a dialog that is to be removed */
5893 inev.ie.kind = DELETE_WINDOW_EVENT;
5894 XSETFRAME (inev.ie.frame_or_window, f);
5895 goto done;
5898 goto done;
5901 if (event.xclient.message_type
5902 == dpyinfo->Xatom_wm_configure_denied)
5904 goto done;
5907 if (event.xclient.message_type
5908 == dpyinfo->Xatom_wm_window_moved)
5910 int new_x, new_y;
5911 f = x_window_to_frame (dpyinfo, event.xclient.window);
5913 new_x = event.xclient.data.s[0];
5914 new_y = event.xclient.data.s[1];
5916 if (f)
5918 f->left_pos = new_x;
5919 f->top_pos = new_y;
5921 goto done;
5924 #ifdef HACK_EDITRES
5925 if (event.xclient.message_type
5926 == dpyinfo->Xatom_editres)
5928 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5929 if (f)
5930 _XEditResCheckMessages (f->output_data.x->widget, NULL,
5931 &event, NULL);
5932 goto done;
5934 #endif /* HACK_EDITRES */
5936 if ((event.xclient.message_type
5937 == dpyinfo->Xatom_DONE)
5938 || (event.xclient.message_type
5939 == dpyinfo->Xatom_PAGE))
5941 /* Ghostview job completed. Kill it. We could
5942 reply with "Next" if we received "Page", but we
5943 currently never do because we are interested in
5944 images, only, which should have 1 page. */
5945 Pixmap pixmap = (Pixmap) event.xclient.data.l[1];
5946 f = x_window_to_frame (dpyinfo, event.xclient.window);
5947 if (!f)
5948 goto OTHER;
5949 x_kill_gs_process (pixmap, f);
5950 expose_frame (f, 0, 0, 0, 0);
5951 goto done;
5954 #ifdef USE_TOOLKIT_SCROLL_BARS
5955 /* Scroll bar callbacks send a ClientMessage from which
5956 we construct an input_event. */
5957 if (event.xclient.message_type
5958 == dpyinfo->Xatom_Scrollbar)
5960 x_scroll_bar_to_input_event (&event, &inev.ie);
5961 *finish = X_EVENT_GOTO_OUT;
5962 goto done;
5964 #endif /* USE_TOOLKIT_SCROLL_BARS */
5966 /* XEmbed messages from the embedder (if any). */
5967 if (event.xclient.message_type
5968 == dpyinfo->Xatom_XEMBED)
5970 enum xembed_message msg = event.xclient.data.l[1];
5971 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
5972 x_detect_focus_change (dpyinfo, &event, &inev.ie);
5974 *finish = X_EVENT_GOTO_OUT;
5975 goto done;
5978 f = x_any_window_to_frame (dpyinfo, event.xclient.window);
5979 if (!f)
5980 goto OTHER;
5981 if (x_handle_dnd_message (f, &event.xclient, dpyinfo, &inev.ie))
5982 *finish = X_EVENT_DROP;
5984 break;
5986 case SelectionNotify:
5987 last_user_time = event.xselection.time;
5988 #ifdef USE_X_TOOLKIT
5989 if (! x_window_to_frame (dpyinfo, event.xselection.requestor))
5990 goto OTHER;
5991 #endif /* not USE_X_TOOLKIT */
5992 x_handle_selection_notify (&event.xselection);
5993 break;
5995 case SelectionClear: /* Someone has grabbed ownership. */
5996 last_user_time = event.xselectionclear.time;
5997 #ifdef USE_X_TOOLKIT
5998 if (! x_window_to_frame (dpyinfo, event.xselectionclear.window))
5999 goto OTHER;
6000 #endif /* USE_X_TOOLKIT */
6002 XSelectionClearEvent *eventp = (XSelectionClearEvent *) &event;
6004 inev.ie.kind = SELECTION_CLEAR_EVENT;
6005 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6006 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6007 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6008 inev.ie.frame_or_window = Qnil;
6010 break;
6012 case SelectionRequest: /* Someone wants our selection. */
6013 last_user_time = event.xselectionrequest.time;
6014 #ifdef USE_X_TOOLKIT
6015 if (!x_window_to_frame (dpyinfo, event.xselectionrequest.owner))
6016 goto OTHER;
6017 #endif /* USE_X_TOOLKIT */
6019 XSelectionRequestEvent *eventp
6020 = (XSelectionRequestEvent *) &event;
6022 inev.ie.kind = SELECTION_REQUEST_EVENT;
6023 SELECTION_EVENT_DISPLAY (&inev.sie) = eventp->display;
6024 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
6025 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
6026 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
6027 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
6028 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
6029 inev.ie.frame_or_window = Qnil;
6031 break;
6033 case PropertyNotify:
6034 last_user_time = event.xproperty.time;
6035 f = x_top_window_to_frame (dpyinfo, event.xproperty.window);
6036 if (f && event.xproperty.atom == dpyinfo->Xatom_net_wm_state)
6037 x_handle_net_wm_state (f, &event.xproperty);
6039 x_handle_property_notify (&event.xproperty);
6040 goto OTHER;
6042 case ReparentNotify:
6043 f = x_top_window_to_frame (dpyinfo, event.xreparent.window);
6044 if (f)
6046 int x, y;
6047 f->output_data.x->parent_desc = event.xreparent.parent;
6048 x_real_positions (f, &x, &y);
6049 f->left_pos = x;
6050 f->top_pos = y;
6052 /* Perhaps reparented due to a WM restart. Reset this. */
6053 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
6054 FRAME_X_DISPLAY_INFO (f)->net_supported_window = 0;
6056 goto OTHER;
6058 case Expose:
6059 f = x_window_to_frame (dpyinfo, event.xexpose.window);
6060 if (f)
6062 #ifdef USE_GTK
6063 /* This seems to be needed for GTK 2.6. */
6064 x_clear_area (event.xexpose.display,
6065 event.xexpose.window,
6066 event.xexpose.x, event.xexpose.y,
6067 event.xexpose.width, event.xexpose.height,
6068 FALSE);
6069 #endif
6070 if (f->async_visible == 0)
6072 f->async_visible = 1;
6073 f->async_iconified = 0;
6074 f->output_data.x->has_been_visible = 1;
6075 SET_FRAME_GARBAGED (f);
6077 else
6078 expose_frame (f,
6079 event.xexpose.x, event.xexpose.y,
6080 event.xexpose.width, event.xexpose.height);
6082 else
6084 #ifndef USE_TOOLKIT_SCROLL_BARS
6085 struct scroll_bar *bar;
6086 #endif
6087 #if defined USE_LUCID
6088 /* Submenus of the Lucid menu bar aren't widgets
6089 themselves, so there's no way to dispatch events
6090 to them. Recognize this case separately. */
6092 Widget widget
6093 = x_window_to_menu_bar (event.xexpose.window);
6094 if (widget)
6095 xlwmenu_redisplay (widget);
6097 #endif /* USE_LUCID */
6099 #ifdef USE_TOOLKIT_SCROLL_BARS
6100 /* Dispatch event to the widget. */
6101 goto OTHER;
6102 #else /* not USE_TOOLKIT_SCROLL_BARS */
6103 bar = x_window_to_scroll_bar (event.xexpose.display,
6104 event.xexpose.window);
6106 if (bar)
6107 x_scroll_bar_expose (bar, &event);
6108 #ifdef USE_X_TOOLKIT
6109 else
6110 goto OTHER;
6111 #endif /* USE_X_TOOLKIT */
6112 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6114 break;
6116 case GraphicsExpose: /* This occurs when an XCopyArea's
6117 source area was obscured or not
6118 available. */
6119 f = x_window_to_frame (dpyinfo, event.xgraphicsexpose.drawable);
6120 if (f)
6122 expose_frame (f,
6123 event.xgraphicsexpose.x, event.xgraphicsexpose.y,
6124 event.xgraphicsexpose.width,
6125 event.xgraphicsexpose.height);
6127 #ifdef USE_X_TOOLKIT
6128 else
6129 goto OTHER;
6130 #endif /* USE_X_TOOLKIT */
6131 break;
6133 case NoExpose: /* This occurs when an XCopyArea's
6134 source area was completely
6135 available. */
6136 break;
6138 case UnmapNotify:
6139 /* Redo the mouse-highlight after the tooltip has gone. */
6140 if (event.xmap.window == tip_window)
6142 tip_window = 0;
6143 redo_mouse_highlight ();
6146 f = x_top_window_to_frame (dpyinfo, event.xunmap.window);
6147 if (f) /* F may no longer exist if
6148 the frame was deleted. */
6150 /* While a frame is unmapped, display generation is
6151 disabled; you don't want to spend time updating a
6152 display that won't ever be seen. */
6153 f->async_visible = 0;
6154 /* We can't distinguish, from the event, whether the window
6155 has become iconified or invisible. So assume, if it
6156 was previously visible, than now it is iconified.
6157 But x_make_frame_invisible clears both
6158 the visible flag and the iconified flag;
6159 and that way, we know the window is not iconified now. */
6160 if (FRAME_VISIBLE_P (f) || FRAME_ICONIFIED_P (f))
6162 f->async_iconified = 1;
6164 inev.ie.kind = ICONIFY_EVENT;
6165 XSETFRAME (inev.ie.frame_or_window, f);
6168 goto OTHER;
6170 case MapNotify:
6171 if (event.xmap.window == tip_window)
6172 /* The tooltip has been drawn already. Avoid
6173 the SET_FRAME_GARBAGED below. */
6174 goto OTHER;
6176 /* We use x_top_window_to_frame because map events can
6177 come for sub-windows and they don't mean that the
6178 frame is visible. */
6179 f = x_top_window_to_frame (dpyinfo, event.xmap.window);
6180 if (f)
6182 /* wait_reading_process_output will notice this and update
6183 the frame's display structures.
6184 If we where iconified, we should not set garbaged,
6185 because that stops redrawing on Expose events. This looks
6186 bad if we are called from a recursive event loop
6187 (x_dispatch_event), for example when a dialog is up. */
6188 if (! f->async_iconified)
6189 SET_FRAME_GARBAGED (f);
6191 f->async_visible = 1;
6192 f->async_iconified = 0;
6193 f->output_data.x->has_been_visible = 1;
6195 if (f->iconified)
6197 inev.ie.kind = DEICONIFY_EVENT;
6198 XSETFRAME (inev.ie.frame_or_window, f);
6200 else if (! NILP (Vframe_list)
6201 && ! NILP (XCDR (Vframe_list)))
6202 /* Force a redisplay sooner or later
6203 to update the frame titles
6204 in case this is the second frame. */
6205 record_asynch_buffer_change ();
6207 /* Check if fullscreen was specified before we where mapped. */
6208 x_check_fullscreen (f);
6210 goto OTHER;
6212 case KeyPress:
6214 last_user_time = event.xkey.time;
6215 ignore_next_mouse_click_timeout = 0;
6217 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6218 /* Dispatch KeyPress events when in menu. */
6219 if (popup_activated ())
6220 goto OTHER;
6221 #endif
6223 f = x_any_window_to_frame (dpyinfo, event.xkey.window);
6225 /* If mouse-highlight is an integer, input clears out
6226 mouse highlighting. */
6227 if (!dpyinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
6228 && (f == 0
6229 || !EQ (f->tool_bar_window, dpyinfo->mouse_face_window)))
6231 clear_mouse_face (dpyinfo);
6232 dpyinfo->mouse_face_hidden = 1;
6235 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
6236 if (f == 0)
6238 /* Scroll bars consume key events, but we want
6239 the keys to go to the scroll bar's frame. */
6240 Widget widget = XtWindowToWidget (dpyinfo->display,
6241 event.xkey.window);
6242 if (widget && XmIsScrollBar (widget))
6244 widget = XtParent (widget);
6245 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
6248 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
6250 if (f != 0)
6252 KeySym keysym, orig_keysym;
6253 /* al%imercury@uunet.uu.net says that making this 81
6254 instead of 80 fixed a bug whereby meta chars made
6255 his Emacs hang.
6257 It seems that some version of XmbLookupString has
6258 a bug of not returning XBufferOverflow in
6259 status_return even if the input is too long to
6260 fit in 81 bytes. So, we must prepare sufficient
6261 bytes for copy_buffer. 513 bytes (256 chars for
6262 two-byte character set) seems to be a fairly good
6263 approximation. -- 2000.8.10 handa@etl.go.jp */
6264 unsigned char copy_buffer[513];
6265 unsigned char *copy_bufptr = copy_buffer;
6266 int copy_bufsiz = sizeof (copy_buffer);
6267 int modifiers;
6268 Lisp_Object coding_system = Qlatin_1;
6269 Lisp_Object c;
6271 #ifdef USE_GTK
6272 /* Don't pass keys to GTK. A Tab will shift focus to the
6273 tool bar in GTK 2.4. Keys will still go to menus and
6274 dialogs because in that case popup_activated is TRUE
6275 (see above). */
6276 *finish = X_EVENT_DROP;
6277 #endif
6279 event.xkey.state
6280 |= x_emacs_to_x_modifiers (FRAME_X_DISPLAY_INFO (f),
6281 extra_keyboard_modifiers);
6282 modifiers = event.xkey.state;
6284 /* This will have to go some day... */
6286 /* make_lispy_event turns chars into control chars.
6287 Don't do it here because XLookupString is too eager. */
6288 event.xkey.state &= ~ControlMask;
6289 event.xkey.state &= ~(dpyinfo->meta_mod_mask
6290 | dpyinfo->super_mod_mask
6291 | dpyinfo->hyper_mod_mask
6292 | dpyinfo->alt_mod_mask);
6294 /* In case Meta is ComposeCharacter,
6295 clear its status. According to Markus Ehrnsperger
6296 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
6297 this enables ComposeCharacter to work whether or
6298 not it is combined with Meta. */
6299 if (modifiers & dpyinfo->meta_mod_mask)
6300 bzero (&compose_status, sizeof (compose_status));
6302 #ifdef HAVE_X_I18N
6303 if (FRAME_XIC (f))
6305 Status status_return;
6307 coding_system = Vlocale_coding_system;
6308 nbytes = XmbLookupString (FRAME_XIC (f),
6309 &event.xkey, copy_bufptr,
6310 copy_bufsiz, &keysym,
6311 &status_return);
6312 if (status_return == XBufferOverflow)
6314 copy_bufsiz = nbytes + 1;
6315 copy_bufptr = (unsigned char *) alloca (copy_bufsiz);
6316 nbytes = XmbLookupString (FRAME_XIC (f),
6317 &event.xkey, copy_bufptr,
6318 copy_bufsiz, &keysym,
6319 &status_return);
6321 /* Xutf8LookupString is a new but already deprecated interface. -stef */
6322 if (status_return == XLookupNone)
6323 break;
6324 else if (status_return == XLookupChars)
6326 keysym = NoSymbol;
6327 modifiers = 0;
6329 else if (status_return != XLookupKeySym
6330 && status_return != XLookupBoth)
6331 abort ();
6333 else
6334 nbytes = XLookupString (&event.xkey, copy_bufptr,
6335 copy_bufsiz, &keysym,
6336 &compose_status);
6337 #else
6338 nbytes = XLookupString (&event.xkey, copy_bufptr,
6339 copy_bufsiz, &keysym,
6340 &compose_status);
6341 #endif
6343 /* If not using XIM/XIC, and a compose sequence is in progress,
6344 we break here. Otherwise, chars_matched is always 0. */
6345 if (compose_status.chars_matched > 0 && nbytes == 0)
6346 break;
6348 bzero (&compose_status, sizeof (compose_status));
6349 orig_keysym = keysym;
6351 /* Common for all keysym input events. */
6352 XSETFRAME (inev.ie.frame_or_window, f);
6353 inev.ie.modifiers
6354 = x_x_to_emacs_modifiers (FRAME_X_DISPLAY_INFO (f), modifiers);
6355 inev.ie.timestamp = event.xkey.time;
6357 /* First deal with keysyms which have defined
6358 translations to characters. */
6359 if (keysym >= 32 && keysym < 128)
6360 /* Avoid explicitly decoding each ASCII character. */
6362 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6363 inev.ie.code = keysym;
6364 goto done_keysym;
6367 /* Keysyms directly mapped to Unicode characters. */
6368 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
6370 if (keysym < 0x01000080)
6371 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
6372 else
6373 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
6374 inev.ie.code = keysym & 0xFFFFFF;
6375 goto done_keysym;
6378 /* Now non-ASCII. */
6379 if (HASH_TABLE_P (Vx_keysym_table)
6380 && (NATNUMP (c = Fgethash (make_number (keysym),
6381 Vx_keysym_table,
6382 Qnil))))
6384 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
6385 ? ASCII_KEYSTROKE_EVENT
6386 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6387 inev.ie.code = XFASTINT (c);
6388 goto done_keysym;
6391 /* Random non-modifier sorts of keysyms. */
6392 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
6393 || keysym == XK_Delete
6394 #ifdef XK_ISO_Left_Tab
6395 || (keysym >= XK_ISO_Left_Tab
6396 && keysym <= XK_ISO_Enter)
6397 #endif
6398 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
6399 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
6400 #ifdef HPUX
6401 /* This recognizes the "extended function
6402 keys". It seems there's no cleaner way.
6403 Test IsModifierKey to avoid handling
6404 mode_switch incorrectly. */
6405 || ((unsigned) (keysym) >= XK_Select
6406 && (unsigned)(keysym) < XK_KP_Space)
6407 #endif
6408 #ifdef XK_dead_circumflex
6409 || orig_keysym == XK_dead_circumflex
6410 #endif
6411 #ifdef XK_dead_grave
6412 || orig_keysym == XK_dead_grave
6413 #endif
6414 #ifdef XK_dead_tilde
6415 || orig_keysym == XK_dead_tilde
6416 #endif
6417 #ifdef XK_dead_diaeresis
6418 || orig_keysym == XK_dead_diaeresis
6419 #endif
6420 #ifdef XK_dead_macron
6421 || orig_keysym == XK_dead_macron
6422 #endif
6423 #ifdef XK_dead_degree
6424 || orig_keysym == XK_dead_degree
6425 #endif
6426 #ifdef XK_dead_acute
6427 || orig_keysym == XK_dead_acute
6428 #endif
6429 #ifdef XK_dead_cedilla
6430 || orig_keysym == XK_dead_cedilla
6431 #endif
6432 #ifdef XK_dead_breve
6433 || orig_keysym == XK_dead_breve
6434 #endif
6435 #ifdef XK_dead_ogonek
6436 || orig_keysym == XK_dead_ogonek
6437 #endif
6438 #ifdef XK_dead_caron
6439 || orig_keysym == XK_dead_caron
6440 #endif
6441 #ifdef XK_dead_doubleacute
6442 || orig_keysym == XK_dead_doubleacute
6443 #endif
6444 #ifdef XK_dead_abovedot
6445 || orig_keysym == XK_dead_abovedot
6446 #endif
6447 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
6448 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
6449 /* Any "vendor-specific" key is ok. */
6450 || (orig_keysym & (1 << 28))
6451 || (keysym != NoSymbol && nbytes == 0))
6452 && ! (IsModifierKey (orig_keysym)
6453 /* The symbols from XK_ISO_Lock
6454 to XK_ISO_Last_Group_Lock
6455 don't have real modifiers but
6456 should be treated similarly to
6457 Mode_switch by Emacs. */
6458 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
6459 || ((unsigned)(orig_keysym)
6460 >= XK_ISO_Lock
6461 && (unsigned)(orig_keysym)
6462 <= XK_ISO_Last_Group_Lock)
6463 #endif
6466 STORE_KEYSYM_FOR_DEBUG (keysym);
6467 /* make_lispy_event will convert this to a symbolic
6468 key. */
6469 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
6470 inev.ie.code = keysym;
6471 goto done_keysym;
6474 { /* Raw bytes, not keysym. */
6475 register int i;
6476 register int c;
6477 int nchars, len;
6479 for (i = 0, nchars = 0; i < nbytes; i++)
6481 if (ASCII_BYTE_P (copy_bufptr[i]))
6482 nchars++;
6483 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
6486 if (nchars < nbytes)
6488 /* Decode the input data. */
6489 int require;
6490 unsigned char *p;
6492 /* The input should be decoded with `coding_system'
6493 which depends on which X*LookupString function
6494 we used just above and the locale. */
6495 setup_coding_system (coding_system, &coding);
6496 coding.src_multibyte = 0;
6497 coding.dst_multibyte = 1;
6498 /* The input is converted to events, thus we can't
6499 handle composition. Anyway, there's no XIM that
6500 gives us composition information. */
6501 coding.common_flags &= ~CODING_ANNOTATION_MASK;
6503 require = MAX_MULTIBYTE_LENGTH * nbytes;
6504 coding.destination = alloca (require);
6505 coding.dst_bytes = require;
6506 coding.mode |= CODING_MODE_LAST_BLOCK;
6507 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
6508 nbytes = coding.produced;
6509 nchars = coding.produced_char;
6510 copy_bufptr = coding.destination;
6513 /* Convert the input data to a sequence of
6514 character events. */
6515 for (i = 0; i < nbytes; i += len)
6517 if (nchars == nbytes)
6518 c = copy_bufptr[i], len = 1;
6519 else
6520 c = STRING_CHAR_AND_LENGTH (copy_bufptr + i,
6521 nbytes - i, len);
6522 inev.ie.kind = (SINGLE_BYTE_CHAR_P (c)
6523 ? ASCII_KEYSTROKE_EVENT
6524 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
6525 inev.ie.code = c;
6526 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6529 count += nchars;
6531 inev.ie.kind = NO_EVENT; /* Already stored above. */
6533 if (keysym == NoSymbol)
6534 break;
6537 done_keysym:
6538 #ifdef HAVE_X_I18N
6539 /* Don't dispatch this event since XtDispatchEvent calls
6540 XFilterEvent, and two calls in a row may freeze the
6541 client. */
6542 break;
6543 #else
6544 goto OTHER;
6545 #endif
6547 case KeyRelease:
6548 last_user_time = event.xkey.time;
6549 #ifdef HAVE_X_I18N
6550 /* Don't dispatch this event since XtDispatchEvent calls
6551 XFilterEvent, and two calls in a row may freeze the
6552 client. */
6553 break;
6554 #else
6555 goto OTHER;
6556 #endif
6558 case EnterNotify:
6559 last_user_time = event.xcrossing.time;
6560 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6562 f = x_any_window_to_frame (dpyinfo, event.xcrossing.window);
6564 if (f && x_mouse_click_focus_ignore_position)
6565 ignore_next_mouse_click_timeout = event.xmotion.time + 200;
6567 /* EnterNotify counts as mouse movement,
6568 so update things that depend on mouse position. */
6569 if (f && !f->output_data.x->hourglass_p)
6570 note_mouse_movement (f, &event.xmotion);
6571 #ifdef USE_GTK
6572 /* We may get an EnterNotify on the buttons in the toolbar. In that
6573 case we moved out of any highlighted area and need to note this. */
6574 if (!f && last_mouse_glyph_frame)
6575 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6576 #endif
6577 goto OTHER;
6579 case FocusIn:
6580 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6581 goto OTHER;
6583 case LeaveNotify:
6584 last_user_time = event.xcrossing.time;
6585 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6587 f = x_top_window_to_frame (dpyinfo, event.xcrossing.window);
6588 if (f)
6590 if (f == dpyinfo->mouse_face_mouse_frame)
6592 /* If we move outside the frame, then we're
6593 certainly no longer on any text in the frame. */
6594 clear_mouse_face (dpyinfo);
6595 dpyinfo->mouse_face_mouse_frame = 0;
6598 /* Generate a nil HELP_EVENT to cancel a help-echo.
6599 Do it only if there's something to cancel.
6600 Otherwise, the startup message is cleared when
6601 the mouse leaves the frame. */
6602 if (any_help_event_p)
6603 do_help = -1;
6605 #ifdef USE_GTK
6606 /* See comment in EnterNotify above */
6607 else if (last_mouse_glyph_frame)
6608 note_mouse_movement (last_mouse_glyph_frame, &event.xmotion);
6609 #endif
6610 goto OTHER;
6612 case FocusOut:
6613 x_detect_focus_change (dpyinfo, &event, &inev.ie);
6614 goto OTHER;
6616 case MotionNotify:
6618 last_user_time = event.xmotion.time;
6619 previous_help_echo_string = help_echo_string;
6620 help_echo_string = Qnil;
6622 if (dpyinfo->grabbed && last_mouse_frame
6623 && FRAME_LIVE_P (last_mouse_frame))
6624 f = last_mouse_frame;
6625 else
6626 f = x_window_to_frame (dpyinfo, event.xmotion.window);
6628 if (dpyinfo->mouse_face_hidden)
6630 dpyinfo->mouse_face_hidden = 0;
6631 clear_mouse_face (dpyinfo);
6634 if (f)
6637 /* Generate SELECT_WINDOW_EVENTs when needed.
6638 Don't let popup menus influence things (bug#1261). */
6639 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
6641 Lisp_Object window;
6643 window = window_from_coordinates (f,
6644 event.xmotion.x, event.xmotion.y,
6645 0, 0, 0, 0);
6647 /* Window will be selected only when it is not selected now and
6648 last mouse movement event was not in it. Minibuffer window
6649 will be selected only when it is active. */
6650 if (WINDOWP (window)
6651 && !EQ (window, last_window)
6652 && !EQ (window, selected_window)
6653 /* For click-to-focus window managers
6654 create event iff we don't leave the
6655 selected frame. */
6656 && (focus_follows_mouse
6657 || (EQ (XWINDOW (window)->frame,
6658 XWINDOW (selected_window)->frame))))
6660 inev.ie.kind = SELECT_WINDOW_EVENT;
6661 inev.ie.frame_or_window = window;
6664 last_window=window;
6666 if (!note_mouse_movement (f, &event.xmotion))
6667 help_echo_string = previous_help_echo_string;
6669 else
6671 #ifndef USE_TOOLKIT_SCROLL_BARS
6672 struct scroll_bar *bar
6673 = x_window_to_scroll_bar (event.xmotion.display,
6674 event.xmotion.window);
6676 if (bar)
6677 x_scroll_bar_note_movement (bar, &event);
6678 #endif /* USE_TOOLKIT_SCROLL_BARS */
6680 /* If we move outside the frame, then we're
6681 certainly no longer on any text in the frame. */
6682 clear_mouse_face (dpyinfo);
6685 /* If the contents of the global variable help_echo_string
6686 has changed, generate a HELP_EVENT. */
6687 if (!NILP (help_echo_string)
6688 || !NILP (previous_help_echo_string))
6689 do_help = 1;
6690 goto OTHER;
6693 case ConfigureNotify:
6694 f = x_top_window_to_frame (dpyinfo, event.xconfigure.window);
6695 #ifdef USE_GTK
6696 if (!f
6697 && (f = x_any_window_to_frame (dpyinfo, event.xconfigure.window))
6698 && event.xconfigure.window == FRAME_X_WINDOW (f))
6700 xg_frame_resized (f, event.xconfigure.width,
6701 event.xconfigure.height);
6702 f = 0;
6704 #endif
6705 if (f)
6707 #ifndef USE_X_TOOLKIT
6708 #ifndef USE_GTK
6709 int rows = FRAME_PIXEL_HEIGHT_TO_TEXT_LINES (f, event.xconfigure.height);
6710 int columns = FRAME_PIXEL_WIDTH_TO_TEXT_COLS (f, event.xconfigure.width);
6712 /* In the toolkit version, change_frame_size
6713 is called by the code that handles resizing
6714 of the EmacsFrame widget. */
6716 /* Even if the number of character rows and columns has
6717 not changed, the font size may have changed, so we need
6718 to check the pixel dimensions as well. */
6719 if (columns != FRAME_COLS (f)
6720 || rows != FRAME_LINES (f)
6721 || event.xconfigure.width != FRAME_PIXEL_WIDTH (f)
6722 || event.xconfigure.height != FRAME_PIXEL_HEIGHT (f))
6724 change_frame_size (f, rows, columns, 0, 1, 0);
6725 SET_FRAME_GARBAGED (f);
6726 cancel_mouse_face (f);
6729 FRAME_PIXEL_WIDTH (f) = event.xconfigure.width;
6730 FRAME_PIXEL_HEIGHT (f) = event.xconfigure.height;
6731 #endif /* not USE_GTK */
6732 #endif
6734 #ifdef USE_GTK
6735 /* GTK creates windows but doesn't map them.
6736 Only get real positions and check fullscreen when mapped. */
6737 if (FRAME_GTK_OUTER_WIDGET (f)
6738 && GTK_WIDGET_MAPPED (FRAME_GTK_OUTER_WIDGET (f)))
6739 #endif
6741 x_real_positions (f, &f->left_pos, &f->top_pos);
6744 #ifdef HAVE_X_I18N
6745 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
6746 xic_set_statusarea (f);
6747 #endif
6749 #ifndef USE_GTK
6750 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
6752 /* Since the WM decorations come below top_pos now,
6753 we must put them below top_pos in the future. */
6754 f->win_gravity = NorthWestGravity;
6755 x_wm_set_size_hint (f, (long) 0, 0);
6757 #endif
6759 goto OTHER;
6761 case ButtonRelease:
6762 case ButtonPress:
6764 /* If we decide we want to generate an event to be seen
6765 by the rest of Emacs, we put it here. */
6766 int tool_bar_p = 0;
6768 bzero (&compose_status, sizeof (compose_status));
6769 last_mouse_glyph_frame = 0;
6770 last_user_time = event.xbutton.time;
6772 if (dpyinfo->grabbed
6773 && last_mouse_frame
6774 && FRAME_LIVE_P (last_mouse_frame))
6775 f = last_mouse_frame;
6776 else
6777 f = x_window_to_frame (dpyinfo, event.xbutton.window);
6779 if (f)
6781 /* Is this in the tool-bar? */
6782 if (WINDOWP (f->tool_bar_window)
6783 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
6785 Lisp_Object window;
6786 int x = event.xbutton.x;
6787 int y = event.xbutton.y;
6789 window = window_from_coordinates (f, x, y, 0, 0, 0, 1);
6790 tool_bar_p = EQ (window, f->tool_bar_window);
6792 if (tool_bar_p && event.xbutton.button < 4)
6794 handle_tool_bar_click (f, x, y,
6795 event.xbutton.type == ButtonPress,
6796 x_x_to_emacs_modifiers (dpyinfo,
6797 event.xbutton.state));
6801 if (!tool_bar_p)
6802 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6803 if (! popup_activated ())
6804 #endif
6806 if (ignore_next_mouse_click_timeout)
6808 if (event.type == ButtonPress
6809 && (int)(event.xbutton.time - ignore_next_mouse_click_timeout) > 0)
6811 ignore_next_mouse_click_timeout = 0;
6812 construct_mouse_click (&inev.ie, &event.xbutton, f);
6814 if (event.type == ButtonRelease)
6815 ignore_next_mouse_click_timeout = 0;
6817 else
6818 construct_mouse_click (&inev.ie, &event.xbutton, f);
6820 if (FRAME_X_EMBEDDED_P (f))
6821 xembed_send_message (f, event.xbutton.time,
6822 XEMBED_REQUEST_FOCUS, 0, 0, 0);
6824 else
6826 struct scroll_bar *bar
6827 = x_window_to_scroll_bar (event.xbutton.display,
6828 event.xbutton.window);
6830 #ifdef USE_TOOLKIT_SCROLL_BARS
6831 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
6832 scroll bars. */
6833 if (bar && event.xbutton.state & ControlMask)
6835 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6836 *finish = X_EVENT_DROP;
6838 #else /* not USE_TOOLKIT_SCROLL_BARS */
6839 if (bar)
6840 x_scroll_bar_handle_click (bar, &event, &inev.ie);
6841 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6844 if (event.type == ButtonPress)
6846 dpyinfo->grabbed |= (1 << event.xbutton.button);
6847 last_mouse_frame = f;
6849 if (!tool_bar_p)
6850 last_tool_bar_item = -1;
6852 else
6853 dpyinfo->grabbed &= ~(1 << event.xbutton.button);
6855 /* Ignore any mouse motion that happened before this event;
6856 any subsequent mouse-movement Emacs events should reflect
6857 only motion after the ButtonPress/Release. */
6858 if (f != 0)
6859 f->mouse_moved = 0;
6861 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
6862 f = x_menubar_window_to_frame (dpyinfo, event.xbutton.window);
6863 /* For a down-event in the menu bar,
6864 don't pass it to Xt right now.
6865 Instead, save it away
6866 and we will pass it to Xt from kbd_buffer_get_event.
6867 That way, we can run some Lisp code first. */
6868 if (
6869 #ifdef USE_GTK
6870 ! popup_activated ()
6871 /* Gtk+ menus only react to the first three buttons. */
6872 && event.xbutton.button < 3
6874 #endif
6875 f && event.type == ButtonPress
6876 /* Verify the event is really within the menu bar
6877 and not just sent to it due to grabbing. */
6878 && event.xbutton.x >= 0
6879 && event.xbutton.x < FRAME_PIXEL_WIDTH (f)
6880 && event.xbutton.y >= 0
6881 && event.xbutton.y < f->output_data.x->menubar_height
6882 && event.xbutton.same_screen)
6884 SET_SAVED_BUTTON_EVENT;
6885 XSETFRAME (last_mouse_press_frame, f);
6886 #ifdef USE_GTK
6887 *finish = X_EVENT_DROP;
6888 #endif
6890 else if (event.type == ButtonPress)
6892 last_mouse_press_frame = Qnil;
6893 goto OTHER;
6896 #ifdef USE_MOTIF /* This should do not harm for Lucid,
6897 but I am trying to be cautious. */
6898 else if (event.type == ButtonRelease)
6900 if (!NILP (last_mouse_press_frame))
6902 f = XFRAME (last_mouse_press_frame);
6903 if (f->output_data.x)
6904 SET_SAVED_BUTTON_EVENT;
6906 else
6907 goto OTHER;
6909 #endif /* USE_MOTIF */
6910 else
6911 goto OTHER;
6912 #endif /* USE_X_TOOLKIT || USE_GTK */
6914 break;
6916 case CirculateNotify:
6917 goto OTHER;
6919 case CirculateRequest:
6920 goto OTHER;
6922 case VisibilityNotify:
6923 goto OTHER;
6925 case MappingNotify:
6926 /* Someone has changed the keyboard mapping - update the
6927 local cache. */
6928 switch (event.xmapping.request)
6930 case MappingModifier:
6931 x_find_modifier_meanings (dpyinfo);
6932 /* This is meant to fall through. */
6933 case MappingKeyboard:
6934 XRefreshKeyboardMapping (&event.xmapping);
6936 goto OTHER;
6938 default:
6939 OTHER:
6940 #ifdef USE_X_TOOLKIT
6941 BLOCK_INPUT;
6942 if (*finish != X_EVENT_DROP)
6943 XtDispatchEvent (&event);
6944 UNBLOCK_INPUT;
6945 #endif /* USE_X_TOOLKIT */
6946 break;
6949 done:
6950 if (inev.ie.kind != NO_EVENT)
6952 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
6953 count++;
6956 if (do_help
6957 && !(hold_quit && hold_quit->kind != NO_EVENT))
6959 Lisp_Object frame;
6961 if (f)
6962 XSETFRAME (frame, f);
6963 else
6964 frame = Qnil;
6966 if (do_help > 0)
6968 any_help_event_p = 1;
6969 gen_help_event (help_echo_string, frame, help_echo_window,
6970 help_echo_object, help_echo_pos);
6972 else
6974 help_echo_string = Qnil;
6975 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
6977 count++;
6980 *eventp = event;
6981 return count;
6985 /* Handles the XEvent EVENT on display DISPLAY.
6986 This is used for event loops outside the normal event handling,
6987 i.e. looping while a popup menu or a dialog is posted.
6989 Returns the value handle_one_xevent sets in the finish argument. */
6991 x_dispatch_event (event, display)
6992 XEvent *event;
6993 Display *display;
6995 struct x_display_info *dpyinfo;
6996 int finish = X_EVENT_NORMAL;
6998 dpyinfo = x_display_info_for_display (display);
7000 if (dpyinfo)
7001 handle_one_xevent (dpyinfo, event, &finish, 0);
7003 return finish;
7007 /* Read events coming from the X server.
7008 This routine is called by the SIGIO handler.
7009 We return as soon as there are no more events to be read.
7011 We return the number of characters stored into the buffer,
7012 thus pretending to be `read' (except the characters we store
7013 in the keyboard buffer can be multibyte, so are not necessarily
7014 C chars).
7016 EXPECTED is nonzero if the caller knows input is available. */
7018 static int
7019 XTread_socket (terminal, expected, hold_quit)
7020 struct terminal *terminal;
7021 int expected;
7022 struct input_event *hold_quit;
7024 int count = 0;
7025 XEvent event;
7026 int event_found = 0;
7028 if (interrupt_input_blocked)
7030 interrupt_input_pending = 1;
7031 #ifdef SYNC_INPUT
7032 pending_signals = 1;
7033 #endif
7034 return -1;
7037 interrupt_input_pending = 0;
7038 #ifdef SYNC_INPUT
7039 pending_signals = pending_atimers;
7040 #endif
7041 BLOCK_INPUT;
7043 /* So people can tell when we have read the available input. */
7044 input_signal_count++;
7046 ++handling_signal;
7048 #ifdef HAVE_X_SM
7049 /* Only check session manager input for the primary display. */
7050 if (terminal->id == 1 && x_session_have_connection ())
7052 struct input_event inev;
7053 BLOCK_INPUT;
7054 /* We don't need to EVENT_INIT (inev) here, as
7055 x_session_check_input copies an entire input_event. */
7056 if (x_session_check_input (&inev))
7058 kbd_buffer_store_event_hold (&inev, hold_quit);
7059 count++;
7061 UNBLOCK_INPUT;
7063 #endif
7065 /* For debugging, this gives a way to fake an I/O error. */
7066 if (terminal->display_info.x == XTread_socket_fake_io_error)
7068 XTread_socket_fake_io_error = 0;
7069 x_io_error_quitter (terminal->display_info.x->display);
7072 #ifndef USE_GTK
7073 while (XPending (terminal->display_info.x->display))
7075 int finish;
7077 XNextEvent (terminal->display_info.x->display, &event);
7079 #ifdef HAVE_X_I18N
7080 /* Filter events for the current X input method. */
7081 if (x_filter_event (terminal->display_info.x, &event))
7082 break;
7083 #endif
7084 event_found = 1;
7086 count += handle_one_xevent (terminal->display_info.x,
7087 &event, &finish, hold_quit);
7089 if (finish == X_EVENT_GOTO_OUT)
7090 goto out;
7093 #else /* USE_GTK */
7095 /* For GTK we must use the GTK event loop. But XEvents gets passed
7096 to our filter function above, and then to the big event switch.
7097 We use a bunch of globals to communicate with our filter function,
7098 that is kind of ugly, but it works.
7100 There is no way to do one display at the time, GTK just does events
7101 from all displays. */
7103 while (gtk_events_pending ())
7105 current_count = count;
7106 current_hold_quit = hold_quit;
7108 gtk_main_iteration ();
7110 count = current_count;
7111 current_count = -1;
7112 current_hold_quit = 0;
7114 if (current_finish == X_EVENT_GOTO_OUT)
7115 break;
7117 #endif /* USE_GTK */
7119 out:;
7121 /* On some systems, an X bug causes Emacs to get no more events
7122 when the window is destroyed. Detect that. (1994.) */
7123 if (! event_found)
7125 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
7126 One XNOOP in 100 loops will make Emacs terminate.
7127 B. Bretthauer, 1994 */
7128 x_noop_count++;
7129 if (x_noop_count >= 100)
7131 x_noop_count=0;
7133 if (next_noop_dpyinfo == 0)
7134 next_noop_dpyinfo = x_display_list;
7136 XNoOp (next_noop_dpyinfo->display);
7138 /* Each time we get here, cycle through the displays now open. */
7139 next_noop_dpyinfo = next_noop_dpyinfo->next;
7143 /* If the focus was just given to an auto-raising frame,
7144 raise it now. */
7145 /* ??? This ought to be able to handle more than one such frame. */
7146 if (pending_autoraise_frame)
7148 x_raise_frame (pending_autoraise_frame);
7149 pending_autoraise_frame = 0;
7152 --handling_signal;
7153 UNBLOCK_INPUT;
7155 return count;
7161 /***********************************************************************
7162 Text Cursor
7163 ***********************************************************************/
7165 /* Set clipping for output in glyph row ROW. W is the window in which
7166 we operate. GC is the graphics context to set clipping in.
7168 ROW may be a text row or, e.g., a mode line. Text rows must be
7169 clipped to the interior of the window dedicated to text display,
7170 mode lines must be clipped to the whole window. */
7172 static void
7173 x_clip_to_row (w, row, area, gc)
7174 struct window *w;
7175 struct glyph_row *row;
7176 int area;
7177 GC gc;
7179 struct frame *f = XFRAME (WINDOW_FRAME (w));
7180 XRectangle clip_rect;
7181 int window_x, window_y, window_width;
7183 window_box (w, area, &window_x, &window_y, &window_width, 0);
7185 clip_rect.x = window_x;
7186 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
7187 clip_rect.y = max (clip_rect.y, window_y);
7188 clip_rect.width = window_width;
7189 clip_rect.height = row->visible_height;
7191 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, &clip_rect, 1, Unsorted);
7195 /* Draw a hollow box cursor on window W in glyph row ROW. */
7197 static void
7198 x_draw_hollow_cursor (w, row)
7199 struct window *w;
7200 struct glyph_row *row;
7202 struct frame *f = XFRAME (WINDOW_FRAME (w));
7203 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
7204 Display *dpy = FRAME_X_DISPLAY (f);
7205 int x, y, wd, h;
7206 XGCValues xgcv;
7207 struct glyph *cursor_glyph;
7208 GC gc;
7210 /* Get the glyph the cursor is on. If we can't tell because
7211 the current matrix is invalid or such, give up. */
7212 cursor_glyph = get_phys_cursor_glyph (w);
7213 if (cursor_glyph == NULL)
7214 return;
7216 /* Compute frame-relative coordinates for phys cursor. */
7217 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
7218 wd = w->phys_cursor_width;
7220 /* The foreground of cursor_gc is typically the same as the normal
7221 background color, which can cause the cursor box to be invisible. */
7222 xgcv.foreground = f->output_data.x->cursor_pixel;
7223 if (dpyinfo->scratch_cursor_gc)
7224 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
7225 else
7226 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
7227 GCForeground, &xgcv);
7228 gc = dpyinfo->scratch_cursor_gc;
7230 /* Set clipping, draw the rectangle, and reset clipping again. */
7231 x_clip_to_row (w, row, TEXT_AREA, gc);
7232 XDrawRectangle (dpy, FRAME_X_WINDOW (f), gc, x, y, wd, h - 1);
7233 XSetClipMask (dpy, gc, None);
7237 /* Draw a bar cursor on window W in glyph row ROW.
7239 Implementation note: One would like to draw a bar cursor with an
7240 angle equal to the one given by the font property XA_ITALIC_ANGLE.
7241 Unfortunately, I didn't find a font yet that has this property set.
7242 --gerd. */
7244 static void
7245 x_draw_bar_cursor (w, row, width, kind)
7246 struct window *w;
7247 struct glyph_row *row;
7248 int width;
7249 enum text_cursor_kinds kind;
7251 struct frame *f = XFRAME (w->frame);
7252 struct glyph *cursor_glyph;
7254 /* If cursor is out of bounds, don't draw garbage. This can happen
7255 in mini-buffer windows when switching between echo area glyphs
7256 and mini-buffer. */
7257 cursor_glyph = get_phys_cursor_glyph (w);
7258 if (cursor_glyph == NULL)
7259 return;
7261 /* If on an image, draw like a normal cursor. That's usually better
7262 visible than drawing a bar, esp. if the image is large so that
7263 the bar might not be in the window. */
7264 if (cursor_glyph->type == IMAGE_GLYPH)
7266 struct glyph_row *row;
7267 row = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
7268 draw_phys_cursor_glyph (w, row, DRAW_CURSOR);
7270 else
7272 Display *dpy = FRAME_X_DISPLAY (f);
7273 Window window = FRAME_X_WINDOW (f);
7274 GC gc = FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc;
7275 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
7276 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
7277 XGCValues xgcv;
7279 /* If the glyph's background equals the color we normally draw
7280 the bars cursor in, the bar cursor in its normal color is
7281 invisible. Use the glyph's foreground color instead in this
7282 case, on the assumption that the glyph's colors are chosen so
7283 that the glyph is legible. */
7284 if (face->background == f->output_data.x->cursor_pixel)
7285 xgcv.background = xgcv.foreground = face->foreground;
7286 else
7287 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
7288 xgcv.graphics_exposures = 0;
7290 if (gc)
7291 XChangeGC (dpy, gc, mask, &xgcv);
7292 else
7294 gc = XCreateGC (dpy, window, mask, &xgcv);
7295 FRAME_X_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
7298 x_clip_to_row (w, row, TEXT_AREA, gc);
7300 if (kind == BAR_CURSOR)
7302 if (width < 0)
7303 width = FRAME_CURSOR_WIDTH (f);
7304 width = min (cursor_glyph->pixel_width, width);
7306 w->phys_cursor_width = width;
7308 XFillRectangle (dpy, window, gc,
7309 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7310 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
7311 width, row->height);
7313 else
7315 int dummy_x, dummy_y, dummy_h;
7317 if (width < 0)
7318 width = row->height;
7320 width = min (row->height, width);
7322 get_phys_cursor_geometry (w, row, cursor_glyph, &dummy_x,
7323 &dummy_y, &dummy_h);
7325 XFillRectangle (dpy, window, gc,
7326 WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x),
7327 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
7328 row->height - width),
7329 w->phys_cursor_width, width);
7332 XSetClipMask (dpy, gc, None);
7337 /* RIF: Define cursor CURSOR on frame F. */
7339 static void
7340 x_define_frame_cursor (f, cursor)
7341 struct frame *f;
7342 Cursor cursor;
7344 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
7348 /* RIF: Clear area on frame F. */
7350 static void
7351 x_clear_frame_area (f, x, y, width, height)
7352 struct frame *f;
7353 int x, y, width, height;
7355 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
7356 x, y, width, height, False);
7360 /* RIF: Draw cursor on window W. */
7362 static void
7363 x_draw_window_cursor (w, glyph_row, x, y, cursor_type, cursor_width, on_p, active_p)
7364 struct window *w;
7365 struct glyph_row *glyph_row;
7366 int x, y;
7367 int cursor_type, cursor_width;
7368 int on_p, active_p;
7370 struct frame *f = XFRAME (WINDOW_FRAME (w));
7372 if (on_p)
7374 w->phys_cursor_type = cursor_type;
7375 w->phys_cursor_on_p = 1;
7377 if (glyph_row->exact_window_width_line_p
7378 && w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])
7380 glyph_row->cursor_in_fringe_p = 1;
7381 draw_fringe_bitmap (w, glyph_row, 0);
7383 else
7384 switch (cursor_type)
7386 case HOLLOW_BOX_CURSOR:
7387 x_draw_hollow_cursor (w, glyph_row);
7388 break;
7390 case FILLED_BOX_CURSOR:
7391 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
7392 break;
7394 case BAR_CURSOR:
7395 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
7396 break;
7398 case HBAR_CURSOR:
7399 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
7400 break;
7402 case NO_CURSOR:
7403 w->phys_cursor_width = 0;
7404 break;
7406 default:
7407 abort ();
7410 #ifdef HAVE_X_I18N
7411 if (w == XWINDOW (f->selected_window))
7412 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
7413 xic_set_preeditarea (w, x, y);
7414 #endif
7417 #ifndef XFlush
7418 XFlush (FRAME_X_DISPLAY (f));
7419 #endif
7423 /* Icons. */
7425 /* Make the x-window of frame F use the gnu icon bitmap. */
7428 x_bitmap_icon (f, file)
7429 struct frame *f;
7430 Lisp_Object file;
7432 int bitmap_id;
7434 if (FRAME_X_WINDOW (f) == 0)
7435 return 1;
7437 /* Free up our existing icon bitmap and mask if any. */
7438 if (f->output_data.x->icon_bitmap > 0)
7439 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7440 f->output_data.x->icon_bitmap = 0;
7442 if (STRINGP (file))
7444 #ifdef USE_GTK
7445 /* Use gtk_window_set_icon_from_file () if available,
7446 It's not restricted to bitmaps */
7447 if (xg_set_icon (f, file))
7448 return 0;
7449 #endif /* USE_GTK */
7450 bitmap_id = x_create_bitmap_from_file (f, file);
7451 x_create_bitmap_mask (f, bitmap_id);
7453 else
7455 /* Create the GNU bitmap and mask if necessary. */
7456 if (FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id < 0)
7458 int rc = -1;
7460 #ifdef USE_GTK
7462 if (xg_set_icon (f, xg_default_icon_file)
7463 || xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
7464 return 0;
7466 #elif defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
7468 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
7469 if (rc != -1)
7470 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7472 #endif
7474 /* If all else fails, use the (black and white) xbm image. */
7475 if (rc == -1)
7477 rc = x_create_bitmap_from_data (f, gnu_xbm_bits,
7478 gnu_xbm_width, gnu_xbm_height);
7479 if (rc == -1)
7480 return 1;
7482 FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id = rc;
7483 x_create_bitmap_mask (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7487 /* The first time we create the GNU bitmap and mask,
7488 this increments the ref-count one extra time.
7489 As a result, the GNU bitmap and mask are never freed.
7490 That way, we don't have to worry about allocating it again. */
7491 x_reference_bitmap (f, FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id);
7493 bitmap_id = FRAME_X_DISPLAY_INFO (f)->icon_bitmap_id;
7496 x_wm_set_icon_pixmap (f, bitmap_id);
7497 f->output_data.x->icon_bitmap = bitmap_id;
7499 return 0;
7503 /* Make the x-window of frame F use a rectangle with text.
7504 Use ICON_NAME as the text. */
7507 x_text_icon (f, icon_name)
7508 struct frame *f;
7509 char *icon_name;
7511 if (FRAME_X_WINDOW (f) == 0)
7512 return 1;
7515 XTextProperty text;
7516 text.value = (unsigned char *) icon_name;
7517 text.encoding = XA_STRING;
7518 text.format = 8;
7519 text.nitems = strlen (icon_name);
7520 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
7523 if (f->output_data.x->icon_bitmap > 0)
7524 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
7525 f->output_data.x->icon_bitmap = 0;
7526 x_wm_set_icon_pixmap (f, 0);
7528 return 0;
7531 #define X_ERROR_MESSAGE_SIZE 200
7533 /* If non-nil, this should be a string.
7534 It means catch X errors and store the error message in this string.
7536 The reason we use a stack is that x_catch_error/x_uncatch_error can
7537 be called from a signal handler.
7540 struct x_error_message_stack {
7541 char string[X_ERROR_MESSAGE_SIZE];
7542 Display *dpy;
7543 struct x_error_message_stack *prev;
7545 static struct x_error_message_stack *x_error_message;
7547 /* An X error handler which stores the error message in
7548 *x_error_message. This is called from x_error_handler if
7549 x_catch_errors is in effect. */
7551 static void
7552 x_error_catcher (display, error)
7553 Display *display;
7554 XErrorEvent *error;
7556 XGetErrorText (display, error->error_code,
7557 x_error_message->string,
7558 X_ERROR_MESSAGE_SIZE);
7561 /* Begin trapping X errors for display DPY. Actually we trap X errors
7562 for all displays, but DPY should be the display you are actually
7563 operating on.
7565 After calling this function, X protocol errors no longer cause
7566 Emacs to exit; instead, they are recorded in the string
7567 stored in *x_error_message.
7569 Calling x_check_errors signals an Emacs error if an X error has
7570 occurred since the last call to x_catch_errors or x_check_errors.
7572 Calling x_uncatch_errors resumes the normal error handling. */
7574 void x_check_errors ();
7576 void
7577 x_catch_errors (dpy)
7578 Display *dpy;
7580 struct x_error_message_stack *data = xmalloc (sizeof (*data));
7582 /* Make sure any errors from previous requests have been dealt with. */
7583 XSync (dpy, False);
7585 data->dpy = dpy;
7586 data->string[0] = 0;
7587 data->prev = x_error_message;
7588 x_error_message = data;
7591 /* Undo the last x_catch_errors call.
7592 DPY should be the display that was passed to x_catch_errors. */
7594 void
7595 x_uncatch_errors ()
7597 struct x_error_message_stack *tmp;
7599 BLOCK_INPUT;
7601 /* The display may have been closed before this function is called.
7602 Check if it is still open before calling XSync. */
7603 if (x_display_info_for_display (x_error_message->dpy) != 0)
7604 XSync (x_error_message->dpy, False);
7606 tmp = x_error_message;
7607 x_error_message = x_error_message->prev;
7608 xfree (tmp);
7609 UNBLOCK_INPUT;
7612 /* If any X protocol errors have arrived since the last call to
7613 x_catch_errors or x_check_errors, signal an Emacs error using
7614 sprintf (a buffer, FORMAT, the x error message text) as the text. */
7616 void
7617 x_check_errors (dpy, format)
7618 Display *dpy;
7619 char *format;
7621 /* Make sure to catch any errors incurred so far. */
7622 XSync (dpy, False);
7624 if (x_error_message->string[0])
7626 char string[X_ERROR_MESSAGE_SIZE];
7627 bcopy (x_error_message->string, string, X_ERROR_MESSAGE_SIZE);
7628 x_uncatch_errors ();
7629 error (format, string);
7633 /* Nonzero if we had any X protocol errors
7634 since we did x_catch_errors on DPY. */
7637 x_had_errors_p (dpy)
7638 Display *dpy;
7640 /* Make sure to catch any errors incurred so far. */
7641 XSync (dpy, False);
7643 return x_error_message->string[0] != 0;
7646 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
7648 void
7649 x_clear_errors (dpy)
7650 Display *dpy;
7652 x_error_message->string[0] = 0;
7655 #if 0 /* See comment in unwind_to_catch why calling this is a bad
7656 * idea. --lorentey */
7657 /* Close off all unclosed x_catch_errors calls. */
7659 void
7660 x_fully_uncatch_errors ()
7662 while (x_error_message)
7663 x_uncatch_errors ();
7665 #endif
7667 /* Nonzero if x_catch_errors has been done and not yet canceled. */
7670 x_catching_errors ()
7672 return x_error_message != 0;
7675 #if 0
7676 static unsigned int x_wire_count;
7677 x_trace_wire ()
7679 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
7681 #endif /* ! 0 */
7684 /* Handle SIGPIPE, which can happen when the connection to a server
7685 simply goes away. SIGPIPE is handled by x_connection_signal.
7686 Don't need to do anything, because the write which caused the
7687 SIGPIPE will fail, causing Xlib to invoke the X IO error handler,
7688 which will do the appropriate cleanup for us. */
7690 static SIGTYPE
7691 x_connection_signal (signalnum) /* If we don't have an argument, */
7692 int signalnum; /* some compilers complain in signal calls. */
7694 #ifdef USG
7695 /* USG systems forget handlers when they are used;
7696 must reestablish each time */
7697 signal (signalnum, x_connection_signal);
7698 #endif /* USG */
7702 /************************************************************************
7703 Handling X errors
7704 ************************************************************************/
7706 /* Error message passed to x_connection_closed. */
7708 static char *error_msg;
7710 /* Function installed as fatal_error_signal_hook in
7711 x_connection_closed. Print the X error message, and exit normally,
7712 instead of dumping core when XtCloseDisplay fails. */
7714 static void
7715 x_fatal_error_signal ()
7717 fprintf (stderr, "%s\n", error_msg);
7718 exit (70);
7721 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
7722 the text of an error message that lead to the connection loss. */
7724 static SIGTYPE
7725 x_connection_closed (dpy, error_message)
7726 Display *dpy;
7727 char *error_message;
7729 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
7730 Lisp_Object frame, tail;
7731 int index = SPECPDL_INDEX ();
7733 error_msg = (char *) alloca (strlen (error_message) + 1);
7734 strcpy (error_msg, error_message);
7735 handling_signal = 0;
7737 /* Prevent being called recursively because of an error condition
7738 below. Otherwise, we might end up with printing ``can't find per
7739 display information'' in the recursive call instead of printing
7740 the original message here. */
7741 x_catch_errors (dpy);
7743 /* Inhibit redisplay while frames are being deleted. */
7744 specbind (Qinhibit_redisplay, Qt);
7746 if (dpyinfo)
7748 /* Protect display from being closed when we delete the last
7749 frame on it. */
7750 dpyinfo->reference_count++;
7751 dpyinfo->terminal->reference_count++;
7754 /* First delete frames whose mini-buffers are on frames
7755 that are on the dead display. */
7756 FOR_EACH_FRAME (tail, frame)
7758 Lisp_Object minibuf_frame;
7759 minibuf_frame
7760 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
7761 if (FRAME_X_P (XFRAME (frame))
7762 && FRAME_X_P (XFRAME (minibuf_frame))
7763 && ! EQ (frame, minibuf_frame)
7764 && FRAME_X_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
7765 delete_frame (frame, Qnoelisp);
7768 /* Now delete all remaining frames on the dead display.
7769 We are now sure none of these is used as the mini-buffer
7770 for another frame that we need to delete. */
7771 FOR_EACH_FRAME (tail, frame)
7772 if (FRAME_X_P (XFRAME (frame))
7773 && FRAME_X_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
7775 /* Set this to t so that delete_frame won't get confused
7776 trying to find a replacement. */
7777 FRAME_KBOARD (XFRAME (frame))->Vdefault_minibuffer_frame = Qt;
7778 delete_frame (frame, Qnoelisp);
7781 /* We have to close the display to inform Xt that it doesn't
7782 exist anymore. If we don't, Xt will continue to wait for
7783 events from the display. As a consequence, a sequence of
7785 M-x make-frame-on-display RET :1 RET
7786 ...kill the new frame, so that we get an IO error...
7787 M-x make-frame-on-display RET :1 RET
7789 will indefinitely wait in Xt for events for display `:1', opened
7790 in the first call to make-frame-on-display.
7792 Closing the display is reported to lead to a bus error on
7793 OpenWindows in certain situations. I suspect that is a bug
7794 in OpenWindows. I don't know how to circumvent it here. */
7796 if (dpyinfo)
7798 #ifdef USE_X_TOOLKIT
7799 /* If DPYINFO is null, this means we didn't open the display
7800 in the first place, so don't try to close it. */
7802 extern void (*fatal_error_signal_hook) P_ ((void));
7803 fatal_error_signal_hook = x_fatal_error_signal;
7804 XtCloseDisplay (dpy);
7805 fatal_error_signal_hook = NULL;
7807 #endif
7809 #ifdef USE_GTK
7810 /* Due to bugs in some Gtk+ versions, just exit here if this
7811 is the last display/terminal. */
7812 if (terminal_list->next_terminal == NULL)
7814 fprintf (stderr, "%s\n", error_msg);
7815 shut_down_emacs (0, 0, Qnil);
7816 exit (70);
7818 xg_display_close (dpyinfo->display);
7819 #endif
7821 /* Indicate that this display is dead. */
7822 dpyinfo->display = 0;
7824 dpyinfo->reference_count--;
7825 dpyinfo->terminal->reference_count--;
7826 if (dpyinfo->reference_count != 0)
7827 /* We have just closed all frames on this display. */
7828 abort ();
7831 Lisp_Object tmp;
7832 XSETTERMINAL (tmp, dpyinfo->terminal);
7833 Fdelete_terminal (tmp, Qnoelisp);
7837 x_uncatch_errors ();
7839 if (terminal_list == 0)
7841 fprintf (stderr, "%s\n", error_msg);
7842 shut_down_emacs (0, 0, Qnil);
7843 exit (70);
7846 /* Ordinary stack unwind doesn't deal with these. */
7847 #ifdef SIGIO
7848 sigunblock (sigmask (SIGIO));
7849 #endif
7850 sigunblock (sigmask (SIGALRM));
7851 TOTALLY_UNBLOCK_INPUT;
7853 unbind_to (index, Qnil);
7854 clear_waiting_for_input ();
7855 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
7856 longjmp), because returning from this function would get us back into
7857 Xlib's code which will directly call `exit'. */
7858 error ("%s", error_msg);
7861 /* We specifically use it before defining it, so that gcc doesn't inline it,
7862 otherwise gdb doesn't know how to properly put a breakpoint on it. */
7863 static void x_error_quitter P_ ((Display *, XErrorEvent *));
7865 /* This is the first-level handler for X protocol errors.
7866 It calls x_error_quitter or x_error_catcher. */
7868 static int
7869 x_error_handler (display, error)
7870 Display *display;
7871 XErrorEvent *error;
7873 if (x_error_message)
7874 x_error_catcher (display, error);
7875 else
7876 x_error_quitter (display, error);
7877 return 0;
7880 /* This is the usual handler for X protocol errors.
7881 It kills all frames on the display that we got the error for.
7882 If that was the only one, it prints an error message and kills Emacs. */
7884 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
7886 #if __GNUC__ >= 3 /* On GCC 3.0 we might get a warning. */
7887 #define NO_INLINE __attribute__((noinline))
7888 #else
7889 #define NO_INLINE
7890 #endif
7892 /* Some versions of GNU/Linux define noinline in their headers. */
7894 #ifdef noinline
7895 #undef noinline
7896 #endif
7898 /* On older GCC versions, just putting x_error_quitter
7899 after x_error_handler prevents inlining into the former. */
7901 static void NO_INLINE
7902 x_error_quitter (display, error)
7903 Display *display;
7904 XErrorEvent *error;
7906 char buf[256], buf1[356];
7908 /* Ignore BadName errors. They can happen because of fonts
7909 or colors that are not defined. */
7911 if (error->error_code == BadName)
7912 return;
7914 /* Note that there is no real way portable across R3/R4 to get the
7915 original error handler. */
7917 XGetErrorText (display, error->error_code, buf, sizeof (buf));
7918 sprintf (buf1, "X protocol error: %s on protocol request %d",
7919 buf, error->request_code);
7920 x_connection_closed (display, buf1);
7924 /* This is the handler for X IO errors, always.
7925 It kills all frames on the display that we lost touch with.
7926 If that was the only one, it prints an error message and kills Emacs. */
7928 static int
7929 x_io_error_quitter (display)
7930 Display *display;
7932 char buf[256];
7934 sprintf (buf, "Connection lost to X server `%s'", DisplayString (display));
7935 x_connection_closed (display, buf);
7936 return 0;
7939 /* Changing the font of the frame. */
7941 /* Give frame F the font FONT-OBJECT as its default font. The return
7942 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
7943 frame. If it is negative, generate a new fontset from
7944 FONT-OBJECT. */
7946 Lisp_Object
7947 x_new_font (f, font_object, fontset)
7948 struct frame *f;
7949 Lisp_Object font_object;
7950 int fontset;
7952 struct font *font = XFONT_OBJECT (font_object);
7954 if (fontset < 0)
7955 fontset = fontset_from_font (font_object);
7956 FRAME_FONTSET (f) = fontset;
7957 if (FRAME_FONT (f) == font)
7958 /* This font is already set in frame F. There's nothing more to
7959 do. */
7960 return font_object;
7962 FRAME_FONT (f) = font;
7963 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
7964 FRAME_COLUMN_WIDTH (f) = font->average_width;
7965 FRAME_SPACE_WIDTH (f) = font->space_width;
7966 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
7968 compute_fringe_widths (f, 1);
7970 /* Compute the scroll bar width in character columns. */
7971 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
7973 int wid = FRAME_COLUMN_WIDTH (f);
7974 FRAME_CONFIG_SCROLL_BAR_COLS (f)
7975 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + wid-1) / wid;
7977 else
7979 int wid = FRAME_COLUMN_WIDTH (f);
7980 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + wid - 1) / wid;
7983 if (FRAME_X_WINDOW (f) != 0)
7985 /* Don't change the size of a tip frame; there's no point in
7986 doing it because it's done in Fx_show_tip, and it leads to
7987 problems because the tip frame has no widget. */
7988 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
7989 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
7992 #ifdef HAVE_X_I18N
7993 if (FRAME_XIC (f)
7994 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
7996 BLOCK_INPUT;
7997 xic_set_xfontset (f, SDATA (fontset_ascii (fontset)));
7998 UNBLOCK_INPUT;
8000 #endif
8002 return font_object;
8006 /***********************************************************************
8007 X Input Methods
8008 ***********************************************************************/
8010 #ifdef HAVE_X_I18N
8012 #ifdef HAVE_X11R6
8014 /* XIM destroy callback function, which is called whenever the
8015 connection to input method XIM dies. CLIENT_DATA contains a
8016 pointer to the x_display_info structure corresponding to XIM. */
8018 static void
8019 xim_destroy_callback (xim, client_data, call_data)
8020 XIM xim;
8021 XPointer client_data;
8022 XPointer call_data;
8024 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
8025 Lisp_Object frame, tail;
8027 BLOCK_INPUT;
8029 /* No need to call XDestroyIC.. */
8030 FOR_EACH_FRAME (tail, frame)
8032 struct frame *f = XFRAME (frame);
8033 if (FRAME_X_P (f) && FRAME_X_DISPLAY_INFO (f) == dpyinfo)
8035 FRAME_XIC (f) = NULL;
8036 xic_free_xfontset (f);
8040 /* No need to call XCloseIM. */
8041 dpyinfo->xim = NULL;
8042 XFree (dpyinfo->xim_styles);
8043 UNBLOCK_INPUT;
8046 #endif /* HAVE_X11R6 */
8048 #ifdef HAVE_X11R6
8049 /* This isn't prototyped in OSF 5.0 or 5.1a. */
8050 extern char *XSetIMValues P_ ((XIM, ...));
8051 #endif
8053 /* Open the connection to the XIM server on display DPYINFO.
8054 RESOURCE_NAME is the resource name Emacs uses. */
8056 static void
8057 xim_open_dpy (dpyinfo, resource_name)
8058 struct x_display_info *dpyinfo;
8059 char *resource_name;
8061 XIM xim;
8063 #ifdef HAVE_XIM
8064 if (use_xim)
8066 if (dpyinfo->xim)
8067 XCloseIM (dpyinfo->xim);
8068 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
8069 EMACS_CLASS);
8070 dpyinfo->xim = xim;
8072 if (xim)
8074 #ifdef HAVE_X11R6
8075 XIMCallback destroy;
8076 #endif
8078 /* Get supported styles and XIM values. */
8079 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
8081 #ifdef HAVE_X11R6
8082 destroy.callback = xim_destroy_callback;
8083 destroy.client_data = (XPointer)dpyinfo;
8084 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
8085 #endif
8089 else
8090 #endif /* HAVE_XIM */
8091 dpyinfo->xim = NULL;
8095 #ifdef HAVE_X11R6_XIM
8097 /* XIM instantiate callback function, which is called whenever an XIM
8098 server is available. DISPLAY is the display of the XIM.
8099 CLIENT_DATA contains a pointer to an xim_inst_t structure created
8100 when the callback was registered. */
8102 static void
8103 xim_instantiate_callback (display, client_data, call_data)
8104 Display *display;
8105 XPointer client_data;
8106 XPointer call_data;
8108 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
8109 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
8111 /* We don't support multiple XIM connections. */
8112 if (dpyinfo->xim)
8113 return;
8115 xim_open_dpy (dpyinfo, xim_inst->resource_name);
8117 /* Create XIC for the existing frames on the same display, as long
8118 as they have no XIC. */
8119 if (dpyinfo->xim && dpyinfo->reference_count > 0)
8121 Lisp_Object tail, frame;
8123 BLOCK_INPUT;
8124 FOR_EACH_FRAME (tail, frame)
8126 struct frame *f = XFRAME (frame);
8128 if (FRAME_X_P (f)
8129 && FRAME_X_DISPLAY_INFO (f) == xim_inst->dpyinfo)
8130 if (FRAME_XIC (f) == NULL)
8132 create_frame_xic (f);
8133 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
8134 xic_set_statusarea (f);
8135 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
8137 struct window *w = XWINDOW (f->selected_window);
8138 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
8143 UNBLOCK_INPUT;
8147 #endif /* HAVE_X11R6_XIM */
8150 /* Open a connection to the XIM server on display DPYINFO.
8151 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
8152 connection only at the first time. On X11R6, open the connection
8153 in the XIM instantiate callback function. */
8155 static void
8156 xim_initialize (dpyinfo, resource_name)
8157 struct x_display_info *dpyinfo;
8158 char *resource_name;
8160 dpyinfo->xim = NULL;
8161 #ifdef HAVE_XIM
8162 if (use_xim)
8164 #ifdef HAVE_X11R6_XIM
8165 struct xim_inst_t *xim_inst;
8166 int len;
8168 xim_inst = (struct xim_inst_t *) xmalloc (sizeof (struct xim_inst_t));
8169 dpyinfo->xim_callback_data = xim_inst;
8170 xim_inst->dpyinfo = dpyinfo;
8171 len = strlen (resource_name);
8172 xim_inst->resource_name = (char *) xmalloc (len + 1);
8173 bcopy (resource_name, xim_inst->resource_name, len + 1);
8174 XRegisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8175 resource_name, EMACS_CLASS,
8176 xim_instantiate_callback,
8177 /* This is XPointer in XFree86
8178 but (XPointer *) on Tru64, at
8179 least, hence the configure test. */
8180 (XRegisterIMInstantiateCallback_arg6) xim_inst);
8181 #else /* not HAVE_X11R6_XIM */
8182 xim_open_dpy (dpyinfo, resource_name);
8183 #endif /* not HAVE_X11R6_XIM */
8185 #endif /* HAVE_XIM */
8189 /* Close the connection to the XIM server on display DPYINFO. */
8191 static void
8192 xim_close_dpy (dpyinfo)
8193 struct x_display_info *dpyinfo;
8195 #ifdef HAVE_XIM
8196 if (use_xim)
8198 #ifdef HAVE_X11R6_XIM
8199 if (dpyinfo->display)
8200 XUnregisterIMInstantiateCallback (dpyinfo->display, dpyinfo->xrdb,
8201 NULL, EMACS_CLASS,
8202 xim_instantiate_callback, NULL);
8203 xfree (dpyinfo->xim_callback_data->resource_name);
8204 xfree (dpyinfo->xim_callback_data);
8205 #endif /* HAVE_X11R6_XIM */
8206 if (dpyinfo->display)
8207 XCloseIM (dpyinfo->xim);
8208 dpyinfo->xim = NULL;
8209 XFree (dpyinfo->xim_styles);
8211 #endif /* HAVE_XIM */
8214 #endif /* not HAVE_X11R6_XIM */
8218 /* Calculate the absolute position in frame F
8219 from its current recorded position values and gravity. */
8221 void
8222 x_calc_absolute_position (f)
8223 struct frame *f;
8225 int flags = f->size_hint_flags;
8227 /* We have nothing to do if the current position
8228 is already for the top-left corner. */
8229 if (! ((flags & XNegative) || (flags & YNegative)))
8230 return;
8232 /* Treat negative positions as relative to the leftmost bottommost
8233 position that fits on the screen. */
8234 if (flags & XNegative)
8235 f->left_pos = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
8236 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
8239 int height = FRAME_PIXEL_HEIGHT (f);
8241 #if defined USE_X_TOOLKIT && defined USE_MOTIF
8242 /* Something is fishy here. When using Motif, starting Emacs with
8243 `-g -0-0', the frame appears too low by a few pixels.
8245 This seems to be so because initially, while Emacs is starting,
8246 the column widget's height and the frame's pixel height are
8247 different. The column widget's height is the right one. In
8248 later invocations, when Emacs is up, the frame's pixel height
8249 is right, though.
8251 It's not obvious where the initial small difference comes from.
8252 2000-12-01, gerd. */
8254 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
8255 #endif
8257 if (flags & YNegative)
8258 f->top_pos = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
8259 - height + f->top_pos;
8262 /* The left_pos and top_pos
8263 are now relative to the top and left screen edges,
8264 so the flags should correspond. */
8265 f->size_hint_flags &= ~ (XNegative | YNegative);
8268 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
8269 to really change the position, and 0 when calling from
8270 x_make_frame_visible (in that case, XOFF and YOFF are the current
8271 position values). It is -1 when calling from x_set_frame_parameters,
8272 which means, do adjust for borders but don't change the gravity. */
8274 void
8275 x_set_offset (f, xoff, yoff, change_gravity)
8276 struct frame *f;
8277 register int xoff, yoff;
8278 int change_gravity;
8280 int modified_top, modified_left;
8282 if (change_gravity > 0)
8284 FRAME_X_OUTPUT (f)->left_before_move = f->left_pos;
8285 FRAME_X_OUTPUT (f)->top_before_move = f->top_pos;
8287 f->top_pos = yoff;
8288 f->left_pos = xoff;
8289 f->size_hint_flags &= ~ (XNegative | YNegative);
8290 if (xoff < 0)
8291 f->size_hint_flags |= XNegative;
8292 if (yoff < 0)
8293 f->size_hint_flags |= YNegative;
8294 f->win_gravity = NorthWestGravity;
8296 x_calc_absolute_position (f);
8298 BLOCK_INPUT;
8299 x_wm_set_size_hint (f, (long) 0, 0);
8301 modified_left = f->left_pos;
8302 modified_top = f->top_pos;
8304 if (change_gravity != 0 && FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
8306 /* Some WMs (twm, wmaker at least) has an offset that is smaller
8307 than the WM decorations. So we use the calculated offset instead
8308 of the WM decoration sizes here (x/y_pixels_outer_diff). */
8309 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
8310 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
8313 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8314 modified_left, modified_top);
8316 x_sync_with_move (f, f->left_pos, f->top_pos,
8317 FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8318 ? 1 : 0);
8320 /* change_gravity is non-zero when this function is called from Lisp to
8321 programmatically move a frame. In that case, we call
8322 x_check_expected_move to discover if we have a "Type A" or "Type B"
8323 window manager, and, for a "Type A" window manager, adjust the position
8324 of the frame.
8326 We call x_check_expected_move if a programmatic move occurred, and
8327 either the window manager type (A/B) is unknown or it is Type A but we
8328 need to compute the top/left offset adjustment for this frame. */
8330 if (change_gravity != 0 &&
8331 (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
8332 || (FRAME_X_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
8333 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
8334 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
8335 x_check_expected_move (f, modified_left, modified_top);
8337 UNBLOCK_INPUT;
8340 /* Return non-zero if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
8341 on the root window for frame F contains ATOMNAME.
8342 This is how a WM check shall be done according to the Window Manager
8343 Specification/Extended Window Manager Hints at
8344 http://freedesktop.org/wiki/Specifications/wm-spec. */
8346 static int
8347 wm_supports (f, atomname)
8348 struct frame *f;
8349 const char *atomname;
8351 Atom actual_type;
8352 unsigned long actual_size, bytes_remaining;
8353 int i, rc, actual_format;
8354 Atom prop_atom;
8355 Window wmcheck_window;
8356 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8357 Window target_window = dpyinfo->root_window;
8358 long max_len = 65536;
8359 Display *dpy = FRAME_X_DISPLAY (f);
8360 unsigned char *tmp_data = NULL;
8361 Atom target_type = XA_WINDOW;
8362 Atom want_atom;
8364 BLOCK_INPUT;
8366 prop_atom = XInternAtom (dpy, "_NET_SUPPORTING_WM_CHECK", False);
8368 x_catch_errors (dpy);
8369 rc = XGetWindowProperty (dpy, target_window,
8370 prop_atom, 0, max_len, False, target_type,
8371 &actual_type, &actual_format, &actual_size,
8372 &bytes_remaining, &tmp_data);
8374 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
8376 if (tmp_data) XFree (tmp_data);
8377 x_uncatch_errors ();
8378 UNBLOCK_INPUT;
8379 return 0;
8382 wmcheck_window = *(Window *) tmp_data;
8383 XFree (tmp_data);
8385 /* Check if window exists. */
8386 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
8387 x_sync (f);
8388 if (x_had_errors_p (dpy))
8390 x_uncatch_errors ();
8391 UNBLOCK_INPUT;
8392 return 0;
8395 if (dpyinfo->net_supported_window != wmcheck_window)
8397 /* Window changed, reload atoms */
8398 if (dpyinfo->net_supported_atoms != NULL)
8399 XFree (dpyinfo->net_supported_atoms);
8400 dpyinfo->net_supported_atoms = NULL;
8401 dpyinfo->nr_net_supported_atoms = 0;
8402 dpyinfo->net_supported_window = 0;
8404 target_type = XA_ATOM;
8405 prop_atom = XInternAtom (dpy, "_NET_SUPPORTED", False);
8406 tmp_data = NULL;
8407 rc = XGetWindowProperty (dpy, target_window,
8408 prop_atom, 0, max_len, False, target_type,
8409 &actual_type, &actual_format, &actual_size,
8410 &bytes_remaining, &tmp_data);
8412 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
8414 if (tmp_data) XFree (tmp_data);
8415 x_uncatch_errors ();
8416 UNBLOCK_INPUT;
8417 return 0;
8420 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
8421 dpyinfo->nr_net_supported_atoms = actual_size;
8422 dpyinfo->net_supported_window = wmcheck_window;
8425 rc = 0;
8426 want_atom = XInternAtom (dpy, atomname, False);
8428 for (i = 0; rc == 0 && i < dpyinfo->nr_net_supported_atoms; ++i)
8429 rc = dpyinfo->net_supported_atoms[i] == want_atom;
8431 x_uncatch_errors ();
8432 UNBLOCK_INPUT;
8434 return rc;
8437 static void
8438 set_wm_state (frame, add, what, what2)
8439 Lisp_Object frame;
8440 int add;
8441 const char *what;
8442 const char *what2;
8444 const char *atom = "_NET_WM_STATE";
8445 Fx_send_client_event (frame, make_number (0), frame,
8446 make_unibyte_string (atom, strlen (atom)),
8447 make_number (32),
8448 /* 1 = add, 0 = remove */
8449 Fcons
8450 (make_number (add ? 1 : 0),
8451 Fcons
8452 (make_unibyte_string (what, strlen (what)),
8453 what2 != 0
8454 ? Fcons (make_unibyte_string (what2, strlen (what2)),
8455 Qnil)
8456 : Qnil)));
8459 /* Do fullscreen as specified in extended window manager hints */
8461 static int
8462 do_ewmh_fullscreen (f)
8463 struct frame *f;
8465 int have_net_atom = wm_supports (f, "_NET_WM_STATE");
8467 /* Some window managers don't say they support _NET_WM_STATE, but they do say
8468 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
8469 if (!have_net_atom)
8470 have_net_atom = wm_supports (f, "_NET_WM_STATE_FULLSCREEN");
8472 if (have_net_atom)
8474 Lisp_Object frame;
8475 const char *fs = "_NET_WM_STATE_FULLSCREEN";
8476 const char *fw = "_NET_WM_STATE_MAXIMIZED_HORZ";
8477 const char *fh = "_NET_WM_STATE_MAXIMIZED_VERT";
8479 XSETFRAME (frame, f);
8481 set_wm_state (frame, 0, fs, NULL);
8482 set_wm_state (frame, 0, fh, NULL);
8483 set_wm_state (frame, 0, fw, NULL);
8485 /* If there are _NET_ atoms we assume we have extended window manager
8486 hints. */
8487 switch (f->want_fullscreen)
8489 case FULLSCREEN_BOTH:
8490 set_wm_state (frame, 1, fs, NULL);
8491 break;
8492 case FULLSCREEN_WIDTH:
8493 set_wm_state (frame, 1, fw, NULL);
8494 break;
8495 case FULLSCREEN_HEIGHT:
8496 set_wm_state (frame, 1, fh, NULL);
8497 break;
8498 case FULLSCREEN_MAXIMIZED:
8499 set_wm_state (frame, 1, fw, fh);
8500 break;
8503 f->want_fullscreen = FULLSCREEN_NONE;
8507 return have_net_atom;
8510 static void
8511 XTfullscreen_hook (f)
8512 FRAME_PTR f;
8514 if (f->async_visible)
8516 BLOCK_INPUT;
8517 x_check_fullscreen (f);
8518 x_sync (f);
8519 UNBLOCK_INPUT;
8524 static void
8525 x_handle_net_wm_state (f, event)
8526 struct frame *f;
8527 XPropertyEvent *event;
8529 Atom actual_type;
8530 unsigned long actual_size, bytes_remaining;
8531 int i, rc, actual_format, value = FULLSCREEN_NONE;
8532 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8533 long max_len = 65536;
8534 Display *dpy = FRAME_X_DISPLAY (f);
8535 unsigned char *tmp_data = NULL;
8536 Atom target_type = XA_ATOM;
8537 Lisp_Object lval;
8539 BLOCK_INPUT;
8540 x_catch_errors (dpy);
8541 rc = XGetWindowProperty (dpy, event->window,
8542 event->atom, 0, max_len, False, target_type,
8543 &actual_type, &actual_format, &actual_size,
8544 &bytes_remaining, &tmp_data);
8546 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
8548 if (tmp_data) XFree (tmp_data);
8549 x_uncatch_errors ();
8550 UNBLOCK_INPUT;
8551 return;
8554 x_uncatch_errors ();
8556 for (i = 0; i < actual_size; ++i)
8558 Atom a = ((Atom*)tmp_data)[i];
8559 if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
8561 if (value == FULLSCREEN_HEIGHT)
8562 value = FULLSCREEN_MAXIMIZED;
8563 else
8564 value = FULLSCREEN_WIDTH;
8566 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
8568 if (value == FULLSCREEN_WIDTH)
8569 value = FULLSCREEN_MAXIMIZED;
8570 else
8571 value = FULLSCREEN_HEIGHT;
8573 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen_atom)
8574 value = FULLSCREEN_BOTH;
8577 lval = Qnil;
8578 switch (value)
8580 case FULLSCREEN_WIDTH:
8581 lval = Qfullwidth;
8582 break;
8583 case FULLSCREEN_HEIGHT:
8584 lval = Qfullheight;
8585 break;
8586 case FULLSCREEN_BOTH:
8587 lval = Qfullboth;
8588 break;
8589 case FULLSCREEN_MAXIMIZED:
8590 lval = Qmaximized;
8591 break;
8594 store_frame_param (f, Qfullscreen, lval);
8596 if (tmp_data) XFree (tmp_data);
8597 UNBLOCK_INPUT;
8600 /* Check if we need to resize the frame due to a fullscreen request.
8601 If so needed, resize the frame. */
8602 static void
8603 x_check_fullscreen (f)
8604 struct frame *f;
8606 if (do_ewmh_fullscreen (f))
8607 return;
8609 if (f->output_data.x->parent_desc != FRAME_X_DISPLAY_INFO (f)->root_window)
8610 return; // Only fullscreen without WM or with EWM hints (above).
8612 if (f->want_fullscreen != FULLSCREEN_NONE)
8614 int width = FRAME_COLS (f), height = FRAME_LINES (f);
8615 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
8617 switch (f->want_fullscreen)
8619 /* No difference between these two when there is no WM */
8620 case FULLSCREEN_BOTH:
8621 case FULLSCREEN_MAXIMIZED:
8622 width = x_display_pixel_width (dpyinfo);
8623 height = x_display_pixel_height (dpyinfo);
8624 break;
8625 case FULLSCREEN_WIDTH:
8626 width = x_display_pixel_width (dpyinfo);
8627 break;
8628 case FULLSCREEN_HEIGHT:
8629 height = x_display_pixel_height (dpyinfo);
8632 if (FRAME_COLS (f) != width || FRAME_LINES (f) != height)
8634 change_frame_size (f, height, width, 0, 1, 0);
8635 SET_FRAME_GARBAGED (f);
8636 cancel_mouse_face (f);
8641 /* This function is called by x_set_offset to determine whether the window
8642 manager interfered with the positioning of the frame. Type A window
8643 managers position the surrounding window manager decorations a small
8644 amount above and left of the user-supplied position. Type B window
8645 managers position the surrounding window manager decorations at the
8646 user-specified position. If we detect a Type A window manager, we
8647 compensate by moving the window right and down by the proper amount. */
8649 static void
8650 x_check_expected_move (f, expected_left, expected_top)
8651 struct frame *f;
8652 int expected_left;
8653 int expected_top;
8655 int current_left = 0, current_top = 0;
8657 /* x_real_positions returns the left and top offsets of the outermost
8658 window manager window around the frame. */
8660 x_real_positions (f, &current_left, &current_top);
8662 if (current_left != expected_left || current_top != expected_top)
8664 /* It's a "Type A" window manager. */
8666 int adjusted_left;
8667 int adjusted_top;
8669 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
8670 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
8671 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
8673 /* Now fix the mispositioned frame's location. */
8675 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
8676 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
8678 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
8679 adjusted_left, adjusted_top);
8681 x_sync_with_move (f, expected_left, expected_top, 0);
8683 else
8684 /* It's a "Type B" window manager. We don't have to adjust the
8685 frame's position. */
8687 FRAME_X_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
8691 /* Wait for XGetGeometry to return up-to-date position information for a
8692 recently-moved frame. Call this immediately after calling XMoveWindow.
8693 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
8694 frame has been moved to, so we use a fuzzy position comparison instead
8695 of an exact comparison. */
8697 static void
8698 x_sync_with_move (f, left, top, fuzzy)
8699 struct frame *f;
8700 int left, top, fuzzy;
8702 int count = 0;
8704 while (count++ < 50)
8706 int current_left = 0, current_top = 0;
8708 /* In theory, this call to XSync only needs to happen once, but in
8709 practice, it doesn't seem to work, hence the need for the surrounding
8710 loop. */
8712 XSync (FRAME_X_DISPLAY (f), False);
8713 x_real_positions (f, &current_left, &current_top);
8715 if (fuzzy)
8717 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
8718 pixels. */
8720 if (eabs (current_left - left) <= 10
8721 && eabs (current_top - top) <= 40)
8722 return;
8724 else if (current_left == left && current_top == top)
8725 return;
8728 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
8729 will then return up-to-date position info. */
8731 wait_reading_process_output (0, 500000, 0, 0, Qnil, NULL, 0);
8735 /* Change the size of frame F's X window to COLS/ROWS in the case F
8736 doesn't have a widget. If CHANGE_GRAVITY is 1, we change to
8737 top-left-corner window gravity for this size change and subsequent
8738 size changes. Otherwise we leave the window gravity unchanged. */
8740 static void
8741 x_set_window_size_1 (f, change_gravity, cols, rows)
8742 struct frame *f;
8743 int change_gravity;
8744 int cols, rows;
8746 int pixelwidth, pixelheight;
8748 check_frame_size (f, &rows, &cols);
8749 f->scroll_bar_actual_width
8750 = (!FRAME_HAS_VERTICAL_SCROLL_BARS (f)
8752 : FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0
8753 ? FRAME_CONFIG_SCROLL_BAR_WIDTH (f)
8754 : (FRAME_CONFIG_SCROLL_BAR_COLS (f) * FRAME_COLUMN_WIDTH (f)));
8756 compute_fringe_widths (f, 0);
8758 pixelwidth = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, cols);
8759 pixelheight = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, rows);
8761 f->win_gravity = NorthWestGravity;
8762 x_wm_set_size_hint (f, (long) 0, 0);
8764 XSync (FRAME_X_DISPLAY (f), False);
8765 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8766 pixelwidth, pixelheight);
8768 /* Now, strictly speaking, we can't be sure that this is accurate,
8769 but the window manager will get around to dealing with the size
8770 change request eventually, and we'll hear how it went when the
8771 ConfigureNotify event gets here.
8773 We could just not bother storing any of this information here,
8774 and let the ConfigureNotify event set everything up, but that
8775 might be kind of confusing to the Lisp code, since size changes
8776 wouldn't be reported in the frame parameters until some random
8777 point in the future when the ConfigureNotify event arrives.
8779 We pass 1 for DELAY since we can't run Lisp code inside of
8780 a BLOCK_INPUT. */
8781 change_frame_size (f, rows, cols, 0, 1, 0);
8782 FRAME_PIXEL_WIDTH (f) = pixelwidth;
8783 FRAME_PIXEL_HEIGHT (f) = pixelheight;
8785 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
8786 receive in the ConfigureNotify event; if we get what we asked
8787 for, then the event won't cause the screen to become garbaged, so
8788 we have to make sure to do it here. */
8789 SET_FRAME_GARBAGED (f);
8791 XFlush (FRAME_X_DISPLAY (f));
8795 /* Call this to change the size of frame F's x-window.
8796 If CHANGE_GRAVITY is 1, we change to top-left-corner window gravity
8797 for this size change and subsequent size changes.
8798 Otherwise we leave the window gravity unchanged. */
8800 void
8801 x_set_window_size (f, change_gravity, cols, rows)
8802 struct frame *f;
8803 int change_gravity;
8804 int cols, rows;
8806 BLOCK_INPUT;
8808 #ifdef USE_GTK
8809 if (FRAME_GTK_WIDGET (f))
8810 xg_frame_set_char_size (f, cols, rows);
8811 else
8812 x_set_window_size_1 (f, change_gravity, cols, rows);
8813 #elif USE_X_TOOLKIT
8815 if (f->output_data.x->widget != NULL)
8817 /* The x and y position of the widget is clobbered by the
8818 call to XtSetValues within EmacsFrameSetCharSize.
8819 This is a real kludge, but I don't understand Xt so I can't
8820 figure out a correct fix. Can anyone else tell me? -- rms. */
8821 int xpos = f->output_data.x->widget->core.x;
8822 int ypos = f->output_data.x->widget->core.y;
8823 EmacsFrameSetCharSize (f->output_data.x->edit_widget, cols, rows);
8824 f->output_data.x->widget->core.x = xpos;
8825 f->output_data.x->widget->core.y = ypos;
8827 else
8828 x_set_window_size_1 (f, change_gravity, cols, rows);
8830 #else /* not USE_X_TOOLKIT */
8832 x_set_window_size_1 (f, change_gravity, cols, rows);
8834 #endif /* not USE_X_TOOLKIT */
8836 /* If cursor was outside the new size, mark it as off. */
8837 mark_window_cursors_off (XWINDOW (f->root_window));
8839 /* Clear out any recollection of where the mouse highlighting was,
8840 since it might be in a place that's outside the new frame size.
8841 Actually checking whether it is outside is a pain in the neck,
8842 so don't try--just let the highlighting be done afresh with new size. */
8843 cancel_mouse_face (f);
8845 UNBLOCK_INPUT;
8848 /* Mouse warping. */
8850 void
8851 x_set_mouse_position (f, x, y)
8852 struct frame *f;
8853 int x, y;
8855 int pix_x, pix_y;
8857 pix_x = FRAME_COL_TO_PIXEL_X (f, x) + FRAME_COLUMN_WIDTH (f) / 2;
8858 pix_y = FRAME_LINE_TO_PIXEL_Y (f, y) + FRAME_LINE_HEIGHT (f) / 2;
8860 if (pix_x < 0) pix_x = 0;
8861 if (pix_x > FRAME_PIXEL_WIDTH (f)) pix_x = FRAME_PIXEL_WIDTH (f);
8863 if (pix_y < 0) pix_y = 0;
8864 if (pix_y > FRAME_PIXEL_HEIGHT (f)) pix_y = FRAME_PIXEL_HEIGHT (f);
8866 BLOCK_INPUT;
8868 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8869 0, 0, 0, 0, pix_x, pix_y);
8870 UNBLOCK_INPUT;
8873 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
8875 void
8876 x_set_mouse_pixel_position (f, pix_x, pix_y)
8877 struct frame *f;
8878 int pix_x, pix_y;
8880 BLOCK_INPUT;
8882 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
8883 0, 0, 0, 0, pix_x, pix_y);
8884 UNBLOCK_INPUT;
8887 /* focus shifting, raising and lowering. */
8889 void
8890 x_focus_on_frame (f)
8891 struct frame *f;
8893 #if 0
8894 /* I don't think that the ICCCM allows programs to do things like this
8895 without the interaction of the window manager. Whatever you end up
8896 doing with this code, do it to x_unfocus_frame too. */
8897 XSetInputFocus (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
8898 RevertToPointerRoot, CurrentTime);
8899 #endif /* ! 0 */
8902 void
8903 x_unfocus_frame (f)
8904 struct frame *f;
8906 #if 0
8907 /* Look at the remarks in x_focus_on_frame. */
8908 if (FRAME_X_DISPLAY_INFO (f)->x_focus_frame == f)
8909 XSetInputFocus (FRAME_X_DISPLAY (f), PointerRoot,
8910 RevertToPointerRoot, CurrentTime);
8911 #endif /* ! 0 */
8914 /* Raise frame F. */
8916 void
8917 x_raise_frame (f)
8918 struct frame *f;
8920 BLOCK_INPUT;
8921 if (f->async_visible)
8922 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8924 XFlush (FRAME_X_DISPLAY (f));
8925 UNBLOCK_INPUT;
8928 /* Lower frame F. */
8930 void
8931 x_lower_frame (f)
8932 struct frame *f;
8934 if (f->async_visible)
8936 BLOCK_INPUT;
8937 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
8938 XFlush (FRAME_X_DISPLAY (f));
8939 UNBLOCK_INPUT;
8943 /* Activate frame with Extended Window Manager Hints */
8945 void
8946 x_ewmh_activate_frame (f)
8947 FRAME_PTR f;
8949 /* See Window Manager Specification/Extended Window Manager Hints at
8950 http://freedesktop.org/wiki/Specifications/wm-spec */
8952 const char *atom = "_NET_ACTIVE_WINDOW";
8953 if (f->async_visible && wm_supports (f, atom))
8955 Lisp_Object frame;
8956 XSETFRAME (frame, f);
8957 Fx_send_client_event (frame, make_number (0), frame,
8958 make_unibyte_string (atom, strlen (atom)),
8959 make_number (32),
8960 Fcons (make_number (1),
8961 Fcons (make_number (last_user_time),
8962 Qnil)));
8966 static void
8967 XTframe_raise_lower (f, raise_flag)
8968 FRAME_PTR f;
8969 int raise_flag;
8971 if (raise_flag)
8972 x_raise_frame (f);
8973 else
8974 x_lower_frame (f);
8977 /* XEmbed implementation. */
8979 void
8980 xembed_set_info (f, flags)
8981 struct frame *f;
8982 enum xembed_info flags;
8984 Atom atom;
8985 unsigned long data[2];
8987 atom = XInternAtom (FRAME_X_DISPLAY (f), "_XEMBED_INFO", False);
8989 data[0] = XEMBED_VERSION;
8990 data[1] = flags;
8992 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), atom, atom,
8993 32, PropModeReplace, (unsigned char *) data, 2);
8996 void
8997 xembed_send_message (f, time, message, detail, data1, data2)
8998 struct frame *f;
8999 Time time;
9000 enum xembed_message message;
9001 long detail;
9002 long data1;
9003 long data2;
9005 XEvent event;
9007 event.xclient.type = ClientMessage;
9008 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
9009 event.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_XEMBED;
9010 event.xclient.format = 32;
9011 event.xclient.data.l[0] = time;
9012 event.xclient.data.l[1] = message;
9013 event.xclient.data.l[2] = detail;
9014 event.xclient.data.l[3] = data1;
9015 event.xclient.data.l[4] = data2;
9017 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
9018 False, NoEventMask, &event);
9019 XSync (FRAME_X_DISPLAY (f), False);
9022 /* Change of visibility. */
9024 /* This tries to wait until the frame is really visible.
9025 However, if the window manager asks the user where to position
9026 the frame, this will return before the user finishes doing that.
9027 The frame will not actually be visible at that time,
9028 but it will become visible later when the window manager
9029 finishes with it. */
9031 void
9032 x_make_frame_visible (f)
9033 struct frame *f;
9035 Lisp_Object type;
9036 int original_top, original_left;
9037 int retry_count = 2;
9039 retry:
9041 BLOCK_INPUT;
9043 type = x_icon_type (f);
9044 if (!NILP (type))
9045 x_bitmap_icon (f, type);
9047 if (! FRAME_VISIBLE_P (f))
9049 /* We test FRAME_GARBAGED_P here to make sure we don't
9050 call x_set_offset a second time
9051 if we get to x_make_frame_visible a second time
9052 before the window gets really visible. */
9053 if (! FRAME_ICONIFIED_P (f)
9054 && ! FRAME_X_EMBEDDED_P (f)
9055 && ! f->output_data.x->asked_for_visible)
9056 x_set_offset (f, f->left_pos, f->top_pos, 0);
9058 f->output_data.x->asked_for_visible = 1;
9060 if (! EQ (Vx_no_window_manager, Qt))
9061 x_wm_set_window_state (f, NormalState);
9062 #ifdef USE_X_TOOLKIT
9063 if (FRAME_X_EMBEDDED_P (f))
9064 xembed_set_info (f, XEMBED_MAPPED);
9065 else
9067 /* This was XtPopup, but that did nothing for an iconified frame. */
9068 XtMapWidget (f->output_data.x->widget);
9070 #else /* not USE_X_TOOLKIT */
9071 #ifdef USE_GTK
9072 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9073 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9074 #else
9075 if (FRAME_X_EMBEDDED_P (f))
9076 xembed_set_info (f, XEMBED_MAPPED);
9077 else
9078 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9079 #endif /* not USE_GTK */
9080 #endif /* not USE_X_TOOLKIT */
9083 XFlush (FRAME_X_DISPLAY (f));
9085 /* Synchronize to ensure Emacs knows the frame is visible
9086 before we do anything else. We do this loop with input not blocked
9087 so that incoming events are handled. */
9089 Lisp_Object frame;
9090 int count;
9091 /* This must be before UNBLOCK_INPUT
9092 since events that arrive in response to the actions above
9093 will set it when they are handled. */
9094 int previously_visible = f->output_data.x->has_been_visible;
9096 original_left = f->left_pos;
9097 original_top = f->top_pos;
9099 /* This must come after we set COUNT. */
9100 UNBLOCK_INPUT;
9102 /* We unblock here so that arriving X events are processed. */
9104 /* Now move the window back to where it was "supposed to be".
9105 But don't do it if the gravity is negative.
9106 When the gravity is negative, this uses a position
9107 that is 3 pixels too low. Perhaps that's really the border width.
9109 Don't do this if the window has never been visible before,
9110 because the window manager may choose the position
9111 and we don't want to override it. */
9113 if (! FRAME_VISIBLE_P (f)
9114 && ! FRAME_ICONIFIED_P (f)
9115 && ! FRAME_X_EMBEDDED_P (f)
9116 && f->win_gravity == NorthWestGravity
9117 && previously_visible)
9119 Drawable rootw;
9120 int x, y;
9121 unsigned int width, height, border, depth;
9123 BLOCK_INPUT;
9125 /* On some window managers (such as FVWM) moving an existing
9126 window, even to the same place, causes the window manager
9127 to introduce an offset. This can cause the window to move
9128 to an unexpected location. Check the geometry (a little
9129 slow here) and then verify that the window is in the right
9130 place. If the window is not in the right place, move it
9131 there, and take the potential window manager hit. */
9132 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9133 &rootw, &x, &y, &width, &height, &border, &depth);
9135 if (original_left != x || original_top != y)
9136 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9137 original_left, original_top);
9139 UNBLOCK_INPUT;
9142 XSETFRAME (frame, f);
9144 /* Wait until the frame is visible. Process X events until a
9145 MapNotify event has been seen, or until we think we won't get a
9146 MapNotify at all.. */
9147 for (count = input_signal_count + 10;
9148 input_signal_count < count && !FRAME_VISIBLE_P (f);)
9150 /* Force processing of queued events. */
9151 x_sync (f);
9153 /* Machines that do polling rather than SIGIO have been
9154 observed to go into a busy-wait here. So we'll fake an
9155 alarm signal to let the handler know that there's something
9156 to be read. We used to raise a real alarm, but it seems
9157 that the handler isn't always enabled here. This is
9158 probably a bug. */
9159 if (input_polling_used ())
9161 /* It could be confusing if a real alarm arrives while
9162 processing the fake one. Turn it off and let the
9163 handler reset it. */
9164 extern void poll_for_input_1 P_ ((void));
9165 int old_poll_suppress_count = poll_suppress_count;
9166 poll_suppress_count = 1;
9167 poll_for_input_1 ();
9168 poll_suppress_count = old_poll_suppress_count;
9171 /* See if a MapNotify event has been processed. */
9172 FRAME_SAMPLE_VISIBILITY (f);
9175 /* 2000-09-28: In
9177 (let ((f (selected-frame)))
9178 (iconify-frame f)
9179 (raise-frame f))
9181 the frame is not raised with various window managers on
9182 FreeBSD, GNU/Linux and Solaris. It turns out that, for some
9183 unknown reason, the call to XtMapWidget is completely ignored.
9184 Mapping the widget a second time works. */
9186 if (!FRAME_VISIBLE_P (f) && --retry_count > 0)
9187 goto retry;
9191 /* Change from mapped state to withdrawn state. */
9193 /* Make the frame visible (mapped and not iconified). */
9195 void
9196 x_make_frame_invisible (f)
9197 struct frame *f;
9199 Window window;
9201 /* Use the frame's outermost window, not the one we normally draw on. */
9202 window = FRAME_OUTER_WINDOW (f);
9204 /* Don't keep the highlight on an invisible frame. */
9205 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9206 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9208 BLOCK_INPUT;
9210 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
9211 that the current position of the window is user-specified, rather than
9212 program-specified, so that when the window is mapped again, it will be
9213 placed at the same location, without forcing the user to position it
9214 by hand again (they have already done that once for this window.) */
9215 x_wm_set_size_hint (f, (long) 0, 1);
9217 #ifdef USE_GTK
9218 if (FRAME_GTK_OUTER_WIDGET (f))
9219 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
9220 else
9221 #else
9222 if (FRAME_X_EMBEDDED_P (f))
9223 xembed_set_info (f, 0);
9224 else
9225 #endif
9228 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
9229 DefaultScreen (FRAME_X_DISPLAY (f))))
9231 UNBLOCK_INPUT_RESIGNAL;
9232 error ("Can't notify window manager of window withdrawal");
9236 /* We can't distinguish this from iconification
9237 just by the event that we get from the server.
9238 So we can't win using the usual strategy of letting
9239 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
9240 and synchronize with the server to make sure we agree. */
9241 f->visible = 0;
9242 FRAME_ICONIFIED_P (f) = 0;
9243 f->async_visible = 0;
9244 f->async_iconified = 0;
9246 x_sync (f);
9248 UNBLOCK_INPUT;
9251 /* Change window state from mapped to iconified. */
9253 void
9254 x_iconify_frame (f)
9255 struct frame *f;
9257 int result;
9258 Lisp_Object type;
9260 /* Don't keep the highlight on an invisible frame. */
9261 if (FRAME_X_DISPLAY_INFO (f)->x_highlight_frame == f)
9262 FRAME_X_DISPLAY_INFO (f)->x_highlight_frame = 0;
9264 if (f->async_iconified)
9265 return;
9267 BLOCK_INPUT;
9269 FRAME_SAMPLE_VISIBILITY (f);
9271 type = x_icon_type (f);
9272 if (!NILP (type))
9273 x_bitmap_icon (f, type);
9275 #ifdef USE_GTK
9276 if (FRAME_GTK_OUTER_WIDGET (f))
9278 if (! FRAME_VISIBLE_P (f))
9279 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
9281 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
9282 f->iconified = 1;
9283 f->visible = 1;
9284 f->async_iconified = 1;
9285 f->async_visible = 0;
9286 UNBLOCK_INPUT;
9287 return;
9289 #endif
9291 #ifdef USE_X_TOOLKIT
9293 if (! FRAME_VISIBLE_P (f))
9295 if (! EQ (Vx_no_window_manager, Qt))
9296 x_wm_set_window_state (f, IconicState);
9297 /* This was XtPopup, but that did nothing for an iconified frame. */
9298 XtMapWidget (f->output_data.x->widget);
9299 /* The server won't give us any event to indicate
9300 that an invisible frame was changed to an icon,
9301 so we have to record it here. */
9302 f->iconified = 1;
9303 f->visible = 1;
9304 f->async_iconified = 1;
9305 f->async_visible = 0;
9306 UNBLOCK_INPUT;
9307 return;
9310 result = XIconifyWindow (FRAME_X_DISPLAY (f),
9311 XtWindow (f->output_data.x->widget),
9312 DefaultScreen (FRAME_X_DISPLAY (f)));
9313 UNBLOCK_INPUT;
9315 if (!result)
9316 error ("Can't notify window manager of iconification");
9318 f->async_iconified = 1;
9319 f->async_visible = 0;
9322 BLOCK_INPUT;
9323 XFlush (FRAME_X_DISPLAY (f));
9324 UNBLOCK_INPUT;
9325 #else /* not USE_X_TOOLKIT */
9327 /* Make sure the X server knows where the window should be positioned,
9328 in case the user deiconifies with the window manager. */
9329 if (! FRAME_VISIBLE_P (f)
9330 && ! FRAME_ICONIFIED_P (f)
9331 && ! FRAME_X_EMBEDDED_P (f))
9332 x_set_offset (f, f->left_pos, f->top_pos, 0);
9334 /* Since we don't know which revision of X we're running, we'll use both
9335 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
9337 /* X11R4: send a ClientMessage to the window manager using the
9338 WM_CHANGE_STATE type. */
9340 XEvent message;
9342 message.xclient.window = FRAME_X_WINDOW (f);
9343 message.xclient.type = ClientMessage;
9344 message.xclient.message_type = FRAME_X_DISPLAY_INFO (f)->Xatom_wm_change_state;
9345 message.xclient.format = 32;
9346 message.xclient.data.l[0] = IconicState;
9348 if (! XSendEvent (FRAME_X_DISPLAY (f),
9349 DefaultRootWindow (FRAME_X_DISPLAY (f)),
9350 False,
9351 SubstructureRedirectMask | SubstructureNotifyMask,
9352 &message))
9354 UNBLOCK_INPUT_RESIGNAL;
9355 error ("Can't notify window manager of iconification");
9359 /* X11R3: set the initial_state field of the window manager hints to
9360 IconicState. */
9361 x_wm_set_window_state (f, IconicState);
9363 if (!FRAME_VISIBLE_P (f))
9365 /* If the frame was withdrawn, before, we must map it. */
9366 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9369 f->async_iconified = 1;
9370 f->async_visible = 0;
9372 XFlush (FRAME_X_DISPLAY (f));
9373 UNBLOCK_INPUT;
9374 #endif /* not USE_X_TOOLKIT */
9378 /* Free X resources of frame F. */
9380 void
9381 x_free_frame_resources (f)
9382 struct frame *f;
9384 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9385 Lisp_Object bar;
9386 struct scroll_bar *b;
9388 BLOCK_INPUT;
9390 /* If a display connection is dead, don't try sending more
9391 commands to the X server. */
9392 if (dpyinfo->display)
9394 /* We must free faces before destroying windows because some
9395 font-driver (e.g. xft) access a window while finishing a
9396 face. */
9397 if (FRAME_FACE_CACHE (f))
9398 free_frame_faces (f);
9400 if (f->output_data.x->icon_desc)
9401 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
9403 #ifdef USE_X_TOOLKIT
9404 /* Explicitly destroy the scroll bars of the frame. Without
9405 this, we get "BadDrawable" errors from the toolkit later on,
9406 presumably from expose events generated for the disappearing
9407 toolkit scroll bars. */
9408 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
9410 b = XSCROLL_BAR (bar);
9411 x_scroll_bar_remove (b);
9413 #endif
9415 #ifdef HAVE_X_I18N
9416 if (FRAME_XIC (f))
9417 free_frame_xic (f);
9418 #endif
9420 #ifdef USE_X_TOOLKIT
9421 if (f->output_data.x->widget)
9423 XtDestroyWidget (f->output_data.x->widget);
9424 f->output_data.x->widget = NULL;
9426 /* Tooltips don't have widgets, only a simple X window, even if
9427 we are using a toolkit. */
9428 else if (FRAME_X_WINDOW (f))
9429 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9431 free_frame_menubar (f);
9432 #else /* !USE_X_TOOLKIT */
9434 #ifdef USE_GTK
9435 /* In the GTK version, tooltips are normal X
9436 frames. We must check and free both types. */
9437 if (FRAME_GTK_OUTER_WIDGET (f))
9439 gtk_widget_destroy (FRAME_GTK_OUTER_WIDGET (f));
9440 FRAME_X_WINDOW (f) = 0; /* Set to avoid XDestroyWindow below */
9441 FRAME_GTK_OUTER_WIDGET (f) = 0;
9443 #endif /* USE_GTK */
9445 if (FRAME_X_WINDOW (f))
9446 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
9447 #endif /* !USE_X_TOOLKIT */
9449 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
9450 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
9451 unload_color (f, f->output_data.x->cursor_pixel);
9452 unload_color (f, f->output_data.x->cursor_foreground_pixel);
9453 unload_color (f, f->output_data.x->border_pixel);
9454 unload_color (f, f->output_data.x->mouse_pixel);
9456 if (f->output_data.x->scroll_bar_background_pixel != -1)
9457 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
9458 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
9459 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
9460 #ifdef USE_TOOLKIT_SCROLL_BARS
9461 /* Scrollbar shadow colors. */
9462 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
9463 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
9464 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
9465 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
9466 #endif /* USE_TOOLKIT_SCROLL_BARS */
9467 if (f->output_data.x->white_relief.allocated_p)
9468 unload_color (f, f->output_data.x->white_relief.pixel);
9469 if (f->output_data.x->black_relief.allocated_p)
9470 unload_color (f, f->output_data.x->black_relief.pixel);
9472 x_free_gcs (f);
9473 XFlush (FRAME_X_DISPLAY (f));
9476 xfree (f->output_data.x->saved_menu_event);
9477 xfree (f->output_data.x);
9478 f->output_data.x = NULL;
9480 if (f == dpyinfo->x_focus_frame)
9481 dpyinfo->x_focus_frame = 0;
9482 if (f == dpyinfo->x_focus_event_frame)
9483 dpyinfo->x_focus_event_frame = 0;
9484 if (f == dpyinfo->x_highlight_frame)
9485 dpyinfo->x_highlight_frame = 0;
9487 if (f == dpyinfo->mouse_face_mouse_frame)
9489 dpyinfo->mouse_face_beg_row
9490 = dpyinfo->mouse_face_beg_col = -1;
9491 dpyinfo->mouse_face_end_row
9492 = dpyinfo->mouse_face_end_col = -1;
9493 dpyinfo->mouse_face_window = Qnil;
9494 dpyinfo->mouse_face_deferred_gc = 0;
9495 dpyinfo->mouse_face_mouse_frame = 0;
9498 UNBLOCK_INPUT;
9502 /* Destroy the X window of frame F. */
9504 void
9505 x_destroy_window (f)
9506 struct frame *f;
9508 struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
9510 /* If a display connection is dead, don't try sending more
9511 commands to the X server. */
9512 if (dpyinfo->display != 0)
9513 x_free_frame_resources (f);
9515 dpyinfo->reference_count--;
9519 /* Setting window manager hints. */
9521 /* Set the normal size hints for the window manager, for frame F.
9522 FLAGS is the flags word to use--or 0 meaning preserve the flags
9523 that the window now has.
9524 If USER_POSITION is nonzero, we set the USPosition
9525 flag (this is useful when FLAGS is 0).
9526 The GTK version is in gtkutils.c */
9528 #ifndef USE_GTK
9529 void
9530 x_wm_set_size_hint (f, flags, user_position)
9531 struct frame *f;
9532 long flags;
9533 int user_position;
9535 XSizeHints size_hints;
9537 #ifdef USE_X_TOOLKIT
9538 Arg al[2];
9539 int ac = 0;
9540 Dimension widget_width, widget_height;
9541 #endif
9543 Window window = FRAME_OUTER_WINDOW (f);
9545 /* Setting PMaxSize caused various problems. */
9546 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
9548 size_hints.x = f->left_pos;
9549 size_hints.y = f->top_pos;
9551 #ifdef USE_X_TOOLKIT
9552 XtSetArg (al[ac], XtNwidth, &widget_width); ac++;
9553 XtSetArg (al[ac], XtNheight, &widget_height); ac++;
9554 XtGetValues (f->output_data.x->widget, al, ac);
9555 size_hints.height = widget_height;
9556 size_hints.width = widget_width;
9557 #else /* not USE_X_TOOLKIT */
9558 size_hints.height = FRAME_PIXEL_HEIGHT (f);
9559 size_hints.width = FRAME_PIXEL_WIDTH (f);
9560 #endif /* not USE_X_TOOLKIT */
9562 size_hints.width_inc = FRAME_COLUMN_WIDTH (f);
9563 size_hints.height_inc = FRAME_LINE_HEIGHT (f);
9564 size_hints.max_width = x_display_pixel_width (FRAME_X_DISPLAY_INFO (f))
9565 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9566 size_hints.max_height = x_display_pixel_height (FRAME_X_DISPLAY_INFO (f))
9567 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9569 /* Calculate the base and minimum sizes.
9571 (When we use the X toolkit, we don't do it here.
9572 Instead we copy the values that the widgets are using, below.) */
9573 #ifndef USE_X_TOOLKIT
9575 int base_width, base_height;
9576 int min_rows = 0, min_cols = 0;
9578 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
9579 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
9581 check_frame_size (f, &min_rows, &min_cols);
9583 /* The window manager uses the base width hints to calculate the
9584 current number of rows and columns in the frame while
9585 resizing; min_width and min_height aren't useful for this
9586 purpose, since they might not give the dimensions for a
9587 zero-row, zero-column frame.
9589 We use the base_width and base_height members if we have
9590 them; otherwise, we set the min_width and min_height members
9591 to the size for a zero x zero frame. */
9593 size_hints.flags |= PBaseSize;
9594 size_hints.base_width = base_width;
9595 size_hints.base_height = base_height;
9596 size_hints.min_width = base_width + min_cols * size_hints.width_inc;
9597 size_hints.min_height = base_height + min_rows * size_hints.height_inc;
9600 /* If we don't need the old flags, we don't need the old hint at all. */
9601 if (flags)
9603 size_hints.flags |= flags;
9604 goto no_read;
9606 #endif /* not USE_X_TOOLKIT */
9609 XSizeHints hints; /* Sometimes I hate X Windows... */
9610 long supplied_return;
9611 int value;
9613 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
9614 &supplied_return);
9616 #ifdef USE_X_TOOLKIT
9617 size_hints.base_height = hints.base_height;
9618 size_hints.base_width = hints.base_width;
9619 size_hints.min_height = hints.min_height;
9620 size_hints.min_width = hints.min_width;
9621 #endif
9623 if (flags)
9624 size_hints.flags |= flags;
9625 else
9627 if (value == 0)
9628 hints.flags = 0;
9629 if (hints.flags & PSize)
9630 size_hints.flags |= PSize;
9631 if (hints.flags & PPosition)
9632 size_hints.flags |= PPosition;
9633 if (hints.flags & USPosition)
9634 size_hints.flags |= USPosition;
9635 if (hints.flags & USSize)
9636 size_hints.flags |= USSize;
9640 #ifndef USE_X_TOOLKIT
9641 no_read:
9642 #endif
9644 #ifdef PWinGravity
9645 size_hints.win_gravity = f->win_gravity;
9646 size_hints.flags |= PWinGravity;
9648 if (user_position)
9650 size_hints.flags &= ~ PPosition;
9651 size_hints.flags |= USPosition;
9653 #endif /* PWinGravity */
9655 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
9657 #endif /* not USE_GTK */
9659 /* Used for IconicState or NormalState */
9661 void
9662 x_wm_set_window_state (f, state)
9663 struct frame *f;
9664 int state;
9666 #ifdef USE_X_TOOLKIT
9667 Arg al[1];
9669 XtSetArg (al[0], XtNinitialState, state);
9670 XtSetValues (f->output_data.x->widget, al, 1);
9671 #else /* not USE_X_TOOLKIT */
9672 Window window = FRAME_X_WINDOW (f);
9674 f->output_data.x->wm_hints.flags |= StateHint;
9675 f->output_data.x->wm_hints.initial_state = state;
9677 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9678 #endif /* not USE_X_TOOLKIT */
9681 void
9682 x_wm_set_icon_pixmap (f, pixmap_id)
9683 struct frame *f;
9684 int pixmap_id;
9686 Pixmap icon_pixmap, icon_mask;
9688 #ifndef USE_X_TOOLKIT
9689 Window window = FRAME_OUTER_WINDOW (f);
9690 #endif
9692 if (pixmap_id > 0)
9694 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
9695 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
9696 icon_mask = x_bitmap_mask (f, pixmap_id);
9697 f->output_data.x->wm_hints.icon_mask = icon_mask;
9699 else
9701 /* It seems there is no way to turn off use of an icon
9702 pixmap. */
9703 return;
9707 #ifdef USE_GTK
9709 xg_set_frame_icon (f, icon_pixmap, icon_mask);
9710 return;
9713 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
9716 Arg al[1];
9717 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
9718 XtSetValues (f->output_data.x->widget, al, 1);
9719 XtSetArg (al[0], XtNiconMask, icon_mask);
9720 XtSetValues (f->output_data.x->widget, al, 1);
9723 #else /* not USE_X_TOOLKIT && not USE_GTK */
9725 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
9726 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9728 #endif /* not USE_X_TOOLKIT && not USE_GTK */
9731 void
9732 x_wm_set_icon_position (f, icon_x, icon_y)
9733 struct frame *f;
9734 int icon_x, icon_y;
9736 Window window = FRAME_OUTER_WINDOW (f);
9738 f->output_data.x->wm_hints.flags |= IconPositionHint;
9739 f->output_data.x->wm_hints.icon_x = icon_x;
9740 f->output_data.x->wm_hints.icon_y = icon_y;
9742 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
9746 /***********************************************************************
9747 Fonts
9748 ***********************************************************************/
9750 #if GLYPH_DEBUG
9752 /* Check that FONT is valid on frame F. It is if it can be found in F's
9753 font table. */
9755 static void
9756 x_check_font (f, font)
9757 struct frame *f;
9758 struct font *font;
9760 Lisp_Object frame;
9762 xassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
9763 if (font->driver->check)
9764 xassert (font->driver->check (f, font) == 0);
9767 #endif /* GLYPH_DEBUG != 0 */
9770 /***********************************************************************
9771 Initialization
9772 ***********************************************************************/
9774 #ifdef USE_X_TOOLKIT
9775 static XrmOptionDescRec emacs_options[] = {
9776 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
9777 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
9779 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
9780 XrmoptionSepArg, NULL},
9781 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
9783 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9784 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9785 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
9786 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9787 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
9788 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
9789 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
9792 /* Whether atimer for Xt timeouts is activated or not. */
9794 static int x_timeout_atimer_activated_flag;
9796 #endif /* USE_X_TOOLKIT */
9798 static int x_initialized;
9800 #ifdef HAVE_X_SM
9801 static int x_session_initialized;
9802 #endif
9804 /* Test whether two display-name strings agree up to the dot that separates
9805 the screen number from the server number. */
9806 static int
9807 same_x_server (name1, name2)
9808 const char *name1, *name2;
9810 int seen_colon = 0;
9811 const unsigned char *system_name = SDATA (Vsystem_name);
9812 int system_name_length = strlen (system_name);
9813 int length_until_period = 0;
9815 while (system_name[length_until_period] != 0
9816 && system_name[length_until_period] != '.')
9817 length_until_period++;
9819 /* Treat `unix' like an empty host name. */
9820 if (! strncmp (name1, "unix:", 5))
9821 name1 += 4;
9822 if (! strncmp (name2, "unix:", 5))
9823 name2 += 4;
9824 /* Treat this host's name like an empty host name. */
9825 if (! strncmp (name1, system_name, system_name_length)
9826 && name1[system_name_length] == ':')
9827 name1 += system_name_length;
9828 if (! strncmp (name2, system_name, system_name_length)
9829 && name2[system_name_length] == ':')
9830 name2 += system_name_length;
9831 /* Treat this host's domainless name like an empty host name. */
9832 if (! strncmp (name1, system_name, length_until_period)
9833 && name1[length_until_period] == ':')
9834 name1 += length_until_period;
9835 if (! strncmp (name2, system_name, length_until_period)
9836 && name2[length_until_period] == ':')
9837 name2 += length_until_period;
9839 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
9841 if (*name1 == ':')
9842 seen_colon++;
9843 if (seen_colon && *name1 == '.')
9844 return 1;
9846 return (seen_colon
9847 && (*name1 == '.' || *name1 == '\0')
9848 && (*name2 == '.' || *name2 == '\0'));
9851 /* Count number of set bits in mask and number of bits to shift to
9852 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
9853 to 5. */
9854 static void
9855 get_bits_and_offset (mask, bits, offset)
9856 unsigned long mask;
9857 int *bits;
9858 int *offset;
9860 int nr = 0;
9861 int off = 0;
9863 while (!(mask & 1))
9865 off++;
9866 mask >>= 1;
9869 while (mask & 1)
9871 nr++;
9872 mask >>= 1;
9875 *offset = off;
9876 *bits = nr;
9879 /* Return 1 if display DISPLAY is available for use, 0 otherwise.
9880 But don't permanently open it, just test its availability. */
9883 x_display_ok (display)
9884 const char *display;
9886 int dpy_ok = 1;
9887 Display *dpy;
9889 dpy = XOpenDisplay (display);
9890 if (dpy)
9891 XCloseDisplay (dpy);
9892 else
9893 dpy_ok = 0;
9894 return dpy_ok;
9897 /* Open a connection to X display DISPLAY_NAME, and return
9898 the structure that describes the open display.
9899 If we cannot contact the display, return null. */
9901 struct x_display_info *
9902 x_term_init (display_name, xrm_option, resource_name)
9903 Lisp_Object display_name;
9904 char *xrm_option;
9905 char *resource_name;
9907 int connection;
9908 Display *dpy;
9909 struct terminal *terminal;
9910 struct x_display_info *dpyinfo;
9911 XrmDatabase xrdb;
9913 BLOCK_INPUT;
9915 if (!x_initialized)
9917 x_initialize ();
9918 ++x_initialized;
9921 if (! x_display_ok (SDATA (display_name)))
9922 error ("Display %s can't be opened", SDATA (display_name));
9924 #ifdef USE_GTK
9926 #define NUM_ARGV 10
9927 int argc;
9928 char *argv[NUM_ARGV];
9929 char **argv2 = argv;
9930 GdkAtom atom;
9932 #ifndef HAVE_GTK_MULTIDISPLAY
9933 if (!EQ (Vinitial_window_system, intern ("x")))
9934 error ("Sorry, you cannot connect to X servers with the GTK toolkit");
9935 #endif
9937 if (x_initialized++ > 1)
9939 #ifdef HAVE_GTK_MULTIDISPLAY
9940 /* Opening another display. If xg_display_open returns less
9941 than zero, we are probably on GTK 2.0, which can only handle
9942 one display. GTK 2.2 or later can handle more than one. */
9943 if (xg_display_open (SDATA (display_name), &dpy) < 0)
9944 #endif
9945 error ("Sorry, this version of GTK can only handle one display");
9947 else
9949 for (argc = 0; argc < NUM_ARGV; ++argc)
9950 argv[argc] = 0;
9952 argc = 0;
9953 argv[argc++] = initial_argv[0];
9955 if (! NILP (display_name))
9957 argv[argc++] = "--display";
9958 argv[argc++] = SDATA (display_name);
9961 argv[argc++] = "--name";
9962 argv[argc++] = resource_name;
9964 XSetLocaleModifiers ("");
9966 gtk_init (&argc, &argv2);
9968 /* gtk_init does set_locale. We must fix locale after calling it. */
9969 fixup_locale ();
9970 xg_initialize ();
9972 dpy = GDK_DISPLAY ();
9974 /* NULL window -> events for all windows go to our function */
9975 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
9977 /* Load our own gtkrc if it exists. */
9979 char *file = "~/.emacs.d/gtkrc";
9980 Lisp_Object s, abs_file;
9982 s = make_string (file, strlen (file));
9983 abs_file = Fexpand_file_name (s, Qnil);
9985 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
9986 gtk_rc_parse (SDATA (abs_file));
9989 XSetErrorHandler (x_error_handler);
9990 XSetIOErrorHandler (x_io_error_quitter);
9993 #else /* not USE_GTK */
9994 #ifdef USE_X_TOOLKIT
9995 /* weiner@footloose.sps.mot.com reports that this causes
9996 errors with X11R5:
9997 X protocol error: BadAtom (invalid Atom parameter)
9998 on protocol request 18skiloaf.
9999 So let's not use it until R6. */
10000 #ifdef HAVE_X11XTR6
10001 XtSetLanguageProc (NULL, NULL, NULL);
10002 #endif
10005 int argc = 0;
10006 char *argv[3];
10008 argv[0] = "";
10009 argc = 1;
10010 if (xrm_option)
10012 argv[argc++] = "-xrm";
10013 argv[argc++] = xrm_option;
10015 turn_on_atimers (0);
10016 dpy = XtOpenDisplay (Xt_app_con, SDATA (display_name),
10017 resource_name, EMACS_CLASS,
10018 emacs_options, XtNumber (emacs_options),
10019 &argc, argv);
10020 turn_on_atimers (1);
10022 #ifdef HAVE_X11XTR6
10023 /* I think this is to compensate for XtSetLanguageProc. */
10024 fixup_locale ();
10025 #endif
10028 #else /* not USE_X_TOOLKIT */
10029 XSetLocaleModifiers ("");
10030 dpy = XOpenDisplay (SDATA (display_name));
10031 #endif /* not USE_X_TOOLKIT */
10032 #endif /* not USE_GTK*/
10034 /* Detect failure. */
10035 if (dpy == 0)
10037 UNBLOCK_INPUT;
10038 return 0;
10041 /* We have definitely succeeded. Record the new connection. */
10043 dpyinfo = (struct x_display_info *) xmalloc (sizeof (struct x_display_info));
10044 bzero (dpyinfo, sizeof *dpyinfo);
10046 terminal = x_create_terminal (dpyinfo);
10049 struct x_display_info *share;
10050 Lisp_Object tail;
10052 for (share = x_display_list, tail = x_display_name_list; share;
10053 share = share->next, tail = XCDR (tail))
10054 if (same_x_server (SDATA (XCAR (XCAR (tail))),
10055 SDATA (display_name)))
10056 break;
10057 if (share)
10058 terminal->kboard = share->terminal->kboard;
10059 else
10061 terminal->kboard = (KBOARD *) xmalloc (sizeof (KBOARD));
10062 init_kboard (terminal->kboard);
10063 terminal->kboard->Vwindow_system = intern ("x");
10064 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
10066 char *vendor = ServerVendor (dpy);
10067 /* Temporarily hide the partially initialized terminal */
10068 terminal_list = terminal->next_terminal;
10069 UNBLOCK_INPUT;
10070 terminal->kboard->Vsystem_key_alist
10071 = call1 (Qvendor_specific_keysyms,
10072 vendor ? build_string (vendor) : empty_unibyte_string);
10073 BLOCK_INPUT;
10074 terminal->next_terminal = terminal_list;
10075 terminal_list = terminal;
10078 terminal->kboard->next_kboard = all_kboards;
10079 all_kboards = terminal->kboard;
10080 /* Don't let the initial kboard remain current longer than necessary.
10081 That would cause problems if a file loaded on startup tries to
10082 prompt in the mini-buffer. */
10083 if (current_kboard == initial_kboard)
10084 current_kboard = terminal->kboard;
10086 terminal->kboard->reference_count++;
10089 /* Put this display on the chain. */
10090 dpyinfo->next = x_display_list;
10091 x_display_list = dpyinfo;
10093 /* Put it on x_display_name_list as well, to keep them parallel. */
10094 x_display_name_list = Fcons (Fcons (display_name, Qnil),
10095 x_display_name_list);
10096 dpyinfo->name_list_element = XCAR (x_display_name_list);
10098 dpyinfo->display = dpy;
10100 /* Set the name of the terminal. */
10101 terminal->name = (char *) xmalloc (SBYTES (display_name) + 1);
10102 strncpy (terminal->name, SDATA (display_name), SBYTES (display_name));
10103 terminal->name[SBYTES (display_name)] = 0;
10105 #if 0
10106 XSetAfterFunction (x_current_display, x_trace_wire);
10107 #endif /* ! 0 */
10109 dpyinfo->x_id_name
10110 = (char *) xmalloc (SBYTES (Vinvocation_name)
10111 + SBYTES (Vsystem_name)
10112 + 2);
10113 sprintf (dpyinfo->x_id_name, "%s@%s",
10114 SDATA (Vinvocation_name), SDATA (Vsystem_name));
10116 /* Figure out which modifier bits mean what. */
10117 x_find_modifier_meanings (dpyinfo);
10119 /* Get the scroll bar cursor. */
10120 #ifdef USE_GTK
10121 /* We must create a GTK cursor, it is required for GTK widgets. */
10122 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
10123 #endif /* USE_GTK */
10125 dpyinfo->vertical_scroll_bar_cursor
10126 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
10128 xrdb = x_load_resources (dpyinfo->display, xrm_option,
10129 resource_name, EMACS_CLASS);
10130 #ifdef HAVE_XRMSETDATABASE
10131 XrmSetDatabase (dpyinfo->display, xrdb);
10132 #else
10133 dpyinfo->display->db = xrdb;
10134 #endif
10135 /* Put the rdb where we can find it in a way that works on
10136 all versions. */
10137 dpyinfo->xrdb = xrdb;
10139 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
10140 DefaultScreen (dpyinfo->display));
10141 select_visual (dpyinfo);
10142 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
10143 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
10144 dpyinfo->client_leader_window = 0;
10145 dpyinfo->grabbed = 0;
10146 dpyinfo->reference_count = 0;
10147 dpyinfo->icon_bitmap_id = -1;
10148 dpyinfo->n_fonts = 0;
10149 dpyinfo->bitmaps = 0;
10150 dpyinfo->bitmaps_size = 0;
10151 dpyinfo->bitmaps_last = 0;
10152 dpyinfo->scratch_cursor_gc = 0;
10153 dpyinfo->mouse_face_mouse_frame = 0;
10154 dpyinfo->mouse_face_deferred_gc = 0;
10155 dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
10156 dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
10157 dpyinfo->mouse_face_face_id = DEFAULT_FACE_ID;
10158 dpyinfo->mouse_face_window = Qnil;
10159 dpyinfo->mouse_face_overlay = Qnil;
10160 dpyinfo->mouse_face_mouse_x = dpyinfo->mouse_face_mouse_y = 0;
10161 dpyinfo->mouse_face_defer = 0;
10162 dpyinfo->mouse_face_hidden = 0;
10163 dpyinfo->x_focus_frame = 0;
10164 dpyinfo->x_focus_event_frame = 0;
10165 dpyinfo->x_highlight_frame = 0;
10166 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
10168 /* See if we can construct pixel values from RGB values. */
10169 dpyinfo->red_bits = dpyinfo->blue_bits = dpyinfo->green_bits = 0;
10170 dpyinfo->red_offset = dpyinfo->blue_offset = dpyinfo->green_offset = 0;
10172 if (dpyinfo->visual->class == TrueColor)
10174 get_bits_and_offset (dpyinfo->visual->red_mask,
10175 &dpyinfo->red_bits, &dpyinfo->red_offset);
10176 get_bits_and_offset (dpyinfo->visual->blue_mask,
10177 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
10178 get_bits_and_offset (dpyinfo->visual->green_mask,
10179 &dpyinfo->green_bits, &dpyinfo->green_offset);
10182 /* See if a private colormap is requested. */
10183 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
10185 if (dpyinfo->visual->class == PseudoColor)
10187 Lisp_Object value;
10188 value = display_x_get_resource (dpyinfo,
10189 build_string ("privateColormap"),
10190 build_string ("PrivateColormap"),
10191 Qnil, Qnil);
10192 if (STRINGP (value)
10193 && (!strcmp (SDATA (value), "true")
10194 || !strcmp (SDATA (value), "on")))
10195 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
10198 else
10199 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
10200 dpyinfo->visual, AllocNone);
10203 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
10204 double pixels = DisplayHeight (dpyinfo->display, screen_number);
10205 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
10206 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10207 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
10208 pixels = DisplayWidth (dpyinfo->display, screen_number);
10209 mm = DisplayWidthMM (dpyinfo->display, screen_number);
10210 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
10211 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
10214 dpyinfo->Xatom_wm_protocols
10215 = XInternAtom (dpyinfo->display, "WM_PROTOCOLS", False);
10216 dpyinfo->Xatom_wm_take_focus
10217 = XInternAtom (dpyinfo->display, "WM_TAKE_FOCUS", False);
10218 dpyinfo->Xatom_wm_save_yourself
10219 = XInternAtom (dpyinfo->display, "WM_SAVE_YOURSELF", False);
10220 dpyinfo->Xatom_wm_delete_window
10221 = XInternAtom (dpyinfo->display, "WM_DELETE_WINDOW", False);
10222 dpyinfo->Xatom_wm_change_state
10223 = XInternAtom (dpyinfo->display, "WM_CHANGE_STATE", False);
10224 dpyinfo->Xatom_wm_configure_denied
10225 = XInternAtom (dpyinfo->display, "WM_CONFIGURE_DENIED", False);
10226 dpyinfo->Xatom_wm_window_moved
10227 = XInternAtom (dpyinfo->display, "WM_MOVED", False);
10228 dpyinfo->Xatom_wm_client_leader
10229 = XInternAtom (dpyinfo->display, "WM_CLIENT_LEADER", False);
10230 dpyinfo->Xatom_editres
10231 = XInternAtom (dpyinfo->display, "Editres", False);
10232 dpyinfo->Xatom_CLIPBOARD
10233 = XInternAtom (dpyinfo->display, "CLIPBOARD", False);
10234 dpyinfo->Xatom_TIMESTAMP
10235 = XInternAtom (dpyinfo->display, "TIMESTAMP", False);
10236 dpyinfo->Xatom_TEXT
10237 = XInternAtom (dpyinfo->display, "TEXT", False);
10238 dpyinfo->Xatom_COMPOUND_TEXT
10239 = XInternAtom (dpyinfo->display, "COMPOUND_TEXT", False);
10240 dpyinfo->Xatom_UTF8_STRING
10241 = XInternAtom (dpyinfo->display, "UTF8_STRING", False);
10242 dpyinfo->Xatom_DELETE
10243 = XInternAtom (dpyinfo->display, "DELETE", False);
10244 dpyinfo->Xatom_MULTIPLE
10245 = XInternAtom (dpyinfo->display, "MULTIPLE", False);
10246 dpyinfo->Xatom_INCR
10247 = XInternAtom (dpyinfo->display, "INCR", False);
10248 dpyinfo->Xatom_EMACS_TMP
10249 = XInternAtom (dpyinfo->display, "_EMACS_TMP_", False);
10250 dpyinfo->Xatom_TARGETS
10251 = XInternAtom (dpyinfo->display, "TARGETS", False);
10252 dpyinfo->Xatom_NULL
10253 = XInternAtom (dpyinfo->display, "NULL", False);
10254 dpyinfo->Xatom_ATOM_PAIR
10255 = XInternAtom (dpyinfo->display, "ATOM_PAIR", False);
10256 /* For properties of font. */
10257 dpyinfo->Xatom_PIXEL_SIZE
10258 = XInternAtom (dpyinfo->display, "PIXEL_SIZE", False);
10259 dpyinfo->Xatom_AVERAGE_WIDTH
10260 = XInternAtom (dpyinfo->display, "AVERAGE_WIDTH", False);
10261 dpyinfo->Xatom_MULE_BASELINE_OFFSET
10262 = XInternAtom (dpyinfo->display, "_MULE_BASELINE_OFFSET", False);
10263 dpyinfo->Xatom_MULE_RELATIVE_COMPOSE
10264 = XInternAtom (dpyinfo->display, "_MULE_RELATIVE_COMPOSE", False);
10265 dpyinfo->Xatom_MULE_DEFAULT_ASCENT
10266 = XInternAtom (dpyinfo->display, "_MULE_DEFAULT_ASCENT", False);
10268 /* Ghostscript support. */
10269 dpyinfo->Xatom_PAGE = XInternAtom (dpyinfo->display, "PAGE", False);
10270 dpyinfo->Xatom_DONE = XInternAtom (dpyinfo->display, "DONE", False);
10272 dpyinfo->Xatom_Scrollbar = XInternAtom (dpyinfo->display, "SCROLLBAR",
10273 False);
10275 dpyinfo->Xatom_XEMBED = XInternAtom (dpyinfo->display, "_XEMBED",
10276 False);
10278 dpyinfo->Xatom_net_wm_state
10279 = XInternAtom (dpyinfo->display, "_NET_WM_STATE", False);
10280 dpyinfo->Xatom_net_wm_state_fullscreen_atom
10281 = XInternAtom (dpyinfo->display, "_NET_WM_STATE_FULLSCREEN", False);
10282 dpyinfo->Xatom_net_wm_state_maximized_horz
10283 = XInternAtom (dpyinfo->display, "_NET_WM_STATE_MAXIMIZED_HORZ", False);
10284 dpyinfo->Xatom_net_wm_state_maximized_vert
10285 = XInternAtom (dpyinfo->display, "_NET_WM_STATE_MAXIMIZED_VERT", False);
10287 dpyinfo->cut_buffers_initialized = 0;
10289 dpyinfo->x_dnd_atoms_size = 8;
10290 dpyinfo->x_dnd_atoms_length = 0;
10291 dpyinfo->x_dnd_atoms = xmalloc (sizeof (*dpyinfo->x_dnd_atoms)
10292 * dpyinfo->x_dnd_atoms_size);
10294 dpyinfo->net_supported_atoms = NULL;
10295 dpyinfo->nr_net_supported_atoms = 0;
10296 dpyinfo->net_supported_window = 0;
10298 connection = ConnectionNumber (dpyinfo->display);
10299 dpyinfo->connection = connection;
10302 extern int gray_bitmap_width, gray_bitmap_height;
10303 extern char *gray_bitmap_bits;
10304 dpyinfo->gray
10305 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
10306 gray_bitmap_bits,
10307 gray_bitmap_width, gray_bitmap_height,
10308 (unsigned long) 1, (unsigned long) 0, 1);
10311 #ifdef HAVE_X_I18N
10312 xim_initialize (dpyinfo, resource_name);
10313 #endif
10315 #ifdef subprocesses
10316 /* This is only needed for distinguishing keyboard and process input. */
10317 if (connection != 0)
10318 add_keyboard_wait_descriptor (connection);
10319 #endif
10321 #ifdef F_SETOWN
10322 fcntl (connection, F_SETOWN, getpid ());
10323 #endif /* ! defined (F_SETOWN) */
10325 #ifdef SIGIO
10326 if (interrupt_input)
10327 init_sigio (connection);
10328 #endif /* ! defined (SIGIO) */
10330 #ifdef USE_LUCID
10332 Display *dpy = dpyinfo->display;
10333 XrmValue d, fr, to;
10334 Font font;
10336 d.addr = (XPointer)&dpy;
10337 d.size = sizeof (Display *);
10338 fr.addr = XtDefaultFont;
10339 fr.size = sizeof (XtDefaultFont);
10340 to.size = sizeof (Font *);
10341 to.addr = (XPointer)&font;
10342 x_catch_errors (dpy);
10343 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
10344 abort ();
10345 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
10346 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
10347 x_uncatch_errors ();
10349 #endif
10351 /* See if we should run in synchronous mode. This is useful
10352 for debugging X code. */
10354 Lisp_Object value;
10355 value = display_x_get_resource (dpyinfo,
10356 build_string ("synchronous"),
10357 build_string ("Synchronous"),
10358 Qnil, Qnil);
10359 if (STRINGP (value)
10360 && (!strcmp (SDATA (value), "true")
10361 || !strcmp (SDATA (value), "on")))
10362 XSynchronize (dpyinfo->display, True);
10366 Lisp_Object value;
10367 value = display_x_get_resource (dpyinfo,
10368 build_string ("useXIM"),
10369 build_string ("UseXIM"),
10370 Qnil, Qnil);
10371 #ifdef USE_XIM
10372 if (STRINGP (value)
10373 && (!strcmp (SDATA (value), "false")
10374 || !strcmp (SDATA (value), "off")))
10375 use_xim = 0;
10376 #else
10377 if (STRINGP (value)
10378 && (!strcmp (SDATA (value), "true")
10379 || !strcmp (SDATA (value), "on")))
10380 use_xim = 1;
10381 #endif
10384 #ifdef HAVE_X_SM
10385 /* Only do this for the very first display in the Emacs session.
10386 Ignore X session management when Emacs was first started on a
10387 tty. */
10388 if (terminal->id == 1)
10389 x_session_initialize (dpyinfo);
10390 #endif
10392 UNBLOCK_INPUT;
10394 return dpyinfo;
10397 /* Get rid of display DPYINFO, deleting all frames on it,
10398 and without sending any more commands to the X server. */
10400 void
10401 x_delete_display (dpyinfo)
10402 struct x_display_info *dpyinfo;
10404 int i;
10405 struct terminal *t;
10407 /* Close all frames and delete the generic struct terminal for this
10408 X display. */
10409 for (t = terminal_list; t; t = t->next_terminal)
10410 if (t->type == output_x_window && t->display_info.x == dpyinfo)
10412 #ifdef HAVE_X_SM
10413 /* Close X session management when we close its display. */
10414 if (t->id == 1 && x_session_have_connection ())
10415 x_session_close();
10416 #endif
10417 delete_terminal (t);
10418 break;
10421 delete_keyboard_wait_descriptor (dpyinfo->connection);
10423 /* Discard this display from x_display_name_list and x_display_list.
10424 We can't use Fdelq because that can quit. */
10425 if (! NILP (x_display_name_list)
10426 && EQ (XCAR (x_display_name_list), dpyinfo->name_list_element))
10427 x_display_name_list = XCDR (x_display_name_list);
10428 else
10430 Lisp_Object tail;
10432 tail = x_display_name_list;
10433 while (CONSP (tail) && CONSP (XCDR (tail)))
10435 if (EQ (XCAR (XCDR (tail)), dpyinfo->name_list_element))
10437 XSETCDR (tail, XCDR (XCDR (tail)));
10438 break;
10440 tail = XCDR (tail);
10444 if (next_noop_dpyinfo == dpyinfo)
10445 next_noop_dpyinfo = dpyinfo->next;
10447 if (x_display_list == dpyinfo)
10448 x_display_list = dpyinfo->next;
10449 else
10451 struct x_display_info *tail;
10453 for (tail = x_display_list; tail; tail = tail->next)
10454 if (tail->next == dpyinfo)
10455 tail->next = tail->next->next;
10458 xfree (dpyinfo->x_id_name);
10459 xfree (dpyinfo->x_dnd_atoms);
10460 xfree (dpyinfo->color_cells);
10461 xfree (dpyinfo);
10464 #ifdef USE_X_TOOLKIT
10466 /* Atimer callback function for TIMER. Called every 0.1s to process
10467 Xt timeouts, if needed. We must avoid calling XtAppPending as
10468 much as possible because that function does an implicit XFlush
10469 that slows us down. */
10471 static void
10472 x_process_timeouts (timer)
10473 struct atimer *timer;
10475 BLOCK_INPUT;
10476 x_timeout_atimer_activated_flag = 0;
10477 if (toolkit_scroll_bar_interaction || popup_activated ())
10479 while (XtAppPending (Xt_app_con) & XtIMTimer)
10480 XtAppProcessEvent (Xt_app_con, XtIMTimer);
10481 /* Reactivate the atimer for next time. */
10482 x_activate_timeout_atimer ();
10484 UNBLOCK_INPUT;
10487 /* Install an asynchronous timer that processes Xt timeout events
10488 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
10489 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
10490 function whenever these variables are set. This is necessary
10491 because some widget sets use timeouts internally, for example the
10492 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
10493 processed, these widgets don't behave normally. */
10495 void
10496 x_activate_timeout_atimer ()
10498 BLOCK_INPUT;
10499 if (!x_timeout_atimer_activated_flag)
10501 EMACS_TIME interval;
10503 EMACS_SET_SECS_USECS (interval, 0, 100000);
10504 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
10505 x_timeout_atimer_activated_flag = 1;
10507 UNBLOCK_INPUT;
10510 #endif /* USE_X_TOOLKIT */
10513 /* Set up use of X before we make the first connection. */
10515 extern frame_parm_handler x_frame_parm_handlers[];
10517 static struct redisplay_interface x_redisplay_interface =
10519 x_frame_parm_handlers,
10520 x_produce_glyphs,
10521 x_write_glyphs,
10522 x_insert_glyphs,
10523 x_clear_end_of_line,
10524 x_scroll_run,
10525 x_after_update_window_line,
10526 x_update_window_begin,
10527 x_update_window_end,
10528 x_cursor_to,
10529 x_flush,
10530 #ifdef XFlush
10531 x_flush,
10532 #else
10533 0, /* flush_display_optional */
10534 #endif
10535 x_clear_window_mouse_face,
10536 x_get_glyph_overhangs,
10537 x_fix_overlapping_area,
10538 x_draw_fringe_bitmap,
10539 0, /* define_fringe_bitmap */
10540 0, /* destroy_fringe_bitmap */
10541 x_compute_glyph_string_overhangs,
10542 x_draw_glyph_string,
10543 x_define_frame_cursor,
10544 x_clear_frame_area,
10545 x_draw_window_cursor,
10546 x_draw_vertical_window_border,
10547 x_shift_glyphs_for_insert
10551 /* This function is called when the last frame on a display is deleted. */
10552 void
10553 x_delete_terminal (struct terminal *terminal)
10555 struct x_display_info *dpyinfo = terminal->display_info.x;
10556 int i;
10558 /* Protect against recursive calls. delete_frame in
10559 delete_terminal calls us back when it deletes our last frame. */
10560 if (!terminal->name)
10561 return;
10563 BLOCK_INPUT;
10564 #ifdef HAVE_X_I18N
10565 /* We must close our connection to the XIM server before closing the
10566 X display. */
10567 if (dpyinfo->xim)
10568 xim_close_dpy (dpyinfo);
10569 #endif
10571 /* If called from x_connection_closed, the display may already be closed
10572 and dpyinfo->display was set to 0 to indicate that. */
10573 if (dpyinfo->display)
10575 x_destroy_all_bitmaps (dpyinfo);
10576 XSetCloseDownMode (dpyinfo->display, DestroyAll);
10578 /* Whether or not XCloseDisplay destroys the associated resource
10579 database depends on the version of libX11. To avoid both
10580 crash and memory leak, we dissociate the database from the
10581 display and then destroy dpyinfo->xrdb ourselves.
10583 Unfortunately, the above strategy does not work in some
10584 situations due to a bug in newer versions of libX11: because
10585 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
10586 dpy->db is NULL, XCloseDisplay destroys the associated
10587 database whereas it has not been created by XGetDefault
10588 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
10589 don't destroy the database here in order to avoid the crash
10590 in the above situations for now, though that may cause memory
10591 leaks in other situations. */
10592 #if 0
10593 #ifdef HAVE_XRMSETDATABASE
10594 XrmSetDatabase (dpyinfo->display, NULL);
10595 #else
10596 dpyinfo->display->db = NULL;
10597 #endif
10598 /* We used to call XrmDestroyDatabase from x_delete_display, but
10599 some older versions of libX11 crash if we call it after
10600 closing all the displays. */
10601 XrmDestroyDatabase (dpyinfo->xrdb);
10602 #endif
10604 #ifdef USE_GTK
10605 xg_display_close (dpyinfo->display);
10606 #else
10607 #ifdef USE_X_TOOLKIT
10608 XtCloseDisplay (dpyinfo->display);
10609 #else
10610 XCloseDisplay (dpyinfo->display);
10611 #endif
10612 #endif /* ! USE_GTK */
10615 x_delete_display (dpyinfo);
10616 UNBLOCK_INPUT;
10619 /* Create a struct terminal, initialize it with the X11 specific
10620 functions and make DISPLAY->TERMINAL point to it. */
10622 static struct terminal *
10623 x_create_terminal (struct x_display_info *dpyinfo)
10625 struct terminal *terminal;
10627 terminal = create_terminal ();
10629 terminal->type = output_x_window;
10630 terminal->display_info.x = dpyinfo;
10631 dpyinfo->terminal = terminal;
10633 /* kboard is initialized in x_term_init. */
10635 terminal->clear_frame_hook = x_clear_frame;
10636 terminal->ins_del_lines_hook = x_ins_del_lines;
10637 terminal->delete_glyphs_hook = x_delete_glyphs;
10638 terminal->ring_bell_hook = XTring_bell;
10639 terminal->reset_terminal_modes_hook = XTreset_terminal_modes;
10640 terminal->set_terminal_modes_hook = XTset_terminal_modes;
10641 terminal->update_begin_hook = x_update_begin;
10642 terminal->update_end_hook = x_update_end;
10643 terminal->set_terminal_window_hook = XTset_terminal_window;
10644 terminal->read_socket_hook = XTread_socket;
10645 terminal->frame_up_to_date_hook = XTframe_up_to_date;
10646 terminal->mouse_position_hook = XTmouse_position;
10647 terminal->frame_rehighlight_hook = XTframe_rehighlight;
10648 terminal->frame_raise_lower_hook = XTframe_raise_lower;
10649 terminal->fullscreen_hook = XTfullscreen_hook;
10650 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
10651 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
10652 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
10653 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
10655 terminal->delete_frame_hook = x_destroy_window;
10656 terminal->delete_terminal_hook = x_delete_terminal;
10658 terminal->rif = &x_redisplay_interface;
10659 terminal->scroll_region_ok = 1; /* We'll scroll partial frames. */
10660 terminal->char_ins_del_ok = 1;
10661 terminal->line_ins_del_ok = 1; /* We'll just blt 'em. */
10662 terminal->fast_clear_end_of_line = 1; /* X does this well. */
10663 terminal->memory_below_frame = 0; /* We don't remember what scrolls
10664 off the bottom. */
10666 return terminal;
10669 void
10670 x_initialize ()
10672 baud_rate = 19200;
10674 x_noop_count = 0;
10675 last_tool_bar_item = -1;
10676 any_help_event_p = 0;
10677 ignore_next_mouse_click_timeout = 0;
10678 #ifdef HAVE_X_SM
10679 x_session_initialized = 0;
10680 #endif
10682 #ifdef USE_GTK
10683 current_count = -1;
10684 #endif
10686 /* Try to use interrupt input; if we can't, then start polling. */
10687 Fset_input_interrupt_mode (Qt);
10689 #ifdef USE_X_TOOLKIT
10690 XtToolkitInitialize ();
10692 Xt_app_con = XtCreateApplicationContext ();
10694 /* Register a converter from strings to pixels, which uses
10695 Emacs' color allocation infrastructure. */
10696 XtAppSetTypeConverter (Xt_app_con,
10697 XtRString, XtRPixel, cvt_string_to_pixel,
10698 cvt_string_to_pixel_args,
10699 XtNumber (cvt_string_to_pixel_args),
10700 XtCacheByDisplay, cvt_pixel_dtor);
10702 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
10703 #endif
10705 #ifdef USE_TOOLKIT_SCROLL_BARS
10706 #ifndef USE_GTK
10707 xaw3d_arrow_scroll = False;
10708 xaw3d_pick_top = True;
10709 #endif
10710 #endif
10712 /* Note that there is no real way portable across R3/R4 to get the
10713 original error handler. */
10714 XSetErrorHandler (x_error_handler);
10715 XSetIOErrorHandler (x_io_error_quitter);
10717 signal (SIGPIPE, x_connection_signal);
10721 void
10722 syms_of_xterm ()
10724 x_error_message = NULL;
10726 staticpro (&x_display_name_list);
10727 x_display_name_list = Qnil;
10729 staticpro (&last_mouse_scroll_bar);
10730 last_mouse_scroll_bar = Qnil;
10732 staticpro (&Qvendor_specific_keysyms);
10733 Qvendor_specific_keysyms = intern ("vendor-specific-keysyms");
10735 staticpro (&Qlatin_1);
10736 Qlatin_1 = intern ("latin-1");
10738 staticpro (&last_mouse_press_frame);
10739 last_mouse_press_frame = Qnil;
10741 #ifdef USE_GTK
10742 xg_default_icon_file = build_string ("icons/hicolor/scalable/apps/emacs.svg");
10743 staticpro (&xg_default_icon_file);
10744 #endif
10746 DEFVAR_BOOL ("x-use-underline-position-properties",
10747 &x_use_underline_position_properties,
10748 doc: /* *Non-nil means make use of UNDERLINE_POSITION font properties.
10749 A value of nil means ignore them. If you encounter fonts with bogus
10750 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
10751 to 4.1, set this to nil. You can also use `underline-minimum-offset'
10752 to override the font's UNDERLINE_POSITION for small font display
10753 sizes. */);
10754 x_use_underline_position_properties = 1;
10756 DEFVAR_BOOL ("x-underline-at-descent-line",
10757 &x_underline_at_descent_line,
10758 doc: /* *Non-nil means to draw the underline at the same place as the descent line.
10759 A value of nil means to draw the underline according to the value of the
10760 variable `x-use-underline-position-properties', which is usually at the
10761 baseline level. The default value is nil. */);
10762 x_underline_at_descent_line = 0;
10764 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
10765 &x_mouse_click_focus_ignore_position,
10766 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
10767 This variable is only used when the window manager requires that you
10768 click on a frame to select it (give it focus). In that case, a value
10769 of nil, means that the selected window and cursor position changes to
10770 reflect the mouse click position, while a non-nil value means that the
10771 selected window or cursor position is preserved. */);
10772 x_mouse_click_focus_ignore_position = 0;
10774 DEFVAR_LISP ("x-toolkit-scroll-bars", &Vx_toolkit_scroll_bars,
10775 doc: /* What X toolkit scroll bars Emacs uses.
10776 A value of nil means Emacs doesn't use X toolkit scroll bars.
10777 Otherwise, value is a symbol describing the X toolkit. */);
10778 #ifdef USE_TOOLKIT_SCROLL_BARS
10779 #ifdef USE_MOTIF
10780 Vx_toolkit_scroll_bars = intern ("motif");
10781 #elif defined HAVE_XAW3D
10782 Vx_toolkit_scroll_bars = intern ("xaw3d");
10783 #elif USE_GTK
10784 Vx_toolkit_scroll_bars = intern ("gtk");
10785 #else
10786 Vx_toolkit_scroll_bars = intern ("xaw");
10787 #endif
10788 #else
10789 Vx_toolkit_scroll_bars = Qnil;
10790 #endif
10792 staticpro (&last_mouse_motion_frame);
10793 last_mouse_motion_frame = Qnil;
10795 Qmodifier_value = intern ("modifier-value");
10796 Qalt = intern ("alt");
10797 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
10798 Qhyper = intern ("hyper");
10799 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
10800 Qmeta = intern ("meta");
10801 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
10802 Qsuper = intern ("super");
10803 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
10805 DEFVAR_LISP ("x-alt-keysym", &Vx_alt_keysym,
10806 doc: /* Which keys Emacs uses for the alt modifier.
10807 This should be one of the symbols `alt', `hyper', `meta', `super'.
10808 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
10809 is nil, which is the same as `alt'. */);
10810 Vx_alt_keysym = Qnil;
10812 DEFVAR_LISP ("x-hyper-keysym", &Vx_hyper_keysym,
10813 doc: /* Which keys Emacs uses for the hyper modifier.
10814 This should be one of the symbols `alt', `hyper', `meta', `super'.
10815 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
10816 default is nil, which is the same as `hyper'. */);
10817 Vx_hyper_keysym = Qnil;
10819 DEFVAR_LISP ("x-meta-keysym", &Vx_meta_keysym,
10820 doc: /* Which keys Emacs uses for the meta modifier.
10821 This should be one of the symbols `alt', `hyper', `meta', `super'.
10822 For example, `meta' means use the Meta_L and Meta_R keysyms. The
10823 default is nil, which is the same as `meta'. */);
10824 Vx_meta_keysym = Qnil;
10826 DEFVAR_LISP ("x-super-keysym", &Vx_super_keysym,
10827 doc: /* Which keys Emacs uses for the super modifier.
10828 This should be one of the symbols `alt', `hyper', `meta', `super'.
10829 For example, `super' means use the Super_L and Super_R keysyms. The
10830 default is nil, which is the same as `super'. */);
10831 Vx_super_keysym = Qnil;
10833 DEFVAR_LISP ("x-keysym-table", &Vx_keysym_table,
10834 doc: /* Hash table of character codes indexed by X keysym codes. */);
10835 Vx_keysym_table = make_hash_table (Qeql, make_number (900),
10836 make_float (DEFAULT_REHASH_SIZE),
10837 make_float (DEFAULT_REHASH_THRESHOLD),
10838 Qnil, Qnil, Qnil);
10841 #endif /* HAVE_X_WINDOWS */
10843 /* arch-tag: 6d4e4cb7-abc1-4302-9585-d84dcfb09d0f
10844 (do not change this comment) */