Address some compilation warnings.
[emacs.git] / src / xterm.c
blob4d7945059fe2c4853c80149b276de6585ea7b26a
1 /* X Communication module for terminals which understand the X protocol.
3 Copyright (C) 1989, 1993-2015 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
20 /* New display code by Gerd Moellmann <gerd@gnu.org>. */
21 /* Xt features made by Fred Pierresteguy. */
23 #include <config.h>
24 #include <stdio.h>
25 #ifdef USE_CAIRO
26 #include <math.h>
27 #endif
29 #include "lisp.h"
30 #include "blockinput.h"
31 #include "syssignal.h"
33 /* This may include sys/types.h, and that somehow loses
34 if this is not done before the other system files. */
35 #include "xterm.h"
36 #include <X11/cursorfont.h>
38 /* If we have Xfixes extension, use it for pointer blanking. */
39 #ifdef HAVE_XFIXES
40 #include <X11/extensions/Xfixes.h>
41 #endif
43 /* Using Xft implies that XRender is available. */
44 #ifdef HAVE_XFT
45 #include <X11/extensions/Xrender.h>
46 #endif
48 /* Load sys/types.h if not already loaded.
49 In some systems loading it twice is suicidal. */
50 #ifndef makedev
51 #include <sys/types.h>
52 #endif /* makedev */
54 #include <sys/ioctl.h>
56 #include "systime.h"
58 #include <fcntl.h>
59 #include <errno.h>
60 #include <sys/stat.h>
61 /* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed. */
62 /* #include <sys/param.h> */
64 #include "charset.h"
65 #include "character.h"
66 #include "coding.h"
67 #include "frame.h"
68 #include "dispextern.h"
69 #include "fontset.h"
70 #include "termhooks.h"
71 #include "termopts.h"
72 #include "termchar.h"
73 #include "emacs-icon.h"
74 #include "disptab.h"
75 #include "buffer.h"
76 #include "window.h"
77 #include "keyboard.h"
78 #include "intervals.h"
79 #include "process.h"
80 #include "atimer.h"
81 #include "keymap.h"
82 #include "font.h"
83 #include "xsettings.h"
84 #include "xgselect.h"
85 #include "sysselect.h"
86 #include "menu.h"
88 #ifdef USE_X_TOOLKIT
89 #include <X11/Shell.h>
90 #endif
92 #include <unistd.h>
94 #ifdef USE_GTK
95 #include "gtkutil.h"
96 #ifdef HAVE_GTK3
97 #include <X11/Xproto.h>
98 #endif
99 #endif
101 #if defined (USE_LUCID) || defined (USE_MOTIF)
102 #include "../lwlib/xlwmenu.h"
103 #endif
105 #ifdef USE_X_TOOLKIT
106 #if !defined (NO_EDITRES)
107 #define HACK_EDITRES
108 extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
109 #endif /* not NO_EDITRES */
111 /* Include toolkit specific headers for the scroll bar widget. */
113 #ifdef USE_TOOLKIT_SCROLL_BARS
114 #if defined USE_MOTIF
115 #include <Xm/Xm.h> /* For LESSTIF_VERSION */
116 #include <Xm/ScrollBar.h>
117 #else /* !USE_MOTIF i.e. use Xaw */
119 #ifdef HAVE_XAW3D
120 #include <X11/Xaw3d/Simple.h>
121 #include <X11/Xaw3d/Scrollbar.h>
122 #include <X11/Xaw3d/ThreeD.h>
123 #else /* !HAVE_XAW3D */
124 #include <X11/Xaw/Simple.h>
125 #include <X11/Xaw/Scrollbar.h>
126 #endif /* !HAVE_XAW3D */
127 #ifndef XtNpickTop
128 #define XtNpickTop "pickTop"
129 #endif /* !XtNpickTop */
130 #endif /* !USE_MOTIF */
131 #endif /* USE_TOOLKIT_SCROLL_BARS */
133 #endif /* USE_X_TOOLKIT */
135 #ifdef USE_X_TOOLKIT
136 #include "widget.h"
137 #ifndef XtNinitialState
138 #define XtNinitialState "initialState"
139 #endif
140 #endif
142 #include "bitmaps/gray.xbm"
144 #ifdef HAVE_XKB
145 #include <X11/XKBlib.h>
146 #endif
148 /* Default to using XIM if available. */
149 #ifdef USE_XIM
150 bool use_xim = true;
151 #else
152 bool use_xim = false; /* configure --without-xim */
153 #endif
155 /* Non-zero means that a HELP_EVENT has been generated since Emacs
156 start. */
158 static bool any_help_event_p;
160 /* This is a chain of structures for all the X displays currently in
161 use. */
163 struct x_display_info *x_display_list;
165 #ifdef USE_X_TOOLKIT
167 /* The application context for Xt use. */
168 XtAppContext Xt_app_con;
169 static String Xt_default_resources[] = {0};
171 /* Non-zero means user is interacting with a toolkit scroll bar. */
172 static bool toolkit_scroll_bar_interaction;
174 #endif /* USE_X_TOOLKIT */
176 /* Non-zero timeout value means ignore next mouse click if it arrives
177 before that timeout elapses (i.e. as part of the same sequence of
178 events resulting from clicking on a frame to select it). */
180 static Time ignore_next_mouse_click_timeout;
182 /* Used locally within XTread_socket. */
184 static int x_noop_count;
186 #ifdef USE_GTK
187 /* The name of the Emacs icon file. */
188 static Lisp_Object xg_default_icon_file;
189 #endif
191 /* Some functions take this as char *, not const char *. */
192 static char emacs_class[] = EMACS_CLASS;
194 enum xembed_info
196 XEMBED_MAPPED = 1 << 0
199 enum xembed_message
201 XEMBED_EMBEDDED_NOTIFY = 0,
202 XEMBED_WINDOW_ACTIVATE = 1,
203 XEMBED_WINDOW_DEACTIVATE = 2,
204 XEMBED_REQUEST_FOCUS = 3,
205 XEMBED_FOCUS_IN = 4,
206 XEMBED_FOCUS_OUT = 5,
207 XEMBED_FOCUS_NEXT = 6,
208 XEMBED_FOCUS_PREV = 7,
210 XEMBED_MODALITY_ON = 10,
211 XEMBED_MODALITY_OFF = 11,
212 XEMBED_REGISTER_ACCELERATOR = 12,
213 XEMBED_UNREGISTER_ACCELERATOR = 13,
214 XEMBED_ACTIVATE_ACCELERATOR = 14
217 static void x_free_cr_resources (struct frame *);
218 static bool x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
219 static void x_raise_frame (struct frame *);
220 static void x_lower_frame (struct frame *);
221 static int x_io_error_quitter (Display *);
222 static struct terminal *x_create_terminal (struct x_display_info *);
223 static void x_frame_rehighlight (struct x_display_info *);
225 static void x_clip_to_row (struct window *, struct glyph_row *,
226 enum glyph_row_area, GC);
227 static struct scroll_bar *x_window_to_scroll_bar (Display *, Window, int);
228 static void x_scroll_bar_report_motion (struct frame **, Lisp_Object *,
229 enum scroll_bar_part *,
230 Lisp_Object *, Lisp_Object *,
231 Time *);
232 static void x_horizontal_scroll_bar_report_motion (struct frame **, Lisp_Object *,
233 enum scroll_bar_part *,
234 Lisp_Object *, Lisp_Object *,
235 Time *);
236 static bool x_handle_net_wm_state (struct frame *, const XPropertyEvent *);
237 static void x_check_fullscreen (struct frame *);
238 static void x_check_expected_move (struct frame *, int, int);
239 static void x_sync_with_move (struct frame *, int, int, bool);
240 static int handle_one_xevent (struct x_display_info *,
241 const XEvent *, int *,
242 struct input_event *);
243 #if ! (defined USE_X_TOOLKIT || defined USE_MOTIF)
244 static int x_dispatch_event (XEvent *, Display *);
245 #endif
246 static void x_wm_set_window_state (struct frame *, int);
247 static void x_wm_set_icon_pixmap (struct frame *, ptrdiff_t);
248 static void x_initialize (void);
250 static bool get_current_wm_state (struct frame *, Window, int *, bool *);
252 /* Flush display of frame F. */
254 static void
255 x_flush (struct frame *f)
257 eassert (f && FRAME_X_P (f));
258 /* Don't call XFlush when it is not safe to redisplay; the X
259 connection may be broken. */
260 if (!NILP (Vinhibit_redisplay))
261 return;
263 block_input ();
264 XFlush (FRAME_X_DISPLAY (f));
265 unblock_input ();
269 /* Remove calls to XFlush by defining XFlush to an empty replacement.
270 Calls to XFlush should be unnecessary because the X output buffer
271 is flushed automatically as needed by calls to XPending,
272 XNextEvent, or XWindowEvent according to the XFlush man page.
273 XTread_socket calls XPending. Removing XFlush improves
274 performance. */
276 #define XFlush(DISPLAY) (void) 0
279 /***********************************************************************
280 Debugging
281 ***********************************************************************/
283 #if false
285 /* This is a function useful for recording debugging information about
286 the sequence of occurrences in this file. */
288 struct record
290 char *locus;
291 int type;
294 struct record event_record[100];
296 int event_record_index;
298 void
299 record_event (char *locus, int type)
301 if (event_record_index == ARRAYELTS (event_record))
302 event_record_index = 0;
304 event_record[event_record_index].locus = locus;
305 event_record[event_record_index].type = type;
306 event_record_index++;
309 #endif
311 #ifdef USE_CAIRO
313 #define FRAME_CR_CONTEXT(f) ((f)->output_data.x->cr_context)
314 #define FRAME_CR_SURFACE(f) ((f)->output_data.x->cr_surface)
316 static struct x_gc_ext_data *
317 x_gc_get_ext_data (struct frame *f, GC gc, int create_if_not_found_p)
319 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
320 XEDataObject object;
321 XExtData **head, *ext_data;
323 object.gc = gc;
324 head = XEHeadOfExtensionList (object);
325 ext_data = XFindOnExtensionList (head, dpyinfo->ext_codes->extension);
326 if (ext_data == NULL)
328 if (!create_if_not_found_p)
329 return NULL;
330 else
332 ext_data = xzalloc (sizeof (*ext_data));
333 ext_data->number = dpyinfo->ext_codes->extension;
334 ext_data->private_data = xzalloc (sizeof (struct x_gc_ext_data));
335 XAddToExtensionList (head, ext_data);
338 return (struct x_gc_ext_data *) ext_data->private_data;
341 static void
342 x_extension_initialize (struct x_display_info *dpyinfo)
344 XExtCodes *ext_codes = XAddExtension (dpyinfo->display);
346 dpyinfo->ext_codes = ext_codes;
349 static void
350 x_cr_destroy_surface (struct frame *f)
352 if (FRAME_CR_SURFACE (f))
354 cairo_t *cr = FRAME_CR_CONTEXT (f);
355 cairo_surface_destroy (FRAME_CR_SURFACE (f));
356 FRAME_CR_SURFACE (f) = 0;
357 if (cr) cairo_destroy (cr);
358 FRAME_CR_CONTEXT (f) = NULL;
362 cairo_t *
363 x_begin_cr_clip (struct frame *f, GC gc)
365 cairo_t *cr = FRAME_CR_CONTEXT (f);
367 if (!cr)
370 if (! FRAME_CR_SURFACE (f))
372 cairo_surface_t *surface;
373 surface = cairo_xlib_surface_create (FRAME_X_DISPLAY (f),
374 FRAME_X_WINDOW (f),
375 FRAME_DISPLAY_INFO (f)->visual,
376 FRAME_PIXEL_WIDTH (f),
377 FRAME_PIXEL_HEIGHT (f));
378 cr = cairo_create (surface);
379 cairo_surface_destroy (surface);
381 else
382 cr = cairo_create (FRAME_CR_SURFACE (f));
383 FRAME_CR_CONTEXT (f) = cr;
385 cairo_save (cr);
387 if (gc)
389 struct x_gc_ext_data *gc_ext = x_gc_get_ext_data (f, gc, 0);
391 if (gc_ext && gc_ext->n_clip_rects)
393 int i;
395 for (i = 0; i < gc_ext->n_clip_rects; i++)
396 cairo_rectangle (cr, gc_ext->clip_rects[i].x,
397 gc_ext->clip_rects[i].y,
398 gc_ext->clip_rects[i].width,
399 gc_ext->clip_rects[i].height);
400 cairo_clip (cr);
404 return cr;
407 void
408 x_end_cr_clip (struct frame *f)
410 cairo_restore (FRAME_CR_CONTEXT (f));
413 void
414 x_set_cr_source_with_gc_foreground (struct frame *f, GC gc)
416 XGCValues xgcv;
417 XColor color;
419 XGetGCValues (FRAME_X_DISPLAY (f), gc, GCForeground, &xgcv);
420 color.pixel = xgcv.foreground;
421 x_query_color (f, &color);
422 cairo_set_source_rgb (FRAME_CR_CONTEXT (f), color.red / 65535.0,
423 color.green / 65535.0, color.blue / 65535.0);
426 void
427 x_set_cr_source_with_gc_background (struct frame *f, GC gc)
429 XGCValues xgcv;
430 XColor color;
432 XGetGCValues (FRAME_X_DISPLAY (f), gc, GCBackground, &xgcv);
433 color.pixel = xgcv.background;
434 x_query_color (f, &color);
435 cairo_set_source_rgb (FRAME_CR_CONTEXT (f), color.red / 65535.0,
436 color.green / 65535.0, color.blue / 65535.0);
439 /* Fringe bitmaps. */
441 static int max_fringe_bmp = 0;
442 static cairo_pattern_t **fringe_bmp = 0;
444 static void
445 x_cr_define_fringe_bitmap (int which, unsigned short *bits, int h, int wd)
447 int i, stride;
448 cairo_surface_t *surface;
449 unsigned char *data;
450 cairo_pattern_t *pattern;
452 if (which >= max_fringe_bmp)
454 i = max_fringe_bmp;
455 max_fringe_bmp = which + 20;
456 fringe_bmp = (cairo_pattern_t **) xrealloc (fringe_bmp, max_fringe_bmp * sizeof (cairo_pattern_t *));
457 while (i < max_fringe_bmp)
458 fringe_bmp[i++] = 0;
461 block_input ();
463 surface = cairo_image_surface_create (CAIRO_FORMAT_A1, wd, h);
464 stride = cairo_image_surface_get_stride (surface);
465 data = cairo_image_surface_get_data (surface);
467 for (i = 0; i < h; i++)
469 *((unsigned short *) data) = bits[i];
470 data += stride;
473 cairo_surface_mark_dirty (surface);
474 pattern = cairo_pattern_create_for_surface (surface);
475 cairo_surface_destroy (surface);
477 unblock_input ();
479 fringe_bmp[which] = pattern;
482 static void
483 x_cr_destroy_fringe_bitmap (int which)
485 if (which >= max_fringe_bmp)
486 return;
488 if (fringe_bmp[which])
490 block_input ();
491 cairo_pattern_destroy (fringe_bmp[which]);
492 unblock_input ();
494 fringe_bmp[which] = 0;
497 static void
498 x_cr_draw_image (struct frame *f, GC gc, cairo_pattern_t *image,
499 int src_x, int src_y, int width, int height,
500 int dest_x, int dest_y, bool overlay_p)
502 cairo_t *cr;
503 cairo_matrix_t matrix;
504 cairo_surface_t *surface;
505 cairo_format_t format;
507 cr = x_begin_cr_clip (f, gc);
508 if (overlay_p)
509 cairo_rectangle (cr, dest_x, dest_y, width, height);
510 else
512 x_set_cr_source_with_gc_background (f, gc);
513 cairo_rectangle (cr, dest_x, dest_y, width, height);
514 cairo_fill_preserve (cr);
516 cairo_clip (cr);
517 cairo_matrix_init_translate (&matrix, src_x - dest_x, src_y - dest_y);
518 cairo_pattern_set_matrix (image, &matrix);
519 cairo_pattern_get_surface (image, &surface);
520 format = cairo_image_surface_get_format (surface);
521 if (format != CAIRO_FORMAT_A8 && format != CAIRO_FORMAT_A1)
523 cairo_set_source (cr, image);
524 cairo_fill (cr);
526 else
528 x_set_cr_source_with_gc_foreground (f, gc);
529 cairo_mask (cr, image);
531 x_end_cr_clip (f);
534 void
535 x_cr_draw_frame (cairo_t *cr, struct frame *f)
537 int width, height;
539 width = FRAME_PIXEL_WIDTH (f);
540 height = FRAME_PIXEL_HEIGHT (f);
542 x_free_cr_resources (f);
543 FRAME_CR_CONTEXT (f) = cr;
544 x_clear_area (f, 0, 0, width, height);
545 expose_frame (f, 0, 0, width, height);
546 FRAME_CR_CONTEXT (f) = NULL;
549 static cairo_status_t
550 x_cr_accumulate_data (void *closure, const unsigned char *data,
551 unsigned int length)
553 Lisp_Object *acc = (Lisp_Object *) closure;
555 *acc = Fcons (make_unibyte_string (data, length), *acc);
557 return CAIRO_STATUS_SUCCESS;
560 static void
561 x_cr_destroy (Lisp_Object arg)
563 cairo_t *cr = (cairo_t *) XSAVE_POINTER (arg, 0);
565 block_input ();
566 cairo_destroy (cr);
567 unblock_input ();
570 Lisp_Object
571 x_cr_export_frames (Lisp_Object frames, cairo_surface_type_t surface_type)
573 struct frame *f;
574 cairo_surface_t *surface;
575 cairo_t *cr;
576 int width, height;
577 void (*surface_set_size_func) (cairo_surface_t *, double, double) = NULL;
578 Lisp_Object acc = Qnil, args[2];
579 int count = SPECPDL_INDEX ();
581 Fredisplay (Qt);
583 f = XFRAME (XCAR (frames));
584 frames = XCDR (frames);
585 width = FRAME_PIXEL_WIDTH (f);
586 height = FRAME_PIXEL_HEIGHT (f);
588 block_input ();
589 #ifdef CAIRO_HAS_PDF_SURFACE
590 if (surface_type == CAIRO_SURFACE_TYPE_PDF)
592 surface = cairo_pdf_surface_create_for_stream (x_cr_accumulate_data, &acc,
593 width, height);
594 surface_set_size_func = cairo_pdf_surface_set_size;
596 else
597 #endif
598 #ifdef CAIRO_HAS_PNG_FUNCTIONS
599 if (surface_type == CAIRO_SURFACE_TYPE_IMAGE)
600 surface = cairo_image_surface_create (CAIRO_FORMAT_RGB24, width, height);
601 else
602 #endif
603 #ifdef CAIRO_HAS_PS_SURFACE
604 if (surface_type == CAIRO_SURFACE_TYPE_PS)
606 surface = cairo_ps_surface_create_for_stream (x_cr_accumulate_data, &acc,
607 width, height);
608 surface_set_size_func = cairo_ps_surface_set_size;
610 else
611 #endif
612 #ifdef CAIRO_HAS_SVG_SURFACE
613 if (surface_type == CAIRO_SURFACE_TYPE_SVG)
614 surface = cairo_svg_surface_create_for_stream (x_cr_accumulate_data, &acc,
615 width, height);
616 else
617 #endif
618 abort ();
620 cr = cairo_create (surface);
621 cairo_surface_destroy (surface);
622 record_unwind_protect (x_cr_destroy, make_save_ptr (cr));
623 unblock_input ();
625 while (1)
627 QUIT;
629 block_input ();
630 x_free_cr_resources (f);
631 FRAME_CR_CONTEXT (f) = cr;
632 x_clear_area (f, 0, 0, width, height);
633 expose_frame (f, 0, 0, width, height);
634 FRAME_CR_CONTEXT (f) = NULL;
635 unblock_input ();
637 if (NILP (frames))
638 break;
640 block_input ();
641 cairo_surface_show_page (surface);
642 f = XFRAME (XCAR (frames));
643 frames = XCDR (frames);
644 width = FRAME_PIXEL_WIDTH (f);
645 height = FRAME_PIXEL_HEIGHT (f);
646 if (surface_set_size_func)
647 (*surface_set_size_func) (surface, width, height);
648 unblock_input ();
651 #ifdef CAIRO_HAS_PNG_FUNCTIONS
652 if (surface_type == CAIRO_SURFACE_TYPE_IMAGE)
654 block_input ();
655 cairo_surface_flush (surface);
656 cairo_surface_write_to_png_stream (surface, x_cr_accumulate_data, &acc);
657 unblock_input ();
659 #endif
660 unbind_to (count, Qnil);
662 args[0] = intern ("concat");
663 args[1] = Fnreverse (acc);
664 return Fapply (2, args);
667 #endif /* USE_CAIRO */
669 static void
670 x_free_cr_resources (struct frame *f)
672 #ifdef USE_CAIRO
673 if (f == NULL)
675 Lisp_Object rest, frame;
676 FOR_EACH_FRAME (rest, frame)
677 if (FRAME_X_P (XFRAME (frame)))
678 x_free_cr_resources (XFRAME (frame));
680 else
682 cairo_t *cr = FRAME_CR_CONTEXT (f);
684 if (cr)
686 cairo_surface_t *surface = cairo_get_target (cr);
688 if (cairo_surface_get_type (surface) == CAIRO_SURFACE_TYPE_XLIB)
690 cairo_destroy (cr);
691 FRAME_CR_CONTEXT (f) = NULL;
695 #endif
698 static void
699 x_set_clip_rectangles (struct frame *f, GC gc, XRectangle *rectangles, int n)
701 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, rectangles, n, Unsorted);
702 #ifdef USE_CAIRO
703 eassert (n >= 0 && n <= MAX_CLIP_RECTS);
706 struct x_gc_ext_data *gc_ext = x_gc_get_ext_data (f, gc, 1);
708 gc_ext->n_clip_rects = n;
709 memcpy (gc_ext->clip_rects, rectangles, sizeof (XRectangle) * n);
711 #endif
714 static void
715 x_reset_clip_rectangles (struct frame *f, GC gc)
717 XSetClipMask (FRAME_X_DISPLAY (f), gc, None);
718 #ifdef USE_CAIRO
720 struct x_gc_ext_data *gc_ext = x_gc_get_ext_data (f, gc, 0);
722 if (gc_ext)
723 gc_ext->n_clip_rects = 0;
725 #endif
728 static void
729 x_fill_rectangle (struct frame *f, GC gc, int x, int y, int width, int height)
731 #ifdef USE_CAIRO
732 cairo_t *cr;
734 cr = x_begin_cr_clip (f, gc);
735 x_set_cr_source_with_gc_foreground (f, gc);
736 cairo_rectangle (cr, x, y, width, height);
737 cairo_fill (cr);
738 x_end_cr_clip (f);
739 #else
740 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
741 gc, x, y, width, height);
742 #endif
745 static void
746 x_draw_rectangle (struct frame *f, GC gc, int x, int y, int width, int height)
748 #ifdef USE_CAIRO
749 cairo_t *cr;
751 cr = x_begin_cr_clip (f, gc);
752 x_set_cr_source_with_gc_foreground (f, gc);
753 cairo_rectangle (cr, x + 0.5, y + 0.5, width, height);
754 cairo_set_line_width (cr, 1);
755 cairo_stroke (cr);
756 x_end_cr_clip (f);
757 #else
758 XDrawRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
759 gc, x, y, width, height);
760 #endif
763 static void
764 x_clear_window (struct frame *f)
766 #ifdef USE_CAIRO
767 cairo_t *cr;
769 cr = x_begin_cr_clip (f, NULL);
770 x_set_cr_source_with_gc_background (f, f->output_data.x->normal_gc);
771 cairo_paint (cr);
772 x_end_cr_clip (f);
773 #else
774 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
775 #endif
778 #ifdef USE_CAIRO
779 static void
780 x_fill_trapezoid_for_relief (struct frame *f, GC gc, int x, int y,
781 int width, int height, int top_p)
783 cairo_t *cr;
785 cr = x_begin_cr_clip (f, gc);
786 x_set_cr_source_with_gc_foreground (f, gc);
787 cairo_move_to (cr, top_p ? x : x + height, y);
788 cairo_line_to (cr, x, y + height);
789 cairo_line_to (cr, top_p ? x + width - height : x + width, y + height);
790 cairo_line_to (cr, x + width, y);
791 cairo_fill (cr);
792 x_end_cr_clip (f);
795 enum corners
797 CORNER_BOTTOM_RIGHT, /* 0 -> pi/2 */
798 CORNER_BOTTOM_LEFT, /* pi/2 -> pi */
799 CORNER_TOP_LEFT, /* pi -> 3pi/2 */
800 CORNER_TOP_RIGHT, /* 3pi/2 -> 2pi */
801 CORNER_LAST
804 static void
805 x_erase_corners_for_relief (struct frame *f, GC gc, int x, int y,
806 int width, int height,
807 double radius, double margin, int corners)
809 cairo_t *cr;
810 int i;
812 cr = x_begin_cr_clip (f, gc);
813 x_set_cr_source_with_gc_background (f, gc);
814 for (i = 0; i < CORNER_LAST; i++)
815 if (corners & (1 << i))
817 double xm, ym, xc, yc;
819 if (i == CORNER_TOP_LEFT || i == CORNER_BOTTOM_LEFT)
820 xm = x - margin, xc = xm + radius;
821 else
822 xm = x + width + margin, xc = xm - radius;
823 if (i == CORNER_TOP_LEFT || i == CORNER_TOP_RIGHT)
824 ym = y - margin, yc = ym + radius;
825 else
826 ym = y + height + margin, yc = ym - radius;
828 cairo_move_to (cr, xm, ym);
829 cairo_arc (cr, xc, yc, radius, i * M_PI_2, (i + 1) * M_PI_2);
831 cairo_clip (cr);
832 cairo_rectangle (cr, x, y, width, height);
833 cairo_fill (cr);
834 x_end_cr_clip (f);
837 static void
838 x_draw_horizontal_wave (struct frame *f, GC gc, int x, int y,
839 int width, int height, int wave_length)
841 cairo_t *cr;
842 double dx = wave_length, dy = height - 1;
843 int xoffset, n;
845 cr = x_begin_cr_clip (f, gc);
846 x_set_cr_source_with_gc_foreground (f, gc);
847 cairo_rectangle (cr, x, y, width, height);
848 cairo_clip (cr);
850 if (x >= 0)
852 xoffset = x % (wave_length * 2);
853 if (xoffset == 0)
854 xoffset = wave_length * 2;
856 else
857 xoffset = x % (wave_length * 2) + wave_length * 2;
858 n = (width + xoffset) / wave_length + 1;
859 if (xoffset > wave_length)
861 xoffset -= wave_length;
862 --n;
863 y += height - 1;
864 dy = -dy;
867 cairo_move_to (cr, x - xoffset + 0.5, y + 0.5);
868 while (--n >= 0)
870 cairo_rel_line_to (cr, dx, dy);
871 dy = -dy;
873 cairo_set_line_width (cr, 1);
874 cairo_stroke (cr);
875 x_end_cr_clip (f);
877 #endif
880 /* Return the struct x_display_info corresponding to DPY. */
882 struct x_display_info *
883 x_display_info_for_display (Display *dpy)
885 struct x_display_info *dpyinfo;
887 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
888 if (dpyinfo->display == dpy)
889 return dpyinfo;
891 return 0;
894 static Window
895 x_find_topmost_parent (struct frame *f)
897 struct x_output *x = f->output_data.x;
898 Window win = None, wi = x->parent_desc;
899 Display *dpy = FRAME_X_DISPLAY (f);
901 while (wi != FRAME_DISPLAY_INFO (f)->root_window)
903 Window root;
904 Window *children;
905 unsigned int nchildren;
907 win = wi;
908 if (XQueryTree (dpy, win, &root, &wi, &children, &nchildren))
909 XFree (children);
910 else
911 break;
914 return win;
917 #define OPAQUE 0xffffffff
919 void
920 x_set_frame_alpha (struct frame *f)
922 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
923 Display *dpy = FRAME_X_DISPLAY (f);
924 Window win = FRAME_OUTER_WINDOW (f);
925 double alpha = 1.0;
926 double alpha_min = 1.0;
927 unsigned long opac;
928 Window parent;
930 if (dpyinfo->x_highlight_frame == f)
931 alpha = f->alpha[0];
932 else
933 alpha = f->alpha[1];
935 if (FLOATP (Vframe_alpha_lower_limit))
936 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
937 else if (INTEGERP (Vframe_alpha_lower_limit))
938 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
940 if (alpha < 0.0)
941 return;
942 else if (alpha > 1.0)
943 alpha = 1.0;
944 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
945 alpha = alpha_min;
947 opac = alpha * OPAQUE;
949 x_catch_errors (dpy);
951 /* If there is a parent from the window manager, put the property there
952 also, to work around broken window managers that fail to do that.
953 Do this unconditionally as this function is called on reparent when
954 alpha has not changed on the frame. */
956 parent = x_find_topmost_parent (f);
957 if (parent != None)
958 XChangeProperty (dpy, parent, dpyinfo->Xatom_net_wm_window_opacity,
959 XA_CARDINAL, 32, PropModeReplace,
960 (unsigned char *) &opac, 1);
962 /* return unless necessary */
964 unsigned char *data;
965 Atom actual;
966 int rc, format;
967 unsigned long n, left;
969 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
970 0, 1, False, XA_CARDINAL,
971 &actual, &format, &n, &left,
972 &data);
974 if (rc == Success && actual != None)
976 unsigned long value = *(unsigned long *)data;
977 XFree (data);
978 if (value == opac)
980 x_uncatch_errors ();
981 return;
986 XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
987 XA_CARDINAL, 32, PropModeReplace,
988 (unsigned char *) &opac, 1);
989 x_uncatch_errors ();
992 /***********************************************************************
993 Starting and ending an update
994 ***********************************************************************/
996 /* Start an update of frame F. This function is installed as a hook
997 for update_begin, i.e. it is called when update_begin is called.
998 This function is called prior to calls to x_update_window_begin for
999 each window being updated. Currently, there is nothing to do here
1000 because all interesting stuff is done on a window basis. */
1002 static void
1003 x_update_begin (struct frame *f)
1005 #ifdef USE_CAIRO
1006 if (! NILP (tip_frame) && XFRAME (tip_frame) == f
1007 && ! FRAME_VISIBLE_P (f))
1008 return;
1010 if (! FRAME_CR_SURFACE (f))
1012 int width, height;
1013 #ifdef USE_GTK
1014 if (FRAME_GTK_WIDGET (f))
1016 GdkWindow *w = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
1017 width = gdk_window_get_width (w);
1018 height = gdk_window_get_height (w);
1020 else
1021 #endif
1023 width = FRAME_PIXEL_WIDTH (f);
1024 height = FRAME_PIXEL_HEIGHT (f);
1025 if (! FRAME_EXTERNAL_TOOL_BAR (f))
1026 height += FRAME_TOOL_BAR_HEIGHT (f);
1027 if (! FRAME_EXTERNAL_MENU_BAR (f))
1028 height += FRAME_MENU_BAR_HEIGHT (f);
1031 if (width > 0 && height > 0)
1033 block_input();
1034 FRAME_CR_SURFACE (f) = cairo_image_surface_create
1035 (CAIRO_FORMAT_ARGB32, width, height);
1036 unblock_input();
1039 #endif /* USE_CAIRO */
1042 /* Start update of window W. */
1044 static void
1045 x_update_window_begin (struct window *w)
1047 struct frame *f = XFRAME (WINDOW_FRAME (w));
1048 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
1050 w->output_cursor = w->cursor;
1052 block_input ();
1054 if (f == hlinfo->mouse_face_mouse_frame)
1056 /* Don't do highlighting for mouse motion during the update. */
1057 hlinfo->mouse_face_defer = true;
1059 /* If F needs to be redrawn, simply forget about any prior mouse
1060 highlighting. */
1061 if (FRAME_GARBAGED_P (f))
1062 hlinfo->mouse_face_window = Qnil;
1065 unblock_input ();
1069 /* Draw a vertical window border from (x,y0) to (x,y1) */
1071 static void
1072 x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
1074 struct frame *f = XFRAME (WINDOW_FRAME (w));
1075 struct face *face;
1077 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
1078 if (face)
1079 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
1080 face->foreground);
1082 #ifdef USE_CAIRO
1083 x_fill_rectangle (f, f->output_data.x->normal_gc, x, y0, 1, y1 - y0);
1084 #else
1085 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1086 f->output_data.x->normal_gc, x, y0, x, y1);
1087 #endif
1090 /* Draw a window divider from (x0,y0) to (x1,y1) */
1092 static void
1093 x_draw_window_divider (struct window *w, int x0, int x1, int y0, int y1)
1095 struct frame *f = XFRAME (WINDOW_FRAME (w));
1096 struct face *face = FACE_FROM_ID (f, WINDOW_DIVIDER_FACE_ID);
1097 struct face *face_first = FACE_FROM_ID (f, WINDOW_DIVIDER_FIRST_PIXEL_FACE_ID);
1098 struct face *face_last = FACE_FROM_ID (f, WINDOW_DIVIDER_LAST_PIXEL_FACE_ID);
1099 unsigned long color = face ? face->foreground : FRAME_FOREGROUND_PIXEL (f);
1100 unsigned long color_first = (face_first
1101 ? face_first->foreground
1102 : FRAME_FOREGROUND_PIXEL (f));
1103 unsigned long color_last = (face_last
1104 ? face_last->foreground
1105 : FRAME_FOREGROUND_PIXEL (f));
1106 Display *display = FRAME_X_DISPLAY (f);
1108 if (y1 - y0 > x1 - x0 && x1 - x0 > 2)
1109 /* Vertical. */
1111 XSetForeground (display, f->output_data.x->normal_gc, color_first);
1112 x_fill_rectangle (f, f->output_data.x->normal_gc,
1113 x0, y0, 1, y1 - y0);
1114 XSetForeground (display, f->output_data.x->normal_gc, color);
1115 x_fill_rectangle (f, f->output_data.x->normal_gc,
1116 x0 + 1, y0, x1 - x0 - 2, y1 - y0);
1117 XSetForeground (display, f->output_data.x->normal_gc, color_last);
1118 x_fill_rectangle (f, f->output_data.x->normal_gc,
1119 x1 - 1, y0, 1, y1 - y0);
1121 else if (x1 - x0 > y1 - y0 && y1 - y0 > 3)
1122 /* Horizontal. */
1124 XSetForeground (display, f->output_data.x->normal_gc, color_first);
1125 x_fill_rectangle (f, f->output_data.x->normal_gc,
1126 x0, y0, x1 - x0, 1);
1127 XSetForeground (display, f->output_data.x->normal_gc, color);
1128 x_fill_rectangle (f, f->output_data.x->normal_gc,
1129 x0, y0 + 1, x1 - x0, y1 - y0 - 2);
1130 XSetForeground (display, f->output_data.x->normal_gc, color_last);
1131 x_fill_rectangle (f, f->output_data.x->normal_gc,
1132 x0, y1 - 1, x1 - x0, 1);
1134 else
1136 XSetForeground (display, f->output_data.x->normal_gc, color);
1137 x_fill_rectangle (f, f->output_data.x->normal_gc,
1138 x0, y0, x1 - x0, y1 - y0);
1142 /* End update of window W.
1144 Draw vertical borders between horizontally adjacent windows, and
1145 display W's cursor if CURSOR_ON_P is non-zero.
1147 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
1148 glyphs in mouse-face were overwritten. In that case we have to
1149 make sure that the mouse-highlight is properly redrawn.
1151 W may be a menu bar pseudo-window in case we don't have X toolkit
1152 support. Such windows don't have a cursor, so don't display it
1153 here. */
1155 static void
1156 x_update_window_end (struct window *w, bool cursor_on_p,
1157 bool mouse_face_overwritten_p)
1159 if (!w->pseudo_window_p)
1161 block_input ();
1163 if (cursor_on_p)
1164 display_and_set_cursor (w, true,
1165 w->output_cursor.hpos, w->output_cursor.vpos,
1166 w->output_cursor.x, w->output_cursor.y);
1168 if (draw_window_fringes (w, true))
1170 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
1171 x_draw_right_divider (w);
1172 else
1173 x_draw_vertical_border (w);
1176 unblock_input ();
1179 /* If a row with mouse-face was overwritten, arrange for
1180 XTframe_up_to_date to redisplay the mouse highlight. */
1181 if (mouse_face_overwritten_p)
1183 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
1185 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
1186 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
1187 hlinfo->mouse_face_window = Qnil;
1192 /* End update of frame F. This function is installed as a hook in
1193 update_end. */
1195 static void
1196 x_update_end (struct frame *f)
1198 /* Mouse highlight may be displayed again. */
1199 MOUSE_HL_INFO (f)->mouse_face_defer = false;
1201 #ifdef USE_CAIRO
1202 if (FRAME_CR_SURFACE (f))
1204 cairo_t *cr = 0;
1205 block_input();
1206 #if defined (USE_GTK) && defined (HAVE_GTK3)
1207 if (FRAME_GTK_WIDGET (f))
1209 GdkWindow *w = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
1210 cr = gdk_cairo_create (w);
1212 else
1213 #endif
1215 cairo_surface_t *surface;
1216 int width = FRAME_PIXEL_WIDTH (f);
1217 int height = FRAME_PIXEL_HEIGHT (f);
1218 if (! FRAME_EXTERNAL_TOOL_BAR (f))
1219 height += FRAME_TOOL_BAR_HEIGHT (f);
1220 if (! FRAME_EXTERNAL_MENU_BAR (f))
1221 height += FRAME_MENU_BAR_HEIGHT (f);
1222 surface = cairo_xlib_surface_create (FRAME_X_DISPLAY (f),
1223 FRAME_X_WINDOW (f),
1224 FRAME_DISPLAY_INFO (f)->visual,
1225 width,
1226 height);
1227 cr = cairo_create (surface);
1228 cairo_surface_destroy (surface);
1231 cairo_set_source_surface (cr, FRAME_CR_SURFACE (f), 0, 0);
1232 cairo_paint (cr);
1233 cairo_destroy (cr);
1234 unblock_input ();
1236 #endif /* USE_CAIRO */
1238 #ifndef XFlush
1239 block_input ();
1240 XFlush (FRAME_X_DISPLAY (f));
1241 unblock_input ();
1242 #endif
1246 /* This function is called from various places in xdisp.c
1247 whenever a complete update has been performed. */
1249 static void
1250 XTframe_up_to_date (struct frame *f)
1252 if (FRAME_X_P (f))
1253 FRAME_MOUSE_UPDATE (f);
1257 /* Clear under internal border if any (GTK has its own version). */
1258 #ifndef USE_GTK
1259 void
1260 x_clear_under_internal_border (struct frame *f)
1262 if (FRAME_INTERNAL_BORDER_WIDTH (f) > 0)
1264 int border = FRAME_INTERNAL_BORDER_WIDTH (f);
1265 int width = FRAME_PIXEL_WIDTH (f);
1266 int height = FRAME_PIXEL_HEIGHT (f);
1267 int margin = FRAME_TOP_MARGIN_HEIGHT (f);
1269 block_input ();
1270 x_clear_area (f, 0, 0, border, height);
1271 x_clear_area (f, 0, margin, width, border);
1272 x_clear_area (f, width - border, 0, border, height);
1273 x_clear_area (f, 0, height - border, width, border);
1274 unblock_input ();
1277 #endif
1279 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
1280 arrow bitmaps, or clear the fringes if no bitmaps are required
1281 before DESIRED_ROW is made current. This function is called from
1282 update_window_line only if it is known that there are differences
1283 between bitmaps to be drawn between current row and DESIRED_ROW. */
1285 static void
1286 x_after_update_window_line (struct window *w, struct glyph_row *desired_row)
1288 eassert (w);
1290 if (!desired_row->mode_line_p && !w->pseudo_window_p)
1291 desired_row->redraw_fringe_bitmaps_p = true;
1293 #ifdef USE_X_TOOLKIT
1294 /* When a window has disappeared, make sure that no rest of
1295 full-width rows stays visible in the internal border. Could
1296 check here if updated window is the leftmost/rightmost window,
1297 but I guess it's not worth doing since vertically split windows
1298 are almost never used, internal border is rarely set, and the
1299 overhead is very small. */
1301 struct frame *f;
1302 int width, height;
1304 if (windows_or_buffers_changed
1305 && desired_row->full_width_p
1306 && (f = XFRAME (w->frame),
1307 width = FRAME_INTERNAL_BORDER_WIDTH (f),
1308 width != 0)
1309 && (height = desired_row->visible_height,
1310 height > 0))
1312 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
1314 block_input ();
1315 x_clear_area (f, 0, y, width, height);
1316 x_clear_area (f, FRAME_PIXEL_WIDTH (f) - width, y, width, height);
1317 unblock_input ();
1320 #endif
1323 static void
1324 x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
1326 struct frame *f = XFRAME (WINDOW_FRAME (w));
1327 Display *display = FRAME_X_DISPLAY (f);
1328 Window window = FRAME_X_WINDOW (f);
1329 GC gc = f->output_data.x->normal_gc;
1330 struct face *face = p->face;
1332 /* Must clip because of partially visible lines. */
1333 x_clip_to_row (w, row, ANY_AREA, gc);
1335 if (p->bx >= 0 && !p->overlay_p)
1337 /* In case the same realized face is used for fringes and
1338 for something displayed in the text (e.g. face `region' on
1339 mono-displays, the fill style may have been changed to
1340 FillSolid in x_draw_glyph_string_background. */
1341 if (face->stipple)
1342 XSetFillStyle (display, face->gc, FillOpaqueStippled);
1343 else
1344 XSetForeground (display, face->gc, face->background);
1346 x_fill_rectangle (f, face->gc, p->bx, p->by, p->nx, p->ny);
1348 if (!face->stipple)
1349 XSetForeground (display, face->gc, face->foreground);
1352 #ifdef USE_CAIRO
1353 if (p->which && p->which < max_fringe_bmp)
1355 XGCValues gcv;
1357 XGetGCValues (display, gc, GCForeground | GCBackground, &gcv);
1358 XSetForeground (display, gc, (p->cursor_p
1359 ? (p->overlay_p ? face->background
1360 : f->output_data.x->cursor_pixel)
1361 : face->foreground));
1362 XSetBackground (display, gc, face->background);
1363 x_cr_draw_image (f, gc, fringe_bmp[p->which], 0, p->dh,
1364 p->wd, p->h, p->x, p->y, p->overlay_p);
1365 XSetForeground (display, gc, gcv.foreground);
1366 XSetBackground (display, gc, gcv.background);
1368 #else /* not USE_CAIRO */
1369 if (p->which)
1371 char *bits;
1372 Pixmap pixmap, clipmask = (Pixmap) 0;
1373 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
1374 XGCValues gcv;
1376 if (p->wd > 8)
1377 bits = (char *) (p->bits + p->dh);
1378 else
1379 bits = (char *) p->bits + p->dh;
1381 /* Draw the bitmap. I believe these small pixmaps can be cached
1382 by the server. */
1383 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
1384 (p->cursor_p
1385 ? (p->overlay_p ? face->background
1386 : f->output_data.x->cursor_pixel)
1387 : face->foreground),
1388 face->background, depth);
1390 if (p->overlay_p)
1392 clipmask = XCreatePixmapFromBitmapData (display,
1393 FRAME_DISPLAY_INFO (f)->root_window,
1394 bits, p->wd, p->h,
1395 1, 0, 1);
1396 gcv.clip_mask = clipmask;
1397 gcv.clip_x_origin = p->x;
1398 gcv.clip_y_origin = p->y;
1399 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
1402 XCopyArea (display, pixmap, window, gc, 0, 0,
1403 p->wd, p->h, p->x, p->y);
1404 XFreePixmap (display, pixmap);
1406 if (p->overlay_p)
1408 gcv.clip_mask = (Pixmap) 0;
1409 XChangeGC (display, gc, GCClipMask, &gcv);
1410 XFreePixmap (display, clipmask);
1413 #endif /* not USE_CAIRO */
1415 x_reset_clip_rectangles (f, gc);
1418 /***********************************************************************
1419 Glyph display
1420 ***********************************************************************/
1424 static void x_set_glyph_string_clipping (struct glyph_string *);
1425 static void x_set_glyph_string_gc (struct glyph_string *);
1426 static void x_draw_glyph_string_foreground (struct glyph_string *);
1427 static void x_draw_composite_glyph_string_foreground (struct glyph_string *);
1428 static void x_draw_glyph_string_box (struct glyph_string *);
1429 static void x_draw_glyph_string (struct glyph_string *);
1430 static _Noreturn void x_delete_glyphs (struct frame *, int);
1431 static void x_compute_glyph_string_overhangs (struct glyph_string *);
1432 static void x_set_cursor_gc (struct glyph_string *);
1433 static void x_set_mode_line_face_gc (struct glyph_string *);
1434 static void x_set_mouse_face_gc (struct glyph_string *);
1435 static bool x_alloc_lighter_color (struct frame *, Display *, Colormap,
1436 unsigned long *, double, int);
1437 static void x_setup_relief_color (struct frame *, struct relief *,
1438 double, int, unsigned long);
1439 static void x_setup_relief_colors (struct glyph_string *);
1440 static void x_draw_image_glyph_string (struct glyph_string *);
1441 static void x_draw_image_relief (struct glyph_string *);
1442 static void x_draw_image_foreground (struct glyph_string *);
1443 static void x_draw_image_foreground_1 (struct glyph_string *, Pixmap);
1444 static void x_clear_glyph_string_rect (struct glyph_string *, int,
1445 int, int, int);
1446 static void x_draw_relief_rect (struct frame *, int, int, int, int,
1447 int, bool, bool, bool, bool, bool,
1448 XRectangle *);
1449 static void x_draw_box_rect (struct glyph_string *, int, int, int, int,
1450 int, bool, bool, XRectangle *);
1451 static void x_scroll_bar_clear (struct frame *);
1453 #ifdef GLYPH_DEBUG
1454 static void x_check_font (struct frame *, struct font *);
1455 #endif
1458 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
1459 face. */
1461 static void
1462 x_set_cursor_gc (struct glyph_string *s)
1464 if (s->font == FRAME_FONT (s->f)
1465 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
1466 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
1467 && !s->cmp)
1468 s->gc = s->f->output_data.x->cursor_gc;
1469 else
1471 /* Cursor on non-default face: must merge. */
1472 XGCValues xgcv;
1473 unsigned long mask;
1475 xgcv.background = s->f->output_data.x->cursor_pixel;
1476 xgcv.foreground = s->face->background;
1478 /* If the glyph would be invisible, try a different foreground. */
1479 if (xgcv.foreground == xgcv.background)
1480 xgcv.foreground = s->face->foreground;
1481 if (xgcv.foreground == xgcv.background)
1482 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
1483 if (xgcv.foreground == xgcv.background)
1484 xgcv.foreground = s->face->foreground;
1486 /* Make sure the cursor is distinct from text in this face. */
1487 if (xgcv.background == s->face->background
1488 && xgcv.foreground == s->face->foreground)
1490 xgcv.background = s->face->foreground;
1491 xgcv.foreground = s->face->background;
1494 IF_DEBUG (x_check_font (s->f, s->font));
1495 xgcv.graphics_exposures = False;
1496 mask = GCForeground | GCBackground | GCGraphicsExposures;
1498 if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1499 XChangeGC (s->display, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1500 mask, &xgcv);
1501 else
1502 FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
1503 = XCreateGC (s->display, s->window, mask, &xgcv);
1505 s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1510 /* Set up S->gc of glyph string S for drawing text in mouse face. */
1512 static void
1513 x_set_mouse_face_gc (struct glyph_string *s)
1515 int face_id;
1516 struct face *face;
1518 /* What face has to be used last for the mouse face? */
1519 face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
1520 face = FACE_FROM_ID (s->f, face_id);
1521 if (face == NULL)
1522 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
1524 if (s->first_glyph->type == CHAR_GLYPH)
1525 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1526 else
1527 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1528 s->face = FACE_FROM_ID (s->f, face_id);
1529 prepare_face_for_display (s->f, s->face);
1531 if (s->font == s->face->font)
1532 s->gc = s->face->gc;
1533 else
1535 /* Otherwise construct scratch_cursor_gc with values from FACE
1536 except for FONT. */
1537 XGCValues xgcv;
1538 unsigned long mask;
1540 xgcv.background = s->face->background;
1541 xgcv.foreground = s->face->foreground;
1542 xgcv.graphics_exposures = False;
1543 mask = GCForeground | GCBackground | GCGraphicsExposures;
1545 if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1546 XChangeGC (s->display, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1547 mask, &xgcv);
1548 else
1549 FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
1550 = XCreateGC (s->display, s->window, mask, &xgcv);
1552 s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1555 eassert (s->gc != 0);
1559 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1560 Faces to use in the mode line have already been computed when the
1561 matrix was built, so there isn't much to do, here. */
1563 static void
1564 x_set_mode_line_face_gc (struct glyph_string *s)
1566 s->gc = s->face->gc;
1570 /* Set S->gc of glyph string S for drawing that glyph string. Set
1571 S->stippled_p to a non-zero value if the face of S has a stipple
1572 pattern. */
1574 static void
1575 x_set_glyph_string_gc (struct glyph_string *s)
1577 prepare_face_for_display (s->f, s->face);
1579 if (s->hl == DRAW_NORMAL_TEXT)
1581 s->gc = s->face->gc;
1582 s->stippled_p = s->face->stipple != 0;
1584 else if (s->hl == DRAW_INVERSE_VIDEO)
1586 x_set_mode_line_face_gc (s);
1587 s->stippled_p = s->face->stipple != 0;
1589 else if (s->hl == DRAW_CURSOR)
1591 x_set_cursor_gc (s);
1592 s->stippled_p = false;
1594 else if (s->hl == DRAW_MOUSE_FACE)
1596 x_set_mouse_face_gc (s);
1597 s->stippled_p = s->face->stipple != 0;
1599 else if (s->hl == DRAW_IMAGE_RAISED
1600 || s->hl == DRAW_IMAGE_SUNKEN)
1602 s->gc = s->face->gc;
1603 s->stippled_p = s->face->stipple != 0;
1605 else
1606 emacs_abort ();
1608 /* GC must have been set. */
1609 eassert (s->gc != 0);
1613 /* Set clipping for output of glyph string S. S may be part of a mode
1614 line or menu if we don't have X toolkit support. */
1616 static void
1617 x_set_glyph_string_clipping (struct glyph_string *s)
1619 XRectangle *r = s->clip;
1620 int n = get_glyph_string_clip_rects (s, r, 2);
1622 if (n > 0)
1623 x_set_clip_rectangles (s->f, s->gc, r, n);
1624 s->num_clips = n;
1628 /* Set SRC's clipping for output of glyph string DST. This is called
1629 when we are drawing DST's left_overhang or right_overhang only in
1630 the area of SRC. */
1632 static void
1633 x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1635 XRectangle r;
1637 r.x = src->x;
1638 r.width = src->width;
1639 r.y = src->y;
1640 r.height = src->height;
1641 dst->clip[0] = r;
1642 dst->num_clips = 1;
1643 x_set_clip_rectangles (dst->f, dst->gc, &r, 1);
1647 /* RIF:
1648 Compute left and right overhang of glyph string S. */
1650 static void
1651 x_compute_glyph_string_overhangs (struct glyph_string *s)
1653 if (s->cmp == NULL
1654 && (s->first_glyph->type == CHAR_GLYPH
1655 || s->first_glyph->type == COMPOSITE_GLYPH))
1657 struct font_metrics metrics;
1659 if (s->first_glyph->type == CHAR_GLYPH)
1661 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1662 struct font *font = s->font;
1663 int i;
1665 for (i = 0; i < s->nchars; i++)
1666 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1667 font->driver->text_extents (font, code, s->nchars, &metrics);
1669 else
1671 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1673 composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
1675 s->right_overhang = (metrics.rbearing > metrics.width
1676 ? metrics.rbearing - metrics.width : 0);
1677 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1679 else if (s->cmp)
1681 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1682 s->left_overhang = - s->cmp->lbearing;
1687 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1689 static void
1690 x_clear_glyph_string_rect (struct glyph_string *s, int x, int y, int w, int h)
1692 XGCValues xgcv;
1693 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1694 XSetForeground (s->display, s->gc, xgcv.background);
1695 x_fill_rectangle (s->f, s->gc, x, y, w, h);
1696 XSetForeground (s->display, s->gc, xgcv.foreground);
1700 /* Draw the background of glyph_string S. If S->background_filled_p
1701 is non-zero don't draw it. FORCE_P non-zero means draw the
1702 background even if it wouldn't be drawn normally. This is used
1703 when a string preceding S draws into the background of S, or S
1704 contains the first component of a composition. */
1706 static void
1707 x_draw_glyph_string_background (struct glyph_string *s, bool force_p)
1709 /* Nothing to do if background has already been drawn or if it
1710 shouldn't be drawn in the first place. */
1711 if (!s->background_filled_p)
1713 int box_line_width = max (s->face->box_line_width, 0);
1715 if (s->stippled_p)
1717 /* Fill background with a stipple pattern. */
1718 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1719 x_fill_rectangle (s->f, s->gc, s->x,
1720 s->y + box_line_width,
1721 s->background_width,
1722 s->height - 2 * box_line_width);
1723 XSetFillStyle (s->display, s->gc, FillSolid);
1724 s->background_filled_p = true;
1726 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1727 /* When xdisp.c ignores FONT_HEIGHT, we cannot trust
1728 font dimensions, since the actual glyphs might be
1729 much smaller. So in that case we always clear the
1730 rectangle with background color. */
1731 || FONT_TOO_HIGH (s->font)
1732 || s->font_not_found_p
1733 || s->extends_to_end_of_line_p
1734 || force_p)
1736 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1737 s->background_width,
1738 s->height - 2 * box_line_width);
1739 s->background_filled_p = true;
1745 /* Draw the foreground of glyph string S. */
1747 static void
1748 x_draw_glyph_string_foreground (struct glyph_string *s)
1750 int i, x;
1752 /* If first glyph of S has a left box line, start drawing the text
1753 of S to the right of that box line. */
1754 if (s->face->box != FACE_NO_BOX
1755 && s->first_glyph->left_box_line_p)
1756 x = s->x + eabs (s->face->box_line_width);
1757 else
1758 x = s->x;
1760 /* Draw characters of S as rectangles if S's font could not be
1761 loaded. */
1762 if (s->font_not_found_p)
1764 for (i = 0; i < s->nchars; ++i)
1766 struct glyph *g = s->first_glyph + i;
1767 x_draw_rectangle (s->f,
1768 s->gc, x, s->y, g->pixel_width - 1,
1769 s->height - 1);
1770 x += g->pixel_width;
1773 else
1775 struct font *font = s->font;
1776 int boff = font->baseline_offset;
1777 int y;
1779 if (font->vertical_centering)
1780 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1782 y = s->ybase - boff;
1783 if (s->for_overlaps
1784 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1785 font->driver->draw (s, 0, s->nchars, x, y, false);
1786 else
1787 font->driver->draw (s, 0, s->nchars, x, y, true);
1788 if (s->face->overstrike)
1789 font->driver->draw (s, 0, s->nchars, x + 1, y, false);
1793 /* Draw the foreground of composite glyph string S. */
1795 static void
1796 x_draw_composite_glyph_string_foreground (struct glyph_string *s)
1798 int i, j, x;
1799 struct font *font = s->font;
1801 /* If first glyph of S has a left box line, start drawing the text
1802 of S to the right of that box line. */
1803 if (s->face && s->face->box != FACE_NO_BOX
1804 && s->first_glyph->left_box_line_p)
1805 x = s->x + eabs (s->face->box_line_width);
1806 else
1807 x = s->x;
1809 /* S is a glyph string for a composition. S->cmp_from is the index
1810 of the first character drawn for glyphs of this composition.
1811 S->cmp_from == 0 means we are drawing the very first character of
1812 this composition. */
1814 /* Draw a rectangle for the composition if the font for the very
1815 first character of the composition could not be loaded. */
1816 if (s->font_not_found_p)
1818 if (s->cmp_from == 0)
1819 x_draw_rectangle (s->f, s->gc, x, s->y,
1820 s->width - 1, s->height - 1);
1822 else if (! s->first_glyph->u.cmp.automatic)
1824 int y = s->ybase;
1826 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1827 /* TAB in a composition means display glyphs with padding
1828 space on the left or right. */
1829 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1831 int xx = x + s->cmp->offsets[j * 2];
1832 int yy = y - s->cmp->offsets[j * 2 + 1];
1834 font->driver->draw (s, j, j + 1, xx, yy, false);
1835 if (s->face->overstrike)
1836 font->driver->draw (s, j, j + 1, xx + 1, yy, false);
1839 else
1841 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1842 Lisp_Object glyph;
1843 int y = s->ybase;
1844 int width = 0;
1846 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1848 glyph = LGSTRING_GLYPH (gstring, i);
1849 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1850 width += LGLYPH_WIDTH (glyph);
1851 else
1853 int xoff, yoff, wadjust;
1855 if (j < i)
1857 font->driver->draw (s, j, i, x, y, false);
1858 if (s->face->overstrike)
1859 font->driver->draw (s, j, i, x + 1, y, false);
1860 x += width;
1862 xoff = LGLYPH_XOFF (glyph);
1863 yoff = LGLYPH_YOFF (glyph);
1864 wadjust = LGLYPH_WADJUST (glyph);
1865 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, false);
1866 if (s->face->overstrike)
1867 font->driver->draw (s, i, i + 1, x + xoff + 1, y + yoff,
1868 false);
1869 x += wadjust;
1870 j = i + 1;
1871 width = 0;
1874 if (j < i)
1876 font->driver->draw (s, j, i, x, y, false);
1877 if (s->face->overstrike)
1878 font->driver->draw (s, j, i, x + 1, y, false);
1884 /* Draw the foreground of glyph string S for glyphless characters. */
1886 static void
1887 x_draw_glyphless_glyph_string_foreground (struct glyph_string *s)
1889 struct glyph *glyph = s->first_glyph;
1890 XChar2b char2b[8];
1891 int x, i, j;
1893 /* If first glyph of S has a left box line, start drawing the text
1894 of S to the right of that box line. */
1895 if (s->face && s->face->box != FACE_NO_BOX
1896 && s->first_glyph->left_box_line_p)
1897 x = s->x + eabs (s->face->box_line_width);
1898 else
1899 x = s->x;
1901 s->char2b = char2b;
1903 for (i = 0; i < s->nchars; i++, glyph++)
1905 char buf[7], *str = NULL;
1906 int len = glyph->u.glyphless.len;
1908 if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_ACRONYM)
1910 if (len > 0
1911 && CHAR_TABLE_P (Vglyphless_char_display)
1912 && (CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display))
1913 >= 1))
1915 Lisp_Object acronym
1916 = (! glyph->u.glyphless.for_no_font
1917 ? CHAR_TABLE_REF (Vglyphless_char_display,
1918 glyph->u.glyphless.ch)
1919 : XCHAR_TABLE (Vglyphless_char_display)->extras[0]);
1920 if (STRINGP (acronym))
1921 str = SSDATA (acronym);
1924 else if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_HEX_CODE)
1926 sprintf (buf, "%0*X",
1927 glyph->u.glyphless.ch < 0x10000 ? 4 : 6,
1928 glyph->u.glyphless.ch + 0u);
1929 str = buf;
1932 if (str)
1934 int upper_len = (len + 1) / 2;
1935 unsigned code;
1937 /* It is assured that all LEN characters in STR is ASCII. */
1938 for (j = 0; j < len; j++)
1940 code = s->font->driver->encode_char (s->font, str[j]);
1941 STORE_XCHAR2B (char2b + j, code >> 8, code & 0xFF);
1943 s->font->driver->draw (s, 0, upper_len,
1944 x + glyph->slice.glyphless.upper_xoff,
1945 s->ybase + glyph->slice.glyphless.upper_yoff,
1946 false);
1947 s->font->driver->draw (s, upper_len, len,
1948 x + glyph->slice.glyphless.lower_xoff,
1949 s->ybase + glyph->slice.glyphless.lower_yoff,
1950 false);
1952 if (glyph->u.glyphless.method != GLYPHLESS_DISPLAY_THIN_SPACE)
1953 x_draw_rectangle (s->f, s->gc,
1954 x, s->ybase - glyph->ascent,
1955 glyph->pixel_width - 1,
1956 glyph->ascent + glyph->descent - 1);
1957 x += glyph->pixel_width;
1961 #ifdef USE_X_TOOLKIT
1963 #ifdef USE_LUCID
1965 /* Return the frame on which widget WIDGET is used.. Abort if frame
1966 cannot be determined. */
1968 static struct frame *
1969 x_frame_of_widget (Widget widget)
1971 struct x_display_info *dpyinfo;
1972 Lisp_Object tail, frame;
1973 struct frame *f;
1975 dpyinfo = x_display_info_for_display (XtDisplay (widget));
1977 /* Find the top-level shell of the widget. Note that this function
1978 can be called when the widget is not yet realized, so XtWindow
1979 (widget) == 0. That's the reason we can't simply use
1980 x_any_window_to_frame. */
1981 while (!XtIsTopLevelShell (widget))
1982 widget = XtParent (widget);
1984 /* Look for a frame with that top-level widget. Allocate the color
1985 on that frame to get the right gamma correction value. */
1986 FOR_EACH_FRAME (tail, frame)
1988 f = XFRAME (frame);
1989 if (FRAME_X_P (f)
1990 && f->output_data.nothing != 1
1991 && FRAME_DISPLAY_INFO (f) == dpyinfo
1992 && f->output_data.x->widget == widget)
1993 return f;
1995 emacs_abort ();
1998 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
1999 or DELTA. Try a color with RGB values multiplied by FACTOR first.
2000 If this produces the same color as PIXEL, try a color where all RGB
2001 values have DELTA added. Return the allocated color in *PIXEL.
2002 DISPLAY is the X display, CMAP is the colormap to operate on.
2003 Value is true if successful. */
2005 bool
2006 x_alloc_lighter_color_for_widget (Widget widget, Display *display, Colormap cmap,
2007 unsigned long *pixel, double factor, int delta)
2009 struct frame *f = x_frame_of_widget (widget);
2010 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
2013 #endif /* USE_LUCID */
2016 /* Structure specifying which arguments should be passed by Xt to
2017 cvt_string_to_pixel. We want the widget's screen and colormap. */
2019 static XtConvertArgRec cvt_string_to_pixel_args[] =
2021 {XtWidgetBaseOffset, (XtPointer) offsetof (WidgetRec, core.screen),
2022 sizeof (Screen *)},
2023 {XtWidgetBaseOffset, (XtPointer) offsetof (WidgetRec, core.colormap),
2024 sizeof (Colormap)}
2028 /* The address of this variable is returned by
2029 cvt_string_to_pixel. */
2031 static Pixel cvt_string_to_pixel_value;
2034 /* Convert a color name to a pixel color.
2036 DPY is the display we are working on.
2038 ARGS is an array of *NARGS XrmValue structures holding additional
2039 information about the widget for which the conversion takes place.
2040 The contents of this array are determined by the specification
2041 in cvt_string_to_pixel_args.
2043 FROM is a pointer to an XrmValue which points to the color name to
2044 convert. TO is an XrmValue in which to return the pixel color.
2046 CLOSURE_RET is a pointer to user-data, in which we record if
2047 we allocated the color or not.
2049 Value is True if successful, False otherwise. */
2051 static Boolean
2052 cvt_string_to_pixel (Display *dpy, XrmValue *args, Cardinal *nargs,
2053 XrmValue *from, XrmValue *to,
2054 XtPointer *closure_ret)
2056 Screen *screen;
2057 Colormap cmap;
2058 Pixel pixel;
2059 String color_name;
2060 XColor color;
2062 if (*nargs != 2)
2064 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
2065 "wrongParameters", "cvt_string_to_pixel",
2066 "XtToolkitError",
2067 "Screen and colormap args required", NULL, NULL);
2068 return False;
2071 screen = *(Screen **) args[0].addr;
2072 cmap = *(Colormap *) args[1].addr;
2073 color_name = (String) from->addr;
2075 if (strcmp (color_name, XtDefaultBackground) == 0)
2077 *closure_ret = (XtPointer) False;
2078 pixel = WhitePixelOfScreen (screen);
2080 else if (strcmp (color_name, XtDefaultForeground) == 0)
2082 *closure_ret = (XtPointer) False;
2083 pixel = BlackPixelOfScreen (screen);
2085 else if (XParseColor (dpy, cmap, color_name, &color)
2086 && x_alloc_nearest_color_1 (dpy, cmap, &color))
2088 pixel = color.pixel;
2089 *closure_ret = (XtPointer) True;
2091 else
2093 String params[1];
2094 Cardinal nparams = 1;
2096 params[0] = color_name;
2097 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
2098 "badValue", "cvt_string_to_pixel",
2099 "XtToolkitError", "Invalid color '%s'",
2100 params, &nparams);
2101 return False;
2104 if (to->addr != NULL)
2106 if (to->size < sizeof (Pixel))
2108 to->size = sizeof (Pixel);
2109 return False;
2112 *(Pixel *) to->addr = pixel;
2114 else
2116 cvt_string_to_pixel_value = pixel;
2117 to->addr = (XtPointer) &cvt_string_to_pixel_value;
2120 to->size = sizeof (Pixel);
2121 return True;
2125 /* Free a pixel color which was previously allocated via
2126 cvt_string_to_pixel. This is registered as the destructor
2127 for this type of resource via XtSetTypeConverter.
2129 APP is the application context in which we work.
2131 TO is a pointer to an XrmValue holding the color to free.
2132 CLOSURE is the value we stored in CLOSURE_RET for this color
2133 in cvt_string_to_pixel.
2135 ARGS and NARGS are like for cvt_string_to_pixel. */
2137 static void
2138 cvt_pixel_dtor (XtAppContext app, XrmValuePtr to, XtPointer closure, XrmValuePtr args,
2139 Cardinal *nargs)
2141 if (*nargs != 2)
2143 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
2144 "XtToolkitError",
2145 "Screen and colormap arguments required",
2146 NULL, NULL);
2148 else if (closure != NULL)
2150 /* We did allocate the pixel, so free it. */
2151 Screen *screen = *(Screen **) args[0].addr;
2152 Colormap cmap = *(Colormap *) args[1].addr;
2153 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
2154 (Pixel *) to->addr, 1);
2159 #endif /* USE_X_TOOLKIT */
2162 /* Value is an array of XColor structures for the contents of the
2163 color map of display DPY. Set *NCELLS to the size of the array.
2164 Note that this probably shouldn't be called for large color maps,
2165 say a 24-bit TrueColor map. */
2167 static const XColor *
2168 x_color_cells (Display *dpy, int *ncells)
2170 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
2172 if (dpyinfo->color_cells == NULL)
2174 Screen *screen = dpyinfo->screen;
2175 int ncolor_cells = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
2176 int i;
2178 dpyinfo->color_cells = xnmalloc (ncolor_cells,
2179 sizeof *dpyinfo->color_cells);
2180 dpyinfo->ncolor_cells = ncolor_cells;
2182 for (i = 0; i < ncolor_cells; ++i)
2183 dpyinfo->color_cells[i].pixel = i;
2185 XQueryColors (dpy, dpyinfo->cmap,
2186 dpyinfo->color_cells, ncolor_cells);
2189 *ncells = dpyinfo->ncolor_cells;
2190 return dpyinfo->color_cells;
2194 /* On frame F, translate pixel colors to RGB values for the NCOLORS
2195 colors in COLORS. Use cached information, if available. */
2197 void
2198 x_query_colors (struct frame *f, XColor *colors, int ncolors)
2200 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
2202 if (dpyinfo->color_cells)
2204 int i;
2205 for (i = 0; i < ncolors; ++i)
2207 unsigned long pixel = colors[i].pixel;
2208 eassert (pixel < dpyinfo->ncolor_cells);
2209 eassert (dpyinfo->color_cells[pixel].pixel == pixel);
2210 colors[i] = dpyinfo->color_cells[pixel];
2213 else
2214 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
2218 /* On frame F, translate pixel color to RGB values for the color in
2219 COLOR. Use cached information, if available. */
2221 void
2222 x_query_color (struct frame *f, XColor *color)
2224 x_query_colors (f, color, 1);
2228 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
2229 exact match can't be allocated, try the nearest color available.
2230 Value is true if successful. Set *COLOR to the color
2231 allocated. */
2233 static bool
2234 x_alloc_nearest_color_1 (Display *dpy, Colormap cmap, XColor *color)
2236 bool rc;
2238 rc = XAllocColor (dpy, cmap, color) != 0;
2239 if (rc == 0)
2241 /* If we got to this point, the colormap is full, so we're going
2242 to try to get the next closest color. The algorithm used is
2243 a least-squares matching, which is what X uses for closest
2244 color matching with StaticColor visuals. */
2245 int nearest, i;
2246 int max_color_delta = 255;
2247 int max_delta = 3 * max_color_delta;
2248 int nearest_delta = max_delta + 1;
2249 int ncells;
2250 const XColor *cells = x_color_cells (dpy, &ncells);
2252 for (nearest = i = 0; i < ncells; ++i)
2254 int dred = (color->red >> 8) - (cells[i].red >> 8);
2255 int dgreen = (color->green >> 8) - (cells[i].green >> 8);
2256 int dblue = (color->blue >> 8) - (cells[i].blue >> 8);
2257 int delta = dred * dred + dgreen * dgreen + dblue * dblue;
2259 if (delta < nearest_delta)
2261 nearest = i;
2262 nearest_delta = delta;
2266 color->red = cells[nearest].red;
2267 color->green = cells[nearest].green;
2268 color->blue = cells[nearest].blue;
2269 rc = XAllocColor (dpy, cmap, color) != 0;
2271 else
2273 /* If allocation succeeded, and the allocated pixel color is not
2274 equal to a cached pixel color recorded earlier, there was a
2275 change in the colormap, so clear the color cache. */
2276 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
2277 XColor *cached_color;
2279 if (dpyinfo->color_cells
2280 && (cached_color = &dpyinfo->color_cells[color->pixel],
2281 (cached_color->red != color->red
2282 || cached_color->blue != color->blue
2283 || cached_color->green != color->green)))
2285 xfree (dpyinfo->color_cells);
2286 dpyinfo->color_cells = NULL;
2287 dpyinfo->ncolor_cells = 0;
2291 #ifdef DEBUG_X_COLORS
2292 if (rc)
2293 register_color (color->pixel);
2294 #endif /* DEBUG_X_COLORS */
2296 return rc;
2300 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
2301 exact match can't be allocated, try the nearest color available.
2302 Value is true if successful. Set *COLOR to the color
2303 allocated. */
2305 bool
2306 x_alloc_nearest_color (struct frame *f, Colormap cmap, XColor *color)
2308 gamma_correct (f, color);
2309 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
2313 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
2314 It's necessary to do this instead of just using PIXEL directly to
2315 get color reference counts right. */
2317 unsigned long
2318 x_copy_color (struct frame *f, unsigned long pixel)
2320 XColor color;
2322 color.pixel = pixel;
2323 block_input ();
2324 x_query_color (f, &color);
2325 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
2326 unblock_input ();
2327 #ifdef DEBUG_X_COLORS
2328 register_color (pixel);
2329 #endif
2330 return color.pixel;
2334 /* Brightness beyond which a color won't have its highlight brightness
2335 boosted.
2337 Nominally, highlight colors for `3d' faces are calculated by
2338 brightening an object's color by a constant scale factor, but this
2339 doesn't yield good results for dark colors, so for colors who's
2340 brightness is less than this value (on a scale of 0-65535) have an
2341 use an additional additive factor.
2343 The value here is set so that the default menu-bar/mode-line color
2344 (grey75) will not have its highlights changed at all. */
2345 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
2348 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
2349 or DELTA. Try a color with RGB values multiplied by FACTOR first.
2350 If this produces the same color as PIXEL, try a color where all RGB
2351 values have DELTA added. Return the allocated color in *PIXEL.
2352 DISPLAY is the X display, CMAP is the colormap to operate on.
2353 Value is non-zero if successful. */
2355 static bool
2356 x_alloc_lighter_color (struct frame *f, Display *display, Colormap cmap,
2357 unsigned long *pixel, double factor, int delta)
2359 XColor color, new;
2360 long bright;
2361 bool success_p;
2363 /* Get RGB color values. */
2364 color.pixel = *pixel;
2365 x_query_color (f, &color);
2367 /* Change RGB values by specified FACTOR. Avoid overflow! */
2368 eassert (factor >= 0);
2369 new.red = min (0xffff, factor * color.red);
2370 new.green = min (0xffff, factor * color.green);
2371 new.blue = min (0xffff, factor * color.blue);
2373 /* Calculate brightness of COLOR. */
2374 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
2376 /* We only boost colors that are darker than
2377 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
2378 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
2379 /* Make an additive adjustment to NEW, because it's dark enough so
2380 that scaling by FACTOR alone isn't enough. */
2382 /* How far below the limit this color is (0 - 1, 1 being darker). */
2383 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
2384 /* The additive adjustment. */
2385 int min_delta = delta * dimness * factor / 2;
2387 if (factor < 1)
2389 new.red = max (0, new.red - min_delta);
2390 new.green = max (0, new.green - min_delta);
2391 new.blue = max (0, new.blue - min_delta);
2393 else
2395 new.red = min (0xffff, min_delta + new.red);
2396 new.green = min (0xffff, min_delta + new.green);
2397 new.blue = min (0xffff, min_delta + new.blue);
2401 /* Try to allocate the color. */
2402 success_p = x_alloc_nearest_color (f, cmap, &new);
2403 if (success_p)
2405 if (new.pixel == *pixel)
2407 /* If we end up with the same color as before, try adding
2408 delta to the RGB values. */
2409 x_free_colors (f, &new.pixel, 1);
2411 new.red = min (0xffff, delta + color.red);
2412 new.green = min (0xffff, delta + color.green);
2413 new.blue = min (0xffff, delta + color.blue);
2414 success_p = x_alloc_nearest_color (f, cmap, &new);
2416 else
2417 success_p = true;
2418 *pixel = new.pixel;
2421 return success_p;
2425 /* Set up the foreground color for drawing relief lines of glyph
2426 string S. RELIEF is a pointer to a struct relief containing the GC
2427 with which lines will be drawn. Use a color that is FACTOR or
2428 DELTA lighter or darker than the relief's background which is found
2429 in S->f->output_data.x->relief_background. If such a color cannot
2430 be allocated, use DEFAULT_PIXEL, instead. */
2432 static void
2433 x_setup_relief_color (struct frame *f, struct relief *relief, double factor,
2434 int delta, unsigned long default_pixel)
2436 XGCValues xgcv;
2437 struct x_output *di = f->output_data.x;
2438 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
2439 unsigned long pixel;
2440 unsigned long background = di->relief_background;
2441 Colormap cmap = FRAME_X_COLORMAP (f);
2442 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
2443 Display *dpy = FRAME_X_DISPLAY (f);
2445 xgcv.graphics_exposures = False;
2446 xgcv.line_width = 1;
2448 /* Free previously allocated color. The color cell will be reused
2449 when it has been freed as many times as it was allocated, so this
2450 doesn't affect faces using the same colors. */
2451 if (relief->gc && relief->pixel != -1)
2453 x_free_colors (f, &relief->pixel, 1);
2454 relief->pixel = -1;
2457 /* Allocate new color. */
2458 xgcv.foreground = default_pixel;
2459 pixel = background;
2460 if (dpyinfo->n_planes != 1
2461 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
2462 xgcv.foreground = relief->pixel = pixel;
2464 if (relief->gc == 0)
2466 xgcv.stipple = dpyinfo->gray;
2467 mask |= GCStipple;
2468 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
2470 else
2471 XChangeGC (dpy, relief->gc, mask, &xgcv);
2475 /* Set up colors for the relief lines around glyph string S. */
2477 static void
2478 x_setup_relief_colors (struct glyph_string *s)
2480 struct x_output *di = s->f->output_data.x;
2481 unsigned long color;
2483 if (s->face->use_box_color_for_shadows_p)
2484 color = s->face->box_color;
2485 else if (s->first_glyph->type == IMAGE_GLYPH
2486 && s->img->pixmap
2487 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2488 color = IMAGE_BACKGROUND (s->img, s->f, 0);
2489 else
2491 XGCValues xgcv;
2493 /* Get the background color of the face. */
2494 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
2495 color = xgcv.background;
2498 if (di->white_relief.gc == 0
2499 || color != di->relief_background)
2501 di->relief_background = color;
2502 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
2503 WHITE_PIX_DEFAULT (s->f));
2504 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
2505 BLACK_PIX_DEFAULT (s->f));
2510 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
2511 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
2512 to draw, it must be >= 0. RAISED_P means draw a raised
2513 relief. LEFT_P means draw a relief on the left side of
2514 the rectangle. RIGHT_P means draw a relief on the right
2515 side of the rectangle. CLIP_RECT is the clipping rectangle to use
2516 when drawing. */
2518 static void
2519 x_draw_relief_rect (struct frame *f,
2520 int left_x, int top_y, int right_x, int bottom_y,
2521 int width, bool raised_p, bool top_p, bool bot_p,
2522 bool left_p, bool right_p,
2523 XRectangle *clip_rect)
2525 #ifdef USE_CAIRO
2526 GC top_left_gc, bottom_right_gc;
2527 int corners = 0;
2529 if (raised_p)
2531 top_left_gc = f->output_data.x->white_relief.gc;
2532 bottom_right_gc = f->output_data.x->black_relief.gc;
2534 else
2536 top_left_gc = f->output_data.x->black_relief.gc;
2537 bottom_right_gc = f->output_data.x->white_relief.gc;
2540 x_set_clip_rectangles (f, top_left_gc, clip_rect, 1);
2541 x_set_clip_rectangles (f, bottom_right_gc, clip_rect, 1);
2543 if (left_p)
2545 x_fill_rectangle (f, top_left_gc, left_x, top_y,
2546 width, bottom_y + 1 - top_y);
2547 if (top_p)
2548 corners |= 1 << CORNER_TOP_LEFT;
2549 if (bot_p)
2550 corners |= 1 << CORNER_BOTTOM_LEFT;
2552 if (right_p)
2554 x_fill_rectangle (f, bottom_right_gc, right_x + 1 - width, top_y,
2555 width, bottom_y + 1 - top_y);
2556 if (top_p)
2557 corners |= 1 << CORNER_TOP_RIGHT;
2558 if (bot_p)
2559 corners |= 1 << CORNER_BOTTOM_RIGHT;
2561 if (top_p)
2563 if (!right_p)
2564 x_fill_rectangle (f, top_left_gc, left_x, top_y,
2565 right_x + 1 - left_x, width);
2566 else
2567 x_fill_trapezoid_for_relief (f, top_left_gc, left_x, top_y,
2568 right_x + 1 - left_x, width, 1);
2570 if (bot_p)
2572 if (!left_p)
2573 x_fill_rectangle (f, bottom_right_gc, left_x, bottom_y + 1 - width,
2574 right_x + 1 - left_x, width);
2575 else
2576 x_fill_trapezoid_for_relief (f, bottom_right_gc,
2577 left_x, bottom_y + 1 - width,
2578 right_x + 1 - left_x, width, 0);
2580 if (left_p && width != 1)
2581 x_fill_rectangle (f, bottom_right_gc, left_x, top_y,
2582 1, bottom_y + 1 - top_y);
2583 if (top_p && width != 1)
2584 x_fill_rectangle (f, bottom_right_gc, left_x, top_y,
2585 right_x + 1 - left_x, 1);
2586 if (corners)
2588 XSetBackground (FRAME_X_DISPLAY (f), top_left_gc,
2589 FRAME_BACKGROUND_PIXEL (f));
2590 x_erase_corners_for_relief (f, top_left_gc, left_x, top_y,
2591 right_x - left_x + 1, bottom_y - top_y + 1,
2592 6, 1, corners);
2595 x_reset_clip_rectangles (f, top_left_gc);
2596 x_reset_clip_rectangles (f, bottom_right_gc);
2597 #else
2598 Display *dpy = FRAME_X_DISPLAY (f);
2599 Window window = FRAME_X_WINDOW (f);
2600 int i;
2601 GC gc;
2603 if (raised_p)
2604 gc = f->output_data.x->white_relief.gc;
2605 else
2606 gc = f->output_data.x->black_relief.gc;
2607 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2609 /* This code is more complicated than it has to be, because of two
2610 minor hacks to make the boxes look nicer: (i) if width > 1, draw
2611 the outermost line using the black relief. (ii) Omit the four
2612 corner pixels. */
2614 /* Top. */
2615 if (top_p)
2617 if (width == 1)
2618 XDrawLine (dpy, window, gc,
2619 left_x + left_p, top_y,
2620 right_x + !right_p, top_y);
2622 for (i = 1; i < width; ++i)
2623 XDrawLine (dpy, window, gc,
2624 left_x + i * left_p, top_y + i,
2625 right_x + 1 - i * right_p, top_y + i);
2628 /* Left. */
2629 if (left_p)
2631 if (width == 1)
2632 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2634 XClearArea (dpy, window, left_x, top_y, 1, 1, False);
2635 XClearArea (dpy, window, left_x, bottom_y, 1, 1, False);
2637 for (i = (width > 1 ? 1 : 0); i < width; ++i)
2638 XDrawLine (dpy, window, gc,
2639 left_x + i, top_y + (i + 1) * top_p,
2640 left_x + i, bottom_y + 1 - (i + 1) * bot_p);
2643 XSetClipMask (dpy, gc, None);
2644 if (raised_p)
2645 gc = f->output_data.x->black_relief.gc;
2646 else
2647 gc = f->output_data.x->white_relief.gc;
2648 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2650 if (width > 1)
2652 /* Outermost top line. */
2653 if (top_p)
2654 XDrawLine (dpy, window, gc,
2655 left_x + left_p, top_y,
2656 right_x + !right_p, top_y);
2658 /* Outermost left line. */
2659 if (left_p)
2660 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2663 /* Bottom. */
2664 if (bot_p)
2666 XDrawLine (dpy, window, gc,
2667 left_x + left_p, bottom_y,
2668 right_x + !right_p, bottom_y);
2669 for (i = 1; i < width; ++i)
2670 XDrawLine (dpy, window, gc,
2671 left_x + i * left_p, bottom_y - i,
2672 right_x + 1 - i * right_p, bottom_y - i);
2675 /* Right. */
2676 if (right_p)
2678 XClearArea (dpy, window, right_x, top_y, 1, 1, False);
2679 XClearArea (dpy, window, right_x, bottom_y, 1, 1, False);
2680 for (i = 0; i < width; ++i)
2681 XDrawLine (dpy, window, gc,
2682 right_x - i, top_y + (i + 1) * top_p,
2683 right_x - i, bottom_y + 1 - (i + 1) * bot_p);
2686 x_reset_clip_rectangles (f, gc);
2688 #endif
2692 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2693 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2694 draw, it must be >= 0. LEFT_P means draw a line on the
2695 left side of the rectangle. RIGHT_P means draw a line
2696 on the right side of the rectangle. CLIP_RECT is the clipping
2697 rectangle to use when drawing. */
2699 static void
2700 x_draw_box_rect (struct glyph_string *s,
2701 int left_x, int top_y, int right_x, int bottom_y, int width,
2702 bool left_p, bool right_p, XRectangle *clip_rect)
2704 XGCValues xgcv;
2706 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2707 XSetForeground (s->display, s->gc, s->face->box_color);
2708 x_set_clip_rectangles (s->f, s->gc, clip_rect, 1);
2710 /* Top. */
2711 x_fill_rectangle (s->f, s->gc,
2712 left_x, top_y, right_x - left_x + 1, width);
2714 /* Left. */
2715 if (left_p)
2716 x_fill_rectangle (s->f, s->gc,
2717 left_x, top_y, width, bottom_y - top_y + 1);
2719 /* Bottom. */
2720 x_fill_rectangle (s->f, s->gc,
2721 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2723 /* Right. */
2724 if (right_p)
2725 x_fill_rectangle (s->f, s->gc,
2726 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2728 XSetForeground (s->display, s->gc, xgcv.foreground);
2729 x_reset_clip_rectangles (s->f, s->gc);
2733 /* Draw a box around glyph string S. */
2735 static void
2736 x_draw_glyph_string_box (struct glyph_string *s)
2738 int width, left_x, right_x, top_y, bottom_y, last_x;
2739 bool raised_p, left_p, right_p;
2740 struct glyph *last_glyph;
2741 XRectangle clip_rect;
2743 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2744 ? WINDOW_RIGHT_EDGE_X (s->w)
2745 : window_box_right (s->w, s->area));
2747 /* The glyph that may have a right box line. */
2748 last_glyph = (s->cmp || s->img
2749 ? s->first_glyph
2750 : s->first_glyph + s->nchars - 1);
2752 width = eabs (s->face->box_line_width);
2753 raised_p = s->face->box == FACE_RAISED_BOX;
2754 left_x = s->x;
2755 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2756 ? last_x - 1
2757 : min (last_x, s->x + s->background_width) - 1);
2758 top_y = s->y;
2759 bottom_y = top_y + s->height - 1;
2761 left_p = (s->first_glyph->left_box_line_p
2762 || (s->hl == DRAW_MOUSE_FACE
2763 && (s->prev == NULL
2764 || s->prev->hl != s->hl)));
2765 right_p = (last_glyph->right_box_line_p
2766 || (s->hl == DRAW_MOUSE_FACE
2767 && (s->next == NULL
2768 || s->next->hl != s->hl)));
2770 get_glyph_string_clip_rect (s, &clip_rect);
2772 if (s->face->box == FACE_SIMPLE_BOX)
2773 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2774 left_p, right_p, &clip_rect);
2775 else
2777 x_setup_relief_colors (s);
2778 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2779 width, raised_p, true, true, left_p, right_p,
2780 &clip_rect);
2785 /* Draw foreground of image glyph string S. */
2787 static void
2788 x_draw_image_foreground (struct glyph_string *s)
2790 int x = s->x;
2791 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2793 /* If first glyph of S has a left box line, start drawing it to the
2794 right of that line. */
2795 if (s->face->box != FACE_NO_BOX
2796 && s->first_glyph->left_box_line_p
2797 && s->slice.x == 0)
2798 x += eabs (s->face->box_line_width);
2800 /* If there is a margin around the image, adjust x- and y-position
2801 by that margin. */
2802 if (s->slice.x == 0)
2803 x += s->img->hmargin;
2804 if (s->slice.y == 0)
2805 y += s->img->vmargin;
2807 if (s->img->pixmap)
2809 if (s->img->mask)
2811 /* We can't set both a clip mask and use XSetClipRectangles
2812 because the latter also sets a clip mask. We also can't
2813 trust on the shape extension to be available
2814 (XShapeCombineRegion). So, compute the rectangle to draw
2815 manually. */
2816 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2817 | GCFunction);
2818 XGCValues xgcv;
2819 XRectangle clip_rect, image_rect, r;
2821 xgcv.clip_mask = s->img->mask;
2822 xgcv.clip_x_origin = x;
2823 xgcv.clip_y_origin = y;
2824 xgcv.function = GXcopy;
2825 XChangeGC (s->display, s->gc, mask, &xgcv);
2827 get_glyph_string_clip_rect (s, &clip_rect);
2828 image_rect.x = x;
2829 image_rect.y = y;
2830 image_rect.width = s->slice.width;
2831 image_rect.height = s->slice.height;
2832 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2833 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2834 s->slice.x + r.x - x, s->slice.y + r.y - y,
2835 r.width, r.height, r.x, r.y);
2837 else
2839 XRectangle clip_rect, image_rect, r;
2841 get_glyph_string_clip_rect (s, &clip_rect);
2842 image_rect.x = x;
2843 image_rect.y = y;
2844 image_rect.width = s->slice.width;
2845 image_rect.height = s->slice.height;
2846 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2847 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2848 s->slice.x + r.x - x, s->slice.y + r.y - y,
2849 r.width, r.height, r.x, r.y);
2851 /* When the image has a mask, we can expect that at
2852 least part of a mouse highlight or a block cursor will
2853 be visible. If the image doesn't have a mask, make
2854 a block cursor visible by drawing a rectangle around
2855 the image. I believe it's looking better if we do
2856 nothing here for mouse-face. */
2857 if (s->hl == DRAW_CURSOR)
2859 int relief = eabs (s->img->relief);
2860 x_draw_rectangle (s->f, s->gc,
2861 x - relief, y - relief,
2862 s->slice.width + relief*2 - 1,
2863 s->slice.height + relief*2 - 1);
2867 else
2868 /* Draw a rectangle if image could not be loaded. */
2869 x_draw_rectangle (s->f, s->gc, x, y,
2870 s->slice.width - 1, s->slice.height - 1);
2874 /* Draw a relief around the image glyph string S. */
2876 static void
2877 x_draw_image_relief (struct glyph_string *s)
2879 int x1, y1, thick;
2880 bool raised_p, top_p, bot_p, left_p, right_p;
2881 int extra_x, extra_y;
2882 XRectangle r;
2883 int x = s->x;
2884 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2886 /* If first glyph of S has a left box line, start drawing it to the
2887 right of that line. */
2888 if (s->face->box != FACE_NO_BOX
2889 && s->first_glyph->left_box_line_p
2890 && s->slice.x == 0)
2891 x += eabs (s->face->box_line_width);
2893 /* If there is a margin around the image, adjust x- and y-position
2894 by that margin. */
2895 if (s->slice.x == 0)
2896 x += s->img->hmargin;
2897 if (s->slice.y == 0)
2898 y += s->img->vmargin;
2900 if (s->hl == DRAW_IMAGE_SUNKEN
2901 || s->hl == DRAW_IMAGE_RAISED)
2903 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2904 raised_p = s->hl == DRAW_IMAGE_RAISED;
2906 else
2908 thick = eabs (s->img->relief);
2909 raised_p = s->img->relief > 0;
2912 x1 = x + s->slice.width - 1;
2913 y1 = y + s->slice.height - 1;
2915 extra_x = extra_y = 0;
2916 if (s->face->id == TOOL_BAR_FACE_ID)
2918 if (CONSP (Vtool_bar_button_margin)
2919 && INTEGERP (XCAR (Vtool_bar_button_margin))
2920 && INTEGERP (XCDR (Vtool_bar_button_margin)))
2922 extra_x = XINT (XCAR (Vtool_bar_button_margin));
2923 extra_y = XINT (XCDR (Vtool_bar_button_margin));
2925 else if (INTEGERP (Vtool_bar_button_margin))
2926 extra_x = extra_y = XINT (Vtool_bar_button_margin);
2929 top_p = bot_p = left_p = right_p = false;
2931 if (s->slice.x == 0)
2932 x -= thick + extra_x, left_p = true;
2933 if (s->slice.y == 0)
2934 y -= thick + extra_y, top_p = true;
2935 if (s->slice.x + s->slice.width == s->img->width)
2936 x1 += thick + extra_x, right_p = true;
2937 if (s->slice.y + s->slice.height == s->img->height)
2938 y1 += thick + extra_y, bot_p = true;
2940 x_setup_relief_colors (s);
2941 get_glyph_string_clip_rect (s, &r);
2942 x_draw_relief_rect (s->f, x, y, x1, y1, thick, raised_p,
2943 top_p, bot_p, left_p, right_p, &r);
2947 /* Draw the foreground of image glyph string S to PIXMAP. */
2949 static void
2950 x_draw_image_foreground_1 (struct glyph_string *s, Pixmap pixmap)
2952 int x = 0;
2953 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2955 /* If first glyph of S has a left box line, start drawing it to the
2956 right of that line. */
2957 if (s->face->box != FACE_NO_BOX
2958 && s->first_glyph->left_box_line_p
2959 && s->slice.x == 0)
2960 x += eabs (s->face->box_line_width);
2962 /* If there is a margin around the image, adjust x- and y-position
2963 by that margin. */
2964 if (s->slice.x == 0)
2965 x += s->img->hmargin;
2966 if (s->slice.y == 0)
2967 y += s->img->vmargin;
2969 if (s->img->pixmap)
2971 if (s->img->mask)
2973 /* We can't set both a clip mask and use XSetClipRectangles
2974 because the latter also sets a clip mask. We also can't
2975 trust on the shape extension to be available
2976 (XShapeCombineRegion). So, compute the rectangle to draw
2977 manually. */
2978 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2979 | GCFunction);
2980 XGCValues xgcv;
2982 xgcv.clip_mask = s->img->mask;
2983 xgcv.clip_x_origin = x - s->slice.x;
2984 xgcv.clip_y_origin = y - s->slice.y;
2985 xgcv.function = GXcopy;
2986 XChangeGC (s->display, s->gc, mask, &xgcv);
2988 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2989 s->slice.x, s->slice.y,
2990 s->slice.width, s->slice.height, x, y);
2991 XSetClipMask (s->display, s->gc, None);
2993 else
2995 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
2996 s->slice.x, s->slice.y,
2997 s->slice.width, s->slice.height, x, y);
2999 /* When the image has a mask, we can expect that at
3000 least part of a mouse highlight or a block cursor will
3001 be visible. If the image doesn't have a mask, make
3002 a block cursor visible by drawing a rectangle around
3003 the image. I believe it's looking better if we do
3004 nothing here for mouse-face. */
3005 if (s->hl == DRAW_CURSOR)
3007 int r = eabs (s->img->relief);
3008 x_draw_rectangle (s->f, s->gc, x - r, y - r,
3009 s->slice.width + r*2 - 1,
3010 s->slice.height + r*2 - 1);
3014 else
3015 /* Draw a rectangle if image could not be loaded. */
3016 x_draw_rectangle (s->f, s->gc, x, y,
3017 s->slice.width - 1, s->slice.height - 1);
3021 /* Draw part of the background of glyph string S. X, Y, W, and H
3022 give the rectangle to draw. */
3024 static void
3025 x_draw_glyph_string_bg_rect (struct glyph_string *s, int x, int y, int w, int h)
3027 if (s->stippled_p)
3029 /* Fill background with a stipple pattern. */
3030 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
3031 x_fill_rectangle (s->f, s->gc, x, y, w, h);
3032 XSetFillStyle (s->display, s->gc, FillSolid);
3034 else
3035 x_clear_glyph_string_rect (s, x, y, w, h);
3039 /* Draw image glyph string S.
3041 s->y
3042 s->x +-------------------------
3043 | s->face->box
3045 | +-------------------------
3046 | | s->img->margin
3048 | | +-------------------
3049 | | | the image
3053 static void
3054 x_draw_image_glyph_string (struct glyph_string *s)
3056 int box_line_hwidth = eabs (s->face->box_line_width);
3057 int box_line_vwidth = max (s->face->box_line_width, 0);
3058 int height;
3059 Pixmap pixmap = None;
3061 height = s->height;
3062 if (s->slice.y == 0)
3063 height -= box_line_vwidth;
3064 if (s->slice.y + s->slice.height >= s->img->height)
3065 height -= box_line_vwidth;
3067 /* Fill background with face under the image. Do it only if row is
3068 taller than image or if image has a clip mask to reduce
3069 flickering. */
3070 s->stippled_p = s->face->stipple != 0;
3071 if (height > s->slice.height
3072 || s->img->hmargin
3073 || s->img->vmargin
3074 || s->img->mask
3075 || s->img->pixmap == 0
3076 || s->width != s->background_width)
3078 if (s->img->mask)
3080 /* Create a pixmap as large as the glyph string. Fill it
3081 with the background color. Copy the image to it, using
3082 its mask. Copy the temporary pixmap to the display. */
3083 Screen *screen = FRAME_X_SCREEN (s->f);
3084 int depth = DefaultDepthOfScreen (screen);
3086 /* Create a pixmap as large as the glyph string. */
3087 pixmap = XCreatePixmap (s->display, s->window,
3088 s->background_width,
3089 s->height, depth);
3091 /* Don't clip in the following because we're working on the
3092 pixmap. */
3093 XSetClipMask (s->display, s->gc, None);
3095 /* Fill the pixmap with the background color/stipple. */
3096 if (s->stippled_p)
3098 /* Fill background with a stipple pattern. */
3099 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
3100 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
3101 XFillRectangle (s->display, pixmap, s->gc,
3102 0, 0, s->background_width, s->height);
3103 XSetFillStyle (s->display, s->gc, FillSolid);
3104 XSetTSOrigin (s->display, s->gc, 0, 0);
3106 else
3108 XGCValues xgcv;
3109 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
3110 &xgcv);
3111 XSetForeground (s->display, s->gc, xgcv.background);
3112 XFillRectangle (s->display, pixmap, s->gc,
3113 0, 0, s->background_width, s->height);
3114 XSetForeground (s->display, s->gc, xgcv.foreground);
3117 else
3119 int x = s->x;
3120 int y = s->y;
3121 int width = s->background_width;
3123 if (s->first_glyph->left_box_line_p
3124 && s->slice.x == 0)
3126 x += box_line_hwidth;
3127 width -= box_line_hwidth;
3130 if (s->slice.y == 0)
3131 y += box_line_vwidth;
3133 x_draw_glyph_string_bg_rect (s, x, y, width, height);
3136 s->background_filled_p = true;
3139 /* Draw the foreground. */
3140 #ifdef USE_CAIRO
3141 if (s->img->cr_data)
3143 cairo_t *cr = x_begin_cr_clip (s->f, s->gc);
3145 int x = s->x + s->img->hmargin;
3146 int y = s->y + s->img->vmargin;
3147 int width = s->background_width;
3149 cairo_set_source_surface (cr, s->img->cr_data,
3150 x - s->slice.x,
3151 y - s->slice.y);
3152 cairo_rectangle (cr, x, y, width, height);
3153 cairo_fill (cr);
3154 x_end_cr_clip (s->f);
3156 else
3157 #endif
3158 if (pixmap != None)
3160 x_draw_image_foreground_1 (s, pixmap);
3161 x_set_glyph_string_clipping (s);
3162 XCopyArea (s->display, pixmap, s->window, s->gc,
3163 0, 0, s->background_width, s->height, s->x, s->y);
3164 XFreePixmap (s->display, pixmap);
3166 else
3167 x_draw_image_foreground (s);
3169 /* If we must draw a relief around the image, do it. */
3170 if (s->img->relief
3171 || s->hl == DRAW_IMAGE_RAISED
3172 || s->hl == DRAW_IMAGE_SUNKEN)
3173 x_draw_image_relief (s);
3177 /* Draw stretch glyph string S. */
3179 static void
3180 x_draw_stretch_glyph_string (struct glyph_string *s)
3182 eassert (s->first_glyph->type == STRETCH_GLYPH);
3184 if (s->hl == DRAW_CURSOR
3185 && !x_stretch_cursor_p)
3187 /* If `x-stretch-cursor' is nil, don't draw a block cursor as
3188 wide as the stretch glyph. */
3189 int width, background_width = s->background_width;
3190 int x = s->x;
3192 if (!s->row->reversed_p)
3194 int left_x = window_box_left_offset (s->w, TEXT_AREA);
3196 if (x < left_x)
3198 background_width -= left_x - x;
3199 x = left_x;
3202 else
3204 /* In R2L rows, draw the cursor on the right edge of the
3205 stretch glyph. */
3206 int right_x = window_box_right (s->w, TEXT_AREA);
3208 if (x + background_width > right_x)
3209 background_width -= x - right_x;
3210 x += background_width;
3212 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
3213 if (s->row->reversed_p)
3214 x -= width;
3216 /* Draw cursor. */
3217 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
3219 /* Clear rest using the GC of the original non-cursor face. */
3220 if (width < background_width)
3222 int y = s->y;
3223 int w = background_width - width, h = s->height;
3224 XRectangle r;
3225 GC gc;
3227 if (!s->row->reversed_p)
3228 x += width;
3229 else
3230 x = s->x;
3231 if (s->row->mouse_face_p
3232 && cursor_in_mouse_face_p (s->w))
3234 x_set_mouse_face_gc (s);
3235 gc = s->gc;
3237 else
3238 gc = s->face->gc;
3240 get_glyph_string_clip_rect (s, &r);
3241 x_set_clip_rectangles (s->f, gc, &r, 1);
3243 if (s->face->stipple)
3245 /* Fill background with a stipple pattern. */
3246 XSetFillStyle (s->display, gc, FillOpaqueStippled);
3247 x_fill_rectangle (s->f, gc, x, y, w, h);
3248 XSetFillStyle (s->display, gc, FillSolid);
3250 else
3252 XGCValues xgcv;
3253 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
3254 XSetForeground (s->display, gc, xgcv.background);
3255 x_fill_rectangle (s->f, gc, x, y, w, h);
3256 XSetForeground (s->display, gc, xgcv.foreground);
3259 x_reset_clip_rectangles (s->f, gc);
3262 else if (!s->background_filled_p)
3264 int background_width = s->background_width;
3265 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
3267 /* Don't draw into left margin, fringe or scrollbar area
3268 except for header line and mode line. */
3269 if (x < left_x && !s->row->mode_line_p)
3271 background_width -= left_x - x;
3272 x = left_x;
3274 if (background_width > 0)
3275 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
3278 s->background_filled_p = true;
3282 Draw a wavy line under S. The wave fills wave_height pixels from y0.
3284 x0 wave_length = 2
3286 y0 * * * * *
3287 |* * * * * * * * *
3288 wave_height = 3 | * * * *
3292 static void
3293 x_draw_underwave (struct glyph_string *s)
3295 int wave_height = 3, wave_length = 2;
3296 #ifdef USE_CAIRO
3297 x_draw_horizontal_wave (s->f, s->gc, s->x, s->ybase - wave_height + 3,
3298 s->width, wave_height, wave_length);
3299 #else /* not USE_CAIRO */
3300 int dx, dy, x0, y0, width, x1, y1, x2, y2, xmax;
3301 bool odd;
3302 XRectangle wave_clip, string_clip, final_clip;
3304 dx = wave_length;
3305 dy = wave_height - 1;
3306 x0 = s->x;
3307 y0 = s->ybase - wave_height + 3;
3308 width = s->width;
3309 xmax = x0 + width;
3311 /* Find and set clipping rectangle */
3313 wave_clip.x = x0;
3314 wave_clip.y = y0;
3315 wave_clip.width = width;
3316 wave_clip.height = wave_height;
3317 get_glyph_string_clip_rect (s, &string_clip);
3319 if (!x_intersect_rectangles (&wave_clip, &string_clip, &final_clip))
3320 return;
3322 XSetClipRectangles (s->display, s->gc, 0, 0, &final_clip, 1, Unsorted);
3324 /* Draw the waves */
3326 x1 = x0 - (x0 % dx);
3327 x2 = x1 + dx;
3328 odd = (x1 / dx) & 1;
3329 y1 = y2 = y0;
3331 if (odd)
3332 y1 += dy;
3333 else
3334 y2 += dy;
3336 if (INT_MAX - dx < xmax)
3337 emacs_abort ();
3339 while (x1 <= xmax)
3341 XDrawLine (s->display, s->window, s->gc, x1, y1, x2, y2);
3342 x1 = x2, y1 = y2;
3343 x2 += dx, y2 = y0 + odd*dy;
3344 odd = !odd;
3347 /* Restore previous clipping rectangle(s) */
3348 XSetClipRectangles (s->display, s->gc, 0, 0, s->clip, s->num_clips, Unsorted);
3349 #endif /* not USE_CAIRO */
3353 /* Draw glyph string S. */
3355 static void
3356 x_draw_glyph_string (struct glyph_string *s)
3358 bool relief_drawn_p = false;
3360 /* If S draws into the background of its successors, draw the
3361 background of the successors first so that S can draw into it.
3362 This makes S->next use XDrawString instead of XDrawImageString. */
3363 if (s->next && s->right_overhang && !s->for_overlaps)
3365 int width;
3366 struct glyph_string *next;
3368 for (width = 0, next = s->next;
3369 next && width < s->right_overhang;
3370 width += next->width, next = next->next)
3371 if (next->first_glyph->type != IMAGE_GLYPH)
3373 x_set_glyph_string_gc (next);
3374 x_set_glyph_string_clipping (next);
3375 if (next->first_glyph->type == STRETCH_GLYPH)
3376 x_draw_stretch_glyph_string (next);
3377 else
3378 x_draw_glyph_string_background (next, true);
3379 next->num_clips = 0;
3383 /* Set up S->gc, set clipping and draw S. */
3384 x_set_glyph_string_gc (s);
3386 /* Draw relief (if any) in advance for char/composition so that the
3387 glyph string can be drawn over it. */
3388 if (!s->for_overlaps
3389 && s->face->box != FACE_NO_BOX
3390 && (s->first_glyph->type == CHAR_GLYPH
3391 || s->first_glyph->type == COMPOSITE_GLYPH))
3394 x_set_glyph_string_clipping (s);
3395 x_draw_glyph_string_background (s, true);
3396 x_draw_glyph_string_box (s);
3397 x_set_glyph_string_clipping (s);
3398 relief_drawn_p = true;
3400 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
3401 && !s->clip_tail
3402 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
3403 || (s->next && s->next->hl != s->hl && s->right_overhang)))
3404 /* We must clip just this glyph. left_overhang part has already
3405 drawn when s->prev was drawn, and right_overhang part will be
3406 drawn later when s->next is drawn. */
3407 x_set_glyph_string_clipping_exactly (s, s);
3408 else
3409 x_set_glyph_string_clipping (s);
3411 switch (s->first_glyph->type)
3413 case IMAGE_GLYPH:
3414 x_draw_image_glyph_string (s);
3415 break;
3417 case STRETCH_GLYPH:
3418 x_draw_stretch_glyph_string (s);
3419 break;
3421 case CHAR_GLYPH:
3422 if (s->for_overlaps)
3423 s->background_filled_p = true;
3424 else
3425 x_draw_glyph_string_background (s, false);
3426 x_draw_glyph_string_foreground (s);
3427 break;
3429 case COMPOSITE_GLYPH:
3430 if (s->for_overlaps || (s->cmp_from > 0
3431 && ! s->first_glyph->u.cmp.automatic))
3432 s->background_filled_p = true;
3433 else
3434 x_draw_glyph_string_background (s, true);
3435 x_draw_composite_glyph_string_foreground (s);
3436 break;
3438 case GLYPHLESS_GLYPH:
3439 if (s->for_overlaps)
3440 s->background_filled_p = true;
3441 else
3442 x_draw_glyph_string_background (s, true);
3443 x_draw_glyphless_glyph_string_foreground (s);
3444 break;
3446 default:
3447 emacs_abort ();
3450 if (!s->for_overlaps)
3452 /* Draw underline. */
3453 if (s->face->underline_p)
3455 if (s->face->underline_type == FACE_UNDER_WAVE)
3457 if (s->face->underline_defaulted_p)
3458 x_draw_underwave (s);
3459 else
3461 XGCValues xgcv;
3462 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
3463 XSetForeground (s->display, s->gc, s->face->underline_color);
3464 x_draw_underwave (s);
3465 XSetForeground (s->display, s->gc, xgcv.foreground);
3468 else if (s->face->underline_type == FACE_UNDER_LINE)
3470 unsigned long thickness, position;
3471 int y;
3473 if (s->prev && s->prev->face->underline_p
3474 && s->prev->face->underline_type == FACE_UNDER_LINE)
3476 /* We use the same underline style as the previous one. */
3477 thickness = s->prev->underline_thickness;
3478 position = s->prev->underline_position;
3480 else
3482 /* Get the underline thickness. Default is 1 pixel. */
3483 if (s->font && s->font->underline_thickness > 0)
3484 thickness = s->font->underline_thickness;
3485 else
3486 thickness = 1;
3487 if (x_underline_at_descent_line)
3488 position = (s->height - thickness) - (s->ybase - s->y);
3489 else
3491 /* Get the underline position. This is the recommended
3492 vertical offset in pixels from the baseline to the top of
3493 the underline. This is a signed value according to the
3494 specs, and its default is
3496 ROUND ((maximum descent) / 2), with
3497 ROUND(x) = floor (x + 0.5) */
3499 if (x_use_underline_position_properties
3500 && s->font && s->font->underline_position >= 0)
3501 position = s->font->underline_position;
3502 else if (s->font)
3503 position = (s->font->descent + 1) / 2;
3504 else
3505 position = underline_minimum_offset;
3507 position = max (position, underline_minimum_offset);
3509 /* Check the sanity of thickness and position. We should
3510 avoid drawing underline out of the current line area. */
3511 if (s->y + s->height <= s->ybase + position)
3512 position = (s->height - 1) - (s->ybase - s->y);
3513 if (s->y + s->height < s->ybase + position + thickness)
3514 thickness = (s->y + s->height) - (s->ybase + position);
3515 s->underline_thickness = thickness;
3516 s->underline_position = position;
3517 y = s->ybase + position;
3518 if (s->face->underline_defaulted_p)
3519 x_fill_rectangle (s->f, s->gc,
3520 s->x, y, s->width, thickness);
3521 else
3523 XGCValues xgcv;
3524 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
3525 XSetForeground (s->display, s->gc, s->face->underline_color);
3526 x_fill_rectangle (s->f, s->gc,
3527 s->x, y, s->width, thickness);
3528 XSetForeground (s->display, s->gc, xgcv.foreground);
3532 /* Draw overline. */
3533 if (s->face->overline_p)
3535 unsigned long dy = 0, h = 1;
3537 if (s->face->overline_color_defaulted_p)
3538 x_fill_rectangle (s->f, s->gc, s->x, s->y + dy,
3539 s->width, h);
3540 else
3542 XGCValues xgcv;
3543 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
3544 XSetForeground (s->display, s->gc, s->face->overline_color);
3545 x_fill_rectangle (s->f, s->gc, s->x, s->y + dy,
3546 s->width, h);
3547 XSetForeground (s->display, s->gc, xgcv.foreground);
3551 /* Draw strike-through. */
3552 if (s->face->strike_through_p)
3554 unsigned long h = 1;
3555 unsigned long dy = (s->height - h) / 2;
3557 if (s->face->strike_through_color_defaulted_p)
3558 x_fill_rectangle (s->f, s->gc, s->x, s->y + dy,
3559 s->width, h);
3560 else
3562 XGCValues xgcv;
3563 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
3564 XSetForeground (s->display, s->gc, s->face->strike_through_color);
3565 x_fill_rectangle (s->f, s->gc, s->x, s->y + dy,
3566 s->width, h);
3567 XSetForeground (s->display, s->gc, xgcv.foreground);
3571 /* Draw relief if not yet drawn. */
3572 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
3573 x_draw_glyph_string_box (s);
3575 if (s->prev)
3577 struct glyph_string *prev;
3579 for (prev = s->prev; prev; prev = prev->prev)
3580 if (prev->hl != s->hl
3581 && prev->x + prev->width + prev->right_overhang > s->x)
3583 /* As prev was drawn while clipped to its own area, we
3584 must draw the right_overhang part using s->hl now. */
3585 enum draw_glyphs_face save = prev->hl;
3587 prev->hl = s->hl;
3588 x_set_glyph_string_gc (prev);
3589 x_set_glyph_string_clipping_exactly (s, prev);
3590 if (prev->first_glyph->type == CHAR_GLYPH)
3591 x_draw_glyph_string_foreground (prev);
3592 else
3593 x_draw_composite_glyph_string_foreground (prev);
3594 x_reset_clip_rectangles (prev->f, prev->gc);
3595 prev->hl = save;
3596 prev->num_clips = 0;
3600 if (s->next)
3602 struct glyph_string *next;
3604 for (next = s->next; next; next = next->next)
3605 if (next->hl != s->hl
3606 && next->x - next->left_overhang < s->x + s->width)
3608 /* As next will be drawn while clipped to its own area,
3609 we must draw the left_overhang part using s->hl now. */
3610 enum draw_glyphs_face save = next->hl;
3612 next->hl = s->hl;
3613 x_set_glyph_string_gc (next);
3614 x_set_glyph_string_clipping_exactly (s, next);
3615 if (next->first_glyph->type == CHAR_GLYPH)
3616 x_draw_glyph_string_foreground (next);
3617 else
3618 x_draw_composite_glyph_string_foreground (next);
3619 x_reset_clip_rectangles (next->f, next->gc);
3620 next->hl = save;
3621 next->num_clips = 0;
3622 next->clip_head = s->next;
3627 /* Reset clipping. */
3628 x_reset_clip_rectangles (s->f, s->gc);
3629 s->num_clips = 0;
3632 /* Shift display to make room for inserted glyphs. */
3634 static void
3635 x_shift_glyphs_for_insert (struct frame *f, int x, int y, int width, int height, int shift_by)
3637 /* Never called on a GUI frame, see
3638 http://lists.gnu.org/archive/html/emacs-devel/2015-05/msg00456.html
3640 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3641 f->output_data.x->normal_gc,
3642 x, y, width, height,
3643 x + shift_by, y);
3646 /* Delete N glyphs at the nominal cursor position. Not implemented
3647 for X frames. */
3649 static void
3650 x_delete_glyphs (struct frame *f, register int n)
3652 emacs_abort ();
3656 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
3657 If they are <= 0, this is probably an error. */
3659 static void
3660 x_clear_area1 (Display *dpy, Window window,
3661 int x, int y, int width, int height, int exposures)
3663 eassert (width > 0 && height > 0);
3664 XClearArea (dpy, window, x, y, width, height, exposures);
3668 void
3669 x_clear_area (struct frame *f, int x, int y, int width, int height)
3671 #ifdef USE_CAIRO
3672 cairo_t *cr;
3674 eassert (width > 0 && height > 0);
3676 cr = x_begin_cr_clip (f, NULL);
3677 x_set_cr_source_with_gc_background (f, f->output_data.x->normal_gc);
3678 cairo_rectangle (cr, x, y, width, height);
3679 cairo_fill (cr);
3680 x_end_cr_clip (f);
3681 #else
3682 x_clear_area1 (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3683 x, y, width, height, False);
3684 #endif
3688 /* Clear an entire frame. */
3690 static void
3691 x_clear_frame (struct frame *f)
3693 /* Clearing the frame will erase any cursor, so mark them all as no
3694 longer visible. */
3695 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
3697 block_input ();
3699 x_clear_window (f);
3701 /* We have to clear the scroll bars. If we have changed colors or
3702 something like that, then they should be notified. */
3703 x_scroll_bar_clear (f);
3705 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3706 /* Make sure scroll bars are redrawn. As they aren't redrawn by
3707 redisplay, do it here. */
3708 if (FRAME_GTK_WIDGET (f))
3709 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
3710 #endif
3712 XFlush (FRAME_X_DISPLAY (f));
3714 unblock_input ();
3717 /* RIF: Show hourglass cursor on frame F. */
3719 static void
3720 x_show_hourglass (struct frame *f)
3722 Display *dpy = FRAME_X_DISPLAY (f);
3724 if (dpy)
3726 struct x_output *x = FRAME_X_OUTPUT (f);
3727 #ifdef USE_X_TOOLKIT
3728 if (x->widget)
3729 #else
3730 if (FRAME_OUTER_WINDOW (f))
3731 #endif
3733 x->hourglass_p = true;
3735 if (!x->hourglass_window)
3737 unsigned long mask = CWCursor;
3738 XSetWindowAttributes attrs;
3739 #ifdef USE_GTK
3740 Window parent = FRAME_X_WINDOW (f);
3741 #else
3742 Window parent = FRAME_OUTER_WINDOW (f);
3743 #endif
3744 attrs.cursor = x->hourglass_cursor;
3746 x->hourglass_window = XCreateWindow
3747 (dpy, parent, 0, 0, 32000, 32000, 0, 0,
3748 InputOnly, CopyFromParent, mask, &attrs);
3751 XMapRaised (dpy, x->hourglass_window);
3752 XFlush (dpy);
3757 /* RIF: Cancel hourglass cursor on frame F. */
3759 static void
3760 x_hide_hourglass (struct frame *f)
3762 struct x_output *x = FRAME_X_OUTPUT (f);
3764 /* Watch out for newly created frames. */
3765 if (x->hourglass_window)
3767 XUnmapWindow (FRAME_X_DISPLAY (f), x->hourglass_window);
3768 /* Sync here because XTread_socket looks at the
3769 hourglass_p flag that is reset to zero below. */
3770 XSync (FRAME_X_DISPLAY (f), False);
3771 x->hourglass_p = false;
3775 /* Invert the middle quarter of the frame for .15 sec. */
3777 static void
3778 XTflash (struct frame *f)
3780 block_input ();
3783 #ifdef USE_GTK
3784 /* Use Gdk routines to draw. This way, we won't draw over scroll bars
3785 when the scroll bars and the edit widget share the same X window. */
3786 GdkWindow *window = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
3787 #ifdef HAVE_GTK3
3788 cairo_t *cr = gdk_cairo_create (window);
3789 cairo_set_source_rgb (cr, 1, 1, 1);
3790 cairo_set_operator (cr, CAIRO_OPERATOR_DIFFERENCE);
3791 #define XFillRectangle(d, win, gc, x, y, w, h) \
3792 do { \
3793 cairo_rectangle (cr, x, y, w, h); \
3794 cairo_fill (cr); \
3796 while (false)
3797 #else /* ! HAVE_GTK3 */
3798 GdkGCValues vals;
3799 GdkGC *gc;
3800 vals.foreground.pixel = (FRAME_FOREGROUND_PIXEL (f)
3801 ^ FRAME_BACKGROUND_PIXEL (f));
3802 vals.function = GDK_XOR;
3803 gc = gdk_gc_new_with_values (window,
3804 &vals, GDK_GC_FUNCTION | GDK_GC_FOREGROUND);
3805 #define XFillRectangle(d, win, gc, x, y, w, h) \
3806 gdk_draw_rectangle (window, gc, true, x, y, w, h)
3807 #endif /* ! HAVE_GTK3 */
3808 #else /* ! USE_GTK */
3809 GC gc;
3811 /* Create a GC that will use the GXxor function to flip foreground
3812 pixels into background pixels. */
3814 XGCValues values;
3816 values.function = GXxor;
3817 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3818 ^ FRAME_BACKGROUND_PIXEL (f));
3820 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3821 GCFunction | GCForeground, &values);
3823 #endif
3825 /* Get the height not including a menu bar widget. */
3826 int height = FRAME_PIXEL_HEIGHT (f);
3827 /* Height of each line to flash. */
3828 int flash_height = FRAME_LINE_HEIGHT (f);
3829 /* These will be the left and right margins of the rectangles. */
3830 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3831 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3832 int width = flash_right - flash_left;
3834 /* If window is tall, flash top and bottom line. */
3835 if (height > 3 * FRAME_LINE_HEIGHT (f))
3837 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3838 flash_left,
3839 (FRAME_INTERNAL_BORDER_WIDTH (f)
3840 + FRAME_TOP_MARGIN_HEIGHT (f)),
3841 width, flash_height);
3842 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3843 flash_left,
3844 (height - flash_height
3845 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3846 width, flash_height);
3849 else
3850 /* If it is short, flash it all. */
3851 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3852 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3853 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3855 x_flush (f);
3858 struct timespec delay = make_timespec (0, 150 * 1000 * 1000);
3859 struct timespec wakeup = timespec_add (current_timespec (), delay);
3861 /* Keep waiting until past the time wakeup or any input gets
3862 available. */
3863 while (! detect_input_pending ())
3865 struct timespec current = current_timespec ();
3866 struct timespec timeout;
3868 /* Break if result would not be positive. */
3869 if (timespec_cmp (wakeup, current) <= 0)
3870 break;
3872 /* How long `select' should wait. */
3873 timeout = make_timespec (0, 10 * 1000 * 1000);
3875 /* Try to wait that long--but we might wake up sooner. */
3876 pselect (0, NULL, NULL, NULL, &timeout, NULL);
3880 /* If window is tall, flash top and bottom line. */
3881 if (height > 3 * FRAME_LINE_HEIGHT (f))
3883 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3884 flash_left,
3885 (FRAME_INTERNAL_BORDER_WIDTH (f)
3886 + FRAME_TOP_MARGIN_HEIGHT (f)),
3887 width, flash_height);
3888 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3889 flash_left,
3890 (height - flash_height
3891 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3892 width, flash_height);
3894 else
3895 /* If it is short, flash it all. */
3896 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3897 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3898 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3900 #ifdef USE_GTK
3901 #ifdef HAVE_GTK3
3902 cairo_destroy (cr);
3903 #else
3904 g_object_unref (G_OBJECT (gc));
3905 #endif
3906 #undef XFillRectangle
3907 #else
3908 XFreeGC (FRAME_X_DISPLAY (f), gc);
3909 #endif
3910 x_flush (f);
3914 unblock_input ();
3918 static void
3919 XTtoggle_invisible_pointer (struct frame *f, bool invisible)
3921 block_input ();
3922 FRAME_DISPLAY_INFO (f)->toggle_visible_pointer (f, invisible);
3923 unblock_input ();
3927 /* Make audible bell. */
3929 static void
3930 XTring_bell (struct frame *f)
3932 if (FRAME_X_DISPLAY (f))
3934 if (visible_bell)
3935 XTflash (f);
3936 else
3938 block_input ();
3939 #ifdef HAVE_XKB
3940 XkbBell (FRAME_X_DISPLAY (f), None, 0, None);
3941 #else
3942 XBell (FRAME_X_DISPLAY (f), 0);
3943 #endif
3944 XFlush (FRAME_X_DISPLAY (f));
3945 unblock_input ();
3950 /***********************************************************************
3951 Line Dance
3952 ***********************************************************************/
3954 /* Perform an insert-lines or delete-lines operation, inserting N
3955 lines or deleting -N lines at vertical position VPOS. */
3957 static void
3958 x_ins_del_lines (struct frame *f, int vpos, int n)
3960 emacs_abort ();
3964 /* Scroll part of the display as described by RUN. */
3966 static void
3967 x_scroll_run (struct window *w, struct run *run)
3969 struct frame *f = XFRAME (w->frame);
3970 int x, y, width, height, from_y, to_y, bottom_y;
3972 /* Get frame-relative bounding box of the text display area of W,
3973 without mode lines. Include in this box the left and right
3974 fringe of W. */
3975 window_box (w, ANY_AREA, &x, &y, &width, &height);
3977 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
3978 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
3979 bottom_y = y + height;
3981 if (to_y < from_y)
3983 /* Scrolling up. Make sure we don't copy part of the mode
3984 line at the bottom. */
3985 if (from_y + run->height > bottom_y)
3986 height = bottom_y - from_y;
3987 else
3988 height = run->height;
3990 else
3992 /* Scrolling down. Make sure we don't copy over the mode line.
3993 at the bottom. */
3994 if (to_y + run->height > bottom_y)
3995 height = bottom_y - to_y;
3996 else
3997 height = run->height;
4000 block_input ();
4002 /* Cursor off. Will be switched on again in x_update_window_end. */
4003 x_clear_cursor (w);
4005 #ifdef USE_CAIRO
4006 SET_FRAME_GARBAGED (f);
4007 #else
4008 XCopyArea (FRAME_X_DISPLAY (f),
4009 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
4010 f->output_data.x->normal_gc,
4011 x, from_y,
4012 width, height,
4013 x, to_y);
4014 #endif
4016 unblock_input ();
4021 /***********************************************************************
4022 Exposure Events
4023 ***********************************************************************/
4026 static void
4027 frame_highlight (struct frame *f)
4029 /* We used to only do this if Vx_no_window_manager was non-nil, but
4030 the ICCCM (section 4.1.6) says that the window's border pixmap
4031 and border pixel are window attributes which are "private to the
4032 client", so we can always change it to whatever we want. */
4033 block_input ();
4034 /* I recently started to get errors in this XSetWindowBorder, depending on
4035 the window-manager in use, tho something more is at play since I've been
4036 using that same window-manager binary for ever. Let's not crash just
4037 because of this (bug#9310). */
4038 x_catch_errors (FRAME_X_DISPLAY (f));
4039 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4040 f->output_data.x->border_pixel);
4041 x_uncatch_errors ();
4042 unblock_input ();
4043 x_update_cursor (f, true);
4044 x_set_frame_alpha (f);
4047 static void
4048 frame_unhighlight (struct frame *f)
4050 /* We used to only do this if Vx_no_window_manager was non-nil, but
4051 the ICCCM (section 4.1.6) says that the window's border pixmap
4052 and border pixel are window attributes which are "private to the
4053 client", so we can always change it to whatever we want. */
4054 block_input ();
4055 /* Same as above for XSetWindowBorder (bug#9310). */
4056 x_catch_errors (FRAME_X_DISPLAY (f));
4057 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4058 f->output_data.x->border_tile);
4059 x_uncatch_errors ();
4060 unblock_input ();
4061 x_update_cursor (f, true);
4062 x_set_frame_alpha (f);
4065 /* The focus has changed. Update the frames as necessary to reflect
4066 the new situation. Note that we can't change the selected frame
4067 here, because the Lisp code we are interrupting might become confused.
4068 Each event gets marked with the frame in which it occurred, so the
4069 Lisp code can tell when the switch took place by examining the events. */
4071 static void
4072 x_new_focus_frame (struct x_display_info *dpyinfo, struct frame *frame)
4074 struct frame *old_focus = dpyinfo->x_focus_frame;
4076 if (frame != dpyinfo->x_focus_frame)
4078 /* Set this before calling other routines, so that they see
4079 the correct value of x_focus_frame. */
4080 dpyinfo->x_focus_frame = frame;
4082 if (old_focus && old_focus->auto_lower)
4083 x_lower_frame (old_focus);
4085 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
4086 dpyinfo->x_pending_autoraise_frame = dpyinfo->x_focus_frame;
4087 else
4088 dpyinfo->x_pending_autoraise_frame = NULL;
4091 x_frame_rehighlight (dpyinfo);
4094 /* Handle FocusIn and FocusOut state changes for FRAME.
4095 If FRAME has focus and there exists more than one frame, puts
4096 a FOCUS_IN_EVENT into *BUFP. */
4098 static void
4099 x_focus_changed (int type, int state, struct x_display_info *dpyinfo, struct frame *frame, struct input_event *bufp)
4101 if (type == FocusIn)
4103 if (dpyinfo->x_focus_event_frame != frame)
4105 x_new_focus_frame (dpyinfo, frame);
4106 dpyinfo->x_focus_event_frame = frame;
4108 /* Don't stop displaying the initial startup message
4109 for a switch-frame event we don't need. */
4110 /* When run as a daemon, Vterminal_frame is always NIL. */
4111 bufp->arg = (((NILP (Vterminal_frame)
4112 || ! FRAME_X_P (XFRAME (Vterminal_frame))
4113 || EQ (Fdaemonp (), Qt))
4114 && CONSP (Vframe_list)
4115 && !NILP (XCDR (Vframe_list)))
4116 ? Qt : Qnil);
4117 bufp->kind = FOCUS_IN_EVENT;
4118 XSETFRAME (bufp->frame_or_window, frame);
4121 frame->output_data.x->focus_state |= state;
4123 #ifdef HAVE_X_I18N
4124 if (FRAME_XIC (frame))
4125 XSetICFocus (FRAME_XIC (frame));
4126 #endif
4128 else if (type == FocusOut)
4130 frame->output_data.x->focus_state &= ~state;
4132 if (dpyinfo->x_focus_event_frame == frame)
4134 dpyinfo->x_focus_event_frame = 0;
4135 x_new_focus_frame (dpyinfo, 0);
4137 bufp->kind = FOCUS_OUT_EVENT;
4138 XSETFRAME (bufp->frame_or_window, frame);
4141 #ifdef HAVE_X_I18N
4142 if (FRAME_XIC (frame))
4143 XUnsetICFocus (FRAME_XIC (frame));
4144 #endif
4145 if (frame->pointer_invisible)
4146 XTtoggle_invisible_pointer (frame, false);
4150 /* Return the Emacs frame-object corresponding to an X window.
4151 It could be the frame's main window or an icon window. */
4153 static struct frame *
4154 x_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
4156 Lisp_Object tail, frame;
4157 struct frame *f;
4159 if (wdesc == None)
4160 return NULL;
4162 FOR_EACH_FRAME (tail, frame)
4164 f = XFRAME (frame);
4165 if (!FRAME_X_P (f) || FRAME_DISPLAY_INFO (f) != dpyinfo)
4166 continue;
4167 if (f->output_data.x->hourglass_window == wdesc)
4168 return f;
4169 #ifdef USE_X_TOOLKIT
4170 if ((f->output_data.x->edit_widget
4171 && XtWindow (f->output_data.x->edit_widget) == wdesc)
4172 /* A tooltip frame? */
4173 || (!f->output_data.x->edit_widget
4174 && FRAME_X_WINDOW (f) == wdesc)
4175 || f->output_data.x->icon_desc == wdesc)
4176 return f;
4177 #else /* not USE_X_TOOLKIT */
4178 #ifdef USE_GTK
4179 if (f->output_data.x->edit_widget)
4181 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
4182 struct x_output *x = f->output_data.x;
4183 if (gwdesc != 0 && gwdesc == x->edit_widget)
4184 return f;
4186 #endif /* USE_GTK */
4187 if (FRAME_X_WINDOW (f) == wdesc
4188 || f->output_data.x->icon_desc == wdesc)
4189 return f;
4190 #endif /* not USE_X_TOOLKIT */
4192 return 0;
4195 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
4197 /* Like x_window_to_frame but also compares the window with the widget's
4198 windows. */
4200 static struct frame *
4201 x_any_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
4203 Lisp_Object tail, frame;
4204 struct frame *f, *found = NULL;
4205 struct x_output *x;
4207 if (wdesc == None)
4208 return NULL;
4210 FOR_EACH_FRAME (tail, frame)
4212 if (found)
4213 break;
4214 f = XFRAME (frame);
4215 if (FRAME_X_P (f) && FRAME_DISPLAY_INFO (f) == dpyinfo)
4217 /* This frame matches if the window is any of its widgets. */
4218 x = f->output_data.x;
4219 if (x->hourglass_window == wdesc)
4220 found = f;
4221 else if (x->widget)
4223 #ifdef USE_GTK
4224 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
4225 if (gwdesc != 0
4226 && gtk_widget_get_toplevel (gwdesc) == x->widget)
4227 found = f;
4228 #else
4229 if (wdesc == XtWindow (x->widget)
4230 || wdesc == XtWindow (x->column_widget)
4231 || wdesc == XtWindow (x->edit_widget))
4232 found = f;
4233 /* Match if the window is this frame's menubar. */
4234 else if (lw_window_is_in_menubar (wdesc, x->menubar_widget))
4235 found = f;
4236 #endif
4238 else if (FRAME_X_WINDOW (f) == wdesc)
4239 /* A tooltip frame. */
4240 found = f;
4244 return found;
4247 /* Likewise, but consider only the menu bar widget. */
4249 static struct frame *
4250 x_menubar_window_to_frame (struct x_display_info *dpyinfo,
4251 const XEvent *event)
4253 Window wdesc = event->xany.window;
4254 Lisp_Object tail, frame;
4255 struct frame *f;
4256 struct x_output *x;
4258 if (wdesc == None)
4259 return NULL;
4261 FOR_EACH_FRAME (tail, frame)
4263 f = XFRAME (frame);
4264 if (!FRAME_X_P (f) || FRAME_DISPLAY_INFO (f) != dpyinfo)
4265 continue;
4266 x = f->output_data.x;
4267 #ifdef USE_GTK
4268 if (x->menubar_widget && xg_event_is_for_menubar (f, event))
4269 return f;
4270 #else
4271 /* Match if the window is this frame's menubar. */
4272 if (x->menubar_widget
4273 && lw_window_is_in_menubar (wdesc, x->menubar_widget))
4274 return f;
4275 #endif
4277 return 0;
4280 /* Return the frame whose principal (outermost) window is WDESC.
4281 If WDESC is some other (smaller) window, we return 0. */
4283 struct frame *
4284 x_top_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
4286 Lisp_Object tail, frame;
4287 struct frame *f;
4288 struct x_output *x;
4290 if (wdesc == None)
4291 return NULL;
4293 FOR_EACH_FRAME (tail, frame)
4295 f = XFRAME (frame);
4296 if (!FRAME_X_P (f) || FRAME_DISPLAY_INFO (f) != dpyinfo)
4297 continue;
4298 x = f->output_data.x;
4300 if (x->widget)
4302 /* This frame matches if the window is its topmost widget. */
4303 #ifdef USE_GTK
4304 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
4305 if (gwdesc == x->widget)
4306 return f;
4307 #else
4308 if (wdesc == XtWindow (x->widget))
4309 return f;
4310 #endif
4312 else if (FRAME_X_WINDOW (f) == wdesc)
4313 /* Tooltip frame. */
4314 return f;
4316 return 0;
4319 #else /* !USE_X_TOOLKIT && !USE_GTK */
4321 #define x_any_window_to_frame(d, i) x_window_to_frame (d, i)
4322 #define x_top_window_to_frame(d, i) x_window_to_frame (d, i)
4324 #endif /* USE_X_TOOLKIT || USE_GTK */
4326 /* The focus may have changed. Figure out if it is a real focus change,
4327 by checking both FocusIn/Out and Enter/LeaveNotify events.
4329 Returns FOCUS_IN_EVENT event in *BUFP. */
4331 static void
4332 x_detect_focus_change (struct x_display_info *dpyinfo, struct frame *frame,
4333 const XEvent *event, struct input_event *bufp)
4335 if (!frame)
4336 return;
4338 switch (event->type)
4340 case EnterNotify:
4341 case LeaveNotify:
4343 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
4344 int focus_state
4345 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
4347 if (event->xcrossing.detail != NotifyInferior
4348 && event->xcrossing.focus
4349 && ! (focus_state & FOCUS_EXPLICIT))
4350 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
4351 FOCUS_IMPLICIT,
4352 dpyinfo, frame, bufp);
4354 break;
4356 case FocusIn:
4357 case FocusOut:
4358 x_focus_changed (event->type,
4359 (event->xfocus.detail == NotifyPointer ?
4360 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
4361 dpyinfo, frame, bufp);
4362 break;
4364 case ClientMessage:
4365 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
4367 enum xembed_message msg = event->xclient.data.l[1];
4368 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
4369 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
4371 break;
4376 #if !defined USE_X_TOOLKIT && !defined USE_GTK
4377 /* Handle an event saying the mouse has moved out of an Emacs frame. */
4379 void
4380 x_mouse_leave (struct x_display_info *dpyinfo)
4382 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
4384 #endif
4386 /* The focus has changed, or we have redirected a frame's focus to
4387 another frame (this happens when a frame uses a surrogate
4388 mini-buffer frame). Shift the highlight as appropriate.
4390 The FRAME argument doesn't necessarily have anything to do with which
4391 frame is being highlighted or un-highlighted; we only use it to find
4392 the appropriate X display info. */
4394 static void
4395 XTframe_rehighlight (struct frame *frame)
4397 x_frame_rehighlight (FRAME_DISPLAY_INFO (frame));
4400 static void
4401 x_frame_rehighlight (struct x_display_info *dpyinfo)
4403 struct frame *old_highlight = dpyinfo->x_highlight_frame;
4405 if (dpyinfo->x_focus_frame)
4407 dpyinfo->x_highlight_frame
4408 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
4409 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
4410 : dpyinfo->x_focus_frame);
4411 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
4413 fset_focus_frame (dpyinfo->x_focus_frame, Qnil);
4414 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
4417 else
4418 dpyinfo->x_highlight_frame = 0;
4420 if (dpyinfo->x_highlight_frame != old_highlight)
4422 if (old_highlight)
4423 frame_unhighlight (old_highlight);
4424 if (dpyinfo->x_highlight_frame)
4425 frame_highlight (dpyinfo->x_highlight_frame);
4431 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
4433 /* Initialize mode_switch_bit and modifier_meaning. */
4434 static void
4435 x_find_modifier_meanings (struct x_display_info *dpyinfo)
4437 int min_code, max_code;
4438 KeySym *syms;
4439 int syms_per_code;
4440 XModifierKeymap *mods;
4442 dpyinfo->meta_mod_mask = 0;
4443 dpyinfo->shift_lock_mask = 0;
4444 dpyinfo->alt_mod_mask = 0;
4445 dpyinfo->super_mod_mask = 0;
4446 dpyinfo->hyper_mod_mask = 0;
4448 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
4450 syms = XGetKeyboardMapping (dpyinfo->display,
4451 min_code, max_code - min_code + 1,
4452 &syms_per_code);
4453 mods = XGetModifierMapping (dpyinfo->display);
4455 /* Scan the modifier table to see which modifier bits the Meta and
4456 Alt keysyms are on. */
4458 int row, col; /* The row and column in the modifier table. */
4459 bool found_alt_or_meta;
4461 for (row = 3; row < 8; row++)
4463 found_alt_or_meta = false;
4464 for (col = 0; col < mods->max_keypermod; col++)
4466 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
4468 /* Zeroes are used for filler. Skip them. */
4469 if (code == 0)
4470 continue;
4472 /* Are any of this keycode's keysyms a meta key? */
4474 int code_col;
4476 for (code_col = 0; code_col < syms_per_code; code_col++)
4478 int sym = syms[((code - min_code) * syms_per_code) + code_col];
4480 switch (sym)
4482 case XK_Meta_L:
4483 case XK_Meta_R:
4484 found_alt_or_meta = true;
4485 dpyinfo->meta_mod_mask |= (1 << row);
4486 break;
4488 case XK_Alt_L:
4489 case XK_Alt_R:
4490 found_alt_or_meta = true;
4491 dpyinfo->alt_mod_mask |= (1 << row);
4492 break;
4494 case XK_Hyper_L:
4495 case XK_Hyper_R:
4496 if (!found_alt_or_meta)
4497 dpyinfo->hyper_mod_mask |= (1 << row);
4498 code_col = syms_per_code;
4499 col = mods->max_keypermod;
4500 break;
4502 case XK_Super_L:
4503 case XK_Super_R:
4504 if (!found_alt_or_meta)
4505 dpyinfo->super_mod_mask |= (1 << row);
4506 code_col = syms_per_code;
4507 col = mods->max_keypermod;
4508 break;
4510 case XK_Shift_Lock:
4511 /* Ignore this if it's not on the lock modifier. */
4512 if (!found_alt_or_meta && ((1 << row) == LockMask))
4513 dpyinfo->shift_lock_mask = LockMask;
4514 code_col = syms_per_code;
4515 col = mods->max_keypermod;
4516 break;
4524 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
4525 if (! dpyinfo->meta_mod_mask)
4527 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
4528 dpyinfo->alt_mod_mask = 0;
4531 /* If some keys are both alt and meta,
4532 make them just meta, not alt. */
4533 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
4535 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
4538 XFree (syms);
4539 XFreeModifiermap (mods);
4542 /* Convert between the modifier bits X uses and the modifier bits
4543 Emacs uses. */
4546 x_x_to_emacs_modifiers (struct x_display_info *dpyinfo, int state)
4548 int mod_meta = meta_modifier;
4549 int mod_alt = alt_modifier;
4550 int mod_hyper = hyper_modifier;
4551 int mod_super = super_modifier;
4552 Lisp_Object tem;
4554 tem = Fget (Vx_alt_keysym, Qmodifier_value);
4555 if (INTEGERP (tem)) mod_alt = XINT (tem) & INT_MAX;
4556 tem = Fget (Vx_meta_keysym, Qmodifier_value);
4557 if (INTEGERP (tem)) mod_meta = XINT (tem) & INT_MAX;
4558 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
4559 if (INTEGERP (tem)) mod_hyper = XINT (tem) & INT_MAX;
4560 tem = Fget (Vx_super_keysym, Qmodifier_value);
4561 if (INTEGERP (tem)) mod_super = XINT (tem) & INT_MAX;
4563 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
4564 | ((state & ControlMask) ? ctrl_modifier : 0)
4565 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
4566 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
4567 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
4568 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
4571 static int
4572 x_emacs_to_x_modifiers (struct x_display_info *dpyinfo, EMACS_INT state)
4574 EMACS_INT mod_meta = meta_modifier;
4575 EMACS_INT mod_alt = alt_modifier;
4576 EMACS_INT mod_hyper = hyper_modifier;
4577 EMACS_INT mod_super = super_modifier;
4579 Lisp_Object tem;
4581 tem = Fget (Vx_alt_keysym, Qmodifier_value);
4582 if (INTEGERP (tem)) mod_alt = XINT (tem);
4583 tem = Fget (Vx_meta_keysym, Qmodifier_value);
4584 if (INTEGERP (tem)) mod_meta = XINT (tem);
4585 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
4586 if (INTEGERP (tem)) mod_hyper = XINT (tem);
4587 tem = Fget (Vx_super_keysym, Qmodifier_value);
4588 if (INTEGERP (tem)) mod_super = XINT (tem);
4591 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
4592 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
4593 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
4594 | ((state & shift_modifier) ? ShiftMask : 0)
4595 | ((state & ctrl_modifier) ? ControlMask : 0)
4596 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
4599 /* Convert a keysym to its name. */
4601 char *
4602 x_get_keysym_name (int keysym)
4604 char *value;
4606 block_input ();
4607 value = XKeysymToString (keysym);
4608 unblock_input ();
4610 return value;
4613 /* Mouse clicks and mouse movement. Rah.
4615 Formerly, we used PointerMotionHintMask (in standard_event_mask)
4616 so that we would have to call XQueryPointer after each MotionNotify
4617 event to ask for another such event. However, this made mouse tracking
4618 slow, and there was a bug that made it eventually stop.
4620 Simply asking for MotionNotify all the time seems to work better.
4622 In order to avoid asking for motion events and then throwing most
4623 of them away or busy-polling the server for mouse positions, we ask
4624 the server for pointer motion hints. This means that we get only
4625 one event per group of mouse movements. "Groups" are delimited by
4626 other kinds of events (focus changes and button clicks, for
4627 example), or by XQueryPointer calls; when one of these happens, we
4628 get another MotionNotify event the next time the mouse moves. This
4629 is at least as efficient as getting motion events when mouse
4630 tracking is on, and I suspect only negligibly worse when tracking
4631 is off. */
4633 /* Prepare a mouse-event in *RESULT for placement in the input queue.
4635 If the event is a button press, then note that we have grabbed
4636 the mouse. */
4638 static Lisp_Object
4639 construct_mouse_click (struct input_event *result,
4640 const XButtonEvent *event,
4641 struct frame *f)
4643 /* Make the event type NO_EVENT; we'll change that when we decide
4644 otherwise. */
4645 result->kind = MOUSE_CLICK_EVENT;
4646 result->code = event->button - Button1;
4647 result->timestamp = event->time;
4648 result->modifiers = (x_x_to_emacs_modifiers (FRAME_DISPLAY_INFO (f),
4649 event->state)
4650 | (event->type == ButtonRelease
4651 ? up_modifier
4652 : down_modifier));
4654 XSETINT (result->x, event->x);
4655 XSETINT (result->y, event->y);
4656 XSETFRAME (result->frame_or_window, f);
4657 result->arg = Qnil;
4658 return Qnil;
4661 /* Function to report a mouse movement to the mainstream Emacs code.
4662 The input handler calls this.
4664 We have received a mouse movement event, which is given in *event.
4665 If the mouse is over a different glyph than it was last time, tell
4666 the mainstream emacs code by setting mouse_moved. If not, ask for
4667 another motion event, so we can check again the next time it moves. */
4669 static bool
4670 note_mouse_movement (struct frame *frame, const XMotionEvent *event)
4672 XRectangle *r;
4673 struct x_display_info *dpyinfo;
4675 if (!FRAME_X_OUTPUT (frame))
4676 return false;
4678 dpyinfo = FRAME_DISPLAY_INFO (frame);
4679 dpyinfo->last_mouse_movement_time = event->time;
4680 dpyinfo->last_mouse_motion_frame = frame;
4681 dpyinfo->last_mouse_motion_x = event->x;
4682 dpyinfo->last_mouse_motion_y = event->y;
4684 if (event->window != FRAME_X_WINDOW (frame))
4686 frame->mouse_moved = true;
4687 dpyinfo->last_mouse_scroll_bar = NULL;
4688 note_mouse_highlight (frame, -1, -1);
4689 dpyinfo->last_mouse_glyph_frame = NULL;
4690 return true;
4694 /* Has the mouse moved off the glyph it was on at the last sighting? */
4695 r = &dpyinfo->last_mouse_glyph;
4696 if (frame != dpyinfo->last_mouse_glyph_frame
4697 || event->x < r->x || event->x >= r->x + r->width
4698 || event->y < r->y || event->y >= r->y + r->height)
4700 frame->mouse_moved = true;
4701 dpyinfo->last_mouse_scroll_bar = NULL;
4702 note_mouse_highlight (frame, event->x, event->y);
4703 /* Remember which glyph we're now on. */
4704 remember_mouse_glyph (frame, event->x, event->y, r);
4705 dpyinfo->last_mouse_glyph_frame = frame;
4706 return true;
4709 return false;
4712 /* Return the current position of the mouse.
4713 *FP should be a frame which indicates which display to ask about.
4715 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
4716 and *PART to the frame, window, and scroll bar part that the mouse
4717 is over. Set *X and *Y to the portion and whole of the mouse's
4718 position on the scroll bar.
4720 If the mouse movement started elsewhere, set *FP to the frame the
4721 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
4722 the mouse is over.
4724 Set *TIMESTAMP to the server time-stamp for the time at which the mouse
4725 was at this position.
4727 Don't store anything if we don't have a valid set of values to report.
4729 This clears the mouse_moved flag, so we can wait for the next mouse
4730 movement. */
4732 static void
4733 XTmouse_position (struct frame **fp, int insist, Lisp_Object *bar_window,
4734 enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
4735 Time *timestamp)
4737 struct frame *f1;
4738 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (*fp);
4740 block_input ();
4742 if (dpyinfo->last_mouse_scroll_bar && insist == 0)
4744 struct scroll_bar *bar = dpyinfo->last_mouse_scroll_bar;
4746 if (bar->horizontal)
4747 x_horizontal_scroll_bar_report_motion (fp, bar_window, part, x, y, timestamp);
4748 else
4749 x_scroll_bar_report_motion (fp, bar_window, part, x, y, timestamp);
4751 else
4753 Window root;
4754 int root_x, root_y;
4756 Window dummy_window;
4757 int dummy;
4759 Lisp_Object frame, tail;
4761 /* Clear the mouse-moved flag for every frame on this display. */
4762 FOR_EACH_FRAME (tail, frame)
4763 if (FRAME_X_P (XFRAME (frame))
4764 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
4765 XFRAME (frame)->mouse_moved = false;
4767 dpyinfo->last_mouse_scroll_bar = NULL;
4769 /* Figure out which root window we're on. */
4770 XQueryPointer (FRAME_X_DISPLAY (*fp),
4771 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
4773 /* The root window which contains the pointer. */
4774 &root,
4776 /* Trash which we can't trust if the pointer is on
4777 a different screen. */
4778 &dummy_window,
4780 /* The position on that root window. */
4781 &root_x, &root_y,
4783 /* More trash we can't trust. */
4784 &dummy, &dummy,
4786 /* Modifier keys and pointer buttons, about which
4787 we don't care. */
4788 (unsigned int *) &dummy);
4790 /* Now we have a position on the root; find the innermost window
4791 containing the pointer. */
4793 Window win, child;
4794 int win_x, win_y;
4795 int parent_x = 0, parent_y = 0;
4797 win = root;
4799 /* XTranslateCoordinates can get errors if the window
4800 structure is changing at the same time this function
4801 is running. So at least we must not crash from them. */
4803 x_catch_errors (FRAME_X_DISPLAY (*fp));
4805 if (x_mouse_grabbed (dpyinfo))
4807 /* If mouse was grabbed on a frame, give coords for that frame
4808 even if the mouse is now outside it. */
4809 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
4811 /* From-window. */
4812 root,
4814 /* To-window. */
4815 FRAME_X_WINDOW (dpyinfo->last_mouse_frame),
4817 /* From-position, to-position. */
4818 root_x, root_y, &win_x, &win_y,
4820 /* Child of win. */
4821 &child);
4822 f1 = dpyinfo->last_mouse_frame;
4824 else
4826 while (true)
4828 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
4830 /* From-window, to-window. */
4831 root, win,
4833 /* From-position, to-position. */
4834 root_x, root_y, &win_x, &win_y,
4836 /* Child of win. */
4837 &child);
4839 if (child == None || child == win)
4840 break;
4841 #ifdef USE_GTK
4842 /* We don't wan't to know the innermost window. We
4843 want the edit window. For non-Gtk+ the innermost
4844 window is the edit window. For Gtk+ it might not
4845 be. It might be the tool bar for example. */
4846 if (x_window_to_frame (dpyinfo, win))
4847 break;
4848 #endif
4849 win = child;
4850 parent_x = win_x;
4851 parent_y = win_y;
4854 /* Now we know that:
4855 win is the innermost window containing the pointer
4856 (XTC says it has no child containing the pointer),
4857 win_x and win_y are the pointer's position in it
4858 (XTC did this the last time through), and
4859 parent_x and parent_y are the pointer's position in win's parent.
4860 (They are what win_x and win_y were when win was child.
4861 If win is the root window, it has no parent, and
4862 parent_{x,y} are invalid, but that's okay, because we'll
4863 never use them in that case.) */
4865 #ifdef USE_GTK
4866 /* We don't wan't to know the innermost window. We
4867 want the edit window. */
4868 f1 = x_window_to_frame (dpyinfo, win);
4869 #else
4870 /* Is win one of our frames? */
4871 f1 = x_any_window_to_frame (dpyinfo, win);
4872 #endif
4874 #ifdef USE_X_TOOLKIT
4875 /* If we end up with the menu bar window, say it's not
4876 on the frame. */
4877 if (f1 != NULL
4878 && f1->output_data.x->menubar_widget
4879 && win == XtWindow (f1->output_data.x->menubar_widget))
4880 f1 = NULL;
4881 #endif /* USE_X_TOOLKIT */
4884 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
4885 f1 = 0;
4887 x_uncatch_errors ();
4889 /* If not, is it one of our scroll bars? */
4890 if (! f1)
4892 struct scroll_bar *bar;
4894 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win, 2);
4896 if (bar)
4898 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4899 win_x = parent_x;
4900 win_y = parent_y;
4904 if (f1 == 0 && insist > 0)
4905 f1 = SELECTED_FRAME ();
4907 if (f1)
4909 /* Ok, we found a frame. Store all the values.
4910 last_mouse_glyph is a rectangle used to reduce the
4911 generation of mouse events. To not miss any motion
4912 events, we must divide the frame into rectangles of the
4913 size of the smallest character that could be displayed
4914 on it, i.e. into the same rectangles that matrices on
4915 the frame are divided into. */
4917 /* FIXME: what if F1 is not an X frame? */
4918 dpyinfo = FRAME_DISPLAY_INFO (f1);
4919 remember_mouse_glyph (f1, win_x, win_y, &dpyinfo->last_mouse_glyph);
4920 dpyinfo->last_mouse_glyph_frame = f1;
4922 *bar_window = Qnil;
4923 *part = 0;
4924 *fp = f1;
4925 XSETINT (*x, win_x);
4926 XSETINT (*y, win_y);
4927 *timestamp = dpyinfo->last_mouse_movement_time;
4932 unblock_input ();
4937 /***********************************************************************
4938 Scroll bars
4939 ***********************************************************************/
4941 /* Scroll bar support. */
4943 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
4944 manages it.
4945 This can be called in GC, so we have to make sure to strip off mark
4946 bits. */
4948 static struct scroll_bar *
4949 x_window_to_scroll_bar (Display *display, Window window_id, int type)
4951 Lisp_Object tail, frame;
4953 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
4954 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
4955 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
4957 FOR_EACH_FRAME (tail, frame)
4959 Lisp_Object bar, condemned;
4961 if (! FRAME_X_P (XFRAME (frame)))
4962 continue;
4964 /* Scan this frame's scroll bar list for a scroll bar with the
4965 right window ID. */
4966 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4967 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4968 /* This trick allows us to search both the ordinary and
4969 condemned scroll bar lists with one loop. */
4970 ! NILP (bar) || (bar = condemned,
4971 condemned = Qnil,
4972 ! NILP (bar));
4973 bar = XSCROLL_BAR (bar)->next)
4974 if (XSCROLL_BAR (bar)->x_window == window_id
4975 && FRAME_X_DISPLAY (XFRAME (frame)) == display
4976 && (type = 2
4977 || (type == 1 && XSCROLL_BAR (bar)->horizontal)
4978 || (type == 0 && !XSCROLL_BAR (bar)->horizontal)))
4979 return XSCROLL_BAR (bar);
4982 return NULL;
4986 #if defined USE_LUCID
4988 /* Return the Lucid menu bar WINDOW is part of. Return null
4989 if WINDOW is not part of a menu bar. */
4991 static Widget
4992 x_window_to_menu_bar (Window window)
4994 Lisp_Object tail, frame;
4996 FOR_EACH_FRAME (tail, frame)
4997 if (FRAME_X_P (XFRAME (frame)))
4999 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
5001 if (menu_bar && xlwmenu_window_p (menu_bar, window))
5002 return menu_bar;
5004 return NULL;
5007 #endif /* USE_LUCID */
5010 /************************************************************************
5011 Toolkit scroll bars
5012 ************************************************************************/
5014 #ifdef USE_TOOLKIT_SCROLL_BARS
5016 static void x_send_scroll_bar_event (Lisp_Object, enum scroll_bar_part,
5017 int, int, bool);
5019 /* Lisp window being scrolled. Set when starting to interact with
5020 a toolkit scroll bar, reset to nil when ending the interaction. */
5022 static Lisp_Object window_being_scrolled;
5024 /* Whether this is an Xaw with arrow-scrollbars. This should imply
5025 that movements of 1/20 of the screen size are mapped to up/down. */
5027 #ifndef USE_GTK
5028 /* Id of action hook installed for scroll bars. */
5030 static XtActionHookId action_hook_id;
5031 static XtActionHookId horizontal_action_hook_id;
5033 static Boolean xaw3d_arrow_scroll;
5035 /* Whether the drag scrolling maintains the mouse at the top of the
5036 thumb. If not, resizing the thumb needs to be done more carefully
5037 to avoid jerkiness. */
5039 static Boolean xaw3d_pick_top;
5041 /* Action hook installed via XtAppAddActionHook when toolkit scroll
5042 bars are used.. The hook is responsible for detecting when
5043 the user ends an interaction with the scroll bar, and generates
5044 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
5046 static void
5047 xt_action_hook (Widget widget, XtPointer client_data, String action_name,
5048 XEvent *event, String *params, Cardinal *num_params)
5050 bool scroll_bar_p;
5051 const char *end_action;
5053 #ifdef USE_MOTIF
5054 scroll_bar_p = XmIsScrollBar (widget);
5055 end_action = "Release";
5056 #else /* !USE_MOTIF i.e. use Xaw */
5057 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
5058 end_action = "EndScroll";
5059 #endif /* USE_MOTIF */
5061 if (scroll_bar_p
5062 && strcmp (action_name, end_action) == 0
5063 && WINDOWP (window_being_scrolled))
5065 struct window *w;
5066 struct scroll_bar *bar;
5068 x_send_scroll_bar_event (window_being_scrolled,
5069 scroll_bar_end_scroll, 0, 0, false);
5070 w = XWINDOW (window_being_scrolled);
5071 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5073 if (bar->dragging != -1)
5075 bar->dragging = -1;
5076 /* The thumb size is incorrect while dragging: fix it. */
5077 set_vertical_scroll_bar (w);
5079 window_being_scrolled = Qnil;
5080 #if defined (USE_LUCID)
5081 bar->last_seen_part = scroll_bar_nowhere;
5082 #endif
5083 /* Xt timeouts no longer needed. */
5084 toolkit_scroll_bar_interaction = false;
5089 static void
5090 xt_horizontal_action_hook (Widget widget, XtPointer client_data, String action_name,
5091 XEvent *event, String *params, Cardinal *num_params)
5093 bool scroll_bar_p;
5094 const char *end_action;
5096 #ifdef USE_MOTIF
5097 scroll_bar_p = XmIsScrollBar (widget);
5098 end_action = "Release";
5099 #else /* !USE_MOTIF i.e. use Xaw */
5100 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
5101 end_action = "EndScroll";
5102 #endif /* USE_MOTIF */
5104 if (scroll_bar_p
5105 && strcmp (action_name, end_action) == 0
5106 && WINDOWP (window_being_scrolled))
5108 struct window *w;
5109 struct scroll_bar *bar;
5111 x_send_scroll_bar_event (window_being_scrolled,
5112 scroll_bar_end_scroll, 0, 0, true);
5113 w = XWINDOW (window_being_scrolled);
5114 bar = XSCROLL_BAR (w->horizontal_scroll_bar);
5116 if (bar->dragging != -1)
5118 bar->dragging = -1;
5119 /* The thumb size is incorrect while dragging: fix it. */
5120 set_horizontal_scroll_bar (w);
5122 window_being_scrolled = Qnil;
5123 #if defined (USE_LUCID)
5124 bar->last_seen_part = scroll_bar_nowhere;
5125 #endif
5126 /* Xt timeouts no longer needed. */
5127 toolkit_scroll_bar_interaction = false;
5130 #endif /* not USE_GTK */
5132 /* Send a client message with message type Xatom_Scrollbar for a
5133 scroll action to the frame of WINDOW. PART is a value identifying
5134 the part of the scroll bar that was clicked on. PORTION is the
5135 amount to scroll of a whole of WHOLE. */
5137 static void
5138 x_send_scroll_bar_event (Lisp_Object window, enum scroll_bar_part part,
5139 int portion, int whole, bool horizontal)
5141 XEvent event;
5142 XClientMessageEvent *ev = &event.xclient;
5143 struct window *w = XWINDOW (window);
5144 struct frame *f = XFRAME (w->frame);
5145 intptr_t iw = (intptr_t) w;
5146 enum { BITS_PER_INTPTR = CHAR_BIT * sizeof iw };
5147 verify (BITS_PER_INTPTR <= 64);
5148 int sign_shift = BITS_PER_INTPTR - 32;
5150 block_input ();
5152 /* Construct a ClientMessage event to send to the frame. */
5153 ev->type = ClientMessage;
5154 ev->message_type = (horizontal
5155 ? FRAME_DISPLAY_INFO (f)->Xatom_Horizontal_Scrollbar
5156 : FRAME_DISPLAY_INFO (f)->Xatom_Scrollbar);
5157 ev->display = FRAME_X_DISPLAY (f);
5158 ev->window = FRAME_X_WINDOW (f);
5159 ev->format = 32;
5161 /* A 32-bit X client on a 64-bit X server can pass a window pointer
5162 as-is. A 64-bit client on a 32-bit X server is in trouble
5163 because a pointer does not fit and would be truncated while
5164 passing through the server. So use two slots and hope that X12
5165 will resolve such issues someday. */
5166 ev->data.l[0] = iw >> 31 >> 1;
5167 ev->data.l[1] = sign_shift <= 0 ? iw : iw << sign_shift >> sign_shift;
5168 ev->data.l[2] = part;
5169 ev->data.l[3] = portion;
5170 ev->data.l[4] = whole;
5172 /* Make Xt timeouts work while the scroll bar is active. */
5173 #ifdef USE_X_TOOLKIT
5174 toolkit_scroll_bar_interaction = true;
5175 x_activate_timeout_atimer ();
5176 #endif
5178 /* Setting the event mask to zero means that the message will
5179 be sent to the client that created the window, and if that
5180 window no longer exists, no event will be sent. */
5181 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
5182 unblock_input ();
5186 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
5187 in *IEVENT. */
5189 static void
5190 x_scroll_bar_to_input_event (const XEvent *event,
5191 struct input_event *ievent)
5193 const XClientMessageEvent *ev = &event->xclient;
5194 Lisp_Object window;
5195 struct window *w;
5197 /* See the comment in the function above. */
5198 intptr_t iw0 = ev->data.l[0];
5199 intptr_t iw1 = ev->data.l[1];
5200 intptr_t iw = (iw0 << 31 << 1) + (iw1 & 0xffffffffu);
5201 w = (struct window *) iw;
5203 XSETWINDOW (window, w);
5205 ievent->kind = SCROLL_BAR_CLICK_EVENT;
5206 ievent->frame_or_window = window;
5207 ievent->arg = Qnil;
5208 #ifdef USE_GTK
5209 ievent->timestamp = CurrentTime;
5210 #else
5211 ievent->timestamp =
5212 XtLastTimestampProcessed (FRAME_X_DISPLAY (XFRAME (w->frame)));
5213 #endif
5214 ievent->code = 0;
5215 ievent->part = ev->data.l[2];
5216 ievent->x = make_number (ev->data.l[3]);
5217 ievent->y = make_number (ev->data.l[4]);
5218 ievent->modifiers = 0;
5221 /* Transform a horizontal scroll bar ClientMessage EVENT to an Emacs
5222 input event in *IEVENT. */
5224 static void
5225 x_horizontal_scroll_bar_to_input_event (const XEvent *event,
5226 struct input_event *ievent)
5228 const XClientMessageEvent *ev = &event->xclient;
5229 Lisp_Object window;
5230 struct window *w;
5232 /* See the comment in the function above. */
5233 intptr_t iw0 = ev->data.l[0];
5234 intptr_t iw1 = ev->data.l[1];
5235 intptr_t iw = (iw0 << 31 << 1) + (iw1 & 0xffffffffu);
5236 w = (struct window *) iw;
5238 XSETWINDOW (window, w);
5240 ievent->kind = HORIZONTAL_SCROLL_BAR_CLICK_EVENT;
5241 ievent->frame_or_window = window;
5242 ievent->arg = Qnil;
5243 #ifdef USE_GTK
5244 ievent->timestamp = CurrentTime;
5245 #else
5246 ievent->timestamp =
5247 XtLastTimestampProcessed (FRAME_X_DISPLAY (XFRAME (w->frame)));
5248 #endif
5249 ievent->code = 0;
5250 ievent->part = ev->data.l[2];
5251 ievent->x = make_number (ev->data.l[3]);
5252 ievent->y = make_number (ev->data.l[4]);
5253 ievent->modifiers = 0;
5257 #ifdef USE_MOTIF
5259 /* Minimum and maximum values used for Motif scroll bars. */
5261 #define XM_SB_MAX 10000000
5263 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
5264 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
5265 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
5267 static void
5268 xm_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
5270 struct scroll_bar *bar = client_data;
5271 XmScrollBarCallbackStruct *cs = call_data;
5272 enum scroll_bar_part part = scroll_bar_nowhere;
5273 bool horizontal = bar->horizontal;
5274 int whole = 0, portion = 0;
5276 switch (cs->reason)
5278 case XmCR_DECREMENT:
5279 bar->dragging = -1;
5280 part = horizontal ? scroll_bar_left_arrow : scroll_bar_up_arrow;
5281 break;
5283 case XmCR_INCREMENT:
5284 bar->dragging = -1;
5285 part = horizontal ? scroll_bar_right_arrow : scroll_bar_down_arrow;
5286 break;
5288 case XmCR_PAGE_DECREMENT:
5289 bar->dragging = -1;
5290 part = horizontal ? scroll_bar_before_handle : scroll_bar_above_handle;
5291 break;
5293 case XmCR_PAGE_INCREMENT:
5294 bar->dragging = -1;
5295 part = horizontal ? scroll_bar_after_handle : scroll_bar_below_handle;
5296 break;
5298 case XmCR_TO_TOP:
5299 bar->dragging = -1;
5300 part = horizontal ? scroll_bar_to_leftmost : scroll_bar_to_top;
5301 break;
5303 case XmCR_TO_BOTTOM:
5304 bar->dragging = -1;
5305 part = horizontal ? scroll_bar_to_rightmost : scroll_bar_to_bottom;
5306 break;
5308 case XmCR_DRAG:
5310 int slider_size;
5312 block_input ();
5313 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
5314 unblock_input ();
5316 if (horizontal)
5318 portion = bar->whole * ((float)cs->value / XM_SB_MAX);
5319 whole = bar->whole * ((float)(XM_SB_MAX - slider_size) / XM_SB_MAX);
5320 portion = min (portion, whole);
5321 part = scroll_bar_horizontal_handle;
5323 else
5325 whole = XM_SB_MAX - slider_size;
5326 portion = min (cs->value, whole);
5327 part = scroll_bar_handle;
5330 bar->dragging = cs->value;
5332 break;
5334 case XmCR_VALUE_CHANGED:
5335 break;
5338 if (part != scroll_bar_nowhere)
5340 window_being_scrolled = bar->window;
5341 x_send_scroll_bar_event (bar->window, part, portion, whole,
5342 bar->horizontal);
5346 #elif defined USE_GTK
5348 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
5349 bar widget. DATA is a pointer to the scroll_bar structure. */
5351 static gboolean
5352 xg_scroll_callback (GtkRange *range,
5353 GtkScrollType scroll,
5354 gdouble value,
5355 gpointer user_data)
5357 int whole = 0, portion = 0;
5358 struct scroll_bar *bar = user_data;
5359 enum scroll_bar_part part = scroll_bar_nowhere;
5360 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (range));
5361 struct frame *f = g_object_get_data (G_OBJECT (range), XG_FRAME_DATA);
5363 if (xg_ignore_gtk_scrollbar) return false;
5365 switch (scroll)
5367 case GTK_SCROLL_JUMP:
5368 /* Buttons 1 2 or 3 must be grabbed. */
5369 if (FRAME_DISPLAY_INFO (f)->grabbed != 0
5370 && FRAME_DISPLAY_INFO (f)->grabbed < (1 << 4))
5372 if (bar->horizontal)
5374 part = scroll_bar_horizontal_handle;
5375 whole = (int)(gtk_adjustment_get_upper (adj) -
5376 gtk_adjustment_get_page_size (adj));
5377 portion = min ((int)value, whole);
5378 bar->dragging = portion;
5380 else
5382 part = scroll_bar_handle;
5383 whole = gtk_adjustment_get_upper (adj) -
5384 gtk_adjustment_get_page_size (adj);
5385 portion = min ((int)value, whole);
5386 bar->dragging = portion;
5389 break;
5390 case GTK_SCROLL_STEP_BACKWARD:
5391 part = (bar->horizontal
5392 ? scroll_bar_left_arrow : scroll_bar_up_arrow);
5393 bar->dragging = -1;
5394 break;
5395 case GTK_SCROLL_STEP_FORWARD:
5396 part = (bar->horizontal
5397 ? scroll_bar_right_arrow : scroll_bar_down_arrow);
5398 bar->dragging = -1;
5399 break;
5400 case GTK_SCROLL_PAGE_BACKWARD:
5401 part = (bar->horizontal
5402 ? scroll_bar_before_handle : scroll_bar_above_handle);
5403 bar->dragging = -1;
5404 break;
5405 case GTK_SCROLL_PAGE_FORWARD:
5406 part = (bar->horizontal
5407 ? scroll_bar_after_handle : scroll_bar_below_handle);
5408 bar->dragging = -1;
5409 break;
5412 if (part != scroll_bar_nowhere)
5414 window_being_scrolled = bar->window;
5415 x_send_scroll_bar_event (bar->window, part, portion, whole,
5416 bar->horizontal);
5419 return false;
5422 /* Callback for button release. Sets dragging to -1 when dragging is done. */
5424 static gboolean
5425 xg_end_scroll_callback (GtkWidget *widget,
5426 GdkEventButton *event,
5427 gpointer user_data)
5429 struct scroll_bar *bar = user_data;
5430 bar->dragging = -1;
5431 if (WINDOWP (window_being_scrolled))
5433 x_send_scroll_bar_event (window_being_scrolled,
5434 scroll_bar_end_scroll, 0, 0, bar->horizontal);
5435 window_being_scrolled = Qnil;
5438 return false;
5442 #else /* not USE_GTK and not USE_MOTIF */
5444 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
5445 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
5446 scroll bar struct. CALL_DATA is a pointer to a float saying where
5447 the thumb is. */
5449 static void
5450 xaw_jump_callback (Widget widget, XtPointer client_data, XtPointer call_data)
5452 struct scroll_bar *bar = client_data;
5453 float *top_addr = call_data;
5454 float top = *top_addr;
5455 float shown;
5456 int whole, portion, height, width;
5457 enum scroll_bar_part part;
5458 bool horizontal = bar->horizontal;
5461 if (horizontal)
5463 /* Get the size of the thumb, a value between 0 and 1. */
5464 block_input ();
5465 XtVaGetValues (widget, XtNshown, &shown, XtNwidth, &width, NULL);
5466 unblock_input ();
5468 if (shown < 1)
5470 whole = bar->whole - (shown * bar->whole);
5471 portion = min (top * bar->whole, whole);
5473 else
5475 whole = bar->whole;
5476 portion = 0;
5479 part = scroll_bar_horizontal_handle;
5481 else
5483 /* Get the size of the thumb, a value between 0 and 1. */
5484 block_input ();
5485 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
5486 unblock_input ();
5488 whole = 10000000;
5489 portion = shown < 1 ? top * whole : 0;
5491 if (shown < 1 && (eabs (top + shown - 1) < 1.0f / height))
5492 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
5493 the bottom, so we force the scrolling whenever we see that we're
5494 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
5495 we try to ensure that we always stay two pixels away from the
5496 bottom). */
5497 part = scroll_bar_down_arrow;
5498 else
5499 part = scroll_bar_handle;
5502 window_being_scrolled = bar->window;
5503 bar->dragging = portion;
5504 bar->last_seen_part = part;
5505 x_send_scroll_bar_event (bar->window, part, portion, whole, bar->horizontal);
5509 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
5510 i.e. line or page up or down. WIDGET is the Xaw scroll bar
5511 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
5512 the scroll bar. CALL_DATA is an integer specifying the action that
5513 has taken place. Its magnitude is in the range 0..height of the
5514 scroll bar. Negative values mean scroll towards buffer start.
5515 Values < height of scroll bar mean line-wise movement. */
5517 static void
5518 xaw_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
5520 struct scroll_bar *bar = client_data;
5521 /* The position really is stored cast to a pointer. */
5522 int position = (intptr_t) call_data;
5523 Dimension height, width;
5524 enum scroll_bar_part part;
5526 if (bar->horizontal)
5528 /* Get the width of the scroll bar. */
5529 block_input ();
5530 XtVaGetValues (widget, XtNwidth, &width, NULL);
5531 unblock_input ();
5533 if (eabs (position) >= width)
5534 part = (position < 0) ? scroll_bar_before_handle : scroll_bar_after_handle;
5536 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
5537 it maps line-movement to call_data = max(5, height/20). */
5538 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, width / 20))
5539 part = (position < 0) ? scroll_bar_left_arrow : scroll_bar_right_arrow;
5540 else
5541 part = scroll_bar_move_ratio;
5543 window_being_scrolled = bar->window;
5544 bar->dragging = -1;
5545 bar->last_seen_part = part;
5546 x_send_scroll_bar_event (bar->window, part, position, width,
5547 bar->horizontal);
5549 else
5552 /* Get the height of the scroll bar. */
5553 block_input ();
5554 XtVaGetValues (widget, XtNheight, &height, NULL);
5555 unblock_input ();
5557 if (eabs (position) >= height)
5558 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
5560 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
5561 it maps line-movement to call_data = max(5, height/20). */
5562 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
5563 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
5564 else
5565 part = scroll_bar_move_ratio;
5567 window_being_scrolled = bar->window;
5568 bar->dragging = -1;
5569 bar->last_seen_part = part;
5570 x_send_scroll_bar_event (bar->window, part, position, height,
5571 bar->horizontal);
5575 #endif /* not USE_GTK and not USE_MOTIF */
5577 #define SCROLL_BAR_NAME "verticalScrollBar"
5578 #define SCROLL_BAR_HORIZONTAL_NAME "horizontalScrollBar"
5580 /* Create the widget for scroll bar BAR on frame F. Record the widget
5581 and X window of the scroll bar in BAR. */
5583 #ifdef USE_GTK
5584 static void
5585 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
5587 const char *scroll_bar_name = SCROLL_BAR_NAME;
5589 block_input ();
5590 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
5591 G_CALLBACK (xg_end_scroll_callback),
5592 scroll_bar_name);
5593 unblock_input ();
5596 static void
5597 x_create_horizontal_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
5599 const char *scroll_bar_name = SCROLL_BAR_HORIZONTAL_NAME;
5601 block_input ();
5602 xg_create_horizontal_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
5603 G_CALLBACK (xg_end_scroll_callback),
5604 scroll_bar_name);
5605 unblock_input ();
5608 #else /* not USE_GTK */
5610 static void
5611 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
5613 Window xwindow;
5614 Widget widget;
5615 Arg av[20];
5616 int ac = 0;
5617 const char *scroll_bar_name = SCROLL_BAR_NAME;
5618 unsigned long pixel;
5620 block_input ();
5622 #ifdef USE_MOTIF
5623 /* Set resources. Create the widget. */
5624 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
5625 XtSetArg (av[ac], XmNminimum, 0); ++ac;
5626 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
5627 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
5628 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
5629 XtSetArg (av[ac], XmNincrement, 1); ++ac;
5630 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
5632 pixel = f->output_data.x->scroll_bar_foreground_pixel;
5633 if (pixel != -1)
5635 XtSetArg (av[ac], XmNforeground, pixel);
5636 ++ac;
5639 pixel = f->output_data.x->scroll_bar_background_pixel;
5640 if (pixel != -1)
5642 XtSetArg (av[ac], XmNbackground, pixel);
5643 ++ac;
5646 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
5647 (char *) scroll_bar_name, av, ac);
5649 /* Add one callback for everything that can happen. */
5650 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
5651 (XtPointer) bar);
5652 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
5653 (XtPointer) bar);
5654 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
5655 (XtPointer) bar);
5656 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
5657 (XtPointer) bar);
5658 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
5659 (XtPointer) bar);
5660 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
5661 (XtPointer) bar);
5662 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
5663 (XtPointer) bar);
5665 /* Realize the widget. Only after that is the X window created. */
5666 XtRealizeWidget (widget);
5668 /* Set the cursor to an arrow. I didn't find a resource to do that.
5669 And I'm wondering why it hasn't an arrow cursor by default. */
5670 XDefineCursor (XtDisplay (widget), XtWindow (widget),
5671 f->output_data.x->nontext_cursor);
5673 #else /* !USE_MOTIF i.e. use Xaw */
5675 /* Set resources. Create the widget. The background of the
5676 Xaw3d scroll bar widget is a little bit light for my taste.
5677 We don't alter it here to let users change it according
5678 to their taste with `emacs*verticalScrollBar.background: xxx'. */
5679 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
5680 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
5681 /* For smoother scrolling with Xaw3d -sm */
5682 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
5684 pixel = f->output_data.x->scroll_bar_foreground_pixel;
5685 if (pixel != -1)
5687 XtSetArg (av[ac], XtNforeground, pixel);
5688 ++ac;
5691 pixel = f->output_data.x->scroll_bar_background_pixel;
5692 if (pixel != -1)
5694 XtSetArg (av[ac], XtNbackground, pixel);
5695 ++ac;
5698 /* Top/bottom shadow colors. */
5700 /* Allocate them, if necessary. */
5701 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
5703 pixel = f->output_data.x->scroll_bar_background_pixel;
5704 if (pixel != -1)
5706 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
5707 FRAME_X_COLORMAP (f),
5708 &pixel, 1.2, 0x8000))
5709 pixel = -1;
5710 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
5713 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
5715 pixel = f->output_data.x->scroll_bar_background_pixel;
5716 if (pixel != -1)
5718 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
5719 FRAME_X_COLORMAP (f),
5720 &pixel, 0.6, 0x4000))
5721 pixel = -1;
5722 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
5726 #ifdef XtNbeNiceToColormap
5727 /* Tell the toolkit about them. */
5728 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
5729 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
5730 /* We tried to allocate a color for the top/bottom shadow, and
5731 failed, so tell Xaw3d to use dithering instead. */
5732 /* But only if we have a small colormap. Xaw3d can allocate nice
5733 colors itself. */
5735 XtSetArg (av[ac], XtNbeNiceToColormap,
5736 DefaultDepthOfScreen (FRAME_X_SCREEN (f)) < 16);
5737 ++ac;
5739 else
5740 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
5741 be more consistent with other emacs 3d colors, and since Xaw3d is
5742 not good at dealing with allocation failure. */
5744 /* This tells Xaw3d to use real colors instead of dithering for
5745 the shadows. */
5746 XtSetArg (av[ac], XtNbeNiceToColormap, False);
5747 ++ac;
5749 /* Specify the colors. */
5750 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
5751 if (pixel != -1)
5753 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
5754 ++ac;
5756 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
5757 if (pixel != -1)
5759 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
5760 ++ac;
5763 #endif
5765 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
5766 f->output_data.x->edit_widget, av, ac);
5769 char const *initial = "";
5770 char const *val = initial;
5771 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
5772 #ifdef XtNarrowScrollbars
5773 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
5774 #endif
5775 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
5776 if (xaw3d_arrow_scroll || val == initial)
5777 { /* ARROW_SCROLL */
5778 xaw3d_arrow_scroll = True;
5779 /* Isn't that just a personal preference ? --Stef */
5780 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
5784 /* Define callbacks. */
5785 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
5786 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
5787 (XtPointer) bar);
5789 /* Realize the widget. Only after that is the X window created. */
5790 XtRealizeWidget (widget);
5792 #endif /* !USE_MOTIF */
5794 /* Install an action hook that lets us detect when the user
5795 finishes interacting with a scroll bar. */
5796 if (action_hook_id == 0)
5797 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
5799 /* Remember X window and widget in the scroll bar vector. */
5800 SET_SCROLL_BAR_X_WIDGET (bar, widget);
5801 xwindow = XtWindow (widget);
5802 bar->x_window = xwindow;
5803 bar->whole = 1;
5804 bar->horizontal = false;
5806 unblock_input ();
5809 static void
5810 x_create_horizontal_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
5812 Window xwindow;
5813 Widget widget;
5814 Arg av[20];
5815 int ac = 0;
5816 const char *scroll_bar_name = SCROLL_BAR_HORIZONTAL_NAME;
5817 unsigned long pixel;
5819 block_input ();
5821 #ifdef USE_MOTIF
5822 /* Set resources. Create the widget. */
5823 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
5824 XtSetArg (av[ac], XmNminimum, 0); ++ac;
5825 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
5826 XtSetArg (av[ac], XmNorientation, XmHORIZONTAL); ++ac;
5827 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_RIGHT), ++ac;
5828 XtSetArg (av[ac], XmNincrement, 1); ++ac;
5829 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
5831 pixel = f->output_data.x->scroll_bar_foreground_pixel;
5832 if (pixel != -1)
5834 XtSetArg (av[ac], XmNforeground, pixel);
5835 ++ac;
5838 pixel = f->output_data.x->scroll_bar_background_pixel;
5839 if (pixel != -1)
5841 XtSetArg (av[ac], XmNbackground, pixel);
5842 ++ac;
5845 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
5846 (char *) scroll_bar_name, av, ac);
5848 /* Add one callback for everything that can happen. */
5849 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
5850 (XtPointer) bar);
5851 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
5852 (XtPointer) bar);
5853 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
5854 (XtPointer) bar);
5855 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
5856 (XtPointer) bar);
5857 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
5858 (XtPointer) bar);
5859 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
5860 (XtPointer) bar);
5861 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
5862 (XtPointer) bar);
5864 /* Realize the widget. Only after that is the X window created. */
5865 XtRealizeWidget (widget);
5867 /* Set the cursor to an arrow. I didn't find a resource to do that.
5868 And I'm wondering why it hasn't an arrow cursor by default. */
5869 XDefineCursor (XtDisplay (widget), XtWindow (widget),
5870 f->output_data.x->nontext_cursor);
5872 #else /* !USE_MOTIF i.e. use Xaw */
5874 /* Set resources. Create the widget. The background of the
5875 Xaw3d scroll bar widget is a little bit light for my taste.
5876 We don't alter it here to let users change it according
5877 to their taste with `emacs*verticalScrollBar.background: xxx'. */
5878 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
5879 XtSetArg (av[ac], XtNorientation, XtorientHorizontal); ++ac;
5880 /* For smoother scrolling with Xaw3d -sm */
5881 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
5883 pixel = f->output_data.x->scroll_bar_foreground_pixel;
5884 if (pixel != -1)
5886 XtSetArg (av[ac], XtNforeground, pixel);
5887 ++ac;
5890 pixel = f->output_data.x->scroll_bar_background_pixel;
5891 if (pixel != -1)
5893 XtSetArg (av[ac], XtNbackground, pixel);
5894 ++ac;
5897 /* Top/bottom shadow colors. */
5899 /* Allocate them, if necessary. */
5900 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
5902 pixel = f->output_data.x->scroll_bar_background_pixel;
5903 if (pixel != -1)
5905 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
5906 FRAME_X_COLORMAP (f),
5907 &pixel, 1.2, 0x8000))
5908 pixel = -1;
5909 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
5912 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
5914 pixel = f->output_data.x->scroll_bar_background_pixel;
5915 if (pixel != -1)
5917 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
5918 FRAME_X_COLORMAP (f),
5919 &pixel, 0.6, 0x4000))
5920 pixel = -1;
5921 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
5925 #ifdef XtNbeNiceToColormap
5926 /* Tell the toolkit about them. */
5927 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
5928 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
5929 /* We tried to allocate a color for the top/bottom shadow, and
5930 failed, so tell Xaw3d to use dithering instead. */
5931 /* But only if we have a small colormap. Xaw3d can allocate nice
5932 colors itself. */
5934 XtSetArg (av[ac], XtNbeNiceToColormap,
5935 DefaultDepthOfScreen (FRAME_X_SCREEN (f)) < 16);
5936 ++ac;
5938 else
5939 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
5940 be more consistent with other emacs 3d colors, and since Xaw3d is
5941 not good at dealing with allocation failure. */
5943 /* This tells Xaw3d to use real colors instead of dithering for
5944 the shadows. */
5945 XtSetArg (av[ac], XtNbeNiceToColormap, False);
5946 ++ac;
5948 /* Specify the colors. */
5949 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
5950 if (pixel != -1)
5952 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
5953 ++ac;
5955 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
5956 if (pixel != -1)
5958 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
5959 ++ac;
5962 #endif
5964 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
5965 f->output_data.x->edit_widget, av, ac);
5968 char const *initial = "";
5969 char const *val = initial;
5970 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
5971 #ifdef XtNarrowScrollbars
5972 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
5973 #endif
5974 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
5975 if (xaw3d_arrow_scroll || val == initial)
5976 { /* ARROW_SCROLL */
5977 xaw3d_arrow_scroll = True;
5978 /* Isn't that just a personal preference ? --Stef */
5979 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
5983 /* Define callbacks. */
5984 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
5985 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
5986 (XtPointer) bar);
5988 /* Realize the widget. Only after that is the X window created. */
5989 XtRealizeWidget (widget);
5991 #endif /* !USE_MOTIF */
5993 /* Install an action hook that lets us detect when the user
5994 finishes interacting with a scroll bar. */
5995 if (horizontal_action_hook_id == 0)
5996 horizontal_action_hook_id
5997 = XtAppAddActionHook (Xt_app_con, xt_horizontal_action_hook, 0);
5999 /* Remember X window and widget in the scroll bar vector. */
6000 SET_SCROLL_BAR_X_WIDGET (bar, widget);
6001 xwindow = XtWindow (widget);
6002 bar->x_window = xwindow;
6003 bar->whole = 1;
6004 bar->horizontal = true;
6006 unblock_input ();
6008 #endif /* not USE_GTK */
6011 /* Set the thumb size and position of scroll bar BAR. We are currently
6012 displaying PORTION out of a whole WHOLE, and our position POSITION. */
6014 #ifdef USE_GTK
6015 static void
6016 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position, int whole)
6018 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
6021 static void
6022 x_set_toolkit_horizontal_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position, int whole)
6024 xg_set_toolkit_horizontal_scroll_bar_thumb (bar, portion, position, whole);
6027 #else /* not USE_GTK */
6028 static void
6029 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position,
6030 int whole)
6032 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
6033 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
6034 float top, shown;
6036 block_input ();
6038 #ifdef USE_MOTIF
6040 if (scroll_bar_adjust_thumb_portion_p)
6042 /* We use an estimate of 30 chars per line rather than the real
6043 `portion' value. This has the disadvantage that the thumb size
6044 is not very representative, but it makes our life a lot easier.
6045 Otherwise, we have to constantly adjust the thumb size, which
6046 we can't always do quickly enough: while dragging, the size of
6047 the thumb might prevent the user from dragging the thumb all the
6048 way to the end. but Motif and some versions of Xaw3d don't allow
6049 updating the thumb size while dragging. Also, even if we can update
6050 its size, the update will often happen too late.
6051 If you don't believe it, check out revision 1.650 of xterm.c to see
6052 what hoops we were going through and the still poor behavior we got. */
6053 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
6054 /* When the thumb is at the bottom, position == whole.
6055 So we need to increase `whole' to make space for the thumb. */
6056 whole += portion;
6059 if (whole <= 0)
6060 top = 0, shown = 1;
6061 else
6063 top = (float) position / whole;
6064 shown = (float) portion / whole;
6067 if (bar->dragging == -1)
6069 int size, value;
6071 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
6072 is the scroll bar's maximum and MIN is the scroll bar's minimum
6073 value. */
6074 size = clip_to_bounds (1, shown * XM_SB_MAX, XM_SB_MAX);
6076 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
6077 value = top * XM_SB_MAX;
6078 value = min (value, XM_SB_MAX - size);
6080 XmScrollBarSetValues (widget, value, size, 0, 0, False);
6082 #else /* !USE_MOTIF i.e. use Xaw */
6084 if (whole == 0)
6085 top = 0, shown = 1;
6086 else
6088 top = (float) position / whole;
6089 shown = (float) portion / whole;
6093 float old_top, old_shown;
6094 Dimension height;
6095 XtVaGetValues (widget,
6096 XtNtopOfThumb, &old_top,
6097 XtNshown, &old_shown,
6098 XtNheight, &height,
6099 NULL);
6101 /* Massage the top+shown values. */
6102 if (bar->dragging == -1 || bar->last_seen_part == scroll_bar_down_arrow)
6103 top = max (0, min (1, top));
6104 else
6105 top = old_top;
6106 #if ! defined (HAVE_XAW3D)
6107 /* With Xaw, 'top' values too closer to 1.0 may
6108 cause the thumb to disappear. Fix that. */
6109 top = min (top, 0.99f);
6110 #endif
6111 /* Keep two pixels available for moving the thumb down. */
6112 shown = max (0, min (1 - top - (2.0f / height), shown));
6113 #if ! defined (HAVE_XAW3D)
6114 /* Likewise with too small 'shown'. */
6115 shown = max (shown, 0.01f);
6116 #endif
6118 /* If the call to XawScrollbarSetThumb below doesn't seem to
6119 work, check that 'NARROWPROTO' is defined in src/config.h.
6120 If this is not so, most likely you need to fix configure. */
6121 if (top != old_top || shown != old_shown)
6123 if (bar->dragging == -1)
6124 XawScrollbarSetThumb (widget, top, shown);
6125 else
6127 /* Try to make the scrolling a tad smoother. */
6128 if (!xaw3d_pick_top)
6129 shown = min (shown, old_shown);
6131 XawScrollbarSetThumb (widget, top, shown);
6135 #endif /* !USE_MOTIF */
6137 unblock_input ();
6140 static void
6141 x_set_toolkit_horizontal_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position,
6142 int whole)
6144 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
6145 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
6146 float top, shown;
6148 block_input ();
6150 #ifdef USE_MOTIF
6151 bar->whole = whole;
6152 shown = (float) portion / whole;
6153 top = (float) position / (whole - portion);
6155 int size = clip_to_bounds (1, shown * XM_SB_MAX, XM_SB_MAX);
6156 int value = clip_to_bounds (0, top * (XM_SB_MAX - size), XM_SB_MAX - size);
6158 XmScrollBarSetValues (widget, value, size, 0, 0, False);
6160 #else /* !USE_MOTIF i.e. use Xaw */
6161 bar->whole = whole;
6162 if (whole == 0)
6163 top = 0, shown = 1;
6164 else
6166 top = (float) position / whole;
6167 shown = (float) portion / whole;
6171 float old_top, old_shown;
6172 Dimension height;
6173 XtVaGetValues (widget,
6174 XtNtopOfThumb, &old_top,
6175 XtNshown, &old_shown,
6176 XtNheight, &height,
6177 NULL);
6179 #if false
6180 /* Massage the top+shown values. */
6181 if (bar->dragging == -1 || bar->last_seen_part == scroll_bar_down_arrow)
6182 top = max (0, min (1, top));
6183 else
6184 top = old_top;
6185 #if ! defined (HAVE_XAW3D)
6186 /* With Xaw, 'top' values too closer to 1.0 may
6187 cause the thumb to disappear. Fix that. */
6188 top = min (top, 0.99f);
6189 #endif
6190 /* Keep two pixels available for moving the thumb down. */
6191 shown = max (0, min (1 - top - (2.0f / height), shown));
6192 #if ! defined (HAVE_XAW3D)
6193 /* Likewise with too small 'shown'. */
6194 shown = max (shown, 0.01f);
6195 #endif
6196 #endif
6198 /* If the call to XawScrollbarSetThumb below doesn't seem to
6199 work, check that 'NARROWPROTO' is defined in src/config.h.
6200 If this is not so, most likely you need to fix configure. */
6201 XawScrollbarSetThumb (widget, top, shown);
6202 #if false
6203 if (top != old_top || shown != old_shown)
6205 if (bar->dragging == -1)
6206 XawScrollbarSetThumb (widget, top, shown);
6207 else
6209 /* Try to make the scrolling a tad smoother. */
6210 if (!xaw3d_pick_top)
6211 shown = min (shown, old_shown);
6213 XawScrollbarSetThumb (widget, top, shown);
6216 #endif
6218 #endif /* !USE_MOTIF */
6220 unblock_input ();
6222 #endif /* not USE_GTK */
6224 #endif /* USE_TOOLKIT_SCROLL_BARS */
6228 /************************************************************************
6229 Scroll bars, general
6230 ************************************************************************/
6232 /* Create a scroll bar and return the scroll bar vector for it. W is
6233 the Emacs window on which to create the scroll bar. TOP, LEFT,
6234 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
6235 scroll bar. */
6237 static struct scroll_bar *
6238 x_scroll_bar_create (struct window *w, int top, int left,
6239 int width, int height, bool horizontal)
6241 struct frame *f = XFRAME (w->frame);
6242 struct scroll_bar *bar
6243 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
6244 Lisp_Object barobj;
6246 block_input ();
6248 #ifdef USE_TOOLKIT_SCROLL_BARS
6249 if (horizontal)
6250 x_create_horizontal_toolkit_scroll_bar (f, bar);
6251 else
6252 x_create_toolkit_scroll_bar (f, bar);
6253 #else /* not USE_TOOLKIT_SCROLL_BARS */
6255 XSetWindowAttributes a;
6256 unsigned long mask;
6257 Window window;
6259 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
6260 if (a.background_pixel == -1)
6261 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
6263 a.event_mask = (ButtonPressMask | ButtonReleaseMask
6264 | ButtonMotionMask | PointerMotionHintMask
6265 | ExposureMask);
6266 a.cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
6268 mask = (CWBackPixel | CWEventMask | CWCursor);
6270 /* Clear the area of W that will serve as a scroll bar. This is
6271 for the case that a window has been split horizontally. In
6272 this case, no clear_frame is generated to reduce flickering. */
6273 if (width > 0 && window_box_height (w) > 0)
6274 x_clear_area (f, left, top, width, window_box_height (w));
6276 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
6277 /* Position and size of scroll bar. */
6278 left, top, width, height,
6279 /* Border width, depth, class, and visual. */
6281 CopyFromParent,
6282 CopyFromParent,
6283 CopyFromParent,
6284 /* Attributes. */
6285 mask, &a);
6286 bar->x_window = window;
6288 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6290 XSETWINDOW (bar->window, w);
6291 bar->top = top;
6292 bar->left = left;
6293 bar->width = width;
6294 bar->height = height;
6295 bar->start = 0;
6296 bar->end = 0;
6297 bar->dragging = -1;
6298 bar->horizontal = horizontal;
6299 #if defined (USE_TOOLKIT_SCROLL_BARS) && defined (USE_LUCID)
6300 bar->last_seen_part = scroll_bar_nowhere;
6301 #endif
6303 /* Add bar to its frame's list of scroll bars. */
6304 bar->next = FRAME_SCROLL_BARS (f);
6305 bar->prev = Qnil;
6306 XSETVECTOR (barobj, bar);
6307 fset_scroll_bars (f, barobj);
6308 if (!NILP (bar->next))
6309 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
6311 /* Map the window/widget. */
6312 #ifdef USE_TOOLKIT_SCROLL_BARS
6314 #ifdef USE_GTK
6315 if (horizontal)
6316 xg_update_horizontal_scrollbar_pos (f, bar->x_window, top,
6317 left, width, max (height, 1));
6318 else
6319 xg_update_scrollbar_pos (f, bar->x_window, top,
6320 left, width, max (height, 1));
6321 #else /* not USE_GTK */
6322 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
6323 XtConfigureWidget (scroll_bar, left, top, width, max (height, 1), 0);
6324 XtMapWidget (scroll_bar);
6325 #endif /* not USE_GTK */
6327 #else /* not USE_TOOLKIT_SCROLL_BARS */
6328 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
6329 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6331 unblock_input ();
6332 return bar;
6336 #ifndef USE_TOOLKIT_SCROLL_BARS
6338 /* Draw BAR's handle in the proper position.
6340 If the handle is already drawn from START to END, don't bother
6341 redrawing it, unless REBUILD; in that case, always
6342 redraw it. (REBUILD is handy for drawing the handle after expose
6343 events.)
6345 Normally, we want to constrain the start and end of the handle to
6346 fit inside its rectangle, but if the user is dragging the scroll
6347 bar handle, we want to let them drag it down all the way, so that
6348 the bar's top is as far down as it goes; otherwise, there's no way
6349 to move to the very end of the buffer. */
6351 static void
6352 x_scroll_bar_set_handle (struct scroll_bar *bar, int start, int end,
6353 bool rebuild)
6355 bool dragging = bar->dragging != -1;
6356 Window w = bar->x_window;
6357 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
6358 GC gc = f->output_data.x->normal_gc;
6360 /* If the display is already accurate, do nothing. */
6361 if (! rebuild
6362 && start == bar->start
6363 && end == bar->end)
6364 return;
6366 block_input ();
6369 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
6370 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
6371 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
6373 /* Make sure the values are reasonable, and try to preserve
6374 the distance between start and end. */
6376 int length = end - start;
6378 if (start < 0)
6379 start = 0;
6380 else if (start > top_range)
6381 start = top_range;
6382 end = start + length;
6384 if (end < start)
6385 end = start;
6386 else if (end > top_range && ! dragging)
6387 end = top_range;
6390 /* Store the adjusted setting in the scroll bar. */
6391 bar->start = start;
6392 bar->end = end;
6394 /* Clip the end position, just for display. */
6395 if (end > top_range)
6396 end = top_range;
6398 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
6399 below top positions, to make sure the handle is always at least
6400 that many pixels tall. */
6401 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
6403 /* Draw the empty space above the handle. Note that we can't clear
6404 zero-height areas; that means "clear to end of window." */
6405 if ((inside_width > 0) && (start > 0))
6406 x_clear_area1 (FRAME_X_DISPLAY (f), w,
6407 VERTICAL_SCROLL_BAR_LEFT_BORDER,
6408 VERTICAL_SCROLL_BAR_TOP_BORDER,
6409 inside_width, start, False);
6411 /* Change to proper foreground color if one is specified. */
6412 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
6413 XSetForeground (FRAME_X_DISPLAY (f), gc,
6414 f->output_data.x->scroll_bar_foreground_pixel);
6416 /* Draw the handle itself. */
6417 XFillRectangle (FRAME_X_DISPLAY (f), w, gc,
6418 /* x, y, width, height */
6419 VERTICAL_SCROLL_BAR_LEFT_BORDER,
6420 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
6421 inside_width, end - start);
6423 /* Restore the foreground color of the GC if we changed it above. */
6424 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
6425 XSetForeground (FRAME_X_DISPLAY (f), gc,
6426 FRAME_FOREGROUND_PIXEL (f));
6428 /* Draw the empty space below the handle. Note that we can't
6429 clear zero-height areas; that means "clear to end of window." */
6430 if ((inside_width > 0) && (end < inside_height))
6431 x_clear_area1 (FRAME_X_DISPLAY (f), w,
6432 VERTICAL_SCROLL_BAR_LEFT_BORDER,
6433 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
6434 inside_width, inside_height - end, False);
6437 unblock_input ();
6440 #endif /* !USE_TOOLKIT_SCROLL_BARS */
6442 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
6443 nil. */
6445 static void
6446 x_scroll_bar_remove (struct scroll_bar *bar)
6448 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
6449 block_input ();
6451 #ifdef USE_TOOLKIT_SCROLL_BARS
6452 #ifdef USE_GTK
6453 xg_remove_scroll_bar (f, bar->x_window);
6454 #else /* not USE_GTK */
6455 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
6456 #endif /* not USE_GTK */
6457 #else
6458 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
6459 #endif
6461 /* Dissociate this scroll bar from its window. */
6462 if (bar->horizontal)
6463 wset_horizontal_scroll_bar (XWINDOW (bar->window), Qnil);
6464 else
6465 wset_vertical_scroll_bar (XWINDOW (bar->window), Qnil);
6467 unblock_input ();
6471 /* Set the handle of the vertical scroll bar for WINDOW to indicate
6472 that we are displaying PORTION characters out of a total of WHOLE
6473 characters, starting at POSITION. If WINDOW has no scroll bar,
6474 create one. */
6476 static void
6477 XTset_vertical_scroll_bar (struct window *w, int portion, int whole, int position)
6479 struct frame *f = XFRAME (w->frame);
6480 Lisp_Object barobj;
6481 struct scroll_bar *bar;
6482 int top, height, left, width;
6483 int window_y, window_height;
6485 /* Get window dimensions. */
6486 window_box (w, ANY_AREA, 0, &window_y, 0, &window_height);
6487 top = window_y;
6488 height = window_height;
6489 left = WINDOW_SCROLL_BAR_AREA_X (w);
6490 width = WINDOW_SCROLL_BAR_AREA_WIDTH (w);
6492 /* Does the scroll bar exist yet? */
6493 if (NILP (w->vertical_scroll_bar))
6495 if (width > 0 && height > 0)
6497 block_input ();
6498 x_clear_area (f, left, top, width, height);
6499 unblock_input ();
6502 bar = x_scroll_bar_create (w, top, left, width, max (height, 1), false);
6504 else
6506 /* It may just need to be moved and resized. */
6507 unsigned int mask = 0;
6509 bar = XSCROLL_BAR (w->vertical_scroll_bar);
6511 block_input ();
6513 if (left != bar->left)
6514 mask |= CWX;
6515 if (top != bar->top)
6516 mask |= CWY;
6517 if (width != bar->width)
6518 mask |= CWWidth;
6519 if (height != bar->height)
6520 mask |= CWHeight;
6522 #ifdef USE_TOOLKIT_SCROLL_BARS
6524 /* Move/size the scroll bar widget. */
6525 if (mask)
6527 /* Since toolkit scroll bars are smaller than the space reserved
6528 for them on the frame, we have to clear "under" them. */
6529 if (width > 0 && height > 0)
6530 x_clear_area (f, left, top, width, height);
6531 #ifdef USE_GTK
6532 xg_update_scrollbar_pos (f, bar->x_window, top,
6533 left, width, max (height, 1));
6534 #else /* not USE_GTK */
6535 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
6536 left, top, width, max (height, 1), 0);
6537 #endif /* not USE_GTK */
6539 #else /* not USE_TOOLKIT_SCROLL_BARS */
6541 /* Move/size the scroll bar window. */
6542 if (mask)
6544 XWindowChanges wc;
6546 wc.x = left;
6547 wc.y = top;
6548 wc.width = width;
6549 wc.height = height;
6550 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
6551 mask, &wc);
6554 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6556 /* Remember new settings. */
6557 bar->left = left;
6558 bar->top = top;
6559 bar->width = width;
6560 bar->height = height;
6562 unblock_input ();
6565 #ifdef USE_TOOLKIT_SCROLL_BARS
6566 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
6567 #else /* not USE_TOOLKIT_SCROLL_BARS */
6568 /* Set the scroll bar's current state, unless we're currently being
6569 dragged. */
6570 if (bar->dragging == -1)
6572 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
6574 if (whole == 0)
6575 x_scroll_bar_set_handle (bar, 0, top_range, false);
6576 else
6578 int start = ((double) position * top_range) / whole;
6579 int end = ((double) (position + portion) * top_range) / whole;
6580 x_scroll_bar_set_handle (bar, start, end, false);
6583 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6585 XSETVECTOR (barobj, bar);
6586 wset_vertical_scroll_bar (w, barobj);
6590 static void
6591 XTset_horizontal_scroll_bar (struct window *w, int portion, int whole, int position)
6593 struct frame *f = XFRAME (w->frame);
6594 Lisp_Object barobj;
6595 struct scroll_bar *bar;
6596 int top, height, left, width;
6597 int window_x, window_width;
6598 int pixel_width = WINDOW_PIXEL_WIDTH (w);
6600 /* Get window dimensions. */
6601 window_box (w, ANY_AREA, &window_x, 0, &window_width, 0);
6602 left = window_x;
6603 width = window_width;
6604 top = WINDOW_SCROLL_BAR_AREA_Y (w);
6605 height = WINDOW_SCROLL_BAR_AREA_HEIGHT (w);
6607 /* Does the scroll bar exist yet? */
6608 if (NILP (w->horizontal_scroll_bar))
6610 if (width > 0 && height > 0)
6612 block_input ();
6614 /* Clear also part between window_width and
6615 WINDOW_PIXEL_WIDTH. */
6616 x_clear_area (f, left, top, pixel_width, height);
6617 unblock_input ();
6620 bar = x_scroll_bar_create (w, top, left, width, height, true);
6622 else
6624 /* It may just need to be moved and resized. */
6625 unsigned int mask = 0;
6627 bar = XSCROLL_BAR (w->horizontal_scroll_bar);
6629 block_input ();
6631 if (left != bar->left)
6632 mask |= CWX;
6633 if (top != bar->top)
6634 mask |= CWY;
6635 if (width != bar->width)
6636 mask |= CWWidth;
6637 if (height != bar->height)
6638 mask |= CWHeight;
6640 #ifdef USE_TOOLKIT_SCROLL_BARS
6641 /* Move/size the scroll bar widget. */
6642 if (mask)
6644 /* Since toolkit scroll bars are smaller than the space reserved
6645 for them on the frame, we have to clear "under" them. */
6646 if (width > 0 && height > 0)
6647 x_clear_area (f,
6648 WINDOW_LEFT_EDGE_X (w), top,
6649 pixel_width - WINDOW_RIGHT_DIVIDER_WIDTH (w), height);
6650 #ifdef USE_GTK
6651 xg_update_horizontal_scrollbar_pos (f, bar->x_window, top, left,
6652 width, height);
6653 #else /* not USE_GTK */
6654 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
6655 left, top, width, height, 0);
6656 #endif /* not USE_GTK */
6658 #else /* not USE_TOOLKIT_SCROLL_BARS */
6660 /* Clear areas not covered by the scroll bar because it's not as
6661 wide as the area reserved for it. This makes sure a
6662 previous mode line display is cleared after C-x 2 C-x 1, for
6663 example. */
6665 int area_height = WINDOW_CONFIG_SCROLL_BAR_HEIGHT (w);
6666 int rest = area_height - height;
6667 if (rest > 0 && width > 0)
6668 x_clear_area (f, left, top, width, rest);
6671 /* Move/size the scroll bar window. */
6672 if (mask)
6674 XWindowChanges wc;
6676 wc.x = left;
6677 wc.y = top;
6678 wc.width = width;
6679 wc.height = height;
6680 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
6681 mask, &wc);
6684 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6686 /* Remember new settings. */
6687 bar->left = left;
6688 bar->top = top;
6689 bar->width = width;
6690 bar->height = height;
6692 unblock_input ();
6695 #ifdef USE_TOOLKIT_SCROLL_BARS
6696 x_set_toolkit_horizontal_scroll_bar_thumb (bar, portion, position, whole);
6697 #else /* not USE_TOOLKIT_SCROLL_BARS */
6698 /* Set the scroll bar's current state, unless we're currently being
6699 dragged. */
6700 if (bar->dragging == -1)
6702 int left_range = HORIZONTAL_SCROLL_BAR_LEFT_RANGE (f, width);
6704 if (whole == 0)
6705 x_scroll_bar_set_handle (bar, 0, left_range, false);
6706 else
6708 int start = ((double) position * left_range) / whole;
6709 int end = ((double) (position + portion) * left_range) / whole;
6710 x_scroll_bar_set_handle (bar, start, end, false);
6713 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6715 XSETVECTOR (barobj, bar);
6716 wset_horizontal_scroll_bar (w, barobj);
6720 /* The following three hooks are used when we're doing a thorough
6721 redisplay of the frame. We don't explicitly know which scroll bars
6722 are going to be deleted, because keeping track of when windows go
6723 away is a real pain - "Can you say set-window-configuration, boys
6724 and girls?" Instead, we just assert at the beginning of redisplay
6725 that *all* scroll bars are to be removed, and then save a scroll bar
6726 from the fiery pit when we actually redisplay its window. */
6728 /* Arrange for all scroll bars on FRAME to be removed at the next call
6729 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
6730 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
6732 static void
6733 XTcondemn_scroll_bars (struct frame *frame)
6735 if (!NILP (FRAME_SCROLL_BARS (frame)))
6737 if (!NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
6739 /* Prepend scrollbars to already condemned ones. */
6740 Lisp_Object last = FRAME_SCROLL_BARS (frame);
6742 while (!NILP (XSCROLL_BAR (last)->next))
6743 last = XSCROLL_BAR (last)->next;
6745 XSCROLL_BAR (last)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
6746 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = last;
6749 fset_condemned_scroll_bars (frame, FRAME_SCROLL_BARS (frame));
6750 fset_scroll_bars (frame, Qnil);
6755 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
6756 Note that WINDOW isn't necessarily condemned at all. */
6758 static void
6759 XTredeem_scroll_bar (struct window *w)
6761 struct scroll_bar *bar;
6762 Lisp_Object barobj;
6763 struct frame *f;
6765 /* We can't redeem this window's scroll bar if it doesn't have one. */
6766 if (NILP (w->vertical_scroll_bar) && NILP (w->horizontal_scroll_bar))
6767 emacs_abort ();
6769 if (!NILP (w->vertical_scroll_bar) && WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
6771 bar = XSCROLL_BAR (w->vertical_scroll_bar);
6772 /* Unlink it from the condemned list. */
6773 f = XFRAME (WINDOW_FRAME (w));
6774 if (NILP (bar->prev))
6776 /* If the prev pointer is nil, it must be the first in one of
6777 the lists. */
6778 if (EQ (FRAME_SCROLL_BARS (f), w->vertical_scroll_bar))
6779 /* It's not condemned. Everything's fine. */
6780 goto horizontal;
6781 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
6782 w->vertical_scroll_bar))
6783 fset_condemned_scroll_bars (f, bar->next);
6784 else
6785 /* If its prev pointer is nil, it must be at the front of
6786 one or the other! */
6787 emacs_abort ();
6789 else
6790 XSCROLL_BAR (bar->prev)->next = bar->next;
6792 if (! NILP (bar->next))
6793 XSCROLL_BAR (bar->next)->prev = bar->prev;
6795 bar->next = FRAME_SCROLL_BARS (f);
6796 bar->prev = Qnil;
6797 XSETVECTOR (barobj, bar);
6798 fset_scroll_bars (f, barobj);
6799 if (! NILP (bar->next))
6800 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
6803 horizontal:
6804 if (!NILP (w->horizontal_scroll_bar) && WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w))
6806 bar = XSCROLL_BAR (w->horizontal_scroll_bar);
6807 /* Unlink it from the condemned list. */
6808 f = XFRAME (WINDOW_FRAME (w));
6809 if (NILP (bar->prev))
6811 /* If the prev pointer is nil, it must be the first in one of
6812 the lists. */
6813 if (EQ (FRAME_SCROLL_BARS (f), w->horizontal_scroll_bar))
6814 /* It's not condemned. Everything's fine. */
6815 return;
6816 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
6817 w->horizontal_scroll_bar))
6818 fset_condemned_scroll_bars (f, bar->next);
6819 else
6820 /* If its prev pointer is nil, it must be at the front of
6821 one or the other! */
6822 emacs_abort ();
6824 else
6825 XSCROLL_BAR (bar->prev)->next = bar->next;
6827 if (! NILP (bar->next))
6828 XSCROLL_BAR (bar->next)->prev = bar->prev;
6830 bar->next = FRAME_SCROLL_BARS (f);
6831 bar->prev = Qnil;
6832 XSETVECTOR (barobj, bar);
6833 fset_scroll_bars (f, barobj);
6834 if (! NILP (bar->next))
6835 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
6839 /* Remove all scroll bars on FRAME that haven't been saved since the
6840 last call to `*condemn_scroll_bars_hook'. */
6842 static void
6843 XTjudge_scroll_bars (struct frame *f)
6845 Lisp_Object bar, next;
6847 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
6849 /* Clear out the condemned list now so we won't try to process any
6850 more events on the hapless scroll bars. */
6851 fset_condemned_scroll_bars (f, Qnil);
6853 for (; ! NILP (bar); bar = next)
6855 struct scroll_bar *b = XSCROLL_BAR (bar);
6857 x_scroll_bar_remove (b);
6859 next = b->next;
6860 b->next = b->prev = Qnil;
6863 /* Now there should be no references to the condemned scroll bars,
6864 and they should get garbage-collected. */
6868 #ifndef USE_TOOLKIT_SCROLL_BARS
6869 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
6870 is a no-op when using toolkit scroll bars.
6872 This may be called from a signal handler, so we have to ignore GC
6873 mark bits. */
6875 static void
6876 x_scroll_bar_expose (struct scroll_bar *bar, const XEvent *event)
6878 Window w = bar->x_window;
6879 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
6880 GC gc = f->output_data.x->normal_gc;
6882 block_input ();
6884 x_scroll_bar_set_handle (bar, bar->start, bar->end, true);
6886 /* Switch to scroll bar foreground color. */
6887 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
6888 XSetForeground (FRAME_X_DISPLAY (f), gc,
6889 f->output_data.x->scroll_bar_foreground_pixel);
6891 /* Draw a one-pixel border just inside the edges of the scroll bar. */
6892 XDrawRectangle (FRAME_X_DISPLAY (f), w, gc,
6893 /* x, y, width, height */
6894 0, 0, bar->width - 1, bar->height - 1);
6896 /* Restore the foreground color of the GC if we changed it above. */
6897 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
6898 XSetForeground (FRAME_X_DISPLAY (f), gc,
6899 FRAME_FOREGROUND_PIXEL (f));
6901 unblock_input ();
6904 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6906 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
6907 is set to something other than NO_EVENT, it is enqueued.
6909 This may be called from a signal handler, so we have to ignore GC
6910 mark bits. */
6913 static void
6914 x_scroll_bar_handle_click (struct scroll_bar *bar,
6915 const XEvent *event,
6916 struct input_event *emacs_event)
6918 if (! WINDOWP (bar->window))
6919 emacs_abort ();
6921 emacs_event->kind = (bar->horizontal
6922 ? HORIZONTAL_SCROLL_BAR_CLICK_EVENT
6923 : SCROLL_BAR_CLICK_EVENT);
6924 emacs_event->code = event->xbutton.button - Button1;
6925 emacs_event->modifiers
6926 = (x_x_to_emacs_modifiers (FRAME_DISPLAY_INFO
6927 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
6928 event->xbutton.state)
6929 | (event->type == ButtonRelease
6930 ? up_modifier
6931 : down_modifier));
6932 emacs_event->frame_or_window = bar->window;
6933 emacs_event->arg = Qnil;
6934 emacs_event->timestamp = event->xbutton.time;
6935 if (bar->horizontal)
6937 int left_range
6938 = HORIZONTAL_SCROLL_BAR_LEFT_RANGE (f, bar->width);
6939 int x = event->xbutton.x - HORIZONTAL_SCROLL_BAR_LEFT_BORDER;
6941 if (x < 0) x = 0;
6942 if (x > left_range) x = left_range;
6944 if (x < bar->start)
6945 emacs_event->part = scroll_bar_before_handle;
6946 else if (x < bar->end + HORIZONTAL_SCROLL_BAR_MIN_HANDLE)
6947 emacs_event->part = scroll_bar_horizontal_handle;
6948 else
6949 emacs_event->part = scroll_bar_after_handle;
6951 #ifndef USE_TOOLKIT_SCROLL_BARS
6952 /* If the user has released the handle, set it to its final position. */
6953 if (event->type == ButtonRelease && bar->dragging != -1)
6955 int new_start = - bar->dragging;
6956 int new_end = new_start + bar->end - bar->start;
6958 x_scroll_bar_set_handle (bar, new_start, new_end, false);
6959 bar->dragging = -1;
6961 #endif
6963 XSETINT (emacs_event->x, left_range);
6964 XSETINT (emacs_event->y, x);
6966 else
6968 int top_range
6969 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
6970 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
6972 if (y < 0) y = 0;
6973 if (y > top_range) y = top_range;
6975 if (y < bar->start)
6976 emacs_event->part = scroll_bar_above_handle;
6977 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
6978 emacs_event->part = scroll_bar_handle;
6979 else
6980 emacs_event->part = scroll_bar_below_handle;
6982 #ifndef USE_TOOLKIT_SCROLL_BARS
6983 /* If the user has released the handle, set it to its final position. */
6984 if (event->type == ButtonRelease && bar->dragging != -1)
6986 int new_start = y - bar->dragging;
6987 int new_end = new_start + bar->end - bar->start;
6989 x_scroll_bar_set_handle (bar, new_start, new_end, false);
6990 bar->dragging = -1;
6992 #endif
6994 XSETINT (emacs_event->x, y);
6995 XSETINT (emacs_event->y, top_range);
6999 #ifndef USE_TOOLKIT_SCROLL_BARS
7001 /* Handle some mouse motion while someone is dragging the scroll bar.
7003 This may be called from a signal handler, so we have to ignore GC
7004 mark bits. */
7006 static void
7007 x_scroll_bar_note_movement (struct scroll_bar *bar,
7008 const XMotionEvent *event)
7010 struct frame *f = XFRAME (XWINDOW (bar->window)->frame);
7011 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
7013 dpyinfo->last_mouse_movement_time = event->time;
7014 dpyinfo->last_mouse_scroll_bar = bar;
7015 f->mouse_moved = true;
7017 /* If we're dragging the bar, display it. */
7018 if (bar->dragging != -1)
7020 /* Where should the handle be now? */
7021 int new_start = event->y - bar->dragging;
7023 if (new_start != bar->start)
7025 int new_end = new_start + bar->end - bar->start;
7027 x_scroll_bar_set_handle (bar, new_start, new_end, false);
7032 #endif /* !USE_TOOLKIT_SCROLL_BARS */
7034 /* Return information to the user about the current position of the mouse
7035 on the scroll bar. */
7037 static void
7038 x_scroll_bar_report_motion (struct frame **fp, Lisp_Object *bar_window,
7039 enum scroll_bar_part *part, Lisp_Object *x,
7040 Lisp_Object *y, Time *timestamp)
7042 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (*fp);
7043 struct scroll_bar *bar = dpyinfo->last_mouse_scroll_bar;
7044 Window w = bar->x_window;
7045 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
7046 int win_x, win_y;
7047 Window dummy_window;
7048 int dummy_coord;
7049 unsigned int dummy_mask;
7051 block_input ();
7053 /* Get the mouse's position relative to the scroll bar window, and
7054 report that. */
7055 if (XQueryPointer (FRAME_X_DISPLAY (f), w,
7057 /* Root, child, root x and root y. */
7058 &dummy_window, &dummy_window,
7059 &dummy_coord, &dummy_coord,
7061 /* Position relative to scroll bar. */
7062 &win_x, &win_y,
7064 /* Mouse buttons and modifier keys. */
7065 &dummy_mask))
7067 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
7069 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
7071 if (bar->dragging != -1)
7072 win_y -= bar->dragging;
7074 if (win_y < 0)
7075 win_y = 0;
7076 if (win_y > top_range)
7077 win_y = top_range;
7079 *fp = f;
7080 *bar_window = bar->window;
7082 if (bar->dragging != -1)
7083 *part = scroll_bar_handle;
7084 else if (win_y < bar->start)
7085 *part = scroll_bar_above_handle;
7086 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
7087 *part = scroll_bar_handle;
7088 else
7089 *part = scroll_bar_below_handle;
7091 XSETINT (*x, win_y);
7092 XSETINT (*y, top_range);
7094 f->mouse_moved = false;
7095 dpyinfo->last_mouse_scroll_bar = NULL;
7096 *timestamp = dpyinfo->last_mouse_movement_time;
7099 unblock_input ();
7103 /* Return information to the user about the current position of the mouse
7104 on the scroll bar. */
7106 static void
7107 x_horizontal_scroll_bar_report_motion (struct frame **fp, Lisp_Object *bar_window,
7108 enum scroll_bar_part *part, Lisp_Object *x,
7109 Lisp_Object *y, Time *timestamp)
7111 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (*fp);
7112 struct scroll_bar *bar = dpyinfo->last_mouse_scroll_bar;
7113 Window w = bar->x_window;
7114 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
7115 int win_x, win_y;
7116 Window dummy_window;
7117 int dummy_coord;
7118 unsigned int dummy_mask;
7120 block_input ();
7122 /* Get the mouse's position relative to the scroll bar window, and
7123 report that. */
7124 if (XQueryPointer (FRAME_X_DISPLAY (f), w,
7126 /* Root, child, root x and root y. */
7127 &dummy_window, &dummy_window,
7128 &dummy_coord, &dummy_coord,
7130 /* Position relative to scroll bar. */
7131 &win_x, &win_y,
7133 /* Mouse buttons and modifier keys. */
7134 &dummy_mask))
7136 int left_range = HORIZONTAL_SCROLL_BAR_LEFT_RANGE (f, bar->width);
7138 win_x -= HORIZONTAL_SCROLL_BAR_LEFT_BORDER;
7140 if (bar->dragging != -1)
7141 win_x -= bar->dragging;
7143 if (win_x < 0)
7144 win_x = 0;
7145 if (win_x > left_range)
7146 win_x = left_range;
7148 *fp = f;
7149 *bar_window = bar->window;
7151 if (bar->dragging != -1)
7152 *part = scroll_bar_horizontal_handle;
7153 else if (win_x < bar->start)
7154 *part = scroll_bar_before_handle;
7155 else if (win_x < bar->end + HORIZONTAL_SCROLL_BAR_MIN_HANDLE)
7156 *part = scroll_bar_handle;
7157 else
7158 *part = scroll_bar_after_handle;
7160 XSETINT (*y, win_x);
7161 XSETINT (*x, left_range);
7163 f->mouse_moved = false;
7164 dpyinfo->last_mouse_scroll_bar = NULL;
7165 *timestamp = dpyinfo->last_mouse_movement_time;
7168 unblock_input ();
7172 /* The screen has been cleared so we may have changed foreground or
7173 background colors, and the scroll bars may need to be redrawn.
7174 Clear out the scroll bars, and ask for expose events, so we can
7175 redraw them. */
7177 static void
7178 x_scroll_bar_clear (struct frame *f)
7180 #ifndef USE_TOOLKIT_SCROLL_BARS
7181 Lisp_Object bar;
7183 /* We can have scroll bars even if this is 0,
7184 if we just turned off scroll bar mode.
7185 But in that case we should not clear them. */
7186 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
7187 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
7188 bar = XSCROLL_BAR (bar)->next)
7189 XClearArea (FRAME_X_DISPLAY (f),
7190 XSCROLL_BAR (bar)->x_window,
7191 0, 0, 0, 0, True);
7192 #endif /* not USE_TOOLKIT_SCROLL_BARS */
7195 #ifdef ENABLE_CHECKING
7197 /* Record the last 100 characters stored
7198 to help debug the loss-of-chars-during-GC problem. */
7200 static int temp_index;
7201 static short temp_buffer[100];
7203 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
7204 if (temp_index == ARRAYELTS (temp_buffer)) \
7205 temp_index = 0; \
7206 temp_buffer[temp_index++] = (keysym)
7208 #else /* not ENABLE_CHECKING */
7210 #define STORE_KEYSYM_FOR_DEBUG(keysym) ((void)0)
7212 #endif /* ENABLE_CHECKING */
7214 /* Set this to nonzero to fake an "X I/O error"
7215 on a particular display. */
7217 static struct x_display_info *XTread_socket_fake_io_error;
7219 /* When we find no input here, we occasionally do a no-op command
7220 to verify that the X server is still running and we can still talk with it.
7221 We try all the open displays, one by one.
7222 This variable is used for cycling thru the displays. */
7224 static struct x_display_info *next_noop_dpyinfo;
7226 enum
7228 X_EVENT_NORMAL,
7229 X_EVENT_GOTO_OUT,
7230 X_EVENT_DROP
7233 /* Filter events for the current X input method.
7234 DPYINFO is the display this event is for.
7235 EVENT is the X event to filter.
7237 Returns non-zero if the event was filtered, caller shall not process
7238 this event further.
7239 Returns zero if event is wasn't filtered. */
7241 #ifdef HAVE_X_I18N
7242 static int
7243 x_filter_event (struct x_display_info *dpyinfo, XEvent *event)
7245 /* XFilterEvent returns non-zero if the input method has
7246 consumed the event. We pass the frame's X window to
7247 XFilterEvent because that's the one for which the IC
7248 was created. */
7250 struct frame *f1 = x_any_window_to_frame (dpyinfo,
7251 event->xclient.window);
7253 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
7255 #endif
7257 #ifdef USE_GTK
7258 static int current_count;
7259 static int current_finish;
7260 static struct input_event *current_hold_quit;
7262 /* This is the filter function invoked by the GTK event loop.
7263 It is invoked before the XEvent is translated to a GdkEvent,
7264 so we have a chance to act on the event before GTK. */
7265 static GdkFilterReturn
7266 event_handler_gdk (GdkXEvent *gxev, GdkEvent *ev, gpointer data)
7268 XEvent *xev = (XEvent *) gxev;
7270 block_input ();
7271 if (current_count >= 0)
7273 struct x_display_info *dpyinfo;
7275 dpyinfo = x_display_info_for_display (xev->xany.display);
7277 #ifdef HAVE_X_I18N
7278 /* Filter events for the current X input method.
7279 GTK calls XFilterEvent but not for key press and release,
7280 so we do it here. */
7281 if ((xev->type == KeyPress || xev->type == KeyRelease)
7282 && dpyinfo
7283 && x_filter_event (dpyinfo, xev))
7285 unblock_input ();
7286 return GDK_FILTER_REMOVE;
7288 #endif
7290 if (! dpyinfo)
7291 current_finish = X_EVENT_NORMAL;
7292 else
7293 current_count
7294 += handle_one_xevent (dpyinfo, xev, &current_finish,
7295 current_hold_quit);
7297 else
7298 current_finish = x_dispatch_event (xev, xev->xany.display);
7300 unblock_input ();
7302 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
7303 return GDK_FILTER_REMOVE;
7305 return GDK_FILTER_CONTINUE;
7307 #endif /* USE_GTK */
7310 static void xembed_send_message (struct frame *f, Time,
7311 enum xembed_message,
7312 long detail, long data1, long data2);
7314 static void
7315 x_net_wm_state (struct frame *f, Window window)
7317 int value = FULLSCREEN_NONE;
7318 Lisp_Object lval = Qnil;
7319 bool sticky = false;
7321 get_current_wm_state (f, window, &value, &sticky);
7323 switch (value)
7325 case FULLSCREEN_WIDTH:
7326 lval = Qfullwidth;
7327 break;
7328 case FULLSCREEN_HEIGHT:
7329 lval = Qfullheight;
7330 break;
7331 case FULLSCREEN_BOTH:
7332 lval = Qfullboth;
7333 break;
7334 case FULLSCREEN_MAXIMIZED:
7335 lval = Qmaximized;
7336 break;
7339 frame_size_history_add
7340 (f, Qx_net_wm_state, 0, 0,
7341 list2 (get_frame_param (f, Qfullscreen), lval));
7343 store_frame_param (f, Qfullscreen, lval);
7344 /** store_frame_param (f, Qsticky, sticky ? Qt : Qnil); **/
7347 /* Handles the XEvent EVENT on display DPYINFO.
7349 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
7350 *FINISH is zero if caller should continue reading events.
7351 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
7352 *EVENT is unchanged unless we're processing KeyPress event.
7354 We return the number of characters stored into the buffer. */
7356 static int
7357 handle_one_xevent (struct x_display_info *dpyinfo,
7358 const XEvent *event,
7359 int *finish, struct input_event *hold_quit)
7361 union {
7362 struct input_event ie;
7363 struct selection_input_event sie;
7364 } inev;
7365 int count = 0;
7366 int do_help = 0;
7367 ptrdiff_t nbytes = 0;
7368 struct frame *any, *f = NULL;
7369 struct coding_system coding;
7370 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
7371 /* This holds the state XLookupString needs to implement dead keys
7372 and other tricks known as "compose processing". _X Window System_
7373 says that a portable program can't use this, but Stephen Gildea assures
7374 me that letting the compiler initialize it to zeros will work okay. */
7375 static XComposeStatus compose_status;
7377 USE_SAFE_ALLOCA;
7379 *finish = X_EVENT_NORMAL;
7381 EVENT_INIT (inev.ie);
7382 inev.ie.kind = NO_EVENT;
7383 inev.ie.arg = Qnil;
7385 any = x_any_window_to_frame (dpyinfo, event->xany.window);
7387 if (any && any->wait_event_type == event->type)
7388 any->wait_event_type = 0; /* Indicates we got it. */
7390 switch (event->type)
7392 case ClientMessage:
7394 if (event->xclient.message_type == dpyinfo->Xatom_wm_protocols
7395 && event->xclient.format == 32)
7397 if (event->xclient.data.l[0] == dpyinfo->Xatom_wm_take_focus)
7399 /* Use the value returned by x_any_window_to_frame
7400 because this could be the shell widget window
7401 if the frame has no title bar. */
7402 f = any;
7403 #ifdef HAVE_X_I18N
7404 /* Not quite sure this is needed -pd */
7405 if (f && FRAME_XIC (f))
7406 XSetICFocus (FRAME_XIC (f));
7407 #endif
7408 #if false
7409 /* Emacs sets WM hints whose `input' field is `true'. This
7410 instructs the WM to set the input focus automatically for
7411 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
7412 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
7413 it has set the focus. So, XSetInputFocus below is not
7414 needed.
7416 The call to XSetInputFocus below has also caused trouble. In
7417 cases where the XSetInputFocus done by the WM and the one
7418 below are temporally close (on a fast machine), the call
7419 below can generate additional FocusIn events which confuse
7420 Emacs. */
7422 /* Since we set WM_TAKE_FOCUS, we must call
7423 XSetInputFocus explicitly. But not if f is null,
7424 since that might be an event for a deleted frame. */
7425 if (f)
7427 Display *d = event->xclient.display;
7428 /* Catch and ignore errors, in case window has been
7429 iconified by a window manager such as GWM. */
7430 x_catch_errors (d);
7431 XSetInputFocus (d, event->xclient.window,
7432 /* The ICCCM says this is
7433 the only valid choice. */
7434 RevertToParent,
7435 event->xclient.data.l[1]);
7436 /* This is needed to detect the error
7437 if there is an error. */
7438 XSync (d, False);
7439 x_uncatch_errors ();
7441 /* Not certain about handling scroll bars here */
7442 #endif
7443 goto done;
7446 if (event->xclient.data.l[0] == dpyinfo->Xatom_wm_save_yourself)
7448 /* Save state modify the WM_COMMAND property to
7449 something which can reinstate us. This notifies
7450 the session manager, who's looking for such a
7451 PropertyNotify. Can restart processing when
7452 a keyboard or mouse event arrives. */
7453 /* If we have a session manager, don't set this.
7454 KDE will then start two Emacsen, one for the
7455 session manager and one for this. */
7456 #ifdef HAVE_X_SM
7457 if (! x_session_have_connection ())
7458 #endif
7460 f = x_top_window_to_frame (dpyinfo,
7461 event->xclient.window);
7462 /* This is just so we only give real data once
7463 for a single Emacs process. */
7464 if (f == SELECTED_FRAME ())
7465 XSetCommand (FRAME_X_DISPLAY (f),
7466 event->xclient.window,
7467 initial_argv, initial_argc);
7468 else if (f)
7469 XSetCommand (FRAME_X_DISPLAY (f),
7470 event->xclient.window,
7471 0, 0);
7473 goto done;
7476 if (event->xclient.data.l[0] == dpyinfo->Xatom_wm_delete_window)
7478 f = any;
7479 if (!f)
7480 goto OTHER; /* May be a dialog that is to be removed */
7482 inev.ie.kind = DELETE_WINDOW_EVENT;
7483 XSETFRAME (inev.ie.frame_or_window, f);
7484 goto done;
7487 goto done;
7490 if (event->xclient.message_type == dpyinfo->Xatom_wm_configure_denied)
7491 goto done;
7493 if (event->xclient.message_type == dpyinfo->Xatom_wm_window_moved)
7495 int new_x, new_y;
7496 f = x_window_to_frame (dpyinfo, event->xclient.window);
7498 new_x = event->xclient.data.s[0];
7499 new_y = event->xclient.data.s[1];
7501 if (f)
7503 f->left_pos = new_x;
7504 f->top_pos = new_y;
7506 goto done;
7509 #ifdef HACK_EDITRES
7510 if (event->xclient.message_type == dpyinfo->Xatom_editres)
7512 f = any;
7513 if (f)
7514 _XEditResCheckMessages (f->output_data.x->widget,
7515 NULL, (XEvent *) event, NULL);
7516 goto done;
7518 #endif /* HACK_EDITRES */
7520 if (event->xclient.message_type == dpyinfo->Xatom_DONE
7521 || event->xclient.message_type == dpyinfo->Xatom_PAGE)
7523 /* Ghostview job completed. Kill it. We could
7524 reply with "Next" if we received "Page", but we
7525 currently never do because we are interested in
7526 images, only, which should have 1 page. */
7527 Pixmap pixmap = (Pixmap) event->xclient.data.l[1];
7528 f = x_window_to_frame (dpyinfo, event->xclient.window);
7529 if (!f)
7530 goto OTHER;
7531 x_kill_gs_process (pixmap, f);
7532 expose_frame (f, 0, 0, 0, 0);
7533 goto done;
7536 #ifdef USE_TOOLKIT_SCROLL_BARS
7537 /* Scroll bar callbacks send a ClientMessage from which
7538 we construct an input_event. */
7539 if (event->xclient.message_type == dpyinfo->Xatom_Scrollbar)
7541 x_scroll_bar_to_input_event (event, &inev.ie);
7542 *finish = X_EVENT_GOTO_OUT;
7543 goto done;
7545 else if (event->xclient.message_type == dpyinfo->Xatom_Horizontal_Scrollbar)
7547 x_horizontal_scroll_bar_to_input_event (event, &inev.ie);
7548 *finish = X_EVENT_GOTO_OUT;
7549 goto done;
7551 #endif /* USE_TOOLKIT_SCROLL_BARS */
7553 /* XEmbed messages from the embedder (if any). */
7554 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
7556 enum xembed_message msg = event->xclient.data.l[1];
7557 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
7558 x_detect_focus_change (dpyinfo, any, event, &inev.ie);
7560 *finish = X_EVENT_GOTO_OUT;
7561 goto done;
7564 xft_settings_event (dpyinfo, event);
7566 f = any;
7567 if (!f)
7568 goto OTHER;
7569 if (x_handle_dnd_message (f, &event->xclient, dpyinfo, &inev.ie))
7570 *finish = X_EVENT_DROP;
7572 break;
7574 case SelectionNotify:
7575 x_display_set_last_user_time (dpyinfo, event->xselection.time);
7576 #ifdef USE_X_TOOLKIT
7577 if (! x_window_to_frame (dpyinfo, event->xselection.requestor))
7578 goto OTHER;
7579 #endif /* not USE_X_TOOLKIT */
7580 x_handle_selection_notify (&event->xselection);
7581 break;
7583 case SelectionClear: /* Someone has grabbed ownership. */
7584 x_display_set_last_user_time (dpyinfo, event->xselectionclear.time);
7585 #ifdef USE_X_TOOLKIT
7586 if (! x_window_to_frame (dpyinfo, event->xselectionclear.window))
7587 goto OTHER;
7588 #endif /* USE_X_TOOLKIT */
7590 const XSelectionClearEvent *eventp = &event->xselectionclear;
7592 inev.ie.kind = SELECTION_CLEAR_EVENT;
7593 SELECTION_EVENT_DPYINFO (&inev.sie) = dpyinfo;
7594 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
7595 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
7597 break;
7599 case SelectionRequest: /* Someone wants our selection. */
7600 x_display_set_last_user_time (dpyinfo, event->xselectionrequest.time);
7601 #ifdef USE_X_TOOLKIT
7602 if (!x_window_to_frame (dpyinfo, event->xselectionrequest.owner))
7603 goto OTHER;
7604 #endif /* USE_X_TOOLKIT */
7606 const XSelectionRequestEvent *eventp = &event->xselectionrequest;
7608 inev.ie.kind = SELECTION_REQUEST_EVENT;
7609 SELECTION_EVENT_DPYINFO (&inev.sie) = dpyinfo;
7610 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
7611 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
7612 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
7613 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
7614 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
7616 break;
7618 case PropertyNotify:
7619 x_display_set_last_user_time (dpyinfo, event->xproperty.time);
7620 f = x_top_window_to_frame (dpyinfo, event->xproperty.window);
7621 if (f && event->xproperty.atom == dpyinfo->Xatom_net_wm_state)
7623 bool not_hidden = x_handle_net_wm_state (f, &event->xproperty);
7624 if (not_hidden && FRAME_ICONIFIED_P (f))
7626 /* Gnome shell does not iconify us when C-z is pressed.
7627 It hides the frame. So if our state says we aren't
7628 hidden anymore, treat it as deiconified. */
7629 SET_FRAME_VISIBLE (f, 1);
7630 SET_FRAME_ICONIFIED (f, false);
7631 f->output_data.x->has_been_visible = true;
7632 inev.ie.kind = DEICONIFY_EVENT;
7633 XSETFRAME (inev.ie.frame_or_window, f);
7635 else if (! not_hidden && ! FRAME_ICONIFIED_P (f))
7637 SET_FRAME_VISIBLE (f, 0);
7638 SET_FRAME_ICONIFIED (f, true);
7639 inev.ie.kind = ICONIFY_EVENT;
7640 XSETFRAME (inev.ie.frame_or_window, f);
7644 x_handle_property_notify (&event->xproperty);
7645 xft_settings_event (dpyinfo, event);
7646 goto OTHER;
7648 case ReparentNotify:
7649 f = x_top_window_to_frame (dpyinfo, event->xreparent.window);
7650 if (f)
7652 f->output_data.x->parent_desc = event->xreparent.parent;
7653 x_real_positions (f, &f->left_pos, &f->top_pos);
7655 /* Perhaps reparented due to a WM restart. Reset this. */
7656 FRAME_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
7657 FRAME_DISPLAY_INFO (f)->net_supported_window = 0;
7659 x_set_frame_alpha (f);
7661 goto OTHER;
7663 case Expose:
7664 f = x_window_to_frame (dpyinfo, event->xexpose.window);
7665 if (f)
7667 if (!FRAME_VISIBLE_P (f))
7669 SET_FRAME_VISIBLE (f, 1);
7670 SET_FRAME_ICONIFIED (f, false);
7671 f->output_data.x->has_been_visible = true;
7672 SET_FRAME_GARBAGED (f);
7674 else
7676 #ifdef USE_GTK
7677 /* This seems to be needed for GTK 2.6 and later, see
7678 http://debbugs.gnu.org/cgi/bugreport.cgi?bug=15398. */
7679 x_clear_area (f,
7680 event->xexpose.x, event->xexpose.y,
7681 event->xexpose.width, event->xexpose.height);
7682 #endif
7683 expose_frame (f, event->xexpose.x, event->xexpose.y,
7684 event->xexpose.width, event->xexpose.height);
7687 else
7689 #ifndef USE_TOOLKIT_SCROLL_BARS
7690 struct scroll_bar *bar;
7691 #endif
7692 #if defined USE_LUCID
7693 /* Submenus of the Lucid menu bar aren't widgets
7694 themselves, so there's no way to dispatch events
7695 to them. Recognize this case separately. */
7697 Widget widget = x_window_to_menu_bar (event->xexpose.window);
7698 if (widget)
7699 xlwmenu_redisplay (widget);
7701 #endif /* USE_LUCID */
7703 #ifdef USE_TOOLKIT_SCROLL_BARS
7704 /* Dispatch event to the widget. */
7705 goto OTHER;
7706 #else /* not USE_TOOLKIT_SCROLL_BARS */
7707 bar = x_window_to_scroll_bar (event->xexpose.display,
7708 event->xexpose.window, 2);
7710 if (bar)
7711 x_scroll_bar_expose (bar, event);
7712 #ifdef USE_X_TOOLKIT
7713 else
7714 goto OTHER;
7715 #endif /* USE_X_TOOLKIT */
7716 #endif /* not USE_TOOLKIT_SCROLL_BARS */
7718 break;
7720 case GraphicsExpose: /* This occurs when an XCopyArea's
7721 source area was obscured or not
7722 available. */
7723 f = x_window_to_frame (dpyinfo, event->xgraphicsexpose.drawable);
7724 if (f)
7725 expose_frame (f, event->xgraphicsexpose.x,
7726 event->xgraphicsexpose.y,
7727 event->xgraphicsexpose.width,
7728 event->xgraphicsexpose.height);
7729 #ifdef USE_X_TOOLKIT
7730 else
7731 goto OTHER;
7732 #endif /* USE_X_TOOLKIT */
7733 break;
7735 case NoExpose: /* This occurs when an XCopyArea's
7736 source area was completely
7737 available. */
7738 break;
7740 case UnmapNotify:
7741 /* Redo the mouse-highlight after the tooltip has gone. */
7742 if (event->xunmap.window == tip_window)
7744 tip_window = 0;
7745 x_redo_mouse_highlight (dpyinfo);
7748 f = x_top_window_to_frame (dpyinfo, event->xunmap.window);
7749 if (f) /* F may no longer exist if
7750 the frame was deleted. */
7752 bool visible = FRAME_VISIBLE_P (f);
7753 /* While a frame is unmapped, display generation is
7754 disabled; you don't want to spend time updating a
7755 display that won't ever be seen. */
7756 SET_FRAME_VISIBLE (f, 0);
7757 /* We can't distinguish, from the event, whether the window
7758 has become iconified or invisible. So assume, if it
7759 was previously visible, than now it is iconified.
7760 But x_make_frame_invisible clears both
7761 the visible flag and the iconified flag;
7762 and that way, we know the window is not iconified now. */
7763 if (visible || FRAME_ICONIFIED_P (f))
7765 SET_FRAME_ICONIFIED (f, true);
7766 inev.ie.kind = ICONIFY_EVENT;
7767 XSETFRAME (inev.ie.frame_or_window, f);
7770 goto OTHER;
7772 case MapNotify:
7773 /* We use x_top_window_to_frame because map events can
7774 come for sub-windows and they don't mean that the
7775 frame is visible. */
7776 f = x_top_window_to_frame (dpyinfo, event->xmap.window);
7777 if (f)
7779 bool iconified = FRAME_ICONIFIED_P (f);
7781 /* Check if fullscreen was specified before we where mapped the
7782 first time, i.e. from the command line. */
7783 if (!f->output_data.x->has_been_visible)
7784 x_check_fullscreen (f);
7786 SET_FRAME_VISIBLE (f, 1);
7787 SET_FRAME_ICONIFIED (f, false);
7788 f->output_data.x->has_been_visible = true;
7790 if (iconified)
7792 inev.ie.kind = DEICONIFY_EVENT;
7793 XSETFRAME (inev.ie.frame_or_window, f);
7795 else if (! NILP (Vframe_list) && ! NILP (XCDR (Vframe_list)))
7796 /* Force a redisplay sooner or later to update the
7797 frame titles in case this is the second frame. */
7798 record_asynch_buffer_change ();
7800 #ifdef USE_GTK
7801 xg_frame_resized (f, -1, -1);
7802 #endif
7804 goto OTHER;
7806 case KeyPress:
7808 x_display_set_last_user_time (dpyinfo, event->xkey.time);
7809 ignore_next_mouse_click_timeout = 0;
7811 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
7812 /* Dispatch KeyPress events when in menu. */
7813 if (popup_activated ())
7814 goto OTHER;
7815 #endif
7817 f = any;
7819 /* If mouse-highlight is an integer, input clears out
7820 mouse highlighting. */
7821 if (!hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
7822 #if ! defined (USE_GTK)
7823 && (f == 0
7824 || !EQ (f->tool_bar_window, hlinfo->mouse_face_window))
7825 #endif
7828 clear_mouse_face (hlinfo);
7829 hlinfo->mouse_face_hidden = true;
7832 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
7833 if (f == 0)
7835 /* Scroll bars consume key events, but we want
7836 the keys to go to the scroll bar's frame. */
7837 Widget widget = XtWindowToWidget (dpyinfo->display,
7838 event->xkey.window);
7839 if (widget && XmIsScrollBar (widget))
7841 widget = XtParent (widget);
7842 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
7845 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
7847 if (f != 0)
7849 KeySym keysym, orig_keysym;
7850 /* al%imercury@uunet.uu.net says that making this 81
7851 instead of 80 fixed a bug whereby meta chars made
7852 his Emacs hang.
7854 It seems that some version of XmbLookupString has
7855 a bug of not returning XBufferOverflow in
7856 status_return even if the input is too long to
7857 fit in 81 bytes. So, we must prepare sufficient
7858 bytes for copy_buffer. 513 bytes (256 chars for
7859 two-byte character set) seems to be a fairly good
7860 approximation. -- 2000.8.10 handa@etl.go.jp */
7861 unsigned char copy_buffer[513];
7862 unsigned char *copy_bufptr = copy_buffer;
7863 int copy_bufsiz = sizeof (copy_buffer);
7864 int modifiers;
7865 Lisp_Object coding_system = Qlatin_1;
7866 Lisp_Object c;
7867 /* Event will be modified. */
7868 XKeyEvent xkey = event->xkey;
7870 #ifdef USE_GTK
7871 /* Don't pass keys to GTK. A Tab will shift focus to the
7872 tool bar in GTK 2.4. Keys will still go to menus and
7873 dialogs because in that case popup_activated is nonzero
7874 (see above). */
7875 *finish = X_EVENT_DROP;
7876 #endif
7878 xkey.state |= x_emacs_to_x_modifiers (FRAME_DISPLAY_INFO (f),
7879 extra_keyboard_modifiers);
7880 modifiers = xkey.state;
7882 /* This will have to go some day... */
7884 /* make_lispy_event turns chars into control chars.
7885 Don't do it here because XLookupString is too eager. */
7886 xkey.state &= ~ControlMask;
7887 xkey.state &= ~(dpyinfo->meta_mod_mask
7888 | dpyinfo->super_mod_mask
7889 | dpyinfo->hyper_mod_mask
7890 | dpyinfo->alt_mod_mask);
7892 /* In case Meta is ComposeCharacter,
7893 clear its status. According to Markus Ehrnsperger
7894 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
7895 this enables ComposeCharacter to work whether or
7896 not it is combined with Meta. */
7897 if (modifiers & dpyinfo->meta_mod_mask)
7898 memset (&compose_status, 0, sizeof (compose_status));
7900 #ifdef HAVE_X_I18N
7901 if (FRAME_XIC (f))
7903 Status status_return;
7905 coding_system = Vlocale_coding_system;
7906 nbytes = XmbLookupString (FRAME_XIC (f),
7907 &xkey, (char *) copy_bufptr,
7908 copy_bufsiz, &keysym,
7909 &status_return);
7910 if (status_return == XBufferOverflow)
7912 copy_bufsiz = nbytes + 1;
7913 copy_bufptr = alloca (copy_bufsiz);
7914 nbytes = XmbLookupString (FRAME_XIC (f),
7915 &xkey, (char *) copy_bufptr,
7916 copy_bufsiz, &keysym,
7917 &status_return);
7919 /* Xutf8LookupString is a new but already deprecated interface. -stef */
7920 if (status_return == XLookupNone)
7921 break;
7922 else if (status_return == XLookupChars)
7924 keysym = NoSymbol;
7925 modifiers = 0;
7927 else if (status_return != XLookupKeySym
7928 && status_return != XLookupBoth)
7929 emacs_abort ();
7931 else
7932 nbytes = XLookupString (&xkey, (char *) copy_bufptr,
7933 copy_bufsiz, &keysym,
7934 &compose_status);
7935 #else
7936 nbytes = XLookupString (&xkey, (char *) copy_bufptr,
7937 copy_bufsiz, &keysym,
7938 &compose_status);
7939 #endif
7941 /* If not using XIM/XIC, and a compose sequence is in progress,
7942 we break here. Otherwise, chars_matched is always 0. */
7943 if (compose_status.chars_matched > 0 && nbytes == 0)
7944 break;
7946 memset (&compose_status, 0, sizeof (compose_status));
7947 orig_keysym = keysym;
7949 /* Common for all keysym input events. */
7950 XSETFRAME (inev.ie.frame_or_window, f);
7951 inev.ie.modifiers
7952 = x_x_to_emacs_modifiers (FRAME_DISPLAY_INFO (f), modifiers);
7953 inev.ie.timestamp = xkey.time;
7955 /* First deal with keysyms which have defined
7956 translations to characters. */
7957 if (keysym >= 32 && keysym < 128)
7958 /* Avoid explicitly decoding each ASCII character. */
7960 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
7961 inev.ie.code = keysym;
7962 goto done_keysym;
7965 /* Keysyms directly mapped to Unicode characters. */
7966 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
7968 if (keysym < 0x01000080)
7969 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
7970 else
7971 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
7972 inev.ie.code = keysym & 0xFFFFFF;
7973 goto done_keysym;
7976 /* Now non-ASCII. */
7977 if (HASH_TABLE_P (Vx_keysym_table)
7978 && (c = Fgethash (make_number (keysym),
7979 Vx_keysym_table,
7980 Qnil),
7981 NATNUMP (c)))
7983 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
7984 ? ASCII_KEYSTROKE_EVENT
7985 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
7986 inev.ie.code = XFASTINT (c);
7987 goto done_keysym;
7990 /* Random non-modifier sorts of keysyms. */
7991 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
7992 || keysym == XK_Delete
7993 #ifdef XK_ISO_Left_Tab
7994 || (keysym >= XK_ISO_Left_Tab
7995 && keysym <= XK_ISO_Enter)
7996 #endif
7997 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
7998 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
7999 #ifdef HPUX
8000 /* This recognizes the "extended function
8001 keys". It seems there's no cleaner way.
8002 Test IsModifierKey to avoid handling
8003 mode_switch incorrectly. */
8004 || (XK_Select <= keysym && keysym < XK_KP_Space)
8005 #endif
8006 #ifdef XK_dead_circumflex
8007 || orig_keysym == XK_dead_circumflex
8008 #endif
8009 #ifdef XK_dead_grave
8010 || orig_keysym == XK_dead_grave
8011 #endif
8012 #ifdef XK_dead_tilde
8013 || orig_keysym == XK_dead_tilde
8014 #endif
8015 #ifdef XK_dead_diaeresis
8016 || orig_keysym == XK_dead_diaeresis
8017 #endif
8018 #ifdef XK_dead_macron
8019 || orig_keysym == XK_dead_macron
8020 #endif
8021 #ifdef XK_dead_degree
8022 || orig_keysym == XK_dead_degree
8023 #endif
8024 #ifdef XK_dead_acute
8025 || orig_keysym == XK_dead_acute
8026 #endif
8027 #ifdef XK_dead_cedilla
8028 || orig_keysym == XK_dead_cedilla
8029 #endif
8030 #ifdef XK_dead_breve
8031 || orig_keysym == XK_dead_breve
8032 #endif
8033 #ifdef XK_dead_ogonek
8034 || orig_keysym == XK_dead_ogonek
8035 #endif
8036 #ifdef XK_dead_caron
8037 || orig_keysym == XK_dead_caron
8038 #endif
8039 #ifdef XK_dead_doubleacute
8040 || orig_keysym == XK_dead_doubleacute
8041 #endif
8042 #ifdef XK_dead_abovedot
8043 || orig_keysym == XK_dead_abovedot
8044 #endif
8045 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
8046 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
8047 /* Any "vendor-specific" key is ok. */
8048 || (orig_keysym & (1 << 28))
8049 || (keysym != NoSymbol && nbytes == 0))
8050 && ! (IsModifierKey (orig_keysym)
8051 /* The symbols from XK_ISO_Lock
8052 to XK_ISO_Last_Group_Lock
8053 don't have real modifiers but
8054 should be treated similarly to
8055 Mode_switch by Emacs. */
8056 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
8057 || (XK_ISO_Lock <= orig_keysym
8058 && orig_keysym <= XK_ISO_Last_Group_Lock)
8059 #endif
8062 STORE_KEYSYM_FOR_DEBUG (keysym);
8063 /* make_lispy_event will convert this to a symbolic
8064 key. */
8065 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
8066 inev.ie.code = keysym;
8067 goto done_keysym;
8070 { /* Raw bytes, not keysym. */
8071 ptrdiff_t i;
8072 int nchars, len;
8074 for (i = 0, nchars = 0; i < nbytes; i++)
8076 if (ASCII_CHAR_P (copy_bufptr[i]))
8077 nchars++;
8078 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
8081 if (nchars < nbytes)
8083 /* Decode the input data. */
8085 /* The input should be decoded with `coding_system'
8086 which depends on which X*LookupString function
8087 we used just above and the locale. */
8088 setup_coding_system (coding_system, &coding);
8089 coding.src_multibyte = false;
8090 coding.dst_multibyte = true;
8091 /* The input is converted to events, thus we can't
8092 handle composition. Anyway, there's no XIM that
8093 gives us composition information. */
8094 coding.common_flags &= ~CODING_ANNOTATION_MASK;
8096 SAFE_NALLOCA (coding.destination, MAX_MULTIBYTE_LENGTH,
8097 nbytes);
8098 coding.dst_bytes = MAX_MULTIBYTE_LENGTH * nbytes;
8099 coding.mode |= CODING_MODE_LAST_BLOCK;
8100 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
8101 nbytes = coding.produced;
8102 nchars = coding.produced_char;
8103 copy_bufptr = coding.destination;
8106 /* Convert the input data to a sequence of
8107 character events. */
8108 for (i = 0; i < nbytes; i += len)
8110 int ch;
8111 if (nchars == nbytes)
8112 ch = copy_bufptr[i], len = 1;
8113 else
8114 ch = STRING_CHAR_AND_LENGTH (copy_bufptr + i, len);
8115 inev.ie.kind = (SINGLE_BYTE_CHAR_P (ch)
8116 ? ASCII_KEYSTROKE_EVENT
8117 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
8118 inev.ie.code = ch;
8119 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
8122 count += nchars;
8124 inev.ie.kind = NO_EVENT; /* Already stored above. */
8126 if (keysym == NoSymbol)
8127 break;
8129 /* FIXME: check side effects and remove this. */
8130 ((XEvent *) event)->xkey = xkey;
8132 done_keysym:
8133 #ifdef HAVE_X_I18N
8134 /* Don't dispatch this event since XtDispatchEvent calls
8135 XFilterEvent, and two calls in a row may freeze the
8136 client. */
8137 break;
8138 #else
8139 goto OTHER;
8140 #endif
8142 case KeyRelease:
8143 x_display_set_last_user_time (dpyinfo, event->xkey.time);
8144 #ifdef HAVE_X_I18N
8145 /* Don't dispatch this event since XtDispatchEvent calls
8146 XFilterEvent, and two calls in a row may freeze the
8147 client. */
8148 break;
8149 #else
8150 goto OTHER;
8151 #endif
8153 case EnterNotify:
8154 x_display_set_last_user_time (dpyinfo, event->xcrossing.time);
8155 x_detect_focus_change (dpyinfo, any, event, &inev.ie);
8157 f = any;
8159 if (f && x_mouse_click_focus_ignore_position)
8160 ignore_next_mouse_click_timeout = event->xmotion.time + 200;
8162 /* EnterNotify counts as mouse movement,
8163 so update things that depend on mouse position. */
8164 if (f && !f->output_data.x->hourglass_p)
8165 note_mouse_movement (f, &event->xmotion);
8166 #ifdef USE_GTK
8167 /* We may get an EnterNotify on the buttons in the toolbar. In that
8168 case we moved out of any highlighted area and need to note this. */
8169 if (!f && dpyinfo->last_mouse_glyph_frame)
8170 note_mouse_movement (dpyinfo->last_mouse_glyph_frame, &event->xmotion);
8171 #endif
8172 goto OTHER;
8174 case FocusIn:
8175 x_detect_focus_change (dpyinfo, any, event, &inev.ie);
8176 goto OTHER;
8178 case LeaveNotify:
8179 x_display_set_last_user_time (dpyinfo, event->xcrossing.time);
8180 x_detect_focus_change (dpyinfo, any, event, &inev.ie);
8182 f = x_top_window_to_frame (dpyinfo, event->xcrossing.window);
8183 if (f)
8185 if (f == hlinfo->mouse_face_mouse_frame)
8187 /* If we move outside the frame, then we're
8188 certainly no longer on any text in the frame. */
8189 clear_mouse_face (hlinfo);
8190 hlinfo->mouse_face_mouse_frame = 0;
8193 /* Generate a nil HELP_EVENT to cancel a help-echo.
8194 Do it only if there's something to cancel.
8195 Otherwise, the startup message is cleared when
8196 the mouse leaves the frame. */
8197 if (any_help_event_p)
8198 do_help = -1;
8200 #ifdef USE_GTK
8201 /* See comment in EnterNotify above */
8202 else if (dpyinfo->last_mouse_glyph_frame)
8203 note_mouse_movement (dpyinfo->last_mouse_glyph_frame, &event->xmotion);
8204 #endif
8205 goto OTHER;
8207 case FocusOut:
8208 x_detect_focus_change (dpyinfo, any, event, &inev.ie);
8209 goto OTHER;
8211 case MotionNotify:
8213 x_display_set_last_user_time (dpyinfo, event->xmotion.time);
8214 previous_help_echo_string = help_echo_string;
8215 help_echo_string = Qnil;
8217 f = (x_mouse_grabbed (dpyinfo) ? dpyinfo->last_mouse_frame
8218 : x_window_to_frame (dpyinfo, event->xmotion.window));
8220 if (hlinfo->mouse_face_hidden)
8222 hlinfo->mouse_face_hidden = false;
8223 clear_mouse_face (hlinfo);
8226 #ifdef USE_GTK
8227 if (f && xg_event_is_for_scrollbar (f, event))
8228 f = 0;
8229 #endif
8230 if (f)
8233 /* Generate SELECT_WINDOW_EVENTs when needed.
8234 Don't let popup menus influence things (bug#1261). */
8235 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
8237 static Lisp_Object last_mouse_window;
8238 Lisp_Object window = window_from_coordinates
8239 (f, event->xmotion.x, event->xmotion.y, 0, false);
8241 /* Window will be selected only when it is not selected now and
8242 last mouse movement event was not in it. Minibuffer window
8243 will be selected only when it is active. */
8244 if (WINDOWP (window)
8245 && !EQ (window, last_mouse_window)
8246 && !EQ (window, selected_window)
8247 /* For click-to-focus window managers
8248 create event iff we don't leave the
8249 selected frame. */
8250 && (focus_follows_mouse
8251 || (EQ (XWINDOW (window)->frame,
8252 XWINDOW (selected_window)->frame))))
8254 inev.ie.kind = SELECT_WINDOW_EVENT;
8255 inev.ie.frame_or_window = window;
8257 /* Remember the last window where we saw the mouse. */
8258 last_mouse_window = window;
8260 if (!note_mouse_movement (f, &event->xmotion))
8261 help_echo_string = previous_help_echo_string;
8263 else
8265 #ifndef USE_TOOLKIT_SCROLL_BARS
8266 struct scroll_bar *bar
8267 = x_window_to_scroll_bar (event->xmotion.display,
8268 event->xmotion.window, 2);
8270 if (bar)
8271 x_scroll_bar_note_movement (bar, &event->xmotion);
8272 #endif /* USE_TOOLKIT_SCROLL_BARS */
8274 /* If we move outside the frame, then we're
8275 certainly no longer on any text in the frame. */
8276 clear_mouse_face (hlinfo);
8279 /* If the contents of the global variable help_echo_string
8280 has changed, generate a HELP_EVENT. */
8281 if (!NILP (help_echo_string)
8282 || !NILP (previous_help_echo_string))
8283 do_help = 1;
8284 goto OTHER;
8287 case ConfigureNotify:
8288 f = x_top_window_to_frame (dpyinfo, event->xconfigure.window);
8289 #ifdef USE_CAIRO
8290 if (f) x_cr_destroy_surface (f);
8291 #endif
8292 #ifdef USE_GTK
8293 if (!f
8294 && (f = any)
8295 && event->xconfigure.window == FRAME_X_WINDOW (f))
8297 xg_frame_resized (f, event->xconfigure.width,
8298 event->xconfigure.height);
8299 #ifdef USE_CAIRO
8300 x_cr_destroy_surface (f);
8301 #endif
8302 f = 0;
8304 #endif
8305 if (f)
8307 x_net_wm_state (f, event->xconfigure.window);
8309 #ifdef USE_X_TOOLKIT
8310 /* Tip frames are pure X window, set size for them. */
8311 if (! NILP (tip_frame) && XFRAME (tip_frame) == f)
8313 if (FRAME_PIXEL_HEIGHT (f) != event->xconfigure.height
8314 || FRAME_PIXEL_WIDTH (f) != event->xconfigure.width)
8315 SET_FRAME_GARBAGED (f);
8316 FRAME_PIXEL_HEIGHT (f) = event->xconfigure.height;
8317 FRAME_PIXEL_WIDTH (f) = event->xconfigure.width;
8319 #endif
8321 #ifndef USE_X_TOOLKIT
8322 #ifndef USE_GTK
8323 int width = FRAME_PIXEL_TO_TEXT_WIDTH (f, event->xconfigure.width);
8324 int height = FRAME_PIXEL_TO_TEXT_HEIGHT (f, event->xconfigure.height);
8326 /* In the toolkit version, change_frame_size
8327 is called by the code that handles resizing
8328 of the EmacsFrame widget. */
8330 /* Even if the number of character rows and columns has
8331 not changed, the font size may have changed, so we need
8332 to check the pixel dimensions as well. */
8333 if (width != FRAME_TEXT_WIDTH (f)
8334 || height != FRAME_TEXT_HEIGHT (f)
8335 || event->xconfigure.width != FRAME_PIXEL_WIDTH (f)
8336 || event->xconfigure.height != FRAME_PIXEL_HEIGHT (f))
8338 change_frame_size (f, width, height, false, true, false, true);
8339 x_clear_under_internal_border (f);
8340 SET_FRAME_GARBAGED (f);
8341 cancel_mouse_face (f);
8343 #endif /* not USE_GTK */
8344 #endif
8346 #ifdef USE_GTK
8347 /* GTK creates windows but doesn't map them.
8348 Only get real positions when mapped. */
8349 if (FRAME_GTK_OUTER_WIDGET (f)
8350 && gtk_widget_get_mapped (FRAME_GTK_OUTER_WIDGET (f)))
8351 #endif
8352 x_real_positions (f, &f->left_pos, &f->top_pos);
8354 #ifdef HAVE_X_I18N
8355 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
8356 xic_set_statusarea (f);
8357 #endif
8360 goto OTHER;
8362 case ButtonRelease:
8363 case ButtonPress:
8365 /* If we decide we want to generate an event to be seen
8366 by the rest of Emacs, we put it here. */
8367 bool tool_bar_p = false;
8369 memset (&compose_status, 0, sizeof (compose_status));
8370 dpyinfo->last_mouse_glyph_frame = NULL;
8371 x_display_set_last_user_time (dpyinfo, event->xbutton.time);
8373 f = (x_mouse_grabbed (dpyinfo) ? dpyinfo->last_mouse_frame
8374 : x_window_to_frame (dpyinfo, event->xbutton.window));
8376 #ifdef USE_GTK
8377 if (f && xg_event_is_for_scrollbar (f, event))
8378 f = 0;
8379 #endif
8380 if (f)
8382 #if ! defined (USE_GTK)
8383 /* Is this in the tool-bar? */
8384 if (WINDOWP (f->tool_bar_window)
8385 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
8387 Lisp_Object window;
8388 int x = event->xbutton.x;
8389 int y = event->xbutton.y;
8391 window = window_from_coordinates (f, x, y, 0, true);
8392 tool_bar_p = EQ (window, f->tool_bar_window);
8394 if (tool_bar_p && event->xbutton.button < 4)
8395 handle_tool_bar_click
8396 (f, x, y, event->xbutton.type == ButtonPress,
8397 x_x_to_emacs_modifiers (dpyinfo, event->xbutton.state));
8399 #endif /* !USE_GTK */
8401 if (!tool_bar_p)
8402 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
8403 if (! popup_activated ())
8404 #endif
8406 if (ignore_next_mouse_click_timeout)
8408 if (event->type == ButtonPress
8409 && event->xbutton.time > ignore_next_mouse_click_timeout)
8411 ignore_next_mouse_click_timeout = 0;
8412 construct_mouse_click (&inev.ie, &event->xbutton, f);
8414 if (event->type == ButtonRelease)
8415 ignore_next_mouse_click_timeout = 0;
8417 else
8418 construct_mouse_click (&inev.ie, &event->xbutton, f);
8420 if (FRAME_X_EMBEDDED_P (f))
8421 xembed_send_message (f, event->xbutton.time,
8422 XEMBED_REQUEST_FOCUS, 0, 0, 0);
8424 else
8426 struct scroll_bar *bar
8427 = x_window_to_scroll_bar (event->xbutton.display,
8428 event->xbutton.window, 2);
8430 #ifdef USE_TOOLKIT_SCROLL_BARS
8431 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
8432 scroll bars. */
8433 if (bar && event->xbutton.state & ControlMask)
8435 x_scroll_bar_handle_click (bar, event, &inev.ie);
8436 *finish = X_EVENT_DROP;
8438 #else /* not USE_TOOLKIT_SCROLL_BARS */
8439 if (bar)
8440 x_scroll_bar_handle_click (bar, event, &inev.ie);
8441 #endif /* not USE_TOOLKIT_SCROLL_BARS */
8444 if (event->type == ButtonPress)
8446 dpyinfo->grabbed |= (1 << event->xbutton.button);
8447 dpyinfo->last_mouse_frame = f;
8448 #if ! defined (USE_GTK)
8449 if (f && !tool_bar_p)
8450 f->last_tool_bar_item = -1;
8451 #endif /* not USE_GTK */
8453 else
8454 dpyinfo->grabbed &= ~(1 << event->xbutton.button);
8456 /* Ignore any mouse motion that happened before this event;
8457 any subsequent mouse-movement Emacs events should reflect
8458 only motion after the ButtonPress/Release. */
8459 if (f != 0)
8460 f->mouse_moved = false;
8462 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
8463 f = x_menubar_window_to_frame (dpyinfo, event);
8464 /* For a down-event in the menu bar,
8465 don't pass it to Xt right now.
8466 Instead, save it away
8467 and we will pass it to Xt from kbd_buffer_get_event.
8468 That way, we can run some Lisp code first. */
8469 if (! popup_activated ()
8470 #ifdef USE_GTK
8471 /* Gtk+ menus only react to the first three buttons. */
8472 && event->xbutton.button < 3
8473 #endif
8474 && f && event->type == ButtonPress
8475 /* Verify the event is really within the menu bar
8476 and not just sent to it due to grabbing. */
8477 && event->xbutton.x >= 0
8478 && event->xbutton.x < FRAME_PIXEL_WIDTH (f)
8479 && event->xbutton.y >= 0
8480 && event->xbutton.y < FRAME_MENUBAR_HEIGHT (f)
8481 && event->xbutton.same_screen)
8483 if (!f->output_data.x->saved_menu_event)
8484 f->output_data.x->saved_menu_event = xmalloc (sizeof *event);
8485 *f->output_data.x->saved_menu_event = *event;
8486 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT;
8487 XSETFRAME (inev.ie.frame_or_window, f);
8488 *finish = X_EVENT_DROP;
8490 else
8491 goto OTHER;
8492 #endif /* USE_X_TOOLKIT || USE_GTK */
8494 break;
8496 case CirculateNotify:
8497 goto OTHER;
8499 case CirculateRequest:
8500 goto OTHER;
8502 case VisibilityNotify:
8503 goto OTHER;
8505 case MappingNotify:
8506 /* Someone has changed the keyboard mapping - update the
8507 local cache. */
8508 switch (event->xmapping.request)
8510 case MappingModifier:
8511 x_find_modifier_meanings (dpyinfo);
8512 /* This is meant to fall through. */
8513 case MappingKeyboard:
8514 XRefreshKeyboardMapping ((XMappingEvent *) &event->xmapping);
8516 goto OTHER;
8518 case DestroyNotify:
8519 xft_settings_event (dpyinfo, event);
8520 break;
8522 default:
8523 OTHER:
8524 #ifdef USE_X_TOOLKIT
8525 block_input ();
8526 if (*finish != X_EVENT_DROP)
8527 XtDispatchEvent ((XEvent *) event);
8528 unblock_input ();
8529 #endif /* USE_X_TOOLKIT */
8530 break;
8533 done:
8534 if (inev.ie.kind != NO_EVENT)
8536 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
8537 count++;
8540 if (do_help
8541 && !(hold_quit && hold_quit->kind != NO_EVENT))
8543 Lisp_Object frame;
8545 if (f)
8546 XSETFRAME (frame, f);
8547 else
8548 frame = Qnil;
8550 if (do_help > 0)
8552 any_help_event_p = true;
8553 gen_help_event (help_echo_string, frame, help_echo_window,
8554 help_echo_object, help_echo_pos);
8556 else
8558 help_echo_string = Qnil;
8559 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
8561 count++;
8564 SAFE_FREE ();
8565 return count;
8568 /* Handles the XEvent EVENT on display DISPLAY.
8569 This is used for event loops outside the normal event handling,
8570 i.e. looping while a popup menu or a dialog is posted.
8572 Returns the value handle_one_xevent sets in the finish argument. */
8574 x_dispatch_event (XEvent *event, Display *display)
8576 struct x_display_info *dpyinfo;
8577 int finish = X_EVENT_NORMAL;
8579 dpyinfo = x_display_info_for_display (display);
8581 if (dpyinfo)
8582 handle_one_xevent (dpyinfo, event, &finish, 0);
8584 return finish;
8587 /* Read events coming from the X server.
8588 Return as soon as there are no more events to be read.
8590 Return the number of characters stored into the buffer,
8591 thus pretending to be `read' (except the characters we store
8592 in the keyboard buffer can be multibyte, so are not necessarily
8593 C chars). */
8595 static int
8596 XTread_socket (struct terminal *terminal, struct input_event *hold_quit)
8598 int count = 0;
8599 bool event_found = false;
8600 struct x_display_info *dpyinfo = terminal->display_info.x;
8602 block_input ();
8604 /* For debugging, this gives a way to fake an I/O error. */
8605 if (dpyinfo == XTread_socket_fake_io_error)
8607 XTread_socket_fake_io_error = 0;
8608 x_io_error_quitter (dpyinfo->display);
8611 #ifndef USE_GTK
8612 while (XPending (dpyinfo->display))
8614 int finish;
8615 XEvent event;
8617 XNextEvent (dpyinfo->display, &event);
8619 #ifdef HAVE_X_I18N
8620 /* Filter events for the current X input method. */
8621 if (x_filter_event (dpyinfo, &event))
8622 continue;
8623 #endif
8624 event_found = true;
8626 count += handle_one_xevent (dpyinfo, &event, &finish, hold_quit);
8628 if (finish == X_EVENT_GOTO_OUT)
8629 break;
8632 #else /* USE_GTK */
8634 /* For GTK we must use the GTK event loop. But XEvents gets passed
8635 to our filter function above, and then to the big event switch.
8636 We use a bunch of globals to communicate with our filter function,
8637 that is kind of ugly, but it works.
8639 There is no way to do one display at the time, GTK just does events
8640 from all displays. */
8642 while (gtk_events_pending ())
8644 current_count = count;
8645 current_hold_quit = hold_quit;
8647 gtk_main_iteration ();
8649 count = current_count;
8650 current_count = -1;
8651 current_hold_quit = 0;
8653 if (current_finish == X_EVENT_GOTO_OUT)
8654 break;
8656 #endif /* USE_GTK */
8658 /* On some systems, an X bug causes Emacs to get no more events
8659 when the window is destroyed. Detect that. (1994.) */
8660 if (! event_found)
8662 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
8663 One XNOOP in 100 loops will make Emacs terminate.
8664 B. Bretthauer, 1994 */
8665 x_noop_count++;
8666 if (x_noop_count >= 100)
8668 x_noop_count=0;
8670 if (next_noop_dpyinfo == 0)
8671 next_noop_dpyinfo = x_display_list;
8673 XNoOp (next_noop_dpyinfo->display);
8675 /* Each time we get here, cycle through the displays now open. */
8676 next_noop_dpyinfo = next_noop_dpyinfo->next;
8680 /* If the focus was just given to an auto-raising frame,
8681 raise it now. FIXME: handle more than one such frame. */
8682 if (dpyinfo->x_pending_autoraise_frame)
8684 x_raise_frame (dpyinfo->x_pending_autoraise_frame);
8685 dpyinfo->x_pending_autoraise_frame = NULL;
8688 unblock_input ();
8690 return count;
8696 /***********************************************************************
8697 Text Cursor
8698 ***********************************************************************/
8700 /* Set clipping for output in glyph row ROW. W is the window in which
8701 we operate. GC is the graphics context to set clipping in.
8703 ROW may be a text row or, e.g., a mode line. Text rows must be
8704 clipped to the interior of the window dedicated to text display,
8705 mode lines must be clipped to the whole window. */
8707 static void
8708 x_clip_to_row (struct window *w, struct glyph_row *row,
8709 enum glyph_row_area area, GC gc)
8711 struct frame *f = XFRAME (WINDOW_FRAME (w));
8712 XRectangle clip_rect;
8713 int window_x, window_y, window_width;
8715 window_box (w, area, &window_x, &window_y, &window_width, 0);
8717 clip_rect.x = window_x;
8718 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
8719 clip_rect.y = max (clip_rect.y, window_y);
8720 clip_rect.width = window_width;
8721 clip_rect.height = row->visible_height;
8723 x_set_clip_rectangles (f, gc, &clip_rect, 1);
8727 /* Draw a hollow box cursor on window W in glyph row ROW. */
8729 static void
8730 x_draw_hollow_cursor (struct window *w, struct glyph_row *row)
8732 struct frame *f = XFRAME (WINDOW_FRAME (w));
8733 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
8734 Display *dpy = FRAME_X_DISPLAY (f);
8735 int x, y, wd, h;
8736 XGCValues xgcv;
8737 struct glyph *cursor_glyph;
8738 GC gc;
8740 /* Get the glyph the cursor is on. If we can't tell because
8741 the current matrix is invalid or such, give up. */
8742 cursor_glyph = get_phys_cursor_glyph (w);
8743 if (cursor_glyph == NULL)
8744 return;
8746 /* Compute frame-relative coordinates for phys cursor. */
8747 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
8748 wd = w->phys_cursor_width - 1;
8750 /* The foreground of cursor_gc is typically the same as the normal
8751 background color, which can cause the cursor box to be invisible. */
8752 xgcv.foreground = f->output_data.x->cursor_pixel;
8753 if (dpyinfo->scratch_cursor_gc)
8754 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
8755 else
8756 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
8757 GCForeground, &xgcv);
8758 gc = dpyinfo->scratch_cursor_gc;
8760 /* When on R2L character, show cursor at the right edge of the
8761 glyph, unless the cursor box is as wide as the glyph or wider
8762 (the latter happens when x-stretch-cursor is non-nil). */
8763 if ((cursor_glyph->resolved_level & 1) != 0
8764 && cursor_glyph->pixel_width > wd)
8766 x += cursor_glyph->pixel_width - wd;
8767 if (wd > 0)
8768 wd -= 1;
8770 /* Set clipping, draw the rectangle, and reset clipping again. */
8771 x_clip_to_row (w, row, TEXT_AREA, gc);
8772 x_draw_rectangle (f, gc, x, y, wd, h - 1);
8773 x_reset_clip_rectangles (f, gc);
8777 /* Draw a bar cursor on window W in glyph row ROW.
8779 Implementation note: One would like to draw a bar cursor with an
8780 angle equal to the one given by the font property XA_ITALIC_ANGLE.
8781 Unfortunately, I didn't find a font yet that has this property set.
8782 --gerd. */
8784 static void
8785 x_draw_bar_cursor (struct window *w, struct glyph_row *row, int width, enum text_cursor_kinds kind)
8787 struct frame *f = XFRAME (w->frame);
8788 struct glyph *cursor_glyph;
8790 /* If cursor is out of bounds, don't draw garbage. This can happen
8791 in mini-buffer windows when switching between echo area glyphs
8792 and mini-buffer. */
8793 cursor_glyph = get_phys_cursor_glyph (w);
8794 if (cursor_glyph == NULL)
8795 return;
8797 /* If on an image, draw like a normal cursor. That's usually better
8798 visible than drawing a bar, esp. if the image is large so that
8799 the bar might not be in the window. */
8800 if (cursor_glyph->type == IMAGE_GLYPH)
8802 struct glyph_row *r;
8803 r = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
8804 draw_phys_cursor_glyph (w, r, DRAW_CURSOR);
8806 else
8808 Display *dpy = FRAME_X_DISPLAY (f);
8809 Window window = FRAME_X_WINDOW (f);
8810 GC gc = FRAME_DISPLAY_INFO (f)->scratch_cursor_gc;
8811 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
8812 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
8813 XGCValues xgcv;
8815 /* If the glyph's background equals the color we normally draw
8816 the bars cursor in, the bar cursor in its normal color is
8817 invisible. Use the glyph's foreground color instead in this
8818 case, on the assumption that the glyph's colors are chosen so
8819 that the glyph is legible. */
8820 if (face->background == f->output_data.x->cursor_pixel)
8821 xgcv.background = xgcv.foreground = face->foreground;
8822 else
8823 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
8824 xgcv.graphics_exposures = False;
8826 if (gc)
8827 XChangeGC (dpy, gc, mask, &xgcv);
8828 else
8830 gc = XCreateGC (dpy, window, mask, &xgcv);
8831 FRAME_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
8834 x_clip_to_row (w, row, TEXT_AREA, gc);
8836 if (kind == BAR_CURSOR)
8838 int x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x);
8840 if (width < 0)
8841 width = FRAME_CURSOR_WIDTH (f);
8842 width = min (cursor_glyph->pixel_width, width);
8844 w->phys_cursor_width = width;
8846 /* If the character under cursor is R2L, draw the bar cursor
8847 on the right of its glyph, rather than on the left. */
8848 if ((cursor_glyph->resolved_level & 1) != 0)
8849 x += cursor_glyph->pixel_width - width;
8851 x_fill_rectangle (f, gc, x,
8852 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
8853 width, row->height);
8855 else /* HBAR_CURSOR */
8857 int dummy_x, dummy_y, dummy_h;
8858 int x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x);
8860 if (width < 0)
8861 width = row->height;
8863 width = min (row->height, width);
8865 get_phys_cursor_geometry (w, row, cursor_glyph, &dummy_x,
8866 &dummy_y, &dummy_h);
8868 if ((cursor_glyph->resolved_level & 1) != 0
8869 && cursor_glyph->pixel_width > w->phys_cursor_width - 1)
8870 x += cursor_glyph->pixel_width - w->phys_cursor_width + 1;
8871 x_fill_rectangle (f, gc, x,
8872 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
8873 row->height - width),
8874 w->phys_cursor_width - 1, width);
8877 x_reset_clip_rectangles (f, gc);
8882 /* RIF: Define cursor CURSOR on frame F. */
8884 static void
8885 x_define_frame_cursor (struct frame *f, Cursor cursor)
8887 if (!f->pointer_invisible
8888 && f->output_data.x->current_cursor != cursor)
8889 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
8890 f->output_data.x->current_cursor = cursor;
8894 /* RIF: Clear area on frame F. */
8896 static void
8897 x_clear_frame_area (struct frame *f, int x, int y, int width, int height)
8899 x_clear_area (f, x, y, width, height);
8900 #ifdef USE_GTK
8901 /* Must queue a redraw, because scroll bars might have been cleared. */
8902 if (FRAME_GTK_WIDGET (f))
8903 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
8904 #endif
8908 /* RIF: Draw cursor on window W. */
8910 static void
8911 x_draw_window_cursor (struct window *w, struct glyph_row *glyph_row, int x,
8912 int y, enum text_cursor_kinds cursor_type,
8913 int cursor_width, bool on_p, bool active_p)
8915 struct frame *f = XFRAME (WINDOW_FRAME (w));
8917 if (on_p)
8919 w->phys_cursor_type = cursor_type;
8920 w->phys_cursor_on_p = true;
8922 if (glyph_row->exact_window_width_line_p
8923 && (glyph_row->reversed_p
8924 ? (w->phys_cursor.hpos < 0)
8925 : (w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])))
8927 glyph_row->cursor_in_fringe_p = true;
8928 draw_fringe_bitmap (w, glyph_row, glyph_row->reversed_p);
8930 else
8932 switch (cursor_type)
8934 case HOLLOW_BOX_CURSOR:
8935 x_draw_hollow_cursor (w, glyph_row);
8936 break;
8938 case FILLED_BOX_CURSOR:
8939 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
8940 break;
8942 case BAR_CURSOR:
8943 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
8944 break;
8946 case HBAR_CURSOR:
8947 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
8948 break;
8950 case NO_CURSOR:
8951 w->phys_cursor_width = 0;
8952 break;
8954 default:
8955 emacs_abort ();
8959 #ifdef HAVE_X_I18N
8960 if (w == XWINDOW (f->selected_window))
8961 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
8962 xic_set_preeditarea (w, x, y);
8963 #endif
8966 XFlush (FRAME_X_DISPLAY (f));
8970 /* Icons. */
8972 /* Make the x-window of frame F use the gnu icon bitmap. */
8974 bool
8975 x_bitmap_icon (struct frame *f, Lisp_Object file)
8977 ptrdiff_t bitmap_id;
8979 if (FRAME_X_WINDOW (f) == 0)
8980 return true;
8982 /* Free up our existing icon bitmap and mask if any. */
8983 if (f->output_data.x->icon_bitmap > 0)
8984 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
8985 f->output_data.x->icon_bitmap = 0;
8987 if (STRINGP (file))
8989 #ifdef USE_GTK
8990 /* Use gtk_window_set_icon_from_file () if available,
8991 It's not restricted to bitmaps */
8992 if (xg_set_icon (f, file))
8993 return false;
8994 #endif /* USE_GTK */
8995 bitmap_id = x_create_bitmap_from_file (f, file);
8996 x_create_bitmap_mask (f, bitmap_id);
8998 else
9000 /* Create the GNU bitmap and mask if necessary. */
9001 if (FRAME_DISPLAY_INFO (f)->icon_bitmap_id < 0)
9003 ptrdiff_t rc = -1;
9005 #ifdef USE_GTK
9007 if (xg_set_icon (f, xg_default_icon_file)
9008 || xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
9010 FRAME_DISPLAY_INFO (f)->icon_bitmap_id = -2;
9011 return false;
9014 #elif defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
9016 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
9017 if (rc != -1)
9018 FRAME_DISPLAY_INFO (f)->icon_bitmap_id = rc;
9020 #endif
9022 /* If all else fails, use the (black and white) xbm image. */
9023 if (rc == -1)
9025 rc = x_create_bitmap_from_data (f, (char *) gnu_xbm_bits,
9026 gnu_xbm_width, gnu_xbm_height);
9027 if (rc == -1)
9028 return true;
9030 FRAME_DISPLAY_INFO (f)->icon_bitmap_id = rc;
9031 x_create_bitmap_mask (f, FRAME_DISPLAY_INFO (f)->icon_bitmap_id);
9035 /* The first time we create the GNU bitmap and mask,
9036 this increments the ref-count one extra time.
9037 As a result, the GNU bitmap and mask are never freed.
9038 That way, we don't have to worry about allocating it again. */
9039 x_reference_bitmap (f, FRAME_DISPLAY_INFO (f)->icon_bitmap_id);
9041 bitmap_id = FRAME_DISPLAY_INFO (f)->icon_bitmap_id;
9044 x_wm_set_icon_pixmap (f, bitmap_id);
9045 f->output_data.x->icon_bitmap = bitmap_id;
9047 return false;
9051 /* Make the x-window of frame F use a rectangle with text.
9052 Use ICON_NAME as the text. */
9054 bool
9055 x_text_icon (struct frame *f, const char *icon_name)
9057 if (FRAME_X_WINDOW (f) == 0)
9058 return true;
9061 XTextProperty text;
9062 text.value = (unsigned char *) icon_name;
9063 text.encoding = XA_STRING;
9064 text.format = 8;
9065 text.nitems = strlen (icon_name);
9066 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
9069 if (f->output_data.x->icon_bitmap > 0)
9070 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
9071 f->output_data.x->icon_bitmap = 0;
9072 x_wm_set_icon_pixmap (f, 0);
9074 return false;
9077 #define X_ERROR_MESSAGE_SIZE 200
9079 /* If non-nil, this should be a string.
9080 It means catch X errors and store the error message in this string.
9082 The reason we use a stack is that x_catch_error/x_uncatch_error can
9083 be called from a signal handler.
9086 struct x_error_message_stack {
9087 char string[X_ERROR_MESSAGE_SIZE];
9088 Display *dpy;
9089 struct x_error_message_stack *prev;
9091 static struct x_error_message_stack *x_error_message;
9093 /* An X error handler which stores the error message in
9094 *x_error_message. This is called from x_error_handler if
9095 x_catch_errors is in effect. */
9097 static void
9098 x_error_catcher (Display *display, XErrorEvent *event)
9100 XGetErrorText (display, event->error_code,
9101 x_error_message->string,
9102 X_ERROR_MESSAGE_SIZE);
9105 /* Begin trapping X errors for display DPY. Actually we trap X errors
9106 for all displays, but DPY should be the display you are actually
9107 operating on.
9109 After calling this function, X protocol errors no longer cause
9110 Emacs to exit; instead, they are recorded in the string
9111 stored in *x_error_message.
9113 Calling x_check_errors signals an Emacs error if an X error has
9114 occurred since the last call to x_catch_errors or x_check_errors.
9116 Calling x_uncatch_errors resumes the normal error handling. */
9118 void
9119 x_catch_errors (Display *dpy)
9121 struct x_error_message_stack *data = xmalloc (sizeof *data);
9123 /* Make sure any errors from previous requests have been dealt with. */
9124 XSync (dpy, False);
9126 data->dpy = dpy;
9127 data->string[0] = 0;
9128 data->prev = x_error_message;
9129 x_error_message = data;
9132 /* Undo the last x_catch_errors call.
9133 DPY should be the display that was passed to x_catch_errors. */
9135 void
9136 x_uncatch_errors (void)
9138 struct x_error_message_stack *tmp;
9140 block_input ();
9142 /* The display may have been closed before this function is called.
9143 Check if it is still open before calling XSync. */
9144 if (x_display_info_for_display (x_error_message->dpy) != 0)
9145 XSync (x_error_message->dpy, False);
9147 tmp = x_error_message;
9148 x_error_message = x_error_message->prev;
9149 xfree (tmp);
9150 unblock_input ();
9153 /* If any X protocol errors have arrived since the last call to
9154 x_catch_errors or x_check_errors, signal an Emacs error using
9155 sprintf (a buffer, FORMAT, the x error message text) as the text. */
9157 void
9158 x_check_errors (Display *dpy, const char *format)
9160 /* Make sure to catch any errors incurred so far. */
9161 XSync (dpy, False);
9163 if (x_error_message->string[0])
9165 char string[X_ERROR_MESSAGE_SIZE];
9166 memcpy (string, x_error_message->string, X_ERROR_MESSAGE_SIZE);
9167 x_uncatch_errors ();
9168 error (format, string);
9172 /* Nonzero if we had any X protocol errors
9173 since we did x_catch_errors on DPY. */
9175 bool
9176 x_had_errors_p (Display *dpy)
9178 /* Make sure to catch any errors incurred so far. */
9179 XSync (dpy, False);
9181 return x_error_message->string[0] != 0;
9184 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
9186 void
9187 x_clear_errors (Display *dpy)
9189 x_error_message->string[0] = 0;
9192 #if false
9193 /* See comment in unwind_to_catch why calling this is a bad
9194 * idea. --lorentey */
9195 /* Close off all unclosed x_catch_errors calls. */
9197 void
9198 x_fully_uncatch_errors (void)
9200 while (x_error_message)
9201 x_uncatch_errors ();
9203 #endif
9205 #if false
9206 static unsigned int x_wire_count;
9207 x_trace_wire (void)
9209 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
9211 #endif
9214 /************************************************************************
9215 Handling X errors
9216 ************************************************************************/
9218 /* Error message passed to x_connection_closed. */
9220 static char *error_msg;
9222 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
9223 the text of an error message that lead to the connection loss. */
9225 static void
9226 x_connection_closed (Display *dpy, const char *error_message, bool ioerror)
9228 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
9229 Lisp_Object frame, tail;
9230 ptrdiff_t idx = SPECPDL_INDEX ();
9232 error_msg = alloca (strlen (error_message) + 1);
9233 strcpy (error_msg, error_message);
9235 /* Inhibit redisplay while frames are being deleted. */
9236 specbind (Qinhibit_redisplay, Qt);
9238 if (dpyinfo)
9240 /* Protect display from being closed when we delete the last
9241 frame on it. */
9242 dpyinfo->reference_count++;
9243 dpyinfo->terminal->reference_count++;
9245 if (ioerror) dpyinfo->display = 0;
9247 /* First delete frames whose mini-buffers are on frames
9248 that are on the dead display. */
9249 FOR_EACH_FRAME (tail, frame)
9251 Lisp_Object minibuf_frame;
9252 minibuf_frame
9253 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
9254 if (FRAME_X_P (XFRAME (frame))
9255 && FRAME_X_P (XFRAME (minibuf_frame))
9256 && ! EQ (frame, minibuf_frame)
9257 && FRAME_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
9258 delete_frame (frame, Qnoelisp);
9261 /* Now delete all remaining frames on the dead display.
9262 We are now sure none of these is used as the mini-buffer
9263 for another frame that we need to delete. */
9264 FOR_EACH_FRAME (tail, frame)
9265 if (FRAME_X_P (XFRAME (frame))
9266 && FRAME_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
9268 /* Set this to t so that delete_frame won't get confused
9269 trying to find a replacement. */
9270 kset_default_minibuffer_frame (FRAME_KBOARD (XFRAME (frame)), Qt);
9271 delete_frame (frame, Qnoelisp);
9274 /* If DPYINFO is null, this means we didn't open the display in the
9275 first place, so don't try to close it. */
9276 if (dpyinfo)
9278 /* We can not call XtCloseDisplay here because it calls XSync.
9279 XSync inside the error handler apparently hangs Emacs. On
9280 current Xt versions, this isn't needed either. */
9281 #ifdef USE_GTK
9282 /* A long-standing GTK bug prevents proper disconnect handling
9283 (https://bugzilla.gnome.org/show_bug.cgi?id=85715). Once,
9284 the resulting Glib error message loop filled a user's disk.
9285 To avoid this, kill Emacs unconditionally on disconnect. */
9286 shut_down_emacs (0, Qnil);
9287 fprintf (stderr, "%s\n\
9288 When compiled with GTK, Emacs cannot recover from X disconnects.\n\
9289 This is a GTK bug: https://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
9290 For details, see etc/PROBLEMS.\n",
9291 error_msg);
9292 emacs_abort ();
9293 #endif /* USE_GTK */
9295 /* Indicate that this display is dead. */
9296 dpyinfo->display = 0;
9298 dpyinfo->reference_count--;
9299 dpyinfo->terminal->reference_count--;
9300 if (dpyinfo->reference_count != 0)
9301 /* We have just closed all frames on this display. */
9302 emacs_abort ();
9305 Lisp_Object tmp;
9306 XSETTERMINAL (tmp, dpyinfo->terminal);
9307 Fdelete_terminal (tmp, Qnoelisp);
9311 if (terminal_list == 0)
9313 fprintf (stderr, "%s\n", error_msg);
9314 Fkill_emacs (make_number (70));
9315 /* NOTREACHED */
9318 totally_unblock_input ();
9320 unbind_to (idx, Qnil);
9321 clear_waiting_for_input ();
9323 /* Tell GCC not to suggest attribute 'noreturn' for this function. */
9324 IF_LINT (if (! terminal_list) return; )
9326 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
9327 longjmp), because returning from this function would get us back into
9328 Xlib's code which will directly call `exit'. */
9329 error ("%s", error_msg);
9332 /* We specifically use it before defining it, so that gcc doesn't inline it,
9333 otherwise gdb doesn't know how to properly put a breakpoint on it. */
9334 static void x_error_quitter (Display *, XErrorEvent *);
9336 /* This is the first-level handler for X protocol errors.
9337 It calls x_error_quitter or x_error_catcher. */
9339 static int
9340 x_error_handler (Display *display, XErrorEvent *event)
9342 #if defined USE_GTK && defined HAVE_GTK3
9343 if ((event->error_code == BadMatch || event->error_code == BadWindow)
9344 && event->request_code == X_SetInputFocus)
9346 return 0;
9348 #endif
9350 if (x_error_message)
9351 x_error_catcher (display, event);
9352 else
9353 x_error_quitter (display, event);
9354 return 0;
9357 /* This is the usual handler for X protocol errors.
9358 It kills all frames on the display that we got the error for.
9359 If that was the only one, it prints an error message and kills Emacs. */
9361 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
9363 /* On older GCC versions, just putting x_error_quitter
9364 after x_error_handler prevents inlining into the former. */
9366 static void NO_INLINE
9367 x_error_quitter (Display *display, XErrorEvent *event)
9369 char buf[256], buf1[356];
9371 /* Ignore BadName errors. They can happen because of fonts
9372 or colors that are not defined. */
9374 if (event->error_code == BadName)
9375 return;
9377 /* Note that there is no real way portable across R3/R4 to get the
9378 original error handler. */
9380 XGetErrorText (display, event->error_code, buf, sizeof (buf));
9381 sprintf (buf1, "X protocol error: %s on protocol request %d",
9382 buf, event->request_code);
9383 x_connection_closed (display, buf1, false);
9387 /* This is the handler for X IO errors, always.
9388 It kills all frames on the display that we lost touch with.
9389 If that was the only one, it prints an error message and kills Emacs. */
9391 static int
9392 x_io_error_quitter (Display *display)
9394 char buf[256];
9396 snprintf (buf, sizeof buf, "Connection lost to X server '%s'",
9397 DisplayString (display));
9398 x_connection_closed (display, buf, true);
9399 return 0;
9402 /* Changing the font of the frame. */
9404 /* Give frame F the font FONT-OBJECT as its default font. The return
9405 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
9406 frame. If it is negative, generate a new fontset from
9407 FONT-OBJECT. */
9409 Lisp_Object
9410 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
9412 struct font *font = XFONT_OBJECT (font_object);
9413 int unit, font_ascent, font_descent;
9415 if (fontset < 0)
9416 fontset = fontset_from_font (font_object);
9417 FRAME_FONTSET (f) = fontset;
9418 if (FRAME_FONT (f) == font)
9419 /* This font is already set in frame F. There's nothing more to
9420 do. */
9421 return font_object;
9423 FRAME_FONT (f) = font;
9424 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
9425 FRAME_COLUMN_WIDTH (f) = font->average_width;
9426 get_font_ascent_descent (font, &font_ascent, &font_descent);
9427 FRAME_LINE_HEIGHT (f) = font_ascent + font_descent;
9429 #ifndef USE_X_TOOLKIT
9430 FRAME_MENU_BAR_HEIGHT (f) = FRAME_MENU_BAR_LINES (f) * FRAME_LINE_HEIGHT (f);
9431 #endif
9433 /* Compute character columns occupied by scrollbar.
9435 Don't do things differently for non-toolkit scrollbars
9436 (Bug#17163). */
9437 unit = FRAME_COLUMN_WIDTH (f);
9438 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
9439 FRAME_CONFIG_SCROLL_BAR_COLS (f)
9440 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + unit - 1) / unit;
9441 else
9442 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + unit - 1) / unit;
9444 if (FRAME_X_WINDOW (f) != 0)
9446 /* Don't change the size of a tip frame; there's no point in
9447 doing it because it's done in Fx_show_tip, and it leads to
9448 problems because the tip frame has no widget. */
9449 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
9450 adjust_frame_size (f, FRAME_COLS (f) * FRAME_COLUMN_WIDTH (f),
9451 FRAME_LINES (f) * FRAME_LINE_HEIGHT (f), 3,
9452 false, Qfont);
9455 #ifdef HAVE_X_I18N
9456 if (FRAME_XIC (f)
9457 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
9459 block_input ();
9460 xic_set_xfontset (f, SSDATA (fontset_ascii (fontset)));
9461 unblock_input ();
9463 #endif
9465 return font_object;
9469 /***********************************************************************
9470 X Input Methods
9471 ***********************************************************************/
9473 #ifdef HAVE_X_I18N
9475 #ifdef HAVE_X11R6
9477 /* XIM destroy callback function, which is called whenever the
9478 connection to input method XIM dies. CLIENT_DATA contains a
9479 pointer to the x_display_info structure corresponding to XIM. */
9481 static void
9482 xim_destroy_callback (XIM xim, XPointer client_data, XPointer call_data)
9484 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
9485 Lisp_Object frame, tail;
9487 block_input ();
9489 /* No need to call XDestroyIC.. */
9490 FOR_EACH_FRAME (tail, frame)
9492 struct frame *f = XFRAME (frame);
9493 if (FRAME_X_P (f) && FRAME_DISPLAY_INFO (f) == dpyinfo)
9495 FRAME_XIC (f) = NULL;
9496 xic_free_xfontset (f);
9500 /* No need to call XCloseIM. */
9501 dpyinfo->xim = NULL;
9502 XFree (dpyinfo->xim_styles);
9503 unblock_input ();
9506 #endif /* HAVE_X11R6 */
9508 /* Open the connection to the XIM server on display DPYINFO.
9509 RESOURCE_NAME is the resource name Emacs uses. */
9511 static void
9512 xim_open_dpy (struct x_display_info *dpyinfo, char *resource_name)
9514 XIM xim;
9516 #ifdef HAVE_XIM
9517 if (use_xim)
9519 if (dpyinfo->xim)
9520 XCloseIM (dpyinfo->xim);
9521 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
9522 emacs_class);
9523 dpyinfo->xim = xim;
9525 if (xim)
9527 #ifdef HAVE_X11R6
9528 XIMCallback destroy;
9529 #endif
9531 /* Get supported styles and XIM values. */
9532 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
9534 #ifdef HAVE_X11R6
9535 destroy.callback = xim_destroy_callback;
9536 destroy.client_data = (XPointer)dpyinfo;
9537 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
9538 #endif
9542 else
9543 #endif /* HAVE_XIM */
9544 dpyinfo->xim = NULL;
9548 #ifdef HAVE_X11R6_XIM
9550 /* XIM instantiate callback function, which is called whenever an XIM
9551 server is available. DISPLAY is the display of the XIM.
9552 CLIENT_DATA contains a pointer to an xim_inst_t structure created
9553 when the callback was registered. */
9555 static void
9556 xim_instantiate_callback (Display *display, XPointer client_data, XPointer call_data)
9558 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
9559 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
9561 /* We don't support multiple XIM connections. */
9562 if (dpyinfo->xim)
9563 return;
9565 xim_open_dpy (dpyinfo, xim_inst->resource_name);
9567 /* Create XIC for the existing frames on the same display, as long
9568 as they have no XIC. */
9569 if (dpyinfo->xim && dpyinfo->reference_count > 0)
9571 Lisp_Object tail, frame;
9573 block_input ();
9574 FOR_EACH_FRAME (tail, frame)
9576 struct frame *f = XFRAME (frame);
9578 if (FRAME_X_P (f)
9579 && FRAME_DISPLAY_INFO (f) == xim_inst->dpyinfo)
9580 if (FRAME_XIC (f) == NULL)
9582 create_frame_xic (f);
9583 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
9584 xic_set_statusarea (f);
9585 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
9587 struct window *w = XWINDOW (f->selected_window);
9588 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
9593 unblock_input ();
9597 #endif /* HAVE_X11R6_XIM */
9600 /* Open a connection to the XIM server on display DPYINFO.
9601 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
9602 connection only at the first time. On X11R6, open the connection
9603 in the XIM instantiate callback function. */
9605 static void
9606 xim_initialize (struct x_display_info *dpyinfo, char *resource_name)
9608 dpyinfo->xim = NULL;
9609 #ifdef HAVE_XIM
9610 if (use_xim)
9612 #ifdef HAVE_X11R6_XIM
9613 struct xim_inst_t *xim_inst = xmalloc (sizeof *xim_inst);
9614 Bool ret;
9616 dpyinfo->xim_callback_data = xim_inst;
9617 xim_inst->dpyinfo = dpyinfo;
9618 xim_inst->resource_name = xstrdup (resource_name);
9619 ret = XRegisterIMInstantiateCallback
9620 (dpyinfo->display, dpyinfo->xrdb, xim_inst->resource_name,
9621 emacs_class, xim_instantiate_callback,
9622 /* This is XPointer in XFree86 but (XPointer *)
9623 on Tru64, at least, hence the configure test. */
9624 (XRegisterIMInstantiateCallback_arg6) xim_inst);
9625 eassert (ret == True);
9626 #else /* not HAVE_X11R6_XIM */
9627 xim_open_dpy (dpyinfo, resource_name);
9628 #endif /* not HAVE_X11R6_XIM */
9630 #endif /* HAVE_XIM */
9634 /* Close the connection to the XIM server on display DPYINFO. */
9636 static void
9637 xim_close_dpy (struct x_display_info *dpyinfo)
9639 #ifdef HAVE_XIM
9640 if (use_xim)
9642 #ifdef HAVE_X11R6_XIM
9643 struct xim_inst_t *xim_inst = dpyinfo->xim_callback_data;
9645 if (dpyinfo->display)
9647 Bool ret = XUnregisterIMInstantiateCallback
9648 (dpyinfo->display, dpyinfo->xrdb, xim_inst->resource_name,
9649 emacs_class, xim_instantiate_callback,
9650 (XRegisterIMInstantiateCallback_arg6) xim_inst);
9651 eassert (ret == True);
9653 xfree (xim_inst->resource_name);
9654 xfree (xim_inst);
9655 #endif /* HAVE_X11R6_XIM */
9656 if (dpyinfo->display)
9657 XCloseIM (dpyinfo->xim);
9658 dpyinfo->xim = NULL;
9659 XFree (dpyinfo->xim_styles);
9661 #endif /* HAVE_XIM */
9664 #endif /* not HAVE_X11R6_XIM */
9668 /* Calculate the absolute position in frame F
9669 from its current recorded position values and gravity. */
9671 static void
9672 x_calc_absolute_position (struct frame *f)
9674 int flags = f->size_hint_flags;
9676 /* We have nothing to do if the current position
9677 is already for the top-left corner. */
9678 if (! ((flags & XNegative) || (flags & YNegative)))
9679 return;
9681 /* Treat negative positions as relative to the leftmost bottommost
9682 position that fits on the screen. */
9683 if (flags & XNegative)
9684 f->left_pos = x_display_pixel_width (FRAME_DISPLAY_INFO (f))
9685 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
9688 int height = FRAME_PIXEL_HEIGHT (f);
9690 #if defined USE_X_TOOLKIT && defined USE_MOTIF
9691 /* Something is fishy here. When using Motif, starting Emacs with
9692 `-g -0-0', the frame appears too low by a few pixels.
9694 This seems to be so because initially, while Emacs is starting,
9695 the column widget's height and the frame's pixel height are
9696 different. The column widget's height is the right one. In
9697 later invocations, when Emacs is up, the frame's pixel height
9698 is right, though.
9700 It's not obvious where the initial small difference comes from.
9701 2000-12-01, gerd. */
9703 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
9704 #endif
9706 if (flags & YNegative)
9707 f->top_pos = x_display_pixel_height (FRAME_DISPLAY_INFO (f))
9708 - height + f->top_pos;
9711 /* The left_pos and top_pos
9712 are now relative to the top and left screen edges,
9713 so the flags should correspond. */
9714 f->size_hint_flags &= ~ (XNegative | YNegative);
9717 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
9718 to really change the position, and 0 when calling from
9719 x_make_frame_visible (in that case, XOFF and YOFF are the current
9720 position values). It is -1 when calling from x_set_frame_parameters,
9721 which means, do adjust for borders but don't change the gravity. */
9723 void
9724 x_set_offset (struct frame *f, register int xoff, register int yoff, int change_gravity)
9726 int modified_top, modified_left;
9728 if (change_gravity > 0)
9730 f->top_pos = yoff;
9731 f->left_pos = xoff;
9732 f->size_hint_flags &= ~ (XNegative | YNegative);
9733 if (xoff < 0)
9734 f->size_hint_flags |= XNegative;
9735 if (yoff < 0)
9736 f->size_hint_flags |= YNegative;
9737 f->win_gravity = NorthWestGravity;
9739 x_calc_absolute_position (f);
9741 block_input ();
9742 x_wm_set_size_hint (f, 0, false);
9744 modified_left = f->left_pos;
9745 modified_top = f->top_pos;
9747 if (change_gravity != 0 && FRAME_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
9749 /* Some WMs (twm, wmaker at least) has an offset that is smaller
9750 than the WM decorations. So we use the calculated offset instead
9751 of the WM decoration sizes here (x/y_pixels_outer_diff). */
9752 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
9753 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
9756 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9757 modified_left, modified_top);
9759 x_sync_with_move (f, f->left_pos, f->top_pos,
9760 FRAME_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN);
9762 /* change_gravity is non-zero when this function is called from Lisp to
9763 programmatically move a frame. In that case, we call
9764 x_check_expected_move to discover if we have a "Type A" or "Type B"
9765 window manager, and, for a "Type A" window manager, adjust the position
9766 of the frame.
9768 We call x_check_expected_move if a programmatic move occurred, and
9769 either the window manager type (A/B) is unknown or it is Type A but we
9770 need to compute the top/left offset adjustment for this frame. */
9772 if (change_gravity != 0
9773 && (FRAME_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
9774 || (FRAME_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
9775 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
9776 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
9777 x_check_expected_move (f, modified_left, modified_top);
9779 unblock_input ();
9782 /* Return true if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
9783 on the root window for frame F contains ATOMNAME.
9784 This is how a WM check shall be done according to the Window Manager
9785 Specification/Extended Window Manager Hints at
9786 http://freedesktop.org/wiki/Specifications/wm-spec. */
9788 static bool
9789 wm_supports (struct frame *f, Atom want_atom)
9791 Atom actual_type;
9792 unsigned long actual_size, bytes_remaining;
9793 int i, rc, actual_format;
9794 bool ret;
9795 Window wmcheck_window;
9796 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
9797 Window target_window = dpyinfo->root_window;
9798 int max_len = 65536;
9799 Display *dpy = FRAME_X_DISPLAY (f);
9800 unsigned char *tmp_data = NULL;
9801 Atom target_type = XA_WINDOW;
9803 block_input ();
9805 x_catch_errors (dpy);
9806 rc = XGetWindowProperty (dpy, target_window,
9807 dpyinfo->Xatom_net_supporting_wm_check,
9808 0, max_len, False, target_type,
9809 &actual_type, &actual_format, &actual_size,
9810 &bytes_remaining, &tmp_data);
9812 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
9814 if (tmp_data) XFree (tmp_data);
9815 x_uncatch_errors ();
9816 unblock_input ();
9817 return false;
9820 wmcheck_window = *(Window *) tmp_data;
9821 XFree (tmp_data);
9823 /* Check if window exists. */
9824 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
9825 x_sync (f);
9826 if (x_had_errors_p (dpy))
9828 x_uncatch_errors ();
9829 unblock_input ();
9830 return false;
9833 if (dpyinfo->net_supported_window != wmcheck_window)
9835 /* Window changed, reload atoms */
9836 if (dpyinfo->net_supported_atoms != NULL)
9837 XFree (dpyinfo->net_supported_atoms);
9838 dpyinfo->net_supported_atoms = NULL;
9839 dpyinfo->nr_net_supported_atoms = 0;
9840 dpyinfo->net_supported_window = 0;
9842 target_type = XA_ATOM;
9843 tmp_data = NULL;
9844 rc = XGetWindowProperty (dpy, target_window,
9845 dpyinfo->Xatom_net_supported,
9846 0, max_len, False, target_type,
9847 &actual_type, &actual_format, &actual_size,
9848 &bytes_remaining, &tmp_data);
9850 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
9852 if (tmp_data) XFree (tmp_data);
9853 x_uncatch_errors ();
9854 unblock_input ();
9855 return false;
9858 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
9859 dpyinfo->nr_net_supported_atoms = actual_size;
9860 dpyinfo->net_supported_window = wmcheck_window;
9863 ret = false;
9865 for (i = 0; !ret && i < dpyinfo->nr_net_supported_atoms; ++i)
9866 ret = dpyinfo->net_supported_atoms[i] == want_atom;
9868 x_uncatch_errors ();
9869 unblock_input ();
9871 return ret;
9874 static void
9875 set_wm_state (Lisp_Object frame, bool add, Atom atom, Atom value)
9877 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (XFRAME (frame));
9879 x_send_client_event (frame, make_number (0), frame,
9880 dpyinfo->Xatom_net_wm_state,
9881 make_number (32),
9882 /* 1 = add, 0 = remove */
9883 Fcons
9884 (make_number (add),
9885 Fcons
9886 (make_fixnum_or_float (atom),
9887 (value != 0
9888 ? list1 (make_fixnum_or_float (value))
9889 : Qnil))));
9892 void
9893 x_set_sticky (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
9895 Lisp_Object frame;
9896 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
9898 XSETFRAME (frame, f);
9900 set_wm_state (frame, !NILP (new_value),
9901 dpyinfo->Xatom_net_wm_state_sticky, None);
9904 /* Return the current _NET_WM_STATE.
9905 SIZE_STATE is set to one of the FULLSCREEN_* values.
9906 Set *STICKY to the sticky state.
9908 Return true iff we are not hidden. */
9910 static bool
9911 get_current_wm_state (struct frame *f,
9912 Window window,
9913 int *size_state,
9914 bool *sticky)
9916 Atom actual_type;
9917 unsigned long actual_size, bytes_remaining;
9918 int i, rc, actual_format;
9919 bool is_hidden = false;
9920 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
9921 long max_len = 65536;
9922 Display *dpy = FRAME_X_DISPLAY (f);
9923 unsigned char *tmp_data = NULL;
9924 Atom target_type = XA_ATOM;
9926 *sticky = false;
9927 *size_state = FULLSCREEN_NONE;
9929 block_input ();
9930 x_catch_errors (dpy);
9931 rc = XGetWindowProperty (dpy, window, dpyinfo->Xatom_net_wm_state,
9932 0, max_len, False, target_type,
9933 &actual_type, &actual_format, &actual_size,
9934 &bytes_remaining, &tmp_data);
9936 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
9938 if (tmp_data) XFree (tmp_data);
9939 x_uncatch_errors ();
9940 unblock_input ();
9941 return !FRAME_ICONIFIED_P (f);
9944 x_uncatch_errors ();
9946 for (i = 0; i < actual_size; ++i)
9948 Atom a = ((Atom*)tmp_data)[i];
9949 if (a == dpyinfo->Xatom_net_wm_state_hidden)
9950 is_hidden = true;
9951 else if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
9953 if (*size_state == FULLSCREEN_HEIGHT)
9954 *size_state = FULLSCREEN_MAXIMIZED;
9955 else
9956 *size_state = FULLSCREEN_WIDTH;
9958 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
9960 if (*size_state == FULLSCREEN_WIDTH)
9961 *size_state = FULLSCREEN_MAXIMIZED;
9962 else
9963 *size_state = FULLSCREEN_HEIGHT;
9965 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen)
9966 *size_state = FULLSCREEN_BOTH;
9967 else if (a == dpyinfo->Xatom_net_wm_state_sticky)
9968 *sticky = true;
9971 if (tmp_data) XFree (tmp_data);
9972 unblock_input ();
9973 return ! is_hidden;
9976 /* Do fullscreen as specified in extended window manager hints */
9978 static bool
9979 do_ewmh_fullscreen (struct frame *f)
9981 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
9982 bool have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state);
9983 int cur;
9984 bool dummy;
9986 get_current_wm_state (f, FRAME_OUTER_WINDOW (f), &cur, &dummy);
9988 /* Some window managers don't say they support _NET_WM_STATE, but they do say
9989 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
9990 if (!have_net_atom)
9991 have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state_fullscreen);
9993 if (have_net_atom && cur != f->want_fullscreen)
9995 Lisp_Object frame;
9997 XSETFRAME (frame, f);
9999 /* Keep number of calls to set_wm_state as low as possible.
10000 Some window managers, or possible Gtk+, hangs when too many
10001 are sent at once. */
10002 switch (f->want_fullscreen)
10004 case FULLSCREEN_BOTH:
10005 if (cur != FULLSCREEN_BOTH)
10006 set_wm_state (frame, true, dpyinfo->Xatom_net_wm_state_fullscreen,
10007 None);
10008 break;
10009 case FULLSCREEN_WIDTH:
10010 if (x_frame_normalize_before_maximize && cur == FULLSCREEN_MAXIMIZED)
10012 set_wm_state (frame, false,
10013 dpyinfo->Xatom_net_wm_state_maximized_horz,
10014 dpyinfo->Xatom_net_wm_state_maximized_vert);
10015 set_wm_state (frame, true,
10016 dpyinfo->Xatom_net_wm_state_maximized_horz, None);
10018 else
10020 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_HEIGHT
10021 || cur == FULLSCREEN_MAXIMIZED)
10022 set_wm_state (frame, false, dpyinfo->Xatom_net_wm_state_fullscreen,
10023 dpyinfo->Xatom_net_wm_state_maximized_vert);
10024 if (cur != FULLSCREEN_MAXIMIZED || x_frame_normalize_before_maximize)
10025 set_wm_state (frame, true,
10026 dpyinfo->Xatom_net_wm_state_maximized_horz, None);
10028 break;
10029 case FULLSCREEN_HEIGHT:
10030 if (x_frame_normalize_before_maximize && cur == FULLSCREEN_MAXIMIZED)
10032 set_wm_state (frame, false,
10033 dpyinfo->Xatom_net_wm_state_maximized_horz,
10034 dpyinfo->Xatom_net_wm_state_maximized_vert);
10035 set_wm_state (frame, true,
10036 dpyinfo->Xatom_net_wm_state_maximized_vert, None);
10038 else
10040 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_WIDTH
10041 || cur == FULLSCREEN_MAXIMIZED)
10042 set_wm_state (frame, false, dpyinfo->Xatom_net_wm_state_fullscreen,
10043 dpyinfo->Xatom_net_wm_state_maximized_horz);
10044 if (cur != FULLSCREEN_MAXIMIZED || x_frame_normalize_before_maximize)
10045 set_wm_state (frame, true,
10046 dpyinfo->Xatom_net_wm_state_maximized_vert, None);
10048 break;
10049 case FULLSCREEN_MAXIMIZED:
10050 if (x_frame_normalize_before_maximize && cur == FULLSCREEN_BOTH)
10052 set_wm_state (frame, false,
10053 dpyinfo->Xatom_net_wm_state_fullscreen, None);
10054 set_wm_state (frame, true,
10055 dpyinfo->Xatom_net_wm_state_maximized_horz,
10056 dpyinfo->Xatom_net_wm_state_maximized_vert);
10058 else if (x_frame_normalize_before_maximize && cur == FULLSCREEN_WIDTH)
10060 set_wm_state (frame, false,
10061 dpyinfo->Xatom_net_wm_state_maximized_horz, None);
10062 set_wm_state (frame, true,
10063 dpyinfo->Xatom_net_wm_state_maximized_horz,
10064 dpyinfo->Xatom_net_wm_state_maximized_vert);
10066 else if (x_frame_normalize_before_maximize && cur == FULLSCREEN_HEIGHT)
10068 set_wm_state (frame, false,
10069 dpyinfo->Xatom_net_wm_state_maximized_vert, None);
10070 set_wm_state (frame, true,
10071 dpyinfo->Xatom_net_wm_state_maximized_horz,
10072 dpyinfo->Xatom_net_wm_state_maximized_vert);
10074 else
10076 if (cur == FULLSCREEN_BOTH)
10077 set_wm_state (frame, false, dpyinfo->Xatom_net_wm_state_fullscreen,
10078 None);
10079 else if (cur == FULLSCREEN_HEIGHT)
10080 set_wm_state (frame, true,
10081 dpyinfo->Xatom_net_wm_state_maximized_horz, None);
10082 else if (cur == FULLSCREEN_WIDTH)
10083 set_wm_state (frame, true, None,
10084 dpyinfo->Xatom_net_wm_state_maximized_vert);
10085 else
10086 set_wm_state (frame, true,
10087 dpyinfo->Xatom_net_wm_state_maximized_horz,
10088 dpyinfo->Xatom_net_wm_state_maximized_vert);
10090 break;
10091 case FULLSCREEN_NONE:
10092 if (cur == FULLSCREEN_BOTH)
10093 set_wm_state (frame, false, dpyinfo->Xatom_net_wm_state_fullscreen,
10094 None);
10095 else
10096 set_wm_state (frame, false,
10097 dpyinfo->Xatom_net_wm_state_maximized_horz,
10098 dpyinfo->Xatom_net_wm_state_maximized_vert);
10101 f->want_fullscreen = FULLSCREEN_NONE;
10105 return have_net_atom;
10108 static void
10109 XTfullscreen_hook (struct frame *f)
10111 if (FRAME_VISIBLE_P (f))
10113 block_input ();
10114 x_check_fullscreen (f);
10115 x_sync (f);
10116 unblock_input ();
10121 static bool
10122 x_handle_net_wm_state (struct frame *f, const XPropertyEvent *event)
10124 int value = FULLSCREEN_NONE;
10125 Lisp_Object lval;
10126 bool sticky = false;
10127 bool not_hidden = get_current_wm_state (f, event->window, &value, &sticky);
10129 lval = Qnil;
10130 switch (value)
10132 case FULLSCREEN_WIDTH:
10133 lval = Qfullwidth;
10134 break;
10135 case FULLSCREEN_HEIGHT:
10136 lval = Qfullheight;
10137 break;
10138 case FULLSCREEN_BOTH:
10139 lval = Qfullboth;
10140 break;
10141 case FULLSCREEN_MAXIMIZED:
10142 lval = Qmaximized;
10143 break;
10146 frame_size_history_add
10147 (f, Qx_handle_net_wm_state, 0, 0,
10148 list2 (get_frame_param (f, Qfullscreen), lval));
10150 store_frame_param (f, Qfullscreen, lval);
10151 store_frame_param (f, Qsticky, sticky ? Qt : Qnil);
10153 return not_hidden;
10156 /* Check if we need to resize the frame due to a fullscreen request.
10157 If so needed, resize the frame. */
10158 static void
10159 x_check_fullscreen (struct frame *f)
10161 if (do_ewmh_fullscreen (f))
10162 return;
10164 if (f->output_data.x->parent_desc != FRAME_DISPLAY_INFO (f)->root_window)
10165 return; /* Only fullscreen without WM or with EWM hints (above). */
10167 /* Setting fullscreen to nil doesn't do anything. We could save the
10168 last non-fullscreen size and restore it, but it seems like a
10169 lot of work for this unusual case (no window manager running). */
10171 if (f->want_fullscreen != FULLSCREEN_NONE)
10173 int width = FRAME_PIXEL_WIDTH (f), height = FRAME_PIXEL_HEIGHT (f);
10174 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
10176 switch (f->want_fullscreen)
10178 /* No difference between these two when there is no WM */
10179 case FULLSCREEN_BOTH:
10180 case FULLSCREEN_MAXIMIZED:
10181 width = x_display_pixel_width (dpyinfo);
10182 height = x_display_pixel_height (dpyinfo);
10183 break;
10184 case FULLSCREEN_WIDTH:
10185 width = x_display_pixel_width (dpyinfo);
10186 height = height + FRAME_MENUBAR_HEIGHT (f);
10187 break;
10188 case FULLSCREEN_HEIGHT:
10189 height = x_display_pixel_height (dpyinfo);
10192 frame_size_history_add
10193 (f, Qx_check_fullscreen, width, height, Qnil);
10195 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
10196 width, height);
10198 if (FRAME_VISIBLE_P (f))
10199 x_wait_for_event (f, ConfigureNotify);
10200 else
10202 change_frame_size (f, width, height - FRAME_MENUBAR_HEIGHT (f),
10203 false, true, false, true);
10204 x_sync (f);
10209 /* This function is called by x_set_offset to determine whether the window
10210 manager interfered with the positioning of the frame. Type A window
10211 managers position the surrounding window manager decorations a small
10212 amount above and left of the user-supplied position. Type B window
10213 managers position the surrounding window manager decorations at the
10214 user-specified position. If we detect a Type A window manager, we
10215 compensate by moving the window right and down by the proper amount. */
10217 static void
10218 x_check_expected_move (struct frame *f, int expected_left, int expected_top)
10220 int current_left = 0, current_top = 0;
10222 /* x_real_positions returns the left and top offsets of the outermost
10223 window manager window around the frame. */
10225 x_real_positions (f, &current_left, &current_top);
10227 if (current_left != expected_left || current_top != expected_top)
10229 /* It's a "Type A" window manager. */
10231 int adjusted_left;
10232 int adjusted_top;
10234 FRAME_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
10235 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
10236 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
10238 /* Now fix the mispositioned frame's location. */
10240 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
10241 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
10243 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
10244 adjusted_left, adjusted_top);
10246 x_sync_with_move (f, expected_left, expected_top, false);
10248 else
10249 /* It's a "Type B" window manager. We don't have to adjust the
10250 frame's position. */
10252 FRAME_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
10256 /* Wait for XGetGeometry to return up-to-date position information for a
10257 recently-moved frame. Call this immediately after calling XMoveWindow.
10258 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
10259 frame has been moved to, so we use a fuzzy position comparison instead
10260 of an exact comparison. */
10262 static void
10263 x_sync_with_move (struct frame *f, int left, int top, bool fuzzy)
10265 int count = 0;
10267 while (count++ < 50)
10269 int current_left = 0, current_top = 0;
10271 /* In theory, this call to XSync only needs to happen once, but in
10272 practice, it doesn't seem to work, hence the need for the surrounding
10273 loop. */
10275 XSync (FRAME_X_DISPLAY (f), False);
10276 x_real_positions (f, &current_left, &current_top);
10278 if (fuzzy)
10280 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
10281 pixels. */
10283 if (eabs (current_left - left) <= 10
10284 && eabs (current_top - top) <= 40)
10285 return;
10287 else if (current_left == left && current_top == top)
10288 return;
10291 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
10292 will then return up-to-date position info. */
10294 wait_reading_process_output (0, 500000000, 0, false, Qnil, NULL, 0);
10298 /* Wait for an event on frame F matching EVENTTYPE. */
10299 void
10300 x_wait_for_event (struct frame *f, int eventtype)
10302 int level = interrupt_input_blocked;
10304 fd_set fds;
10305 struct timespec tmo, tmo_at, time_now;
10306 int fd = ConnectionNumber (FRAME_X_DISPLAY (f));
10308 f->wait_event_type = eventtype;
10310 /* Set timeout to 0.1 second. Hopefully not noticeable.
10311 Maybe it should be configurable. */
10312 tmo = make_timespec (0, 100 * 1000 * 1000);
10313 tmo_at = timespec_add (current_timespec (), tmo);
10315 while (f->wait_event_type)
10317 pending_signals = true;
10318 totally_unblock_input ();
10319 /* XTread_socket is called after unblock. */
10320 block_input ();
10321 interrupt_input_blocked = level;
10323 FD_ZERO (&fds);
10324 FD_SET (fd, &fds);
10326 time_now = current_timespec ();
10327 if (timespec_cmp (tmo_at, time_now) < 0)
10328 break;
10330 tmo = timespec_sub (tmo_at, time_now);
10331 if (pselect (fd + 1, &fds, NULL, NULL, &tmo, NULL) == 0)
10332 break; /* Timeout */
10335 f->wait_event_type = 0;
10339 /* Change the size of frame F's X window to WIDTH/HEIGHT in the case F
10340 doesn't have a widget. If CHANGE_GRAVITY, change to
10341 top-left-corner window gravity for this size change and subsequent
10342 size changes. Otherwise leave the window gravity unchanged. */
10344 static void
10345 x_set_window_size_1 (struct frame *f, bool change_gravity,
10346 int width, int height)
10348 int pixelwidth = FRAME_TEXT_TO_PIXEL_WIDTH (f, width);
10349 int pixelheight = FRAME_TEXT_TO_PIXEL_HEIGHT (f, height);
10350 int old_width = FRAME_PIXEL_WIDTH (f);
10351 int old_height = FRAME_PIXEL_HEIGHT (f);
10352 Lisp_Object fullscreen = get_frame_param (f, Qfullscreen);
10354 if (change_gravity) f->win_gravity = NorthWestGravity;
10355 x_wm_set_size_hint (f, 0, false);
10357 /* When the frame is fullheight and we only want to change the width
10358 or it is fullwidth and we only want to change the height we should
10359 be able to preserve the fullscreen property. However, due to the
10360 fact that we have to send a resize request anyway, the window
10361 manager will abolish it. At least the respective size should
10362 remain unchanged but giving the frame back its normal size will
10363 be broken ... */
10364 if (EQ (fullscreen, Qfullwidth) && width == FRAME_TEXT_WIDTH (f))
10366 frame_size_history_add
10367 (f, Qxg_frame_set_char_size_1, width, height,
10368 list2 (make_number (old_height),
10369 make_number (pixelheight + FRAME_MENUBAR_HEIGHT (f))));
10371 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
10372 old_width, pixelheight + FRAME_MENUBAR_HEIGHT (f));
10374 else if (EQ (fullscreen, Qfullheight) && height == FRAME_TEXT_HEIGHT (f))
10376 frame_size_history_add
10377 (f, Qxg_frame_set_char_size_2, width, height,
10378 list2 (make_number (old_width), make_number (pixelwidth)));
10380 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
10381 pixelwidth, old_height);
10384 else
10386 frame_size_history_add
10387 (f, Qxg_frame_set_char_size_3, width, height,
10388 list2 (make_number (pixelwidth + FRAME_TOOLBAR_WIDTH (f)),
10389 make_number (pixelheight + FRAME_TOOLBAR_HEIGHT (f)
10390 + FRAME_MENUBAR_HEIGHT (f))));
10392 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
10393 pixelwidth, pixelheight + FRAME_MENUBAR_HEIGHT (f));
10394 fullscreen = Qnil;
10399 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
10400 receive in the ConfigureNotify event; if we get what we asked
10401 for, then the event won't cause the screen to become garbaged, so
10402 we have to make sure to do it here. */
10403 SET_FRAME_GARBAGED (f);
10405 /* Now, strictly speaking, we can't be sure that this is accurate,
10406 but the window manager will get around to dealing with the size
10407 change request eventually, and we'll hear how it went when the
10408 ConfigureNotify event gets here.
10410 We could just not bother storing any of this information here,
10411 and let the ConfigureNotify event set everything up, but that
10412 might be kind of confusing to the Lisp code, since size changes
10413 wouldn't be reported in the frame parameters until some random
10414 point in the future when the ConfigureNotify event arrives.
10416 Pass true for DELAY since we can't run Lisp code inside of
10417 a BLOCK_INPUT. */
10419 /* But the ConfigureNotify may in fact never arrive, and then this is
10420 not right if the frame is visible. Instead wait (with timeout)
10421 for the ConfigureNotify. */
10422 if (FRAME_VISIBLE_P (f))
10424 x_wait_for_event (f, ConfigureNotify);
10426 if (!NILP (fullscreen))
10427 /* Try to restore fullscreen state. */
10429 store_frame_param (f, Qfullscreen, fullscreen);
10430 x_set_fullscreen (f, fullscreen, fullscreen);
10433 else
10435 change_frame_size (f, width, height, false, true, false, true);
10436 x_sync (f);
10441 /* Call this to change the size of frame F's x-window.
10442 If CHANGE_GRAVITY, change to top-left-corner window gravity
10443 for this size change and subsequent size changes.
10444 Otherwise we leave the window gravity unchanged. */
10446 void
10447 x_set_window_size (struct frame *f, bool change_gravity,
10448 int width, int height, bool pixelwise)
10450 block_input ();
10452 /* The following breaks our calculations. If it's really needed,
10453 think of something else. */
10454 #if false
10455 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
10457 int text_width, text_height;
10459 /* When the frame is maximized/fullscreen or running under for
10460 example Xmonad, x_set_window_size_1 will be a no-op.
10461 In that case, the right thing to do is extend rows/width to
10462 the current frame size. We do that first if x_set_window_size_1
10463 turns out to not be a no-op (there is no way to know).
10464 The size will be adjusted again if the frame gets a
10465 ConfigureNotify event as a result of x_set_window_size. */
10466 int pixelh = FRAME_PIXEL_HEIGHT (f);
10467 #ifdef USE_X_TOOLKIT
10468 /* The menu bar is not part of text lines. The tool bar
10469 is however. */
10470 pixelh -= FRAME_MENUBAR_HEIGHT (f);
10471 #endif
10472 text_width = FRAME_PIXEL_TO_TEXT_WIDTH (f, FRAME_PIXEL_WIDTH (f));
10473 text_height = FRAME_PIXEL_TO_TEXT_HEIGHT (f, pixelh);
10475 change_frame_size (f, text_width, text_height, false, true, false, true);
10477 #endif
10479 /* Pixelize width and height, if necessary. */
10480 if (! pixelwise)
10482 width = width * FRAME_COLUMN_WIDTH (f);
10483 height = height * FRAME_LINE_HEIGHT (f);
10486 #ifdef USE_GTK
10487 if (FRAME_GTK_WIDGET (f))
10488 xg_frame_set_char_size (f, width, height);
10489 else
10490 x_set_window_size_1 (f, change_gravity, width, height);
10491 #else /* not USE_GTK */
10492 x_set_window_size_1 (f, change_gravity, width, height);
10493 x_clear_under_internal_border (f);
10494 #endif /* not USE_GTK */
10496 /* If cursor was outside the new size, mark it as off. */
10497 mark_window_cursors_off (XWINDOW (f->root_window));
10499 /* Clear out any recollection of where the mouse highlighting was,
10500 since it might be in a place that's outside the new frame size.
10501 Actually checking whether it is outside is a pain in the neck,
10502 so don't try--just let the highlighting be done afresh with new size. */
10503 cancel_mouse_face (f);
10505 unblock_input ();
10507 do_pending_window_change (false);
10510 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
10512 void
10513 frame_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
10515 block_input ();
10517 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
10518 0, 0, 0, 0, pix_x, pix_y);
10519 unblock_input ();
10522 /* Raise frame F. */
10524 void
10525 x_raise_frame (struct frame *f)
10527 block_input ();
10528 if (FRAME_VISIBLE_P (f))
10529 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
10530 XFlush (FRAME_X_DISPLAY (f));
10531 unblock_input ();
10534 /* Lower frame F. */
10536 static void
10537 x_lower_frame (struct frame *f)
10539 if (FRAME_VISIBLE_P (f))
10541 block_input ();
10542 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
10543 XFlush (FRAME_X_DISPLAY (f));
10544 unblock_input ();
10548 /* Request focus with XEmbed */
10550 void
10551 xembed_request_focus (struct frame *f)
10553 /* See XEmbed Protocol Specification at
10554 http://freedesktop.org/wiki/Specifications/xembed-spec */
10555 if (FRAME_VISIBLE_P (f))
10556 xembed_send_message (f, CurrentTime,
10557 XEMBED_REQUEST_FOCUS, 0, 0, 0);
10560 /* Activate frame with Extended Window Manager Hints */
10562 void
10563 x_ewmh_activate_frame (struct frame *f)
10565 /* See Window Manager Specification/Extended Window Manager Hints at
10566 http://freedesktop.org/wiki/Specifications/wm-spec */
10568 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
10570 if (FRAME_VISIBLE_P (f) && wm_supports (f, dpyinfo->Xatom_net_active_window))
10572 Lisp_Object frame;
10573 XSETFRAME (frame, f);
10574 x_send_client_event (frame, make_number (0), frame,
10575 dpyinfo->Xatom_net_active_window,
10576 make_number (32),
10577 list2i (1, dpyinfo->last_user_time));
10581 static void
10582 XTframe_raise_lower (struct frame *f, bool raise_flag)
10584 if (raise_flag)
10585 x_raise_frame (f);
10586 else
10587 x_lower_frame (f);
10590 /* XEmbed implementation. */
10592 #if defined USE_X_TOOLKIT || ! defined USE_GTK
10594 /* XEmbed implementation. */
10596 #define XEMBED_VERSION 0
10598 static void
10599 xembed_set_info (struct frame *f, enum xembed_info flags)
10601 unsigned long data[2];
10602 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
10604 data[0] = XEMBED_VERSION;
10605 data[1] = flags;
10607 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
10608 dpyinfo->Xatom_XEMBED_INFO, dpyinfo->Xatom_XEMBED_INFO,
10609 32, PropModeReplace, (unsigned char *) data, 2);
10611 #endif /* defined USE_X_TOOLKIT || ! defined USE_GTK */
10613 static void
10614 xembed_send_message (struct frame *f, Time t, enum xembed_message msg,
10615 long int detail, long int data1, long int data2)
10617 XEvent event;
10619 event.xclient.type = ClientMessage;
10620 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
10621 event.xclient.message_type = FRAME_DISPLAY_INFO (f)->Xatom_XEMBED;
10622 event.xclient.format = 32;
10623 event.xclient.data.l[0] = t;
10624 event.xclient.data.l[1] = msg;
10625 event.xclient.data.l[2] = detail;
10626 event.xclient.data.l[3] = data1;
10627 event.xclient.data.l[4] = data2;
10629 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
10630 False, NoEventMask, &event);
10631 XSync (FRAME_X_DISPLAY (f), False);
10634 /* Change of visibility. */
10636 /* This tries to wait until the frame is really visible.
10637 However, if the window manager asks the user where to position
10638 the frame, this will return before the user finishes doing that.
10639 The frame will not actually be visible at that time,
10640 but it will become visible later when the window manager
10641 finishes with it. */
10643 void
10644 x_make_frame_visible (struct frame *f)
10646 int original_top, original_left;
10647 int tries = 0;
10649 block_input ();
10651 x_set_bitmap_icon (f);
10653 if (! FRAME_VISIBLE_P (f))
10655 /* We test FRAME_GARBAGED_P here to make sure we don't
10656 call x_set_offset a second time
10657 if we get to x_make_frame_visible a second time
10658 before the window gets really visible. */
10659 if (! FRAME_ICONIFIED_P (f)
10660 && ! FRAME_X_EMBEDDED_P (f)
10661 && ! f->output_data.x->asked_for_visible)
10662 x_set_offset (f, f->left_pos, f->top_pos, 0);
10664 f->output_data.x->asked_for_visible = true;
10666 if (! EQ (Vx_no_window_manager, Qt))
10667 x_wm_set_window_state (f, NormalState);
10668 #ifdef USE_X_TOOLKIT
10669 if (FRAME_X_EMBEDDED_P (f))
10670 xembed_set_info (f, XEMBED_MAPPED);
10671 else
10673 /* This was XtPopup, but that did nothing for an iconified frame. */
10674 XtMapWidget (f->output_data.x->widget);
10676 #else /* not USE_X_TOOLKIT */
10677 #ifdef USE_GTK
10678 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
10679 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
10680 #else
10681 if (FRAME_X_EMBEDDED_P (f))
10682 xembed_set_info (f, XEMBED_MAPPED);
10683 else
10684 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
10685 #endif /* not USE_GTK */
10686 #endif /* not USE_X_TOOLKIT */
10689 XFlush (FRAME_X_DISPLAY (f));
10691 /* Synchronize to ensure Emacs knows the frame is visible
10692 before we do anything else. We do this loop with input not blocked
10693 so that incoming events are handled. */
10695 Lisp_Object frame;
10696 /* This must be before UNBLOCK_INPUT
10697 since events that arrive in response to the actions above
10698 will set it when they are handled. */
10699 bool previously_visible = f->output_data.x->has_been_visible;
10701 original_left = f->left_pos;
10702 original_top = f->top_pos;
10704 /* This must come after we set COUNT. */
10705 unblock_input ();
10707 /* We unblock here so that arriving X events are processed. */
10709 /* Now move the window back to where it was "supposed to be".
10710 But don't do it if the gravity is negative.
10711 When the gravity is negative, this uses a position
10712 that is 3 pixels too low. Perhaps that's really the border width.
10714 Don't do this if the window has never been visible before,
10715 because the window manager may choose the position
10716 and we don't want to override it. */
10718 if (! FRAME_VISIBLE_P (f)
10719 && ! FRAME_ICONIFIED_P (f)
10720 && ! FRAME_X_EMBEDDED_P (f)
10721 && f->win_gravity == NorthWestGravity
10722 && previously_visible)
10724 Drawable rootw;
10725 int x, y;
10726 unsigned int width, height, border, depth;
10728 block_input ();
10730 /* On some window managers (such as FVWM) moving an existing
10731 window, even to the same place, causes the window manager
10732 to introduce an offset. This can cause the window to move
10733 to an unexpected location. Check the geometry (a little
10734 slow here) and then verify that the window is in the right
10735 place. If the window is not in the right place, move it
10736 there, and take the potential window manager hit. */
10737 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
10738 &rootw, &x, &y, &width, &height, &border, &depth);
10740 if (original_left != x || original_top != y)
10741 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
10742 original_left, original_top);
10744 unblock_input ();
10747 XSETFRAME (frame, f);
10749 /* Process X events until a MapNotify event has been seen. */
10750 while (!FRAME_VISIBLE_P (f))
10752 /* Force processing of queued events. */
10753 x_sync (f);
10755 /* If on another desktop, the deiconify/map may be ignored and the
10756 frame never becomes visible. XMonad does this.
10757 Prevent an endless loop. */
10758 if (FRAME_ICONIFIED_P (f) && ++tries > 100)
10759 break;
10761 /* This hack is still in use at least for Cygwin. See
10762 http://lists.gnu.org/archive/html/emacs-devel/2013-12/msg00351.html.
10764 Machines that do polling rather than SIGIO have been
10765 observed to go into a busy-wait here. So we'll fake an
10766 alarm signal to let the handler know that there's something
10767 to be read. We used to raise a real alarm, but it seems
10768 that the handler isn't always enabled here. This is
10769 probably a bug. */
10770 if (input_polling_used ())
10772 /* It could be confusing if a real alarm arrives while
10773 processing the fake one. Turn it off and let the
10774 handler reset it. */
10775 int old_poll_suppress_count = poll_suppress_count;
10776 poll_suppress_count = 1;
10777 poll_for_input_1 ();
10778 poll_suppress_count = old_poll_suppress_count;
10781 if (XPending (FRAME_X_DISPLAY (f)))
10783 XEvent xev;
10784 XNextEvent (FRAME_X_DISPLAY (f), &xev);
10785 x_dispatch_event (&xev, FRAME_X_DISPLAY (f));
10791 /* Change from mapped state to withdrawn state. */
10793 /* Make the frame visible (mapped and not iconified). */
10795 void
10796 x_make_frame_invisible (struct frame *f)
10798 Window window;
10800 /* Use the frame's outermost window, not the one we normally draw on. */
10801 window = FRAME_OUTER_WINDOW (f);
10803 /* Don't keep the highlight on an invisible frame. */
10804 if (FRAME_DISPLAY_INFO (f)->x_highlight_frame == f)
10805 FRAME_DISPLAY_INFO (f)->x_highlight_frame = 0;
10807 block_input ();
10809 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
10810 that the current position of the window is user-specified, rather than
10811 program-specified, so that when the window is mapped again, it will be
10812 placed at the same location, without forcing the user to position it
10813 by hand again (they have already done that once for this window.) */
10814 x_wm_set_size_hint (f, 0, true);
10816 #ifdef USE_GTK
10817 if (FRAME_GTK_OUTER_WIDGET (f))
10818 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
10819 else
10820 #else
10821 if (FRAME_X_EMBEDDED_P (f))
10822 xembed_set_info (f, 0);
10823 else
10824 #endif
10827 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
10828 DefaultScreen (FRAME_X_DISPLAY (f))))
10830 unblock_input ();
10831 error ("Can't notify window manager of window withdrawal");
10835 /* We can't distinguish this from iconification
10836 just by the event that we get from the server.
10837 So we can't win using the usual strategy of letting
10838 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
10839 and synchronize with the server to make sure we agree. */
10840 SET_FRAME_VISIBLE (f, 0);
10841 SET_FRAME_ICONIFIED (f, false);
10843 x_sync (f);
10845 unblock_input ();
10848 /* Change window state from mapped to iconified. */
10850 void
10851 x_iconify_frame (struct frame *f)
10853 #ifdef USE_X_TOOLKIT
10854 int result;
10855 #endif
10857 /* Don't keep the highlight on an invisible frame. */
10858 if (FRAME_DISPLAY_INFO (f)->x_highlight_frame == f)
10859 FRAME_DISPLAY_INFO (f)->x_highlight_frame = 0;
10861 if (FRAME_ICONIFIED_P (f))
10862 return;
10864 block_input ();
10866 x_set_bitmap_icon (f);
10868 #if defined (USE_GTK)
10869 if (FRAME_GTK_OUTER_WIDGET (f))
10871 if (! FRAME_VISIBLE_P (f))
10872 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
10874 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
10875 SET_FRAME_VISIBLE (f, 0);
10876 SET_FRAME_ICONIFIED (f, true);
10877 unblock_input ();
10878 return;
10880 #endif
10882 #ifdef USE_X_TOOLKIT
10884 if (! FRAME_VISIBLE_P (f))
10886 if (! EQ (Vx_no_window_manager, Qt))
10887 x_wm_set_window_state (f, IconicState);
10888 /* This was XtPopup, but that did nothing for an iconified frame. */
10889 XtMapWidget (f->output_data.x->widget);
10890 /* The server won't give us any event to indicate
10891 that an invisible frame was changed to an icon,
10892 so we have to record it here. */
10893 SET_FRAME_VISIBLE (f, 0);
10894 SET_FRAME_ICONIFIED (f, true);
10895 unblock_input ();
10896 return;
10899 result = XIconifyWindow (FRAME_X_DISPLAY (f),
10900 XtWindow (f->output_data.x->widget),
10901 DefaultScreen (FRAME_X_DISPLAY (f)));
10902 unblock_input ();
10904 if (!result)
10905 error ("Can't notify window manager of iconification");
10907 SET_FRAME_ICONIFIED (f, true);
10908 SET_FRAME_VISIBLE (f, 0);
10910 block_input ();
10911 XFlush (FRAME_X_DISPLAY (f));
10912 unblock_input ();
10913 #else /* not USE_X_TOOLKIT */
10915 /* Make sure the X server knows where the window should be positioned,
10916 in case the user deiconifies with the window manager. */
10917 if (! FRAME_VISIBLE_P (f)
10918 && ! FRAME_ICONIFIED_P (f)
10919 && ! FRAME_X_EMBEDDED_P (f))
10920 x_set_offset (f, f->left_pos, f->top_pos, 0);
10922 /* Since we don't know which revision of X we're running, we'll use both
10923 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
10925 /* X11R4: send a ClientMessage to the window manager using the
10926 WM_CHANGE_STATE type. */
10928 XEvent msg;
10930 msg.xclient.window = FRAME_X_WINDOW (f);
10931 msg.xclient.type = ClientMessage;
10932 msg.xclient.message_type = FRAME_DISPLAY_INFO (f)->Xatom_wm_change_state;
10933 msg.xclient.format = 32;
10934 msg.xclient.data.l[0] = IconicState;
10936 if (! XSendEvent (FRAME_X_DISPLAY (f),
10937 DefaultRootWindow (FRAME_X_DISPLAY (f)),
10938 False,
10939 SubstructureRedirectMask | SubstructureNotifyMask,
10940 &msg))
10942 unblock_input ();
10943 error ("Can't notify window manager of iconification");
10947 /* X11R3: set the initial_state field of the window manager hints to
10948 IconicState. */
10949 x_wm_set_window_state (f, IconicState);
10951 if (!FRAME_VISIBLE_P (f))
10953 /* If the frame was withdrawn, before, we must map it. */
10954 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
10957 SET_FRAME_ICONIFIED (f, true);
10958 SET_FRAME_VISIBLE (f, 0);
10960 XFlush (FRAME_X_DISPLAY (f));
10961 unblock_input ();
10962 #endif /* not USE_X_TOOLKIT */
10966 /* Free X resources of frame F. */
10968 void
10969 x_free_frame_resources (struct frame *f)
10971 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
10972 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
10973 #ifdef USE_X_TOOLKIT
10974 Lisp_Object bar;
10975 struct scroll_bar *b;
10976 #endif
10978 block_input ();
10980 /* If a display connection is dead, don't try sending more
10981 commands to the X server. */
10982 if (dpyinfo->display)
10984 /* Always exit with visible pointer to avoid weird issue
10985 with Xfixes (Bug#17609). */
10986 if (f->pointer_invisible)
10987 FRAME_DISPLAY_INFO (f)->toggle_visible_pointer (f, 0);
10989 /* We must free faces before destroying windows because some
10990 font-driver (e.g. xft) access a window while finishing a
10991 face. */
10992 free_frame_faces (f);
10994 if (f->output_data.x->icon_desc)
10995 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
10997 #ifdef USE_X_TOOLKIT
10998 /* Explicitly destroy the scroll bars of the frame. Without
10999 this, we get "BadDrawable" errors from the toolkit later on,
11000 presumably from expose events generated for the disappearing
11001 toolkit scroll bars. */
11002 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
11004 b = XSCROLL_BAR (bar);
11005 x_scroll_bar_remove (b);
11007 #endif
11009 #ifdef HAVE_X_I18N
11010 if (FRAME_XIC (f))
11011 free_frame_xic (f);
11012 #endif
11014 x_free_cr_resources (f);
11015 #ifdef USE_X_TOOLKIT
11016 if (f->output_data.x->widget)
11018 XtDestroyWidget (f->output_data.x->widget);
11019 f->output_data.x->widget = NULL;
11021 /* Tooltips don't have widgets, only a simple X window, even if
11022 we are using a toolkit. */
11023 else if (FRAME_X_WINDOW (f))
11024 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
11026 free_frame_menubar (f);
11028 if (f->shell_position)
11029 xfree (f->shell_position);
11030 #else /* !USE_X_TOOLKIT */
11032 #ifdef USE_GTK
11033 xg_free_frame_widgets (f);
11034 #endif /* USE_GTK */
11036 if (FRAME_X_WINDOW (f))
11037 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
11038 #endif /* !USE_X_TOOLKIT */
11040 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
11041 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
11042 unload_color (f, f->output_data.x->cursor_pixel);
11043 unload_color (f, f->output_data.x->cursor_foreground_pixel);
11044 unload_color (f, f->output_data.x->border_pixel);
11045 unload_color (f, f->output_data.x->mouse_pixel);
11047 if (f->output_data.x->scroll_bar_background_pixel != -1)
11048 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
11049 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
11050 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
11051 #if defined (USE_LUCID) && defined (USE_TOOLKIT_SCROLL_BARS)
11052 /* Scrollbar shadow colors. */
11053 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
11054 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
11055 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
11056 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
11057 #endif /* USE_LUCID && USE_TOOLKIT_SCROLL_BARS */
11058 if (f->output_data.x->white_relief.pixel != -1)
11059 unload_color (f, f->output_data.x->white_relief.pixel);
11060 if (f->output_data.x->black_relief.pixel != -1)
11061 unload_color (f, f->output_data.x->black_relief.pixel);
11063 x_free_gcs (f);
11065 /* Free extra GCs allocated by x_setup_relief_colors. */
11066 if (f->output_data.x->white_relief.gc)
11068 XFreeGC (dpyinfo->display, f->output_data.x->white_relief.gc);
11069 f->output_data.x->white_relief.gc = 0;
11071 if (f->output_data.x->black_relief.gc)
11073 XFreeGC (dpyinfo->display, f->output_data.x->black_relief.gc);
11074 f->output_data.x->black_relief.gc = 0;
11077 /* Free cursors. */
11078 if (f->output_data.x->text_cursor != 0)
11079 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->text_cursor);
11080 if (f->output_data.x->nontext_cursor != 0)
11081 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->nontext_cursor);
11082 if (f->output_data.x->modeline_cursor != 0)
11083 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->modeline_cursor);
11084 if (f->output_data.x->hand_cursor != 0)
11085 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->hand_cursor);
11086 if (f->output_data.x->hourglass_cursor != 0)
11087 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->hourglass_cursor);
11088 if (f->output_data.x->horizontal_drag_cursor != 0)
11089 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->horizontal_drag_cursor);
11090 if (f->output_data.x->vertical_drag_cursor != 0)
11091 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->vertical_drag_cursor);
11093 XFlush (FRAME_X_DISPLAY (f));
11096 xfree (f->output_data.x->saved_menu_event);
11097 xfree (f->output_data.x);
11098 f->output_data.x = NULL;
11100 if (f == dpyinfo->x_focus_frame)
11101 dpyinfo->x_focus_frame = 0;
11102 if (f == dpyinfo->x_focus_event_frame)
11103 dpyinfo->x_focus_event_frame = 0;
11104 if (f == dpyinfo->x_highlight_frame)
11105 dpyinfo->x_highlight_frame = 0;
11106 if (f == hlinfo->mouse_face_mouse_frame)
11107 reset_mouse_highlight (hlinfo);
11109 unblock_input ();
11113 /* Destroy the X window of frame F. */
11115 static void
11116 x_destroy_window (struct frame *f)
11118 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
11120 /* If a display connection is dead, don't try sending more
11121 commands to the X server. */
11122 if (dpyinfo->display != 0)
11123 x_free_frame_resources (f);
11125 dpyinfo->reference_count--;
11129 /* Setting window manager hints. */
11131 /* Set the normal size hints for the window manager, for frame F.
11132 FLAGS is the flags word to use--or 0 meaning preserve the flags
11133 that the window now has.
11134 If USER_POSITION, set the USPosition
11135 flag (this is useful when FLAGS is 0).
11136 The GTK version is in gtkutils.c. */
11138 #ifndef USE_GTK
11139 void
11140 x_wm_set_size_hint (struct frame *f, long flags, bool user_position)
11142 XSizeHints size_hints;
11143 Window window = FRAME_OUTER_WINDOW (f);
11145 if (!window)
11146 return;
11148 #ifdef USE_X_TOOLKIT
11149 if (f->output_data.x->widget)
11151 widget_update_wm_size_hints (f->output_data.x->widget);
11152 return;
11154 #endif
11156 /* Setting PMaxSize caused various problems. */
11157 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
11159 size_hints.x = f->left_pos;
11160 size_hints.y = f->top_pos;
11162 size_hints.height = FRAME_PIXEL_HEIGHT (f);
11163 size_hints.width = FRAME_PIXEL_WIDTH (f);
11165 size_hints.width_inc = frame_resize_pixelwise ? 1 : FRAME_COLUMN_WIDTH (f);
11166 size_hints.height_inc = frame_resize_pixelwise ? 1 : FRAME_LINE_HEIGHT (f);
11168 size_hints.max_width = x_display_pixel_width (FRAME_DISPLAY_INFO (f))
11169 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
11170 size_hints.max_height = x_display_pixel_height (FRAME_DISPLAY_INFO (f))
11171 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
11173 /* Calculate the base and minimum sizes. */
11175 int base_width, base_height;
11176 int min_rows = 0, min_cols = 0;
11178 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
11179 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
11181 if (frame_resize_pixelwise)
11182 /* Needed to prevent a bad protocol error crash when making the
11183 frame size very small. */
11185 min_cols = 2 * min_cols;
11186 min_rows = 2 * min_rows;
11189 /* The window manager uses the base width hints to calculate the
11190 current number of rows and columns in the frame while
11191 resizing; min_width and min_height aren't useful for this
11192 purpose, since they might not give the dimensions for a
11193 zero-row, zero-column frame.
11195 We use the base_width and base_height members if we have
11196 them; otherwise, we set the min_width and min_height members
11197 to the size for a zero x zero frame. */
11199 size_hints.flags |= PBaseSize;
11200 size_hints.base_width = base_width;
11201 size_hints.base_height = base_height + FRAME_MENUBAR_HEIGHT (f);
11202 size_hints.min_width = base_width + min_cols * FRAME_COLUMN_WIDTH (f);
11203 size_hints.min_height = base_height + min_rows * FRAME_LINE_HEIGHT (f);
11206 /* If we don't need the old flags, we don't need the old hint at all. */
11207 if (flags)
11209 size_hints.flags |= flags;
11210 goto no_read;
11214 XSizeHints hints; /* Sometimes I hate X Windows... */
11215 long supplied_return;
11216 int value;
11218 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
11219 &supplied_return);
11221 if (flags)
11222 size_hints.flags |= flags;
11223 else
11225 if (value == 0)
11226 hints.flags = 0;
11227 if (hints.flags & PSize)
11228 size_hints.flags |= PSize;
11229 if (hints.flags & PPosition)
11230 size_hints.flags |= PPosition;
11231 if (hints.flags & USPosition)
11232 size_hints.flags |= USPosition;
11233 if (hints.flags & USSize)
11234 size_hints.flags |= USSize;
11238 no_read:
11240 #ifdef PWinGravity
11241 size_hints.win_gravity = f->win_gravity;
11242 size_hints.flags |= PWinGravity;
11244 if (user_position)
11246 size_hints.flags &= ~ PPosition;
11247 size_hints.flags |= USPosition;
11249 #endif /* PWinGravity */
11251 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
11253 #endif /* not USE_GTK */
11255 /* Used for IconicState or NormalState */
11257 static void
11258 x_wm_set_window_state (struct frame *f, int state)
11260 #ifdef USE_X_TOOLKIT
11261 Arg al[1];
11263 XtSetArg (al[0], XtNinitialState, state);
11264 XtSetValues (f->output_data.x->widget, al, 1);
11265 #else /* not USE_X_TOOLKIT */
11266 Window window = FRAME_X_WINDOW (f);
11268 f->output_data.x->wm_hints.flags |= StateHint;
11269 f->output_data.x->wm_hints.initial_state = state;
11271 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
11272 #endif /* not USE_X_TOOLKIT */
11275 static void
11276 x_wm_set_icon_pixmap (struct frame *f, ptrdiff_t pixmap_id)
11278 Pixmap icon_pixmap, icon_mask;
11280 #if !defined USE_X_TOOLKIT && !defined USE_GTK
11281 Window window = FRAME_OUTER_WINDOW (f);
11282 #endif
11284 if (pixmap_id > 0)
11286 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
11287 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
11288 icon_mask = x_bitmap_mask (f, pixmap_id);
11289 f->output_data.x->wm_hints.icon_mask = icon_mask;
11291 else
11293 /* It seems there is no way to turn off use of an icon
11294 pixmap. */
11295 return;
11299 #ifdef USE_GTK
11301 xg_set_frame_icon (f, icon_pixmap, icon_mask);
11302 return;
11305 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
11308 Arg al[1];
11309 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
11310 XtSetValues (f->output_data.x->widget, al, 1);
11311 XtSetArg (al[0], XtNiconMask, icon_mask);
11312 XtSetValues (f->output_data.x->widget, al, 1);
11315 #else /* not USE_X_TOOLKIT && not USE_GTK */
11317 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
11318 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
11320 #endif /* not USE_X_TOOLKIT && not USE_GTK */
11323 void
11324 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
11326 Window window = FRAME_OUTER_WINDOW (f);
11328 f->output_data.x->wm_hints.flags |= IconPositionHint;
11329 f->output_data.x->wm_hints.icon_x = icon_x;
11330 f->output_data.x->wm_hints.icon_y = icon_y;
11332 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
11336 /***********************************************************************
11337 Fonts
11338 ***********************************************************************/
11340 #ifdef GLYPH_DEBUG
11342 /* Check that FONT is valid on frame F. It is if it can be found in F's
11343 font table. */
11345 static void
11346 x_check_font (struct frame *f, struct font *font)
11348 eassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
11349 if (font->driver->check)
11350 eassert (font->driver->check (f, font) == 0);
11353 #endif /* GLYPH_DEBUG */
11356 /***********************************************************************
11357 Initialization
11358 ***********************************************************************/
11360 #ifdef USE_X_TOOLKIT
11361 static XrmOptionDescRec emacs_options[] = {
11362 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
11363 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
11365 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
11366 XrmoptionSepArg, NULL},
11367 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
11369 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
11370 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
11371 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
11372 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
11373 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
11374 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
11375 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
11378 /* Whether atimer for Xt timeouts is activated or not. */
11380 static bool x_timeout_atimer_activated_flag;
11382 #endif /* USE_X_TOOLKIT */
11384 static int x_initialized;
11386 /* Test whether two display-name strings agree up to the dot that separates
11387 the screen number from the server number. */
11388 static bool
11389 same_x_server (const char *name1, const char *name2)
11391 bool seen_colon = false;
11392 Lisp_Object sysname = Fsystem_name ();
11393 const char *system_name = SSDATA (sysname);
11394 ptrdiff_t system_name_length = SBYTES (sysname);
11395 ptrdiff_t length_until_period = 0;
11397 while (system_name[length_until_period] != 0
11398 && system_name[length_until_period] != '.')
11399 length_until_period++;
11401 /* Treat `unix' like an empty host name. */
11402 if (! strncmp (name1, "unix:", 5))
11403 name1 += 4;
11404 if (! strncmp (name2, "unix:", 5))
11405 name2 += 4;
11406 /* Treat this host's name like an empty host name. */
11407 if (! strncmp (name1, system_name, system_name_length)
11408 && name1[system_name_length] == ':')
11409 name1 += system_name_length;
11410 if (! strncmp (name2, system_name, system_name_length)
11411 && name2[system_name_length] == ':')
11412 name2 += system_name_length;
11413 /* Treat this host's domainless name like an empty host name. */
11414 if (! strncmp (name1, system_name, length_until_period)
11415 && name1[length_until_period] == ':')
11416 name1 += length_until_period;
11417 if (! strncmp (name2, system_name, length_until_period)
11418 && name2[length_until_period] == ':')
11419 name2 += length_until_period;
11421 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
11423 if (*name1 == ':')
11424 seen_colon = true;
11425 if (seen_colon && *name1 == '.')
11426 return true;
11428 return (seen_colon
11429 && (*name1 == '.' || *name1 == '\0')
11430 && (*name2 == '.' || *name2 == '\0'));
11433 /* Count number of set bits in mask and number of bits to shift to
11434 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
11435 to 5. */
11436 static void
11437 get_bits_and_offset (unsigned long mask, int *bits, int *offset)
11439 int nr = 0;
11440 int off = 0;
11442 while (!(mask & 1))
11444 off++;
11445 mask >>= 1;
11448 while (mask & 1)
11450 nr++;
11451 mask >>= 1;
11454 *offset = off;
11455 *bits = nr;
11458 /* Return true iff display DISPLAY is available for use.
11459 But don't permanently open it, just test its availability. */
11461 bool
11462 x_display_ok (const char *display)
11464 /* XOpenDisplay fails if it gets a signal. Block SIGIO which may arrive. */
11465 unrequest_sigio ();
11466 Display *dpy = XOpenDisplay (display);
11467 request_sigio ();
11468 if (!dpy)
11469 return false;
11470 XCloseDisplay (dpy);
11471 return true;
11474 #ifdef USE_GTK
11475 static void
11476 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
11477 const gchar *msg, gpointer user_data)
11479 if (!strstr (msg, "g_set_prgname"))
11480 fprintf (stderr, "%s-WARNING **: %s\n", log_domain, msg);
11482 #endif
11484 /* Create invisible cursor on X display referred by DPYINFO. */
11486 static Cursor
11487 make_invisible_cursor (struct x_display_info *dpyinfo)
11489 Display *dpy = dpyinfo->display;
11490 static char const no_data[] = { 0 };
11491 Pixmap pix;
11492 XColor col;
11493 Cursor c = 0;
11495 x_catch_errors (dpy);
11496 pix = XCreateBitmapFromData (dpy, dpyinfo->root_window, no_data, 1, 1);
11497 if (! x_had_errors_p (dpy) && pix != None)
11499 Cursor pixc;
11500 col.pixel = 0;
11501 col.red = col.green = col.blue = 0;
11502 col.flags = DoRed | DoGreen | DoBlue;
11503 pixc = XCreatePixmapCursor (dpy, pix, pix, &col, &col, 0, 0);
11504 if (! x_had_errors_p (dpy) && pixc != None)
11505 c = pixc;
11506 XFreePixmap (dpy, pix);
11509 x_uncatch_errors ();
11511 return c;
11514 /* True if DPY supports Xfixes extension >= 4. */
11516 static bool
11517 x_probe_xfixes_extension (Display *dpy)
11519 #ifdef HAVE_XFIXES
11520 int major, minor;
11521 return XFixesQueryVersion (dpy, &major, &minor) && major >= 4;
11522 #else
11523 return false;
11524 #endif /* HAVE_XFIXES */
11527 /* Toggle mouse pointer visibility on frame F by using Xfixes functions. */
11529 static void
11530 xfixes_toggle_visible_pointer (struct frame *f, bool invisible)
11532 #ifdef HAVE_XFIXES
11533 if (invisible)
11534 XFixesHideCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
11535 else
11536 XFixesShowCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
11537 f->pointer_invisible = invisible;
11538 #else
11539 emacs_abort ();
11540 #endif /* HAVE_XFIXES */
11543 /* Toggle mouse pointer visibility on frame F by using invisible cursor. */
11545 static void
11546 x_toggle_visible_pointer (struct frame *f, bool invisible)
11548 eassert (FRAME_DISPLAY_INFO (f)->invisible_cursor != 0);
11549 if (invisible)
11550 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
11551 FRAME_DISPLAY_INFO (f)->invisible_cursor);
11552 else
11553 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
11554 f->output_data.x->current_cursor);
11555 f->pointer_invisible = invisible;
11558 /* Setup pointer blanking, prefer Xfixes if available. */
11560 static void
11561 x_setup_pointer_blanking (struct x_display_info *dpyinfo)
11563 /* FIXME: the brave tester should set EMACS_XFIXES because we're suspecting
11564 X server bug, see http://debbugs.gnu.org/cgi/bugreport.cgi?bug=17609. */
11565 if (egetenv ("EMACS_XFIXES") && x_probe_xfixes_extension (dpyinfo->display))
11566 dpyinfo->toggle_visible_pointer = xfixes_toggle_visible_pointer;
11567 else
11569 dpyinfo->toggle_visible_pointer = x_toggle_visible_pointer;
11570 dpyinfo->invisible_cursor = make_invisible_cursor (dpyinfo);
11574 /* Current X display connection identifier. Incremented for each next
11575 connection established. */
11576 static unsigned x_display_id;
11578 /* Open a connection to X display DISPLAY_NAME, and return
11579 the structure that describes the open display.
11580 If we cannot contact the display, return null. */
11582 struct x_display_info *
11583 x_term_init (Lisp_Object display_name, char *xrm_option, char *resource_name)
11585 Display *dpy;
11586 struct terminal *terminal;
11587 struct x_display_info *dpyinfo;
11588 XrmDatabase xrdb;
11589 ptrdiff_t lim;
11591 block_input ();
11593 if (!x_initialized)
11595 x_initialize ();
11596 ++x_initialized;
11599 if (! x_display_ok (SSDATA (display_name)))
11600 error ("Display %s can't be opened", SSDATA (display_name));
11602 #ifdef USE_GTK
11604 #define NUM_ARGV 10
11605 int argc;
11606 char *argv[NUM_ARGV];
11607 char **argv2 = argv;
11608 guint id;
11610 if (x_initialized++ > 1)
11612 xg_display_open (SSDATA (display_name), &dpy);
11614 else
11616 static char display_opt[] = "--display";
11617 static char name_opt[] = "--name";
11619 for (argc = 0; argc < NUM_ARGV; ++argc)
11620 argv[argc] = 0;
11622 argc = 0;
11623 argv[argc++] = initial_argv[0];
11625 if (! NILP (display_name))
11627 argv[argc++] = display_opt;
11628 argv[argc++] = SSDATA (display_name);
11631 argv[argc++] = name_opt;
11632 argv[argc++] = resource_name;
11634 XSetLocaleModifiers ("");
11636 /* Work around GLib bug that outputs a faulty warning. See
11637 https://bugzilla.gnome.org/show_bug.cgi?id=563627. */
11638 id = g_log_set_handler ("GLib", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
11639 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
11641 /* NULL window -> events for all windows go to our function.
11642 Call before gtk_init so Gtk+ event filters comes after our. */
11643 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
11645 /* gtk_init does set_locale. Fix locale before and after. */
11646 fixup_locale ();
11647 unrequest_sigio (); /* See comment in x_display_ok. */
11648 gtk_init (&argc, &argv2);
11649 request_sigio ();
11650 fixup_locale ();
11652 g_log_remove_handler ("GLib", id);
11654 xg_initialize ();
11656 dpy = DEFAULT_GDK_DISPLAY ();
11658 #if ! GTK_CHECK_VERSION (2, 90, 0)
11659 /* Load our own gtkrc if it exists. */
11661 const char *file = "~/.emacs.d/gtkrc";
11662 Lisp_Object s, abs_file;
11664 s = build_string (file);
11665 abs_file = Fexpand_file_name (s, Qnil);
11667 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
11668 gtk_rc_parse (SSDATA (abs_file));
11670 #endif
11672 XSetErrorHandler (x_error_handler);
11673 XSetIOErrorHandler (x_io_error_quitter);
11676 #else /* not USE_GTK */
11677 #ifdef USE_X_TOOLKIT
11678 /* weiner@footloose.sps.mot.com reports that this causes
11679 errors with X11R5:
11680 X protocol error: BadAtom (invalid Atom parameter)
11681 on protocol request 18skiloaf.
11682 So let's not use it until R6. */
11683 #ifdef HAVE_X11XTR6
11684 XtSetLanguageProc (NULL, NULL, NULL);
11685 #endif
11688 int argc = 0;
11689 char *argv[3];
11691 argv[0] = "";
11692 argc = 1;
11693 if (xrm_option)
11695 argv[argc++] = "-xrm";
11696 argv[argc++] = xrm_option;
11698 turn_on_atimers (false);
11699 unrequest_sigio (); /* See comment in x_display_ok. */
11700 dpy = XtOpenDisplay (Xt_app_con, SSDATA (display_name),
11701 resource_name, EMACS_CLASS,
11702 emacs_options, XtNumber (emacs_options),
11703 &argc, argv);
11704 request_sigio ();
11705 turn_on_atimers (true);
11707 #ifdef HAVE_X11XTR6
11708 /* I think this is to compensate for XtSetLanguageProc. */
11709 fixup_locale ();
11710 #endif
11713 #else /* not USE_X_TOOLKIT */
11714 XSetLocaleModifiers ("");
11715 unrequest_sigio (); // See comment in x_display_ok.
11716 dpy = XOpenDisplay (SSDATA (display_name));
11717 request_sigio ();
11718 #endif /* not USE_X_TOOLKIT */
11719 #endif /* not USE_GTK*/
11721 /* Detect failure. */
11722 if (dpy == 0)
11724 unblock_input ();
11725 return 0;
11728 /* We have definitely succeeded. Record the new connection. */
11730 dpyinfo = xzalloc (sizeof *dpyinfo);
11731 terminal = x_create_terminal (dpyinfo);
11734 struct x_display_info *share;
11736 for (share = x_display_list; share; share = share->next)
11737 if (same_x_server (SSDATA (XCAR (share->name_list_element)),
11738 SSDATA (display_name)))
11739 break;
11740 if (share)
11741 terminal->kboard = share->terminal->kboard;
11742 else
11744 terminal->kboard = allocate_kboard (Qx);
11746 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
11748 char *vendor = ServerVendor (dpy);
11750 /* Protect terminal from GC before removing it from the
11751 list of terminals. */
11752 struct gcpro gcpro1;
11753 Lisp_Object gcpro_term;
11754 XSETTERMINAL (gcpro_term, terminal);
11755 GCPRO1 (gcpro_term);
11757 /* Temporarily hide the partially initialized terminal. */
11758 terminal_list = terminal->next_terminal;
11759 unblock_input ();
11760 kset_system_key_alist
11761 (terminal->kboard,
11762 call1 (Qvendor_specific_keysyms,
11763 vendor ? build_string (vendor) : empty_unibyte_string));
11764 block_input ();
11765 terminal->next_terminal = terminal_list;
11766 terminal_list = terminal;
11767 UNGCPRO;
11770 /* Don't let the initial kboard remain current longer than necessary.
11771 That would cause problems if a file loaded on startup tries to
11772 prompt in the mini-buffer. */
11773 if (current_kboard == initial_kboard)
11774 current_kboard = terminal->kboard;
11776 terminal->kboard->reference_count++;
11779 /* Put this display on the chain. */
11780 dpyinfo->next = x_display_list;
11781 x_display_list = dpyinfo;
11783 dpyinfo->name_list_element = Fcons (display_name, Qnil);
11784 dpyinfo->display = dpy;
11785 dpyinfo->connection = ConnectionNumber (dpyinfo->display);
11787 /* Set the name of the terminal. */
11788 terminal->name = xlispstrdup (display_name);
11790 #if false
11791 XSetAfterFunction (x_current_display, x_trace_wire);
11792 #endif
11794 lim = min (PTRDIFF_MAX, SIZE_MAX) - sizeof "@";
11795 Lisp_Object system_name = Fsystem_name ();
11796 if (lim - SBYTES (Vinvocation_name) < SBYTES (system_name))
11797 memory_full (SIZE_MAX);
11798 dpyinfo->x_id = ++x_display_id;
11799 dpyinfo->x_id_name = xmalloc (SBYTES (Vinvocation_name)
11800 + SBYTES (system_name) + 2);
11801 char *nametail = lispstpcpy (dpyinfo->x_id_name, Vinvocation_name);
11802 *nametail++ = '@';
11803 lispstpcpy (nametail, system_name);
11805 /* Figure out which modifier bits mean what. */
11806 x_find_modifier_meanings (dpyinfo);
11808 /* Get the scroll bar cursor. */
11809 #ifdef USE_GTK
11810 /* We must create a GTK cursor, it is required for GTK widgets. */
11811 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
11812 #endif /* USE_GTK */
11814 dpyinfo->vertical_scroll_bar_cursor
11815 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
11817 dpyinfo->horizontal_scroll_bar_cursor
11818 = XCreateFontCursor (dpyinfo->display, XC_sb_h_double_arrow);
11820 xrdb = x_load_resources (dpyinfo->display, xrm_option,
11821 resource_name, EMACS_CLASS);
11822 #ifdef HAVE_XRMSETDATABASE
11823 XrmSetDatabase (dpyinfo->display, xrdb);
11824 #else
11825 dpyinfo->display->db = xrdb;
11826 #endif
11827 /* Put the rdb where we can find it in a way that works on
11828 all versions. */
11829 dpyinfo->xrdb = xrdb;
11831 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
11832 DefaultScreen (dpyinfo->display));
11833 select_visual (dpyinfo);
11834 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
11835 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
11836 dpyinfo->icon_bitmap_id = -1;
11837 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
11839 reset_mouse_highlight (&dpyinfo->mouse_highlight);
11841 /* See if we can construct pixel values from RGB values. */
11842 if (dpyinfo->visual->class == TrueColor)
11844 get_bits_and_offset (dpyinfo->visual->red_mask,
11845 &dpyinfo->red_bits, &dpyinfo->red_offset);
11846 get_bits_and_offset (dpyinfo->visual->blue_mask,
11847 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
11848 get_bits_and_offset (dpyinfo->visual->green_mask,
11849 &dpyinfo->green_bits, &dpyinfo->green_offset);
11852 /* See if a private colormap is requested. */
11853 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
11855 if (dpyinfo->visual->class == PseudoColor)
11857 AUTO_STRING (privateColormap, "privateColormap");
11858 AUTO_STRING (PrivateColormap, "PrivateColormap");
11859 Lisp_Object value
11860 = display_x_get_resource (dpyinfo, privateColormap,
11861 PrivateColormap, Qnil, Qnil);
11862 if (STRINGP (value)
11863 && (!strcmp (SSDATA (value), "true")
11864 || !strcmp (SSDATA (value), "on")))
11865 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
11868 else
11869 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
11870 dpyinfo->visual, AllocNone);
11872 #ifdef HAVE_XFT
11874 /* If we are using Xft, the following precautions should be made:
11876 1. Make sure that the Xrender extension is added before the Xft one.
11877 Otherwise, the close-display hook set by Xft is called after the one
11878 for Xrender, and the former tries to re-add the latter. This results
11879 in inconsistency of internal states and leads to X protocol error when
11880 one reconnects to the same X server (Bug#1696).
11882 2. Check dpi value in X resources. It is better we use it as well,
11883 since Xft will use it, as will all Gnome applications. If our real DPI
11884 is smaller or larger than the one Xft uses, our font will look smaller
11885 or larger than other for other applications, even if it is the same
11886 font name (monospace-10 for example). */
11888 int event_base, error_base;
11889 char *v;
11890 double d;
11892 XRenderQueryExtension (dpyinfo->display, &event_base, &error_base);
11894 v = XGetDefault (dpyinfo->display, "Xft", "dpi");
11895 if (v != NULL && sscanf (v, "%lf", &d) == 1)
11896 dpyinfo->resy = dpyinfo->resx = d;
11898 #endif
11900 if (dpyinfo->resy < 1)
11902 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
11903 double pixels = DisplayHeight (dpyinfo->display, screen_number);
11904 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
11905 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
11906 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
11907 pixels = DisplayWidth (dpyinfo->display, screen_number);
11908 mm = DisplayWidthMM (dpyinfo->display, screen_number);
11909 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
11910 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
11914 static const struct
11916 const char *name;
11917 int offset;
11918 } atom_refs[] = {
11919 #define ATOM_REFS_INIT(string, member) \
11920 { string, offsetof (struct x_display_info, member) },
11921 ATOM_REFS_INIT ("WM_PROTOCOLS", Xatom_wm_protocols)
11922 ATOM_REFS_INIT ("WM_TAKE_FOCUS", Xatom_wm_take_focus)
11923 ATOM_REFS_INIT ("WM_SAVE_YOURSELF", Xatom_wm_save_yourself)
11924 ATOM_REFS_INIT ("WM_DELETE_WINDOW", Xatom_wm_delete_window)
11925 ATOM_REFS_INIT ("WM_CHANGE_STATE", Xatom_wm_change_state)
11926 ATOM_REFS_INIT ("WM_CONFIGURE_DENIED", Xatom_wm_configure_denied)
11927 ATOM_REFS_INIT ("WM_MOVED", Xatom_wm_window_moved)
11928 ATOM_REFS_INIT ("WM_CLIENT_LEADER", Xatom_wm_client_leader)
11929 ATOM_REFS_INIT ("Editres", Xatom_editres)
11930 ATOM_REFS_INIT ("CLIPBOARD", Xatom_CLIPBOARD)
11931 ATOM_REFS_INIT ("TIMESTAMP", Xatom_TIMESTAMP)
11932 ATOM_REFS_INIT ("TEXT", Xatom_TEXT)
11933 ATOM_REFS_INIT ("COMPOUND_TEXT", Xatom_COMPOUND_TEXT)
11934 ATOM_REFS_INIT ("UTF8_STRING", Xatom_UTF8_STRING)
11935 ATOM_REFS_INIT ("DELETE", Xatom_DELETE)
11936 ATOM_REFS_INIT ("MULTIPLE", Xatom_MULTIPLE)
11937 ATOM_REFS_INIT ("INCR", Xatom_INCR)
11938 ATOM_REFS_INIT ("_EMACS_TMP_", Xatom_EMACS_TMP)
11939 ATOM_REFS_INIT ("TARGETS", Xatom_TARGETS)
11940 ATOM_REFS_INIT ("NULL", Xatom_NULL)
11941 ATOM_REFS_INIT ("ATOM", Xatom_ATOM)
11942 ATOM_REFS_INIT ("ATOM_PAIR", Xatom_ATOM_PAIR)
11943 ATOM_REFS_INIT ("CLIPBOARD_MANAGER", Xatom_CLIPBOARD_MANAGER)
11944 ATOM_REFS_INIT ("_XEMBED_INFO", Xatom_XEMBED_INFO)
11945 /* For properties of font. */
11946 ATOM_REFS_INIT ("PIXEL_SIZE", Xatom_PIXEL_SIZE)
11947 ATOM_REFS_INIT ("AVERAGE_WIDTH", Xatom_AVERAGE_WIDTH)
11948 ATOM_REFS_INIT ("_MULE_BASELINE_OFFSET", Xatom_MULE_BASELINE_OFFSET)
11949 ATOM_REFS_INIT ("_MULE_RELATIVE_COMPOSE", Xatom_MULE_RELATIVE_COMPOSE)
11950 ATOM_REFS_INIT ("_MULE_DEFAULT_ASCENT", Xatom_MULE_DEFAULT_ASCENT)
11951 /* Ghostscript support. */
11952 ATOM_REFS_INIT ("DONE", Xatom_DONE)
11953 ATOM_REFS_INIT ("PAGE", Xatom_PAGE)
11954 ATOM_REFS_INIT ("SCROLLBAR", Xatom_Scrollbar)
11955 ATOM_REFS_INIT ("HORIZONTAL_SCROLLBAR", Xatom_Horizontal_Scrollbar)
11956 ATOM_REFS_INIT ("_XEMBED", Xatom_XEMBED)
11957 /* EWMH */
11958 ATOM_REFS_INIT ("_NET_WM_STATE", Xatom_net_wm_state)
11959 ATOM_REFS_INIT ("_NET_WM_STATE_FULLSCREEN", Xatom_net_wm_state_fullscreen)
11960 ATOM_REFS_INIT ("_NET_WM_STATE_MAXIMIZED_HORZ",
11961 Xatom_net_wm_state_maximized_horz)
11962 ATOM_REFS_INIT ("_NET_WM_STATE_MAXIMIZED_VERT",
11963 Xatom_net_wm_state_maximized_vert)
11964 ATOM_REFS_INIT ("_NET_WM_STATE_STICKY", Xatom_net_wm_state_sticky)
11965 ATOM_REFS_INIT ("_NET_WM_STATE_HIDDEN", Xatom_net_wm_state_hidden)
11966 ATOM_REFS_INIT ("_NET_WM_WINDOW_TYPE", Xatom_net_window_type)
11967 ATOM_REFS_INIT ("_NET_WM_WINDOW_TYPE_TOOLTIP",
11968 Xatom_net_window_type_tooltip)
11969 ATOM_REFS_INIT ("_NET_WM_ICON_NAME", Xatom_net_wm_icon_name)
11970 ATOM_REFS_INIT ("_NET_WM_NAME", Xatom_net_wm_name)
11971 ATOM_REFS_INIT ("_NET_SUPPORTED", Xatom_net_supported)
11972 ATOM_REFS_INIT ("_NET_SUPPORTING_WM_CHECK", Xatom_net_supporting_wm_check)
11973 ATOM_REFS_INIT ("_NET_WM_WINDOW_OPACITY", Xatom_net_wm_window_opacity)
11974 ATOM_REFS_INIT ("_NET_ACTIVE_WINDOW", Xatom_net_active_window)
11975 ATOM_REFS_INIT ("_NET_FRAME_EXTENTS", Xatom_net_frame_extents)
11976 ATOM_REFS_INIT ("_NET_CURRENT_DESKTOP", Xatom_net_current_desktop)
11977 ATOM_REFS_INIT ("_NET_WORKAREA", Xatom_net_workarea)
11978 /* Session management */
11979 ATOM_REFS_INIT ("SM_CLIENT_ID", Xatom_SM_CLIENT_ID)
11980 ATOM_REFS_INIT ("_XSETTINGS_SETTINGS", Xatom_xsettings_prop)
11981 ATOM_REFS_INIT ("MANAGER", Xatom_xsettings_mgr)
11984 int i;
11985 enum { atom_count = ARRAYELTS (atom_refs) };
11986 /* 1 for _XSETTINGS_SN. */
11987 enum { total_atom_count = 1 + atom_count };
11988 Atom atoms_return[total_atom_count];
11989 char *atom_names[total_atom_count];
11990 static char const xsettings_fmt[] = "_XSETTINGS_S%d";
11991 char xsettings_atom_name[sizeof xsettings_fmt - 2
11992 + INT_STRLEN_BOUND (int)];
11994 for (i = 0; i < atom_count; i++)
11995 atom_names[i] = (char *) atom_refs[i].name;
11997 /* Build _XSETTINGS_SN atom name. */
11998 sprintf (xsettings_atom_name, xsettings_fmt,
11999 XScreenNumberOfScreen (dpyinfo->screen));
12000 atom_names[i] = xsettings_atom_name;
12002 XInternAtoms (dpyinfo->display, atom_names, total_atom_count,
12003 False, atoms_return);
12005 for (i = 0; i < atom_count; i++)
12006 *(Atom *) ((char *) dpyinfo + atom_refs[i].offset) = atoms_return[i];
12008 /* Manually copy last atom. */
12009 dpyinfo->Xatom_xsettings_sel = atoms_return[i];
12012 dpyinfo->x_dnd_atoms_size = 8;
12013 dpyinfo->x_dnd_atoms = xmalloc (sizeof *dpyinfo->x_dnd_atoms
12014 * dpyinfo->x_dnd_atoms_size);
12015 dpyinfo->gray
12016 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
12017 gray_bits, gray_width, gray_height,
12018 1, 0, 1);
12020 x_setup_pointer_blanking (dpyinfo);
12022 #ifdef HAVE_X_I18N
12023 xim_initialize (dpyinfo, resource_name);
12024 #endif
12026 xsettings_initialize (dpyinfo);
12028 /* This is only needed for distinguishing keyboard and process input. */
12029 if (dpyinfo->connection != 0)
12030 add_keyboard_wait_descriptor (dpyinfo->connection);
12032 #ifdef F_SETOWN
12033 fcntl (dpyinfo->connection, F_SETOWN, getpid ());
12034 #endif /* ! defined (F_SETOWN) */
12036 if (interrupt_input)
12037 init_sigio (dpyinfo->connection);
12039 #ifdef USE_LUCID
12041 XrmValue d, fr, to;
12042 Font font;
12044 dpy = dpyinfo->display;
12045 d.addr = (XPointer)&dpy;
12046 d.size = sizeof (Display *);
12047 fr.addr = XtDefaultFont;
12048 fr.size = sizeof (XtDefaultFont);
12049 to.size = sizeof (Font *);
12050 to.addr = (XPointer)&font;
12051 x_catch_errors (dpy);
12052 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
12053 emacs_abort ();
12054 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
12055 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
12056 /* Do not free XFontStruct returned by the above call to XQueryFont.
12057 This leads to X protocol errors at XtCloseDisplay (Bug#18403). */
12058 x_uncatch_errors ();
12060 #endif
12062 /* See if we should run in synchronous mode. This is useful
12063 for debugging X code. */
12065 AUTO_STRING (synchronous, "synchronous");
12066 AUTO_STRING (Synchronous, "Synchronous");
12067 Lisp_Object value = display_x_get_resource (dpyinfo, synchronous,
12068 Synchronous, Qnil, Qnil);
12069 if (STRINGP (value)
12070 && (!strcmp (SSDATA (value), "true")
12071 || !strcmp (SSDATA (value), "on")))
12072 XSynchronize (dpyinfo->display, True);
12076 AUTO_STRING (useXIM, "useXIM");
12077 AUTO_STRING (UseXIM, "UseXIM");
12078 Lisp_Object value = display_x_get_resource (dpyinfo, useXIM, UseXIM,
12079 Qnil, Qnil);
12080 #ifdef USE_XIM
12081 if (STRINGP (value)
12082 && (!strcmp (SSDATA (value), "false")
12083 || !strcmp (SSDATA (value), "off")))
12084 use_xim = false;
12085 #else
12086 if (STRINGP (value)
12087 && (!strcmp (SSDATA (value), "true")
12088 || !strcmp (SSDATA (value), "on")))
12089 use_xim = true;
12090 #endif
12093 #ifdef HAVE_X_SM
12094 /* Only do this for the very first display in the Emacs session.
12095 Ignore X session management when Emacs was first started on a
12096 tty or started as a daemon. */
12097 if (terminal->id == 1 && ! IS_DAEMON)
12098 x_session_initialize (dpyinfo);
12099 #endif
12101 #ifdef USE_CAIRO
12102 x_extension_initialize (dpyinfo);
12103 #endif
12105 unblock_input ();
12107 return dpyinfo;
12110 /* Get rid of display DPYINFO, deleting all frames on it,
12111 and without sending any more commands to the X server. */
12113 static void
12114 x_delete_display (struct x_display_info *dpyinfo)
12116 struct terminal *t;
12118 /* Close all frames and delete the generic struct terminal for this
12119 X display. */
12120 for (t = terminal_list; t; t = t->next_terminal)
12121 if (t->type == output_x_window && t->display_info.x == dpyinfo)
12123 #ifdef HAVE_X_SM
12124 /* Close X session management when we close its display. */
12125 if (t->id == 1 && x_session_have_connection ())
12126 x_session_close ();
12127 #endif
12128 delete_terminal (t);
12129 break;
12132 if (next_noop_dpyinfo == dpyinfo)
12133 next_noop_dpyinfo = dpyinfo->next;
12135 if (x_display_list == dpyinfo)
12136 x_display_list = dpyinfo->next;
12137 else
12139 struct x_display_info *tail;
12141 for (tail = x_display_list; tail; tail = tail->next)
12142 if (tail->next == dpyinfo)
12143 tail->next = tail->next->next;
12146 xfree (dpyinfo->x_id_name);
12147 xfree (dpyinfo->x_dnd_atoms);
12148 xfree (dpyinfo->color_cells);
12149 xfree (dpyinfo);
12152 #ifdef USE_X_TOOLKIT
12154 /* Atimer callback function for TIMER. Called every 0.1s to process
12155 Xt timeouts, if needed. We must avoid calling XtAppPending as
12156 much as possible because that function does an implicit XFlush
12157 that slows us down. */
12159 static void
12160 x_process_timeouts (struct atimer *timer)
12162 block_input ();
12163 x_timeout_atimer_activated_flag = false;
12164 if (toolkit_scroll_bar_interaction || popup_activated ())
12166 while (XtAppPending (Xt_app_con) & XtIMTimer)
12167 XtAppProcessEvent (Xt_app_con, XtIMTimer);
12168 /* Reactivate the atimer for next time. */
12169 x_activate_timeout_atimer ();
12171 unblock_input ();
12174 /* Install an asynchronous timer that processes Xt timeout events
12175 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
12176 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
12177 function whenever these variables are set. This is necessary
12178 because some widget sets use timeouts internally, for example the
12179 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
12180 processed, these widgets don't behave normally. */
12182 void
12183 x_activate_timeout_atimer (void)
12185 block_input ();
12186 if (!x_timeout_atimer_activated_flag)
12188 struct timespec interval = make_timespec (0, 100 * 1000 * 1000);
12189 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
12190 x_timeout_atimer_activated_flag = true;
12192 unblock_input ();
12195 #endif /* USE_X_TOOLKIT */
12198 /* Set up use of X before we make the first connection. */
12200 static struct redisplay_interface x_redisplay_interface =
12202 x_frame_parm_handlers,
12203 x_produce_glyphs,
12204 x_write_glyphs,
12205 x_insert_glyphs,
12206 x_clear_end_of_line,
12207 x_scroll_run,
12208 x_after_update_window_line,
12209 x_update_window_begin,
12210 x_update_window_end,
12211 x_flush,
12212 x_clear_window_mouse_face,
12213 x_get_glyph_overhangs,
12214 x_fix_overlapping_area,
12215 x_draw_fringe_bitmap,
12216 #ifdef USE_CAIRO
12217 x_cr_define_fringe_bitmap,
12218 x_cr_destroy_fringe_bitmap,
12219 #else
12220 0, /* define_fringe_bitmap */
12221 0, /* destroy_fringe_bitmap */
12222 #endif
12223 x_compute_glyph_string_overhangs,
12224 x_draw_glyph_string,
12225 x_define_frame_cursor,
12226 x_clear_frame_area,
12227 x_draw_window_cursor,
12228 x_draw_vertical_window_border,
12229 x_draw_window_divider,
12230 x_shift_glyphs_for_insert, /* Never called; see comment in function. */
12231 x_show_hourglass,
12232 x_hide_hourglass
12236 /* This function is called when the last frame on a display is deleted. */
12237 void
12238 x_delete_terminal (struct terminal *terminal)
12240 struct x_display_info *dpyinfo = terminal->display_info.x;
12242 /* Protect against recursive calls. delete_frame in
12243 delete_terminal calls us back when it deletes our last frame. */
12244 if (!terminal->name)
12245 return;
12247 block_input ();
12248 #ifdef HAVE_X_I18N
12249 /* We must close our connection to the XIM server before closing the
12250 X display. */
12251 if (dpyinfo->xim)
12252 xim_close_dpy (dpyinfo);
12253 #endif
12255 /* Normally, the display is available... */
12256 if (dpyinfo->display)
12258 x_destroy_all_bitmaps (dpyinfo);
12259 XSetCloseDownMode (dpyinfo->display, DestroyAll);
12261 /* Whether or not XCloseDisplay destroys the associated resource
12262 database depends on the version of libX11. To avoid both
12263 crash and memory leak, we dissociate the database from the
12264 display and then destroy dpyinfo->xrdb ourselves.
12266 Unfortunately, the above strategy does not work in some
12267 situations due to a bug in newer versions of libX11: because
12268 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
12269 dpy->db is NULL, XCloseDisplay destroys the associated
12270 database whereas it has not been created by XGetDefault
12271 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
12272 don't destroy the database here in order to avoid the crash
12273 in the above situations for now, though that may cause memory
12274 leaks in other situations. */
12275 #if false
12276 #ifdef HAVE_XRMSETDATABASE
12277 XrmSetDatabase (dpyinfo->display, NULL);
12278 #else
12279 dpyinfo->display->db = NULL;
12280 #endif
12281 /* We used to call XrmDestroyDatabase from x_delete_display, but
12282 some older versions of libX11 crash if we call it after
12283 closing all the displays. */
12284 XrmDestroyDatabase (dpyinfo->xrdb);
12285 #endif
12287 #ifdef USE_GTK
12288 xg_display_close (dpyinfo->display);
12289 #else
12290 #ifdef USE_X_TOOLKIT
12291 XtCloseDisplay (dpyinfo->display);
12292 #else
12293 XCloseDisplay (dpyinfo->display);
12294 #endif
12295 #endif /* ! USE_GTK */
12296 /* Do not close the connection here because it's already closed
12297 by X(t)CloseDisplay (Bug#18403). */
12298 dpyinfo->display = NULL;
12301 /* ...but if called from x_connection_closed, the display may already
12302 be closed and dpyinfo->display was set to 0 to indicate that. Since
12303 X server is most likely gone, explicit close is the only reliable
12304 way to continue and avoid Bug#19147. */
12305 else if (dpyinfo->connection >= 0)
12306 emacs_close (dpyinfo->connection);
12308 /* No more input on this descriptor. */
12309 delete_keyboard_wait_descriptor (dpyinfo->connection);
12310 /* Mark as dead. */
12311 dpyinfo->connection = -1;
12313 x_delete_display (dpyinfo);
12314 unblock_input ();
12317 /* Create a struct terminal, initialize it with the X11 specific
12318 functions and make DISPLAY->TERMINAL point to it. */
12320 static struct terminal *
12321 x_create_terminal (struct x_display_info *dpyinfo)
12323 struct terminal *terminal;
12325 terminal = create_terminal (output_x_window, &x_redisplay_interface);
12327 terminal->display_info.x = dpyinfo;
12328 dpyinfo->terminal = terminal;
12330 /* kboard is initialized in x_term_init. */
12332 terminal->clear_frame_hook = x_clear_frame;
12333 terminal->ins_del_lines_hook = x_ins_del_lines;
12334 terminal->delete_glyphs_hook = x_delete_glyphs;
12335 terminal->ring_bell_hook = XTring_bell;
12336 terminal->toggle_invisible_pointer_hook = XTtoggle_invisible_pointer;
12337 terminal->update_begin_hook = x_update_begin;
12338 terminal->update_end_hook = x_update_end;
12339 terminal->read_socket_hook = XTread_socket;
12340 terminal->frame_up_to_date_hook = XTframe_up_to_date;
12341 terminal->mouse_position_hook = XTmouse_position;
12342 terminal->frame_rehighlight_hook = XTframe_rehighlight;
12343 terminal->frame_raise_lower_hook = XTframe_raise_lower;
12344 terminal->fullscreen_hook = XTfullscreen_hook;
12345 terminal->menu_show_hook = x_menu_show;
12346 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
12347 terminal->popup_dialog_hook = xw_popup_dialog;
12348 #endif
12349 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
12350 terminal->set_horizontal_scroll_bar_hook = XTset_horizontal_scroll_bar;
12351 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
12352 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
12353 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
12354 terminal->delete_frame_hook = x_destroy_window;
12355 terminal->delete_terminal_hook = x_delete_terminal;
12356 /* Other hooks are NULL by default. */
12358 return terminal;
12361 static void
12362 x_initialize (void)
12364 baud_rate = 19200;
12366 x_noop_count = 0;
12367 any_help_event_p = false;
12368 ignore_next_mouse_click_timeout = 0;
12370 #ifdef USE_GTK
12371 current_count = -1;
12372 #endif
12374 /* Try to use interrupt input; if we can't, then start polling. */
12375 Fset_input_interrupt_mode (Qt);
12377 #ifdef USE_X_TOOLKIT
12378 XtToolkitInitialize ();
12380 Xt_app_con = XtCreateApplicationContext ();
12382 /* Register a converter from strings to pixels, which uses
12383 Emacs' color allocation infrastructure. */
12384 XtAppSetTypeConverter (Xt_app_con,
12385 XtRString, XtRPixel, cvt_string_to_pixel,
12386 cvt_string_to_pixel_args,
12387 XtNumber (cvt_string_to_pixel_args),
12388 XtCacheByDisplay, cvt_pixel_dtor);
12390 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
12391 #endif
12393 #ifdef USE_TOOLKIT_SCROLL_BARS
12394 #ifndef USE_GTK
12395 xaw3d_arrow_scroll = False;
12396 xaw3d_pick_top = True;
12397 #endif
12398 #endif
12400 #ifdef USE_CAIRO
12401 x_cr_init_fringe (&x_redisplay_interface);
12402 #endif
12404 /* Note that there is no real way portable across R3/R4 to get the
12405 original error handler. */
12406 XSetErrorHandler (x_error_handler);
12407 XSetIOErrorHandler (x_io_error_quitter);
12410 #ifdef USE_GTK
12411 void
12412 init_xterm (void)
12414 /* Emacs can handle only core input events, so make sure
12415 Gtk doesn't use Xinput or Xinput2 extensions. */
12416 xputenv ("GDK_CORE_DEVICE_EVENTS=1");
12418 #endif
12420 void
12421 syms_of_xterm (void)
12423 x_error_message = NULL;
12425 DEFSYM (Qvendor_specific_keysyms, "vendor-specific-keysyms");
12426 DEFSYM (Qlatin_1, "latin-1");
12428 #ifdef USE_GTK
12429 xg_default_icon_file = build_pure_c_string ("icons/hicolor/scalable/apps/emacs.svg");
12430 staticpro (&xg_default_icon_file);
12432 DEFSYM (Qx_gtk_map_stock, "x-gtk-map-stock");
12433 #endif
12435 DEFVAR_BOOL ("x-use-underline-position-properties",
12436 x_use_underline_position_properties,
12437 doc: /* Non-nil means make use of UNDERLINE_POSITION font properties.
12438 A value of nil means ignore them. If you encounter fonts with bogus
12439 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
12440 to 4.1, set this to nil. You can also use `underline-minimum-offset'
12441 to override the font's UNDERLINE_POSITION for small font display
12442 sizes. */);
12443 x_use_underline_position_properties = true;
12445 DEFVAR_BOOL ("x-underline-at-descent-line",
12446 x_underline_at_descent_line,
12447 doc: /* Non-nil means to draw the underline at the same place as the descent line.
12448 A value of nil means to draw the underline according to the value of the
12449 variable `x-use-underline-position-properties', which is usually at the
12450 baseline level. The default value is nil. */);
12451 x_underline_at_descent_line = false;
12453 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
12454 x_mouse_click_focus_ignore_position,
12455 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
12456 This variable is only used when the window manager requires that you
12457 click on a frame to select it (give it focus). In that case, a value
12458 of nil, means that the selected window and cursor position changes to
12459 reflect the mouse click position, while a non-nil value means that the
12460 selected window or cursor position is preserved. */);
12461 x_mouse_click_focus_ignore_position = false;
12463 DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
12464 doc: /* Which toolkit scroll bars Emacs uses, if any.
12465 A value of nil means Emacs doesn't use toolkit scroll bars.
12466 With the X Window system, the value is a symbol describing the
12467 X toolkit. Possible values are: gtk, motif, xaw, or xaw3d.
12468 With MS Windows or Nextstep, the value is t. */);
12469 #ifdef USE_TOOLKIT_SCROLL_BARS
12470 #ifdef USE_MOTIF
12471 Vx_toolkit_scroll_bars = intern_c_string ("motif");
12472 #elif defined HAVE_XAW3D
12473 Vx_toolkit_scroll_bars = intern_c_string ("xaw3d");
12474 #elif USE_GTK
12475 Vx_toolkit_scroll_bars = intern_c_string ("gtk");
12476 #else
12477 Vx_toolkit_scroll_bars = intern_c_string ("xaw");
12478 #endif
12479 #else
12480 Vx_toolkit_scroll_bars = Qnil;
12481 #endif
12483 DEFSYM (Qmodifier_value, "modifier-value");
12484 DEFSYM (Qalt, "alt");
12485 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
12486 DEFSYM (Qhyper, "hyper");
12487 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
12488 DEFSYM (Qmeta, "meta");
12489 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
12490 DEFSYM (Qsuper, "super");
12491 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
12493 DEFVAR_LISP ("x-alt-keysym", Vx_alt_keysym,
12494 doc: /* Which keys Emacs uses for the alt modifier.
12495 This should be one of the symbols `alt', `hyper', `meta', `super'.
12496 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
12497 is nil, which is the same as `alt'. */);
12498 Vx_alt_keysym = Qnil;
12500 DEFVAR_LISP ("x-hyper-keysym", Vx_hyper_keysym,
12501 doc: /* Which keys Emacs uses for the hyper modifier.
12502 This should be one of the symbols `alt', `hyper', `meta', `super'.
12503 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
12504 default is nil, which is the same as `hyper'. */);
12505 Vx_hyper_keysym = Qnil;
12507 DEFVAR_LISP ("x-meta-keysym", Vx_meta_keysym,
12508 doc: /* Which keys Emacs uses for the meta modifier.
12509 This should be one of the symbols `alt', `hyper', `meta', `super'.
12510 For example, `meta' means use the Meta_L and Meta_R keysyms. The
12511 default is nil, which is the same as `meta'. */);
12512 Vx_meta_keysym = Qnil;
12514 DEFVAR_LISP ("x-super-keysym", Vx_super_keysym,
12515 doc: /* Which keys Emacs uses for the super modifier.
12516 This should be one of the symbols `alt', `hyper', `meta', `super'.
12517 For example, `super' means use the Super_L and Super_R keysyms. The
12518 default is nil, which is the same as `super'. */);
12519 Vx_super_keysym = Qnil;
12521 DEFVAR_LISP ("x-keysym-table", Vx_keysym_table,
12522 doc: /* Hash table of character codes indexed by X keysym codes. */);
12523 Vx_keysym_table = make_hash_table (hashtest_eql, make_number (900),
12524 make_float (DEFAULT_REHASH_SIZE),
12525 make_float (DEFAULT_REHASH_THRESHOLD),
12526 Qnil);
12528 DEFVAR_BOOL ("x-frame-normalize-before-maximize",
12529 x_frame_normalize_before_maximize,
12530 doc: /* Non-nil means normalize frame before maximizing.
12531 If this variable is t, Emacs first asks the window manager to give the
12532 frame its normal size, and only then the final state, whenever changing
12533 from a full-height, full-width or full-both state to the maximized one
12534 or when changing from the maximized to the full-height or full-width
12535 state.
12537 Set this variable only if your window manager cannot handle the
12538 transition between the various maximization states. */);
12539 x_frame_normalize_before_maximize = false;