]> code.delx.au - gnu-emacs/blob - src/xterm.c
Merge branch 'master' into cairo
[gnu-emacs] / src / xterm.c
1 /* X Communication module for terminals which understand the X protocol.
2
3 Copyright (C) 1989, 1993-2015 Free Software Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
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.
11
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.
16
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/>. */
19
20 /* New display code by Gerd Moellmann <gerd@gnu.org>. */
21 /* Xt features made by Fred Pierresteguy. */
22
23 #include <config.h>
24 #include <stdio.h>
25 #ifdef USE_CAIRO
26 #include <math.h>
27 #endif
28
29 #include "lisp.h"
30 #include "blockinput.h"
31 #include "syssignal.h"
32
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>
37
38 /* If we have Xfixes extension, use it for pointer blanking. */
39 #ifdef HAVE_XFIXES
40 #include <X11/extensions/Xfixes.h>
41 #endif
42
43 /* Using Xft implies that XRender is available. */
44 #ifdef HAVE_XFT
45 #include <X11/extensions/Xrender.h>
46 #endif
47
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 */
53
54 #include <sys/ioctl.h>
55
56 #include "systime.h"
57
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> */
63
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"
87
88 #ifdef USE_X_TOOLKIT
89 #include <X11/Shell.h>
90 #endif
91
92 #include <unistd.h>
93
94 #ifdef USE_GTK
95 #include "gtkutil.h"
96 #ifdef HAVE_GTK3
97 #include <X11/Xproto.h>
98 #endif
99 #endif
100
101 #if defined (USE_LUCID) || defined (USE_MOTIF)
102 #include "../lwlib/xlwmenu.h"
103 #endif
104
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 */
110
111 /* Include toolkit specific headers for the scroll bar widget. */
112
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 */
118
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 */
132
133 #endif /* USE_X_TOOLKIT */
134
135 #ifdef USE_X_TOOLKIT
136 #include "widget.h"
137 #ifndef XtNinitialState
138 #define XtNinitialState "initialState"
139 #endif
140 #endif
141
142 #include "bitmaps/gray.xbm"
143
144 #ifdef HAVE_XKB
145 #include <X11/XKBlib.h>
146 #endif
147
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
154
155 /* Non-zero means that a HELP_EVENT has been generated since Emacs
156 start. */
157
158 static bool any_help_event_p;
159
160 /* This is a chain of structures for all the X displays currently in
161 use. */
162
163 struct x_display_info *x_display_list;
164
165 #ifdef USE_X_TOOLKIT
166
167 /* The application context for Xt use. */
168 XtAppContext Xt_app_con;
169 static String Xt_default_resources[] = {0};
170
171 /* Non-zero means user is interacting with a toolkit scroll bar. */
172 static bool toolkit_scroll_bar_interaction;
173
174 #endif /* USE_X_TOOLKIT */
175
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). */
179
180 static Time ignore_next_mouse_click_timeout;
181
182 /* Used locally within XTread_socket. */
183
184 static int x_noop_count;
185
186 #ifdef USE_GTK
187 /* The name of the Emacs icon file. */
188 static Lisp_Object xg_default_icon_file;
189 #endif
190
191 /* Some functions take this as char *, not const char *. */
192 static char emacs_class[] = EMACS_CLASS;
193
194 enum xembed_info
195 {
196 XEMBED_MAPPED = 1 << 0
197 };
198
199 enum xembed_message
200 {
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,
209
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
215 };
216
217 static bool x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
218 static void x_set_window_size_1 (struct frame *, bool, int, int);
219 static void x_raise_frame (struct frame *);
220 static void x_lower_frame (struct frame *);
221 static const XColor *x_color_cells (Display *, int *);
222 static int x_io_error_quitter (Display *);
223 static struct terminal *x_create_terminal (struct x_display_info *);
224 static void x_update_end (struct frame *);
225 static void XTframe_up_to_date (struct frame *);
226 static void x_clear_area1 (Display *, Window, int, int, int, int, int);
227 static void x_clear_frame (struct frame *);
228 static _Noreturn void x_ins_del_lines (struct frame *, int, int);
229 static void frame_highlight (struct frame *);
230 static void frame_unhighlight (struct frame *);
231 static void x_new_focus_frame (struct x_display_info *, struct frame *);
232 static void x_focus_changed (int, int, struct x_display_info *,
233 struct frame *, struct input_event *);
234 static void XTframe_rehighlight (struct frame *);
235 static void x_frame_rehighlight (struct x_display_info *);
236 static void x_draw_hollow_cursor (struct window *, struct glyph_row *);
237 static void x_draw_bar_cursor (struct window *, struct glyph_row *, int,
238 enum text_cursor_kinds);
239
240 static void x_clip_to_row (struct window *, struct glyph_row *,
241 enum glyph_row_area, GC);
242 static void x_flush (struct frame *f);
243 static void x_update_begin (struct frame *);
244 static void x_update_window_begin (struct window *);
245 static struct scroll_bar *x_window_to_scroll_bar (Display *, Window, int);
246 static void x_scroll_bar_report_motion (struct frame **, Lisp_Object *,
247 enum scroll_bar_part *,
248 Lisp_Object *, Lisp_Object *,
249 Time *);
250 static void x_horizontal_scroll_bar_report_motion (struct frame **, Lisp_Object *,
251 enum scroll_bar_part *,
252 Lisp_Object *, Lisp_Object *,
253 Time *);
254 static bool x_handle_net_wm_state (struct frame *, const XPropertyEvent *);
255 static void x_check_fullscreen (struct frame *);
256 static void x_check_expected_move (struct frame *, int, int);
257 static void x_sync_with_move (struct frame *, int, int, bool);
258 static int handle_one_xevent (struct x_display_info *,
259 const XEvent *, int *,
260 struct input_event *);
261 #if ! (defined USE_X_TOOLKIT || defined USE_MOTIF)
262 static int x_dispatch_event (XEvent *, Display *);
263 #endif
264 /* Don't declare this _Noreturn because we want no
265 interference with debugging failing X calls. */
266 static void x_connection_closed (Display *, const char *, bool);
267 static void x_wm_set_window_state (struct frame *, int);
268 static void x_wm_set_icon_pixmap (struct frame *, ptrdiff_t);
269 static void x_initialize (void);
270
271 static bool get_current_wm_state (struct frame *, Window, int *, bool *);
272
273 /* Flush display of frame F. */
274
275 static void
276 x_flush (struct frame *f)
277 {
278 eassert (f && FRAME_X_P (f));
279 /* Don't call XFlush when it is not safe to redisplay; the X
280 connection may be broken. */
281 if (!NILP (Vinhibit_redisplay))
282 return;
283
284 block_input ();
285 XFlush (FRAME_X_DISPLAY (f));
286 unblock_input ();
287 }
288
289
290 /* Remove calls to XFlush by defining XFlush to an empty replacement.
291 Calls to XFlush should be unnecessary because the X output buffer
292 is flushed automatically as needed by calls to XPending,
293 XNextEvent, or XWindowEvent according to the XFlush man page.
294 XTread_socket calls XPending. Removing XFlush improves
295 performance. */
296
297 #define XFlush(DISPLAY) (void) 0
298
299 \f
300 /***********************************************************************
301 Debugging
302 ***********************************************************************/
303
304 #if false
305
306 /* This is a function useful for recording debugging information about
307 the sequence of occurrences in this file. */
308
309 struct record
310 {
311 char *locus;
312 int type;
313 };
314
315 struct record event_record[100];
316
317 int event_record_index;
318
319 void
320 record_event (char *locus, int type)
321 {
322 if (event_record_index == ARRAYELTS (event_record))
323 event_record_index = 0;
324
325 event_record[event_record_index].locus = locus;
326 event_record[event_record_index].type = type;
327 event_record_index++;
328 }
329
330 #endif
331
332 static void x_free_cr_resources (struct frame *);
333 static void x_set_clip_rectangles (struct frame *, GC, XRectangle *, int);
334 static void x_reset_clip_rectangles (struct frame *, GC);
335 static void x_fill_rectangle (struct frame *, GC, int, int, int, int);
336 static void x_draw_rectangle (struct frame *, GC, int, int, int, int);
337 static void x_fill_trapezoid_for_relief (struct frame *, GC, int, int,
338 int, int, int);
339 static void x_clear_window (struct frame *);
340
341 #ifdef USE_CAIRO
342 static struct x_gc_ext_data *x_gc_get_ext_data (struct frame *, GC, int);
343 static void x_extension_initialize (struct x_display_info *);
344 static cairo_status_t x_cr_accumulate_data (void *,
345 const unsigned char *,
346 unsigned int);
347
348 #define FRAME_CR_CONTEXT(f) ((f)->output_data.x->cr_context)
349 #define FRAME_CR_SURFACE(f) ((f)->output_data.x->cr_surface)
350
351 static struct x_gc_ext_data *
352 x_gc_get_ext_data (struct frame *f, GC gc, int create_if_not_found_p)
353 {
354 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
355 XEDataObject object;
356 XExtData **head, *ext_data;
357
358 object.gc = gc;
359 head = XEHeadOfExtensionList (object);
360 ext_data = XFindOnExtensionList (head, dpyinfo->ext_codes->extension);
361 if (ext_data == NULL)
362 {
363 if (!create_if_not_found_p)
364 return NULL;
365 else
366 {
367 ext_data = xzalloc (sizeof (*ext_data));
368 ext_data->number = dpyinfo->ext_codes->extension;
369 ext_data->private_data = xzalloc (sizeof (struct x_gc_ext_data));
370 XAddToExtensionList (head, ext_data);
371 }
372 }
373 return (struct x_gc_ext_data *) ext_data->private_data;
374 }
375
376 static void
377 x_extension_initialize (struct x_display_info *dpyinfo)
378 {
379 XExtCodes *ext_codes = XAddExtension (dpyinfo->display);
380
381 dpyinfo->ext_codes = ext_codes;
382 }
383
384 static void
385 x_cr_destroy_surface (struct frame *f)
386 {
387 if (FRAME_CR_SURFACE (f))
388 {
389 cairo_t *cr = FRAME_CR_CONTEXT (f);
390 cairo_surface_destroy (FRAME_CR_SURFACE (f));
391 FRAME_CR_SURFACE (f) = 0;
392 if (cr) cairo_destroy (cr);
393 FRAME_CR_CONTEXT (f) = NULL;
394 }
395 }
396
397 cairo_t *
398 x_begin_cr_clip (struct frame *f, GC gc)
399 {
400 cairo_t *cr = FRAME_CR_CONTEXT (f);
401
402 if (!cr)
403 {
404
405 if (! FRAME_CR_SURFACE (f))
406 {
407 cairo_surface_t *surface;
408 surface = cairo_xlib_surface_create (FRAME_X_DISPLAY (f),
409 FRAME_X_WINDOW (f),
410 FRAME_DISPLAY_INFO (f)->visual,
411 FRAME_PIXEL_WIDTH (f),
412 FRAME_PIXEL_HEIGHT (f));
413 cr = cairo_create (surface);
414 cairo_surface_destroy (surface);
415 }
416 else
417 cr = cairo_create (FRAME_CR_SURFACE (f));
418 FRAME_CR_CONTEXT (f) = cr;
419 }
420 cairo_save (cr);
421
422 if (gc)
423 {
424 struct x_gc_ext_data *gc_ext = x_gc_get_ext_data (f, gc, 0);
425
426 if (gc_ext && gc_ext->n_clip_rects)
427 {
428 int i;
429
430 for (i = 0; i < gc_ext->n_clip_rects; i++)
431 cairo_rectangle (cr, gc_ext->clip_rects[i].x,
432 gc_ext->clip_rects[i].y,
433 gc_ext->clip_rects[i].width,
434 gc_ext->clip_rects[i].height);
435 cairo_clip (cr);
436 }
437 }
438
439 return cr;
440 }
441
442 void
443 x_end_cr_clip (struct frame *f)
444 {
445 cairo_restore (FRAME_CR_CONTEXT (f));
446 }
447
448 void
449 x_set_cr_source_with_gc_foreground (struct frame *f, GC gc)
450 {
451 XGCValues xgcv;
452 XColor color;
453
454 XGetGCValues (FRAME_X_DISPLAY (f), gc, GCForeground, &xgcv);
455 color.pixel = xgcv.foreground;
456 x_query_color (f, &color);
457 cairo_set_source_rgb (FRAME_CR_CONTEXT (f), color.red / 65535.0,
458 color.green / 65535.0, color.blue / 65535.0);
459 }
460
461 void
462 x_set_cr_source_with_gc_background (struct frame *f, GC gc)
463 {
464 XGCValues xgcv;
465 XColor color;
466
467 XGetGCValues (FRAME_X_DISPLAY (f), gc, GCBackground, &xgcv);
468 color.pixel = xgcv.background;
469 x_query_color (f, &color);
470 cairo_set_source_rgb (FRAME_CR_CONTEXT (f), color.red / 65535.0,
471 color.green / 65535.0, color.blue / 65535.0);
472 }
473
474 /* Fringe bitmaps. */
475
476 static int max_fringe_bmp = 0;
477 static cairo_pattern_t **fringe_bmp = 0;
478
479 static void
480 x_cr_define_fringe_bitmap (int which, unsigned short *bits, int h, int wd)
481 {
482 int i, stride;
483 cairo_surface_t *surface;
484 unsigned char *data;
485 cairo_pattern_t *pattern;
486
487 if (which >= max_fringe_bmp)
488 {
489 i = max_fringe_bmp;
490 max_fringe_bmp = which + 20;
491 fringe_bmp = (cairo_pattern_t **) xrealloc (fringe_bmp, max_fringe_bmp * sizeof (cairo_pattern_t *));
492 while (i < max_fringe_bmp)
493 fringe_bmp[i++] = 0;
494 }
495
496 block_input ();
497
498 surface = cairo_image_surface_create (CAIRO_FORMAT_A1, wd, h);
499 stride = cairo_image_surface_get_stride (surface);
500 data = cairo_image_surface_get_data (surface);
501
502 for (i = 0; i < h; i++)
503 {
504 *((unsigned short *) data) = bits[i];
505 data += stride;
506 }
507
508 cairo_surface_mark_dirty (surface);
509 pattern = cairo_pattern_create_for_surface (surface);
510 cairo_surface_destroy (surface);
511
512 unblock_input ();
513
514 fringe_bmp[which] = pattern;
515 }
516
517 static void
518 x_cr_destroy_fringe_bitmap (int which)
519 {
520 if (which >= max_fringe_bmp)
521 return;
522
523 if (fringe_bmp[which])
524 {
525 block_input ();
526 cairo_pattern_destroy (fringe_bmp[which]);
527 unblock_input ();
528 }
529 fringe_bmp[which] = 0;
530 }
531
532 static void
533 x_cr_draw_image (struct frame *f, GC gc, cairo_pattern_t *image,
534 int src_x, int src_y, int width, int height,
535 int dest_x, int dest_y, bool overlay_p)
536 {
537 cairo_t *cr;
538 cairo_matrix_t matrix;
539 cairo_surface_t *surface;
540 cairo_format_t format;
541
542 cr = x_begin_cr_clip (f, gc);
543 if (overlay_p)
544 cairo_rectangle (cr, dest_x, dest_y, width, height);
545 else
546 {
547 x_set_cr_source_with_gc_background (f, gc);
548 cairo_rectangle (cr, dest_x, dest_y, width, height);
549 cairo_fill_preserve (cr);
550 }
551 cairo_clip (cr);
552 cairo_matrix_init_translate (&matrix, src_x - dest_x, src_y - dest_y);
553 cairo_pattern_set_matrix (image, &matrix);
554 cairo_pattern_get_surface (image, &surface);
555 format = cairo_image_surface_get_format (surface);
556 if (format != CAIRO_FORMAT_A8 && format != CAIRO_FORMAT_A1)
557 {
558 cairo_set_source (cr, image);
559 cairo_fill (cr);
560 }
561 else
562 {
563 x_set_cr_source_with_gc_foreground (f, gc);
564 cairo_mask (cr, image);
565 }
566 x_end_cr_clip (f);
567 }
568
569 void
570 x_cr_draw_frame (cairo_t *cr, struct frame *f)
571 {
572 int width, height;
573
574 width = FRAME_PIXEL_WIDTH (f);
575 height = FRAME_PIXEL_HEIGHT (f);
576
577 x_free_cr_resources (f);
578 FRAME_CR_CONTEXT (f) = cr;
579 x_clear_area (f, 0, 0, width, height);
580 expose_frame (f, 0, 0, width, height);
581 FRAME_CR_CONTEXT (f) = NULL;
582 }
583
584 static cairo_status_t
585 x_cr_accumulate_data (void *closure, const unsigned char *data,
586 unsigned int length)
587 {
588 Lisp_Object *acc = (Lisp_Object *) closure;
589
590 *acc = Fcons (make_unibyte_string (data, length), *acc);
591
592 return CAIRO_STATUS_SUCCESS;
593 }
594
595 static void
596 x_cr_destroy (Lisp_Object arg)
597 {
598 cairo_t *cr = (cairo_t *) XSAVE_POINTER (arg, 0);
599
600 block_input ();
601 cairo_destroy (cr);
602 unblock_input ();
603 }
604
605 Lisp_Object
606 x_cr_export_frames (Lisp_Object frames, cairo_surface_type_t surface_type)
607 {
608 struct frame *f;
609 cairo_surface_t *surface;
610 cairo_t *cr;
611 int width, height;
612 void (*surface_set_size_func) (cairo_surface_t *, double, double) = NULL;
613 Lisp_Object acc = Qnil, args[2];
614 int count = SPECPDL_INDEX ();
615
616 Fredisplay (Qt);
617
618 f = XFRAME (XCAR (frames));
619 frames = XCDR (frames);
620 width = FRAME_PIXEL_WIDTH (f);
621 height = FRAME_PIXEL_HEIGHT (f);
622
623 block_input ();
624 #ifdef CAIRO_HAS_PDF_SURFACE
625 if (surface_type == CAIRO_SURFACE_TYPE_PDF)
626 {
627 surface = cairo_pdf_surface_create_for_stream (x_cr_accumulate_data, &acc,
628 width, height);
629 surface_set_size_func = cairo_pdf_surface_set_size;
630 }
631 else
632 #endif
633 #ifdef CAIRO_HAS_PNG_FUNCTIONS
634 if (surface_type == CAIRO_SURFACE_TYPE_IMAGE)
635 surface = cairo_image_surface_create (CAIRO_FORMAT_RGB24, width, height);
636 else
637 #endif
638 #ifdef CAIRO_HAS_PS_SURFACE
639 if (surface_type == CAIRO_SURFACE_TYPE_PS)
640 {
641 surface = cairo_ps_surface_create_for_stream (x_cr_accumulate_data, &acc,
642 width, height);
643 surface_set_size_func = cairo_ps_surface_set_size;
644 }
645 else
646 #endif
647 #ifdef CAIRO_HAS_SVG_SURFACE
648 if (surface_type == CAIRO_SURFACE_TYPE_SVG)
649 surface = cairo_svg_surface_create_for_stream (x_cr_accumulate_data, &acc,
650 width, height);
651 else
652 #endif
653 abort ();
654
655 cr = cairo_create (surface);
656 cairo_surface_destroy (surface);
657 record_unwind_protect (x_cr_destroy, make_save_ptr (cr));
658 unblock_input ();
659
660 while (1)
661 {
662 QUIT;
663
664 block_input ();
665 x_free_cr_resources (f);
666 FRAME_CR_CONTEXT (f) = cr;
667 x_clear_area (f, 0, 0, width, height);
668 expose_frame (f, 0, 0, width, height);
669 FRAME_CR_CONTEXT (f) = NULL;
670 unblock_input ();
671
672 if (NILP (frames))
673 break;
674
675 block_input ();
676 cairo_surface_show_page (surface);
677 f = XFRAME (XCAR (frames));
678 frames = XCDR (frames);
679 width = FRAME_PIXEL_WIDTH (f);
680 height = FRAME_PIXEL_HEIGHT (f);
681 if (surface_set_size_func)
682 (*surface_set_size_func) (surface, width, height);
683 unblock_input ();
684 }
685
686 #ifdef CAIRO_HAS_PNG_FUNCTIONS
687 if (surface_type == CAIRO_SURFACE_TYPE_IMAGE)
688 {
689 block_input ();
690 cairo_surface_flush (surface);
691 cairo_surface_write_to_png_stream (surface, x_cr_accumulate_data, &acc);
692 unblock_input ();
693 }
694 #endif
695 unbind_to (count, Qnil);
696
697 args[0] = intern ("concat");
698 args[1] = Fnreverse (acc);
699 return Fapply (2, args);
700 }
701
702 #endif /* USE_CAIRO */
703
704 static void
705 x_free_cr_resources (struct frame *f)
706 {
707 #ifdef USE_CAIRO
708 if (f == NULL)
709 {
710 Lisp_Object rest, frame;
711 FOR_EACH_FRAME (rest, frame)
712 if (FRAME_X_P (XFRAME (frame)))
713 x_free_cr_resources (XFRAME (frame));
714 }
715 else
716 {
717 cairo_t *cr = FRAME_CR_CONTEXT (f);
718
719 if (cr)
720 {
721 cairo_surface_t *surface = cairo_get_target (cr);
722
723 if (cairo_surface_get_type (surface) == CAIRO_SURFACE_TYPE_XLIB)
724 {
725 cairo_destroy (cr);
726 FRAME_CR_CONTEXT (f) = NULL;
727 }
728 }
729 }
730 #endif
731 }
732
733 static void
734 x_set_clip_rectangles (struct frame *f, GC gc, XRectangle *rectangles, int n)
735 {
736 XSetClipRectangles (FRAME_X_DISPLAY (f), gc, 0, 0, rectangles, n, Unsorted);
737 #ifdef USE_CAIRO
738 eassert (n >= 0 && n <= MAX_CLIP_RECTS);
739
740 {
741 struct x_gc_ext_data *gc_ext = x_gc_get_ext_data (f, gc, 1);
742
743 gc_ext->n_clip_rects = n;
744 memcpy (gc_ext->clip_rects, rectangles, sizeof (XRectangle) * n);
745 }
746 #endif
747 }
748
749 static void
750 x_reset_clip_rectangles (struct frame *f, GC gc)
751 {
752 XSetClipMask (FRAME_X_DISPLAY (f), gc, None);
753 #ifdef USE_CAIRO
754 {
755 struct x_gc_ext_data *gc_ext = x_gc_get_ext_data (f, gc, 0);
756
757 if (gc_ext)
758 gc_ext->n_clip_rects = 0;
759 }
760 #endif
761 }
762
763 static void
764 x_fill_rectangle (struct frame *f, GC gc, int x, int y, int width, int height)
765 {
766 #ifdef USE_CAIRO
767 cairo_t *cr;
768
769 cr = x_begin_cr_clip (f, gc);
770 x_set_cr_source_with_gc_foreground (f, gc);
771 cairo_rectangle (cr, x, y, width, height);
772 cairo_fill (cr);
773 x_end_cr_clip (f);
774 #else
775 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
776 gc, x, y, width, height);
777 #endif
778 }
779
780 static void
781 x_draw_rectangle (struct frame *f, GC gc, int x, int y, int width, int height)
782 {
783 #ifdef USE_CAIRO
784 cairo_t *cr;
785
786 cr = x_begin_cr_clip (f, gc);
787 x_set_cr_source_with_gc_foreground (f, gc);
788 cairo_rectangle (cr, x + 0.5, y + 0.5, width, height);
789 cairo_set_line_width (cr, 1);
790 cairo_stroke (cr);
791 x_end_cr_clip (f);
792 #else
793 XDrawRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
794 gc, x, y, width, height);
795 #endif
796 }
797
798 static void
799 x_clear_window (struct frame *f)
800 {
801 #ifdef USE_CAIRO
802 cairo_t *cr;
803
804 cr = x_begin_cr_clip (f, NULL);
805 x_set_cr_source_with_gc_background (f, f->output_data.x->normal_gc);
806 cairo_paint (cr);
807 x_end_cr_clip (f);
808 #else
809 XClearWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
810 #endif
811 }
812
813 #ifdef USE_CAIRO
814 static void
815 x_fill_trapezoid_for_relief (struct frame *f, GC gc, int x, int y,
816 int width, int height, int top_p)
817 {
818 cairo_t *cr;
819
820 cr = x_begin_cr_clip (f, gc);
821 x_set_cr_source_with_gc_foreground (f, gc);
822 cairo_move_to (cr, top_p ? x : x + height, y);
823 cairo_line_to (cr, x, y + height);
824 cairo_line_to (cr, top_p ? x + width - height : x + width, y + height);
825 cairo_line_to (cr, x + width, y);
826 cairo_fill (cr);
827 x_end_cr_clip (f);
828 }
829
830 enum corners
831 {
832 CORNER_BOTTOM_RIGHT, /* 0 -> pi/2 */
833 CORNER_BOTTOM_LEFT, /* pi/2 -> pi */
834 CORNER_TOP_LEFT, /* pi -> 3pi/2 */
835 CORNER_TOP_RIGHT, /* 3pi/2 -> 2pi */
836 CORNER_LAST
837 };
838
839 static void
840 x_erase_corners_for_relief (struct frame *f, GC gc, int x, int y,
841 int width, int height,
842 double radius, double margin, int corners)
843 {
844 cairo_t *cr;
845 int i;
846
847 cr = x_begin_cr_clip (f, gc);
848 x_set_cr_source_with_gc_background (f, gc);
849 for (i = 0; i < CORNER_LAST; i++)
850 if (corners & (1 << i))
851 {
852 double xm, ym, xc, yc;
853
854 if (i == CORNER_TOP_LEFT || i == CORNER_BOTTOM_LEFT)
855 xm = x - margin, xc = xm + radius;
856 else
857 xm = x + width + margin, xc = xm - radius;
858 if (i == CORNER_TOP_LEFT || i == CORNER_TOP_RIGHT)
859 ym = y - margin, yc = ym + radius;
860 else
861 ym = y + height + margin, yc = ym - radius;
862
863 cairo_move_to (cr, xm, ym);
864 cairo_arc (cr, xc, yc, radius, i * M_PI_2, (i + 1) * M_PI_2);
865 }
866 cairo_clip (cr);
867 cairo_rectangle (cr, x, y, width, height);
868 cairo_fill (cr);
869 x_end_cr_clip (f);
870 }
871
872 static void
873 x_draw_horizontal_wave (struct frame *f, GC gc, int x, int y,
874 int width, int height, int wave_length)
875 {
876 cairo_t *cr;
877 double dx = wave_length, dy = height - 1;
878 int xoffset, n;
879
880 cr = x_begin_cr_clip (f, gc);
881 x_set_cr_source_with_gc_foreground (f, gc);
882 cairo_rectangle (cr, x, y, width, height);
883 cairo_clip (cr);
884
885 if (x >= 0)
886 {
887 xoffset = x % (wave_length * 2);
888 if (xoffset == 0)
889 xoffset = wave_length * 2;
890 }
891 else
892 xoffset = x % (wave_length * 2) + wave_length * 2;
893 n = (width + xoffset) / wave_length + 1;
894 if (xoffset > wave_length)
895 {
896 xoffset -= wave_length;
897 --n;
898 y += height - 1;
899 dy = -dy;
900 }
901
902 cairo_move_to (cr, x - xoffset + 0.5, y + 0.5);
903 while (--n >= 0)
904 {
905 cairo_rel_line_to (cr, dx, dy);
906 dy = -dy;
907 }
908 cairo_set_line_width (cr, 1);
909 cairo_stroke (cr);
910 x_end_cr_clip (f);
911 }
912 #endif
913
914 \f
915 /* Return the struct x_display_info corresponding to DPY. */
916
917 struct x_display_info *
918 x_display_info_for_display (Display *dpy)
919 {
920 struct x_display_info *dpyinfo;
921
922 for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
923 if (dpyinfo->display == dpy)
924 return dpyinfo;
925
926 return 0;
927 }
928
929 static Window
930 x_find_topmost_parent (struct frame *f)
931 {
932 struct x_output *x = f->output_data.x;
933 Window win = None, wi = x->parent_desc;
934 Display *dpy = FRAME_X_DISPLAY (f);
935
936 while (wi != FRAME_DISPLAY_INFO (f)->root_window)
937 {
938 Window root;
939 Window *children;
940 unsigned int nchildren;
941
942 win = wi;
943 if (XQueryTree (dpy, win, &root, &wi, &children, &nchildren))
944 XFree (children);
945 else
946 break;
947 }
948
949 return win;
950 }
951
952 #define OPAQUE 0xffffffff
953
954 void
955 x_set_frame_alpha (struct frame *f)
956 {
957 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
958 Display *dpy = FRAME_X_DISPLAY (f);
959 Window win = FRAME_OUTER_WINDOW (f);
960 double alpha = 1.0;
961 double alpha_min = 1.0;
962 unsigned long opac;
963 Window parent;
964
965 if (dpyinfo->x_highlight_frame == f)
966 alpha = f->alpha[0];
967 else
968 alpha = f->alpha[1];
969
970 if (FLOATP (Vframe_alpha_lower_limit))
971 alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
972 else if (INTEGERP (Vframe_alpha_lower_limit))
973 alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;
974
975 if (alpha < 0.0)
976 return;
977 else if (alpha > 1.0)
978 alpha = 1.0;
979 else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
980 alpha = alpha_min;
981
982 opac = alpha * OPAQUE;
983
984 x_catch_errors (dpy);
985
986 /* If there is a parent from the window manager, put the property there
987 also, to work around broken window managers that fail to do that.
988 Do this unconditionally as this function is called on reparent when
989 alpha has not changed on the frame. */
990
991 parent = x_find_topmost_parent (f);
992 if (parent != None)
993 XChangeProperty (dpy, parent, dpyinfo->Xatom_net_wm_window_opacity,
994 XA_CARDINAL, 32, PropModeReplace,
995 (unsigned char *) &opac, 1);
996
997 /* return unless necessary */
998 {
999 unsigned char *data;
1000 Atom actual;
1001 int rc, format;
1002 unsigned long n, left;
1003
1004 rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
1005 0, 1, False, XA_CARDINAL,
1006 &actual, &format, &n, &left,
1007 &data);
1008
1009 if (rc == Success && actual != None)
1010 {
1011 unsigned long value = *(unsigned long *)data;
1012 XFree (data);
1013 if (value == opac)
1014 {
1015 x_uncatch_errors ();
1016 return;
1017 }
1018 }
1019 }
1020
1021 XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
1022 XA_CARDINAL, 32, PropModeReplace,
1023 (unsigned char *) &opac, 1);
1024 x_uncatch_errors ();
1025 }
1026
1027 /***********************************************************************
1028 Starting and ending an update
1029 ***********************************************************************/
1030
1031 /* Start an update of frame F. This function is installed as a hook
1032 for update_begin, i.e. it is called when update_begin is called.
1033 This function is called prior to calls to x_update_window_begin for
1034 each window being updated. Currently, there is nothing to do here
1035 because all interesting stuff is done on a window basis. */
1036
1037 static void
1038 x_update_begin (struct frame *f)
1039 {
1040 #ifdef USE_CAIRO
1041 if (! NILP (tip_frame) && XFRAME (tip_frame) == f
1042 && ! FRAME_VISIBLE_P (f))
1043 return;
1044
1045 if (! FRAME_CR_SURFACE (f))
1046 {
1047 int width, height;
1048 #ifdef USE_GTK
1049 if (FRAME_GTK_WIDGET (f))
1050 {
1051 GdkWindow *w = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
1052 width = gdk_window_get_width (w);
1053 height = gdk_window_get_height (w);
1054 }
1055 else
1056 #endif
1057 {
1058 width = FRAME_PIXEL_WIDTH (f);
1059 height = FRAME_PIXEL_HEIGHT (f);
1060 if (! FRAME_EXTERNAL_TOOL_BAR (f))
1061 height += FRAME_TOOL_BAR_HEIGHT (f);
1062 if (! FRAME_EXTERNAL_MENU_BAR (f))
1063 height += FRAME_MENU_BAR_HEIGHT (f);
1064 }
1065
1066 if (width > 0 && height > 0)
1067 {
1068 block_input();
1069 FRAME_CR_SURFACE (f) = cairo_image_surface_create
1070 (CAIRO_FORMAT_ARGB32, width, height);
1071 unblock_input();
1072 }
1073 }
1074 #endif /* USE_CAIRO */
1075 }
1076
1077 /* Start update of window W. */
1078
1079 static void
1080 x_update_window_begin (struct window *w)
1081 {
1082 struct frame *f = XFRAME (WINDOW_FRAME (w));
1083 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
1084
1085 w->output_cursor = w->cursor;
1086
1087 block_input ();
1088
1089 if (f == hlinfo->mouse_face_mouse_frame)
1090 {
1091 /* Don't do highlighting for mouse motion during the update. */
1092 hlinfo->mouse_face_defer = true;
1093
1094 /* If F needs to be redrawn, simply forget about any prior mouse
1095 highlighting. */
1096 if (FRAME_GARBAGED_P (f))
1097 hlinfo->mouse_face_window = Qnil;
1098 }
1099
1100 unblock_input ();
1101 }
1102
1103
1104 /* Draw a vertical window border from (x,y0) to (x,y1) */
1105
1106 static void
1107 x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
1108 {
1109 struct frame *f = XFRAME (WINDOW_FRAME (w));
1110 struct face *face;
1111
1112 face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
1113 if (face)
1114 XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
1115 face->foreground);
1116
1117 #ifdef USE_CAIRO
1118 x_fill_rectangle (f, f->output_data.x->normal_gc, x, y0, 1, y1 - y0);
1119 #else
1120 XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
1121 f->output_data.x->normal_gc, x, y0, x, y1);
1122 #endif
1123 }
1124
1125 /* Draw a window divider from (x0,y0) to (x1,y1) */
1126
1127 static void
1128 x_draw_window_divider (struct window *w, int x0, int x1, int y0, int y1)
1129 {
1130 struct frame *f = XFRAME (WINDOW_FRAME (w));
1131 struct face *face = FACE_FROM_ID (f, WINDOW_DIVIDER_FACE_ID);
1132 struct face *face_first = FACE_FROM_ID (f, WINDOW_DIVIDER_FIRST_PIXEL_FACE_ID);
1133 struct face *face_last = FACE_FROM_ID (f, WINDOW_DIVIDER_LAST_PIXEL_FACE_ID);
1134 unsigned long color = face ? face->foreground : FRAME_FOREGROUND_PIXEL (f);
1135 unsigned long color_first = (face_first
1136 ? face_first->foreground
1137 : FRAME_FOREGROUND_PIXEL (f));
1138 unsigned long color_last = (face_last
1139 ? face_last->foreground
1140 : FRAME_FOREGROUND_PIXEL (f));
1141 Display *display = FRAME_X_DISPLAY (f);
1142
1143 if (y1 - y0 > x1 - x0 && x1 - x0 > 2)
1144 /* Vertical. */
1145 {
1146 XSetForeground (display, f->output_data.x->normal_gc, color_first);
1147 x_fill_rectangle (f, f->output_data.x->normal_gc,
1148 x0, y0, 1, y1 - y0);
1149 XSetForeground (display, f->output_data.x->normal_gc, color);
1150 x_fill_rectangle (f, f->output_data.x->normal_gc,
1151 x0 + 1, y0, x1 - x0 - 2, y1 - y0);
1152 XSetForeground (display, f->output_data.x->normal_gc, color_last);
1153 x_fill_rectangle (f, f->output_data.x->normal_gc,
1154 x1 - 1, y0, 1, y1 - y0);
1155 }
1156 else if (x1 - x0 > y1 - y0 && y1 - y0 > 3)
1157 /* Horizontal. */
1158 {
1159 XSetForeground (display, f->output_data.x->normal_gc, color_first);
1160 x_fill_rectangle (f, f->output_data.x->normal_gc,
1161 x0, y0, x1 - x0, 1);
1162 XSetForeground (display, f->output_data.x->normal_gc, color);
1163 x_fill_rectangle (f, f->output_data.x->normal_gc,
1164 x0, y0 + 1, x1 - x0, y1 - y0 - 2);
1165 XSetForeground (display, f->output_data.x->normal_gc, color_last);
1166 x_fill_rectangle (f, f->output_data.x->normal_gc,
1167 x0, y1 - 1, x1 - x0, 1);
1168 }
1169 else
1170 {
1171 XSetForeground (display, f->output_data.x->normal_gc, color);
1172 x_fill_rectangle (f, f->output_data.x->normal_gc,
1173 x0, y0, x1 - x0, y1 - y0);
1174 }
1175 }
1176
1177 /* End update of window W.
1178
1179 Draw vertical borders between horizontally adjacent windows, and
1180 display W's cursor if CURSOR_ON_P is non-zero.
1181
1182 MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
1183 glyphs in mouse-face were overwritten. In that case we have to
1184 make sure that the mouse-highlight is properly redrawn.
1185
1186 W may be a menu bar pseudo-window in case we don't have X toolkit
1187 support. Such windows don't have a cursor, so don't display it
1188 here. */
1189
1190 static void
1191 x_update_window_end (struct window *w, bool cursor_on_p,
1192 bool mouse_face_overwritten_p)
1193 {
1194 if (!w->pseudo_window_p)
1195 {
1196 block_input ();
1197
1198 if (cursor_on_p)
1199 display_and_set_cursor (w, true,
1200 w->output_cursor.hpos, w->output_cursor.vpos,
1201 w->output_cursor.x, w->output_cursor.y);
1202
1203 if (draw_window_fringes (w, true))
1204 {
1205 if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
1206 x_draw_right_divider (w);
1207 else
1208 x_draw_vertical_border (w);
1209 }
1210
1211 unblock_input ();
1212 }
1213
1214 /* If a row with mouse-face was overwritten, arrange for
1215 XTframe_up_to_date to redisplay the mouse highlight. */
1216 if (mouse_face_overwritten_p)
1217 {
1218 Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
1219
1220 hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
1221 hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
1222 hlinfo->mouse_face_window = Qnil;
1223 }
1224 }
1225
1226
1227 /* End update of frame F. This function is installed as a hook in
1228 update_end. */
1229
1230 static void
1231 x_update_end (struct frame *f)
1232 {
1233 /* Mouse highlight may be displayed again. */
1234 MOUSE_HL_INFO (f)->mouse_face_defer = false;
1235
1236 #ifdef USE_CAIRO
1237 if (FRAME_CR_SURFACE (f))
1238 {
1239 cairo_t *cr = 0;
1240 block_input();
1241 #if defined (USE_GTK) && defined (HAVE_GTK3)
1242 if (FRAME_GTK_WIDGET (f))
1243 {
1244 GdkWindow *w = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
1245 cr = gdk_cairo_create (w);
1246 }
1247 else
1248 #endif
1249 {
1250 cairo_surface_t *surface;
1251 int width = FRAME_PIXEL_WIDTH (f);
1252 int height = FRAME_PIXEL_HEIGHT (f);
1253 if (! FRAME_EXTERNAL_TOOL_BAR (f))
1254 height += FRAME_TOOL_BAR_HEIGHT (f);
1255 if (! FRAME_EXTERNAL_MENU_BAR (f))
1256 height += FRAME_MENU_BAR_HEIGHT (f);
1257 surface = cairo_xlib_surface_create (FRAME_X_DISPLAY (f),
1258 FRAME_X_WINDOW (f),
1259 FRAME_DISPLAY_INFO (f)->visual,
1260 width,
1261 height);
1262 cr = cairo_create (surface);
1263 cairo_surface_destroy (surface);
1264 }
1265
1266 cairo_set_source_surface (cr, FRAME_CR_SURFACE (f), 0, 0);
1267 cairo_paint (cr);
1268 cairo_destroy (cr);
1269 unblock_input ();
1270 }
1271 #endif /* USE_CAIRO */
1272
1273 #ifndef XFlush
1274 block_input ();
1275 XFlush (FRAME_X_DISPLAY (f));
1276 unblock_input ();
1277 #endif
1278 }
1279
1280
1281 /* This function is called from various places in xdisp.c
1282 whenever a complete update has been performed. */
1283
1284 static void
1285 XTframe_up_to_date (struct frame *f)
1286 {
1287 if (FRAME_X_P (f))
1288 FRAME_MOUSE_UPDATE (f);
1289 }
1290
1291
1292 /* Clear under internal border if any (GTK has its own version). */
1293 #ifndef USE_GTK
1294 void
1295 x_clear_under_internal_border (struct frame *f)
1296 {
1297 if (FRAME_INTERNAL_BORDER_WIDTH (f) > 0)
1298 {
1299 int border = FRAME_INTERNAL_BORDER_WIDTH (f);
1300 int width = FRAME_PIXEL_WIDTH (f);
1301 int height = FRAME_PIXEL_HEIGHT (f);
1302 int margin = FRAME_TOP_MARGIN_HEIGHT (f);
1303
1304 block_input ();
1305 x_clear_area (f, 0, 0, border, height);
1306 x_clear_area (f, 0, margin, width, border);
1307 x_clear_area (f, width - border, 0, border, height);
1308 x_clear_area (f, 0, height - border, width, border);
1309 unblock_input ();
1310 }
1311 }
1312 #endif
1313
1314 /* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
1315 arrow bitmaps, or clear the fringes if no bitmaps are required
1316 before DESIRED_ROW is made current. This function is called from
1317 update_window_line only if it is known that there are differences
1318 between bitmaps to be drawn between current row and DESIRED_ROW. */
1319
1320 static void
1321 x_after_update_window_line (struct window *w, struct glyph_row *desired_row)
1322 {
1323 eassert (w);
1324
1325 if (!desired_row->mode_line_p && !w->pseudo_window_p)
1326 desired_row->redraw_fringe_bitmaps_p = true;
1327
1328 #ifdef USE_X_TOOLKIT
1329 /* When a window has disappeared, make sure that no rest of
1330 full-width rows stays visible in the internal border. Could
1331 check here if updated window is the leftmost/rightmost window,
1332 but I guess it's not worth doing since vertically split windows
1333 are almost never used, internal border is rarely set, and the
1334 overhead is very small. */
1335 {
1336 struct frame *f;
1337 int width, height;
1338
1339 if (windows_or_buffers_changed
1340 && desired_row->full_width_p
1341 && (f = XFRAME (w->frame),
1342 width = FRAME_INTERNAL_BORDER_WIDTH (f),
1343 width != 0)
1344 && (height = desired_row->visible_height,
1345 height > 0))
1346 {
1347 int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
1348
1349 block_input ();
1350 x_clear_area (f, 0, y, width, height);
1351 x_clear_area (f, FRAME_PIXEL_WIDTH (f) - width, y, width, height);
1352 unblock_input ();
1353 }
1354 }
1355 #endif
1356 }
1357
1358 static void
1359 x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
1360 {
1361 struct frame *f = XFRAME (WINDOW_FRAME (w));
1362 Display *display = FRAME_X_DISPLAY (f);
1363 Window window = FRAME_X_WINDOW (f);
1364 GC gc = f->output_data.x->normal_gc;
1365 struct face *face = p->face;
1366
1367 /* Must clip because of partially visible lines. */
1368 x_clip_to_row (w, row, ANY_AREA, gc);
1369
1370 if (p->bx >= 0 && !p->overlay_p)
1371 {
1372 /* In case the same realized face is used for fringes and
1373 for something displayed in the text (e.g. face `region' on
1374 mono-displays, the fill style may have been changed to
1375 FillSolid in x_draw_glyph_string_background. */
1376 if (face->stipple)
1377 XSetFillStyle (display, face->gc, FillOpaqueStippled);
1378 else
1379 XSetForeground (display, face->gc, face->background);
1380
1381 x_fill_rectangle (f, face->gc, p->bx, p->by, p->nx, p->ny);
1382
1383 if (!face->stipple)
1384 XSetForeground (display, face->gc, face->foreground);
1385 }
1386
1387 #ifdef USE_CAIRO
1388 if (p->which && p->which < max_fringe_bmp)
1389 {
1390 XGCValues gcv;
1391
1392 XGetGCValues (display, gc, GCForeground | GCBackground, &gcv);
1393 XSetForeground (display, gc, (p->cursor_p
1394 ? (p->overlay_p ? face->background
1395 : f->output_data.x->cursor_pixel)
1396 : face->foreground));
1397 XSetBackground (display, gc, face->background);
1398 x_cr_draw_image (f, gc, fringe_bmp[p->which], 0, p->dh,
1399 p->wd, p->h, p->x, p->y, p->overlay_p);
1400 XSetForeground (display, gc, gcv.foreground);
1401 XSetBackground (display, gc, gcv.background);
1402 }
1403 #else /* not USE_CAIRO */
1404 if (p->which)
1405 {
1406 char *bits;
1407 Pixmap pixmap, clipmask = (Pixmap) 0;
1408 int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
1409 XGCValues gcv;
1410
1411 if (p->wd > 8)
1412 bits = (char *) (p->bits + p->dh);
1413 else
1414 bits = (char *) p->bits + p->dh;
1415
1416 /* Draw the bitmap. I believe these small pixmaps can be cached
1417 by the server. */
1418 pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
1419 (p->cursor_p
1420 ? (p->overlay_p ? face->background
1421 : f->output_data.x->cursor_pixel)
1422 : face->foreground),
1423 face->background, depth);
1424
1425 if (p->overlay_p)
1426 {
1427 clipmask = XCreatePixmapFromBitmapData (display,
1428 FRAME_DISPLAY_INFO (f)->root_window,
1429 bits, p->wd, p->h,
1430 1, 0, 1);
1431 gcv.clip_mask = clipmask;
1432 gcv.clip_x_origin = p->x;
1433 gcv.clip_y_origin = p->y;
1434 XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
1435 }
1436
1437 XCopyArea (display, pixmap, window, gc, 0, 0,
1438 p->wd, p->h, p->x, p->y);
1439 XFreePixmap (display, pixmap);
1440
1441 if (p->overlay_p)
1442 {
1443 gcv.clip_mask = (Pixmap) 0;
1444 XChangeGC (display, gc, GCClipMask, &gcv);
1445 XFreePixmap (display, clipmask);
1446 }
1447 }
1448 #endif /* not USE_CAIRO */
1449
1450 x_reset_clip_rectangles (f, gc);
1451 }
1452
1453 /***********************************************************************
1454 Glyph display
1455 ***********************************************************************/
1456
1457
1458
1459 static void x_set_glyph_string_clipping (struct glyph_string *);
1460 static void x_set_glyph_string_gc (struct glyph_string *);
1461 static void x_draw_glyph_string_foreground (struct glyph_string *);
1462 static void x_draw_composite_glyph_string_foreground (struct glyph_string *);
1463 static void x_draw_glyph_string_box (struct glyph_string *);
1464 static void x_draw_glyph_string (struct glyph_string *);
1465 static _Noreturn void x_delete_glyphs (struct frame *, int);
1466 static void x_compute_glyph_string_overhangs (struct glyph_string *);
1467 static void x_set_cursor_gc (struct glyph_string *);
1468 static void x_set_mode_line_face_gc (struct glyph_string *);
1469 static void x_set_mouse_face_gc (struct glyph_string *);
1470 static bool x_alloc_lighter_color (struct frame *, Display *, Colormap,
1471 unsigned long *, double, int);
1472 static void x_setup_relief_color (struct frame *, struct relief *,
1473 double, int, unsigned long);
1474 static void x_setup_relief_colors (struct glyph_string *);
1475 static void x_draw_image_glyph_string (struct glyph_string *);
1476 static void x_draw_image_relief (struct glyph_string *);
1477 static void x_draw_image_foreground (struct glyph_string *);
1478 static void x_draw_image_foreground_1 (struct glyph_string *, Pixmap);
1479 static void x_clear_glyph_string_rect (struct glyph_string *, int,
1480 int, int, int);
1481 static void x_draw_relief_rect (struct frame *, int, int, int, int,
1482 int, bool, bool, bool, bool, bool,
1483 XRectangle *);
1484 static void x_draw_box_rect (struct glyph_string *, int, int, int, int,
1485 int, bool, bool, XRectangle *);
1486 static void x_scroll_bar_clear (struct frame *);
1487
1488 #ifdef GLYPH_DEBUG
1489 static void x_check_font (struct frame *, struct font *);
1490 #endif
1491
1492
1493 /* Set S->gc to a suitable GC for drawing glyph string S in cursor
1494 face. */
1495
1496 static void
1497 x_set_cursor_gc (struct glyph_string *s)
1498 {
1499 if (s->font == FRAME_FONT (s->f)
1500 && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
1501 && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
1502 && !s->cmp)
1503 s->gc = s->f->output_data.x->cursor_gc;
1504 else
1505 {
1506 /* Cursor on non-default face: must merge. */
1507 XGCValues xgcv;
1508 unsigned long mask;
1509
1510 xgcv.background = s->f->output_data.x->cursor_pixel;
1511 xgcv.foreground = s->face->background;
1512
1513 /* If the glyph would be invisible, try a different foreground. */
1514 if (xgcv.foreground == xgcv.background)
1515 xgcv.foreground = s->face->foreground;
1516 if (xgcv.foreground == xgcv.background)
1517 xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
1518 if (xgcv.foreground == xgcv.background)
1519 xgcv.foreground = s->face->foreground;
1520
1521 /* Make sure the cursor is distinct from text in this face. */
1522 if (xgcv.background == s->face->background
1523 && xgcv.foreground == s->face->foreground)
1524 {
1525 xgcv.background = s->face->foreground;
1526 xgcv.foreground = s->face->background;
1527 }
1528
1529 IF_DEBUG (x_check_font (s->f, s->font));
1530 xgcv.graphics_exposures = False;
1531 mask = GCForeground | GCBackground | GCGraphicsExposures;
1532
1533 if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1534 XChangeGC (s->display, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1535 mask, &xgcv);
1536 else
1537 FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
1538 = XCreateGC (s->display, s->window, mask, &xgcv);
1539
1540 s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1541 }
1542 }
1543
1544
1545 /* Set up S->gc of glyph string S for drawing text in mouse face. */
1546
1547 static void
1548 x_set_mouse_face_gc (struct glyph_string *s)
1549 {
1550 int face_id;
1551 struct face *face;
1552
1553 /* What face has to be used last for the mouse face? */
1554 face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
1555 face = FACE_FROM_ID (s->f, face_id);
1556 if (face == NULL)
1557 face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
1558
1559 if (s->first_glyph->type == CHAR_GLYPH)
1560 face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1561 else
1562 face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1563 s->face = FACE_FROM_ID (s->f, face_id);
1564 prepare_face_for_display (s->f, s->face);
1565
1566 if (s->font == s->face->font)
1567 s->gc = s->face->gc;
1568 else
1569 {
1570 /* Otherwise construct scratch_cursor_gc with values from FACE
1571 except for FONT. */
1572 XGCValues xgcv;
1573 unsigned long mask;
1574
1575 xgcv.background = s->face->background;
1576 xgcv.foreground = s->face->foreground;
1577 xgcv.graphics_exposures = False;
1578 mask = GCForeground | GCBackground | GCGraphicsExposures;
1579
1580 if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
1581 XChangeGC (s->display, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1582 mask, &xgcv);
1583 else
1584 FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
1585 = XCreateGC (s->display, s->window, mask, &xgcv);
1586
1587 s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1588
1589 }
1590 eassert (s->gc != 0);
1591 }
1592
1593
1594 /* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
1595 Faces to use in the mode line have already been computed when the
1596 matrix was built, so there isn't much to do, here. */
1597
1598 static void
1599 x_set_mode_line_face_gc (struct glyph_string *s)
1600 {
1601 s->gc = s->face->gc;
1602 }
1603
1604
1605 /* Set S->gc of glyph string S for drawing that glyph string. Set
1606 S->stippled_p to a non-zero value if the face of S has a stipple
1607 pattern. */
1608
1609 static void
1610 x_set_glyph_string_gc (struct glyph_string *s)
1611 {
1612 prepare_face_for_display (s->f, s->face);
1613
1614 if (s->hl == DRAW_NORMAL_TEXT)
1615 {
1616 s->gc = s->face->gc;
1617 s->stippled_p = s->face->stipple != 0;
1618 }
1619 else if (s->hl == DRAW_INVERSE_VIDEO)
1620 {
1621 x_set_mode_line_face_gc (s);
1622 s->stippled_p = s->face->stipple != 0;
1623 }
1624 else if (s->hl == DRAW_CURSOR)
1625 {
1626 x_set_cursor_gc (s);
1627 s->stippled_p = false;
1628 }
1629 else if (s->hl == DRAW_MOUSE_FACE)
1630 {
1631 x_set_mouse_face_gc (s);
1632 s->stippled_p = s->face->stipple != 0;
1633 }
1634 else if (s->hl == DRAW_IMAGE_RAISED
1635 || s->hl == DRAW_IMAGE_SUNKEN)
1636 {
1637 s->gc = s->face->gc;
1638 s->stippled_p = s->face->stipple != 0;
1639 }
1640 else
1641 emacs_abort ();
1642
1643 /* GC must have been set. */
1644 eassert (s->gc != 0);
1645 }
1646
1647
1648 /* Set clipping for output of glyph string S. S may be part of a mode
1649 line or menu if we don't have X toolkit support. */
1650
1651 static void
1652 x_set_glyph_string_clipping (struct glyph_string *s)
1653 {
1654 XRectangle *r = s->clip;
1655 int n = get_glyph_string_clip_rects (s, r, 2);
1656
1657 if (n > 0)
1658 x_set_clip_rectangles (s->f, s->gc, r, n);
1659 s->num_clips = n;
1660 }
1661
1662
1663 /* Set SRC's clipping for output of glyph string DST. This is called
1664 when we are drawing DST's left_overhang or right_overhang only in
1665 the area of SRC. */
1666
1667 static void
1668 x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1669 {
1670 XRectangle r;
1671
1672 r.x = src->x;
1673 r.width = src->width;
1674 r.y = src->y;
1675 r.height = src->height;
1676 dst->clip[0] = r;
1677 dst->num_clips = 1;
1678 x_set_clip_rectangles (dst->f, dst->gc, &r, 1);
1679 }
1680
1681
1682 /* RIF:
1683 Compute left and right overhang of glyph string S. */
1684
1685 static void
1686 x_compute_glyph_string_overhangs (struct glyph_string *s)
1687 {
1688 if (s->cmp == NULL
1689 && (s->first_glyph->type == CHAR_GLYPH
1690 || s->first_glyph->type == COMPOSITE_GLYPH))
1691 {
1692 struct font_metrics metrics;
1693
1694 if (s->first_glyph->type == CHAR_GLYPH)
1695 {
1696 unsigned *code = alloca (sizeof (unsigned) * s->nchars);
1697 struct font *font = s->font;
1698 int i;
1699
1700 for (i = 0; i < s->nchars; i++)
1701 code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
1702 font->driver->text_extents (font, code, s->nchars, &metrics);
1703 }
1704 else
1705 {
1706 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1707
1708 composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
1709 }
1710 s->right_overhang = (metrics.rbearing > metrics.width
1711 ? metrics.rbearing - metrics.width : 0);
1712 s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1713 }
1714 else if (s->cmp)
1715 {
1716 s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
1717 s->left_overhang = - s->cmp->lbearing;
1718 }
1719 }
1720
1721
1722 /* Fill rectangle X, Y, W, H with background color of glyph string S. */
1723
1724 static void
1725 x_clear_glyph_string_rect (struct glyph_string *s, int x, int y, int w, int h)
1726 {
1727 XGCValues xgcv;
1728 XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
1729 XSetForeground (s->display, s->gc, xgcv.background);
1730 x_fill_rectangle (s->f, s->gc, x, y, w, h);
1731 XSetForeground (s->display, s->gc, xgcv.foreground);
1732 }
1733
1734
1735 /* Draw the background of glyph_string S. If S->background_filled_p
1736 is non-zero don't draw it. FORCE_P non-zero means draw the
1737 background even if it wouldn't be drawn normally. This is used
1738 when a string preceding S draws into the background of S, or S
1739 contains the first component of a composition. */
1740
1741 static void
1742 x_draw_glyph_string_background (struct glyph_string *s, bool force_p)
1743 {
1744 /* Nothing to do if background has already been drawn or if it
1745 shouldn't be drawn in the first place. */
1746 if (!s->background_filled_p)
1747 {
1748 int box_line_width = max (s->face->box_line_width, 0);
1749
1750 if (s->stippled_p)
1751 {
1752 /* Fill background with a stipple pattern. */
1753 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
1754 x_fill_rectangle (s->f, s->gc, s->x,
1755 s->y + box_line_width,
1756 s->background_width,
1757 s->height - 2 * box_line_width);
1758 XSetFillStyle (s->display, s->gc, FillSolid);
1759 s->background_filled_p = true;
1760 }
1761 else if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1762 || s->font_not_found_p
1763 || s->extends_to_end_of_line_p
1764 || force_p)
1765 {
1766 x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1767 s->background_width,
1768 s->height - 2 * box_line_width);
1769 s->background_filled_p = true;
1770 }
1771 }
1772 }
1773
1774
1775 /* Draw the foreground of glyph string S. */
1776
1777 static void
1778 x_draw_glyph_string_foreground (struct glyph_string *s)
1779 {
1780 int i, x;
1781
1782 /* If first glyph of S has a left box line, start drawing the text
1783 of S to the right of that box line. */
1784 if (s->face->box != FACE_NO_BOX
1785 && s->first_glyph->left_box_line_p)
1786 x = s->x + eabs (s->face->box_line_width);
1787 else
1788 x = s->x;
1789
1790 /* Draw characters of S as rectangles if S's font could not be
1791 loaded. */
1792 if (s->font_not_found_p)
1793 {
1794 for (i = 0; i < s->nchars; ++i)
1795 {
1796 struct glyph *g = s->first_glyph + i;
1797 x_draw_rectangle (s->f,
1798 s->gc, x, s->y, g->pixel_width - 1,
1799 s->height - 1);
1800 x += g->pixel_width;
1801 }
1802 }
1803 else
1804 {
1805 struct font *font = s->font;
1806 int boff = font->baseline_offset;
1807 int y;
1808
1809 if (font->vertical_centering)
1810 boff = VCENTER_BASELINE_OFFSET (font, s->f) - boff;
1811
1812 y = s->ybase - boff;
1813 if (s->for_overlaps
1814 || (s->background_filled_p && s->hl != DRAW_CURSOR))
1815 font->driver->draw (s, 0, s->nchars, x, y, false);
1816 else
1817 font->driver->draw (s, 0, s->nchars, x, y, true);
1818 if (s->face->overstrike)
1819 font->driver->draw (s, 0, s->nchars, x + 1, y, false);
1820 }
1821 }
1822
1823 /* Draw the foreground of composite glyph string S. */
1824
1825 static void
1826 x_draw_composite_glyph_string_foreground (struct glyph_string *s)
1827 {
1828 int i, j, x;
1829 struct font *font = s->font;
1830
1831 /* If first glyph of S has a left box line, start drawing the text
1832 of S to the right of that box line. */
1833 if (s->face && s->face->box != FACE_NO_BOX
1834 && s->first_glyph->left_box_line_p)
1835 x = s->x + eabs (s->face->box_line_width);
1836 else
1837 x = s->x;
1838
1839 /* S is a glyph string for a composition. S->cmp_from is the index
1840 of the first character drawn for glyphs of this composition.
1841 S->cmp_from == 0 means we are drawing the very first character of
1842 this composition. */
1843
1844 /* Draw a rectangle for the composition if the font for the very
1845 first character of the composition could not be loaded. */
1846 if (s->font_not_found_p)
1847 {
1848 if (s->cmp_from == 0)
1849 x_draw_rectangle (s->f, s->gc, x, s->y,
1850 s->width - 1, s->height - 1);
1851 }
1852 else if (! s->first_glyph->u.cmp.automatic)
1853 {
1854 int y = s->ybase;
1855
1856 for (i = 0, j = s->cmp_from; i < s->nchars; i++, j++)
1857 /* TAB in a composition means display glyphs with padding
1858 space on the left or right. */
1859 if (COMPOSITION_GLYPH (s->cmp, j) != '\t')
1860 {
1861 int xx = x + s->cmp->offsets[j * 2];
1862 int yy = y - s->cmp->offsets[j * 2 + 1];
1863
1864 font->driver->draw (s, j, j + 1, xx, yy, false);
1865 if (s->face->overstrike)
1866 font->driver->draw (s, j, j + 1, xx + 1, yy, false);
1867 }
1868 }
1869 else
1870 {
1871 Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);
1872 Lisp_Object glyph;
1873 int y = s->ybase;
1874 int width = 0;
1875
1876 for (i = j = s->cmp_from; i < s->cmp_to; i++)
1877 {
1878 glyph = LGSTRING_GLYPH (gstring, i);
1879 if (NILP (LGLYPH_ADJUSTMENT (glyph)))
1880 width += LGLYPH_WIDTH (glyph);
1881 else
1882 {
1883 int xoff, yoff, wadjust;
1884
1885 if (j < i)
1886 {
1887 font->driver->draw (s, j, i, x, y, false);
1888 if (s->face->overstrike)
1889 font->driver->draw (s, j, i, x + 1, y, false);
1890 x += width;
1891 }
1892 xoff = LGLYPH_XOFF (glyph);
1893 yoff = LGLYPH_YOFF (glyph);
1894 wadjust = LGLYPH_WADJUST (glyph);
1895 font->driver->draw (s, i, i + 1, x + xoff, y + yoff, false);
1896 if (s->face->overstrike)
1897 font->driver->draw (s, i, i + 1, x + xoff + 1, y + yoff,
1898 false);
1899 x += wadjust;
1900 j = i + 1;
1901 width = 0;
1902 }
1903 }
1904 if (j < i)
1905 {
1906 font->driver->draw (s, j, i, x, y, false);
1907 if (s->face->overstrike)
1908 font->driver->draw (s, j, i, x + 1, y, false);
1909 }
1910 }
1911 }
1912
1913
1914 /* Draw the foreground of glyph string S for glyphless characters. */
1915
1916 static void
1917 x_draw_glyphless_glyph_string_foreground (struct glyph_string *s)
1918 {
1919 struct glyph *glyph = s->first_glyph;
1920 XChar2b char2b[8];
1921 int x, i, j;
1922
1923 /* If first glyph of S has a left box line, start drawing the text
1924 of S to the right of that box line. */
1925 if (s->face && s->face->box != FACE_NO_BOX
1926 && s->first_glyph->left_box_line_p)
1927 x = s->x + eabs (s->face->box_line_width);
1928 else
1929 x = s->x;
1930
1931 s->char2b = char2b;
1932
1933 for (i = 0; i < s->nchars; i++, glyph++)
1934 {
1935 char buf[7], *str = NULL;
1936 int len = glyph->u.glyphless.len;
1937
1938 if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_ACRONYM)
1939 {
1940 if (len > 0
1941 && CHAR_TABLE_P (Vglyphless_char_display)
1942 && (CHAR_TABLE_EXTRA_SLOTS (XCHAR_TABLE (Vglyphless_char_display))
1943 >= 1))
1944 {
1945 Lisp_Object acronym
1946 = (! glyph->u.glyphless.for_no_font
1947 ? CHAR_TABLE_REF (Vglyphless_char_display,
1948 glyph->u.glyphless.ch)
1949 : XCHAR_TABLE (Vglyphless_char_display)->extras[0]);
1950 if (STRINGP (acronym))
1951 str = SSDATA (acronym);
1952 }
1953 }
1954 else if (glyph->u.glyphless.method == GLYPHLESS_DISPLAY_HEX_CODE)
1955 {
1956 sprintf (buf, "%0*X",
1957 glyph->u.glyphless.ch < 0x10000 ? 4 : 6,
1958 glyph->u.glyphless.ch + 0u);
1959 str = buf;
1960 }
1961
1962 if (str)
1963 {
1964 int upper_len = (len + 1) / 2;
1965 unsigned code;
1966
1967 /* It is assured that all LEN characters in STR is ASCII. */
1968 for (j = 0; j < len; j++)
1969 {
1970 code = s->font->driver->encode_char (s->font, str[j]);
1971 STORE_XCHAR2B (char2b + j, code >> 8, code & 0xFF);
1972 }
1973 s->font->driver->draw (s, 0, upper_len,
1974 x + glyph->slice.glyphless.upper_xoff,
1975 s->ybase + glyph->slice.glyphless.upper_yoff,
1976 false);
1977 s->font->driver->draw (s, upper_len, len,
1978 x + glyph->slice.glyphless.lower_xoff,
1979 s->ybase + glyph->slice.glyphless.lower_yoff,
1980 false);
1981 }
1982 if (glyph->u.glyphless.method != GLYPHLESS_DISPLAY_THIN_SPACE)
1983 x_draw_rectangle (s->f, s->gc,
1984 x, s->ybase - glyph->ascent,
1985 glyph->pixel_width - 1,
1986 glyph->ascent + glyph->descent - 1);
1987 x += glyph->pixel_width;
1988 }
1989 }
1990
1991 #ifdef USE_X_TOOLKIT
1992
1993 #ifdef USE_LUCID
1994
1995 /* Return the frame on which widget WIDGET is used.. Abort if frame
1996 cannot be determined. */
1997
1998 static struct frame *
1999 x_frame_of_widget (Widget widget)
2000 {
2001 struct x_display_info *dpyinfo;
2002 Lisp_Object tail, frame;
2003 struct frame *f;
2004
2005 dpyinfo = x_display_info_for_display (XtDisplay (widget));
2006
2007 /* Find the top-level shell of the widget. Note that this function
2008 can be called when the widget is not yet realized, so XtWindow
2009 (widget) == 0. That's the reason we can't simply use
2010 x_any_window_to_frame. */
2011 while (!XtIsTopLevelShell (widget))
2012 widget = XtParent (widget);
2013
2014 /* Look for a frame with that top-level widget. Allocate the color
2015 on that frame to get the right gamma correction value. */
2016 FOR_EACH_FRAME (tail, frame)
2017 {
2018 f = XFRAME (frame);
2019 if (FRAME_X_P (f)
2020 && f->output_data.nothing != 1
2021 && FRAME_DISPLAY_INFO (f) == dpyinfo
2022 && f->output_data.x->widget == widget)
2023 return f;
2024 }
2025 emacs_abort ();
2026 }
2027
2028 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
2029 or DELTA. Try a color with RGB values multiplied by FACTOR first.
2030 If this produces the same color as PIXEL, try a color where all RGB
2031 values have DELTA added. Return the allocated color in *PIXEL.
2032 DISPLAY is the X display, CMAP is the colormap to operate on.
2033 Value is true if successful. */
2034
2035 bool
2036 x_alloc_lighter_color_for_widget (Widget widget, Display *display, Colormap cmap,
2037 unsigned long *pixel, double factor, int delta)
2038 {
2039 struct frame *f = x_frame_of_widget (widget);
2040 return x_alloc_lighter_color (f, display, cmap, pixel, factor, delta);
2041 }
2042
2043 #endif /* USE_LUCID */
2044
2045
2046 /* Structure specifying which arguments should be passed by Xt to
2047 cvt_string_to_pixel. We want the widget's screen and colormap. */
2048
2049 static XtConvertArgRec cvt_string_to_pixel_args[] =
2050 {
2051 {XtWidgetBaseOffset, (XtPointer) offsetof (WidgetRec, core.screen),
2052 sizeof (Screen *)},
2053 {XtWidgetBaseOffset, (XtPointer) offsetof (WidgetRec, core.colormap),
2054 sizeof (Colormap)}
2055 };
2056
2057
2058 /* The address of this variable is returned by
2059 cvt_string_to_pixel. */
2060
2061 static Pixel cvt_string_to_pixel_value;
2062
2063
2064 /* Convert a color name to a pixel color.
2065
2066 DPY is the display we are working on.
2067
2068 ARGS is an array of *NARGS XrmValue structures holding additional
2069 information about the widget for which the conversion takes place.
2070 The contents of this array are determined by the specification
2071 in cvt_string_to_pixel_args.
2072
2073 FROM is a pointer to an XrmValue which points to the color name to
2074 convert. TO is an XrmValue in which to return the pixel color.
2075
2076 CLOSURE_RET is a pointer to user-data, in which we record if
2077 we allocated the color or not.
2078
2079 Value is True if successful, False otherwise. */
2080
2081 static Boolean
2082 cvt_string_to_pixel (Display *dpy, XrmValue *args, Cardinal *nargs,
2083 XrmValue *from, XrmValue *to,
2084 XtPointer *closure_ret)
2085 {
2086 Screen *screen;
2087 Colormap cmap;
2088 Pixel pixel;
2089 String color_name;
2090 XColor color;
2091
2092 if (*nargs != 2)
2093 {
2094 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
2095 "wrongParameters", "cvt_string_to_pixel",
2096 "XtToolkitError",
2097 "Screen and colormap args required", NULL, NULL);
2098 return False;
2099 }
2100
2101 screen = *(Screen **) args[0].addr;
2102 cmap = *(Colormap *) args[1].addr;
2103 color_name = (String) from->addr;
2104
2105 if (strcmp (color_name, XtDefaultBackground) == 0)
2106 {
2107 *closure_ret = (XtPointer) False;
2108 pixel = WhitePixelOfScreen (screen);
2109 }
2110 else if (strcmp (color_name, XtDefaultForeground) == 0)
2111 {
2112 *closure_ret = (XtPointer) False;
2113 pixel = BlackPixelOfScreen (screen);
2114 }
2115 else if (XParseColor (dpy, cmap, color_name, &color)
2116 && x_alloc_nearest_color_1 (dpy, cmap, &color))
2117 {
2118 pixel = color.pixel;
2119 *closure_ret = (XtPointer) True;
2120 }
2121 else
2122 {
2123 String params[1];
2124 Cardinal nparams = 1;
2125
2126 params[0] = color_name;
2127 XtAppWarningMsg (XtDisplayToApplicationContext (dpy),
2128 "badValue", "cvt_string_to_pixel",
2129 "XtToolkitError", "Invalid color `%s'",
2130 params, &nparams);
2131 return False;
2132 }
2133
2134 if (to->addr != NULL)
2135 {
2136 if (to->size < sizeof (Pixel))
2137 {
2138 to->size = sizeof (Pixel);
2139 return False;
2140 }
2141
2142 *(Pixel *) to->addr = pixel;
2143 }
2144 else
2145 {
2146 cvt_string_to_pixel_value = pixel;
2147 to->addr = (XtPointer) &cvt_string_to_pixel_value;
2148 }
2149
2150 to->size = sizeof (Pixel);
2151 return True;
2152 }
2153
2154
2155 /* Free a pixel color which was previously allocated via
2156 cvt_string_to_pixel. This is registered as the destructor
2157 for this type of resource via XtSetTypeConverter.
2158
2159 APP is the application context in which we work.
2160
2161 TO is a pointer to an XrmValue holding the color to free.
2162 CLOSURE is the value we stored in CLOSURE_RET for this color
2163 in cvt_string_to_pixel.
2164
2165 ARGS and NARGS are like for cvt_string_to_pixel. */
2166
2167 static void
2168 cvt_pixel_dtor (XtAppContext app, XrmValuePtr to, XtPointer closure, XrmValuePtr args,
2169 Cardinal *nargs)
2170 {
2171 if (*nargs != 2)
2172 {
2173 XtAppWarningMsg (app, "wrongParameters", "cvt_pixel_dtor",
2174 "XtToolkitError",
2175 "Screen and colormap arguments required",
2176 NULL, NULL);
2177 }
2178 else if (closure != NULL)
2179 {
2180 /* We did allocate the pixel, so free it. */
2181 Screen *screen = *(Screen **) args[0].addr;
2182 Colormap cmap = *(Colormap *) args[1].addr;
2183 x_free_dpy_colors (DisplayOfScreen (screen), screen, cmap,
2184 (Pixel *) to->addr, 1);
2185 }
2186 }
2187
2188
2189 #endif /* USE_X_TOOLKIT */
2190
2191
2192 /* Value is an array of XColor structures for the contents of the
2193 color map of display DPY. Set *NCELLS to the size of the array.
2194 Note that this probably shouldn't be called for large color maps,
2195 say a 24-bit TrueColor map. */
2196
2197 static const XColor *
2198 x_color_cells (Display *dpy, int *ncells)
2199 {
2200 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
2201
2202 if (dpyinfo->color_cells == NULL)
2203 {
2204 Screen *screen = dpyinfo->screen;
2205 int ncolor_cells = XDisplayCells (dpy, XScreenNumberOfScreen (screen));
2206 int i;
2207
2208 dpyinfo->color_cells = xnmalloc (ncolor_cells,
2209 sizeof *dpyinfo->color_cells);
2210 dpyinfo->ncolor_cells = ncolor_cells;
2211
2212 for (i = 0; i < ncolor_cells; ++i)
2213 dpyinfo->color_cells[i].pixel = i;
2214
2215 XQueryColors (dpy, dpyinfo->cmap,
2216 dpyinfo->color_cells, ncolor_cells);
2217 }
2218
2219 *ncells = dpyinfo->ncolor_cells;
2220 return dpyinfo->color_cells;
2221 }
2222
2223
2224 /* On frame F, translate pixel colors to RGB values for the NCOLORS
2225 colors in COLORS. Use cached information, if available. */
2226
2227 void
2228 x_query_colors (struct frame *f, XColor *colors, int ncolors)
2229 {
2230 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
2231
2232 if (dpyinfo->color_cells)
2233 {
2234 int i;
2235 for (i = 0; i < ncolors; ++i)
2236 {
2237 unsigned long pixel = colors[i].pixel;
2238 eassert (pixel < dpyinfo->ncolor_cells);
2239 eassert (dpyinfo->color_cells[pixel].pixel == pixel);
2240 colors[i] = dpyinfo->color_cells[pixel];
2241 }
2242 }
2243 else
2244 XQueryColors (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), colors, ncolors);
2245 }
2246
2247
2248 /* On frame F, translate pixel color to RGB values for the color in
2249 COLOR. Use cached information, if available. */
2250
2251 void
2252 x_query_color (struct frame *f, XColor *color)
2253 {
2254 x_query_colors (f, color, 1);
2255 }
2256
2257
2258 /* Allocate the color COLOR->pixel on DISPLAY, colormap CMAP. If an
2259 exact match can't be allocated, try the nearest color available.
2260 Value is true if successful. Set *COLOR to the color
2261 allocated. */
2262
2263 static bool
2264 x_alloc_nearest_color_1 (Display *dpy, Colormap cmap, XColor *color)
2265 {
2266 bool rc;
2267
2268 rc = XAllocColor (dpy, cmap, color) != 0;
2269 if (rc == 0)
2270 {
2271 /* If we got to this point, the colormap is full, so we're going
2272 to try to get the next closest color. The algorithm used is
2273 a least-squares matching, which is what X uses for closest
2274 color matching with StaticColor visuals. */
2275 int nearest, i;
2276 int max_color_delta = 255;
2277 int max_delta = 3 * max_color_delta;
2278 int nearest_delta = max_delta + 1;
2279 int ncells;
2280 const XColor *cells = x_color_cells (dpy, &ncells);
2281
2282 for (nearest = i = 0; i < ncells; ++i)
2283 {
2284 int dred = (color->red >> 8) - (cells[i].red >> 8);
2285 int dgreen = (color->green >> 8) - (cells[i].green >> 8);
2286 int dblue = (color->blue >> 8) - (cells[i].blue >> 8);
2287 int delta = dred * dred + dgreen * dgreen + dblue * dblue;
2288
2289 if (delta < nearest_delta)
2290 {
2291 nearest = i;
2292 nearest_delta = delta;
2293 }
2294 }
2295
2296 color->red = cells[nearest].red;
2297 color->green = cells[nearest].green;
2298 color->blue = cells[nearest].blue;
2299 rc = XAllocColor (dpy, cmap, color) != 0;
2300 }
2301 else
2302 {
2303 /* If allocation succeeded, and the allocated pixel color is not
2304 equal to a cached pixel color recorded earlier, there was a
2305 change in the colormap, so clear the color cache. */
2306 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
2307 XColor *cached_color;
2308
2309 if (dpyinfo->color_cells
2310 && (cached_color = &dpyinfo->color_cells[color->pixel],
2311 (cached_color->red != color->red
2312 || cached_color->blue != color->blue
2313 || cached_color->green != color->green)))
2314 {
2315 xfree (dpyinfo->color_cells);
2316 dpyinfo->color_cells = NULL;
2317 dpyinfo->ncolor_cells = 0;
2318 }
2319 }
2320
2321 #ifdef DEBUG_X_COLORS
2322 if (rc)
2323 register_color (color->pixel);
2324 #endif /* DEBUG_X_COLORS */
2325
2326 return rc;
2327 }
2328
2329
2330 /* Allocate the color COLOR->pixel on frame F, colormap CMAP. If an
2331 exact match can't be allocated, try the nearest color available.
2332 Value is true if successful. Set *COLOR to the color
2333 allocated. */
2334
2335 bool
2336 x_alloc_nearest_color (struct frame *f, Colormap cmap, XColor *color)
2337 {
2338 gamma_correct (f, color);
2339 return x_alloc_nearest_color_1 (FRAME_X_DISPLAY (f), cmap, color);
2340 }
2341
2342
2343 /* Allocate color PIXEL on frame F. PIXEL must already be allocated.
2344 It's necessary to do this instead of just using PIXEL directly to
2345 get color reference counts right. */
2346
2347 unsigned long
2348 x_copy_color (struct frame *f, unsigned long pixel)
2349 {
2350 XColor color;
2351
2352 color.pixel = pixel;
2353 block_input ();
2354 x_query_color (f, &color);
2355 XAllocColor (FRAME_X_DISPLAY (f), FRAME_X_COLORMAP (f), &color);
2356 unblock_input ();
2357 #ifdef DEBUG_X_COLORS
2358 register_color (pixel);
2359 #endif
2360 return color.pixel;
2361 }
2362
2363
2364 /* Brightness beyond which a color won't have its highlight brightness
2365 boosted.
2366
2367 Nominally, highlight colors for `3d' faces are calculated by
2368 brightening an object's color by a constant scale factor, but this
2369 doesn't yield good results for dark colors, so for colors who's
2370 brightness is less than this value (on a scale of 0-65535) have an
2371 use an additional additive factor.
2372
2373 The value here is set so that the default menu-bar/mode-line color
2374 (grey75) will not have its highlights changed at all. */
2375 #define HIGHLIGHT_COLOR_DARK_BOOST_LIMIT 48000
2376
2377
2378 /* Allocate a color which is lighter or darker than *PIXEL by FACTOR
2379 or DELTA. Try a color with RGB values multiplied by FACTOR first.
2380 If this produces the same color as PIXEL, try a color where all RGB
2381 values have DELTA added. Return the allocated color in *PIXEL.
2382 DISPLAY is the X display, CMAP is the colormap to operate on.
2383 Value is non-zero if successful. */
2384
2385 static bool
2386 x_alloc_lighter_color (struct frame *f, Display *display, Colormap cmap,
2387 unsigned long *pixel, double factor, int delta)
2388 {
2389 XColor color, new;
2390 long bright;
2391 bool success_p;
2392
2393 /* Get RGB color values. */
2394 color.pixel = *pixel;
2395 x_query_color (f, &color);
2396
2397 /* Change RGB values by specified FACTOR. Avoid overflow! */
2398 eassert (factor >= 0);
2399 new.red = min (0xffff, factor * color.red);
2400 new.green = min (0xffff, factor * color.green);
2401 new.blue = min (0xffff, factor * color.blue);
2402
2403 /* Calculate brightness of COLOR. */
2404 bright = (2 * color.red + 3 * color.green + color.blue) / 6;
2405
2406 /* We only boost colors that are darker than
2407 HIGHLIGHT_COLOR_DARK_BOOST_LIMIT. */
2408 if (bright < HIGHLIGHT_COLOR_DARK_BOOST_LIMIT)
2409 /* Make an additive adjustment to NEW, because it's dark enough so
2410 that scaling by FACTOR alone isn't enough. */
2411 {
2412 /* How far below the limit this color is (0 - 1, 1 being darker). */
2413 double dimness = 1 - (double)bright / HIGHLIGHT_COLOR_DARK_BOOST_LIMIT;
2414 /* The additive adjustment. */
2415 int min_delta = delta * dimness * factor / 2;
2416
2417 if (factor < 1)
2418 {
2419 new.red = max (0, new.red - min_delta);
2420 new.green = max (0, new.green - min_delta);
2421 new.blue = max (0, new.blue - min_delta);
2422 }
2423 else
2424 {
2425 new.red = min (0xffff, min_delta + new.red);
2426 new.green = min (0xffff, min_delta + new.green);
2427 new.blue = min (0xffff, min_delta + new.blue);
2428 }
2429 }
2430
2431 /* Try to allocate the color. */
2432 success_p = x_alloc_nearest_color (f, cmap, &new);
2433 if (success_p)
2434 {
2435 if (new.pixel == *pixel)
2436 {
2437 /* If we end up with the same color as before, try adding
2438 delta to the RGB values. */
2439 x_free_colors (f, &new.pixel, 1);
2440
2441 new.red = min (0xffff, delta + color.red);
2442 new.green = min (0xffff, delta + color.green);
2443 new.blue = min (0xffff, delta + color.blue);
2444 success_p = x_alloc_nearest_color (f, cmap, &new);
2445 }
2446 else
2447 success_p = true;
2448 *pixel = new.pixel;
2449 }
2450
2451 return success_p;
2452 }
2453
2454
2455 /* Set up the foreground color for drawing relief lines of glyph
2456 string S. RELIEF is a pointer to a struct relief containing the GC
2457 with which lines will be drawn. Use a color that is FACTOR or
2458 DELTA lighter or darker than the relief's background which is found
2459 in S->f->output_data.x->relief_background. If such a color cannot
2460 be allocated, use DEFAULT_PIXEL, instead. */
2461
2462 static void
2463 x_setup_relief_color (struct frame *f, struct relief *relief, double factor,
2464 int delta, unsigned long default_pixel)
2465 {
2466 XGCValues xgcv;
2467 struct x_output *di = f->output_data.x;
2468 unsigned long mask = GCForeground | GCLineWidth | GCGraphicsExposures;
2469 unsigned long pixel;
2470 unsigned long background = di->relief_background;
2471 Colormap cmap = FRAME_X_COLORMAP (f);
2472 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
2473 Display *dpy = FRAME_X_DISPLAY (f);
2474
2475 xgcv.graphics_exposures = False;
2476 xgcv.line_width = 1;
2477
2478 /* Free previously allocated color. The color cell will be reused
2479 when it has been freed as many times as it was allocated, so this
2480 doesn't affect faces using the same colors. */
2481 if (relief->gc && relief->pixel != -1)
2482 {
2483 x_free_colors (f, &relief->pixel, 1);
2484 relief->pixel = -1;
2485 }
2486
2487 /* Allocate new color. */
2488 xgcv.foreground = default_pixel;
2489 pixel = background;
2490 if (dpyinfo->n_planes != 1
2491 && x_alloc_lighter_color (f, dpy, cmap, &pixel, factor, delta))
2492 xgcv.foreground = relief->pixel = pixel;
2493
2494 if (relief->gc == 0)
2495 {
2496 xgcv.stipple = dpyinfo->gray;
2497 mask |= GCStipple;
2498 relief->gc = XCreateGC (dpy, FRAME_X_WINDOW (f), mask, &xgcv);
2499 }
2500 else
2501 XChangeGC (dpy, relief->gc, mask, &xgcv);
2502 }
2503
2504
2505 /* Set up colors for the relief lines around glyph string S. */
2506
2507 static void
2508 x_setup_relief_colors (struct glyph_string *s)
2509 {
2510 struct x_output *di = s->f->output_data.x;
2511 unsigned long color;
2512
2513 if (s->face->use_box_color_for_shadows_p)
2514 color = s->face->box_color;
2515 else if (s->first_glyph->type == IMAGE_GLYPH
2516 && s->img->pixmap
2517 && !IMAGE_BACKGROUND_TRANSPARENT (s->img, s->f, 0))
2518 color = IMAGE_BACKGROUND (s->img, s->f, 0);
2519 else
2520 {
2521 XGCValues xgcv;
2522
2523 /* Get the background color of the face. */
2524 XGetGCValues (s->display, s->gc, GCBackground, &xgcv);
2525 color = xgcv.background;
2526 }
2527
2528 if (di->white_relief.gc == 0
2529 || color != di->relief_background)
2530 {
2531 di->relief_background = color;
2532 x_setup_relief_color (s->f, &di->white_relief, 1.2, 0x8000,
2533 WHITE_PIX_DEFAULT (s->f));
2534 x_setup_relief_color (s->f, &di->black_relief, 0.6, 0x4000,
2535 BLACK_PIX_DEFAULT (s->f));
2536 }
2537 }
2538
2539
2540 /* Draw a relief on frame F inside the rectangle given by LEFT_X,
2541 TOP_Y, RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the relief
2542 to draw, it must be >= 0. RAISED_P means draw a raised
2543 relief. LEFT_P means draw a relief on the left side of
2544 the rectangle. RIGHT_P means draw a relief on the right
2545 side of the rectangle. CLIP_RECT is the clipping rectangle to use
2546 when drawing. */
2547
2548 static void
2549 x_draw_relief_rect (struct frame *f,
2550 int left_x, int top_y, int right_x, int bottom_y,
2551 int width, bool raised_p, bool top_p, bool bot_p,
2552 bool left_p, bool right_p,
2553 XRectangle *clip_rect)
2554 {
2555 #ifdef USE_CAIRO
2556 GC top_left_gc, bottom_right_gc;
2557 int corners = 0;
2558
2559 if (raised_p)
2560 {
2561 top_left_gc = f->output_data.x->white_relief.gc;
2562 bottom_right_gc = f->output_data.x->black_relief.gc;
2563 }
2564 else
2565 {
2566 top_left_gc = f->output_data.x->black_relief.gc;
2567 bottom_right_gc = f->output_data.x->white_relief.gc;
2568 }
2569
2570 x_set_clip_rectangles (f, top_left_gc, clip_rect, 1);
2571 x_set_clip_rectangles (f, bottom_right_gc, clip_rect, 1);
2572
2573 if (left_p)
2574 {
2575 x_fill_rectangle (f, top_left_gc, left_x, top_y,
2576 width, bottom_y + 1 - top_y);
2577 if (top_p)
2578 corners |= 1 << CORNER_TOP_LEFT;
2579 if (bot_p)
2580 corners |= 1 << CORNER_BOTTOM_LEFT;
2581 }
2582 if (right_p)
2583 {
2584 x_fill_rectangle (f, bottom_right_gc, right_x + 1 - width, top_y,
2585 width, bottom_y + 1 - top_y);
2586 if (top_p)
2587 corners |= 1 << CORNER_TOP_RIGHT;
2588 if (bot_p)
2589 corners |= 1 << CORNER_BOTTOM_RIGHT;
2590 }
2591 if (top_p)
2592 {
2593 if (!right_p)
2594 x_fill_rectangle (f, top_left_gc, left_x, top_y,
2595 right_x + 1 - left_x, width);
2596 else
2597 x_fill_trapezoid_for_relief (f, top_left_gc, left_x, top_y,
2598 right_x + 1 - left_x, width, 1);
2599 }
2600 if (bot_p)
2601 {
2602 if (!left_p)
2603 x_fill_rectangle (f, bottom_right_gc, left_x, bottom_y + 1 - width,
2604 right_x + 1 - left_x, width);
2605 else
2606 x_fill_trapezoid_for_relief (f, bottom_right_gc,
2607 left_x, bottom_y + 1 - width,
2608 right_x + 1 - left_x, width, 0);
2609 }
2610 if (left_p && width != 1)
2611 x_fill_rectangle (f, bottom_right_gc, left_x, top_y,
2612 1, bottom_y + 1 - top_y);
2613 if (top_p && width != 1)
2614 x_fill_rectangle (f, bottom_right_gc, left_x, top_y,
2615 right_x + 1 - left_x, 1);
2616 if (corners)
2617 {
2618 XSetBackground (FRAME_X_DISPLAY (f), top_left_gc,
2619 FRAME_BACKGROUND_PIXEL (f));
2620 x_erase_corners_for_relief (f, top_left_gc, left_x, top_y,
2621 right_x - left_x + 1, bottom_y - top_y + 1,
2622 6, 1, corners);
2623 }
2624
2625 x_reset_clip_rectangles (f, top_left_gc);
2626 x_reset_clip_rectangles (f, bottom_right_gc);
2627 #else
2628 Display *dpy = FRAME_X_DISPLAY (f);
2629 Window window = FRAME_X_WINDOW (f);
2630 int i;
2631 GC gc;
2632
2633 if (raised_p)
2634 gc = f->output_data.x->white_relief.gc;
2635 else
2636 gc = f->output_data.x->black_relief.gc;
2637 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2638
2639 /* This code is more complicated than it has to be, because of two
2640 minor hacks to make the boxes look nicer: (i) if width > 1, draw
2641 the outermost line using the black relief. (ii) Omit the four
2642 corner pixels. */
2643
2644 /* Top. */
2645 if (top_p)
2646 {
2647 if (width == 1)
2648 XDrawLine (dpy, window, gc,
2649 left_x + left_p, top_y,
2650 right_x + !right_p, top_y);
2651
2652 for (i = 1; i < width; ++i)
2653 XDrawLine (dpy, window, gc,
2654 left_x + i * left_p, top_y + i,
2655 right_x + 1 - i * right_p, top_y + i);
2656 }
2657
2658 /* Left. */
2659 if (left_p)
2660 {
2661 if (width == 1)
2662 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2663
2664 XClearArea (dpy, window, left_x, top_y, 1, 1, False);
2665 XClearArea (dpy, window, left_x, bottom_y, 1, 1, False);
2666
2667 for (i = (width > 1 ? 1 : 0); i < width; ++i)
2668 XDrawLine (dpy, window, gc,
2669 left_x + i, top_y + (i + 1) * top_p,
2670 left_x + i, bottom_y + 1 - (i + 1) * bot_p);
2671 }
2672
2673 XSetClipMask (dpy, gc, None);
2674 if (raised_p)
2675 gc = f->output_data.x->black_relief.gc;
2676 else
2677 gc = f->output_data.x->white_relief.gc;
2678 XSetClipRectangles (dpy, gc, 0, 0, clip_rect, 1, Unsorted);
2679
2680 if (width > 1)
2681 {
2682 /* Outermost top line. */
2683 if (top_p)
2684 XDrawLine (dpy, window, gc,
2685 left_x + left_p, top_y,
2686 right_x + !right_p, top_y);
2687
2688 /* Outermost left line. */
2689 if (left_p)
2690 XDrawLine (dpy, window, gc, left_x, top_y + 1, left_x, bottom_y);
2691 }
2692
2693 /* Bottom. */
2694 if (bot_p)
2695 {
2696 XDrawLine (dpy, window, gc,
2697 left_x + left_p, bottom_y,
2698 right_x + !right_p, bottom_y);
2699 for (i = 1; i < width; ++i)
2700 XDrawLine (dpy, window, gc,
2701 left_x + i * left_p, bottom_y - i,
2702 right_x + 1 - i * right_p, bottom_y - i);
2703 }
2704
2705 /* Right. */
2706 if (right_p)
2707 {
2708 XClearArea (dpy, window, right_x, top_y, 1, 1, False);
2709 XClearArea (dpy, window, right_x, bottom_y, 1, 1, False);
2710 for (i = 0; i < width; ++i)
2711 XDrawLine (dpy, window, gc,
2712 right_x - i, top_y + (i + 1) * top_p,
2713 right_x - i, bottom_y + 1 - (i + 1) * bot_p);
2714 }
2715
2716 x_reset_clip_rectangles (f, gc);
2717
2718 #endif
2719 }
2720
2721
2722 /* Draw a box on frame F inside the rectangle given by LEFT_X, TOP_Y,
2723 RIGHT_X, and BOTTOM_Y. WIDTH is the thickness of the lines to
2724 draw, it must be >= 0. LEFT_P means draw a line on the
2725 left side of the rectangle. RIGHT_P means draw a line
2726 on the right side of the rectangle. CLIP_RECT is the clipping
2727 rectangle to use when drawing. */
2728
2729 static void
2730 x_draw_box_rect (struct glyph_string *s,
2731 int left_x, int top_y, int right_x, int bottom_y, int width,
2732 bool left_p, bool right_p, XRectangle *clip_rect)
2733 {
2734 XGCValues xgcv;
2735
2736 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
2737 XSetForeground (s->display, s->gc, s->face->box_color);
2738 x_set_clip_rectangles (s->f, s->gc, clip_rect, 1);
2739
2740 /* Top. */
2741 x_fill_rectangle (s->f, s->gc,
2742 left_x, top_y, right_x - left_x + 1, width);
2743
2744 /* Left. */
2745 if (left_p)
2746 x_fill_rectangle (s->f, s->gc,
2747 left_x, top_y, width, bottom_y - top_y + 1);
2748
2749 /* Bottom. */
2750 x_fill_rectangle (s->f, s->gc,
2751 left_x, bottom_y - width + 1, right_x - left_x + 1, width);
2752
2753 /* Right. */
2754 if (right_p)
2755 x_fill_rectangle (s->f, s->gc,
2756 right_x - width + 1, top_y, width, bottom_y - top_y + 1);
2757
2758 XSetForeground (s->display, s->gc, xgcv.foreground);
2759 x_reset_clip_rectangles (s->f, s->gc);
2760 }
2761
2762
2763 /* Draw a box around glyph string S. */
2764
2765 static void
2766 x_draw_glyph_string_box (struct glyph_string *s)
2767 {
2768 int width, left_x, right_x, top_y, bottom_y, last_x;
2769 bool raised_p, left_p, right_p;
2770 struct glyph *last_glyph;
2771 XRectangle clip_rect;
2772
2773 last_x = ((s->row->full_width_p && !s->w->pseudo_window_p)
2774 ? WINDOW_RIGHT_EDGE_X (s->w)
2775 : window_box_right (s->w, s->area));
2776
2777 /* The glyph that may have a right box line. */
2778 last_glyph = (s->cmp || s->img
2779 ? s->first_glyph
2780 : s->first_glyph + s->nchars - 1);
2781
2782 width = eabs (s->face->box_line_width);
2783 raised_p = s->face->box == FACE_RAISED_BOX;
2784 left_x = s->x;
2785 right_x = (s->row->full_width_p && s->extends_to_end_of_line_p
2786 ? last_x - 1
2787 : min (last_x, s->x + s->background_width) - 1);
2788 top_y = s->y;
2789 bottom_y = top_y + s->height - 1;
2790
2791 left_p = (s->first_glyph->left_box_line_p
2792 || (s->hl == DRAW_MOUSE_FACE
2793 && (s->prev == NULL
2794 || s->prev->hl != s->hl)));
2795 right_p = (last_glyph->right_box_line_p
2796 || (s->hl == DRAW_MOUSE_FACE
2797 && (s->next == NULL
2798 || s->next->hl != s->hl)));
2799
2800 get_glyph_string_clip_rect (s, &clip_rect);
2801
2802 if (s->face->box == FACE_SIMPLE_BOX)
2803 x_draw_box_rect (s, left_x, top_y, right_x, bottom_y, width,
2804 left_p, right_p, &clip_rect);
2805 else
2806 {
2807 x_setup_relief_colors (s);
2808 x_draw_relief_rect (s->f, left_x, top_y, right_x, bottom_y,
2809 width, raised_p, true, true, left_p, right_p,
2810 &clip_rect);
2811 }
2812 }
2813
2814
2815 /* Draw foreground of image glyph string S. */
2816
2817 static void
2818 x_draw_image_foreground (struct glyph_string *s)
2819 {
2820 int x = s->x;
2821 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2822
2823 /* If first glyph of S has a left box line, start drawing it to the
2824 right of that line. */
2825 if (s->face->box != FACE_NO_BOX
2826 && s->first_glyph->left_box_line_p
2827 && s->slice.x == 0)
2828 x += eabs (s->face->box_line_width);
2829
2830 /* If there is a margin around the image, adjust x- and y-position
2831 by that margin. */
2832 if (s->slice.x == 0)
2833 x += s->img->hmargin;
2834 if (s->slice.y == 0)
2835 y += s->img->vmargin;
2836
2837 if (s->img->pixmap)
2838 {
2839 if (s->img->mask)
2840 {
2841 /* We can't set both a clip mask and use XSetClipRectangles
2842 because the latter also sets a clip mask. We also can't
2843 trust on the shape extension to be available
2844 (XShapeCombineRegion). So, compute the rectangle to draw
2845 manually. */
2846 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
2847 | GCFunction);
2848 XGCValues xgcv;
2849 XRectangle clip_rect, image_rect, r;
2850
2851 xgcv.clip_mask = s->img->mask;
2852 xgcv.clip_x_origin = x;
2853 xgcv.clip_y_origin = y;
2854 xgcv.function = GXcopy;
2855 XChangeGC (s->display, s->gc, mask, &xgcv);
2856
2857 get_glyph_string_clip_rect (s, &clip_rect);
2858 image_rect.x = x;
2859 image_rect.y = y;
2860 image_rect.width = s->slice.width;
2861 image_rect.height = s->slice.height;
2862 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2863 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2864 s->slice.x + r.x - x, s->slice.y + r.y - y,
2865 r.width, r.height, r.x, r.y);
2866 }
2867 else
2868 {
2869 XRectangle clip_rect, image_rect, r;
2870
2871 get_glyph_string_clip_rect (s, &clip_rect);
2872 image_rect.x = x;
2873 image_rect.y = y;
2874 image_rect.width = s->slice.width;
2875 image_rect.height = s->slice.height;
2876 if (x_intersect_rectangles (&clip_rect, &image_rect, &r))
2877 XCopyArea (s->display, s->img->pixmap, s->window, s->gc,
2878 s->slice.x + r.x - x, s->slice.y + r.y - y,
2879 r.width, r.height, r.x, r.y);
2880
2881 /* When the image has a mask, we can expect that at
2882 least part of a mouse highlight or a block cursor will
2883 be visible. If the image doesn't have a mask, make
2884 a block cursor visible by drawing a rectangle around
2885 the image. I believe it's looking better if we do
2886 nothing here for mouse-face. */
2887 if (s->hl == DRAW_CURSOR)
2888 {
2889 int relief = eabs (s->img->relief);
2890 x_draw_rectangle (s->f, s->gc,
2891 x - relief, y - relief,
2892 s->slice.width + relief*2 - 1,
2893 s->slice.height + relief*2 - 1);
2894 }
2895 }
2896 }
2897 else
2898 /* Draw a rectangle if image could not be loaded. */
2899 x_draw_rectangle (s->f, s->gc, x, y,
2900 s->slice.width - 1, s->slice.height - 1);
2901 }
2902
2903
2904 /* Draw a relief around the image glyph string S. */
2905
2906 static void
2907 x_draw_image_relief (struct glyph_string *s)
2908 {
2909 int x1, y1, thick;
2910 bool raised_p, top_p, bot_p, left_p, right_p;
2911 int extra_x, extra_y;
2912 XRectangle r;
2913 int x = s->x;
2914 int y = s->ybase - image_ascent (s->img, s->face, &s->slice);
2915
2916 /* If first glyph of S has a left box line, start drawing it to the
2917 right of that line. */
2918 if (s->face->box != FACE_NO_BOX
2919 && s->first_glyph->left_box_line_p
2920 && s->slice.x == 0)
2921 x += eabs (s->face->box_line_width);
2922
2923 /* If there is a margin around the image, adjust x- and y-position
2924 by that margin. */
2925 if (s->slice.x == 0)
2926 x += s->img->hmargin;
2927 if (s->slice.y == 0)
2928 y += s->img->vmargin;
2929
2930 if (s->hl == DRAW_IMAGE_SUNKEN
2931 || s->hl == DRAW_IMAGE_RAISED)
2932 {
2933 thick = tool_bar_button_relief >= 0 ? tool_bar_button_relief : DEFAULT_TOOL_BAR_BUTTON_RELIEF;
2934 raised_p = s->hl == DRAW_IMAGE_RAISED;
2935 }
2936 else
2937 {
2938 thick = eabs (s->img->relief);
2939 raised_p = s->img->relief > 0;
2940 }
2941
2942 x1 = x + s->slice.width - 1;
2943 y1 = y + s->slice.height - 1;
2944
2945 extra_x = extra_y = 0;
2946 if (s->face->id == TOOL_BAR_FACE_ID)
2947 {
2948 if (CONSP (Vtool_bar_button_margin)
2949 && INTEGERP (XCAR (Vtool_bar_button_margin))
2950 && INTEGERP (XCDR (Vtool_bar_button_margin)))
2951 {
2952 extra_x = XINT (XCAR (Vtool_bar_button_margin));
2953 extra_y = XINT (XCDR (Vtool_bar_button_margin));
2954 }
2955 else if (INTEGERP (Vtool_bar_button_margin))
2956 extra_x = extra_y = XINT (Vtool_bar_button_margin);
2957 }
2958
2959 top_p = bot_p = left_p = right_p = false;
2960
2961 if (s->slice.x == 0)
2962 x -= thick + extra_x, left_p = true;
2963 if (s->slice.y == 0)
2964 y -= thick + extra_y, top_p = true;
2965 if (s->slice.x + s->slice.width == s->img->width)
2966 x1 += thick + extra_x, right_p = true;
2967 if (s->slice.y + s->slice.height == s->img->height)
2968 y1 += thick + extra_y, bot_p = true;
2969
2970 x_setup_relief_colors (s);
2971 get_glyph_string_clip_rect (s, &r);
2972 x_draw_relief_rect (s->f, x, y, x1, y1, thick, raised_p,
2973 top_p, bot_p, left_p, right_p, &r);
2974 }
2975
2976
2977 /* Draw the foreground of image glyph string S to PIXMAP. */
2978
2979 static void
2980 x_draw_image_foreground_1 (struct glyph_string *s, Pixmap pixmap)
2981 {
2982 int x = 0;
2983 int y = s->ybase - s->y - image_ascent (s->img, s->face, &s->slice);
2984
2985 /* If first glyph of S has a left box line, start drawing it to the
2986 right of that line. */
2987 if (s->face->box != FACE_NO_BOX
2988 && s->first_glyph->left_box_line_p
2989 && s->slice.x == 0)
2990 x += eabs (s->face->box_line_width);
2991
2992 /* If there is a margin around the image, adjust x- and y-position
2993 by that margin. */
2994 if (s->slice.x == 0)
2995 x += s->img->hmargin;
2996 if (s->slice.y == 0)
2997 y += s->img->vmargin;
2998
2999 if (s->img->pixmap)
3000 {
3001 if (s->img->mask)
3002 {
3003 /* We can't set both a clip mask and use XSetClipRectangles
3004 because the latter also sets a clip mask. We also can't
3005 trust on the shape extension to be available
3006 (XShapeCombineRegion). So, compute the rectangle to draw
3007 manually. */
3008 unsigned long mask = (GCClipMask | GCClipXOrigin | GCClipYOrigin
3009 | GCFunction);
3010 XGCValues xgcv;
3011
3012 xgcv.clip_mask = s->img->mask;
3013 xgcv.clip_x_origin = x - s->slice.x;
3014 xgcv.clip_y_origin = y - s->slice.y;
3015 xgcv.function = GXcopy;
3016 XChangeGC (s->display, s->gc, mask, &xgcv);
3017
3018 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
3019 s->slice.x, s->slice.y,
3020 s->slice.width, s->slice.height, x, y);
3021 XSetClipMask (s->display, s->gc, None);
3022 }
3023 else
3024 {
3025 XCopyArea (s->display, s->img->pixmap, pixmap, s->gc,
3026 s->slice.x, s->slice.y,
3027 s->slice.width, s->slice.height, x, y);
3028
3029 /* When the image has a mask, we can expect that at
3030 least part of a mouse highlight or a block cursor will
3031 be visible. If the image doesn't have a mask, make
3032 a block cursor visible by drawing a rectangle around
3033 the image. I believe it's looking better if we do
3034 nothing here for mouse-face. */
3035 if (s->hl == DRAW_CURSOR)
3036 {
3037 int r = eabs (s->img->relief);
3038 x_draw_rectangle (s->f, s->gc, x - r, y - r,
3039 s->slice.width + r*2 - 1,
3040 s->slice.height + r*2 - 1);
3041 }
3042 }
3043 }
3044 else
3045 /* Draw a rectangle if image could not be loaded. */
3046 x_draw_rectangle (s->f, s->gc, x, y,
3047 s->slice.width - 1, s->slice.height - 1);
3048 }
3049
3050
3051 /* Draw part of the background of glyph string S. X, Y, W, and H
3052 give the rectangle to draw. */
3053
3054 static void
3055 x_draw_glyph_string_bg_rect (struct glyph_string *s, int x, int y, int w, int h)
3056 {
3057 if (s->stippled_p)
3058 {
3059 /* Fill background with a stipple pattern. */
3060 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
3061 x_fill_rectangle (s->f, s->gc, x, y, w, h);
3062 XSetFillStyle (s->display, s->gc, FillSolid);
3063 }
3064 else
3065 x_clear_glyph_string_rect (s, x, y, w, h);
3066 }
3067
3068
3069 /* Draw image glyph string S.
3070
3071 s->y
3072 s->x +-------------------------
3073 | s->face->box
3074 |
3075 | +-------------------------
3076 | | s->img->margin
3077 | |
3078 | | +-------------------
3079 | | | the image
3080
3081 */
3082
3083 static void
3084 x_draw_image_glyph_string (struct glyph_string *s)
3085 {
3086 int box_line_hwidth = eabs (s->face->box_line_width);
3087 int box_line_vwidth = max (s->face->box_line_width, 0);
3088 int height;
3089 Pixmap pixmap = None;
3090
3091 height = s->height;
3092 if (s->slice.y == 0)
3093 height -= box_line_vwidth;
3094 if (s->slice.y + s->slice.height >= s->img->height)
3095 height -= box_line_vwidth;
3096
3097 /* Fill background with face under the image. Do it only if row is
3098 taller than image or if image has a clip mask to reduce
3099 flickering. */
3100 s->stippled_p = s->face->stipple != 0;
3101 if (height > s->slice.height
3102 || s->img->hmargin
3103 || s->img->vmargin
3104 || s->img->mask
3105 || s->img->pixmap == 0
3106 || s->width != s->background_width)
3107 {
3108 if (s->img->mask)
3109 {
3110 /* Create a pixmap as large as the glyph string. Fill it
3111 with the background color. Copy the image to it, using
3112 its mask. Copy the temporary pixmap to the display. */
3113 Screen *screen = FRAME_X_SCREEN (s->f);
3114 int depth = DefaultDepthOfScreen (screen);
3115
3116 /* Create a pixmap as large as the glyph string. */
3117 pixmap = XCreatePixmap (s->display, s->window,
3118 s->background_width,
3119 s->height, depth);
3120
3121 /* Don't clip in the following because we're working on the
3122 pixmap. */
3123 XSetClipMask (s->display, s->gc, None);
3124
3125 /* Fill the pixmap with the background color/stipple. */
3126 if (s->stippled_p)
3127 {
3128 /* Fill background with a stipple pattern. */
3129 XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
3130 XSetTSOrigin (s->display, s->gc, - s->x, - s->y);
3131 XFillRectangle (s->display, pixmap, s->gc,
3132 0, 0, s->background_width, s->height);
3133 XSetFillStyle (s->display, s->gc, FillSolid);
3134 XSetTSOrigin (s->display, s->gc, 0, 0);
3135 }
3136 else
3137 {
3138 XGCValues xgcv;
3139 XGetGCValues (s->display, s->gc, GCForeground | GCBackground,
3140 &xgcv);
3141 XSetForeground (s->display, s->gc, xgcv.background);
3142 XFillRectangle (s->display, pixmap, s->gc,
3143 0, 0, s->background_width, s->height);
3144 XSetForeground (s->display, s->gc, xgcv.foreground);
3145 }
3146 }
3147 else
3148 {
3149 int x = s->x;
3150 int y = s->y;
3151 int width = s->background_width;
3152
3153 if (s->first_glyph->left_box_line_p
3154 && s->slice.x == 0)
3155 {
3156 x += box_line_hwidth;
3157 width -= box_line_hwidth;
3158 }
3159
3160 if (s->slice.y == 0)
3161 y += box_line_vwidth;
3162
3163 x_draw_glyph_string_bg_rect (s, x, y, width, height);
3164 }
3165
3166 s->background_filled_p = true;
3167 }
3168
3169 /* Draw the foreground. */
3170 #ifdef USE_CAIRO
3171 if (s->img->cr_data)
3172 {
3173 cairo_t *cr = x_begin_cr_clip (s->f, s->gc);
3174
3175 int x = s->x + s->img->hmargin;
3176 int y = s->y + s->img->vmargin;
3177 int width = s->background_width;
3178
3179 cairo_set_source_surface (cr, s->img->cr_data,
3180 x - s->slice.x,
3181 y - s->slice.y);
3182 cairo_rectangle (cr, x, y, width, height);
3183 cairo_fill (cr);
3184 x_end_cr_clip (s->f);
3185 }
3186 else
3187 #endif
3188 if (pixmap != None)
3189 {
3190 x_draw_image_foreground_1 (s, pixmap);
3191 x_set_glyph_string_clipping (s);
3192 XCopyArea (s->display, pixmap, s->window, s->gc,
3193 0, 0, s->background_width, s->height, s->x, s->y);
3194 XFreePixmap (s->display, pixmap);
3195 }
3196 else
3197 x_draw_image_foreground (s);
3198
3199 /* If we must draw a relief around the image, do it. */
3200 if (s->img->relief
3201 || s->hl == DRAW_IMAGE_RAISED
3202 || s->hl == DRAW_IMAGE_SUNKEN)
3203 x_draw_image_relief (s);
3204 }
3205
3206
3207 /* Draw stretch glyph string S. */
3208
3209 static void
3210 x_draw_stretch_glyph_string (struct glyph_string *s)
3211 {
3212 eassert (s->first_glyph->type == STRETCH_GLYPH);
3213
3214 if (s->hl == DRAW_CURSOR
3215 && !x_stretch_cursor_p)
3216 {
3217 /* If `x-stretch-cursor' is nil, don't draw a block cursor as
3218 wide as the stretch glyph. */
3219 int width, background_width = s->background_width;
3220 int x = s->x;
3221
3222 if (!s->row->reversed_p)
3223 {
3224 int left_x = window_box_left_offset (s->w, TEXT_AREA);
3225
3226 if (x < left_x)
3227 {
3228 background_width -= left_x - x;
3229 x = left_x;
3230 }
3231 }
3232 else
3233 {
3234 /* In R2L rows, draw the cursor on the right edge of the
3235 stretch glyph. */
3236 int right_x = window_box_right (s->w, TEXT_AREA);
3237
3238 if (x + background_width > right_x)
3239 background_width -= x - right_x;
3240 x += background_width;
3241 }
3242 width = min (FRAME_COLUMN_WIDTH (s->f), background_width);
3243 if (s->row->reversed_p)
3244 x -= width;
3245
3246 /* Draw cursor. */
3247 x_draw_glyph_string_bg_rect (s, x, s->y, width, s->height);
3248
3249 /* Clear rest using the GC of the original non-cursor face. */
3250 if (width < background_width)
3251 {
3252 int y = s->y;
3253 int w = background_width - width, h = s->height;
3254 XRectangle r;
3255 GC gc;
3256
3257 if (!s->row->reversed_p)
3258 x += width;
3259 else
3260 x = s->x;
3261 if (s->row->mouse_face_p
3262 && cursor_in_mouse_face_p (s->w))
3263 {
3264 x_set_mouse_face_gc (s);
3265 gc = s->gc;
3266 }
3267 else
3268 gc = s->face->gc;
3269
3270 get_glyph_string_clip_rect (s, &r);
3271 x_set_clip_rectangles (s->f, gc, &r, 1);
3272
3273 if (s->face->stipple)
3274 {
3275 /* Fill background with a stipple pattern. */
3276 XSetFillStyle (s->display, gc, FillOpaqueStippled);
3277 x_fill_rectangle (s->f, gc, x, y, w, h);
3278 XSetFillStyle (s->display, gc, FillSolid);
3279 }
3280 else
3281 {
3282 XGCValues xgcv;
3283 XGetGCValues (s->display, gc, GCForeground | GCBackground, &xgcv);
3284 XSetForeground (s->display, gc, xgcv.background);
3285 x_fill_rectangle (s->f, gc, x, y, w, h);
3286 XSetForeground (s->display, gc, xgcv.foreground);
3287 }
3288
3289 x_reset_clip_rectangles (s->f, gc);
3290 }
3291 }
3292 else if (!s->background_filled_p)
3293 {
3294 int background_width = s->background_width;
3295 int x = s->x, left_x = window_box_left_offset (s->w, TEXT_AREA);
3296
3297 /* Don't draw into left margin, fringe or scrollbar area
3298 except for header line and mode line. */
3299 if (x < left_x && !s->row->mode_line_p)
3300 {
3301 background_width -= left_x - x;
3302 x = left_x;
3303 }
3304 if (background_width > 0)
3305 x_draw_glyph_string_bg_rect (s, x, s->y, background_width, s->height);
3306 }
3307
3308 s->background_filled_p = true;
3309 }
3310
3311 /*
3312 Draw a wavy line under S. The wave fills wave_height pixels from y0.
3313
3314 x0 wave_length = 2
3315 --
3316 y0 * * * * *
3317 |* * * * * * * * *
3318 wave_height = 3 | * * * *
3319
3320 */
3321
3322 static void
3323 x_draw_underwave (struct glyph_string *s)
3324 {
3325 int wave_height = 3, wave_length = 2;
3326 #ifdef USE_CAIRO
3327 x_draw_horizontal_wave (s->f, s->gc, s->x, s->ybase - wave_height + 3,
3328 s->width, wave_height, wave_length);
3329 #else /* not USE_CAIRO */
3330 int dx, dy, x0, y0, width, x1, y1, x2, y2, xmax;
3331 bool odd;
3332 XRectangle wave_clip, string_clip, final_clip;
3333
3334 dx = wave_length;
3335 dy = wave_height - 1;
3336 x0 = s->x;
3337 y0 = s->ybase - wave_height + 3;
3338 width = s->width;
3339 xmax = x0 + width;
3340
3341 /* Find and set clipping rectangle */
3342
3343 wave_clip.x = x0;
3344 wave_clip.y = y0;
3345 wave_clip.width = width;
3346 wave_clip.height = wave_height;
3347 get_glyph_string_clip_rect (s, &string_clip);
3348
3349 if (!x_intersect_rectangles (&wave_clip, &string_clip, &final_clip))
3350 return;
3351
3352 XSetClipRectangles (s->display, s->gc, 0, 0, &final_clip, 1, Unsorted);
3353
3354 /* Draw the waves */
3355
3356 x1 = x0 - (x0 % dx);
3357 x2 = x1 + dx;
3358 odd = (x1 / dx) & 1;
3359 y1 = y2 = y0;
3360
3361 if (odd)
3362 y1 += dy;
3363 else
3364 y2 += dy;
3365
3366 if (INT_MAX - dx < xmax)
3367 emacs_abort ();
3368
3369 while (x1 <= xmax)
3370 {
3371 XDrawLine (s->display, s->window, s->gc, x1, y1, x2, y2);
3372 x1 = x2, y1 = y2;
3373 x2 += dx, y2 = y0 + odd*dy;
3374 odd = !odd;
3375 }
3376
3377 /* Restore previous clipping rectangle(s) */
3378 XSetClipRectangles (s->display, s->gc, 0, 0, s->clip, s->num_clips, Unsorted);
3379 #endif /* not USE_CAIRO */
3380 }
3381
3382
3383 /* Draw glyph string S. */
3384
3385 static void
3386 x_draw_glyph_string (struct glyph_string *s)
3387 {
3388 bool relief_drawn_p = false;
3389
3390 /* If S draws into the background of its successors, draw the
3391 background of the successors first so that S can draw into it.
3392 This makes S->next use XDrawString instead of XDrawImageString. */
3393 if (s->next && s->right_overhang && !s->for_overlaps)
3394 {
3395 int width;
3396 struct glyph_string *next;
3397
3398 for (width = 0, next = s->next;
3399 next && width < s->right_overhang;
3400 width += next->width, next = next->next)
3401 if (next->first_glyph->type != IMAGE_GLYPH)
3402 {
3403 x_set_glyph_string_gc (next);
3404 x_set_glyph_string_clipping (next);
3405 if (next->first_glyph->type == STRETCH_GLYPH)
3406 x_draw_stretch_glyph_string (next);
3407 else
3408 x_draw_glyph_string_background (next, true);
3409 next->num_clips = 0;
3410 }
3411 }
3412
3413 /* Set up S->gc, set clipping and draw S. */
3414 x_set_glyph_string_gc (s);
3415
3416 /* Draw relief (if any) in advance for char/composition so that the
3417 glyph string can be drawn over it. */
3418 if (!s->for_overlaps
3419 && s->face->box != FACE_NO_BOX
3420 && (s->first_glyph->type == CHAR_GLYPH
3421 || s->first_glyph->type == COMPOSITE_GLYPH))
3422
3423 {
3424 x_set_glyph_string_clipping (s);
3425 x_draw_glyph_string_background (s, true);
3426 x_draw_glyph_string_box (s);
3427 x_set_glyph_string_clipping (s);
3428 relief_drawn_p = true;
3429 }
3430 else if (!s->clip_head /* draw_glyphs didn't specify a clip mask. */
3431 && !s->clip_tail
3432 && ((s->prev && s->prev->hl != s->hl && s->left_overhang)
3433 || (s->next && s->next->hl != s->hl && s->right_overhang)))
3434 /* We must clip just this glyph. left_overhang part has already
3435 drawn when s->prev was drawn, and right_overhang part will be
3436 drawn later when s->next is drawn. */
3437 x_set_glyph_string_clipping_exactly (s, s);
3438 else
3439 x_set_glyph_string_clipping (s);
3440
3441 switch (s->first_glyph->type)
3442 {
3443 case IMAGE_GLYPH:
3444 x_draw_image_glyph_string (s);
3445 break;
3446
3447 case STRETCH_GLYPH:
3448 x_draw_stretch_glyph_string (s);
3449 break;
3450
3451 case CHAR_GLYPH:
3452 if (s->for_overlaps)
3453 s->background_filled_p = true;
3454 else
3455 x_draw_glyph_string_background (s, false);
3456 x_draw_glyph_string_foreground (s);
3457 break;
3458
3459 case COMPOSITE_GLYPH:
3460 if (s->for_overlaps || (s->cmp_from > 0
3461 && ! s->first_glyph->u.cmp.automatic))
3462 s->background_filled_p = true;
3463 else
3464 x_draw_glyph_string_background (s, true);
3465 x_draw_composite_glyph_string_foreground (s);
3466 break;
3467
3468 case GLYPHLESS_GLYPH:
3469 if (s->for_overlaps)
3470 s->background_filled_p = true;
3471 else
3472 x_draw_glyph_string_background (s, true);
3473 x_draw_glyphless_glyph_string_foreground (s);
3474 break;
3475
3476 default:
3477 emacs_abort ();
3478 }
3479
3480 if (!s->for_overlaps)
3481 {
3482 /* Draw underline. */
3483 if (s->face->underline_p)
3484 {
3485 if (s->face->underline_type == FACE_UNDER_WAVE)
3486 {
3487 if (s->face->underline_defaulted_p)
3488 x_draw_underwave (s);
3489 else
3490 {
3491 XGCValues xgcv;
3492 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
3493 XSetForeground (s->display, s->gc, s->face->underline_color);
3494 x_draw_underwave (s);
3495 XSetForeground (s->display, s->gc, xgcv.foreground);
3496 }
3497 }
3498 else if (s->face->underline_type == FACE_UNDER_LINE)
3499 {
3500 unsigned long thickness, position;
3501 int y;
3502
3503 if (s->prev && s->prev->face->underline_p
3504 && s->prev->face->underline_type == FACE_UNDER_LINE)
3505 {
3506 /* We use the same underline style as the previous one. */
3507 thickness = s->prev->underline_thickness;
3508 position = s->prev->underline_position;
3509 }
3510 else
3511 {
3512 /* Get the underline thickness. Default is 1 pixel. */
3513 if (s->font && s->font->underline_thickness > 0)
3514 thickness = s->font->underline_thickness;
3515 else
3516 thickness = 1;
3517 if (x_underline_at_descent_line)
3518 position = (s->height - thickness) - (s->ybase - s->y);
3519 else
3520 {
3521 /* Get the underline position. This is the recommended
3522 vertical offset in pixels from the baseline to the top of
3523 the underline. This is a signed value according to the
3524 specs, and its default is
3525
3526 ROUND ((maximum descent) / 2), with
3527 ROUND(x) = floor (x + 0.5) */
3528
3529 if (x_use_underline_position_properties
3530 && s->font && s->font->underline_position >= 0)
3531 position = s->font->underline_position;
3532 else if (s->font)
3533 position = (s->font->descent + 1) / 2;
3534 else
3535 position = underline_minimum_offset;
3536 }
3537 position = max (position, underline_minimum_offset);
3538 }
3539 /* Check the sanity of thickness and position. We should
3540 avoid drawing underline out of the current line area. */
3541 if (s->y + s->height <= s->ybase + position)
3542 position = (s->height - 1) - (s->ybase - s->y);
3543 if (s->y + s->height < s->ybase + position + thickness)
3544 thickness = (s->y + s->height) - (s->ybase + position);
3545 s->underline_thickness = thickness;
3546 s->underline_position = position;
3547 y = s->ybase + position;
3548 if (s->face->underline_defaulted_p)
3549 x_fill_rectangle (s->f, s->gc,
3550 s->x, y, s->width, thickness);
3551 else
3552 {
3553 XGCValues xgcv;
3554 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
3555 XSetForeground (s->display, s->gc, s->face->underline_color);
3556 x_fill_rectangle (s->f, s->gc,
3557 s->x, y, s->width, thickness);
3558 XSetForeground (s->display, s->gc, xgcv.foreground);
3559 }
3560 }
3561 }
3562 /* Draw overline. */
3563 if (s->face->overline_p)
3564 {
3565 unsigned long dy = 0, h = 1;
3566
3567 if (s->face->overline_color_defaulted_p)
3568 x_fill_rectangle (s->f, s->gc, s->x, s->y + dy,
3569 s->width, h);
3570 else
3571 {
3572 XGCValues xgcv;
3573 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
3574 XSetForeground (s->display, s->gc, s->face->overline_color);
3575 x_fill_rectangle (s->f, s->gc, s->x, s->y + dy,
3576 s->width, h);
3577 XSetForeground (s->display, s->gc, xgcv.foreground);
3578 }
3579 }
3580
3581 /* Draw strike-through. */
3582 if (s->face->strike_through_p)
3583 {
3584 unsigned long h = 1;
3585 unsigned long dy = (s->height - h) / 2;
3586
3587 if (s->face->strike_through_color_defaulted_p)
3588 x_fill_rectangle (s->f, s->gc, s->x, s->y + dy,
3589 s->width, h);
3590 else
3591 {
3592 XGCValues xgcv;
3593 XGetGCValues (s->display, s->gc, GCForeground, &xgcv);
3594 XSetForeground (s->display, s->gc, s->face->strike_through_color);
3595 x_fill_rectangle (s->f, s->gc, s->x, s->y + dy,
3596 s->width, h);
3597 XSetForeground (s->display, s->gc, xgcv.foreground);
3598 }
3599 }
3600
3601 /* Draw relief if not yet drawn. */
3602 if (!relief_drawn_p && s->face->box != FACE_NO_BOX)
3603 x_draw_glyph_string_box (s);
3604
3605 if (s->prev)
3606 {
3607 struct glyph_string *prev;
3608
3609 for (prev = s->prev; prev; prev = prev->prev)
3610 if (prev->hl != s->hl
3611 && prev->x + prev->width + prev->right_overhang > s->x)
3612 {
3613 /* As prev was drawn while clipped to its own area, we
3614 must draw the right_overhang part using s->hl now. */
3615 enum draw_glyphs_face save = prev->hl;
3616
3617 prev->hl = s->hl;
3618 x_set_glyph_string_gc (prev);
3619 x_set_glyph_string_clipping_exactly (s, prev);
3620 if (prev->first_glyph->type == CHAR_GLYPH)
3621 x_draw_glyph_string_foreground (prev);
3622 else
3623 x_draw_composite_glyph_string_foreground (prev);
3624 x_reset_clip_rectangles (prev->f, prev->gc);
3625 prev->hl = save;
3626 prev->num_clips = 0;
3627 }
3628 }
3629
3630 if (s->next)
3631 {
3632 struct glyph_string *next;
3633
3634 for (next = s->next; next; next = next->next)
3635 if (next->hl != s->hl
3636 && next->x - next->left_overhang < s->x + s->width)
3637 {
3638 /* As next will be drawn while clipped to its own area,
3639 we must draw the left_overhang part using s->hl now. */
3640 enum draw_glyphs_face save = next->hl;
3641
3642 next->hl = s->hl;
3643 x_set_glyph_string_gc (next);
3644 x_set_glyph_string_clipping_exactly (s, next);
3645 if (next->first_glyph->type == CHAR_GLYPH)
3646 x_draw_glyph_string_foreground (next);
3647 else
3648 x_draw_composite_glyph_string_foreground (next);
3649 x_reset_clip_rectangles (next->f, next->gc);
3650 next->hl = save;
3651 next->num_clips = 0;
3652 next->clip_head = s->next;
3653 }
3654 }
3655 }
3656
3657 /* Reset clipping. */
3658 x_reset_clip_rectangles (s->f, s->gc);
3659 s->num_clips = 0;
3660 }
3661
3662 /* Shift display to make room for inserted glyphs. */
3663
3664 static void
3665 x_shift_glyphs_for_insert (struct frame *f, int x, int y, int width, int height, int shift_by)
3666 {
3667 /* Never called on a GUI frame, see
3668 http://lists.gnu.org/archive/html/emacs-devel/2015-05/msg00456.html
3669 */
3670 XCopyArea (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
3671 f->output_data.x->normal_gc,
3672 x, y, width, height,
3673 x + shift_by, y);
3674 }
3675
3676 /* Delete N glyphs at the nominal cursor position. Not implemented
3677 for X frames. */
3678
3679 static void
3680 x_delete_glyphs (struct frame *f, register int n)
3681 {
3682 emacs_abort ();
3683 }
3684
3685
3686 /* Like XClearArea, but check that WIDTH and HEIGHT are reasonable.
3687 If they are <= 0, this is probably an error. */
3688
3689 static void
3690 x_clear_area1 (Display *dpy, Window window,
3691 int x, int y, int width, int height, int exposures)
3692 {
3693 eassert (width > 0 && height > 0);
3694 XClearArea (dpy, window, x, y, width, height, exposures);
3695 }
3696
3697
3698 void
3699 x_clear_area (struct frame *f, int x, int y, int width, int height)
3700 {
3701 #ifdef USE_CAIRO
3702 cairo_t *cr;
3703
3704 eassert (width > 0 && height > 0);
3705
3706 cr = x_begin_cr_clip (f, NULL);
3707 x_set_cr_source_with_gc_background (f, f->output_data.x->normal_gc);
3708 cairo_rectangle (cr, x, y, width, height);
3709 cairo_fill (cr);
3710 x_end_cr_clip (f);
3711 #else
3712 x_clear_area1 (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3713 x, y, width, height, False);
3714 #endif
3715 }
3716
3717
3718 /* Clear an entire frame. */
3719
3720 static void
3721 x_clear_frame (struct frame *f)
3722 {
3723 /* Clearing the frame will erase any cursor, so mark them all as no
3724 longer visible. */
3725 mark_window_cursors_off (XWINDOW (FRAME_ROOT_WINDOW (f)));
3726
3727 block_input ();
3728
3729 x_clear_window (f);
3730
3731 /* We have to clear the scroll bars. If we have changed colors or
3732 something like that, then they should be notified. */
3733 x_scroll_bar_clear (f);
3734
3735 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
3736 /* Make sure scroll bars are redrawn. As they aren't redrawn by
3737 redisplay, do it here. */
3738 if (FRAME_GTK_WIDGET (f))
3739 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
3740 #endif
3741
3742 XFlush (FRAME_X_DISPLAY (f));
3743
3744 unblock_input ();
3745 }
3746
3747 /* RIF: Show hourglass cursor on frame F. */
3748
3749 static void
3750 x_show_hourglass (struct frame *f)
3751 {
3752 Display *dpy = FRAME_X_DISPLAY (f);
3753
3754 if (dpy)
3755 {
3756 struct x_output *x = FRAME_X_OUTPUT (f);
3757 #ifdef USE_X_TOOLKIT
3758 if (x->widget)
3759 #else
3760 if (FRAME_OUTER_WINDOW (f))
3761 #endif
3762 {
3763 x->hourglass_p = true;
3764
3765 if (!x->hourglass_window)
3766 {
3767 unsigned long mask = CWCursor;
3768 XSetWindowAttributes attrs;
3769 #ifdef USE_GTK
3770 Window parent = FRAME_X_WINDOW (f);
3771 #else
3772 Window parent = FRAME_OUTER_WINDOW (f);
3773 #endif
3774 attrs.cursor = x->hourglass_cursor;
3775
3776 x->hourglass_window = XCreateWindow
3777 (dpy, parent, 0, 0, 32000, 32000, 0, 0,
3778 InputOnly, CopyFromParent, mask, &attrs);
3779 }
3780
3781 XMapRaised (dpy, x->hourglass_window);
3782 XFlush (dpy);
3783 }
3784 }
3785 }
3786
3787 /* RIF: Cancel hourglass cursor on frame F. */
3788
3789 static void
3790 x_hide_hourglass (struct frame *f)
3791 {
3792 struct x_output *x = FRAME_X_OUTPUT (f);
3793
3794 /* Watch out for newly created frames. */
3795 if (x->hourglass_window)
3796 {
3797 XUnmapWindow (FRAME_X_DISPLAY (f), x->hourglass_window);
3798 /* Sync here because XTread_socket looks at the
3799 hourglass_p flag that is reset to zero below. */
3800 XSync (FRAME_X_DISPLAY (f), False);
3801 x->hourglass_p = false;
3802 }
3803 }
3804
3805 /* Invert the middle quarter of the frame for .15 sec. */
3806
3807 static void
3808 XTflash (struct frame *f)
3809 {
3810 block_input ();
3811
3812 {
3813 #ifdef USE_GTK
3814 /* Use Gdk routines to draw. This way, we won't draw over scroll bars
3815 when the scroll bars and the edit widget share the same X window. */
3816 GdkWindow *window = gtk_widget_get_window (FRAME_GTK_WIDGET (f));
3817 #ifdef HAVE_GTK3
3818 cairo_t *cr = gdk_cairo_create (window);
3819 cairo_set_source_rgb (cr, 1, 1, 1);
3820 cairo_set_operator (cr, CAIRO_OPERATOR_DIFFERENCE);
3821 #define XFillRectangle(d, win, gc, x, y, w, h) \
3822 do { \
3823 cairo_rectangle (cr, x, y, w, h); \
3824 cairo_fill (cr); \
3825 } \
3826 while (false)
3827 #else /* ! HAVE_GTK3 */
3828 GdkGCValues vals;
3829 GdkGC *gc;
3830 vals.foreground.pixel = (FRAME_FOREGROUND_PIXEL (f)
3831 ^ FRAME_BACKGROUND_PIXEL (f));
3832 vals.function = GDK_XOR;
3833 gc = gdk_gc_new_with_values (window,
3834 &vals, GDK_GC_FUNCTION | GDK_GC_FOREGROUND);
3835 #define XFillRectangle(d, win, gc, x, y, w, h) \
3836 gdk_draw_rectangle (window, gc, true, x, y, w, h)
3837 #endif /* ! HAVE_GTK3 */
3838 #else /* ! USE_GTK */
3839 GC gc;
3840
3841 /* Create a GC that will use the GXxor function to flip foreground
3842 pixels into background pixels. */
3843 {
3844 XGCValues values;
3845
3846 values.function = GXxor;
3847 values.foreground = (FRAME_FOREGROUND_PIXEL (f)
3848 ^ FRAME_BACKGROUND_PIXEL (f));
3849
3850 gc = XCreateGC (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
3851 GCFunction | GCForeground, &values);
3852 }
3853 #endif
3854 {
3855 /* Get the height not including a menu bar widget. */
3856 int height = FRAME_PIXEL_HEIGHT (f);
3857 /* Height of each line to flash. */
3858 int flash_height = FRAME_LINE_HEIGHT (f);
3859 /* These will be the left and right margins of the rectangles. */
3860 int flash_left = FRAME_INTERNAL_BORDER_WIDTH (f);
3861 int flash_right = FRAME_PIXEL_WIDTH (f) - FRAME_INTERNAL_BORDER_WIDTH (f);
3862 int width = flash_right - flash_left;
3863
3864 /* If window is tall, flash top and bottom line. */
3865 if (height > 3 * FRAME_LINE_HEIGHT (f))
3866 {
3867 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3868 flash_left,
3869 (FRAME_INTERNAL_BORDER_WIDTH (f)
3870 + FRAME_TOP_MARGIN_HEIGHT (f)),
3871 width, flash_height);
3872 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3873 flash_left,
3874 (height - flash_height
3875 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3876 width, flash_height);
3877
3878 }
3879 else
3880 /* If it is short, flash it all. */
3881 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3882 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3883 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3884
3885 x_flush (f);
3886
3887 {
3888 struct timespec delay = make_timespec (0, 150 * 1000 * 1000);
3889 struct timespec wakeup = timespec_add (current_timespec (), delay);
3890
3891 /* Keep waiting until past the time wakeup or any input gets
3892 available. */
3893 while (! detect_input_pending ())
3894 {
3895 struct timespec current = current_timespec ();
3896 struct timespec timeout;
3897
3898 /* Break if result would not be positive. */
3899 if (timespec_cmp (wakeup, current) <= 0)
3900 break;
3901
3902 /* How long `select' should wait. */
3903 timeout = make_timespec (0, 10 * 1000 * 1000);
3904
3905 /* Try to wait that long--but we might wake up sooner. */
3906 pselect (0, NULL, NULL, NULL, &timeout, NULL);
3907 }
3908 }
3909
3910 /* If window is tall, flash top and bottom line. */
3911 if (height > 3 * FRAME_LINE_HEIGHT (f))
3912 {
3913 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3914 flash_left,
3915 (FRAME_INTERNAL_BORDER_WIDTH (f)
3916 + FRAME_TOP_MARGIN_HEIGHT (f)),
3917 width, flash_height);
3918 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3919 flash_left,
3920 (height - flash_height
3921 - FRAME_INTERNAL_BORDER_WIDTH (f)),
3922 width, flash_height);
3923 }
3924 else
3925 /* If it is short, flash it all. */
3926 XFillRectangle (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), gc,
3927 flash_left, FRAME_INTERNAL_BORDER_WIDTH (f),
3928 width, height - 2 * FRAME_INTERNAL_BORDER_WIDTH (f));
3929
3930 #ifdef USE_GTK
3931 #ifdef HAVE_GTK3
3932 cairo_destroy (cr);
3933 #else
3934 g_object_unref (G_OBJECT (gc));
3935 #endif
3936 #undef XFillRectangle
3937 #else
3938 XFreeGC (FRAME_X_DISPLAY (f), gc);
3939 #endif
3940 x_flush (f);
3941 }
3942 }
3943
3944 unblock_input ();
3945 }
3946
3947
3948 static void
3949 XTtoggle_invisible_pointer (struct frame *f, bool invisible)
3950 {
3951 block_input ();
3952 FRAME_DISPLAY_INFO (f)->toggle_visible_pointer (f, invisible);
3953 unblock_input ();
3954 }
3955
3956
3957 /* Make audible bell. */
3958
3959 static void
3960 XTring_bell (struct frame *f)
3961 {
3962 if (FRAME_X_DISPLAY (f))
3963 {
3964 if (visible_bell)
3965 XTflash (f);
3966 else
3967 {
3968 block_input ();
3969 #ifdef HAVE_XKB
3970 XkbBell (FRAME_X_DISPLAY (f), None, 0, None);
3971 #else
3972 XBell (FRAME_X_DISPLAY (f), 0);
3973 #endif
3974 XFlush (FRAME_X_DISPLAY (f));
3975 unblock_input ();
3976 }
3977 }
3978 }
3979
3980 /***********************************************************************
3981 Line Dance
3982 ***********************************************************************/
3983
3984 /* Perform an insert-lines or delete-lines operation, inserting N
3985 lines or deleting -N lines at vertical position VPOS. */
3986
3987 static void
3988 x_ins_del_lines (struct frame *f, int vpos, int n)
3989 {
3990 emacs_abort ();
3991 }
3992
3993
3994 /* Scroll part of the display as described by RUN. */
3995
3996 static void
3997 x_scroll_run (struct window *w, struct run *run)
3998 {
3999 struct frame *f = XFRAME (w->frame);
4000 int x, y, width, height, from_y, to_y, bottom_y;
4001
4002 /* Get frame-relative bounding box of the text display area of W,
4003 without mode lines. Include in this box the left and right
4004 fringe of W. */
4005 window_box (w, ANY_AREA, &x, &y, &width, &height);
4006
4007 from_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->current_y);
4008 to_y = WINDOW_TO_FRAME_PIXEL_Y (w, run->desired_y);
4009 bottom_y = y + height;
4010
4011 if (to_y < from_y)
4012 {
4013 /* Scrolling up. Make sure we don't copy part of the mode
4014 line at the bottom. */
4015 if (from_y + run->height > bottom_y)
4016 height = bottom_y - from_y;
4017 else
4018 height = run->height;
4019 }
4020 else
4021 {
4022 /* Scrolling down. Make sure we don't copy over the mode line.
4023 at the bottom. */
4024 if (to_y + run->height > bottom_y)
4025 height = bottom_y - to_y;
4026 else
4027 height = run->height;
4028 }
4029
4030 block_input ();
4031
4032 /* Cursor off. Will be switched on again in x_update_window_end. */
4033 x_clear_cursor (w);
4034
4035 #ifdef USE_CAIRO
4036 SET_FRAME_GARBAGED (f);
4037 #else
4038 XCopyArea (FRAME_X_DISPLAY (f),
4039 FRAME_X_WINDOW (f), FRAME_X_WINDOW (f),
4040 f->output_data.x->normal_gc,
4041 x, from_y,
4042 width, height,
4043 x, to_y);
4044 #endif
4045
4046 unblock_input ();
4047 }
4048
4049
4050 \f
4051 /***********************************************************************
4052 Exposure Events
4053 ***********************************************************************/
4054
4055 \f
4056 static void
4057 frame_highlight (struct frame *f)
4058 {
4059 /* We used to only do this if Vx_no_window_manager was non-nil, but
4060 the ICCCM (section 4.1.6) says that the window's border pixmap
4061 and border pixel are window attributes which are "private to the
4062 client", so we can always change it to whatever we want. */
4063 block_input ();
4064 /* I recently started to get errors in this XSetWindowBorder, depending on
4065 the window-manager in use, tho something more is at play since I've been
4066 using that same window-manager binary for ever. Let's not crash just
4067 because of this (bug#9310). */
4068 x_catch_errors (FRAME_X_DISPLAY (f));
4069 XSetWindowBorder (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4070 f->output_data.x->border_pixel);
4071 x_uncatch_errors ();
4072 unblock_input ();
4073 x_update_cursor (f, true);
4074 x_set_frame_alpha (f);
4075 }
4076
4077 static void
4078 frame_unhighlight (struct frame *f)
4079 {
4080 /* We used to only do this if Vx_no_window_manager was non-nil, but
4081 the ICCCM (section 4.1.6) says that the window's border pixmap
4082 and border pixel are window attributes which are "private to the
4083 client", so we can always change it to whatever we want. */
4084 block_input ();
4085 /* Same as above for XSetWindowBorder (bug#9310). */
4086 x_catch_errors (FRAME_X_DISPLAY (f));
4087 XSetWindowBorderPixmap (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
4088 f->output_data.x->border_tile);
4089 x_uncatch_errors ();
4090 unblock_input ();
4091 x_update_cursor (f, true);
4092 x_set_frame_alpha (f);
4093 }
4094
4095 /* The focus has changed. Update the frames as necessary to reflect
4096 the new situation. Note that we can't change the selected frame
4097 here, because the Lisp code we are interrupting might become confused.
4098 Each event gets marked with the frame in which it occurred, so the
4099 Lisp code can tell when the switch took place by examining the events. */
4100
4101 static void
4102 x_new_focus_frame (struct x_display_info *dpyinfo, struct frame *frame)
4103 {
4104 struct frame *old_focus = dpyinfo->x_focus_frame;
4105
4106 if (frame != dpyinfo->x_focus_frame)
4107 {
4108 /* Set this before calling other routines, so that they see
4109 the correct value of x_focus_frame. */
4110 dpyinfo->x_focus_frame = frame;
4111
4112 if (old_focus && old_focus->auto_lower)
4113 x_lower_frame (old_focus);
4114
4115 if (dpyinfo->x_focus_frame && dpyinfo->x_focus_frame->auto_raise)
4116 dpyinfo->x_pending_autoraise_frame = dpyinfo->x_focus_frame;
4117 else
4118 dpyinfo->x_pending_autoraise_frame = NULL;
4119 }
4120
4121 x_frame_rehighlight (dpyinfo);
4122 }
4123
4124 /* Handle FocusIn and FocusOut state changes for FRAME.
4125 If FRAME has focus and there exists more than one frame, puts
4126 a FOCUS_IN_EVENT into *BUFP. */
4127
4128 static void
4129 x_focus_changed (int type, int state, struct x_display_info *dpyinfo, struct frame *frame, struct input_event *bufp)
4130 {
4131 if (type == FocusIn)
4132 {
4133 if (dpyinfo->x_focus_event_frame != frame)
4134 {
4135 x_new_focus_frame (dpyinfo, frame);
4136 dpyinfo->x_focus_event_frame = frame;
4137
4138 /* Don't stop displaying the initial startup message
4139 for a switch-frame event we don't need. */
4140 /* When run as a daemon, Vterminal_frame is always NIL. */
4141 bufp->arg = (((NILP (Vterminal_frame)
4142 || ! FRAME_X_P (XFRAME (Vterminal_frame))
4143 || EQ (Fdaemonp (), Qt))
4144 && CONSP (Vframe_list)
4145 && !NILP (XCDR (Vframe_list)))
4146 ? Qt : Qnil);
4147 bufp->kind = FOCUS_IN_EVENT;
4148 XSETFRAME (bufp->frame_or_window, frame);
4149 }
4150
4151 frame->output_data.x->focus_state |= state;
4152
4153 #ifdef HAVE_X_I18N
4154 if (FRAME_XIC (frame))
4155 XSetICFocus (FRAME_XIC (frame));
4156 #endif
4157 }
4158 else if (type == FocusOut)
4159 {
4160 frame->output_data.x->focus_state &= ~state;
4161
4162 if (dpyinfo->x_focus_event_frame == frame)
4163 {
4164 dpyinfo->x_focus_event_frame = 0;
4165 x_new_focus_frame (dpyinfo, 0);
4166
4167 bufp->kind = FOCUS_OUT_EVENT;
4168 XSETFRAME (bufp->frame_or_window, frame);
4169 }
4170
4171 #ifdef HAVE_X_I18N
4172 if (FRAME_XIC (frame))
4173 XUnsetICFocus (FRAME_XIC (frame));
4174 #endif
4175 if (frame->pointer_invisible)
4176 XTtoggle_invisible_pointer (frame, false);
4177 }
4178 }
4179
4180 /* Return the Emacs frame-object corresponding to an X window.
4181 It could be the frame's main window or an icon window. */
4182
4183 static struct frame *
4184 x_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
4185 {
4186 Lisp_Object tail, frame;
4187 struct frame *f;
4188
4189 if (wdesc == None)
4190 return NULL;
4191
4192 FOR_EACH_FRAME (tail, frame)
4193 {
4194 f = XFRAME (frame);
4195 if (!FRAME_X_P (f) || FRAME_DISPLAY_INFO (f) != dpyinfo)
4196 continue;
4197 if (f->output_data.x->hourglass_window == wdesc)
4198 return f;
4199 #ifdef USE_X_TOOLKIT
4200 if ((f->output_data.x->edit_widget
4201 && XtWindow (f->output_data.x->edit_widget) == wdesc)
4202 /* A tooltip frame? */
4203 || (!f->output_data.x->edit_widget
4204 && FRAME_X_WINDOW (f) == wdesc)
4205 || f->output_data.x->icon_desc == wdesc)
4206 return f;
4207 #else /* not USE_X_TOOLKIT */
4208 #ifdef USE_GTK
4209 if (f->output_data.x->edit_widget)
4210 {
4211 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
4212 struct x_output *x = f->output_data.x;
4213 if (gwdesc != 0 && gwdesc == x->edit_widget)
4214 return f;
4215 }
4216 #endif /* USE_GTK */
4217 if (FRAME_X_WINDOW (f) == wdesc
4218 || f->output_data.x->icon_desc == wdesc)
4219 return f;
4220 #endif /* not USE_X_TOOLKIT */
4221 }
4222 return 0;
4223 }
4224
4225 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
4226
4227 /* Like x_window_to_frame but also compares the window with the widget's
4228 windows. */
4229
4230 static struct frame *
4231 x_any_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
4232 {
4233 Lisp_Object tail, frame;
4234 struct frame *f, *found = NULL;
4235 struct x_output *x;
4236
4237 if (wdesc == None)
4238 return NULL;
4239
4240 FOR_EACH_FRAME (tail, frame)
4241 {
4242 if (found)
4243 break;
4244 f = XFRAME (frame);
4245 if (FRAME_X_P (f) && FRAME_DISPLAY_INFO (f) == dpyinfo)
4246 {
4247 /* This frame matches if the window is any of its widgets. */
4248 x = f->output_data.x;
4249 if (x->hourglass_window == wdesc)
4250 found = f;
4251 else if (x->widget)
4252 {
4253 #ifdef USE_GTK
4254 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
4255 if (gwdesc != 0
4256 && gtk_widget_get_toplevel (gwdesc) == x->widget)
4257 found = f;
4258 #else
4259 if (wdesc == XtWindow (x->widget)
4260 || wdesc == XtWindow (x->column_widget)
4261 || wdesc == XtWindow (x->edit_widget))
4262 found = f;
4263 /* Match if the window is this frame's menubar. */
4264 else if (lw_window_is_in_menubar (wdesc, x->menubar_widget))
4265 found = f;
4266 #endif
4267 }
4268 else if (FRAME_X_WINDOW (f) == wdesc)
4269 /* A tooltip frame. */
4270 found = f;
4271 }
4272 }
4273
4274 return found;
4275 }
4276
4277 /* Likewise, but consider only the menu bar widget. */
4278
4279 static struct frame *
4280 x_menubar_window_to_frame (struct x_display_info *dpyinfo,
4281 const XEvent *event)
4282 {
4283 Window wdesc = event->xany.window;
4284 Lisp_Object tail, frame;
4285 struct frame *f;
4286 struct x_output *x;
4287
4288 if (wdesc == None)
4289 return NULL;
4290
4291 FOR_EACH_FRAME (tail, frame)
4292 {
4293 f = XFRAME (frame);
4294 if (!FRAME_X_P (f) || FRAME_DISPLAY_INFO (f) != dpyinfo)
4295 continue;
4296 x = f->output_data.x;
4297 #ifdef USE_GTK
4298 if (x->menubar_widget && xg_event_is_for_menubar (f, event))
4299 return f;
4300 #else
4301 /* Match if the window is this frame's menubar. */
4302 if (x->menubar_widget
4303 && lw_window_is_in_menubar (wdesc, x->menubar_widget))
4304 return f;
4305 #endif
4306 }
4307 return 0;
4308 }
4309
4310 /* Return the frame whose principal (outermost) window is WDESC.
4311 If WDESC is some other (smaller) window, we return 0. */
4312
4313 struct frame *
4314 x_top_window_to_frame (struct x_display_info *dpyinfo, int wdesc)
4315 {
4316 Lisp_Object tail, frame;
4317 struct frame *f;
4318 struct x_output *x;
4319
4320 if (wdesc == None)
4321 return NULL;
4322
4323 FOR_EACH_FRAME (tail, frame)
4324 {
4325 f = XFRAME (frame);
4326 if (!FRAME_X_P (f) || FRAME_DISPLAY_INFO (f) != dpyinfo)
4327 continue;
4328 x = f->output_data.x;
4329
4330 if (x->widget)
4331 {
4332 /* This frame matches if the window is its topmost widget. */
4333 #ifdef USE_GTK
4334 GtkWidget *gwdesc = xg_win_to_widget (dpyinfo->display, wdesc);
4335 if (gwdesc == x->widget)
4336 return f;
4337 #else
4338 if (wdesc == XtWindow (x->widget))
4339 return f;
4340 #endif
4341 }
4342 else if (FRAME_X_WINDOW (f) == wdesc)
4343 /* Tooltip frame. */
4344 return f;
4345 }
4346 return 0;
4347 }
4348
4349 #else /* !USE_X_TOOLKIT && !USE_GTK */
4350
4351 #define x_any_window_to_frame(d, i) x_window_to_frame (d, i)
4352 #define x_top_window_to_frame(d, i) x_window_to_frame (d, i)
4353
4354 #endif /* USE_X_TOOLKIT || USE_GTK */
4355
4356 /* The focus may have changed. Figure out if it is a real focus change,
4357 by checking both FocusIn/Out and Enter/LeaveNotify events.
4358
4359 Returns FOCUS_IN_EVENT event in *BUFP. */
4360
4361 static void
4362 x_detect_focus_change (struct x_display_info *dpyinfo, struct frame *frame,
4363 const XEvent *event, struct input_event *bufp)
4364 {
4365 if (!frame)
4366 return;
4367
4368 switch (event->type)
4369 {
4370 case EnterNotify:
4371 case LeaveNotify:
4372 {
4373 struct frame *focus_frame = dpyinfo->x_focus_event_frame;
4374 int focus_state
4375 = focus_frame ? focus_frame->output_data.x->focus_state : 0;
4376
4377 if (event->xcrossing.detail != NotifyInferior
4378 && event->xcrossing.focus
4379 && ! (focus_state & FOCUS_EXPLICIT))
4380 x_focus_changed ((event->type == EnterNotify ? FocusIn : FocusOut),
4381 FOCUS_IMPLICIT,
4382 dpyinfo, frame, bufp);
4383 }
4384 break;
4385
4386 case FocusIn:
4387 case FocusOut:
4388 x_focus_changed (event->type,
4389 (event->xfocus.detail == NotifyPointer ?
4390 FOCUS_IMPLICIT : FOCUS_EXPLICIT),
4391 dpyinfo, frame, bufp);
4392 break;
4393
4394 case ClientMessage:
4395 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
4396 {
4397 enum xembed_message msg = event->xclient.data.l[1];
4398 x_focus_changed ((msg == XEMBED_FOCUS_IN ? FocusIn : FocusOut),
4399 FOCUS_EXPLICIT, dpyinfo, frame, bufp);
4400 }
4401 break;
4402 }
4403 }
4404
4405
4406 #if !defined USE_X_TOOLKIT && !defined USE_GTK
4407 /* Handle an event saying the mouse has moved out of an Emacs frame. */
4408
4409 void
4410 x_mouse_leave (struct x_display_info *dpyinfo)
4411 {
4412 x_new_focus_frame (dpyinfo, dpyinfo->x_focus_event_frame);
4413 }
4414 #endif
4415
4416 /* The focus has changed, or we have redirected a frame's focus to
4417 another frame (this happens when a frame uses a surrogate
4418 mini-buffer frame). Shift the highlight as appropriate.
4419
4420 The FRAME argument doesn't necessarily have anything to do with which
4421 frame is being highlighted or un-highlighted; we only use it to find
4422 the appropriate X display info. */
4423
4424 static void
4425 XTframe_rehighlight (struct frame *frame)
4426 {
4427 x_frame_rehighlight (FRAME_DISPLAY_INFO (frame));
4428 }
4429
4430 static void
4431 x_frame_rehighlight (struct x_display_info *dpyinfo)
4432 {
4433 struct frame *old_highlight = dpyinfo->x_highlight_frame;
4434
4435 if (dpyinfo->x_focus_frame)
4436 {
4437 dpyinfo->x_highlight_frame
4438 = ((FRAMEP (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame)))
4439 ? XFRAME (FRAME_FOCUS_FRAME (dpyinfo->x_focus_frame))
4440 : dpyinfo->x_focus_frame);
4441 if (! FRAME_LIVE_P (dpyinfo->x_highlight_frame))
4442 {
4443 fset_focus_frame (dpyinfo->x_focus_frame, Qnil);
4444 dpyinfo->x_highlight_frame = dpyinfo->x_focus_frame;
4445 }
4446 }
4447 else
4448 dpyinfo->x_highlight_frame = 0;
4449
4450 if (dpyinfo->x_highlight_frame != old_highlight)
4451 {
4452 if (old_highlight)
4453 frame_unhighlight (old_highlight);
4454 if (dpyinfo->x_highlight_frame)
4455 frame_highlight (dpyinfo->x_highlight_frame);
4456 }
4457 }
4458
4459
4460 \f
4461 /* Keyboard processing - modifier keys, vendor-specific keysyms, etc. */
4462
4463 /* Initialize mode_switch_bit and modifier_meaning. */
4464 static void
4465 x_find_modifier_meanings (struct x_display_info *dpyinfo)
4466 {
4467 int min_code, max_code;
4468 KeySym *syms;
4469 int syms_per_code;
4470 XModifierKeymap *mods;
4471
4472 dpyinfo->meta_mod_mask = 0;
4473 dpyinfo->shift_lock_mask = 0;
4474 dpyinfo->alt_mod_mask = 0;
4475 dpyinfo->super_mod_mask = 0;
4476 dpyinfo->hyper_mod_mask = 0;
4477
4478 XDisplayKeycodes (dpyinfo->display, &min_code, &max_code);
4479
4480 syms = XGetKeyboardMapping (dpyinfo->display,
4481 min_code, max_code - min_code + 1,
4482 &syms_per_code);
4483 mods = XGetModifierMapping (dpyinfo->display);
4484
4485 /* Scan the modifier table to see which modifier bits the Meta and
4486 Alt keysyms are on. */
4487 {
4488 int row, col; /* The row and column in the modifier table. */
4489 bool found_alt_or_meta;
4490
4491 for (row = 3; row < 8; row++)
4492 {
4493 found_alt_or_meta = false;
4494 for (col = 0; col < mods->max_keypermod; col++)
4495 {
4496 KeyCode code = mods->modifiermap[(row * mods->max_keypermod) + col];
4497
4498 /* Zeroes are used for filler. Skip them. */
4499 if (code == 0)
4500 continue;
4501
4502 /* Are any of this keycode's keysyms a meta key? */
4503 {
4504 int code_col;
4505
4506 for (code_col = 0; code_col < syms_per_code; code_col++)
4507 {
4508 int sym = syms[((code - min_code) * syms_per_code) + code_col];
4509
4510 switch (sym)
4511 {
4512 case XK_Meta_L:
4513 case XK_Meta_R:
4514 found_alt_or_meta = true;
4515 dpyinfo->meta_mod_mask |= (1 << row);
4516 break;
4517
4518 case XK_Alt_L:
4519 case XK_Alt_R:
4520 found_alt_or_meta = true;
4521 dpyinfo->alt_mod_mask |= (1 << row);
4522 break;
4523
4524 case XK_Hyper_L:
4525 case XK_Hyper_R:
4526 if (!found_alt_or_meta)
4527 dpyinfo->hyper_mod_mask |= (1 << row);
4528 code_col = syms_per_code;
4529 col = mods->max_keypermod;
4530 break;
4531
4532 case XK_Super_L:
4533 case XK_Super_R:
4534 if (!found_alt_or_meta)
4535 dpyinfo->super_mod_mask |= (1 << row);
4536 code_col = syms_per_code;
4537 col = mods->max_keypermod;
4538 break;
4539
4540 case XK_Shift_Lock:
4541 /* Ignore this if it's not on the lock modifier. */
4542 if (!found_alt_or_meta && ((1 << row) == LockMask))
4543 dpyinfo->shift_lock_mask = LockMask;
4544 code_col = syms_per_code;
4545 col = mods->max_keypermod;
4546 break;
4547 }
4548 }
4549 }
4550 }
4551 }
4552 }
4553
4554 /* If we couldn't find any meta keys, accept any alt keys as meta keys. */
4555 if (! dpyinfo->meta_mod_mask)
4556 {
4557 dpyinfo->meta_mod_mask = dpyinfo->alt_mod_mask;
4558 dpyinfo->alt_mod_mask = 0;
4559 }
4560
4561 /* If some keys are both alt and meta,
4562 make them just meta, not alt. */
4563 if (dpyinfo->alt_mod_mask & dpyinfo->meta_mod_mask)
4564 {
4565 dpyinfo->alt_mod_mask &= ~dpyinfo->meta_mod_mask;
4566 }
4567
4568 XFree (syms);
4569 XFreeModifiermap (mods);
4570 }
4571
4572 /* Convert between the modifier bits X uses and the modifier bits
4573 Emacs uses. */
4574
4575 int
4576 x_x_to_emacs_modifiers (struct x_display_info *dpyinfo, int state)
4577 {
4578 int mod_meta = meta_modifier;
4579 int mod_alt = alt_modifier;
4580 int mod_hyper = hyper_modifier;
4581 int mod_super = super_modifier;
4582 Lisp_Object tem;
4583
4584 tem = Fget (Vx_alt_keysym, Qmodifier_value);
4585 if (INTEGERP (tem)) mod_alt = XINT (tem) & INT_MAX;
4586 tem = Fget (Vx_meta_keysym, Qmodifier_value);
4587 if (INTEGERP (tem)) mod_meta = XINT (tem) & INT_MAX;
4588 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
4589 if (INTEGERP (tem)) mod_hyper = XINT (tem) & INT_MAX;
4590 tem = Fget (Vx_super_keysym, Qmodifier_value);
4591 if (INTEGERP (tem)) mod_super = XINT (tem) & INT_MAX;
4592
4593 return ( ((state & (ShiftMask | dpyinfo->shift_lock_mask)) ? shift_modifier : 0)
4594 | ((state & ControlMask) ? ctrl_modifier : 0)
4595 | ((state & dpyinfo->meta_mod_mask) ? mod_meta : 0)
4596 | ((state & dpyinfo->alt_mod_mask) ? mod_alt : 0)
4597 | ((state & dpyinfo->super_mod_mask) ? mod_super : 0)
4598 | ((state & dpyinfo->hyper_mod_mask) ? mod_hyper : 0));
4599 }
4600
4601 static int
4602 x_emacs_to_x_modifiers (struct x_display_info *dpyinfo, EMACS_INT state)
4603 {
4604 EMACS_INT mod_meta = meta_modifier;
4605 EMACS_INT mod_alt = alt_modifier;
4606 EMACS_INT mod_hyper = hyper_modifier;
4607 EMACS_INT mod_super = super_modifier;
4608
4609 Lisp_Object tem;
4610
4611 tem = Fget (Vx_alt_keysym, Qmodifier_value);
4612 if (INTEGERP (tem)) mod_alt = XINT (tem);
4613 tem = Fget (Vx_meta_keysym, Qmodifier_value);
4614 if (INTEGERP (tem)) mod_meta = XINT (tem);
4615 tem = Fget (Vx_hyper_keysym, Qmodifier_value);
4616 if (INTEGERP (tem)) mod_hyper = XINT (tem);
4617 tem = Fget (Vx_super_keysym, Qmodifier_value);
4618 if (INTEGERP (tem)) mod_super = XINT (tem);
4619
4620
4621 return ( ((state & mod_alt) ? dpyinfo->alt_mod_mask : 0)
4622 | ((state & mod_super) ? dpyinfo->super_mod_mask : 0)
4623 | ((state & mod_hyper) ? dpyinfo->hyper_mod_mask : 0)
4624 | ((state & shift_modifier) ? ShiftMask : 0)
4625 | ((state & ctrl_modifier) ? ControlMask : 0)
4626 | ((state & mod_meta) ? dpyinfo->meta_mod_mask : 0));
4627 }
4628
4629 /* Convert a keysym to its name. */
4630
4631 char *
4632 x_get_keysym_name (int keysym)
4633 {
4634 char *value;
4635
4636 block_input ();
4637 value = XKeysymToString (keysym);
4638 unblock_input ();
4639
4640 return value;
4641 }
4642
4643 /* Mouse clicks and mouse movement. Rah.
4644
4645 Formerly, we used PointerMotionHintMask (in standard_event_mask)
4646 so that we would have to call XQueryPointer after each MotionNotify
4647 event to ask for another such event. However, this made mouse tracking
4648 slow, and there was a bug that made it eventually stop.
4649
4650 Simply asking for MotionNotify all the time seems to work better.
4651
4652 In order to avoid asking for motion events and then throwing most
4653 of them away or busy-polling the server for mouse positions, we ask
4654 the server for pointer motion hints. This means that we get only
4655 one event per group of mouse movements. "Groups" are delimited by
4656 other kinds of events (focus changes and button clicks, for
4657 example), or by XQueryPointer calls; when one of these happens, we
4658 get another MotionNotify event the next time the mouse moves. This
4659 is at least as efficient as getting motion events when mouse
4660 tracking is on, and I suspect only negligibly worse when tracking
4661 is off. */
4662
4663 /* Prepare a mouse-event in *RESULT for placement in the input queue.
4664
4665 If the event is a button press, then note that we have grabbed
4666 the mouse. */
4667
4668 static Lisp_Object
4669 construct_mouse_click (struct input_event *result,
4670 const XButtonEvent *event,
4671 struct frame *f)
4672 {
4673 /* Make the event type NO_EVENT; we'll change that when we decide
4674 otherwise. */
4675 result->kind = MOUSE_CLICK_EVENT;
4676 result->code = event->button - Button1;
4677 result->timestamp = event->time;
4678 result->modifiers = (x_x_to_emacs_modifiers (FRAME_DISPLAY_INFO (f),
4679 event->state)
4680 | (event->type == ButtonRelease
4681 ? up_modifier
4682 : down_modifier));
4683
4684 XSETINT (result->x, event->x);
4685 XSETINT (result->y, event->y);
4686 XSETFRAME (result->frame_or_window, f);
4687 result->arg = Qnil;
4688 return Qnil;
4689 }
4690
4691 /* Function to report a mouse movement to the mainstream Emacs code.
4692 The input handler calls this.
4693
4694 We have received a mouse movement event, which is given in *event.
4695 If the mouse is over a different glyph than it was last time, tell
4696 the mainstream emacs code by setting mouse_moved. If not, ask for
4697 another motion event, so we can check again the next time it moves. */
4698
4699 static bool
4700 note_mouse_movement (struct frame *frame, const XMotionEvent *event)
4701 {
4702 XRectangle *r;
4703 struct x_display_info *dpyinfo;
4704
4705 if (!FRAME_X_OUTPUT (frame))
4706 return false;
4707
4708 dpyinfo = FRAME_DISPLAY_INFO (frame);
4709 dpyinfo->last_mouse_movement_time = event->time;
4710 dpyinfo->last_mouse_motion_frame = frame;
4711 dpyinfo->last_mouse_motion_x = event->x;
4712 dpyinfo->last_mouse_motion_y = event->y;
4713
4714 if (event->window != FRAME_X_WINDOW (frame))
4715 {
4716 frame->mouse_moved = true;
4717 dpyinfo->last_mouse_scroll_bar = NULL;
4718 note_mouse_highlight (frame, -1, -1);
4719 dpyinfo->last_mouse_glyph_frame = NULL;
4720 return true;
4721 }
4722
4723
4724 /* Has the mouse moved off the glyph it was on at the last sighting? */
4725 r = &dpyinfo->last_mouse_glyph;
4726 if (frame != dpyinfo->last_mouse_glyph_frame
4727 || event->x < r->x || event->x >= r->x + r->width
4728 || event->y < r->y || event->y >= r->y + r->height)
4729 {
4730 frame->mouse_moved = true;
4731 dpyinfo->last_mouse_scroll_bar = NULL;
4732 note_mouse_highlight (frame, event->x, event->y);
4733 /* Remember which glyph we're now on. */
4734 remember_mouse_glyph (frame, event->x, event->y, r);
4735 dpyinfo->last_mouse_glyph_frame = frame;
4736 return true;
4737 }
4738
4739 return false;
4740 }
4741
4742 /* Return the current position of the mouse.
4743 *FP should be a frame which indicates which display to ask about.
4744
4745 If the mouse movement started in a scroll bar, set *FP, *BAR_WINDOW,
4746 and *PART to the frame, window, and scroll bar part that the mouse
4747 is over. Set *X and *Y to the portion and whole of the mouse's
4748 position on the scroll bar.
4749
4750 If the mouse movement started elsewhere, set *FP to the frame the
4751 mouse is on, *BAR_WINDOW to nil, and *X and *Y to the character cell
4752 the mouse is over.
4753
4754 Set *TIMESTAMP to the server time-stamp for the time at which the mouse
4755 was at this position.
4756
4757 Don't store anything if we don't have a valid set of values to report.
4758
4759 This clears the mouse_moved flag, so we can wait for the next mouse
4760 movement. */
4761
4762 static void
4763 XTmouse_position (struct frame **fp, int insist, Lisp_Object *bar_window,
4764 enum scroll_bar_part *part, Lisp_Object *x, Lisp_Object *y,
4765 Time *timestamp)
4766 {
4767 struct frame *f1;
4768 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (*fp);
4769
4770 block_input ();
4771
4772 if (dpyinfo->last_mouse_scroll_bar && insist == 0)
4773 {
4774 struct scroll_bar *bar = dpyinfo->last_mouse_scroll_bar;
4775
4776 if (bar->horizontal)
4777 x_horizontal_scroll_bar_report_motion (fp, bar_window, part, x, y, timestamp);
4778 else
4779 x_scroll_bar_report_motion (fp, bar_window, part, x, y, timestamp);
4780 }
4781 else
4782 {
4783 Window root;
4784 int root_x, root_y;
4785
4786 Window dummy_window;
4787 int dummy;
4788
4789 Lisp_Object frame, tail;
4790
4791 /* Clear the mouse-moved flag for every frame on this display. */
4792 FOR_EACH_FRAME (tail, frame)
4793 if (FRAME_X_P (XFRAME (frame))
4794 && FRAME_X_DISPLAY (XFRAME (frame)) == FRAME_X_DISPLAY (*fp))
4795 XFRAME (frame)->mouse_moved = false;
4796
4797 dpyinfo->last_mouse_scroll_bar = NULL;
4798
4799 /* Figure out which root window we're on. */
4800 XQueryPointer (FRAME_X_DISPLAY (*fp),
4801 DefaultRootWindow (FRAME_X_DISPLAY (*fp)),
4802
4803 /* The root window which contains the pointer. */
4804 &root,
4805
4806 /* Trash which we can't trust if the pointer is on
4807 a different screen. */
4808 &dummy_window,
4809
4810 /* The position on that root window. */
4811 &root_x, &root_y,
4812
4813 /* More trash we can't trust. */
4814 &dummy, &dummy,
4815
4816 /* Modifier keys and pointer buttons, about which
4817 we don't care. */
4818 (unsigned int *) &dummy);
4819
4820 /* Now we have a position on the root; find the innermost window
4821 containing the pointer. */
4822 {
4823 Window win, child;
4824 int win_x, win_y;
4825 int parent_x = 0, parent_y = 0;
4826
4827 win = root;
4828
4829 /* XTranslateCoordinates can get errors if the window
4830 structure is changing at the same time this function
4831 is running. So at least we must not crash from them. */
4832
4833 x_catch_errors (FRAME_X_DISPLAY (*fp));
4834
4835 if (x_mouse_grabbed (dpyinfo))
4836 {
4837 /* If mouse was grabbed on a frame, give coords for that frame
4838 even if the mouse is now outside it. */
4839 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
4840
4841 /* From-window. */
4842 root,
4843
4844 /* To-window. */
4845 FRAME_X_WINDOW (dpyinfo->last_mouse_frame),
4846
4847 /* From-position, to-position. */
4848 root_x, root_y, &win_x, &win_y,
4849
4850 /* Child of win. */
4851 &child);
4852 f1 = dpyinfo->last_mouse_frame;
4853 }
4854 else
4855 {
4856 while (true)
4857 {
4858 XTranslateCoordinates (FRAME_X_DISPLAY (*fp),
4859
4860 /* From-window, to-window. */
4861 root, win,
4862
4863 /* From-position, to-position. */
4864 root_x, root_y, &win_x, &win_y,
4865
4866 /* Child of win. */
4867 &child);
4868
4869 if (child == None || child == win)
4870 break;
4871 #ifdef USE_GTK
4872 /* We don't wan't to know the innermost window. We
4873 want the edit window. For non-Gtk+ the innermost
4874 window is the edit window. For Gtk+ it might not
4875 be. It might be the tool bar for example. */
4876 if (x_window_to_frame (dpyinfo, win))
4877 break;
4878 #endif
4879 win = child;
4880 parent_x = win_x;
4881 parent_y = win_y;
4882 }
4883
4884 /* Now we know that:
4885 win is the innermost window containing the pointer
4886 (XTC says it has no child containing the pointer),
4887 win_x and win_y are the pointer's position in it
4888 (XTC did this the last time through), and
4889 parent_x and parent_y are the pointer's position in win's parent.
4890 (They are what win_x and win_y were when win was child.
4891 If win is the root window, it has no parent, and
4892 parent_{x,y} are invalid, but that's okay, because we'll
4893 never use them in that case.) */
4894
4895 #ifdef USE_GTK
4896 /* We don't wan't to know the innermost window. We
4897 want the edit window. */
4898 f1 = x_window_to_frame (dpyinfo, win);
4899 #else
4900 /* Is win one of our frames? */
4901 f1 = x_any_window_to_frame (dpyinfo, win);
4902 #endif
4903
4904 #ifdef USE_X_TOOLKIT
4905 /* If we end up with the menu bar window, say it's not
4906 on the frame. */
4907 if (f1 != NULL
4908 && f1->output_data.x->menubar_widget
4909 && win == XtWindow (f1->output_data.x->menubar_widget))
4910 f1 = NULL;
4911 #endif /* USE_X_TOOLKIT */
4912 }
4913
4914 if (x_had_errors_p (FRAME_X_DISPLAY (*fp)))
4915 f1 = 0;
4916
4917 x_uncatch_errors ();
4918
4919 /* If not, is it one of our scroll bars? */
4920 if (! f1)
4921 {
4922 struct scroll_bar *bar;
4923
4924 bar = x_window_to_scroll_bar (FRAME_X_DISPLAY (*fp), win, 2);
4925
4926 if (bar)
4927 {
4928 f1 = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
4929 win_x = parent_x;
4930 win_y = parent_y;
4931 }
4932 }
4933
4934 if (f1 == 0 && insist > 0)
4935 f1 = SELECTED_FRAME ();
4936
4937 if (f1)
4938 {
4939 /* Ok, we found a frame. Store all the values.
4940 last_mouse_glyph is a rectangle used to reduce the
4941 generation of mouse events. To not miss any motion
4942 events, we must divide the frame into rectangles of the
4943 size of the smallest character that could be displayed
4944 on it, i.e. into the same rectangles that matrices on
4945 the frame are divided into. */
4946
4947 /* FIXME: what if F1 is not an X frame? */
4948 dpyinfo = FRAME_DISPLAY_INFO (f1);
4949 remember_mouse_glyph (f1, win_x, win_y, &dpyinfo->last_mouse_glyph);
4950 dpyinfo->last_mouse_glyph_frame = f1;
4951
4952 *bar_window = Qnil;
4953 *part = 0;
4954 *fp = f1;
4955 XSETINT (*x, win_x);
4956 XSETINT (*y, win_y);
4957 *timestamp = dpyinfo->last_mouse_movement_time;
4958 }
4959 }
4960 }
4961
4962 unblock_input ();
4963 }
4964
4965
4966 \f
4967 /***********************************************************************
4968 Scroll bars
4969 ***********************************************************************/
4970
4971 /* Scroll bar support. */
4972
4973 /* Given an X window ID and a DISPLAY, find the struct scroll_bar which
4974 manages it.
4975 This can be called in GC, so we have to make sure to strip off mark
4976 bits. */
4977
4978 static struct scroll_bar *
4979 x_window_to_scroll_bar (Display *display, Window window_id, int type)
4980 {
4981 Lisp_Object tail, frame;
4982
4983 #if defined (USE_GTK) && defined (USE_TOOLKIT_SCROLL_BARS)
4984 window_id = (Window) xg_get_scroll_id_for_window (display, window_id);
4985 #endif /* USE_GTK && USE_TOOLKIT_SCROLL_BARS */
4986
4987 FOR_EACH_FRAME (tail, frame)
4988 {
4989 Lisp_Object bar, condemned;
4990
4991 if (! FRAME_X_P (XFRAME (frame)))
4992 continue;
4993
4994 /* Scan this frame's scroll bar list for a scroll bar with the
4995 right window ID. */
4996 condemned = FRAME_CONDEMNED_SCROLL_BARS (XFRAME (frame));
4997 for (bar = FRAME_SCROLL_BARS (XFRAME (frame));
4998 /* This trick allows us to search both the ordinary and
4999 condemned scroll bar lists with one loop. */
5000 ! NILP (bar) || (bar = condemned,
5001 condemned = Qnil,
5002 ! NILP (bar));
5003 bar = XSCROLL_BAR (bar)->next)
5004 if (XSCROLL_BAR (bar)->x_window == window_id
5005 && FRAME_X_DISPLAY (XFRAME (frame)) == display
5006 && (type = 2
5007 || (type == 1 && XSCROLL_BAR (bar)->horizontal)
5008 || (type == 0 && !XSCROLL_BAR (bar)->horizontal)))
5009 return XSCROLL_BAR (bar);
5010 }
5011
5012 return NULL;
5013 }
5014
5015
5016 #if defined USE_LUCID
5017
5018 /* Return the Lucid menu bar WINDOW is part of. Return null
5019 if WINDOW is not part of a menu bar. */
5020
5021 static Widget
5022 x_window_to_menu_bar (Window window)
5023 {
5024 Lisp_Object tail, frame;
5025
5026 FOR_EACH_FRAME (tail, frame)
5027 if (FRAME_X_P (XFRAME (frame)))
5028 {
5029 Widget menu_bar = XFRAME (frame)->output_data.x->menubar_widget;
5030
5031 if (menu_bar && xlwmenu_window_p (menu_bar, window))
5032 return menu_bar;
5033 }
5034 return NULL;
5035 }
5036
5037 #endif /* USE_LUCID */
5038
5039 \f
5040 /************************************************************************
5041 Toolkit scroll bars
5042 ************************************************************************/
5043
5044 #ifdef USE_TOOLKIT_SCROLL_BARS
5045
5046 static void x_send_scroll_bar_event (Lisp_Object, enum scroll_bar_part,
5047 int, int, bool);
5048
5049 /* Lisp window being scrolled. Set when starting to interact with
5050 a toolkit scroll bar, reset to nil when ending the interaction. */
5051
5052 static Lisp_Object window_being_scrolled;
5053
5054 /* Whether this is an Xaw with arrow-scrollbars. This should imply
5055 that movements of 1/20 of the screen size are mapped to up/down. */
5056
5057 #ifndef USE_GTK
5058 /* Id of action hook installed for scroll bars. */
5059
5060 static XtActionHookId action_hook_id;
5061 static XtActionHookId horizontal_action_hook_id;
5062
5063 static Boolean xaw3d_arrow_scroll;
5064
5065 /* Whether the drag scrolling maintains the mouse at the top of the
5066 thumb. If not, resizing the thumb needs to be done more carefully
5067 to avoid jerkiness. */
5068
5069 static Boolean xaw3d_pick_top;
5070
5071 /* Action hook installed via XtAppAddActionHook when toolkit scroll
5072 bars are used.. The hook is responsible for detecting when
5073 the user ends an interaction with the scroll bar, and generates
5074 a `end-scroll' SCROLL_BAR_CLICK_EVENT' event if so. */
5075
5076 static void
5077 xt_action_hook (Widget widget, XtPointer client_data, String action_name,
5078 XEvent *event, String *params, Cardinal *num_params)
5079 {
5080 bool scroll_bar_p;
5081 const char *end_action;
5082
5083 #ifdef USE_MOTIF
5084 scroll_bar_p = XmIsScrollBar (widget);
5085 end_action = "Release";
5086 #else /* !USE_MOTIF i.e. use Xaw */
5087 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
5088 end_action = "EndScroll";
5089 #endif /* USE_MOTIF */
5090
5091 if (scroll_bar_p
5092 && strcmp (action_name, end_action) == 0
5093 && WINDOWP (window_being_scrolled))
5094 {
5095 struct window *w;
5096 struct scroll_bar *bar;
5097
5098 x_send_scroll_bar_event (window_being_scrolled,
5099 scroll_bar_end_scroll, 0, 0, false);
5100 w = XWINDOW (window_being_scrolled);
5101 bar = XSCROLL_BAR (w->vertical_scroll_bar);
5102
5103 if (bar->dragging != -1)
5104 {
5105 bar->dragging = -1;
5106 /* The thumb size is incorrect while dragging: fix it. */
5107 set_vertical_scroll_bar (w);
5108 }
5109 window_being_scrolled = Qnil;
5110 #if defined (USE_LUCID)
5111 bar->last_seen_part = scroll_bar_nowhere;
5112 #endif
5113 /* Xt timeouts no longer needed. */
5114 toolkit_scroll_bar_interaction = false;
5115 }
5116 }
5117
5118
5119 static void
5120 xt_horizontal_action_hook (Widget widget, XtPointer client_data, String action_name,
5121 XEvent *event, String *params, Cardinal *num_params)
5122 {
5123 bool scroll_bar_p;
5124 const char *end_action;
5125
5126 #ifdef USE_MOTIF
5127 scroll_bar_p = XmIsScrollBar (widget);
5128 end_action = "Release";
5129 #else /* !USE_MOTIF i.e. use Xaw */
5130 scroll_bar_p = XtIsSubclass (widget, scrollbarWidgetClass);
5131 end_action = "EndScroll";
5132 #endif /* USE_MOTIF */
5133
5134 if (scroll_bar_p
5135 && strcmp (action_name, end_action) == 0
5136 && WINDOWP (window_being_scrolled))
5137 {
5138 struct window *w;
5139 struct scroll_bar *bar;
5140
5141 x_send_scroll_bar_event (window_being_scrolled,
5142 scroll_bar_end_scroll, 0, 0, true);
5143 w = XWINDOW (window_being_scrolled);
5144 bar = XSCROLL_BAR (w->horizontal_scroll_bar);
5145
5146 if (bar->dragging != -1)
5147 {
5148 bar->dragging = -1;
5149 /* The thumb size is incorrect while dragging: fix it. */
5150 set_horizontal_scroll_bar (w);
5151 }
5152 window_being_scrolled = Qnil;
5153 #if defined (USE_LUCID)
5154 bar->last_seen_part = scroll_bar_nowhere;
5155 #endif
5156 /* Xt timeouts no longer needed. */
5157 toolkit_scroll_bar_interaction = false;
5158 }
5159 }
5160 #endif /* not USE_GTK */
5161
5162 /* Send a client message with message type Xatom_Scrollbar for a
5163 scroll action to the frame of WINDOW. PART is a value identifying
5164 the part of the scroll bar that was clicked on. PORTION is the
5165 amount to scroll of a whole of WHOLE. */
5166
5167 static void
5168 x_send_scroll_bar_event (Lisp_Object window, enum scroll_bar_part part,
5169 int portion, int whole, bool horizontal)
5170 {
5171 XEvent event;
5172 XClientMessageEvent *ev = &event.xclient;
5173 struct window *w = XWINDOW (window);
5174 struct frame *f = XFRAME (w->frame);
5175 intptr_t iw = (intptr_t) w;
5176 enum { BITS_PER_INTPTR = CHAR_BIT * sizeof iw };
5177 verify (BITS_PER_INTPTR <= 64);
5178 int sign_shift = BITS_PER_INTPTR - 32;
5179
5180 block_input ();
5181
5182 /* Construct a ClientMessage event to send to the frame. */
5183 ev->type = ClientMessage;
5184 ev->message_type = (horizontal
5185 ? FRAME_DISPLAY_INFO (f)->Xatom_Horizontal_Scrollbar
5186 : FRAME_DISPLAY_INFO (f)->Xatom_Scrollbar);
5187 ev->display = FRAME_X_DISPLAY (f);
5188 ev->window = FRAME_X_WINDOW (f);
5189 ev->format = 32;
5190
5191 /* A 32-bit X client on a 64-bit X server can pass a window pointer
5192 as-is. A 64-bit client on a 32-bit X server is in trouble
5193 because a pointer does not fit and would be truncated while
5194 passing through the server. So use two slots and hope that X12
5195 will resolve such issues someday. */
5196 ev->data.l[0] = iw >> 31 >> 1;
5197 ev->data.l[1] = sign_shift <= 0 ? iw : iw << sign_shift >> sign_shift;
5198 ev->data.l[2] = part;
5199 ev->data.l[3] = portion;
5200 ev->data.l[4] = whole;
5201
5202 /* Make Xt timeouts work while the scroll bar is active. */
5203 #ifdef USE_X_TOOLKIT
5204 toolkit_scroll_bar_interaction = true;
5205 x_activate_timeout_atimer ();
5206 #endif
5207
5208 /* Setting the event mask to zero means that the message will
5209 be sent to the client that created the window, and if that
5210 window no longer exists, no event will be sent. */
5211 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), False, 0, &event);
5212 unblock_input ();
5213 }
5214
5215
5216 /* Transform a scroll bar ClientMessage EVENT to an Emacs input event
5217 in *IEVENT. */
5218
5219 static void
5220 x_scroll_bar_to_input_event (const XEvent *event,
5221 struct input_event *ievent)
5222 {
5223 const XClientMessageEvent *ev = &event->xclient;
5224 Lisp_Object window;
5225 struct window *w;
5226
5227 /* See the comment in the function above. */
5228 intptr_t iw0 = ev->data.l[0];
5229 intptr_t iw1 = ev->data.l[1];
5230 intptr_t iw = (iw0 << 31 << 1) + (iw1 & 0xffffffffu);
5231 w = (struct window *) iw;
5232
5233 XSETWINDOW (window, w);
5234
5235 ievent->kind = SCROLL_BAR_CLICK_EVENT;
5236 ievent->frame_or_window = window;
5237 ievent->arg = Qnil;
5238 #ifdef USE_GTK
5239 ievent->timestamp = CurrentTime;
5240 #else
5241 ievent->timestamp =
5242 XtLastTimestampProcessed (FRAME_X_DISPLAY (XFRAME (w->frame)));
5243 #endif
5244 ievent->code = 0;
5245 ievent->part = ev->data.l[2];
5246 ievent->x = make_number (ev->data.l[3]);
5247 ievent->y = make_number (ev->data.l[4]);
5248 ievent->modifiers = 0;
5249 }
5250
5251 /* Transform a horizontal scroll bar ClientMessage EVENT to an Emacs
5252 input event in *IEVENT. */
5253
5254 static void
5255 x_horizontal_scroll_bar_to_input_event (const XEvent *event,
5256 struct input_event *ievent)
5257 {
5258 const XClientMessageEvent *ev = &event->xclient;
5259 Lisp_Object window;
5260 struct window *w;
5261
5262 /* See the comment in the function above. */
5263 intptr_t iw0 = ev->data.l[0];
5264 intptr_t iw1 = ev->data.l[1];
5265 intptr_t iw = (iw0 << 31 << 1) + (iw1 & 0xffffffffu);
5266 w = (struct window *) iw;
5267
5268 XSETWINDOW (window, w);
5269
5270 ievent->kind = HORIZONTAL_SCROLL_BAR_CLICK_EVENT;
5271 ievent->frame_or_window = window;
5272 ievent->arg = Qnil;
5273 #ifdef USE_GTK
5274 ievent->timestamp = CurrentTime;
5275 #else
5276 ievent->timestamp =
5277 XtLastTimestampProcessed (FRAME_X_DISPLAY (XFRAME (w->frame)));
5278 #endif
5279 ievent->code = 0;
5280 ievent->part = ev->data.l[2];
5281 ievent->x = make_number (ev->data.l[3]);
5282 ievent->y = make_number (ev->data.l[4]);
5283 ievent->modifiers = 0;
5284 }
5285
5286
5287 #ifdef USE_MOTIF
5288
5289 /* Minimum and maximum values used for Motif scroll bars. */
5290
5291 #define XM_SB_MAX 10000000
5292
5293 /* Scroll bar callback for Motif scroll bars. WIDGET is the scroll
5294 bar widget. CLIENT_DATA is a pointer to the scroll_bar structure.
5295 CALL_DATA is a pointer to a XmScrollBarCallbackStruct. */
5296
5297 static void
5298 xm_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
5299 {
5300 struct scroll_bar *bar = client_data;
5301 XmScrollBarCallbackStruct *cs = call_data;
5302 enum scroll_bar_part part = scroll_bar_nowhere;
5303 bool horizontal = bar->horizontal;
5304 int whole = 0, portion = 0;
5305
5306 switch (cs->reason)
5307 {
5308 case XmCR_DECREMENT:
5309 bar->dragging = -1;
5310 part = horizontal ? scroll_bar_left_arrow : scroll_bar_up_arrow;
5311 break;
5312
5313 case XmCR_INCREMENT:
5314 bar->dragging = -1;
5315 part = horizontal ? scroll_bar_right_arrow : scroll_bar_down_arrow;
5316 break;
5317
5318 case XmCR_PAGE_DECREMENT:
5319 bar->dragging = -1;
5320 part = horizontal ? scroll_bar_before_handle : scroll_bar_above_handle;
5321 break;
5322
5323 case XmCR_PAGE_INCREMENT:
5324 bar->dragging = -1;
5325 part = horizontal ? scroll_bar_after_handle : scroll_bar_below_handle;
5326 break;
5327
5328 case XmCR_TO_TOP:
5329 bar->dragging = -1;
5330 part = horizontal ? scroll_bar_to_leftmost : scroll_bar_to_top;
5331 break;
5332
5333 case XmCR_TO_BOTTOM:
5334 bar->dragging = -1;
5335 part = horizontal ? scroll_bar_to_rightmost : scroll_bar_to_bottom;
5336 break;
5337
5338 case XmCR_DRAG:
5339 {
5340 int slider_size;
5341
5342 block_input ();
5343 XtVaGetValues (widget, XmNsliderSize, &slider_size, NULL);
5344 unblock_input ();
5345
5346 if (horizontal)
5347 {
5348 portion = bar->whole * ((float)cs->value / XM_SB_MAX);
5349 whole = bar->whole * ((float)(XM_SB_MAX - slider_size) / XM_SB_MAX);
5350 portion = min (portion, whole);
5351 part = scroll_bar_horizontal_handle;
5352 }
5353 else
5354 {
5355 whole = XM_SB_MAX - slider_size;
5356 portion = min (cs->value, whole);
5357 part = scroll_bar_handle;
5358 }
5359
5360 bar->dragging = cs->value;
5361 }
5362 break;
5363
5364 case XmCR_VALUE_CHANGED:
5365 break;
5366 };
5367
5368 if (part != scroll_bar_nowhere)
5369 {
5370 window_being_scrolled = bar->window;
5371 x_send_scroll_bar_event (bar->window, part, portion, whole,
5372 bar->horizontal);
5373 }
5374 }
5375
5376 #elif defined USE_GTK
5377
5378 /* Scroll bar callback for GTK scroll bars. WIDGET is the scroll
5379 bar widget. DATA is a pointer to the scroll_bar structure. */
5380
5381 static gboolean
5382 xg_scroll_callback (GtkRange *range,
5383 GtkScrollType scroll,
5384 gdouble value,
5385 gpointer user_data)
5386 {
5387 int whole = 0, portion = 0;
5388 struct scroll_bar *bar = user_data;
5389 enum scroll_bar_part part = scroll_bar_nowhere;
5390 GtkAdjustment *adj = GTK_ADJUSTMENT (gtk_range_get_adjustment (range));
5391 struct frame *f = g_object_get_data (G_OBJECT (range), XG_FRAME_DATA);
5392
5393 if (xg_ignore_gtk_scrollbar) return false;
5394
5395 switch (scroll)
5396 {
5397 case GTK_SCROLL_JUMP:
5398 /* Buttons 1 2 or 3 must be grabbed. */
5399 if (FRAME_DISPLAY_INFO (f)->grabbed != 0
5400 && FRAME_DISPLAY_INFO (f)->grabbed < (1 << 4))
5401 {
5402 if (bar->horizontal)
5403 {
5404 part = scroll_bar_horizontal_handle;
5405 whole = (int)(gtk_adjustment_get_upper (adj) -
5406 gtk_adjustment_get_page_size (adj));
5407 portion = min ((int)value, whole);
5408 bar->dragging = portion;
5409 }
5410 else
5411 {
5412 part = scroll_bar_handle;
5413 whole = gtk_adjustment_get_upper (adj) -
5414 gtk_adjustment_get_page_size (adj);
5415 portion = min ((int)value, whole);
5416 bar->dragging = portion;
5417 }
5418 }
5419 break;
5420 case GTK_SCROLL_STEP_BACKWARD:
5421 part = (bar->horizontal
5422 ? scroll_bar_left_arrow : scroll_bar_up_arrow);
5423 bar->dragging = -1;
5424 break;
5425 case GTK_SCROLL_STEP_FORWARD:
5426 part = (bar->horizontal
5427 ? scroll_bar_right_arrow : scroll_bar_down_arrow);
5428 bar->dragging = -1;
5429 break;
5430 case GTK_SCROLL_PAGE_BACKWARD:
5431 part = (bar->horizontal
5432 ? scroll_bar_before_handle : scroll_bar_above_handle);
5433 bar->dragging = -1;
5434 break;
5435 case GTK_SCROLL_PAGE_FORWARD:
5436 part = (bar->horizontal
5437 ? scroll_bar_after_handle : scroll_bar_below_handle);
5438 bar->dragging = -1;
5439 break;
5440 }
5441
5442 if (part != scroll_bar_nowhere)
5443 {
5444 window_being_scrolled = bar->window;
5445 x_send_scroll_bar_event (bar->window, part, portion, whole,
5446 bar->horizontal);
5447 }
5448
5449 return false;
5450 }
5451
5452 /* Callback for button release. Sets dragging to -1 when dragging is done. */
5453
5454 static gboolean
5455 xg_end_scroll_callback (GtkWidget *widget,
5456 GdkEventButton *event,
5457 gpointer user_data)
5458 {
5459 struct scroll_bar *bar = user_data;
5460 bar->dragging = -1;
5461 if (WINDOWP (window_being_scrolled))
5462 {
5463 x_send_scroll_bar_event (window_being_scrolled,
5464 scroll_bar_end_scroll, 0, 0, bar->horizontal);
5465 window_being_scrolled = Qnil;
5466 }
5467
5468 return false;
5469 }
5470
5471
5472 #else /* not USE_GTK and not USE_MOTIF */
5473
5474 /* Xaw scroll bar callback. Invoked when the thumb is dragged.
5475 WIDGET is the scroll bar widget. CLIENT_DATA is a pointer to the
5476 scroll bar struct. CALL_DATA is a pointer to a float saying where
5477 the thumb is. */
5478
5479 static void
5480 xaw_jump_callback (Widget widget, XtPointer client_data, XtPointer call_data)
5481 {
5482 struct scroll_bar *bar = client_data;
5483 float *top_addr = call_data;
5484 float top = *top_addr;
5485 float shown;
5486 int whole, portion, height, width;
5487 enum scroll_bar_part part;
5488 bool horizontal = bar->horizontal;
5489
5490
5491 if (horizontal)
5492 {
5493 /* Get the size of the thumb, a value between 0 and 1. */
5494 block_input ();
5495 XtVaGetValues (widget, XtNshown, &shown, XtNwidth, &width, NULL);
5496 unblock_input ();
5497
5498 if (shown < 1)
5499 {
5500 whole = bar->whole - (shown * bar->whole);
5501 portion = min (top * bar->whole, whole);
5502 }
5503 else
5504 {
5505 whole = bar->whole;
5506 portion = 0;
5507 }
5508
5509 part = scroll_bar_horizontal_handle;
5510 }
5511 else
5512 {
5513 /* Get the size of the thumb, a value between 0 and 1. */
5514 block_input ();
5515 XtVaGetValues (widget, XtNshown, &shown, XtNheight, &height, NULL);
5516 unblock_input ();
5517
5518 whole = 10000000;
5519 portion = shown < 1 ? top * whole : 0;
5520
5521 if (shown < 1 && (eabs (top + shown - 1) < 1.0f / height))
5522 /* Some derivatives of Xaw refuse to shrink the thumb when you reach
5523 the bottom, so we force the scrolling whenever we see that we're
5524 too close to the bottom (in x_set_toolkit_scroll_bar_thumb
5525 we try to ensure that we always stay two pixels away from the
5526 bottom). */
5527 part = scroll_bar_down_arrow;
5528 else
5529 part = scroll_bar_handle;
5530 }
5531
5532 window_being_scrolled = bar->window;
5533 bar->dragging = portion;
5534 bar->last_seen_part = part;
5535 x_send_scroll_bar_event (bar->window, part, portion, whole, bar->horizontal);
5536 }
5537
5538
5539 /* Xaw scroll bar callback. Invoked for incremental scrolling.,
5540 i.e. line or page up or down. WIDGET is the Xaw scroll bar
5541 widget. CLIENT_DATA is a pointer to the scroll_bar structure for
5542 the scroll bar. CALL_DATA is an integer specifying the action that
5543 has taken place. Its magnitude is in the range 0..height of the
5544 scroll bar. Negative values mean scroll towards buffer start.
5545 Values < height of scroll bar mean line-wise movement. */
5546
5547 static void
5548 xaw_scroll_callback (Widget widget, XtPointer client_data, XtPointer call_data)
5549 {
5550 struct scroll_bar *bar = client_data;
5551 /* The position really is stored cast to a pointer. */
5552 int position = (intptr_t) call_data;
5553 Dimension height, width;
5554 enum scroll_bar_part part;
5555
5556 if (bar->horizontal)
5557 {
5558 /* Get the width of the scroll bar. */
5559 block_input ();
5560 XtVaGetValues (widget, XtNwidth, &width, NULL);
5561 unblock_input ();
5562
5563 if (eabs (position) >= width)
5564 part = (position < 0) ? scroll_bar_before_handle : scroll_bar_after_handle;
5565
5566 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
5567 it maps line-movement to call_data = max(5, height/20). */
5568 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, width / 20))
5569 part = (position < 0) ? scroll_bar_left_arrow : scroll_bar_right_arrow;
5570 else
5571 part = scroll_bar_move_ratio;
5572
5573 window_being_scrolled = bar->window;
5574 bar->dragging = -1;
5575 bar->last_seen_part = part;
5576 x_send_scroll_bar_event (bar->window, part, position, width,
5577 bar->horizontal);
5578 }
5579 else
5580 {
5581
5582 /* Get the height of the scroll bar. */
5583 block_input ();
5584 XtVaGetValues (widget, XtNheight, &height, NULL);
5585 unblock_input ();
5586
5587 if (eabs (position) >= height)
5588 part = (position < 0) ? scroll_bar_above_handle : scroll_bar_below_handle;
5589
5590 /* If Xaw3d was compiled with ARROW_SCROLLBAR,
5591 it maps line-movement to call_data = max(5, height/20). */
5592 else if (xaw3d_arrow_scroll && eabs (position) <= max (5, height / 20))
5593 part = (position < 0) ? scroll_bar_up_arrow : scroll_bar_down_arrow;
5594 else
5595 part = scroll_bar_move_ratio;
5596
5597 window_being_scrolled = bar->window;
5598 bar->dragging = -1;
5599 bar->last_seen_part = part;
5600 x_send_scroll_bar_event (bar->window, part, position, height,
5601 bar->horizontal);
5602 }
5603 }
5604
5605 #endif /* not USE_GTK and not USE_MOTIF */
5606
5607 #define SCROLL_BAR_NAME "verticalScrollBar"
5608 #define SCROLL_BAR_HORIZONTAL_NAME "horizontalScrollBar"
5609
5610 /* Create the widget for scroll bar BAR on frame F. Record the widget
5611 and X window of the scroll bar in BAR. */
5612
5613 #ifdef USE_GTK
5614 static void
5615 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
5616 {
5617 const char *scroll_bar_name = SCROLL_BAR_NAME;
5618
5619 block_input ();
5620 xg_create_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
5621 G_CALLBACK (xg_end_scroll_callback),
5622 scroll_bar_name);
5623 unblock_input ();
5624 }
5625
5626 static void
5627 x_create_horizontal_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
5628 {
5629 const char *scroll_bar_name = SCROLL_BAR_HORIZONTAL_NAME;
5630
5631 block_input ();
5632 xg_create_horizontal_scroll_bar (f, bar, G_CALLBACK (xg_scroll_callback),
5633 G_CALLBACK (xg_end_scroll_callback),
5634 scroll_bar_name);
5635 unblock_input ();
5636 }
5637
5638 #else /* not USE_GTK */
5639
5640 static void
5641 x_create_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
5642 {
5643 Window xwindow;
5644 Widget widget;
5645 Arg av[20];
5646 int ac = 0;
5647 const char *scroll_bar_name = SCROLL_BAR_NAME;
5648 unsigned long pixel;
5649
5650 block_input ();
5651
5652 #ifdef USE_MOTIF
5653 /* Set resources. Create the widget. */
5654 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
5655 XtSetArg (av[ac], XmNminimum, 0); ++ac;
5656 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
5657 XtSetArg (av[ac], XmNorientation, XmVERTICAL); ++ac;
5658 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_BOTTOM), ++ac;
5659 XtSetArg (av[ac], XmNincrement, 1); ++ac;
5660 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
5661
5662 pixel = f->output_data.x->scroll_bar_foreground_pixel;
5663 if (pixel != -1)
5664 {
5665 XtSetArg (av[ac], XmNforeground, pixel);
5666 ++ac;
5667 }
5668
5669 pixel = f->output_data.x->scroll_bar_background_pixel;
5670 if (pixel != -1)
5671 {
5672 XtSetArg (av[ac], XmNbackground, pixel);
5673 ++ac;
5674 }
5675
5676 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
5677 (char *) scroll_bar_name, av, ac);
5678
5679 /* Add one callback for everything that can happen. */
5680 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
5681 (XtPointer) bar);
5682 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
5683 (XtPointer) bar);
5684 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
5685 (XtPointer) bar);
5686 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
5687 (XtPointer) bar);
5688 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
5689 (XtPointer) bar);
5690 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
5691 (XtPointer) bar);
5692 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
5693 (XtPointer) bar);
5694
5695 /* Realize the widget. Only after that is the X window created. */
5696 XtRealizeWidget (widget);
5697
5698 /* Set the cursor to an arrow. I didn't find a resource to do that.
5699 And I'm wondering why it hasn't an arrow cursor by default. */
5700 XDefineCursor (XtDisplay (widget), XtWindow (widget),
5701 f->output_data.x->nontext_cursor);
5702
5703 #else /* !USE_MOTIF i.e. use Xaw */
5704
5705 /* Set resources. Create the widget. The background of the
5706 Xaw3d scroll bar widget is a little bit light for my taste.
5707 We don't alter it here to let users change it according
5708 to their taste with `emacs*verticalScrollBar.background: xxx'. */
5709 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
5710 XtSetArg (av[ac], XtNorientation, XtorientVertical); ++ac;
5711 /* For smoother scrolling with Xaw3d -sm */
5712 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
5713
5714 pixel = f->output_data.x->scroll_bar_foreground_pixel;
5715 if (pixel != -1)
5716 {
5717 XtSetArg (av[ac], XtNforeground, pixel);
5718 ++ac;
5719 }
5720
5721 pixel = f->output_data.x->scroll_bar_background_pixel;
5722 if (pixel != -1)
5723 {
5724 XtSetArg (av[ac], XtNbackground, pixel);
5725 ++ac;
5726 }
5727
5728 /* Top/bottom shadow colors. */
5729
5730 /* Allocate them, if necessary. */
5731 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
5732 {
5733 pixel = f->output_data.x->scroll_bar_background_pixel;
5734 if (pixel != -1)
5735 {
5736 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
5737 FRAME_X_COLORMAP (f),
5738 &pixel, 1.2, 0x8000))
5739 pixel = -1;
5740 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
5741 }
5742 }
5743 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
5744 {
5745 pixel = f->output_data.x->scroll_bar_background_pixel;
5746 if (pixel != -1)
5747 {
5748 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
5749 FRAME_X_COLORMAP (f),
5750 &pixel, 0.6, 0x4000))
5751 pixel = -1;
5752 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
5753 }
5754 }
5755
5756 #ifdef XtNbeNiceToColormap
5757 /* Tell the toolkit about them. */
5758 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
5759 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
5760 /* We tried to allocate a color for the top/bottom shadow, and
5761 failed, so tell Xaw3d to use dithering instead. */
5762 /* But only if we have a small colormap. Xaw3d can allocate nice
5763 colors itself. */
5764 {
5765 XtSetArg (av[ac], XtNbeNiceToColormap,
5766 DefaultDepthOfScreen (FRAME_X_SCREEN (f)) < 16);
5767 ++ac;
5768 }
5769 else
5770 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
5771 be more consistent with other emacs 3d colors, and since Xaw3d is
5772 not good at dealing with allocation failure. */
5773 {
5774 /* This tells Xaw3d to use real colors instead of dithering for
5775 the shadows. */
5776 XtSetArg (av[ac], XtNbeNiceToColormap, False);
5777 ++ac;
5778
5779 /* Specify the colors. */
5780 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
5781 if (pixel != -1)
5782 {
5783 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
5784 ++ac;
5785 }
5786 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
5787 if (pixel != -1)
5788 {
5789 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
5790 ++ac;
5791 }
5792 }
5793 #endif
5794
5795 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
5796 f->output_data.x->edit_widget, av, ac);
5797
5798 {
5799 char const *initial = "";
5800 char const *val = initial;
5801 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
5802 #ifdef XtNarrowScrollbars
5803 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
5804 #endif
5805 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
5806 if (xaw3d_arrow_scroll || val == initial)
5807 { /* ARROW_SCROLL */
5808 xaw3d_arrow_scroll = True;
5809 /* Isn't that just a personal preference ? --Stef */
5810 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
5811 }
5812 }
5813
5814 /* Define callbacks. */
5815 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
5816 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
5817 (XtPointer) bar);
5818
5819 /* Realize the widget. Only after that is the X window created. */
5820 XtRealizeWidget (widget);
5821
5822 #endif /* !USE_MOTIF */
5823
5824 /* Install an action hook that lets us detect when the user
5825 finishes interacting with a scroll bar. */
5826 if (action_hook_id == 0)
5827 action_hook_id = XtAppAddActionHook (Xt_app_con, xt_action_hook, 0);
5828
5829 /* Remember X window and widget in the scroll bar vector. */
5830 SET_SCROLL_BAR_X_WIDGET (bar, widget);
5831 xwindow = XtWindow (widget);
5832 bar->x_window = xwindow;
5833 bar->whole = 1;
5834 bar->horizontal = false;
5835
5836 unblock_input ();
5837 }
5838
5839 static void
5840 x_create_horizontal_toolkit_scroll_bar (struct frame *f, struct scroll_bar *bar)
5841 {
5842 Window xwindow;
5843 Widget widget;
5844 Arg av[20];
5845 int ac = 0;
5846 const char *scroll_bar_name = SCROLL_BAR_HORIZONTAL_NAME;
5847 unsigned long pixel;
5848
5849 block_input ();
5850
5851 #ifdef USE_MOTIF
5852 /* Set resources. Create the widget. */
5853 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
5854 XtSetArg (av[ac], XmNminimum, 0); ++ac;
5855 XtSetArg (av[ac], XmNmaximum, XM_SB_MAX); ++ac;
5856 XtSetArg (av[ac], XmNorientation, XmHORIZONTAL); ++ac;
5857 XtSetArg (av[ac], XmNprocessingDirection, XmMAX_ON_RIGHT), ++ac;
5858 XtSetArg (av[ac], XmNincrement, 1); ++ac;
5859 XtSetArg (av[ac], XmNpageIncrement, 1); ++ac;
5860
5861 pixel = f->output_data.x->scroll_bar_foreground_pixel;
5862 if (pixel != -1)
5863 {
5864 XtSetArg (av[ac], XmNforeground, pixel);
5865 ++ac;
5866 }
5867
5868 pixel = f->output_data.x->scroll_bar_background_pixel;
5869 if (pixel != -1)
5870 {
5871 XtSetArg (av[ac], XmNbackground, pixel);
5872 ++ac;
5873 }
5874
5875 widget = XmCreateScrollBar (f->output_data.x->edit_widget,
5876 (char *) scroll_bar_name, av, ac);
5877
5878 /* Add one callback for everything that can happen. */
5879 XtAddCallback (widget, XmNdecrementCallback, xm_scroll_callback,
5880 (XtPointer) bar);
5881 XtAddCallback (widget, XmNdragCallback, xm_scroll_callback,
5882 (XtPointer) bar);
5883 XtAddCallback (widget, XmNincrementCallback, xm_scroll_callback,
5884 (XtPointer) bar);
5885 XtAddCallback (widget, XmNpageDecrementCallback, xm_scroll_callback,
5886 (XtPointer) bar);
5887 XtAddCallback (widget, XmNpageIncrementCallback, xm_scroll_callback,
5888 (XtPointer) bar);
5889 XtAddCallback (widget, XmNtoBottomCallback, xm_scroll_callback,
5890 (XtPointer) bar);
5891 XtAddCallback (widget, XmNtoTopCallback, xm_scroll_callback,
5892 (XtPointer) bar);
5893
5894 /* Realize the widget. Only after that is the X window created. */
5895 XtRealizeWidget (widget);
5896
5897 /* Set the cursor to an arrow. I didn't find a resource to do that.
5898 And I'm wondering why it hasn't an arrow cursor by default. */
5899 XDefineCursor (XtDisplay (widget), XtWindow (widget),
5900 f->output_data.x->nontext_cursor);
5901
5902 #else /* !USE_MOTIF i.e. use Xaw */
5903
5904 /* Set resources. Create the widget. The background of the
5905 Xaw3d scroll bar widget is a little bit light for my taste.
5906 We don't alter it here to let users change it according
5907 to their taste with `emacs*verticalScrollBar.background: xxx'. */
5908 XtSetArg (av[ac], XtNmappedWhenManaged, False); ++ac;
5909 XtSetArg (av[ac], XtNorientation, XtorientHorizontal); ++ac;
5910 /* For smoother scrolling with Xaw3d -sm */
5911 /* XtSetArg (av[ac], XtNpickTop, True); ++ac; */
5912
5913 pixel = f->output_data.x->scroll_bar_foreground_pixel;
5914 if (pixel != -1)
5915 {
5916 XtSetArg (av[ac], XtNforeground, pixel);
5917 ++ac;
5918 }
5919
5920 pixel = f->output_data.x->scroll_bar_background_pixel;
5921 if (pixel != -1)
5922 {
5923 XtSetArg (av[ac], XtNbackground, pixel);
5924 ++ac;
5925 }
5926
5927 /* Top/bottom shadow colors. */
5928
5929 /* Allocate them, if necessary. */
5930 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1)
5931 {
5932 pixel = f->output_data.x->scroll_bar_background_pixel;
5933 if (pixel != -1)
5934 {
5935 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
5936 FRAME_X_COLORMAP (f),
5937 &pixel, 1.2, 0x8000))
5938 pixel = -1;
5939 f->output_data.x->scroll_bar_top_shadow_pixel = pixel;
5940 }
5941 }
5942 if (f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
5943 {
5944 pixel = f->output_data.x->scroll_bar_background_pixel;
5945 if (pixel != -1)
5946 {
5947 if (!x_alloc_lighter_color (f, FRAME_X_DISPLAY (f),
5948 FRAME_X_COLORMAP (f),
5949 &pixel, 0.6, 0x4000))
5950 pixel = -1;
5951 f->output_data.x->scroll_bar_bottom_shadow_pixel = pixel;
5952 }
5953 }
5954
5955 #ifdef XtNbeNiceToColormap
5956 /* Tell the toolkit about them. */
5957 if (f->output_data.x->scroll_bar_top_shadow_pixel == -1
5958 || f->output_data.x->scroll_bar_bottom_shadow_pixel == -1)
5959 /* We tried to allocate a color for the top/bottom shadow, and
5960 failed, so tell Xaw3d to use dithering instead. */
5961 /* But only if we have a small colormap. Xaw3d can allocate nice
5962 colors itself. */
5963 {
5964 XtSetArg (av[ac], XtNbeNiceToColormap,
5965 DefaultDepthOfScreen (FRAME_X_SCREEN (f)) < 16);
5966 ++ac;
5967 }
5968 else
5969 /* Tell what colors Xaw3d should use for the top/bottom shadow, to
5970 be more consistent with other emacs 3d colors, and since Xaw3d is
5971 not good at dealing with allocation failure. */
5972 {
5973 /* This tells Xaw3d to use real colors instead of dithering for
5974 the shadows. */
5975 XtSetArg (av[ac], XtNbeNiceToColormap, False);
5976 ++ac;
5977
5978 /* Specify the colors. */
5979 pixel = f->output_data.x->scroll_bar_top_shadow_pixel;
5980 if (pixel != -1)
5981 {
5982 XtSetArg (av[ac], XtNtopShadowPixel, pixel);
5983 ++ac;
5984 }
5985 pixel = f->output_data.x->scroll_bar_bottom_shadow_pixel;
5986 if (pixel != -1)
5987 {
5988 XtSetArg (av[ac], XtNbottomShadowPixel, pixel);
5989 ++ac;
5990 }
5991 }
5992 #endif
5993
5994 widget = XtCreateWidget (scroll_bar_name, scrollbarWidgetClass,
5995 f->output_data.x->edit_widget, av, ac);
5996
5997 {
5998 char const *initial = "";
5999 char const *val = initial;
6000 XtVaGetValues (widget, XtNscrollVCursor, (XtPointer) &val,
6001 #ifdef XtNarrowScrollbars
6002 XtNarrowScrollbars, (XtPointer) &xaw3d_arrow_scroll,
6003 #endif
6004 XtNpickTop, (XtPointer) &xaw3d_pick_top, NULL);
6005 if (xaw3d_arrow_scroll || val == initial)
6006 { /* ARROW_SCROLL */
6007 xaw3d_arrow_scroll = True;
6008 /* Isn't that just a personal preference ? --Stef */
6009 XtVaSetValues (widget, XtNcursorName, "top_left_arrow", NULL);
6010 }
6011 }
6012
6013 /* Define callbacks. */
6014 XtAddCallback (widget, XtNjumpProc, xaw_jump_callback, (XtPointer) bar);
6015 XtAddCallback (widget, XtNscrollProc, xaw_scroll_callback,
6016 (XtPointer) bar);
6017
6018 /* Realize the widget. Only after that is the X window created. */
6019 XtRealizeWidget (widget);
6020
6021 #endif /* !USE_MOTIF */
6022
6023 /* Install an action hook that lets us detect when the user
6024 finishes interacting with a scroll bar. */
6025 if (horizontal_action_hook_id == 0)
6026 horizontal_action_hook_id
6027 = XtAppAddActionHook (Xt_app_con, xt_horizontal_action_hook, 0);
6028
6029 /* Remember X window and widget in the scroll bar vector. */
6030 SET_SCROLL_BAR_X_WIDGET (bar, widget);
6031 xwindow = XtWindow (widget);
6032 bar->x_window = xwindow;
6033 bar->whole = 1;
6034 bar->horizontal = true;
6035
6036 unblock_input ();
6037 }
6038 #endif /* not USE_GTK */
6039
6040
6041 /* Set the thumb size and position of scroll bar BAR. We are currently
6042 displaying PORTION out of a whole WHOLE, and our position POSITION. */
6043
6044 #ifdef USE_GTK
6045 static void
6046 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position, int whole)
6047 {
6048 xg_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
6049 }
6050
6051 static void
6052 x_set_toolkit_horizontal_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position, int whole)
6053 {
6054 xg_set_toolkit_horizontal_scroll_bar_thumb (bar, portion, position, whole);
6055 }
6056
6057 #else /* not USE_GTK */
6058 static void
6059 x_set_toolkit_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position,
6060 int whole)
6061 {
6062 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
6063 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
6064 float top, shown;
6065
6066 block_input ();
6067
6068 #ifdef USE_MOTIF
6069
6070 if (scroll_bar_adjust_thumb_portion_p)
6071 {
6072 /* We use an estimate of 30 chars per line rather than the real
6073 `portion' value. This has the disadvantage that the thumb size
6074 is not very representative, but it makes our life a lot easier.
6075 Otherwise, we have to constantly adjust the thumb size, which
6076 we can't always do quickly enough: while dragging, the size of
6077 the thumb might prevent the user from dragging the thumb all the
6078 way to the end. but Motif and some versions of Xaw3d don't allow
6079 updating the thumb size while dragging. Also, even if we can update
6080 its size, the update will often happen too late.
6081 If you don't believe it, check out revision 1.650 of xterm.c to see
6082 what hoops we were going through and the still poor behavior we got. */
6083 portion = WINDOW_TOTAL_LINES (XWINDOW (bar->window)) * 30;
6084 /* When the thumb is at the bottom, position == whole.
6085 So we need to increase `whole' to make space for the thumb. */
6086 whole += portion;
6087 }
6088
6089 if (whole <= 0)
6090 top = 0, shown = 1;
6091 else
6092 {
6093 top = (float) position / whole;
6094 shown = (float) portion / whole;
6095 }
6096
6097 if (bar->dragging == -1)
6098 {
6099 int size, value;
6100
6101 /* Slider size. Must be in the range [1 .. MAX - MIN] where MAX
6102 is the scroll bar's maximum and MIN is the scroll bar's minimum
6103 value. */
6104 size = clip_to_bounds (1, shown * XM_SB_MAX, XM_SB_MAX);
6105
6106 /* Position. Must be in the range [MIN .. MAX - SLIDER_SIZE]. */
6107 value = top * XM_SB_MAX;
6108 value = min (value, XM_SB_MAX - size);
6109
6110 XmScrollBarSetValues (widget, value, size, 0, 0, False);
6111 }
6112 #else /* !USE_MOTIF i.e. use Xaw */
6113
6114 if (whole == 0)
6115 top = 0, shown = 1;
6116 else
6117 {
6118 top = (float) position / whole;
6119 shown = (float) portion / whole;
6120 }
6121
6122 {
6123 float old_top, old_shown;
6124 Dimension height;
6125 XtVaGetValues (widget,
6126 XtNtopOfThumb, &old_top,
6127 XtNshown, &old_shown,
6128 XtNheight, &height,
6129 NULL);
6130
6131 /* Massage the top+shown values. */
6132 if (bar->dragging == -1 || bar->last_seen_part == scroll_bar_down_arrow)
6133 top = max (0, min (1, top));
6134 else
6135 top = old_top;
6136 #if ! defined (HAVE_XAW3D)
6137 /* With Xaw, 'top' values too closer to 1.0 may
6138 cause the thumb to disappear. Fix that. */
6139 top = min (top, 0.99f);
6140 #endif
6141 /* Keep two pixels available for moving the thumb down. */
6142 shown = max (0, min (1 - top - (2.0f / height), shown));
6143 #if ! defined (HAVE_XAW3D)
6144 /* Likewise with too small 'shown'. */
6145 shown = max (shown, 0.01f);
6146 #endif
6147
6148 /* If the call to XawScrollbarSetThumb below doesn't seem to
6149 work, check that 'NARROWPROTO' is defined in src/config.h.
6150 If this is not so, most likely you need to fix configure. */
6151 if (top != old_top || shown != old_shown)
6152 {
6153 if (bar->dragging == -1)
6154 XawScrollbarSetThumb (widget, top, shown);
6155 else
6156 {
6157 /* Try to make the scrolling a tad smoother. */
6158 if (!xaw3d_pick_top)
6159 shown = min (shown, old_shown);
6160
6161 XawScrollbarSetThumb (widget, top, shown);
6162 }
6163 }
6164 }
6165 #endif /* !USE_MOTIF */
6166
6167 unblock_input ();
6168 }
6169
6170 static void
6171 x_set_toolkit_horizontal_scroll_bar_thumb (struct scroll_bar *bar, int portion, int position,
6172 int whole)
6173 {
6174 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
6175 Widget widget = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
6176 float top, shown;
6177
6178 block_input ();
6179
6180 #ifdef USE_MOTIF
6181 bar->whole = whole;
6182 shown = (float) portion / whole;
6183 top = (float) position / (whole - portion);
6184 {
6185 int size = clip_to_bounds (1, shown * XM_SB_MAX, XM_SB_MAX);
6186 int value = clip_to_bounds (0, top * (XM_SB_MAX - size), XM_SB_MAX - size);
6187
6188 XmScrollBarSetValues (widget, value, size, 0, 0, False);
6189 }
6190 #else /* !USE_MOTIF i.e. use Xaw */
6191 bar->whole = whole;
6192 if (whole == 0)
6193 top = 0, shown = 1;
6194 else
6195 {
6196 top = (float) position / whole;
6197 shown = (float) portion / whole;
6198 }
6199
6200 {
6201 float old_top, old_shown;
6202 Dimension height;
6203 XtVaGetValues (widget,
6204 XtNtopOfThumb, &old_top,
6205 XtNshown, &old_shown,
6206 XtNheight, &height,
6207 NULL);
6208
6209 #if false
6210 /* Massage the top+shown values. */
6211 if (bar->dragging == -1 || bar->last_seen_part == scroll_bar_down_arrow)
6212 top = max (0, min (1, top));
6213 else
6214 top = old_top;
6215 #if ! defined (HAVE_XAW3D)
6216 /* With Xaw, 'top' values too closer to 1.0 may
6217 cause the thumb to disappear. Fix that. */
6218 top = min (top, 0.99f);
6219 #endif
6220 /* Keep two pixels available for moving the thumb down. */
6221 shown = max (0, min (1 - top - (2.0f / height), shown));
6222 #if ! defined (HAVE_XAW3D)
6223 /* Likewise with too small 'shown'. */
6224 shown = max (shown, 0.01f);
6225 #endif
6226 #endif
6227
6228 /* If the call to XawScrollbarSetThumb below doesn't seem to
6229 work, check that 'NARROWPROTO' is defined in src/config.h.
6230 If this is not so, most likely you need to fix configure. */
6231 XawScrollbarSetThumb (widget, top, shown);
6232 #if false
6233 if (top != old_top || shown != old_shown)
6234 {
6235 if (bar->dragging == -1)
6236 XawScrollbarSetThumb (widget, top, shown);
6237 else
6238 {
6239 /* Try to make the scrolling a tad smoother. */
6240 if (!xaw3d_pick_top)
6241 shown = min (shown, old_shown);
6242
6243 XawScrollbarSetThumb (widget, top, shown);
6244 }
6245 }
6246 #endif
6247 }
6248 #endif /* !USE_MOTIF */
6249
6250 unblock_input ();
6251 }
6252 #endif /* not USE_GTK */
6253
6254 #endif /* USE_TOOLKIT_SCROLL_BARS */
6255
6256
6257 \f
6258 /************************************************************************
6259 Scroll bars, general
6260 ************************************************************************/
6261
6262 /* Create a scroll bar and return the scroll bar vector for it. W is
6263 the Emacs window on which to create the scroll bar. TOP, LEFT,
6264 WIDTH and HEIGHT are the pixel coordinates and dimensions of the
6265 scroll bar. */
6266
6267 static struct scroll_bar *
6268 x_scroll_bar_create (struct window *w, int top, int left,
6269 int width, int height, bool horizontal)
6270 {
6271 struct frame *f = XFRAME (w->frame);
6272 struct scroll_bar *bar
6273 = ALLOCATE_PSEUDOVECTOR (struct scroll_bar, x_window, PVEC_OTHER);
6274 Lisp_Object barobj;
6275
6276 block_input ();
6277
6278 #ifdef USE_TOOLKIT_SCROLL_BARS
6279 if (horizontal)
6280 x_create_horizontal_toolkit_scroll_bar (f, bar);
6281 else
6282 x_create_toolkit_scroll_bar (f, bar);
6283 #else /* not USE_TOOLKIT_SCROLL_BARS */
6284 {
6285 XSetWindowAttributes a;
6286 unsigned long mask;
6287 Window window;
6288
6289 a.background_pixel = f->output_data.x->scroll_bar_background_pixel;
6290 if (a.background_pixel == -1)
6291 a.background_pixel = FRAME_BACKGROUND_PIXEL (f);
6292
6293 a.event_mask = (ButtonPressMask | ButtonReleaseMask
6294 | ButtonMotionMask | PointerMotionHintMask
6295 | ExposureMask);
6296 a.cursor = FRAME_DISPLAY_INFO (f)->vertical_scroll_bar_cursor;
6297
6298 mask = (CWBackPixel | CWEventMask | CWCursor);
6299
6300 /* Clear the area of W that will serve as a scroll bar. This is
6301 for the case that a window has been split horizontally. In
6302 this case, no clear_frame is generated to reduce flickering. */
6303 if (width > 0 && window_box_height (w) > 0)
6304 x_clear_area (f, left, top, width, window_box_height (w));
6305
6306 window = XCreateWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
6307 /* Position and size of scroll bar. */
6308 left, top, width, height,
6309 /* Border width, depth, class, and visual. */
6310 0,
6311 CopyFromParent,
6312 CopyFromParent,
6313 CopyFromParent,
6314 /* Attributes. */
6315 mask, &a);
6316 bar->x_window = window;
6317 }
6318 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6319
6320 XSETWINDOW (bar->window, w);
6321 bar->top = top;
6322 bar->left = left;
6323 bar->width = width;
6324 bar->height = height;
6325 bar->start = 0;
6326 bar->end = 0;
6327 bar->dragging = -1;
6328 bar->horizontal = horizontal;
6329 #if defined (USE_TOOLKIT_SCROLL_BARS) && defined (USE_LUCID)
6330 bar->last_seen_part = scroll_bar_nowhere;
6331 #endif
6332
6333 /* Add bar to its frame's list of scroll bars. */
6334 bar->next = FRAME_SCROLL_BARS (f);
6335 bar->prev = Qnil;
6336 XSETVECTOR (barobj, bar);
6337 fset_scroll_bars (f, barobj);
6338 if (!NILP (bar->next))
6339 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
6340
6341 /* Map the window/widget. */
6342 #ifdef USE_TOOLKIT_SCROLL_BARS
6343 {
6344 #ifdef USE_GTK
6345 if (horizontal)
6346 xg_update_horizontal_scrollbar_pos (f, bar->x_window, top,
6347 left, width, max (height, 1));
6348 else
6349 xg_update_scrollbar_pos (f, bar->x_window, top,
6350 left, width, max (height, 1));
6351 #else /* not USE_GTK */
6352 Widget scroll_bar = SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar);
6353 XtConfigureWidget (scroll_bar, left, top, width, max (height, 1), 0);
6354 XtMapWidget (scroll_bar);
6355 #endif /* not USE_GTK */
6356 }
6357 #else /* not USE_TOOLKIT_SCROLL_BARS */
6358 XMapRaised (FRAME_X_DISPLAY (f), bar->x_window);
6359 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6360
6361 unblock_input ();
6362 return bar;
6363 }
6364
6365
6366 #ifndef USE_TOOLKIT_SCROLL_BARS
6367
6368 /* Draw BAR's handle in the proper position.
6369
6370 If the handle is already drawn from START to END, don't bother
6371 redrawing it, unless REBUILD; in that case, always
6372 redraw it. (REBUILD is handy for drawing the handle after expose
6373 events.)
6374
6375 Normally, we want to constrain the start and end of the handle to
6376 fit inside its rectangle, but if the user is dragging the scroll
6377 bar handle, we want to let them drag it down all the way, so that
6378 the bar's top is as far down as it goes; otherwise, there's no way
6379 to move to the very end of the buffer. */
6380
6381 static void
6382 x_scroll_bar_set_handle (struct scroll_bar *bar, int start, int end,
6383 bool rebuild)
6384 {
6385 bool dragging = bar->dragging != -1;
6386 Window w = bar->x_window;
6387 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
6388 GC gc = f->output_data.x->normal_gc;
6389
6390 /* If the display is already accurate, do nothing. */
6391 if (! rebuild
6392 && start == bar->start
6393 && end == bar->end)
6394 return;
6395
6396 block_input ();
6397
6398 {
6399 int inside_width = VERTICAL_SCROLL_BAR_INSIDE_WIDTH (f, bar->width);
6400 int inside_height = VERTICAL_SCROLL_BAR_INSIDE_HEIGHT (f, bar->height);
6401 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
6402
6403 /* Make sure the values are reasonable, and try to preserve
6404 the distance between start and end. */
6405 {
6406 int length = end - start;
6407
6408 if (start < 0)
6409 start = 0;
6410 else if (start > top_range)
6411 start = top_range;
6412 end = start + length;
6413
6414 if (end < start)
6415 end = start;
6416 else if (end > top_range && ! dragging)
6417 end = top_range;
6418 }
6419
6420 /* Store the adjusted setting in the scroll bar. */
6421 bar->start = start;
6422 bar->end = end;
6423
6424 /* Clip the end position, just for display. */
6425 if (end > top_range)
6426 end = top_range;
6427
6428 /* Draw bottom positions VERTICAL_SCROLL_BAR_MIN_HANDLE pixels
6429 below top positions, to make sure the handle is always at least
6430 that many pixels tall. */
6431 end += VERTICAL_SCROLL_BAR_MIN_HANDLE;
6432
6433 /* Draw the empty space above the handle. Note that we can't clear
6434 zero-height areas; that means "clear to end of window." */
6435 if ((inside_width > 0) && (start > 0))
6436 x_clear_area1 (FRAME_X_DISPLAY (f), w,
6437 VERTICAL_SCROLL_BAR_LEFT_BORDER,
6438 VERTICAL_SCROLL_BAR_TOP_BORDER,
6439 inside_width, start);
6440
6441 /* Change to proper foreground color if one is specified. */
6442 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
6443 XSetForeground (FRAME_X_DISPLAY (f), gc,
6444 f->output_data.x->scroll_bar_foreground_pixel);
6445
6446 /* Draw the handle itself. */
6447 x_fill_rectangle (f, gc,
6448 /* x, y, width, height */
6449 VERTICAL_SCROLL_BAR_LEFT_BORDER,
6450 VERTICAL_SCROLL_BAR_TOP_BORDER + start,
6451 inside_width, end - start);
6452
6453 /* Restore the foreground color of the GC if we changed it above. */
6454 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
6455 XSetForeground (FRAME_X_DISPLAY (f), gc,
6456 FRAME_FOREGROUND_PIXEL (f));
6457
6458 /* Draw the empty space below the handle. Note that we can't
6459 clear zero-height areas; that means "clear to end of window." */
6460 if ((inside_width > 0) && (end < inside_height))
6461 x_clear_area1 (FRAME_X_DISPLAY (f), w,
6462 VERTICAL_SCROLL_BAR_LEFT_BORDER,
6463 VERTICAL_SCROLL_BAR_TOP_BORDER + end,
6464 inside_width, inside_height - end);
6465 }
6466
6467 unblock_input ();
6468 }
6469
6470 #endif /* !USE_TOOLKIT_SCROLL_BARS */
6471
6472 /* Destroy scroll bar BAR, and set its Emacs window's scroll bar to
6473 nil. */
6474
6475 static void
6476 x_scroll_bar_remove (struct scroll_bar *bar)
6477 {
6478 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
6479 block_input ();
6480
6481 #ifdef USE_TOOLKIT_SCROLL_BARS
6482 #ifdef USE_GTK
6483 xg_remove_scroll_bar (f, bar->x_window);
6484 #else /* not USE_GTK */
6485 XtDestroyWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar));
6486 #endif /* not USE_GTK */
6487 #else
6488 XDestroyWindow (FRAME_X_DISPLAY (f), bar->x_window);
6489 #endif
6490
6491 /* Dissociate this scroll bar from its window. */
6492 if (bar->horizontal)
6493 wset_horizontal_scroll_bar (XWINDOW (bar->window), Qnil);
6494 else
6495 wset_vertical_scroll_bar (XWINDOW (bar->window), Qnil);
6496
6497 unblock_input ();
6498 }
6499
6500
6501 /* Set the handle of the vertical scroll bar for WINDOW to indicate
6502 that we are displaying PORTION characters out of a total of WHOLE
6503 characters, starting at POSITION. If WINDOW has no scroll bar,
6504 create one. */
6505
6506 static void
6507 XTset_vertical_scroll_bar (struct window *w, int portion, int whole, int position)
6508 {
6509 struct frame *f = XFRAME (w->frame);
6510 Lisp_Object barobj;
6511 struct scroll_bar *bar;
6512 int top, height, left, width;
6513 int window_y, window_height;
6514
6515 /* Get window dimensions. */
6516 window_box (w, ANY_AREA, 0, &window_y, 0, &window_height);
6517 top = window_y;
6518 height = window_height;
6519 left = WINDOW_SCROLL_BAR_AREA_X (w);
6520 width = WINDOW_SCROLL_BAR_AREA_WIDTH (w);
6521
6522 /* Does the scroll bar exist yet? */
6523 if (NILP (w->vertical_scroll_bar))
6524 {
6525 if (width > 0 && height > 0)
6526 {
6527 block_input ();
6528 x_clear_area (f, left, top, width, height);
6529 unblock_input ();
6530 }
6531
6532 bar = x_scroll_bar_create (w, top, left, width, max (height, 1), false);
6533 }
6534 else
6535 {
6536 /* It may just need to be moved and resized. */
6537 unsigned int mask = 0;
6538
6539 bar = XSCROLL_BAR (w->vertical_scroll_bar);
6540
6541 block_input ();
6542
6543 if (left != bar->left)
6544 mask |= CWX;
6545 if (top != bar->top)
6546 mask |= CWY;
6547 if (width != bar->width)
6548 mask |= CWWidth;
6549 if (height != bar->height)
6550 mask |= CWHeight;
6551
6552 #ifdef USE_TOOLKIT_SCROLL_BARS
6553
6554 /* Move/size the scroll bar widget. */
6555 if (mask)
6556 {
6557 /* Since toolkit scroll bars are smaller than the space reserved
6558 for them on the frame, we have to clear "under" them. */
6559 if (width > 0 && height > 0)
6560 x_clear_area (f, left, top, width, height);
6561 #ifdef USE_GTK
6562 xg_update_scrollbar_pos (f, bar->x_window, top,
6563 left, width, max (height, 1));
6564 #else /* not USE_GTK */
6565 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
6566 left, top, width, max (height, 1), 0);
6567 #endif /* not USE_GTK */
6568 }
6569 #else /* not USE_TOOLKIT_SCROLL_BARS */
6570
6571 /* Move/size the scroll bar window. */
6572 if (mask)
6573 {
6574 XWindowChanges wc;
6575
6576 wc.x = left;
6577 wc.y = top;
6578 wc.width = width;
6579 wc.height = height;
6580 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
6581 mask, &wc);
6582 }
6583
6584 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6585
6586 /* Remember new settings. */
6587 bar->left = left;
6588 bar->top = top;
6589 bar->width = width;
6590 bar->height = height;
6591
6592 unblock_input ();
6593 }
6594
6595 #ifdef USE_TOOLKIT_SCROLL_BARS
6596 x_set_toolkit_scroll_bar_thumb (bar, portion, position, whole);
6597 #else /* not USE_TOOLKIT_SCROLL_BARS */
6598 /* Set the scroll bar's current state, unless we're currently being
6599 dragged. */
6600 if (bar->dragging == -1)
6601 {
6602 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, height);
6603
6604 if (whole == 0)
6605 x_scroll_bar_set_handle (bar, 0, top_range, false);
6606 else
6607 {
6608 int start = ((double) position * top_range) / whole;
6609 int end = ((double) (position + portion) * top_range) / whole;
6610 x_scroll_bar_set_handle (bar, start, end, false);
6611 }
6612 }
6613 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6614
6615 XSETVECTOR (barobj, bar);
6616 wset_vertical_scroll_bar (w, barobj);
6617 }
6618
6619
6620 static void
6621 XTset_horizontal_scroll_bar (struct window *w, int portion, int whole, int position)
6622 {
6623 struct frame *f = XFRAME (w->frame);
6624 Lisp_Object barobj;
6625 struct scroll_bar *bar;
6626 int top, height, left, width;
6627 int window_x, window_width;
6628 int pixel_width = WINDOW_PIXEL_WIDTH (w);
6629
6630 /* Get window dimensions. */
6631 window_box (w, ANY_AREA, &window_x, 0, &window_width, 0);
6632 left = window_x;
6633 width = window_width;
6634 top = WINDOW_SCROLL_BAR_AREA_Y (w);
6635 height = WINDOW_SCROLL_BAR_AREA_HEIGHT (w);
6636
6637 /* Does the scroll bar exist yet? */
6638 if (NILP (w->horizontal_scroll_bar))
6639 {
6640 if (width > 0 && height > 0)
6641 {
6642 block_input ();
6643
6644 /* Clear also part between window_width and
6645 WINDOW_PIXEL_WIDTH. */
6646 x_clear_area (f, left, top, pixel_width, height);
6647 unblock_input ();
6648 }
6649
6650 bar = x_scroll_bar_create (w, top, left, width, height, true);
6651 }
6652 else
6653 {
6654 /* It may just need to be moved and resized. */
6655 unsigned int mask = 0;
6656
6657 bar = XSCROLL_BAR (w->horizontal_scroll_bar);
6658
6659 block_input ();
6660
6661 if (left != bar->left)
6662 mask |= CWX;
6663 if (top != bar->top)
6664 mask |= CWY;
6665 if (width != bar->width)
6666 mask |= CWWidth;
6667 if (height != bar->height)
6668 mask |= CWHeight;
6669
6670 #ifdef USE_TOOLKIT_SCROLL_BARS
6671 /* Move/size the scroll bar widget. */
6672 if (mask)
6673 {
6674 /* Since toolkit scroll bars are smaller than the space reserved
6675 for them on the frame, we have to clear "under" them. */
6676 if (width > 0 && height > 0)
6677 x_clear_area (f,
6678 WINDOW_LEFT_EDGE_X (w), top,
6679 pixel_width - WINDOW_RIGHT_DIVIDER_WIDTH (w), height);
6680 #ifdef USE_GTK
6681 xg_update_horizontal_scrollbar_pos (f, bar->x_window, top, left,
6682 width, height);
6683 #else /* not USE_GTK */
6684 XtConfigureWidget (SCROLL_BAR_X_WIDGET (FRAME_X_DISPLAY (f), bar),
6685 left, top, width, height, 0);
6686 #endif /* not USE_GTK */
6687 }
6688 #else /* not USE_TOOLKIT_SCROLL_BARS */
6689
6690 /* Clear areas not covered by the scroll bar because it's not as
6691 wide as the area reserved for it. This makes sure a
6692 previous mode line display is cleared after C-x 2 C-x 1, for
6693 example. */
6694 {
6695 int area_height = WINDOW_CONFIG_SCROLL_BAR_HEIGHT (w);
6696 int rest = area_height - height;
6697 if (rest > 0 && width > 0)
6698 x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
6699 left, top, width, rest);
6700 }
6701
6702 /* Move/size the scroll bar window. */
6703 if (mask)
6704 {
6705 XWindowChanges wc;
6706
6707 wc.x = left;
6708 wc.y = top;
6709 wc.width = width;
6710 wc.height = height;
6711 XConfigureWindow (FRAME_X_DISPLAY (f), bar->x_window,
6712 mask, &wc);
6713 }
6714
6715 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6716
6717 /* Remember new settings. */
6718 bar->left = left;
6719 bar->top = top;
6720 bar->width = width;
6721 bar->height = height;
6722
6723 unblock_input ();
6724 }
6725
6726 #ifdef USE_TOOLKIT_SCROLL_BARS
6727 x_set_toolkit_horizontal_scroll_bar_thumb (bar, portion, position, whole);
6728 #else /* not USE_TOOLKIT_SCROLL_BARS */
6729 /* Set the scroll bar's current state, unless we're currently being
6730 dragged. */
6731 if (bar->dragging == -1)
6732 {
6733 int left_range = HORIZONTAL_SCROLL_BAR_LEFT_RANGE (f, width);
6734
6735 if (whole == 0)
6736 x_scroll_bar_set_handle (bar, 0, left_range, false);
6737 else
6738 {
6739 int start = ((double) position * left_range) / whole;
6740 int end = ((double) (position + portion) * left_range) / whole;
6741 x_scroll_bar_set_handle (bar, start, end, false);
6742 }
6743 }
6744 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6745
6746 XSETVECTOR (barobj, bar);
6747 wset_horizontal_scroll_bar (w, barobj);
6748 }
6749
6750
6751 /* The following three hooks are used when we're doing a thorough
6752 redisplay of the frame. We don't explicitly know which scroll bars
6753 are going to be deleted, because keeping track of when windows go
6754 away is a real pain - "Can you say set-window-configuration, boys
6755 and girls?" Instead, we just assert at the beginning of redisplay
6756 that *all* scroll bars are to be removed, and then save a scroll bar
6757 from the fiery pit when we actually redisplay its window. */
6758
6759 /* Arrange for all scroll bars on FRAME to be removed at the next call
6760 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
6761 `*redeem_scroll_bar_hook' is applied to its window before the judgment. */
6762
6763 static void
6764 XTcondemn_scroll_bars (struct frame *frame)
6765 {
6766 if (!NILP (FRAME_SCROLL_BARS (frame)))
6767 {
6768 if (!NILP (FRAME_CONDEMNED_SCROLL_BARS (frame)))
6769 {
6770 /* Prepend scrollbars to already condemned ones. */
6771 Lisp_Object last = FRAME_SCROLL_BARS (frame);
6772
6773 while (!NILP (XSCROLL_BAR (last)->next))
6774 last = XSCROLL_BAR (last)->next;
6775
6776 XSCROLL_BAR (last)->next = FRAME_CONDEMNED_SCROLL_BARS (frame);
6777 XSCROLL_BAR (FRAME_CONDEMNED_SCROLL_BARS (frame))->prev = last;
6778 }
6779
6780 fset_condemned_scroll_bars (frame, FRAME_SCROLL_BARS (frame));
6781 fset_scroll_bars (frame, Qnil);
6782 }
6783 }
6784
6785
6786 /* Un-mark WINDOW's scroll bar for deletion in this judgment cycle.
6787 Note that WINDOW isn't necessarily condemned at all. */
6788
6789 static void
6790 XTredeem_scroll_bar (struct window *w)
6791 {
6792 struct scroll_bar *bar;
6793 Lisp_Object barobj;
6794 struct frame *f;
6795
6796 /* We can't redeem this window's scroll bar if it doesn't have one. */
6797 if (NILP (w->vertical_scroll_bar) && NILP (w->horizontal_scroll_bar))
6798 emacs_abort ();
6799
6800 if (!NILP (w->vertical_scroll_bar) && WINDOW_HAS_VERTICAL_SCROLL_BAR (w))
6801 {
6802 bar = XSCROLL_BAR (w->vertical_scroll_bar);
6803 /* Unlink it from the condemned list. */
6804 f = XFRAME (WINDOW_FRAME (w));
6805 if (NILP (bar->prev))
6806 {
6807 /* If the prev pointer is nil, it must be the first in one of
6808 the lists. */
6809 if (EQ (FRAME_SCROLL_BARS (f), w->vertical_scroll_bar))
6810 /* It's not condemned. Everything's fine. */
6811 goto horizontal;
6812 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
6813 w->vertical_scroll_bar))
6814 fset_condemned_scroll_bars (f, bar->next);
6815 else
6816 /* If its prev pointer is nil, it must be at the front of
6817 one or the other! */
6818 emacs_abort ();
6819 }
6820 else
6821 XSCROLL_BAR (bar->prev)->next = bar->next;
6822
6823 if (! NILP (bar->next))
6824 XSCROLL_BAR (bar->next)->prev = bar->prev;
6825
6826 bar->next = FRAME_SCROLL_BARS (f);
6827 bar->prev = Qnil;
6828 XSETVECTOR (barobj, bar);
6829 fset_scroll_bars (f, barobj);
6830 if (! NILP (bar->next))
6831 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
6832 }
6833
6834 horizontal:
6835 if (!NILP (w->horizontal_scroll_bar) && WINDOW_HAS_HORIZONTAL_SCROLL_BAR (w))
6836 {
6837 bar = XSCROLL_BAR (w->horizontal_scroll_bar);
6838 /* Unlink it from the condemned list. */
6839 f = XFRAME (WINDOW_FRAME (w));
6840 if (NILP (bar->prev))
6841 {
6842 /* If the prev pointer is nil, it must be the first in one of
6843 the lists. */
6844 if (EQ (FRAME_SCROLL_BARS (f), w->horizontal_scroll_bar))
6845 /* It's not condemned. Everything's fine. */
6846 return;
6847 else if (EQ (FRAME_CONDEMNED_SCROLL_BARS (f),
6848 w->horizontal_scroll_bar))
6849 fset_condemned_scroll_bars (f, bar->next);
6850 else
6851 /* If its prev pointer is nil, it must be at the front of
6852 one or the other! */
6853 emacs_abort ();
6854 }
6855 else
6856 XSCROLL_BAR (bar->prev)->next = bar->next;
6857
6858 if (! NILP (bar->next))
6859 XSCROLL_BAR (bar->next)->prev = bar->prev;
6860
6861 bar->next = FRAME_SCROLL_BARS (f);
6862 bar->prev = Qnil;
6863 XSETVECTOR (barobj, bar);
6864 fset_scroll_bars (f, barobj);
6865 if (! NILP (bar->next))
6866 XSETVECTOR (XSCROLL_BAR (bar->next)->prev, bar);
6867 }
6868 }
6869
6870 /* Remove all scroll bars on FRAME that haven't been saved since the
6871 last call to `*condemn_scroll_bars_hook'. */
6872
6873 static void
6874 XTjudge_scroll_bars (struct frame *f)
6875 {
6876 Lisp_Object bar, next;
6877
6878 bar = FRAME_CONDEMNED_SCROLL_BARS (f);
6879
6880 /* Clear out the condemned list now so we won't try to process any
6881 more events on the hapless scroll bars. */
6882 fset_condemned_scroll_bars (f, Qnil);
6883
6884 for (; ! NILP (bar); bar = next)
6885 {
6886 struct scroll_bar *b = XSCROLL_BAR (bar);
6887
6888 x_scroll_bar_remove (b);
6889
6890 next = b->next;
6891 b->next = b->prev = Qnil;
6892 }
6893
6894 /* Now there should be no references to the condemned scroll bars,
6895 and they should get garbage-collected. */
6896 }
6897
6898
6899 #ifndef USE_TOOLKIT_SCROLL_BARS
6900 /* Handle an Expose or GraphicsExpose event on a scroll bar. This
6901 is a no-op when using toolkit scroll bars.
6902
6903 This may be called from a signal handler, so we have to ignore GC
6904 mark bits. */
6905
6906 static void
6907 x_scroll_bar_expose (struct scroll_bar *bar, const XEvent *event)
6908 {
6909 Window w = bar->x_window;
6910 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
6911 GC gc = f->output_data.x->normal_gc;
6912
6913 block_input ();
6914
6915 x_scroll_bar_set_handle (bar, bar->start, bar->end, true);
6916
6917 /* Switch to scroll bar foreground color. */
6918 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
6919 XSetForeground (FRAME_X_DISPLAY (f), gc,
6920 f->output_data.x->scroll_bar_foreground_pixel);
6921
6922 /* Draw a one-pixel border just inside the edges of the scroll bar. */
6923 x_draw_rectangle (f, gc,
6924 /* x, y, width, height */
6925 0, 0, bar->width - 1, bar->height - 1);
6926
6927 /* Restore the foreground color of the GC if we changed it above. */
6928 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
6929 XSetForeground (FRAME_X_DISPLAY (f), gc,
6930 FRAME_FOREGROUND_PIXEL (f));
6931
6932 unblock_input ();
6933
6934 }
6935 #endif /* not USE_TOOLKIT_SCROLL_BARS */
6936
6937 /* Handle a mouse click on the scroll bar BAR. If *EMACS_EVENT's kind
6938 is set to something other than NO_EVENT, it is enqueued.
6939
6940 This may be called from a signal handler, so we have to ignore GC
6941 mark bits. */
6942
6943
6944 static void
6945 x_scroll_bar_handle_click (struct scroll_bar *bar,
6946 const XEvent *event,
6947 struct input_event *emacs_event)
6948 {
6949 if (! WINDOWP (bar->window))
6950 emacs_abort ();
6951
6952 emacs_event->kind = (bar->horizontal
6953 ? HORIZONTAL_SCROLL_BAR_CLICK_EVENT
6954 : SCROLL_BAR_CLICK_EVENT);
6955 emacs_event->code = event->xbutton.button - Button1;
6956 emacs_event->modifiers
6957 = (x_x_to_emacs_modifiers (FRAME_DISPLAY_INFO
6958 (XFRAME (WINDOW_FRAME (XWINDOW (bar->window)))),
6959 event->xbutton.state)
6960 | (event->type == ButtonRelease
6961 ? up_modifier
6962 : down_modifier));
6963 emacs_event->frame_or_window = bar->window;
6964 emacs_event->arg = Qnil;
6965 emacs_event->timestamp = event->xbutton.time;
6966 if (bar->horizontal)
6967 {
6968 int left_range
6969 = HORIZONTAL_SCROLL_BAR_LEFT_RANGE (f, bar->width);
6970 int x = event->xbutton.x - HORIZONTAL_SCROLL_BAR_LEFT_BORDER;
6971
6972 if (x < 0) x = 0;
6973 if (x > left_range) x = left_range;
6974
6975 if (x < bar->start)
6976 emacs_event->part = scroll_bar_before_handle;
6977 else if (x < bar->end + HORIZONTAL_SCROLL_BAR_MIN_HANDLE)
6978 emacs_event->part = scroll_bar_horizontal_handle;
6979 else
6980 emacs_event->part = scroll_bar_after_handle;
6981
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)
6985 {
6986 int new_start = - bar->dragging;
6987 int new_end = new_start + bar->end - bar->start;
6988
6989 x_scroll_bar_set_handle (bar, new_start, new_end, false);
6990 bar->dragging = -1;
6991 }
6992 #endif
6993
6994 XSETINT (emacs_event->x, left_range);
6995 XSETINT (emacs_event->y, x);
6996 }
6997 else
6998 {
6999 int top_range
7000 = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
7001 int y = event->xbutton.y - VERTICAL_SCROLL_BAR_TOP_BORDER;
7002
7003 if (y < 0) y = 0;
7004 if (y > top_range) y = top_range;
7005
7006 if (y < bar->start)
7007 emacs_event->part = scroll_bar_above_handle;
7008 else if (y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
7009 emacs_event->part = scroll_bar_handle;
7010 else
7011 emacs_event->part = scroll_bar_below_handle;
7012
7013 #ifndef USE_TOOLKIT_SCROLL_BARS
7014 /* If the user has released the handle, set it to its final position. */
7015 if (event->type == ButtonRelease && bar->dragging != -1)
7016 {
7017 int new_start = y - bar->dragging;
7018 int new_end = new_start + bar->end - bar->start;
7019
7020 x_scroll_bar_set_handle (bar, new_start, new_end, false);
7021 bar->dragging = -1;
7022 }
7023 #endif
7024
7025 XSETINT (emacs_event->x, y);
7026 XSETINT (emacs_event->y, top_range);
7027 }
7028 }
7029
7030 #ifndef USE_TOOLKIT_SCROLL_BARS
7031
7032 /* Handle some mouse motion while someone is dragging the scroll bar.
7033
7034 This may be called from a signal handler, so we have to ignore GC
7035 mark bits. */
7036
7037 static void
7038 x_scroll_bar_note_movement (struct scroll_bar *bar,
7039 const XMotionEvent *event)
7040 {
7041 struct frame *f = XFRAME (XWINDOW (bar->window)->frame);
7042 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
7043
7044 dpyinfo->last_mouse_movement_time = event->time;
7045 dpyinfo->last_mouse_scroll_bar = bar;
7046 f->mouse_moved = true;
7047
7048 /* If we're dragging the bar, display it. */
7049 if (bar->dragging != -1)
7050 {
7051 /* Where should the handle be now? */
7052 int new_start = event->y - bar->dragging;
7053
7054 if (new_start != bar->start)
7055 {
7056 int new_end = new_start + bar->end - bar->start;
7057
7058 x_scroll_bar_set_handle (bar, new_start, new_end, false);
7059 }
7060 }
7061 }
7062
7063 #endif /* !USE_TOOLKIT_SCROLL_BARS */
7064
7065 /* Return information to the user about the current position of the mouse
7066 on the scroll bar. */
7067
7068 static void
7069 x_scroll_bar_report_motion (struct frame **fp, Lisp_Object *bar_window,
7070 enum scroll_bar_part *part, Lisp_Object *x,
7071 Lisp_Object *y, Time *timestamp)
7072 {
7073 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (*fp);
7074 struct scroll_bar *bar = dpyinfo->last_mouse_scroll_bar;
7075 Window w = bar->x_window;
7076 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
7077 int win_x, win_y;
7078 Window dummy_window;
7079 int dummy_coord;
7080 unsigned int dummy_mask;
7081
7082 block_input ();
7083
7084 /* Get the mouse's position relative to the scroll bar window, and
7085 report that. */
7086 if (XQueryPointer (FRAME_X_DISPLAY (f), w,
7087
7088 /* Root, child, root x and root y. */
7089 &dummy_window, &dummy_window,
7090 &dummy_coord, &dummy_coord,
7091
7092 /* Position relative to scroll bar. */
7093 &win_x, &win_y,
7094
7095 /* Mouse buttons and modifier keys. */
7096 &dummy_mask))
7097 {
7098 int top_range = VERTICAL_SCROLL_BAR_TOP_RANGE (f, bar->height);
7099
7100 win_y -= VERTICAL_SCROLL_BAR_TOP_BORDER;
7101
7102 if (bar->dragging != -1)
7103 win_y -= bar->dragging;
7104
7105 if (win_y < 0)
7106 win_y = 0;
7107 if (win_y > top_range)
7108 win_y = top_range;
7109
7110 *fp = f;
7111 *bar_window = bar->window;
7112
7113 if (bar->dragging != -1)
7114 *part = scroll_bar_handle;
7115 else if (win_y < bar->start)
7116 *part = scroll_bar_above_handle;
7117 else if (win_y < bar->end + VERTICAL_SCROLL_BAR_MIN_HANDLE)
7118 *part = scroll_bar_handle;
7119 else
7120 *part = scroll_bar_below_handle;
7121
7122 XSETINT (*x, win_y);
7123 XSETINT (*y, top_range);
7124
7125 f->mouse_moved = false;
7126 dpyinfo->last_mouse_scroll_bar = NULL;
7127 *timestamp = dpyinfo->last_mouse_movement_time;
7128 }
7129
7130 unblock_input ();
7131 }
7132
7133
7134 /* Return information to the user about the current position of the mouse
7135 on the scroll bar. */
7136
7137 static void
7138 x_horizontal_scroll_bar_report_motion (struct frame **fp, Lisp_Object *bar_window,
7139 enum scroll_bar_part *part, Lisp_Object *x,
7140 Lisp_Object *y, Time *timestamp)
7141 {
7142 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (*fp);
7143 struct scroll_bar *bar = dpyinfo->last_mouse_scroll_bar;
7144 Window w = bar->x_window;
7145 struct frame *f = XFRAME (WINDOW_FRAME (XWINDOW (bar->window)));
7146 int win_x, win_y;
7147 Window dummy_window;
7148 int dummy_coord;
7149 unsigned int dummy_mask;
7150
7151 block_input ();
7152
7153 /* Get the mouse's position relative to the scroll bar window, and
7154 report that. */
7155 if (XQueryPointer (FRAME_X_DISPLAY (f), w,
7156
7157 /* Root, child, root x and root y. */
7158 &dummy_window, &dummy_window,
7159 &dummy_coord, &dummy_coord,
7160
7161 /* Position relative to scroll bar. */
7162 &win_x, &win_y,
7163
7164 /* Mouse buttons and modifier keys. */
7165 &dummy_mask))
7166 {
7167 int left_range = HORIZONTAL_SCROLL_BAR_LEFT_RANGE (f, bar->width);
7168
7169 win_x -= HORIZONTAL_SCROLL_BAR_LEFT_BORDER;
7170
7171 if (bar->dragging != -1)
7172 win_x -= bar->dragging;
7173
7174 if (win_x < 0)
7175 win_x = 0;
7176 if (win_x > left_range)
7177 win_x = left_range;
7178
7179 *fp = f;
7180 *bar_window = bar->window;
7181
7182 if (bar->dragging != -1)
7183 *part = scroll_bar_horizontal_handle;
7184 else if (win_x < bar->start)
7185 *part = scroll_bar_before_handle;
7186 else if (win_x < bar->end + HORIZONTAL_SCROLL_BAR_MIN_HANDLE)
7187 *part = scroll_bar_handle;
7188 else
7189 *part = scroll_bar_after_handle;
7190
7191 XSETINT (*y, win_x);
7192 XSETINT (*x, left_range);
7193
7194 f->mouse_moved = false;
7195 dpyinfo->last_mouse_scroll_bar = NULL;
7196 *timestamp = dpyinfo->last_mouse_movement_time;
7197 }
7198
7199 unblock_input ();
7200 }
7201
7202
7203 /* The screen has been cleared so we may have changed foreground or
7204 background colors, and the scroll bars may need to be redrawn.
7205 Clear out the scroll bars, and ask for expose events, so we can
7206 redraw them. */
7207
7208 static void
7209 x_scroll_bar_clear (struct frame *f)
7210 {
7211 #ifndef USE_TOOLKIT_SCROLL_BARS
7212 Lisp_Object bar;
7213
7214 /* We can have scroll bars even if this is 0,
7215 if we just turned off scroll bar mode.
7216 But in that case we should not clear them. */
7217 if (FRAME_HAS_VERTICAL_SCROLL_BARS (f))
7218 for (bar = FRAME_SCROLL_BARS (f); VECTORP (bar);
7219 bar = XSCROLL_BAR (bar)->next)
7220 XClearArea (FRAME_X_DISPLAY (f),
7221 XSCROLL_BAR (bar)->x_window,
7222 0, 0, 0, 0, True);
7223 #endif /* not USE_TOOLKIT_SCROLL_BARS */
7224 }
7225
7226 #ifdef ENABLE_CHECKING
7227
7228 /* Record the last 100 characters stored
7229 to help debug the loss-of-chars-during-GC problem. */
7230
7231 static int temp_index;
7232 static short temp_buffer[100];
7233
7234 #define STORE_KEYSYM_FOR_DEBUG(keysym) \
7235 if (temp_index == ARRAYELTS (temp_buffer)) \
7236 temp_index = 0; \
7237 temp_buffer[temp_index++] = (keysym)
7238
7239 #else /* not ENABLE_CHECKING */
7240
7241 #define STORE_KEYSYM_FOR_DEBUG(keysym) ((void)0)
7242
7243 #endif /* ENABLE_CHECKING */
7244
7245 /* Set this to nonzero to fake an "X I/O error"
7246 on a particular display. */
7247
7248 static struct x_display_info *XTread_socket_fake_io_error;
7249
7250 /* When we find no input here, we occasionally do a no-op command
7251 to verify that the X server is still running and we can still talk with it.
7252 We try all the open displays, one by one.
7253 This variable is used for cycling thru the displays. */
7254
7255 static struct x_display_info *next_noop_dpyinfo;
7256
7257 enum
7258 {
7259 X_EVENT_NORMAL,
7260 X_EVENT_GOTO_OUT,
7261 X_EVENT_DROP
7262 };
7263
7264 /* Filter events for the current X input method.
7265 DPYINFO is the display this event is for.
7266 EVENT is the X event to filter.
7267
7268 Returns non-zero if the event was filtered, caller shall not process
7269 this event further.
7270 Returns zero if event is wasn't filtered. */
7271
7272 #ifdef HAVE_X_I18N
7273 static int
7274 x_filter_event (struct x_display_info *dpyinfo, XEvent *event)
7275 {
7276 /* XFilterEvent returns non-zero if the input method has
7277 consumed the event. We pass the frame's X window to
7278 XFilterEvent because that's the one for which the IC
7279 was created. */
7280
7281 struct frame *f1 = x_any_window_to_frame (dpyinfo,
7282 event->xclient.window);
7283
7284 return XFilterEvent (event, f1 ? FRAME_X_WINDOW (f1) : None);
7285 }
7286 #endif
7287
7288 #ifdef USE_GTK
7289 static int current_count;
7290 static int current_finish;
7291 static struct input_event *current_hold_quit;
7292
7293 /* This is the filter function invoked by the GTK event loop.
7294 It is invoked before the XEvent is translated to a GdkEvent,
7295 so we have a chance to act on the event before GTK. */
7296 static GdkFilterReturn
7297 event_handler_gdk (GdkXEvent *gxev, GdkEvent *ev, gpointer data)
7298 {
7299 XEvent *xev = (XEvent *) gxev;
7300
7301 block_input ();
7302 if (current_count >= 0)
7303 {
7304 struct x_display_info *dpyinfo;
7305
7306 dpyinfo = x_display_info_for_display (xev->xany.display);
7307
7308 #ifdef HAVE_X_I18N
7309 /* Filter events for the current X input method.
7310 GTK calls XFilterEvent but not for key press and release,
7311 so we do it here. */
7312 if ((xev->type == KeyPress || xev->type == KeyRelease)
7313 && dpyinfo
7314 && x_filter_event (dpyinfo, xev))
7315 {
7316 unblock_input ();
7317 return GDK_FILTER_REMOVE;
7318 }
7319 #endif
7320
7321 if (! dpyinfo)
7322 current_finish = X_EVENT_NORMAL;
7323 else
7324 current_count
7325 += handle_one_xevent (dpyinfo, xev, &current_finish,
7326 current_hold_quit);
7327 }
7328 else
7329 current_finish = x_dispatch_event (xev, xev->xany.display);
7330
7331 unblock_input ();
7332
7333 if (current_finish == X_EVENT_GOTO_OUT || current_finish == X_EVENT_DROP)
7334 return GDK_FILTER_REMOVE;
7335
7336 return GDK_FILTER_CONTINUE;
7337 }
7338 #endif /* USE_GTK */
7339
7340
7341 static void xembed_send_message (struct frame *f, Time,
7342 enum xembed_message,
7343 long detail, long data1, long data2);
7344
7345 static void
7346 x_net_wm_state (struct frame *f, Window window)
7347 {
7348 int value = FULLSCREEN_NONE;
7349 Lisp_Object lval = Qnil;
7350 bool sticky = false;
7351
7352 get_current_wm_state (f, window, &value, &sticky);
7353
7354 switch (value)
7355 {
7356 case FULLSCREEN_WIDTH:
7357 lval = Qfullwidth;
7358 break;
7359 case FULLSCREEN_HEIGHT:
7360 lval = Qfullheight;
7361 break;
7362 case FULLSCREEN_BOTH:
7363 lval = Qfullboth;
7364 break;
7365 case FULLSCREEN_MAXIMIZED:
7366 lval = Qmaximized;
7367 break;
7368 }
7369
7370 frame_size_history_add
7371 (f, Qx_net_wm_state, 0, 0,
7372 list2 (get_frame_param (f, Qfullscreen), lval));
7373
7374 store_frame_param (f, Qfullscreen, lval);
7375 /** store_frame_param (f, Qsticky, sticky ? Qt : Qnil); **/
7376 }
7377
7378 /* Handles the XEvent EVENT on display DPYINFO.
7379
7380 *FINISH is X_EVENT_GOTO_OUT if caller should stop reading events.
7381 *FINISH is zero if caller should continue reading events.
7382 *FINISH is X_EVENT_DROP if event should not be passed to the toolkit.
7383 *EVENT is unchanged unless we're processing KeyPress event.
7384
7385 We return the number of characters stored into the buffer. */
7386
7387 static int
7388 handle_one_xevent (struct x_display_info *dpyinfo,
7389 const XEvent *event,
7390 int *finish, struct input_event *hold_quit)
7391 {
7392 union {
7393 struct input_event ie;
7394 struct selection_input_event sie;
7395 } inev;
7396 int count = 0;
7397 int do_help = 0;
7398 ptrdiff_t nbytes = 0;
7399 struct frame *any, *f = NULL;
7400 struct coding_system coding;
7401 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
7402 /* This holds the state XLookupString needs to implement dead keys
7403 and other tricks known as "compose processing". _X Window System_
7404 says that a portable program can't use this, but Stephen Gildea assures
7405 me that letting the compiler initialize it to zeros will work okay. */
7406 static XComposeStatus compose_status;
7407
7408 USE_SAFE_ALLOCA;
7409
7410 *finish = X_EVENT_NORMAL;
7411
7412 EVENT_INIT (inev.ie);
7413 inev.ie.kind = NO_EVENT;
7414 inev.ie.arg = Qnil;
7415
7416 any = x_any_window_to_frame (dpyinfo, event->xany.window);
7417
7418 if (any && any->wait_event_type == event->type)
7419 any->wait_event_type = 0; /* Indicates we got it. */
7420
7421 switch (event->type)
7422 {
7423 case ClientMessage:
7424 {
7425 if (event->xclient.message_type == dpyinfo->Xatom_wm_protocols
7426 && event->xclient.format == 32)
7427 {
7428 if (event->xclient.data.l[0] == dpyinfo->Xatom_wm_take_focus)
7429 {
7430 /* Use the value returned by x_any_window_to_frame
7431 because this could be the shell widget window
7432 if the frame has no title bar. */
7433 f = any;
7434 #ifdef HAVE_X_I18N
7435 /* Not quite sure this is needed -pd */
7436 if (f && FRAME_XIC (f))
7437 XSetICFocus (FRAME_XIC (f));
7438 #endif
7439 #if false
7440 /* Emacs sets WM hints whose `input' field is `true'. This
7441 instructs the WM to set the input focus automatically for
7442 Emacs with a call to XSetInputFocus. Setting WM_TAKE_FOCUS
7443 tells the WM to send us a ClientMessage WM_TAKE_FOCUS after
7444 it has set the focus. So, XSetInputFocus below is not
7445 needed.
7446
7447 The call to XSetInputFocus below has also caused trouble. In
7448 cases where the XSetInputFocus done by the WM and the one
7449 below are temporally close (on a fast machine), the call
7450 below can generate additional FocusIn events which confuse
7451 Emacs. */
7452
7453 /* Since we set WM_TAKE_FOCUS, we must call
7454 XSetInputFocus explicitly. But not if f is null,
7455 since that might be an event for a deleted frame. */
7456 if (f)
7457 {
7458 Display *d = event->xclient.display;
7459 /* Catch and ignore errors, in case window has been
7460 iconified by a window manager such as GWM. */
7461 x_catch_errors (d);
7462 XSetInputFocus (d, event->xclient.window,
7463 /* The ICCCM says this is
7464 the only valid choice. */
7465 RevertToParent,
7466 event->xclient.data.l[1]);
7467 /* This is needed to detect the error
7468 if there is an error. */
7469 XSync (d, False);
7470 x_uncatch_errors ();
7471 }
7472 /* Not certain about handling scroll bars here */
7473 #endif
7474 goto done;
7475 }
7476
7477 if (event->xclient.data.l[0] == dpyinfo->Xatom_wm_save_yourself)
7478 {
7479 /* Save state modify the WM_COMMAND property to
7480 something which can reinstate us. This notifies
7481 the session manager, who's looking for such a
7482 PropertyNotify. Can restart processing when
7483 a keyboard or mouse event arrives. */
7484 /* If we have a session manager, don't set this.
7485 KDE will then start two Emacsen, one for the
7486 session manager and one for this. */
7487 #ifdef HAVE_X_SM
7488 if (! x_session_have_connection ())
7489 #endif
7490 {
7491 f = x_top_window_to_frame (dpyinfo,
7492 event->xclient.window);
7493 /* This is just so we only give real data once
7494 for a single Emacs process. */
7495 if (f == SELECTED_FRAME ())
7496 XSetCommand (FRAME_X_DISPLAY (f),
7497 event->xclient.window,
7498 initial_argv, initial_argc);
7499 else if (f)
7500 XSetCommand (FRAME_X_DISPLAY (f),
7501 event->xclient.window,
7502 0, 0);
7503 }
7504 goto done;
7505 }
7506
7507 if (event->xclient.data.l[0] == dpyinfo->Xatom_wm_delete_window)
7508 {
7509 f = any;
7510 if (!f)
7511 goto OTHER; /* May be a dialog that is to be removed */
7512
7513 inev.ie.kind = DELETE_WINDOW_EVENT;
7514 XSETFRAME (inev.ie.frame_or_window, f);
7515 goto done;
7516 }
7517
7518 goto done;
7519 }
7520
7521 if (event->xclient.message_type == dpyinfo->Xatom_wm_configure_denied)
7522 goto done;
7523
7524 if (event->xclient.message_type == dpyinfo->Xatom_wm_window_moved)
7525 {
7526 int new_x, new_y;
7527 f = x_window_to_frame (dpyinfo, event->xclient.window);
7528
7529 new_x = event->xclient.data.s[0];
7530 new_y = event->xclient.data.s[1];
7531
7532 if (f)
7533 {
7534 f->left_pos = new_x;
7535 f->top_pos = new_y;
7536 }
7537 goto done;
7538 }
7539
7540 #ifdef HACK_EDITRES
7541 if (event->xclient.message_type == dpyinfo->Xatom_editres)
7542 {
7543 f = any;
7544 if (f)
7545 _XEditResCheckMessages (f->output_data.x->widget,
7546 NULL, (XEvent *) event, NULL);
7547 goto done;
7548 }
7549 #endif /* HACK_EDITRES */
7550
7551 if (event->xclient.message_type == dpyinfo->Xatom_DONE
7552 || event->xclient.message_type == dpyinfo->Xatom_PAGE)
7553 {
7554 /* Ghostview job completed. Kill it. We could
7555 reply with "Next" if we received "Page", but we
7556 currently never do because we are interested in
7557 images, only, which should have 1 page. */
7558 Pixmap pixmap = (Pixmap) event->xclient.data.l[1];
7559 f = x_window_to_frame (dpyinfo, event->xclient.window);
7560 if (!f)
7561 goto OTHER;
7562 x_kill_gs_process (pixmap, f);
7563 expose_frame (f, 0, 0, 0, 0);
7564 goto done;
7565 }
7566
7567 #ifdef USE_TOOLKIT_SCROLL_BARS
7568 /* Scroll bar callbacks send a ClientMessage from which
7569 we construct an input_event. */
7570 if (event->xclient.message_type == dpyinfo->Xatom_Scrollbar)
7571 {
7572 x_scroll_bar_to_input_event (event, &inev.ie);
7573 *finish = X_EVENT_GOTO_OUT;
7574 goto done;
7575 }
7576 else if (event->xclient.message_type == dpyinfo->Xatom_Horizontal_Scrollbar)
7577 {
7578 x_horizontal_scroll_bar_to_input_event (event, &inev.ie);
7579 *finish = X_EVENT_GOTO_OUT;
7580 goto done;
7581 }
7582 #endif /* USE_TOOLKIT_SCROLL_BARS */
7583
7584 /* XEmbed messages from the embedder (if any). */
7585 if (event->xclient.message_type == dpyinfo->Xatom_XEMBED)
7586 {
7587 enum xembed_message msg = event->xclient.data.l[1];
7588 if (msg == XEMBED_FOCUS_IN || msg == XEMBED_FOCUS_OUT)
7589 x_detect_focus_change (dpyinfo, any, event, &inev.ie);
7590
7591 *finish = X_EVENT_GOTO_OUT;
7592 goto done;
7593 }
7594
7595 xft_settings_event (dpyinfo, event);
7596
7597 f = any;
7598 if (!f)
7599 goto OTHER;
7600 if (x_handle_dnd_message (f, &event->xclient, dpyinfo, &inev.ie))
7601 *finish = X_EVENT_DROP;
7602 }
7603 break;
7604
7605 case SelectionNotify:
7606 x_display_set_last_user_time (dpyinfo, event->xselection.time);
7607 #ifdef USE_X_TOOLKIT
7608 if (! x_window_to_frame (dpyinfo, event->xselection.requestor))
7609 goto OTHER;
7610 #endif /* not USE_X_TOOLKIT */
7611 x_handle_selection_notify (&event->xselection);
7612 break;
7613
7614 case SelectionClear: /* Someone has grabbed ownership. */
7615 x_display_set_last_user_time (dpyinfo, event->xselectionclear.time);
7616 #ifdef USE_X_TOOLKIT
7617 if (! x_window_to_frame (dpyinfo, event->xselectionclear.window))
7618 goto OTHER;
7619 #endif /* USE_X_TOOLKIT */
7620 {
7621 const XSelectionClearEvent *eventp = &event->xselectionclear;
7622
7623 inev.ie.kind = SELECTION_CLEAR_EVENT;
7624 SELECTION_EVENT_DPYINFO (&inev.sie) = dpyinfo;
7625 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
7626 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
7627 }
7628 break;
7629
7630 case SelectionRequest: /* Someone wants our selection. */
7631 x_display_set_last_user_time (dpyinfo, event->xselectionrequest.time);
7632 #ifdef USE_X_TOOLKIT
7633 if (!x_window_to_frame (dpyinfo, event->xselectionrequest.owner))
7634 goto OTHER;
7635 #endif /* USE_X_TOOLKIT */
7636 {
7637 const XSelectionRequestEvent *eventp = &event->xselectionrequest;
7638
7639 inev.ie.kind = SELECTION_REQUEST_EVENT;
7640 SELECTION_EVENT_DPYINFO (&inev.sie) = dpyinfo;
7641 SELECTION_EVENT_REQUESTOR (&inev.sie) = eventp->requestor;
7642 SELECTION_EVENT_SELECTION (&inev.sie) = eventp->selection;
7643 SELECTION_EVENT_TARGET (&inev.sie) = eventp->target;
7644 SELECTION_EVENT_PROPERTY (&inev.sie) = eventp->property;
7645 SELECTION_EVENT_TIME (&inev.sie) = eventp->time;
7646 }
7647 break;
7648
7649 case PropertyNotify:
7650 x_display_set_last_user_time (dpyinfo, event->xproperty.time);
7651 f = x_top_window_to_frame (dpyinfo, event->xproperty.window);
7652 if (f && event->xproperty.atom == dpyinfo->Xatom_net_wm_state)
7653 {
7654 bool not_hidden = x_handle_net_wm_state (f, &event->xproperty);
7655 if (not_hidden && FRAME_ICONIFIED_P (f))
7656 {
7657 /* Gnome shell does not iconify us when C-z is pressed.
7658 It hides the frame. So if our state says we aren't
7659 hidden anymore, treat it as deiconified. */
7660 SET_FRAME_VISIBLE (f, 1);
7661 SET_FRAME_ICONIFIED (f, false);
7662 f->output_data.x->has_been_visible = true;
7663 inev.ie.kind = DEICONIFY_EVENT;
7664 XSETFRAME (inev.ie.frame_or_window, f);
7665 }
7666 else if (! not_hidden && ! FRAME_ICONIFIED_P (f))
7667 {
7668 SET_FRAME_VISIBLE (f, 0);
7669 SET_FRAME_ICONIFIED (f, true);
7670 inev.ie.kind = ICONIFY_EVENT;
7671 XSETFRAME (inev.ie.frame_or_window, f);
7672 }
7673 }
7674
7675 x_handle_property_notify (&event->xproperty);
7676 xft_settings_event (dpyinfo, event);
7677 goto OTHER;
7678
7679 case ReparentNotify:
7680 f = x_top_window_to_frame (dpyinfo, event->xreparent.window);
7681 if (f)
7682 {
7683 f->output_data.x->parent_desc = event->xreparent.parent;
7684 x_real_positions (f, &f->left_pos, &f->top_pos);
7685
7686 /* Perhaps reparented due to a WM restart. Reset this. */
7687 FRAME_DISPLAY_INFO (f)->wm_type = X_WMTYPE_UNKNOWN;
7688 FRAME_DISPLAY_INFO (f)->net_supported_window = 0;
7689
7690 x_set_frame_alpha (f);
7691 }
7692 goto OTHER;
7693
7694 case Expose:
7695 f = x_window_to_frame (dpyinfo, event->xexpose.window);
7696 if (f)
7697 {
7698 if (!FRAME_VISIBLE_P (f))
7699 {
7700 SET_FRAME_VISIBLE (f, 1);
7701 SET_FRAME_ICONIFIED (f, false);
7702 f->output_data.x->has_been_visible = true;
7703 SET_FRAME_GARBAGED (f);
7704 }
7705 else
7706 {
7707 #if defined (USE_GTK) && ! defined (HAVE_GTK3) && ! defined (USE_CAIRO)
7708 /* This seems to be needed for GTK 2.6 and later, see
7709 http://debbugs.gnu.org/cgi/bugreport.cgi?bug=15398. */
7710 x_clear_area (f,
7711 event->xexpose.x, event->xexpose.y,
7712 event->xexpose.width, event->xexpose.height);
7713 #endif
7714 expose_frame (f, event->xexpose.x, event->xexpose.y,
7715 event->xexpose.width, event->xexpose.height);
7716 }
7717 }
7718 else
7719 {
7720 #ifndef USE_TOOLKIT_SCROLL_BARS
7721 struct scroll_bar *bar;
7722 #endif
7723 #if defined USE_LUCID
7724 /* Submenus of the Lucid menu bar aren't widgets
7725 themselves, so there's no way to dispatch events
7726 to them. Recognize this case separately. */
7727 {
7728 Widget widget = x_window_to_menu_bar (event->xexpose.window);
7729 if (widget)
7730 xlwmenu_redisplay (widget);
7731 }
7732 #endif /* USE_LUCID */
7733
7734 #ifdef USE_TOOLKIT_SCROLL_BARS
7735 /* Dispatch event to the widget. */
7736 goto OTHER;
7737 #else /* not USE_TOOLKIT_SCROLL_BARS */
7738 bar = x_window_to_scroll_bar (event->xexpose.display,
7739 event->xexpose.window, 2);
7740
7741 if (bar)
7742 x_scroll_bar_expose (bar, event);
7743 #ifdef USE_X_TOOLKIT
7744 else
7745 goto OTHER;
7746 #endif /* USE_X_TOOLKIT */
7747 #endif /* not USE_TOOLKIT_SCROLL_BARS */
7748 }
7749 break;
7750
7751 case GraphicsExpose: /* This occurs when an XCopyArea's
7752 source area was obscured or not
7753 available. */
7754 f = x_window_to_frame (dpyinfo, event->xgraphicsexpose.drawable);
7755 if (f)
7756 expose_frame (f, event->xgraphicsexpose.x,
7757 event->xgraphicsexpose.y,
7758 event->xgraphicsexpose.width,
7759 event->xgraphicsexpose.height);
7760 #ifdef USE_X_TOOLKIT
7761 else
7762 goto OTHER;
7763 #endif /* USE_X_TOOLKIT */
7764 break;
7765
7766 case NoExpose: /* This occurs when an XCopyArea's
7767 source area was completely
7768 available. */
7769 break;
7770
7771 case UnmapNotify:
7772 /* Redo the mouse-highlight after the tooltip has gone. */
7773 if (event->xunmap.window == tip_window)
7774 {
7775 tip_window = 0;
7776 x_redo_mouse_highlight (dpyinfo);
7777 }
7778
7779 f = x_top_window_to_frame (dpyinfo, event->xunmap.window);
7780 if (f) /* F may no longer exist if
7781 the frame was deleted. */
7782 {
7783 bool visible = FRAME_VISIBLE_P (f);
7784 /* While a frame is unmapped, display generation is
7785 disabled; you don't want to spend time updating a
7786 display that won't ever be seen. */
7787 SET_FRAME_VISIBLE (f, 0);
7788 /* We can't distinguish, from the event, whether the window
7789 has become iconified or invisible. So assume, if it
7790 was previously visible, than now it is iconified.
7791 But x_make_frame_invisible clears both
7792 the visible flag and the iconified flag;
7793 and that way, we know the window is not iconified now. */
7794 if (visible || FRAME_ICONIFIED_P (f))
7795 {
7796 SET_FRAME_ICONIFIED (f, true);
7797 inev.ie.kind = ICONIFY_EVENT;
7798 XSETFRAME (inev.ie.frame_or_window, f);
7799 }
7800 }
7801 goto OTHER;
7802
7803 case MapNotify:
7804 /* We use x_top_window_to_frame because map events can
7805 come for sub-windows and they don't mean that the
7806 frame is visible. */
7807 f = x_top_window_to_frame (dpyinfo, event->xmap.window);
7808 if (f)
7809 {
7810 bool iconified = FRAME_ICONIFIED_P (f);
7811
7812 /* Check if fullscreen was specified before we where mapped the
7813 first time, i.e. from the command line. */
7814 if (!f->output_data.x->has_been_visible)
7815 x_check_fullscreen (f);
7816
7817 SET_FRAME_VISIBLE (f, 1);
7818 SET_FRAME_ICONIFIED (f, false);
7819 f->output_data.x->has_been_visible = true;
7820
7821 if (iconified)
7822 {
7823 inev.ie.kind = DEICONIFY_EVENT;
7824 XSETFRAME (inev.ie.frame_or_window, f);
7825 }
7826 else if (! NILP (Vframe_list) && ! NILP (XCDR (Vframe_list)))
7827 /* Force a redisplay sooner or later to update the
7828 frame titles in case this is the second frame. */
7829 record_asynch_buffer_change ();
7830
7831 #ifdef USE_GTK
7832 xg_frame_resized (f, -1, -1);
7833 #endif
7834 }
7835 goto OTHER;
7836
7837 case KeyPress:
7838
7839 x_display_set_last_user_time (dpyinfo, event->xkey.time);
7840 ignore_next_mouse_click_timeout = 0;
7841
7842 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
7843 /* Dispatch KeyPress events when in menu. */
7844 if (popup_activated ())
7845 goto OTHER;
7846 #endif
7847
7848 f = any;
7849
7850 /* If mouse-highlight is an integer, input clears out
7851 mouse highlighting. */
7852 if (!hlinfo->mouse_face_hidden && INTEGERP (Vmouse_highlight)
7853 #if ! defined (USE_GTK)
7854 && (f == 0
7855 || !EQ (f->tool_bar_window, hlinfo->mouse_face_window))
7856 #endif
7857 )
7858 {
7859 clear_mouse_face (hlinfo);
7860 hlinfo->mouse_face_hidden = true;
7861 }
7862
7863 #if defined USE_MOTIF && defined USE_TOOLKIT_SCROLL_BARS
7864 if (f == 0)
7865 {
7866 /* Scroll bars consume key events, but we want
7867 the keys to go to the scroll bar's frame. */
7868 Widget widget = XtWindowToWidget (dpyinfo->display,
7869 event->xkey.window);
7870 if (widget && XmIsScrollBar (widget))
7871 {
7872 widget = XtParent (widget);
7873 f = x_any_window_to_frame (dpyinfo, XtWindow (widget));
7874 }
7875 }
7876 #endif /* USE_MOTIF and USE_TOOLKIT_SCROLL_BARS */
7877
7878 if (f != 0)
7879 {
7880 KeySym keysym, orig_keysym;
7881 /* al%imercury@uunet.uu.net says that making this 81
7882 instead of 80 fixed a bug whereby meta chars made
7883 his Emacs hang.
7884
7885 It seems that some version of XmbLookupString has
7886 a bug of not returning XBufferOverflow in
7887 status_return even if the input is too long to
7888 fit in 81 bytes. So, we must prepare sufficient
7889 bytes for copy_buffer. 513 bytes (256 chars for
7890 two-byte character set) seems to be a fairly good
7891 approximation. -- 2000.8.10 handa@etl.go.jp */
7892 unsigned char copy_buffer[513];
7893 unsigned char *copy_bufptr = copy_buffer;
7894 int copy_bufsiz = sizeof (copy_buffer);
7895 int modifiers;
7896 Lisp_Object coding_system = Qlatin_1;
7897 Lisp_Object c;
7898 /* Event will be modified. */
7899 XKeyEvent xkey = event->xkey;
7900
7901 #ifdef USE_GTK
7902 /* Don't pass keys to GTK. A Tab will shift focus to the
7903 tool bar in GTK 2.4. Keys will still go to menus and
7904 dialogs because in that case popup_activated is nonzero
7905 (see above). */
7906 *finish = X_EVENT_DROP;
7907 #endif
7908
7909 xkey.state |= x_emacs_to_x_modifiers (FRAME_DISPLAY_INFO (f),
7910 extra_keyboard_modifiers);
7911 modifiers = xkey.state;
7912
7913 /* This will have to go some day... */
7914
7915 /* make_lispy_event turns chars into control chars.
7916 Don't do it here because XLookupString is too eager. */
7917 xkey.state &= ~ControlMask;
7918 xkey.state &= ~(dpyinfo->meta_mod_mask
7919 | dpyinfo->super_mod_mask
7920 | dpyinfo->hyper_mod_mask
7921 | dpyinfo->alt_mod_mask);
7922
7923 /* In case Meta is ComposeCharacter,
7924 clear its status. According to Markus Ehrnsperger
7925 Markus.Ehrnsperger@lehrstuhl-bross.physik.uni-muenchen.de
7926 this enables ComposeCharacter to work whether or
7927 not it is combined with Meta. */
7928 if (modifiers & dpyinfo->meta_mod_mask)
7929 memset (&compose_status, 0, sizeof (compose_status));
7930
7931 #ifdef HAVE_X_I18N
7932 if (FRAME_XIC (f))
7933 {
7934 Status status_return;
7935
7936 coding_system = Vlocale_coding_system;
7937 nbytes = XmbLookupString (FRAME_XIC (f),
7938 &xkey, (char *) copy_bufptr,
7939 copy_bufsiz, &keysym,
7940 &status_return);
7941 if (status_return == XBufferOverflow)
7942 {
7943 copy_bufsiz = nbytes + 1;
7944 copy_bufptr = alloca (copy_bufsiz);
7945 nbytes = XmbLookupString (FRAME_XIC (f),
7946 &xkey, (char *) copy_bufptr,
7947 copy_bufsiz, &keysym,
7948 &status_return);
7949 }
7950 /* Xutf8LookupString is a new but already deprecated interface. -stef */
7951 if (status_return == XLookupNone)
7952 break;
7953 else if (status_return == XLookupChars)
7954 {
7955 keysym = NoSymbol;
7956 modifiers = 0;
7957 }
7958 else if (status_return != XLookupKeySym
7959 && status_return != XLookupBoth)
7960 emacs_abort ();
7961 }
7962 else
7963 nbytes = XLookupString (&xkey, (char *) copy_bufptr,
7964 copy_bufsiz, &keysym,
7965 &compose_status);
7966 #else
7967 nbytes = XLookupString (&xkey, (char *) copy_bufptr,
7968 copy_bufsiz, &keysym,
7969 &compose_status);
7970 #endif
7971
7972 /* If not using XIM/XIC, and a compose sequence is in progress,
7973 we break here. Otherwise, chars_matched is always 0. */
7974 if (compose_status.chars_matched > 0 && nbytes == 0)
7975 break;
7976
7977 memset (&compose_status, 0, sizeof (compose_status));
7978 orig_keysym = keysym;
7979
7980 /* Common for all keysym input events. */
7981 XSETFRAME (inev.ie.frame_or_window, f);
7982 inev.ie.modifiers
7983 = x_x_to_emacs_modifiers (FRAME_DISPLAY_INFO (f), modifiers);
7984 inev.ie.timestamp = xkey.time;
7985
7986 /* First deal with keysyms which have defined
7987 translations to characters. */
7988 if (keysym >= 32 && keysym < 128)
7989 /* Avoid explicitly decoding each ASCII character. */
7990 {
7991 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
7992 inev.ie.code = keysym;
7993 goto done_keysym;
7994 }
7995
7996 /* Keysyms directly mapped to Unicode characters. */
7997 if (keysym >= 0x01000000 && keysym <= 0x0110FFFF)
7998 {
7999 if (keysym < 0x01000080)
8000 inev.ie.kind = ASCII_KEYSTROKE_EVENT;
8001 else
8002 inev.ie.kind = MULTIBYTE_CHAR_KEYSTROKE_EVENT;
8003 inev.ie.code = keysym & 0xFFFFFF;
8004 goto done_keysym;
8005 }
8006
8007 /* Now non-ASCII. */
8008 if (HASH_TABLE_P (Vx_keysym_table)
8009 && (c = Fgethash (make_number (keysym),
8010 Vx_keysym_table,
8011 Qnil),
8012 NATNUMP (c)))
8013 {
8014 inev.ie.kind = (SINGLE_BYTE_CHAR_P (XFASTINT (c))
8015 ? ASCII_KEYSTROKE_EVENT
8016 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
8017 inev.ie.code = XFASTINT (c);
8018 goto done_keysym;
8019 }
8020
8021 /* Random non-modifier sorts of keysyms. */
8022 if (((keysym >= XK_BackSpace && keysym <= XK_Escape)
8023 || keysym == XK_Delete
8024 #ifdef XK_ISO_Left_Tab
8025 || (keysym >= XK_ISO_Left_Tab
8026 && keysym <= XK_ISO_Enter)
8027 #endif
8028 || IsCursorKey (keysym) /* 0xff50 <= x < 0xff60 */
8029 || IsMiscFunctionKey (keysym) /* 0xff60 <= x < VARIES */
8030 #ifdef HPUX
8031 /* This recognizes the "extended function
8032 keys". It seems there's no cleaner way.
8033 Test IsModifierKey to avoid handling
8034 mode_switch incorrectly. */
8035 || (XK_Select <= keysym && keysym < XK_KP_Space)
8036 #endif
8037 #ifdef XK_dead_circumflex
8038 || orig_keysym == XK_dead_circumflex
8039 #endif
8040 #ifdef XK_dead_grave
8041 || orig_keysym == XK_dead_grave
8042 #endif
8043 #ifdef XK_dead_tilde
8044 || orig_keysym == XK_dead_tilde
8045 #endif
8046 #ifdef XK_dead_diaeresis
8047 || orig_keysym == XK_dead_diaeresis
8048 #endif
8049 #ifdef XK_dead_macron
8050 || orig_keysym == XK_dead_macron
8051 #endif
8052 #ifdef XK_dead_degree
8053 || orig_keysym == XK_dead_degree
8054 #endif
8055 #ifdef XK_dead_acute
8056 || orig_keysym == XK_dead_acute
8057 #endif
8058 #ifdef XK_dead_cedilla
8059 || orig_keysym == XK_dead_cedilla
8060 #endif
8061 #ifdef XK_dead_breve
8062 || orig_keysym == XK_dead_breve
8063 #endif
8064 #ifdef XK_dead_ogonek
8065 || orig_keysym == XK_dead_ogonek
8066 #endif
8067 #ifdef XK_dead_caron
8068 || orig_keysym == XK_dead_caron
8069 #endif
8070 #ifdef XK_dead_doubleacute
8071 || orig_keysym == XK_dead_doubleacute
8072 #endif
8073 #ifdef XK_dead_abovedot
8074 || orig_keysym == XK_dead_abovedot
8075 #endif
8076 || IsKeypadKey (keysym) /* 0xff80 <= x < 0xffbe */
8077 || IsFunctionKey (keysym) /* 0xffbe <= x < 0xffe1 */
8078 /* Any "vendor-specific" key is ok. */
8079 || (orig_keysym & (1 << 28))
8080 || (keysym != NoSymbol && nbytes == 0))
8081 && ! (IsModifierKey (orig_keysym)
8082 /* The symbols from XK_ISO_Lock
8083 to XK_ISO_Last_Group_Lock
8084 don't have real modifiers but
8085 should be treated similarly to
8086 Mode_switch by Emacs. */
8087 #if defined XK_ISO_Lock && defined XK_ISO_Last_Group_Lock
8088 || (XK_ISO_Lock <= orig_keysym
8089 && orig_keysym <= XK_ISO_Last_Group_Lock)
8090 #endif
8091 ))
8092 {
8093 STORE_KEYSYM_FOR_DEBUG (keysym);
8094 /* make_lispy_event will convert this to a symbolic
8095 key. */
8096 inev.ie.kind = NON_ASCII_KEYSTROKE_EVENT;
8097 inev.ie.code = keysym;
8098 goto done_keysym;
8099 }
8100
8101 { /* Raw bytes, not keysym. */
8102 ptrdiff_t i;
8103 int nchars, len;
8104
8105 for (i = 0, nchars = 0; i < nbytes; i++)
8106 {
8107 if (ASCII_CHAR_P (copy_bufptr[i]))
8108 nchars++;
8109 STORE_KEYSYM_FOR_DEBUG (copy_bufptr[i]);
8110 }
8111
8112 if (nchars < nbytes)
8113 {
8114 /* Decode the input data. */
8115
8116 /* The input should be decoded with `coding_system'
8117 which depends on which X*LookupString function
8118 we used just above and the locale. */
8119 setup_coding_system (coding_system, &coding);
8120 coding.src_multibyte = false;
8121 coding.dst_multibyte = true;
8122 /* The input is converted to events, thus we can't
8123 handle composition. Anyway, there's no XIM that
8124 gives us composition information. */
8125 coding.common_flags &= ~CODING_ANNOTATION_MASK;
8126
8127 SAFE_NALLOCA (coding.destination, MAX_MULTIBYTE_LENGTH,
8128 nbytes);
8129 coding.dst_bytes = MAX_MULTIBYTE_LENGTH * nbytes;
8130 coding.mode |= CODING_MODE_LAST_BLOCK;
8131 decode_coding_c_string (&coding, copy_bufptr, nbytes, Qnil);
8132 nbytes = coding.produced;
8133 nchars = coding.produced_char;
8134 copy_bufptr = coding.destination;
8135 }
8136
8137 /* Convert the input data to a sequence of
8138 character events. */
8139 for (i = 0; i < nbytes; i += len)
8140 {
8141 int ch;
8142 if (nchars == nbytes)
8143 ch = copy_bufptr[i], len = 1;
8144 else
8145 ch = STRING_CHAR_AND_LENGTH (copy_bufptr + i, len);
8146 inev.ie.kind = (SINGLE_BYTE_CHAR_P (ch)
8147 ? ASCII_KEYSTROKE_EVENT
8148 : MULTIBYTE_CHAR_KEYSTROKE_EVENT);
8149 inev.ie.code = ch;
8150 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
8151 }
8152
8153 count += nchars;
8154
8155 inev.ie.kind = NO_EVENT; /* Already stored above. */
8156
8157 if (keysym == NoSymbol)
8158 break;
8159 }
8160 /* FIXME: check side effects and remove this. */
8161 ((XEvent *) event)->xkey = xkey;
8162 }
8163 done_keysym:
8164 #ifdef HAVE_X_I18N
8165 /* Don't dispatch this event since XtDispatchEvent calls
8166 XFilterEvent, and two calls in a row may freeze the
8167 client. */
8168 break;
8169 #else
8170 goto OTHER;
8171 #endif
8172
8173 case KeyRelease:
8174 x_display_set_last_user_time (dpyinfo, event->xkey.time);
8175 #ifdef HAVE_X_I18N
8176 /* Don't dispatch this event since XtDispatchEvent calls
8177 XFilterEvent, and two calls in a row may freeze the
8178 client. */
8179 break;
8180 #else
8181 goto OTHER;
8182 #endif
8183
8184 case EnterNotify:
8185 x_display_set_last_user_time (dpyinfo, event->xcrossing.time);
8186 x_detect_focus_change (dpyinfo, any, event, &inev.ie);
8187
8188 f = any;
8189
8190 if (f && x_mouse_click_focus_ignore_position)
8191 ignore_next_mouse_click_timeout = event->xmotion.time + 200;
8192
8193 /* EnterNotify counts as mouse movement,
8194 so update things that depend on mouse position. */
8195 if (f && !f->output_data.x->hourglass_p)
8196 note_mouse_movement (f, &event->xmotion);
8197 #ifdef USE_GTK
8198 /* We may get an EnterNotify on the buttons in the toolbar. In that
8199 case we moved out of any highlighted area and need to note this. */
8200 if (!f && dpyinfo->last_mouse_glyph_frame)
8201 note_mouse_movement (dpyinfo->last_mouse_glyph_frame, &event->xmotion);
8202 #endif
8203 goto OTHER;
8204
8205 case FocusIn:
8206 x_detect_focus_change (dpyinfo, any, event, &inev.ie);
8207 goto OTHER;
8208
8209 case LeaveNotify:
8210 x_display_set_last_user_time (dpyinfo, event->xcrossing.time);
8211 x_detect_focus_change (dpyinfo, any, event, &inev.ie);
8212
8213 f = x_top_window_to_frame (dpyinfo, event->xcrossing.window);
8214 if (f)
8215 {
8216 if (f == hlinfo->mouse_face_mouse_frame)
8217 {
8218 /* If we move outside the frame, then we're
8219 certainly no longer on any text in the frame. */
8220 clear_mouse_face (hlinfo);
8221 hlinfo->mouse_face_mouse_frame = 0;
8222 }
8223
8224 /* Generate a nil HELP_EVENT to cancel a help-echo.
8225 Do it only if there's something to cancel.
8226 Otherwise, the startup message is cleared when
8227 the mouse leaves the frame. */
8228 if (any_help_event_p)
8229 do_help = -1;
8230 }
8231 #ifdef USE_GTK
8232 /* See comment in EnterNotify above */
8233 else if (dpyinfo->last_mouse_glyph_frame)
8234 note_mouse_movement (dpyinfo->last_mouse_glyph_frame, &event->xmotion);
8235 #endif
8236 goto OTHER;
8237
8238 case FocusOut:
8239 x_detect_focus_change (dpyinfo, any, event, &inev.ie);
8240 goto OTHER;
8241
8242 case MotionNotify:
8243 {
8244 x_display_set_last_user_time (dpyinfo, event->xmotion.time);
8245 previous_help_echo_string = help_echo_string;
8246 help_echo_string = Qnil;
8247
8248 f = (x_mouse_grabbed (dpyinfo) ? dpyinfo->last_mouse_frame
8249 : x_window_to_frame (dpyinfo, event->xmotion.window));
8250
8251 if (hlinfo->mouse_face_hidden)
8252 {
8253 hlinfo->mouse_face_hidden = false;
8254 clear_mouse_face (hlinfo);
8255 }
8256
8257 #ifdef USE_GTK
8258 if (f && xg_event_is_for_scrollbar (f, event))
8259 f = 0;
8260 #endif
8261 if (f)
8262 {
8263
8264 /* Generate SELECT_WINDOW_EVENTs when needed.
8265 Don't let popup menus influence things (bug#1261). */
8266 if (!NILP (Vmouse_autoselect_window) && !popup_activated ())
8267 {
8268 static Lisp_Object last_mouse_window;
8269 Lisp_Object window = window_from_coordinates
8270 (f, event->xmotion.x, event->xmotion.y, 0, false);
8271
8272 /* Window will be selected only when it is not selected now and
8273 last mouse movement event was not in it. Minibuffer window
8274 will be selected only when it is active. */
8275 if (WINDOWP (window)
8276 && !EQ (window, last_mouse_window)
8277 && !EQ (window, selected_window)
8278 /* For click-to-focus window managers
8279 create event iff we don't leave the
8280 selected frame. */
8281 && (focus_follows_mouse
8282 || (EQ (XWINDOW (window)->frame,
8283 XWINDOW (selected_window)->frame))))
8284 {
8285 inev.ie.kind = SELECT_WINDOW_EVENT;
8286 inev.ie.frame_or_window = window;
8287 }
8288 /* Remember the last window where we saw the mouse. */
8289 last_mouse_window = window;
8290 }
8291 if (!note_mouse_movement (f, &event->xmotion))
8292 help_echo_string = previous_help_echo_string;
8293 }
8294 else
8295 {
8296 #ifndef USE_TOOLKIT_SCROLL_BARS
8297 struct scroll_bar *bar
8298 = x_window_to_scroll_bar (event->xmotion.display,
8299 event->xmotion.window, 2);
8300
8301 if (bar)
8302 x_scroll_bar_note_movement (bar, &event->xmotion);
8303 #endif /* USE_TOOLKIT_SCROLL_BARS */
8304
8305 /* If we move outside the frame, then we're
8306 certainly no longer on any text in the frame. */
8307 clear_mouse_face (hlinfo);
8308 }
8309
8310 /* If the contents of the global variable help_echo_string
8311 has changed, generate a HELP_EVENT. */
8312 if (!NILP (help_echo_string)
8313 || !NILP (previous_help_echo_string))
8314 do_help = 1;
8315 goto OTHER;
8316 }
8317
8318 case ConfigureNotify:
8319 f = x_top_window_to_frame (dpyinfo, event->xconfigure.window);
8320 #ifdef USE_CAIRO
8321 if (f) x_cr_destroy_surface (f);
8322 #endif
8323 #ifdef USE_GTK
8324 if (!f
8325 && (f = any)
8326 && event->xconfigure.window == FRAME_X_WINDOW (f))
8327 {
8328 xg_frame_resized (f, event->xconfigure.width,
8329 event->xconfigure.height);
8330 #ifdef USE_CAIRO
8331 x_cr_destroy_surface (f);
8332 #endif
8333 f = 0;
8334 }
8335 #endif
8336 if (f)
8337 {
8338 x_net_wm_state (f, event->xconfigure.window);
8339
8340 #ifdef USE_X_TOOLKIT
8341 /* Tip frames are pure X window, set size for them. */
8342 if (! NILP (tip_frame) && XFRAME (tip_frame) == f)
8343 {
8344 if (FRAME_PIXEL_HEIGHT (f) != event->xconfigure.height
8345 || FRAME_PIXEL_WIDTH (f) != event->xconfigure.width)
8346 SET_FRAME_GARBAGED (f);
8347 FRAME_PIXEL_HEIGHT (f) = event->xconfigure.height;
8348 FRAME_PIXEL_WIDTH (f) = event->xconfigure.width;
8349 }
8350 #endif
8351
8352 #ifndef USE_X_TOOLKIT
8353 #ifndef USE_GTK
8354 int width = FRAME_PIXEL_TO_TEXT_WIDTH (f, event->xconfigure.width);
8355 int height = FRAME_PIXEL_TO_TEXT_HEIGHT (f, event->xconfigure.height);
8356
8357 /* In the toolkit version, change_frame_size
8358 is called by the code that handles resizing
8359 of the EmacsFrame widget. */
8360
8361 /* Even if the number of character rows and columns has
8362 not changed, the font size may have changed, so we need
8363 to check the pixel dimensions as well. */
8364 if (width != FRAME_TEXT_WIDTH (f)
8365 || height != FRAME_TEXT_HEIGHT (f)
8366 || event->xconfigure.width != FRAME_PIXEL_WIDTH (f)
8367 || event->xconfigure.height != FRAME_PIXEL_HEIGHT (f))
8368 {
8369 change_frame_size (f, width, height, false, true, false, true);
8370 x_clear_under_internal_border (f);
8371 SET_FRAME_GARBAGED (f);
8372 cancel_mouse_face (f);
8373 }
8374 #endif /* not USE_GTK */
8375 #endif
8376
8377 #ifdef USE_GTK
8378 /* GTK creates windows but doesn't map them.
8379 Only get real positions when mapped. */
8380 if (FRAME_GTK_OUTER_WIDGET (f)
8381 && gtk_widget_get_mapped (FRAME_GTK_OUTER_WIDGET (f)))
8382 #endif
8383 x_real_positions (f, &f->left_pos, &f->top_pos);
8384
8385 #ifdef HAVE_X_I18N
8386 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMStatusArea))
8387 xic_set_statusarea (f);
8388 #endif
8389
8390 }
8391 goto OTHER;
8392
8393 case ButtonRelease:
8394 case ButtonPress:
8395 {
8396 /* If we decide we want to generate an event to be seen
8397 by the rest of Emacs, we put it here. */
8398 bool tool_bar_p = false;
8399
8400 memset (&compose_status, 0, sizeof (compose_status));
8401 dpyinfo->last_mouse_glyph_frame = NULL;
8402 x_display_set_last_user_time (dpyinfo, event->xbutton.time);
8403
8404 f = (x_mouse_grabbed (dpyinfo) ? dpyinfo->last_mouse_frame
8405 : x_window_to_frame (dpyinfo, event->xbutton.window));
8406
8407 #ifdef USE_GTK
8408 if (f && xg_event_is_for_scrollbar (f, event))
8409 f = 0;
8410 #endif
8411 if (f)
8412 {
8413 #if ! defined (USE_GTK)
8414 /* Is this in the tool-bar? */
8415 if (WINDOWP (f->tool_bar_window)
8416 && WINDOW_TOTAL_LINES (XWINDOW (f->tool_bar_window)))
8417 {
8418 Lisp_Object window;
8419 int x = event->xbutton.x;
8420 int y = event->xbutton.y;
8421
8422 window = window_from_coordinates (f, x, y, 0, true);
8423 tool_bar_p = EQ (window, f->tool_bar_window);
8424
8425 if (tool_bar_p && event->xbutton.button < 4)
8426 handle_tool_bar_click
8427 (f, x, y, event->xbutton.type == ButtonPress,
8428 x_x_to_emacs_modifiers (dpyinfo, event->xbutton.state));
8429 }
8430 #endif /* !USE_GTK */
8431
8432 if (!tool_bar_p)
8433 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
8434 if (! popup_activated ())
8435 #endif
8436 {
8437 if (ignore_next_mouse_click_timeout)
8438 {
8439 if (event->type == ButtonPress
8440 && event->xbutton.time > ignore_next_mouse_click_timeout)
8441 {
8442 ignore_next_mouse_click_timeout = 0;
8443 construct_mouse_click (&inev.ie, &event->xbutton, f);
8444 }
8445 if (event->type == ButtonRelease)
8446 ignore_next_mouse_click_timeout = 0;
8447 }
8448 else
8449 construct_mouse_click (&inev.ie, &event->xbutton, f);
8450 }
8451 if (FRAME_X_EMBEDDED_P (f))
8452 xembed_send_message (f, event->xbutton.time,
8453 XEMBED_REQUEST_FOCUS, 0, 0, 0);
8454 }
8455 else
8456 {
8457 struct scroll_bar *bar
8458 = x_window_to_scroll_bar (event->xbutton.display,
8459 event->xbutton.window, 2);
8460
8461 #ifdef USE_TOOLKIT_SCROLL_BARS
8462 /* Make the "Ctrl-Mouse-2 splits window" work for toolkit
8463 scroll bars. */
8464 if (bar && event->xbutton.state & ControlMask)
8465 {
8466 x_scroll_bar_handle_click (bar, event, &inev.ie);
8467 *finish = X_EVENT_DROP;
8468 }
8469 #else /* not USE_TOOLKIT_SCROLL_BARS */
8470 if (bar)
8471 x_scroll_bar_handle_click (bar, event, &inev.ie);
8472 #endif /* not USE_TOOLKIT_SCROLL_BARS */
8473 }
8474
8475 if (event->type == ButtonPress)
8476 {
8477 dpyinfo->grabbed |= (1 << event->xbutton.button);
8478 dpyinfo->last_mouse_frame = f;
8479 #if ! defined (USE_GTK)
8480 if (f && !tool_bar_p)
8481 f->last_tool_bar_item = -1;
8482 #endif /* not USE_GTK */
8483 }
8484 else
8485 dpyinfo->grabbed &= ~(1 << event->xbutton.button);
8486
8487 /* Ignore any mouse motion that happened before this event;
8488 any subsequent mouse-movement Emacs events should reflect
8489 only motion after the ButtonPress/Release. */
8490 if (f != 0)
8491 f->mouse_moved = false;
8492
8493 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
8494 f = x_menubar_window_to_frame (dpyinfo, event);
8495 /* For a down-event in the menu bar,
8496 don't pass it to Xt right now.
8497 Instead, save it away
8498 and we will pass it to Xt from kbd_buffer_get_event.
8499 That way, we can run some Lisp code first. */
8500 if (! popup_activated ()
8501 #ifdef USE_GTK
8502 /* Gtk+ menus only react to the first three buttons. */
8503 && event->xbutton.button < 3
8504 #endif
8505 && f && event->type == ButtonPress
8506 /* Verify the event is really within the menu bar
8507 and not just sent to it due to grabbing. */
8508 && event->xbutton.x >= 0
8509 && event->xbutton.x < FRAME_PIXEL_WIDTH (f)
8510 && event->xbutton.y >= 0
8511 && event->xbutton.y < FRAME_MENUBAR_HEIGHT (f)
8512 && event->xbutton.same_screen)
8513 {
8514 if (!f->output_data.x->saved_menu_event)
8515 f->output_data.x->saved_menu_event = xmalloc (sizeof *event);
8516 *f->output_data.x->saved_menu_event = *event;
8517 inev.ie.kind = MENU_BAR_ACTIVATE_EVENT;
8518 XSETFRAME (inev.ie.frame_or_window, f);
8519 *finish = X_EVENT_DROP;
8520 }
8521 else
8522 goto OTHER;
8523 #endif /* USE_X_TOOLKIT || USE_GTK */
8524 }
8525 break;
8526
8527 case CirculateNotify:
8528 goto OTHER;
8529
8530 case CirculateRequest:
8531 goto OTHER;
8532
8533 case VisibilityNotify:
8534 goto OTHER;
8535
8536 case MappingNotify:
8537 /* Someone has changed the keyboard mapping - update the
8538 local cache. */
8539 switch (event->xmapping.request)
8540 {
8541 case MappingModifier:
8542 x_find_modifier_meanings (dpyinfo);
8543 /* This is meant to fall through. */
8544 case MappingKeyboard:
8545 XRefreshKeyboardMapping ((XMappingEvent *) &event->xmapping);
8546 }
8547 goto OTHER;
8548
8549 case DestroyNotify:
8550 xft_settings_event (dpyinfo, event);
8551 break;
8552
8553 default:
8554 OTHER:
8555 #ifdef USE_X_TOOLKIT
8556 block_input ();
8557 if (*finish != X_EVENT_DROP)
8558 XtDispatchEvent ((XEvent *) event);
8559 unblock_input ();
8560 #endif /* USE_X_TOOLKIT */
8561 break;
8562 }
8563
8564 done:
8565 if (inev.ie.kind != NO_EVENT)
8566 {
8567 kbd_buffer_store_event_hold (&inev.ie, hold_quit);
8568 count++;
8569 }
8570
8571 if (do_help
8572 && !(hold_quit && hold_quit->kind != NO_EVENT))
8573 {
8574 Lisp_Object frame;
8575
8576 if (f)
8577 XSETFRAME (frame, f);
8578 else
8579 frame = Qnil;
8580
8581 if (do_help > 0)
8582 {
8583 any_help_event_p = true;
8584 gen_help_event (help_echo_string, frame, help_echo_window,
8585 help_echo_object, help_echo_pos);
8586 }
8587 else
8588 {
8589 help_echo_string = Qnil;
8590 gen_help_event (Qnil, frame, Qnil, Qnil, 0);
8591 }
8592 count++;
8593 }
8594
8595 SAFE_FREE ();
8596 return count;
8597 }
8598
8599 /* Handles the XEvent EVENT on display DISPLAY.
8600 This is used for event loops outside the normal event handling,
8601 i.e. looping while a popup menu or a dialog is posted.
8602
8603 Returns the value handle_one_xevent sets in the finish argument. */
8604 int
8605 x_dispatch_event (XEvent *event, Display *display)
8606 {
8607 struct x_display_info *dpyinfo;
8608 int finish = X_EVENT_NORMAL;
8609
8610 dpyinfo = x_display_info_for_display (display);
8611
8612 if (dpyinfo)
8613 handle_one_xevent (dpyinfo, event, &finish, 0);
8614
8615 return finish;
8616 }
8617
8618 /* Read events coming from the X server.
8619 Return as soon as there are no more events to be read.
8620
8621 Return the number of characters stored into the buffer,
8622 thus pretending to be `read' (except the characters we store
8623 in the keyboard buffer can be multibyte, so are not necessarily
8624 C chars). */
8625
8626 static int
8627 XTread_socket (struct terminal *terminal, struct input_event *hold_quit)
8628 {
8629 int count = 0;
8630 bool event_found = false;
8631 struct x_display_info *dpyinfo = terminal->display_info.x;
8632
8633 block_input ();
8634
8635 /* For debugging, this gives a way to fake an I/O error. */
8636 if (dpyinfo == XTread_socket_fake_io_error)
8637 {
8638 XTread_socket_fake_io_error = 0;
8639 x_io_error_quitter (dpyinfo->display);
8640 }
8641
8642 #ifndef USE_GTK
8643 while (XPending (dpyinfo->display))
8644 {
8645 int finish;
8646 XEvent event;
8647
8648 XNextEvent (dpyinfo->display, &event);
8649
8650 #ifdef HAVE_X_I18N
8651 /* Filter events for the current X input method. */
8652 if (x_filter_event (dpyinfo, &event))
8653 continue;
8654 #endif
8655 event_found = true;
8656
8657 count += handle_one_xevent (dpyinfo, &event, &finish, hold_quit);
8658
8659 if (finish == X_EVENT_GOTO_OUT)
8660 break;
8661 }
8662
8663 #else /* USE_GTK */
8664
8665 /* For GTK we must use the GTK event loop. But XEvents gets passed
8666 to our filter function above, and then to the big event switch.
8667 We use a bunch of globals to communicate with our filter function,
8668 that is kind of ugly, but it works.
8669
8670 There is no way to do one display at the time, GTK just does events
8671 from all displays. */
8672
8673 while (gtk_events_pending ())
8674 {
8675 current_count = count;
8676 current_hold_quit = hold_quit;
8677
8678 gtk_main_iteration ();
8679
8680 count = current_count;
8681 current_count = -1;
8682 current_hold_quit = 0;
8683
8684 if (current_finish == X_EVENT_GOTO_OUT)
8685 break;
8686 }
8687 #endif /* USE_GTK */
8688
8689 /* On some systems, an X bug causes Emacs to get no more events
8690 when the window is destroyed. Detect that. (1994.) */
8691 if (! event_found)
8692 {
8693 /* Emacs and the X Server eats up CPU time if XNoOp is done every time.
8694 One XNOOP in 100 loops will make Emacs terminate.
8695 B. Bretthauer, 1994 */
8696 x_noop_count++;
8697 if (x_noop_count >= 100)
8698 {
8699 x_noop_count=0;
8700
8701 if (next_noop_dpyinfo == 0)
8702 next_noop_dpyinfo = x_display_list;
8703
8704 XNoOp (next_noop_dpyinfo->display);
8705
8706 /* Each time we get here, cycle through the displays now open. */
8707 next_noop_dpyinfo = next_noop_dpyinfo->next;
8708 }
8709 }
8710
8711 /* If the focus was just given to an auto-raising frame,
8712 raise it now. FIXME: handle more than one such frame. */
8713 if (dpyinfo->x_pending_autoraise_frame)
8714 {
8715 x_raise_frame (dpyinfo->x_pending_autoraise_frame);
8716 dpyinfo->x_pending_autoraise_frame = NULL;
8717 }
8718
8719 unblock_input ();
8720
8721 return count;
8722 }
8723
8724
8725
8726 \f
8727 /***********************************************************************
8728 Text Cursor
8729 ***********************************************************************/
8730
8731 /* Set clipping for output in glyph row ROW. W is the window in which
8732 we operate. GC is the graphics context to set clipping in.
8733
8734 ROW may be a text row or, e.g., a mode line. Text rows must be
8735 clipped to the interior of the window dedicated to text display,
8736 mode lines must be clipped to the whole window. */
8737
8738 static void
8739 x_clip_to_row (struct window *w, struct glyph_row *row,
8740 enum glyph_row_area area, GC gc)
8741 {
8742 struct frame *f = XFRAME (WINDOW_FRAME (w));
8743 XRectangle clip_rect;
8744 int window_x, window_y, window_width;
8745
8746 window_box (w, area, &window_x, &window_y, &window_width, 0);
8747
8748 clip_rect.x = window_x;
8749 clip_rect.y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, row->y));
8750 clip_rect.y = max (clip_rect.y, window_y);
8751 clip_rect.width = window_width;
8752 clip_rect.height = row->visible_height;
8753
8754 x_set_clip_rectangles (f, gc, &clip_rect, 1);
8755 }
8756
8757
8758 /* Draw a hollow box cursor on window W in glyph row ROW. */
8759
8760 static void
8761 x_draw_hollow_cursor (struct window *w, struct glyph_row *row)
8762 {
8763 struct frame *f = XFRAME (WINDOW_FRAME (w));
8764 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
8765 Display *dpy = FRAME_X_DISPLAY (f);
8766 int x, y, wd, h;
8767 XGCValues xgcv;
8768 struct glyph *cursor_glyph;
8769 GC gc;
8770
8771 /* Get the glyph the cursor is on. If we can't tell because
8772 the current matrix is invalid or such, give up. */
8773 cursor_glyph = get_phys_cursor_glyph (w);
8774 if (cursor_glyph == NULL)
8775 return;
8776
8777 /* Compute frame-relative coordinates for phys cursor. */
8778 get_phys_cursor_geometry (w, row, cursor_glyph, &x, &y, &h);
8779 wd = w->phys_cursor_width - 1;
8780
8781 /* The foreground of cursor_gc is typically the same as the normal
8782 background color, which can cause the cursor box to be invisible. */
8783 xgcv.foreground = f->output_data.x->cursor_pixel;
8784 if (dpyinfo->scratch_cursor_gc)
8785 XChangeGC (dpy, dpyinfo->scratch_cursor_gc, GCForeground, &xgcv);
8786 else
8787 dpyinfo->scratch_cursor_gc = XCreateGC (dpy, FRAME_X_WINDOW (f),
8788 GCForeground, &xgcv);
8789 gc = dpyinfo->scratch_cursor_gc;
8790
8791 /* When on R2L character, show cursor at the right edge of the
8792 glyph, unless the cursor box is as wide as the glyph or wider
8793 (the latter happens when x-stretch-cursor is non-nil). */
8794 if ((cursor_glyph->resolved_level & 1) != 0
8795 && cursor_glyph->pixel_width > wd)
8796 {
8797 x += cursor_glyph->pixel_width - wd;
8798 if (wd > 0)
8799 wd -= 1;
8800 }
8801 /* Set clipping, draw the rectangle, and reset clipping again. */
8802 x_clip_to_row (w, row, TEXT_AREA, gc);
8803 x_draw_rectangle (f, gc, x, y, wd, h - 1);
8804 x_reset_clip_rectangles (f, gc);
8805 }
8806
8807
8808 /* Draw a bar cursor on window W in glyph row ROW.
8809
8810 Implementation note: One would like to draw a bar cursor with an
8811 angle equal to the one given by the font property XA_ITALIC_ANGLE.
8812 Unfortunately, I didn't find a font yet that has this property set.
8813 --gerd. */
8814
8815 static void
8816 x_draw_bar_cursor (struct window *w, struct glyph_row *row, int width, enum text_cursor_kinds kind)
8817 {
8818 struct frame *f = XFRAME (w->frame);
8819 struct glyph *cursor_glyph;
8820
8821 /* If cursor is out of bounds, don't draw garbage. This can happen
8822 in mini-buffer windows when switching between echo area glyphs
8823 and mini-buffer. */
8824 cursor_glyph = get_phys_cursor_glyph (w);
8825 if (cursor_glyph == NULL)
8826 return;
8827
8828 /* If on an image, draw like a normal cursor. That's usually better
8829 visible than drawing a bar, esp. if the image is large so that
8830 the bar might not be in the window. */
8831 if (cursor_glyph->type == IMAGE_GLYPH)
8832 {
8833 struct glyph_row *r;
8834 r = MATRIX_ROW (w->current_matrix, w->phys_cursor.vpos);
8835 draw_phys_cursor_glyph (w, r, DRAW_CURSOR);
8836 }
8837 else
8838 {
8839 Display *dpy = FRAME_X_DISPLAY (f);
8840 Window window = FRAME_X_WINDOW (f);
8841 GC gc = FRAME_DISPLAY_INFO (f)->scratch_cursor_gc;
8842 unsigned long mask = GCForeground | GCBackground | GCGraphicsExposures;
8843 struct face *face = FACE_FROM_ID (f, cursor_glyph->face_id);
8844 XGCValues xgcv;
8845
8846 /* If the glyph's background equals the color we normally draw
8847 the bars cursor in, the bar cursor in its normal color is
8848 invisible. Use the glyph's foreground color instead in this
8849 case, on the assumption that the glyph's colors are chosen so
8850 that the glyph is legible. */
8851 if (face->background == f->output_data.x->cursor_pixel)
8852 xgcv.background = xgcv.foreground = face->foreground;
8853 else
8854 xgcv.background = xgcv.foreground = f->output_data.x->cursor_pixel;
8855 xgcv.graphics_exposures = False;
8856
8857 if (gc)
8858 XChangeGC (dpy, gc, mask, &xgcv);
8859 else
8860 {
8861 gc = XCreateGC (dpy, window, mask, &xgcv);
8862 FRAME_DISPLAY_INFO (f)->scratch_cursor_gc = gc;
8863 }
8864
8865 x_clip_to_row (w, row, TEXT_AREA, gc);
8866
8867 if (kind == BAR_CURSOR)
8868 {
8869 int x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x);
8870
8871 if (width < 0)
8872 width = FRAME_CURSOR_WIDTH (f);
8873 width = min (cursor_glyph->pixel_width, width);
8874
8875 w->phys_cursor_width = width;
8876
8877 /* If the character under cursor is R2L, draw the bar cursor
8878 on the right of its glyph, rather than on the left. */
8879 if ((cursor_glyph->resolved_level & 1) != 0)
8880 x += cursor_glyph->pixel_width - width;
8881
8882 x_fill_rectangle (f, gc, x,
8883 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y),
8884 width, row->height);
8885 }
8886 else /* HBAR_CURSOR */
8887 {
8888 int dummy_x, dummy_y, dummy_h;
8889 int x = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, w->phys_cursor.x);
8890
8891 if (width < 0)
8892 width = row->height;
8893
8894 width = min (row->height, width);
8895
8896 get_phys_cursor_geometry (w, row, cursor_glyph, &dummy_x,
8897 &dummy_y, &dummy_h);
8898
8899 if ((cursor_glyph->resolved_level & 1) != 0
8900 && cursor_glyph->pixel_width > w->phys_cursor_width - 1)
8901 x += cursor_glyph->pixel_width - w->phys_cursor_width + 1;
8902 x_fill_rectangle (f, gc, x,
8903 WINDOW_TO_FRAME_PIXEL_Y (w, w->phys_cursor.y +
8904 row->height - width),
8905 w->phys_cursor_width - 1, width);
8906 }
8907
8908 x_reset_clip_rectangles (f, gc);
8909 }
8910 }
8911
8912
8913 /* RIF: Define cursor CURSOR on frame F. */
8914
8915 static void
8916 x_define_frame_cursor (struct frame *f, Cursor cursor)
8917 {
8918 if (!f->pointer_invisible
8919 && f->output_data.x->current_cursor != cursor)
8920 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f), cursor);
8921 f->output_data.x->current_cursor = cursor;
8922 }
8923
8924
8925 /* RIF: Clear area on frame F. */
8926
8927 static void
8928 x_clear_frame_area (struct frame *f, int x, int y, int width, int height)
8929 {
8930 x_clear_area (f, x, y, width, height);
8931 #ifdef USE_GTK
8932 /* Must queue a redraw, because scroll bars might have been cleared. */
8933 if (FRAME_GTK_WIDGET (f))
8934 gtk_widget_queue_draw (FRAME_GTK_WIDGET (f));
8935 #endif
8936 }
8937
8938
8939 /* RIF: Draw cursor on window W. */
8940
8941 static void
8942 x_draw_window_cursor (struct window *w, struct glyph_row *glyph_row, int x,
8943 int y, enum text_cursor_kinds cursor_type,
8944 int cursor_width, bool on_p, bool active_p)
8945 {
8946 struct frame *f = XFRAME (WINDOW_FRAME (w));
8947
8948 if (on_p)
8949 {
8950 w->phys_cursor_type = cursor_type;
8951 w->phys_cursor_on_p = true;
8952
8953 if (glyph_row->exact_window_width_line_p
8954 && (glyph_row->reversed_p
8955 ? (w->phys_cursor.hpos < 0)
8956 : (w->phys_cursor.hpos >= glyph_row->used[TEXT_AREA])))
8957 {
8958 glyph_row->cursor_in_fringe_p = true;
8959 draw_fringe_bitmap (w, glyph_row, glyph_row->reversed_p);
8960 }
8961 else
8962 {
8963 switch (cursor_type)
8964 {
8965 case HOLLOW_BOX_CURSOR:
8966 x_draw_hollow_cursor (w, glyph_row);
8967 break;
8968
8969 case FILLED_BOX_CURSOR:
8970 draw_phys_cursor_glyph (w, glyph_row, DRAW_CURSOR);
8971 break;
8972
8973 case BAR_CURSOR:
8974 x_draw_bar_cursor (w, glyph_row, cursor_width, BAR_CURSOR);
8975 break;
8976
8977 case HBAR_CURSOR:
8978 x_draw_bar_cursor (w, glyph_row, cursor_width, HBAR_CURSOR);
8979 break;
8980
8981 case NO_CURSOR:
8982 w->phys_cursor_width = 0;
8983 break;
8984
8985 default:
8986 emacs_abort ();
8987 }
8988 }
8989
8990 #ifdef HAVE_X_I18N
8991 if (w == XWINDOW (f->selected_window))
8992 if (FRAME_XIC (f) && (FRAME_XIC_STYLE (f) & XIMPreeditPosition))
8993 xic_set_preeditarea (w, x, y);
8994 #endif
8995 }
8996
8997 XFlush (FRAME_X_DISPLAY (f));
8998 }
8999
9000 \f
9001 /* Icons. */
9002
9003 /* Make the x-window of frame F use the gnu icon bitmap. */
9004
9005 bool
9006 x_bitmap_icon (struct frame *f, Lisp_Object file)
9007 {
9008 ptrdiff_t bitmap_id;
9009
9010 if (FRAME_X_WINDOW (f) == 0)
9011 return true;
9012
9013 /* Free up our existing icon bitmap and mask if any. */
9014 if (f->output_data.x->icon_bitmap > 0)
9015 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
9016 f->output_data.x->icon_bitmap = 0;
9017
9018 if (STRINGP (file))
9019 {
9020 #ifdef USE_GTK
9021 /* Use gtk_window_set_icon_from_file () if available,
9022 It's not restricted to bitmaps */
9023 if (xg_set_icon (f, file))
9024 return false;
9025 #endif /* USE_GTK */
9026 bitmap_id = x_create_bitmap_from_file (f, file);
9027 x_create_bitmap_mask (f, bitmap_id);
9028 }
9029 else
9030 {
9031 /* Create the GNU bitmap and mask if necessary. */
9032 if (FRAME_DISPLAY_INFO (f)->icon_bitmap_id < 0)
9033 {
9034 ptrdiff_t rc = -1;
9035
9036 #ifdef USE_GTK
9037
9038 if (xg_set_icon (f, xg_default_icon_file)
9039 || xg_set_icon_from_xpm_data (f, gnu_xpm_bits))
9040 {
9041 FRAME_DISPLAY_INFO (f)->icon_bitmap_id = -2;
9042 return false;
9043 }
9044
9045 #elif defined (HAVE_XPM) && defined (HAVE_X_WINDOWS)
9046
9047 rc = x_create_bitmap_from_xpm_data (f, gnu_xpm_bits);
9048 if (rc != -1)
9049 FRAME_DISPLAY_INFO (f)->icon_bitmap_id = rc;
9050
9051 #endif
9052
9053 /* If all else fails, use the (black and white) xbm image. */
9054 if (rc == -1)
9055 {
9056 rc = x_create_bitmap_from_data (f, (char *) gnu_xbm_bits,
9057 gnu_xbm_width, gnu_xbm_height);
9058 if (rc == -1)
9059 return true;
9060
9061 FRAME_DISPLAY_INFO (f)->icon_bitmap_id = rc;
9062 x_create_bitmap_mask (f, FRAME_DISPLAY_INFO (f)->icon_bitmap_id);
9063 }
9064 }
9065
9066 /* The first time we create the GNU bitmap and mask,
9067 this increments the ref-count one extra time.
9068 As a result, the GNU bitmap and mask are never freed.
9069 That way, we don't have to worry about allocating it again. */
9070 x_reference_bitmap (f, FRAME_DISPLAY_INFO (f)->icon_bitmap_id);
9071
9072 bitmap_id = FRAME_DISPLAY_INFO (f)->icon_bitmap_id;
9073 }
9074
9075 x_wm_set_icon_pixmap (f, bitmap_id);
9076 f->output_data.x->icon_bitmap = bitmap_id;
9077
9078 return false;
9079 }
9080
9081
9082 /* Make the x-window of frame F use a rectangle with text.
9083 Use ICON_NAME as the text. */
9084
9085 bool
9086 x_text_icon (struct frame *f, const char *icon_name)
9087 {
9088 if (FRAME_X_WINDOW (f) == 0)
9089 return true;
9090
9091 {
9092 XTextProperty text;
9093 text.value = (unsigned char *) icon_name;
9094 text.encoding = XA_STRING;
9095 text.format = 8;
9096 text.nitems = strlen (icon_name);
9097 XSetWMIconName (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f), &text);
9098 }
9099
9100 if (f->output_data.x->icon_bitmap > 0)
9101 x_destroy_bitmap (f, f->output_data.x->icon_bitmap);
9102 f->output_data.x->icon_bitmap = 0;
9103 x_wm_set_icon_pixmap (f, 0);
9104
9105 return false;
9106 }
9107 \f
9108 #define X_ERROR_MESSAGE_SIZE 200
9109
9110 /* If non-nil, this should be a string.
9111 It means catch X errors and store the error message in this string.
9112
9113 The reason we use a stack is that x_catch_error/x_uncatch_error can
9114 be called from a signal handler.
9115 */
9116
9117 struct x_error_message_stack {
9118 char string[X_ERROR_MESSAGE_SIZE];
9119 Display *dpy;
9120 struct x_error_message_stack *prev;
9121 };
9122 static struct x_error_message_stack *x_error_message;
9123
9124 /* An X error handler which stores the error message in
9125 *x_error_message. This is called from x_error_handler if
9126 x_catch_errors is in effect. */
9127
9128 static void
9129 x_error_catcher (Display *display, XErrorEvent *event)
9130 {
9131 XGetErrorText (display, event->error_code,
9132 x_error_message->string,
9133 X_ERROR_MESSAGE_SIZE);
9134 }
9135
9136 /* Begin trapping X errors for display DPY. Actually we trap X errors
9137 for all displays, but DPY should be the display you are actually
9138 operating on.
9139
9140 After calling this function, X protocol errors no longer cause
9141 Emacs to exit; instead, they are recorded in the string
9142 stored in *x_error_message.
9143
9144 Calling x_check_errors signals an Emacs error if an X error has
9145 occurred since the last call to x_catch_errors or x_check_errors.
9146
9147 Calling x_uncatch_errors resumes the normal error handling. */
9148
9149 void
9150 x_catch_errors (Display *dpy)
9151 {
9152 struct x_error_message_stack *data = xmalloc (sizeof *data);
9153
9154 /* Make sure any errors from previous requests have been dealt with. */
9155 XSync (dpy, False);
9156
9157 data->dpy = dpy;
9158 data->string[0] = 0;
9159 data->prev = x_error_message;
9160 x_error_message = data;
9161 }
9162
9163 /* Undo the last x_catch_errors call.
9164 DPY should be the display that was passed to x_catch_errors. */
9165
9166 void
9167 x_uncatch_errors (void)
9168 {
9169 struct x_error_message_stack *tmp;
9170
9171 block_input ();
9172
9173 /* The display may have been closed before this function is called.
9174 Check if it is still open before calling XSync. */
9175 if (x_display_info_for_display (x_error_message->dpy) != 0)
9176 XSync (x_error_message->dpy, False);
9177
9178 tmp = x_error_message;
9179 x_error_message = x_error_message->prev;
9180 xfree (tmp);
9181 unblock_input ();
9182 }
9183
9184 /* If any X protocol errors have arrived since the last call to
9185 x_catch_errors or x_check_errors, signal an Emacs error using
9186 sprintf (a buffer, FORMAT, the x error message text) as the text. */
9187
9188 void
9189 x_check_errors (Display *dpy, const char *format)
9190 {
9191 /* Make sure to catch any errors incurred so far. */
9192 XSync (dpy, False);
9193
9194 if (x_error_message->string[0])
9195 {
9196 char string[X_ERROR_MESSAGE_SIZE];
9197 memcpy (string, x_error_message->string, X_ERROR_MESSAGE_SIZE);
9198 x_uncatch_errors ();
9199 error (format, string);
9200 }
9201 }
9202
9203 /* Nonzero if we had any X protocol errors
9204 since we did x_catch_errors on DPY. */
9205
9206 bool
9207 x_had_errors_p (Display *dpy)
9208 {
9209 /* Make sure to catch any errors incurred so far. */
9210 XSync (dpy, False);
9211
9212 return x_error_message->string[0] != 0;
9213 }
9214
9215 /* Forget about any errors we have had, since we did x_catch_errors on DPY. */
9216
9217 void
9218 x_clear_errors (Display *dpy)
9219 {
9220 x_error_message->string[0] = 0;
9221 }
9222
9223 #if false
9224 /* See comment in unwind_to_catch why calling this is a bad
9225 * idea. --lorentey */
9226 /* Close off all unclosed x_catch_errors calls. */
9227
9228 void
9229 x_fully_uncatch_errors (void)
9230 {
9231 while (x_error_message)
9232 x_uncatch_errors ();
9233 }
9234 #endif
9235
9236 #if false
9237 static unsigned int x_wire_count;
9238 x_trace_wire (void)
9239 {
9240 fprintf (stderr, "Lib call: %d\n", ++x_wire_count);
9241 }
9242 #endif
9243
9244 \f
9245 /************************************************************************
9246 Handling X errors
9247 ************************************************************************/
9248
9249 /* Error message passed to x_connection_closed. */
9250
9251 static char *error_msg;
9252
9253 /* Handle the loss of connection to display DPY. ERROR_MESSAGE is
9254 the text of an error message that lead to the connection loss. */
9255
9256 static void
9257 x_connection_closed (Display *dpy, const char *error_message, bool ioerror)
9258 {
9259 struct x_display_info *dpyinfo = x_display_info_for_display (dpy);
9260 Lisp_Object frame, tail;
9261 ptrdiff_t idx = SPECPDL_INDEX ();
9262
9263 error_msg = alloca (strlen (error_message) + 1);
9264 strcpy (error_msg, error_message);
9265
9266 /* Inhibit redisplay while frames are being deleted. */
9267 specbind (Qinhibit_redisplay, Qt);
9268
9269 if (dpyinfo)
9270 {
9271 /* Protect display from being closed when we delete the last
9272 frame on it. */
9273 dpyinfo->reference_count++;
9274 dpyinfo->terminal->reference_count++;
9275 }
9276 if (ioerror) dpyinfo->display = 0;
9277
9278 /* First delete frames whose mini-buffers are on frames
9279 that are on the dead display. */
9280 FOR_EACH_FRAME (tail, frame)
9281 {
9282 Lisp_Object minibuf_frame;
9283 minibuf_frame
9284 = WINDOW_FRAME (XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))));
9285 if (FRAME_X_P (XFRAME (frame))
9286 && FRAME_X_P (XFRAME (minibuf_frame))
9287 && ! EQ (frame, minibuf_frame)
9288 && FRAME_DISPLAY_INFO (XFRAME (minibuf_frame)) == dpyinfo)
9289 delete_frame (frame, Qnoelisp);
9290 }
9291
9292 /* Now delete all remaining frames on the dead display.
9293 We are now sure none of these is used as the mini-buffer
9294 for another frame that we need to delete. */
9295 FOR_EACH_FRAME (tail, frame)
9296 if (FRAME_X_P (XFRAME (frame))
9297 && FRAME_DISPLAY_INFO (XFRAME (frame)) == dpyinfo)
9298 {
9299 /* Set this to t so that delete_frame won't get confused
9300 trying to find a replacement. */
9301 kset_default_minibuffer_frame (FRAME_KBOARD (XFRAME (frame)), Qt);
9302 delete_frame (frame, Qnoelisp);
9303 }
9304
9305 /* If DPYINFO is null, this means we didn't open the display in the
9306 first place, so don't try to close it. */
9307 if (dpyinfo)
9308 {
9309 /* We can not call XtCloseDisplay here because it calls XSync.
9310 XSync inside the error handler apparently hangs Emacs. On
9311 current Xt versions, this isn't needed either. */
9312 #ifdef USE_GTK
9313 /* A long-standing GTK bug prevents proper disconnect handling
9314 (https://bugzilla.gnome.org/show_bug.cgi?id=85715). Once,
9315 the resulting Glib error message loop filled a user's disk.
9316 To avoid this, kill Emacs unconditionally on disconnect. */
9317 shut_down_emacs (0, Qnil);
9318 fprintf (stderr, "%s\n\
9319 When compiled with GTK, Emacs cannot recover from X disconnects.\n\
9320 This is a GTK bug: https://bugzilla.gnome.org/show_bug.cgi?id=85715\n\
9321 For details, see etc/PROBLEMS.\n",
9322 error_msg);
9323 emacs_abort ();
9324 #endif /* USE_GTK */
9325
9326 /* Indicate that this display is dead. */
9327 dpyinfo->display = 0;
9328
9329 dpyinfo->reference_count--;
9330 dpyinfo->terminal->reference_count--;
9331 if (dpyinfo->reference_count != 0)
9332 /* We have just closed all frames on this display. */
9333 emacs_abort ();
9334
9335 {
9336 Lisp_Object tmp;
9337 XSETTERMINAL (tmp, dpyinfo->terminal);
9338 Fdelete_terminal (tmp, Qnoelisp);
9339 }
9340 }
9341
9342 if (terminal_list == 0)
9343 {
9344 fprintf (stderr, "%s\n", error_msg);
9345 Fkill_emacs (make_number (70));
9346 /* NOTREACHED */
9347 }
9348
9349 totally_unblock_input ();
9350
9351 unbind_to (idx, Qnil);
9352 clear_waiting_for_input ();
9353
9354 /* Tell GCC not to suggest attribute 'noreturn' for this function. */
9355 IF_LINT (if (! terminal_list) return; )
9356
9357 /* Here, we absolutely have to use a non-local exit (e.g. signal, throw,
9358 longjmp), because returning from this function would get us back into
9359 Xlib's code which will directly call `exit'. */
9360 error ("%s", error_msg);
9361 }
9362
9363 /* We specifically use it before defining it, so that gcc doesn't inline it,
9364 otherwise gdb doesn't know how to properly put a breakpoint on it. */
9365 static void x_error_quitter (Display *, XErrorEvent *);
9366
9367 /* This is the first-level handler for X protocol errors.
9368 It calls x_error_quitter or x_error_catcher. */
9369
9370 static int
9371 x_error_handler (Display *display, XErrorEvent *event)
9372 {
9373 #if defined USE_GTK && defined HAVE_GTK3
9374 if ((event->error_code == BadMatch || event->error_code == BadWindow)
9375 && event->request_code == X_SetInputFocus)
9376 {
9377 return 0;
9378 }
9379 #endif
9380
9381 if (x_error_message)
9382 x_error_catcher (display, event);
9383 else
9384 x_error_quitter (display, event);
9385 return 0;
9386 }
9387
9388 /* This is the usual handler for X protocol errors.
9389 It kills all frames on the display that we got the error for.
9390 If that was the only one, it prints an error message and kills Emacs. */
9391
9392 /* .gdbinit puts a breakpoint here, so make sure it is not inlined. */
9393
9394 /* On older GCC versions, just putting x_error_quitter
9395 after x_error_handler prevents inlining into the former. */
9396
9397 static void NO_INLINE
9398 x_error_quitter (Display *display, XErrorEvent *event)
9399 {
9400 char buf[256], buf1[356];
9401
9402 /* Ignore BadName errors. They can happen because of fonts
9403 or colors that are not defined. */
9404
9405 if (event->error_code == BadName)
9406 return;
9407
9408 /* Note that there is no real way portable across R3/R4 to get the
9409 original error handler. */
9410
9411 XGetErrorText (display, event->error_code, buf, sizeof (buf));
9412 sprintf (buf1, "X protocol error: %s on protocol request %d",
9413 buf, event->request_code);
9414 x_connection_closed (display, buf1, false);
9415 }
9416
9417
9418 /* This is the handler for X IO errors, always.
9419 It kills all frames on the display that we lost touch with.
9420 If that was the only one, it prints an error message and kills Emacs. */
9421
9422 static int
9423 x_io_error_quitter (Display *display)
9424 {
9425 char buf[256];
9426
9427 snprintf (buf, sizeof buf, "Connection lost to X server `%s'",
9428 DisplayString (display));
9429 x_connection_closed (display, buf, true);
9430 return 0;
9431 }
9432 \f
9433 /* Changing the font of the frame. */
9434
9435 /* Give frame F the font FONT-OBJECT as its default font. The return
9436 value is FONT-OBJECT. FONTSET is an ID of the fontset for the
9437 frame. If it is negative, generate a new fontset from
9438 FONT-OBJECT. */
9439
9440 Lisp_Object
9441 x_new_font (struct frame *f, Lisp_Object font_object, int fontset)
9442 {
9443 struct font *font = XFONT_OBJECT (font_object);
9444 int unit;
9445
9446 if (fontset < 0)
9447 fontset = fontset_from_font (font_object);
9448 FRAME_FONTSET (f) = fontset;
9449 if (FRAME_FONT (f) == font)
9450 /* This font is already set in frame F. There's nothing more to
9451 do. */
9452 return font_object;
9453
9454 FRAME_FONT (f) = font;
9455 FRAME_BASELINE_OFFSET (f) = font->baseline_offset;
9456 FRAME_COLUMN_WIDTH (f) = font->average_width;
9457 FRAME_LINE_HEIGHT (f) = FONT_HEIGHT (font);
9458
9459 #ifndef USE_X_TOOLKIT
9460 FRAME_MENU_BAR_HEIGHT (f) = FRAME_MENU_BAR_LINES (f) * FRAME_LINE_HEIGHT (f);
9461 #endif
9462
9463 /* Compute character columns occupied by scrollbar.
9464
9465 Don't do things differently for non-toolkit scrollbars
9466 (Bug#17163). */
9467 unit = FRAME_COLUMN_WIDTH (f);
9468 if (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) > 0)
9469 FRAME_CONFIG_SCROLL_BAR_COLS (f)
9470 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + unit - 1) / unit;
9471 else
9472 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (14 + unit - 1) / unit;
9473
9474 if (FRAME_X_WINDOW (f) != 0)
9475 {
9476 /* Don't change the size of a tip frame; there's no point in
9477 doing it because it's done in Fx_show_tip, and it leads to
9478 problems because the tip frame has no widget. */
9479 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
9480 adjust_frame_size (f, FRAME_COLS (f) * FRAME_COLUMN_WIDTH (f),
9481 FRAME_LINES (f) * FRAME_LINE_HEIGHT (f), 3,
9482 false, Qfont);
9483 }
9484
9485 #ifdef HAVE_X_I18N
9486 if (FRAME_XIC (f)
9487 && (FRAME_XIC_STYLE (f) & (XIMPreeditPosition | XIMStatusArea)))
9488 {
9489 block_input ();
9490 xic_set_xfontset (f, SSDATA (fontset_ascii (fontset)));
9491 unblock_input ();
9492 }
9493 #endif
9494
9495 return font_object;
9496 }
9497
9498 \f
9499 /***********************************************************************
9500 X Input Methods
9501 ***********************************************************************/
9502
9503 #ifdef HAVE_X_I18N
9504
9505 #ifdef HAVE_X11R6
9506
9507 /* XIM destroy callback function, which is called whenever the
9508 connection to input method XIM dies. CLIENT_DATA contains a
9509 pointer to the x_display_info structure corresponding to XIM. */
9510
9511 static void
9512 xim_destroy_callback (XIM xim, XPointer client_data, XPointer call_data)
9513 {
9514 struct x_display_info *dpyinfo = (struct x_display_info *) client_data;
9515 Lisp_Object frame, tail;
9516
9517 block_input ();
9518
9519 /* No need to call XDestroyIC.. */
9520 FOR_EACH_FRAME (tail, frame)
9521 {
9522 struct frame *f = XFRAME (frame);
9523 if (FRAME_X_P (f) && FRAME_DISPLAY_INFO (f) == dpyinfo)
9524 {
9525 FRAME_XIC (f) = NULL;
9526 xic_free_xfontset (f);
9527 }
9528 }
9529
9530 /* No need to call XCloseIM. */
9531 dpyinfo->xim = NULL;
9532 XFree (dpyinfo->xim_styles);
9533 unblock_input ();
9534 }
9535
9536 #endif /* HAVE_X11R6 */
9537
9538 /* Open the connection to the XIM server on display DPYINFO.
9539 RESOURCE_NAME is the resource name Emacs uses. */
9540
9541 static void
9542 xim_open_dpy (struct x_display_info *dpyinfo, char *resource_name)
9543 {
9544 XIM xim;
9545
9546 #ifdef HAVE_XIM
9547 if (use_xim)
9548 {
9549 if (dpyinfo->xim)
9550 XCloseIM (dpyinfo->xim);
9551 xim = XOpenIM (dpyinfo->display, dpyinfo->xrdb, resource_name,
9552 emacs_class);
9553 dpyinfo->xim = xim;
9554
9555 if (xim)
9556 {
9557 #ifdef HAVE_X11R6
9558 XIMCallback destroy;
9559 #endif
9560
9561 /* Get supported styles and XIM values. */
9562 XGetIMValues (xim, XNQueryInputStyle, &dpyinfo->xim_styles, NULL);
9563
9564 #ifdef HAVE_X11R6
9565 destroy.callback = xim_destroy_callback;
9566 destroy.client_data = (XPointer)dpyinfo;
9567 XSetIMValues (xim, XNDestroyCallback, &destroy, NULL);
9568 #endif
9569 }
9570 }
9571
9572 else
9573 #endif /* HAVE_XIM */
9574 dpyinfo->xim = NULL;
9575 }
9576
9577
9578 #ifdef HAVE_X11R6_XIM
9579
9580 /* XIM instantiate callback function, which is called whenever an XIM
9581 server is available. DISPLAY is the display of the XIM.
9582 CLIENT_DATA contains a pointer to an xim_inst_t structure created
9583 when the callback was registered. */
9584
9585 static void
9586 xim_instantiate_callback (Display *display, XPointer client_data, XPointer call_data)
9587 {
9588 struct xim_inst_t *xim_inst = (struct xim_inst_t *) client_data;
9589 struct x_display_info *dpyinfo = xim_inst->dpyinfo;
9590
9591 /* We don't support multiple XIM connections. */
9592 if (dpyinfo->xim)
9593 return;
9594
9595 xim_open_dpy (dpyinfo, xim_inst->resource_name);
9596
9597 /* Create XIC for the existing frames on the same display, as long
9598 as they have no XIC. */
9599 if (dpyinfo->xim && dpyinfo->reference_count > 0)
9600 {
9601 Lisp_Object tail, frame;
9602
9603 block_input ();
9604 FOR_EACH_FRAME (tail, frame)
9605 {
9606 struct frame *f = XFRAME (frame);
9607
9608 if (FRAME_X_P (f)
9609 && FRAME_DISPLAY_INFO (f) == xim_inst->dpyinfo)
9610 if (FRAME_XIC (f) == NULL)
9611 {
9612 create_frame_xic (f);
9613 if (FRAME_XIC_STYLE (f) & XIMStatusArea)
9614 xic_set_statusarea (f);
9615 if (FRAME_XIC_STYLE (f) & XIMPreeditPosition)
9616 {
9617 struct window *w = XWINDOW (f->selected_window);
9618 xic_set_preeditarea (w, w->cursor.x, w->cursor.y);
9619 }
9620 }
9621 }
9622
9623 unblock_input ();
9624 }
9625 }
9626
9627 #endif /* HAVE_X11R6_XIM */
9628
9629
9630 /* Open a connection to the XIM server on display DPYINFO.
9631 RESOURCE_NAME is the resource name for Emacs. On X11R5, open the
9632 connection only at the first time. On X11R6, open the connection
9633 in the XIM instantiate callback function. */
9634
9635 static void
9636 xim_initialize (struct x_display_info *dpyinfo, char *resource_name)
9637 {
9638 dpyinfo->xim = NULL;
9639 #ifdef HAVE_XIM
9640 if (use_xim)
9641 {
9642 #ifdef HAVE_X11R6_XIM
9643 struct xim_inst_t *xim_inst = xmalloc (sizeof *xim_inst);
9644 Bool ret;
9645
9646 dpyinfo->xim_callback_data = xim_inst;
9647 xim_inst->dpyinfo = dpyinfo;
9648 xim_inst->resource_name = xstrdup (resource_name);
9649 ret = XRegisterIMInstantiateCallback
9650 (dpyinfo->display, dpyinfo->xrdb, xim_inst->resource_name,
9651 emacs_class, xim_instantiate_callback,
9652 /* This is XPointer in XFree86 but (XPointer *)
9653 on Tru64, at least, hence the configure test. */
9654 (XRegisterIMInstantiateCallback_arg6) xim_inst);
9655 eassert (ret == True);
9656 #else /* not HAVE_X11R6_XIM */
9657 xim_open_dpy (dpyinfo, resource_name);
9658 #endif /* not HAVE_X11R6_XIM */
9659 }
9660 #endif /* HAVE_XIM */
9661 }
9662
9663
9664 /* Close the connection to the XIM server on display DPYINFO. */
9665
9666 static void
9667 xim_close_dpy (struct x_display_info *dpyinfo)
9668 {
9669 #ifdef HAVE_XIM
9670 if (use_xim)
9671 {
9672 #ifdef HAVE_X11R6_XIM
9673 struct xim_inst_t *xim_inst = dpyinfo->xim_callback_data;
9674
9675 if (dpyinfo->display)
9676 {
9677 Bool ret = XUnregisterIMInstantiateCallback
9678 (dpyinfo->display, dpyinfo->xrdb, xim_inst->resource_name,
9679 emacs_class, xim_instantiate_callback,
9680 (XRegisterIMInstantiateCallback_arg6) xim_inst);
9681 eassert (ret == True);
9682 }
9683 xfree (xim_inst->resource_name);
9684 xfree (xim_inst);
9685 #endif /* HAVE_X11R6_XIM */
9686 if (dpyinfo->display)
9687 XCloseIM (dpyinfo->xim);
9688 dpyinfo->xim = NULL;
9689 XFree (dpyinfo->xim_styles);
9690 }
9691 #endif /* HAVE_XIM */
9692 }
9693
9694 #endif /* not HAVE_X11R6_XIM */
9695
9696
9697 \f
9698 /* Calculate the absolute position in frame F
9699 from its current recorded position values and gravity. */
9700
9701 static void
9702 x_calc_absolute_position (struct frame *f)
9703 {
9704 int flags = f->size_hint_flags;
9705
9706 /* We have nothing to do if the current position
9707 is already for the top-left corner. */
9708 if (! ((flags & XNegative) || (flags & YNegative)))
9709 return;
9710
9711 /* Treat negative positions as relative to the leftmost bottommost
9712 position that fits on the screen. */
9713 if (flags & XNegative)
9714 f->left_pos = x_display_pixel_width (FRAME_DISPLAY_INFO (f))
9715 - FRAME_PIXEL_WIDTH (f) + f->left_pos;
9716
9717 {
9718 int height = FRAME_PIXEL_HEIGHT (f);
9719
9720 #if defined USE_X_TOOLKIT && defined USE_MOTIF
9721 /* Something is fishy here. When using Motif, starting Emacs with
9722 `-g -0-0', the frame appears too low by a few pixels.
9723
9724 This seems to be so because initially, while Emacs is starting,
9725 the column widget's height and the frame's pixel height are
9726 different. The column widget's height is the right one. In
9727 later invocations, when Emacs is up, the frame's pixel height
9728 is right, though.
9729
9730 It's not obvious where the initial small difference comes from.
9731 2000-12-01, gerd. */
9732
9733 XtVaGetValues (f->output_data.x->column_widget, XtNheight, &height, NULL);
9734 #endif
9735
9736 if (flags & YNegative)
9737 f->top_pos = x_display_pixel_height (FRAME_DISPLAY_INFO (f))
9738 - height + f->top_pos;
9739 }
9740
9741 /* The left_pos and top_pos
9742 are now relative to the top and left screen edges,
9743 so the flags should correspond. */
9744 f->size_hint_flags &= ~ (XNegative | YNegative);
9745 }
9746
9747 /* CHANGE_GRAVITY is 1 when calling from Fset_frame_position,
9748 to really change the position, and 0 when calling from
9749 x_make_frame_visible (in that case, XOFF and YOFF are the current
9750 position values). It is -1 when calling from x_set_frame_parameters,
9751 which means, do adjust for borders but don't change the gravity. */
9752
9753 void
9754 x_set_offset (struct frame *f, register int xoff, register int yoff, int change_gravity)
9755 {
9756 int modified_top, modified_left;
9757
9758 if (change_gravity > 0)
9759 {
9760 f->top_pos = yoff;
9761 f->left_pos = xoff;
9762 f->size_hint_flags &= ~ (XNegative | YNegative);
9763 if (xoff < 0)
9764 f->size_hint_flags |= XNegative;
9765 if (yoff < 0)
9766 f->size_hint_flags |= YNegative;
9767 f->win_gravity = NorthWestGravity;
9768 }
9769 x_calc_absolute_position (f);
9770
9771 block_input ();
9772 x_wm_set_size_hint (f, 0, false);
9773
9774 modified_left = f->left_pos;
9775 modified_top = f->top_pos;
9776
9777 if (change_gravity != 0 && FRAME_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A)
9778 {
9779 /* Some WMs (twm, wmaker at least) has an offset that is smaller
9780 than the WM decorations. So we use the calculated offset instead
9781 of the WM decoration sizes here (x/y_pixels_outer_diff). */
9782 modified_left += FRAME_X_OUTPUT (f)->move_offset_left;
9783 modified_top += FRAME_X_OUTPUT (f)->move_offset_top;
9784 }
9785
9786 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
9787 modified_left, modified_top);
9788
9789 x_sync_with_move (f, f->left_pos, f->top_pos,
9790 FRAME_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN);
9791
9792 /* change_gravity is non-zero when this function is called from Lisp to
9793 programmatically move a frame. In that case, we call
9794 x_check_expected_move to discover if we have a "Type A" or "Type B"
9795 window manager, and, for a "Type A" window manager, adjust the position
9796 of the frame.
9797
9798 We call x_check_expected_move if a programmatic move occurred, and
9799 either the window manager type (A/B) is unknown or it is Type A but we
9800 need to compute the top/left offset adjustment for this frame. */
9801
9802 if (change_gravity != 0
9803 && (FRAME_DISPLAY_INFO (f)->wm_type == X_WMTYPE_UNKNOWN
9804 || (FRAME_DISPLAY_INFO (f)->wm_type == X_WMTYPE_A
9805 && (FRAME_X_OUTPUT (f)->move_offset_left == 0
9806 && FRAME_X_OUTPUT (f)->move_offset_top == 0))))
9807 x_check_expected_move (f, modified_left, modified_top);
9808
9809 unblock_input ();
9810 }
9811
9812 /* Return true if _NET_SUPPORTING_WM_CHECK window exists and _NET_SUPPORTED
9813 on the root window for frame F contains ATOMNAME.
9814 This is how a WM check shall be done according to the Window Manager
9815 Specification/Extended Window Manager Hints at
9816 http://freedesktop.org/wiki/Specifications/wm-spec. */
9817
9818 static bool
9819 wm_supports (struct frame *f, Atom want_atom)
9820 {
9821 Atom actual_type;
9822 unsigned long actual_size, bytes_remaining;
9823 int i, rc, actual_format;
9824 bool ret;
9825 Window wmcheck_window;
9826 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
9827 Window target_window = dpyinfo->root_window;
9828 int max_len = 65536;
9829 Display *dpy = FRAME_X_DISPLAY (f);
9830 unsigned char *tmp_data = NULL;
9831 Atom target_type = XA_WINDOW;
9832
9833 block_input ();
9834
9835 x_catch_errors (dpy);
9836 rc = XGetWindowProperty (dpy, target_window,
9837 dpyinfo->Xatom_net_supporting_wm_check,
9838 0, max_len, False, target_type,
9839 &actual_type, &actual_format, &actual_size,
9840 &bytes_remaining, &tmp_data);
9841
9842 if (rc != Success || actual_type != XA_WINDOW || x_had_errors_p (dpy))
9843 {
9844 if (tmp_data) XFree (tmp_data);
9845 x_uncatch_errors ();
9846 unblock_input ();
9847 return false;
9848 }
9849
9850 wmcheck_window = *(Window *) tmp_data;
9851 XFree (tmp_data);
9852
9853 /* Check if window exists. */
9854 XSelectInput (dpy, wmcheck_window, StructureNotifyMask);
9855 x_sync (f);
9856 if (x_had_errors_p (dpy))
9857 {
9858 x_uncatch_errors ();
9859 unblock_input ();
9860 return false;
9861 }
9862
9863 if (dpyinfo->net_supported_window != wmcheck_window)
9864 {
9865 /* Window changed, reload atoms */
9866 if (dpyinfo->net_supported_atoms != NULL)
9867 XFree (dpyinfo->net_supported_atoms);
9868 dpyinfo->net_supported_atoms = NULL;
9869 dpyinfo->nr_net_supported_atoms = 0;
9870 dpyinfo->net_supported_window = 0;
9871
9872 target_type = XA_ATOM;
9873 tmp_data = NULL;
9874 rc = XGetWindowProperty (dpy, target_window,
9875 dpyinfo->Xatom_net_supported,
9876 0, max_len, False, target_type,
9877 &actual_type, &actual_format, &actual_size,
9878 &bytes_remaining, &tmp_data);
9879
9880 if (rc != Success || actual_type != XA_ATOM || x_had_errors_p (dpy))
9881 {
9882 if (tmp_data) XFree (tmp_data);
9883 x_uncatch_errors ();
9884 unblock_input ();
9885 return false;
9886 }
9887
9888 dpyinfo->net_supported_atoms = (Atom *)tmp_data;
9889 dpyinfo->nr_net_supported_atoms = actual_size;
9890 dpyinfo->net_supported_window = wmcheck_window;
9891 }
9892
9893 ret = false;
9894
9895 for (i = 0; !ret && i < dpyinfo->nr_net_supported_atoms; ++i)
9896 ret = dpyinfo->net_supported_atoms[i] == want_atom;
9897
9898 x_uncatch_errors ();
9899 unblock_input ();
9900
9901 return ret;
9902 }
9903
9904 static void
9905 set_wm_state (Lisp_Object frame, bool add, Atom atom, Atom value)
9906 {
9907 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (XFRAME (frame));
9908
9909 x_send_client_event (frame, make_number (0), frame,
9910 dpyinfo->Xatom_net_wm_state,
9911 make_number (32),
9912 /* 1 = add, 0 = remove */
9913 Fcons
9914 (make_number (add),
9915 Fcons
9916 (make_fixnum_or_float (atom),
9917 (value != 0
9918 ? list1 (make_fixnum_or_float (value))
9919 : Qnil))));
9920 }
9921
9922 void
9923 x_set_sticky (struct frame *f, Lisp_Object new_value, Lisp_Object old_value)
9924 {
9925 Lisp_Object frame;
9926 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
9927
9928 XSETFRAME (frame, f);
9929
9930 set_wm_state (frame, !NILP (new_value),
9931 dpyinfo->Xatom_net_wm_state_sticky, None);
9932 }
9933
9934 /* Return the current _NET_WM_STATE.
9935 SIZE_STATE is set to one of the FULLSCREEN_* values.
9936 Set *STICKY to the sticky state.
9937
9938 Return true iff we are not hidden. */
9939
9940 static bool
9941 get_current_wm_state (struct frame *f,
9942 Window window,
9943 int *size_state,
9944 bool *sticky)
9945 {
9946 Atom actual_type;
9947 unsigned long actual_size, bytes_remaining;
9948 int i, rc, actual_format;
9949 bool is_hidden = false;
9950 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
9951 long max_len = 65536;
9952 Display *dpy = FRAME_X_DISPLAY (f);
9953 unsigned char *tmp_data = NULL;
9954 Atom target_type = XA_ATOM;
9955
9956 *sticky = false;
9957 *size_state = FULLSCREEN_NONE;
9958
9959 block_input ();
9960 x_catch_errors (dpy);
9961 rc = XGetWindowProperty (dpy, window, dpyinfo->Xatom_net_wm_state,
9962 0, max_len, False, target_type,
9963 &actual_type, &actual_format, &actual_size,
9964 &bytes_remaining, &tmp_data);
9965
9966 if (rc != Success || actual_type != target_type || x_had_errors_p (dpy))
9967 {
9968 if (tmp_data) XFree (tmp_data);
9969 x_uncatch_errors ();
9970 unblock_input ();
9971 return !FRAME_ICONIFIED_P (f);
9972 }
9973
9974 x_uncatch_errors ();
9975
9976 for (i = 0; i < actual_size; ++i)
9977 {
9978 Atom a = ((Atom*)tmp_data)[i];
9979 if (a == dpyinfo->Xatom_net_wm_state_hidden)
9980 is_hidden = true;
9981 else if (a == dpyinfo->Xatom_net_wm_state_maximized_horz)
9982 {
9983 if (*size_state == FULLSCREEN_HEIGHT)
9984 *size_state = FULLSCREEN_MAXIMIZED;
9985 else
9986 *size_state = FULLSCREEN_WIDTH;
9987 }
9988 else if (a == dpyinfo->Xatom_net_wm_state_maximized_vert)
9989 {
9990 if (*size_state == FULLSCREEN_WIDTH)
9991 *size_state = FULLSCREEN_MAXIMIZED;
9992 else
9993 *size_state = FULLSCREEN_HEIGHT;
9994 }
9995 else if (a == dpyinfo->Xatom_net_wm_state_fullscreen)
9996 *size_state = FULLSCREEN_BOTH;
9997 else if (a == dpyinfo->Xatom_net_wm_state_sticky)
9998 *sticky = true;
9999 }
10000
10001 if (tmp_data) XFree (tmp_data);
10002 unblock_input ();
10003 return ! is_hidden;
10004 }
10005
10006 /* Do fullscreen as specified in extended window manager hints */
10007
10008 static bool
10009 do_ewmh_fullscreen (struct frame *f)
10010 {
10011 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
10012 bool have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state);
10013 int cur;
10014 bool dummy;
10015
10016 get_current_wm_state (f, FRAME_OUTER_WINDOW (f), &cur, &dummy);
10017
10018 /* Some window managers don't say they support _NET_WM_STATE, but they do say
10019 they support _NET_WM_STATE_FULLSCREEN. Try that also. */
10020 if (!have_net_atom)
10021 have_net_atom = wm_supports (f, dpyinfo->Xatom_net_wm_state_fullscreen);
10022
10023 if (have_net_atom && cur != f->want_fullscreen)
10024 {
10025 Lisp_Object frame;
10026
10027 XSETFRAME (frame, f);
10028
10029 /* Keep number of calls to set_wm_state as low as possible.
10030 Some window managers, or possible Gtk+, hangs when too many
10031 are sent at once. */
10032 switch (f->want_fullscreen)
10033 {
10034 case FULLSCREEN_BOTH:
10035 if (cur != FULLSCREEN_BOTH)
10036 set_wm_state (frame, true, dpyinfo->Xatom_net_wm_state_fullscreen,
10037 None);
10038 break;
10039 case FULLSCREEN_WIDTH:
10040 if (x_frame_normalize_before_maximize && cur == FULLSCREEN_MAXIMIZED)
10041 {
10042 set_wm_state (frame, false,
10043 dpyinfo->Xatom_net_wm_state_maximized_horz,
10044 dpyinfo->Xatom_net_wm_state_maximized_vert);
10045 set_wm_state (frame, true,
10046 dpyinfo->Xatom_net_wm_state_maximized_horz, None);
10047 }
10048 else
10049 {
10050 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_HEIGHT
10051 || cur == FULLSCREEN_MAXIMIZED)
10052 set_wm_state (frame, false, dpyinfo->Xatom_net_wm_state_fullscreen,
10053 dpyinfo->Xatom_net_wm_state_maximized_vert);
10054 if (cur != FULLSCREEN_MAXIMIZED || x_frame_normalize_before_maximize)
10055 set_wm_state (frame, true,
10056 dpyinfo->Xatom_net_wm_state_maximized_horz, None);
10057 }
10058 break;
10059 case FULLSCREEN_HEIGHT:
10060 if (x_frame_normalize_before_maximize && cur == FULLSCREEN_MAXIMIZED)
10061 {
10062 set_wm_state (frame, false,
10063 dpyinfo->Xatom_net_wm_state_maximized_horz,
10064 dpyinfo->Xatom_net_wm_state_maximized_vert);
10065 set_wm_state (frame, true,
10066 dpyinfo->Xatom_net_wm_state_maximized_vert, None);
10067 }
10068 else
10069 {
10070 if (cur == FULLSCREEN_BOTH || cur == FULLSCREEN_WIDTH
10071 || cur == FULLSCREEN_MAXIMIZED)
10072 set_wm_state (frame, false, dpyinfo->Xatom_net_wm_state_fullscreen,
10073 dpyinfo->Xatom_net_wm_state_maximized_horz);
10074 if (cur != FULLSCREEN_MAXIMIZED || x_frame_normalize_before_maximize)
10075 set_wm_state (frame, true,
10076 dpyinfo->Xatom_net_wm_state_maximized_vert, None);
10077 }
10078 break;
10079 case FULLSCREEN_MAXIMIZED:
10080 if (x_frame_normalize_before_maximize && cur == FULLSCREEN_BOTH)
10081 {
10082 set_wm_state (frame, false,
10083 dpyinfo->Xatom_net_wm_state_fullscreen, None);
10084 set_wm_state (frame, true,
10085 dpyinfo->Xatom_net_wm_state_maximized_horz,
10086 dpyinfo->Xatom_net_wm_state_maximized_vert);
10087 }
10088 else if (x_frame_normalize_before_maximize && cur == FULLSCREEN_WIDTH)
10089 {
10090 set_wm_state (frame, false,
10091 dpyinfo->Xatom_net_wm_state_maximized_horz, None);
10092 set_wm_state (frame, true,
10093 dpyinfo->Xatom_net_wm_state_maximized_horz,
10094 dpyinfo->Xatom_net_wm_state_maximized_vert);
10095 }
10096 else if (x_frame_normalize_before_maximize && cur == FULLSCREEN_HEIGHT)
10097 {
10098 set_wm_state (frame, false,
10099 dpyinfo->Xatom_net_wm_state_maximized_vert, None);
10100 set_wm_state (frame, true,
10101 dpyinfo->Xatom_net_wm_state_maximized_horz,
10102 dpyinfo->Xatom_net_wm_state_maximized_vert);
10103 }
10104 else
10105 {
10106 if (cur == FULLSCREEN_BOTH)
10107 set_wm_state (frame, false, dpyinfo->Xatom_net_wm_state_fullscreen,
10108 None);
10109 else if (cur == FULLSCREEN_HEIGHT)
10110 set_wm_state (frame, true,
10111 dpyinfo->Xatom_net_wm_state_maximized_horz, None);
10112 else if (cur == FULLSCREEN_WIDTH)
10113 set_wm_state (frame, true, None,
10114 dpyinfo->Xatom_net_wm_state_maximized_vert);
10115 else
10116 set_wm_state (frame, true,
10117 dpyinfo->Xatom_net_wm_state_maximized_horz,
10118 dpyinfo->Xatom_net_wm_state_maximized_vert);
10119 }
10120 break;
10121 case FULLSCREEN_NONE:
10122 if (cur == FULLSCREEN_BOTH)
10123 set_wm_state (frame, false, dpyinfo->Xatom_net_wm_state_fullscreen,
10124 None);
10125 else
10126 set_wm_state (frame, false,
10127 dpyinfo->Xatom_net_wm_state_maximized_horz,
10128 dpyinfo->Xatom_net_wm_state_maximized_vert);
10129 }
10130
10131 f->want_fullscreen = FULLSCREEN_NONE;
10132
10133 }
10134
10135 return have_net_atom;
10136 }
10137
10138 static void
10139 XTfullscreen_hook (struct frame *f)
10140 {
10141 if (FRAME_VISIBLE_P (f))
10142 {
10143 block_input ();
10144 x_check_fullscreen (f);
10145 x_sync (f);
10146 unblock_input ();
10147 }
10148 }
10149
10150
10151 static bool
10152 x_handle_net_wm_state (struct frame *f, const XPropertyEvent *event)
10153 {
10154 int value = FULLSCREEN_NONE;
10155 Lisp_Object lval;
10156 bool sticky = false;
10157 bool not_hidden = get_current_wm_state (f, event->window, &value, &sticky);
10158
10159 lval = Qnil;
10160 switch (value)
10161 {
10162 case FULLSCREEN_WIDTH:
10163 lval = Qfullwidth;
10164 break;
10165 case FULLSCREEN_HEIGHT:
10166 lval = Qfullheight;
10167 break;
10168 case FULLSCREEN_BOTH:
10169 lval = Qfullboth;
10170 break;
10171 case FULLSCREEN_MAXIMIZED:
10172 lval = Qmaximized;
10173 break;
10174 }
10175
10176 frame_size_history_add
10177 (f, Qx_handle_net_wm_state, 0, 0,
10178 list2 (get_frame_param (f, Qfullscreen), lval));
10179
10180 store_frame_param (f, Qfullscreen, lval);
10181 store_frame_param (f, Qsticky, sticky ? Qt : Qnil);
10182
10183 return not_hidden;
10184 }
10185
10186 /* Check if we need to resize the frame due to a fullscreen request.
10187 If so needed, resize the frame. */
10188 static void
10189 x_check_fullscreen (struct frame *f)
10190 {
10191 if (do_ewmh_fullscreen (f))
10192 return;
10193
10194 if (f->output_data.x->parent_desc != FRAME_DISPLAY_INFO (f)->root_window)
10195 return; /* Only fullscreen without WM or with EWM hints (above). */
10196
10197 /* Setting fullscreen to nil doesn't do anything. We could save the
10198 last non-fullscreen size and restore it, but it seems like a
10199 lot of work for this unusual case (no window manager running). */
10200
10201 if (f->want_fullscreen != FULLSCREEN_NONE)
10202 {
10203 int width = FRAME_PIXEL_WIDTH (f), height = FRAME_PIXEL_HEIGHT (f);
10204 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
10205
10206 switch (f->want_fullscreen)
10207 {
10208 /* No difference between these two when there is no WM */
10209 case FULLSCREEN_BOTH:
10210 case FULLSCREEN_MAXIMIZED:
10211 width = x_display_pixel_width (dpyinfo);
10212 height = x_display_pixel_height (dpyinfo);
10213 break;
10214 case FULLSCREEN_WIDTH:
10215 width = x_display_pixel_width (dpyinfo);
10216 height = height + FRAME_MENUBAR_HEIGHT (f);
10217 break;
10218 case FULLSCREEN_HEIGHT:
10219 height = x_display_pixel_height (dpyinfo);
10220 }
10221
10222 frame_size_history_add
10223 (f, Qx_check_fullscreen, width, height, Qnil);
10224
10225 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
10226 width, height);
10227
10228 if (FRAME_VISIBLE_P (f))
10229 x_wait_for_event (f, ConfigureNotify);
10230 else
10231 {
10232 change_frame_size (f, width, height - FRAME_MENUBAR_HEIGHT (f),
10233 false, true, false, true);
10234 x_sync (f);
10235 }
10236 }
10237 }
10238
10239 /* This function is called by x_set_offset to determine whether the window
10240 manager interfered with the positioning of the frame. Type A window
10241 managers position the surrounding window manager decorations a small
10242 amount above and left of the user-supplied position. Type B window
10243 managers position the surrounding window manager decorations at the
10244 user-specified position. If we detect a Type A window manager, we
10245 compensate by moving the window right and down by the proper amount. */
10246
10247 static void
10248 x_check_expected_move (struct frame *f, int expected_left, int expected_top)
10249 {
10250 int current_left = 0, current_top = 0;
10251
10252 /* x_real_positions returns the left and top offsets of the outermost
10253 window manager window around the frame. */
10254
10255 x_real_positions (f, &current_left, &current_top);
10256
10257 if (current_left != expected_left || current_top != expected_top)
10258 {
10259 /* It's a "Type A" window manager. */
10260
10261 int adjusted_left;
10262 int adjusted_top;
10263
10264 FRAME_DISPLAY_INFO (f)->wm_type = X_WMTYPE_A;
10265 FRAME_X_OUTPUT (f)->move_offset_left = expected_left - current_left;
10266 FRAME_X_OUTPUT (f)->move_offset_top = expected_top - current_top;
10267
10268 /* Now fix the mispositioned frame's location. */
10269
10270 adjusted_left = expected_left + FRAME_X_OUTPUT (f)->move_offset_left;
10271 adjusted_top = expected_top + FRAME_X_OUTPUT (f)->move_offset_top;
10272
10273 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
10274 adjusted_left, adjusted_top);
10275
10276 x_sync_with_move (f, expected_left, expected_top, false);
10277 }
10278 else
10279 /* It's a "Type B" window manager. We don't have to adjust the
10280 frame's position. */
10281
10282 FRAME_DISPLAY_INFO (f)->wm_type = X_WMTYPE_B;
10283 }
10284
10285
10286 /* Wait for XGetGeometry to return up-to-date position information for a
10287 recently-moved frame. Call this immediately after calling XMoveWindow.
10288 If FUZZY is non-zero, then LEFT and TOP are just estimates of where the
10289 frame has been moved to, so we use a fuzzy position comparison instead
10290 of an exact comparison. */
10291
10292 static void
10293 x_sync_with_move (struct frame *f, int left, int top, bool fuzzy)
10294 {
10295 int count = 0;
10296
10297 while (count++ < 50)
10298 {
10299 int current_left = 0, current_top = 0;
10300
10301 /* In theory, this call to XSync only needs to happen once, but in
10302 practice, it doesn't seem to work, hence the need for the surrounding
10303 loop. */
10304
10305 XSync (FRAME_X_DISPLAY (f), False);
10306 x_real_positions (f, &current_left, &current_top);
10307
10308 if (fuzzy)
10309 {
10310 /* The left fuzz-factor is 10 pixels. The top fuzz-factor is 40
10311 pixels. */
10312
10313 if (eabs (current_left - left) <= 10
10314 && eabs (current_top - top) <= 40)
10315 return;
10316 }
10317 else if (current_left == left && current_top == top)
10318 return;
10319 }
10320
10321 /* As a last resort, just wait 0.5 seconds and hope that XGetGeometry
10322 will then return up-to-date position info. */
10323
10324 wait_reading_process_output (0, 500000000, 0, false, Qnil, NULL, 0);
10325 }
10326
10327
10328 /* Wait for an event on frame F matching EVENTTYPE. */
10329 void
10330 x_wait_for_event (struct frame *f, int eventtype)
10331 {
10332 int level = interrupt_input_blocked;
10333
10334 fd_set fds;
10335 struct timespec tmo, tmo_at, time_now;
10336 int fd = ConnectionNumber (FRAME_X_DISPLAY (f));
10337
10338 f->wait_event_type = eventtype;
10339
10340 /* Set timeout to 0.1 second. Hopefully not noticeable.
10341 Maybe it should be configurable. */
10342 tmo = make_timespec (0, 100 * 1000 * 1000);
10343 tmo_at = timespec_add (current_timespec (), tmo);
10344
10345 while (f->wait_event_type)
10346 {
10347 pending_signals = true;
10348 totally_unblock_input ();
10349 /* XTread_socket is called after unblock. */
10350 block_input ();
10351 interrupt_input_blocked = level;
10352
10353 FD_ZERO (&fds);
10354 FD_SET (fd, &fds);
10355
10356 time_now = current_timespec ();
10357 if (timespec_cmp (tmo_at, time_now) < 0)
10358 break;
10359
10360 tmo = timespec_sub (tmo_at, time_now);
10361 if (pselect (fd + 1, &fds, NULL, NULL, &tmo, NULL) == 0)
10362 break; /* Timeout */
10363 }
10364
10365 f->wait_event_type = 0;
10366 }
10367
10368
10369 /* Change the size of frame F's X window to WIDTH/HEIGHT in the case F
10370 doesn't have a widget. If CHANGE_GRAVITY, change to
10371 top-left-corner window gravity for this size change and subsequent
10372 size changes. Otherwise leave the window gravity unchanged. */
10373
10374 static void
10375 x_set_window_size_1 (struct frame *f, bool change_gravity,
10376 int width, int height)
10377 {
10378 int pixelwidth = FRAME_TEXT_TO_PIXEL_WIDTH (f, width);
10379 int pixelheight = FRAME_TEXT_TO_PIXEL_HEIGHT (f, height);
10380 int old_width = FRAME_PIXEL_WIDTH (f);
10381 int old_height = FRAME_PIXEL_HEIGHT (f);
10382 Lisp_Object fullscreen = get_frame_param (f, Qfullscreen);
10383
10384 if (change_gravity) f->win_gravity = NorthWestGravity;
10385 x_wm_set_size_hint (f, 0, false);
10386
10387 /* When the frame is fullheight and we only want to change the width
10388 or it is fullwidth and we only want to change the height we should
10389 be able to preserve the fullscreen property. However, due to the
10390 fact that we have to send a resize request anyway, the window
10391 manager will abolish it. At least the respective size should
10392 remain unchanged but giving the frame back its normal size will
10393 be broken ... */
10394 if (EQ (fullscreen, Qfullwidth) && width == FRAME_TEXT_WIDTH (f))
10395 {
10396 frame_size_history_add
10397 (f, Qxg_frame_set_char_size_1, width, height,
10398 list2 (make_number (old_height),
10399 make_number (pixelheight + FRAME_MENUBAR_HEIGHT (f))));
10400
10401 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
10402 old_width, pixelheight + FRAME_MENUBAR_HEIGHT (f));
10403 }
10404 else if (EQ (fullscreen, Qfullheight) && height == FRAME_TEXT_HEIGHT (f))
10405 {
10406 frame_size_history_add
10407 (f, Qxg_frame_set_char_size_2, width, height,
10408 list2 (make_number (old_width), make_number (pixelwidth)));
10409
10410 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
10411 pixelwidth, old_height);
10412 }
10413
10414 else
10415 {
10416 frame_size_history_add
10417 (f, Qxg_frame_set_char_size_3, width, height,
10418 list2 (make_number (pixelwidth + FRAME_TOOLBAR_WIDTH (f)),
10419 make_number (pixelheight + FRAME_TOOLBAR_HEIGHT (f)
10420 + FRAME_MENUBAR_HEIGHT (f))));
10421
10422 XResizeWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
10423 pixelwidth, pixelheight + FRAME_MENUBAR_HEIGHT (f));
10424 fullscreen = Qnil;
10425 }
10426
10427
10428
10429 /* We've set {FRAME,PIXEL}_{WIDTH,HEIGHT} to the values we hope to
10430 receive in the ConfigureNotify event; if we get what we asked
10431 for, then the event won't cause the screen to become garbaged, so
10432 we have to make sure to do it here. */
10433 SET_FRAME_GARBAGED (f);
10434
10435 /* Now, strictly speaking, we can't be sure that this is accurate,
10436 but the window manager will get around to dealing with the size
10437 change request eventually, and we'll hear how it went when the
10438 ConfigureNotify event gets here.
10439
10440 We could just not bother storing any of this information here,
10441 and let the ConfigureNotify event set everything up, but that
10442 might be kind of confusing to the Lisp code, since size changes
10443 wouldn't be reported in the frame parameters until some random
10444 point in the future when the ConfigureNotify event arrives.
10445
10446 Pass true for DELAY since we can't run Lisp code inside of
10447 a BLOCK_INPUT. */
10448
10449 /* But the ConfigureNotify may in fact never arrive, and then this is
10450 not right if the frame is visible. Instead wait (with timeout)
10451 for the ConfigureNotify. */
10452 if (FRAME_VISIBLE_P (f))
10453 {
10454 x_wait_for_event (f, ConfigureNotify);
10455
10456 if (!NILP (fullscreen))
10457 /* Try to restore fullscreen state. */
10458 {
10459 store_frame_param (f, Qfullscreen, fullscreen);
10460 x_set_fullscreen (f, fullscreen, fullscreen);
10461 }
10462 }
10463 else
10464 {
10465 change_frame_size (f, width, height, false, true, false, true);
10466 x_sync (f);
10467 }
10468 }
10469
10470
10471 /* Call this to change the size of frame F's x-window.
10472 If CHANGE_GRAVITY, change to top-left-corner window gravity
10473 for this size change and subsequent size changes.
10474 Otherwise we leave the window gravity unchanged. */
10475
10476 void
10477 x_set_window_size (struct frame *f, bool change_gravity,
10478 int width, int height, bool pixelwise)
10479 {
10480 block_input ();
10481
10482 /* The following breaks our calculations. If it's really needed,
10483 think of something else. */
10484 #if false
10485 if (NILP (tip_frame) || XFRAME (tip_frame) != f)
10486 {
10487 int text_width, text_height;
10488
10489 /* When the frame is maximized/fullscreen or running under for
10490 example Xmonad, x_set_window_size_1 will be a no-op.
10491 In that case, the right thing to do is extend rows/width to
10492 the current frame size. We do that first if x_set_window_size_1
10493 turns out to not be a no-op (there is no way to know).
10494 The size will be adjusted again if the frame gets a
10495 ConfigureNotify event as a result of x_set_window_size. */
10496 int pixelh = FRAME_PIXEL_HEIGHT (f);
10497 #ifdef USE_X_TOOLKIT
10498 /* The menu bar is not part of text lines. The tool bar
10499 is however. */
10500 pixelh -= FRAME_MENUBAR_HEIGHT (f);
10501 #endif
10502 text_width = FRAME_PIXEL_TO_TEXT_WIDTH (f, FRAME_PIXEL_WIDTH (f));
10503 text_height = FRAME_PIXEL_TO_TEXT_HEIGHT (f, pixelh);
10504
10505 change_frame_size (f, text_width, text_height, false, true, false, true);
10506 }
10507 #endif
10508
10509 /* Pixelize width and height, if necessary. */
10510 if (! pixelwise)
10511 {
10512 width = width * FRAME_COLUMN_WIDTH (f);
10513 height = height * FRAME_LINE_HEIGHT (f);
10514 }
10515
10516 #ifdef USE_GTK
10517 if (FRAME_GTK_WIDGET (f))
10518 xg_frame_set_char_size (f, width, height);
10519 else
10520 x_set_window_size_1 (f, change_gravity, width, height);
10521 #else /* not USE_GTK */
10522 x_set_window_size_1 (f, change_gravity, width, height);
10523 x_clear_under_internal_border (f);
10524 #endif /* not USE_GTK */
10525
10526 /* If cursor was outside the new size, mark it as off. */
10527 mark_window_cursors_off (XWINDOW (f->root_window));
10528
10529 /* Clear out any recollection of where the mouse highlighting was,
10530 since it might be in a place that's outside the new frame size.
10531 Actually checking whether it is outside is a pain in the neck,
10532 so don't try--just let the highlighting be done afresh with new size. */
10533 cancel_mouse_face (f);
10534
10535 unblock_input ();
10536
10537 do_pending_window_change (false);
10538 }
10539
10540 /* Move the mouse to position pixel PIX_X, PIX_Y relative to frame F. */
10541
10542 void
10543 frame_set_mouse_pixel_position (struct frame *f, int pix_x, int pix_y)
10544 {
10545 block_input ();
10546
10547 XWarpPointer (FRAME_X_DISPLAY (f), None, FRAME_X_WINDOW (f),
10548 0, 0, 0, 0, pix_x, pix_y);
10549 unblock_input ();
10550 }
10551 \f
10552 /* Raise frame F. */
10553
10554 void
10555 x_raise_frame (struct frame *f)
10556 {
10557 block_input ();
10558 if (FRAME_VISIBLE_P (f))
10559 XRaiseWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
10560 XFlush (FRAME_X_DISPLAY (f));
10561 unblock_input ();
10562 }
10563
10564 /* Lower frame F. */
10565
10566 static void
10567 x_lower_frame (struct frame *f)
10568 {
10569 if (FRAME_VISIBLE_P (f))
10570 {
10571 block_input ();
10572 XLowerWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f));
10573 XFlush (FRAME_X_DISPLAY (f));
10574 unblock_input ();
10575 }
10576 }
10577
10578 /* Request focus with XEmbed */
10579
10580 void
10581 xembed_request_focus (struct frame *f)
10582 {
10583 /* See XEmbed Protocol Specification at
10584 http://freedesktop.org/wiki/Specifications/xembed-spec */
10585 if (FRAME_VISIBLE_P (f))
10586 xembed_send_message (f, CurrentTime,
10587 XEMBED_REQUEST_FOCUS, 0, 0, 0);
10588 }
10589
10590 /* Activate frame with Extended Window Manager Hints */
10591
10592 void
10593 x_ewmh_activate_frame (struct frame *f)
10594 {
10595 /* See Window Manager Specification/Extended Window Manager Hints at
10596 http://freedesktop.org/wiki/Specifications/wm-spec */
10597
10598 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
10599
10600 if (FRAME_VISIBLE_P (f) && wm_supports (f, dpyinfo->Xatom_net_active_window))
10601 {
10602 Lisp_Object frame;
10603 XSETFRAME (frame, f);
10604 x_send_client_event (frame, make_number (0), frame,
10605 dpyinfo->Xatom_net_active_window,
10606 make_number (32),
10607 list2i (1, dpyinfo->last_user_time));
10608 }
10609 }
10610
10611 static void
10612 XTframe_raise_lower (struct frame *f, bool raise_flag)
10613 {
10614 if (raise_flag)
10615 x_raise_frame (f);
10616 else
10617 x_lower_frame (f);
10618 }
10619 \f
10620 /* XEmbed implementation. */
10621
10622 #if defined USE_X_TOOLKIT || ! defined USE_GTK
10623
10624 /* XEmbed implementation. */
10625
10626 #define XEMBED_VERSION 0
10627
10628 static void
10629 xembed_set_info (struct frame *f, enum xembed_info flags)
10630 {
10631 unsigned long data[2];
10632 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
10633
10634 data[0] = XEMBED_VERSION;
10635 data[1] = flags;
10636
10637 XChangeProperty (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
10638 dpyinfo->Xatom_XEMBED_INFO, dpyinfo->Xatom_XEMBED_INFO,
10639 32, PropModeReplace, (unsigned char *) data, 2);
10640 }
10641 #endif /* defined USE_X_TOOLKIT || ! defined USE_GTK */
10642
10643 static void
10644 xembed_send_message (struct frame *f, Time t, enum xembed_message msg,
10645 long int detail, long int data1, long int data2)
10646 {
10647 XEvent event;
10648
10649 event.xclient.type = ClientMessage;
10650 event.xclient.window = FRAME_X_OUTPUT (f)->parent_desc;
10651 event.xclient.message_type = FRAME_DISPLAY_INFO (f)->Xatom_XEMBED;
10652 event.xclient.format = 32;
10653 event.xclient.data.l[0] = t;
10654 event.xclient.data.l[1] = msg;
10655 event.xclient.data.l[2] = detail;
10656 event.xclient.data.l[3] = data1;
10657 event.xclient.data.l[4] = data2;
10658
10659 XSendEvent (FRAME_X_DISPLAY (f), FRAME_X_OUTPUT (f)->parent_desc,
10660 False, NoEventMask, &event);
10661 XSync (FRAME_X_DISPLAY (f), False);
10662 }
10663 \f
10664 /* Change of visibility. */
10665
10666 /* This tries to wait until the frame is really visible.
10667 However, if the window manager asks the user where to position
10668 the frame, this will return before the user finishes doing that.
10669 The frame will not actually be visible at that time,
10670 but it will become visible later when the window manager
10671 finishes with it. */
10672
10673 void
10674 x_make_frame_visible (struct frame *f)
10675 {
10676 int original_top, original_left;
10677 int tries = 0;
10678
10679 block_input ();
10680
10681 x_set_bitmap_icon (f);
10682
10683 if (! FRAME_VISIBLE_P (f))
10684 {
10685 /* We test FRAME_GARBAGED_P here to make sure we don't
10686 call x_set_offset a second time
10687 if we get to x_make_frame_visible a second time
10688 before the window gets really visible. */
10689 if (! FRAME_ICONIFIED_P (f)
10690 && ! FRAME_X_EMBEDDED_P (f)
10691 && ! f->output_data.x->asked_for_visible)
10692 x_set_offset (f, f->left_pos, f->top_pos, 0);
10693
10694 f->output_data.x->asked_for_visible = true;
10695
10696 if (! EQ (Vx_no_window_manager, Qt))
10697 x_wm_set_window_state (f, NormalState);
10698 #ifdef USE_X_TOOLKIT
10699 if (FRAME_X_EMBEDDED_P (f))
10700 xembed_set_info (f, XEMBED_MAPPED);
10701 else
10702 {
10703 /* This was XtPopup, but that did nothing for an iconified frame. */
10704 XtMapWidget (f->output_data.x->widget);
10705 }
10706 #else /* not USE_X_TOOLKIT */
10707 #ifdef USE_GTK
10708 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
10709 gtk_window_deiconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
10710 #else
10711 if (FRAME_X_EMBEDDED_P (f))
10712 xembed_set_info (f, XEMBED_MAPPED);
10713 else
10714 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
10715 #endif /* not USE_GTK */
10716 #endif /* not USE_X_TOOLKIT */
10717 }
10718
10719 XFlush (FRAME_X_DISPLAY (f));
10720
10721 /* Synchronize to ensure Emacs knows the frame is visible
10722 before we do anything else. We do this loop with input not blocked
10723 so that incoming events are handled. */
10724 {
10725 Lisp_Object frame;
10726 /* This must be before UNBLOCK_INPUT
10727 since events that arrive in response to the actions above
10728 will set it when they are handled. */
10729 bool previously_visible = f->output_data.x->has_been_visible;
10730
10731 original_left = f->left_pos;
10732 original_top = f->top_pos;
10733
10734 /* This must come after we set COUNT. */
10735 unblock_input ();
10736
10737 /* We unblock here so that arriving X events are processed. */
10738
10739 /* Now move the window back to where it was "supposed to be".
10740 But don't do it if the gravity is negative.
10741 When the gravity is negative, this uses a position
10742 that is 3 pixels too low. Perhaps that's really the border width.
10743
10744 Don't do this if the window has never been visible before,
10745 because the window manager may choose the position
10746 and we don't want to override it. */
10747
10748 if (! FRAME_VISIBLE_P (f)
10749 && ! FRAME_ICONIFIED_P (f)
10750 && ! FRAME_X_EMBEDDED_P (f)
10751 && f->win_gravity == NorthWestGravity
10752 && previously_visible)
10753 {
10754 Drawable rootw;
10755 int x, y;
10756 unsigned int width, height, border, depth;
10757
10758 block_input ();
10759
10760 /* On some window managers (such as FVWM) moving an existing
10761 window, even to the same place, causes the window manager
10762 to introduce an offset. This can cause the window to move
10763 to an unexpected location. Check the geometry (a little
10764 slow here) and then verify that the window is in the right
10765 place. If the window is not in the right place, move it
10766 there, and take the potential window manager hit. */
10767 XGetGeometry (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
10768 &rootw, &x, &y, &width, &height, &border, &depth);
10769
10770 if (original_left != x || original_top != y)
10771 XMoveWindow (FRAME_X_DISPLAY (f), FRAME_OUTER_WINDOW (f),
10772 original_left, original_top);
10773
10774 unblock_input ();
10775 }
10776
10777 XSETFRAME (frame, f);
10778
10779 /* Process X events until a MapNotify event has been seen. */
10780 while (!FRAME_VISIBLE_P (f))
10781 {
10782 /* Force processing of queued events. */
10783 x_sync (f);
10784
10785 /* If on another desktop, the deiconify/map may be ignored and the
10786 frame never becomes visible. XMonad does this.
10787 Prevent an endless loop. */
10788 if (FRAME_ICONIFIED_P (f) && ++tries > 100)
10789 break;
10790
10791 /* This hack is still in use at least for Cygwin. See
10792 http://lists.gnu.org/archive/html/emacs-devel/2013-12/msg00351.html.
10793
10794 Machines that do polling rather than SIGIO have been
10795 observed to go into a busy-wait here. So we'll fake an
10796 alarm signal to let the handler know that there's something
10797 to be read. We used to raise a real alarm, but it seems
10798 that the handler isn't always enabled here. This is
10799 probably a bug. */
10800 if (input_polling_used ())
10801 {
10802 /* It could be confusing if a real alarm arrives while
10803 processing the fake one. Turn it off and let the
10804 handler reset it. */
10805 int old_poll_suppress_count = poll_suppress_count;
10806 poll_suppress_count = 1;
10807 poll_for_input_1 ();
10808 poll_suppress_count = old_poll_suppress_count;
10809 }
10810
10811 if (XPending (FRAME_X_DISPLAY (f)))
10812 {
10813 XEvent xev;
10814 XNextEvent (FRAME_X_DISPLAY (f), &xev);
10815 x_dispatch_event (&xev, FRAME_X_DISPLAY (f));
10816 }
10817 }
10818 }
10819 }
10820
10821 /* Change from mapped state to withdrawn state. */
10822
10823 /* Make the frame visible (mapped and not iconified). */
10824
10825 void
10826 x_make_frame_invisible (struct frame *f)
10827 {
10828 Window window;
10829
10830 /* Use the frame's outermost window, not the one we normally draw on. */
10831 window = FRAME_OUTER_WINDOW (f);
10832
10833 /* Don't keep the highlight on an invisible frame. */
10834 if (FRAME_DISPLAY_INFO (f)->x_highlight_frame == f)
10835 FRAME_DISPLAY_INFO (f)->x_highlight_frame = 0;
10836
10837 block_input ();
10838
10839 /* Before unmapping the window, update the WM_SIZE_HINTS property to claim
10840 that the current position of the window is user-specified, rather than
10841 program-specified, so that when the window is mapped again, it will be
10842 placed at the same location, without forcing the user to position it
10843 by hand again (they have already done that once for this window.) */
10844 x_wm_set_size_hint (f, 0, true);
10845
10846 #ifdef USE_GTK
10847 if (FRAME_GTK_OUTER_WIDGET (f))
10848 gtk_widget_hide (FRAME_GTK_OUTER_WIDGET (f));
10849 else
10850 #else
10851 if (FRAME_X_EMBEDDED_P (f))
10852 xembed_set_info (f, 0);
10853 else
10854 #endif
10855 {
10856
10857 if (! XWithdrawWindow (FRAME_X_DISPLAY (f), window,
10858 DefaultScreen (FRAME_X_DISPLAY (f))))
10859 {
10860 unblock_input ();
10861 error ("Can't notify window manager of window withdrawal");
10862 }
10863 }
10864
10865 /* We can't distinguish this from iconification
10866 just by the event that we get from the server.
10867 So we can't win using the usual strategy of letting
10868 FRAME_SAMPLE_VISIBILITY set this. So do it by hand,
10869 and synchronize with the server to make sure we agree. */
10870 SET_FRAME_VISIBLE (f, 0);
10871 SET_FRAME_ICONIFIED (f, false);
10872
10873 x_sync (f);
10874
10875 unblock_input ();
10876 }
10877
10878 /* Change window state from mapped to iconified. */
10879
10880 void
10881 x_iconify_frame (struct frame *f)
10882 {
10883 #ifdef USE_X_TOOLKIT
10884 int result;
10885 #endif
10886
10887 /* Don't keep the highlight on an invisible frame. */
10888 if (FRAME_DISPLAY_INFO (f)->x_highlight_frame == f)
10889 FRAME_DISPLAY_INFO (f)->x_highlight_frame = 0;
10890
10891 if (FRAME_ICONIFIED_P (f))
10892 return;
10893
10894 block_input ();
10895
10896 x_set_bitmap_icon (f);
10897
10898 #if defined (USE_GTK)
10899 if (FRAME_GTK_OUTER_WIDGET (f))
10900 {
10901 if (! FRAME_VISIBLE_P (f))
10902 gtk_widget_show_all (FRAME_GTK_OUTER_WIDGET (f));
10903
10904 gtk_window_iconify (GTK_WINDOW (FRAME_GTK_OUTER_WIDGET (f)));
10905 SET_FRAME_VISIBLE (f, 0);
10906 SET_FRAME_ICONIFIED (f, true);
10907 unblock_input ();
10908 return;
10909 }
10910 #endif
10911
10912 #ifdef USE_X_TOOLKIT
10913
10914 if (! FRAME_VISIBLE_P (f))
10915 {
10916 if (! EQ (Vx_no_window_manager, Qt))
10917 x_wm_set_window_state (f, IconicState);
10918 /* This was XtPopup, but that did nothing for an iconified frame. */
10919 XtMapWidget (f->output_data.x->widget);
10920 /* The server won't give us any event to indicate
10921 that an invisible frame was changed to an icon,
10922 so we have to record it here. */
10923 SET_FRAME_VISIBLE (f, 0);
10924 SET_FRAME_ICONIFIED (f, true);
10925 unblock_input ();
10926 return;
10927 }
10928
10929 result = XIconifyWindow (FRAME_X_DISPLAY (f),
10930 XtWindow (f->output_data.x->widget),
10931 DefaultScreen (FRAME_X_DISPLAY (f)));
10932 unblock_input ();
10933
10934 if (!result)
10935 error ("Can't notify window manager of iconification");
10936
10937 SET_FRAME_ICONIFIED (f, true);
10938 SET_FRAME_VISIBLE (f, 0);
10939
10940 block_input ();
10941 XFlush (FRAME_X_DISPLAY (f));
10942 unblock_input ();
10943 #else /* not USE_X_TOOLKIT */
10944
10945 /* Make sure the X server knows where the window should be positioned,
10946 in case the user deiconifies with the window manager. */
10947 if (! FRAME_VISIBLE_P (f)
10948 && ! FRAME_ICONIFIED_P (f)
10949 && ! FRAME_X_EMBEDDED_P (f))
10950 x_set_offset (f, f->left_pos, f->top_pos, 0);
10951
10952 /* Since we don't know which revision of X we're running, we'll use both
10953 the X11R3 and X11R4 techniques. I don't know if this is a good idea. */
10954
10955 /* X11R4: send a ClientMessage to the window manager using the
10956 WM_CHANGE_STATE type. */
10957 {
10958 XEvent msg;
10959
10960 msg.xclient.window = FRAME_X_WINDOW (f);
10961 msg.xclient.type = ClientMessage;
10962 msg.xclient.message_type = FRAME_DISPLAY_INFO (f)->Xatom_wm_change_state;
10963 msg.xclient.format = 32;
10964 msg.xclient.data.l[0] = IconicState;
10965
10966 if (! XSendEvent (FRAME_X_DISPLAY (f),
10967 DefaultRootWindow (FRAME_X_DISPLAY (f)),
10968 False,
10969 SubstructureRedirectMask | SubstructureNotifyMask,
10970 &msg))
10971 {
10972 unblock_input ();
10973 error ("Can't notify window manager of iconification");
10974 }
10975 }
10976
10977 /* X11R3: set the initial_state field of the window manager hints to
10978 IconicState. */
10979 x_wm_set_window_state (f, IconicState);
10980
10981 if (!FRAME_VISIBLE_P (f))
10982 {
10983 /* If the frame was withdrawn, before, we must map it. */
10984 XMapRaised (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
10985 }
10986
10987 SET_FRAME_ICONIFIED (f, true);
10988 SET_FRAME_VISIBLE (f, 0);
10989
10990 XFlush (FRAME_X_DISPLAY (f));
10991 unblock_input ();
10992 #endif /* not USE_X_TOOLKIT */
10993 }
10994
10995 \f
10996 /* Free X resources of frame F. */
10997
10998 void
10999 x_free_frame_resources (struct frame *f)
11000 {
11001 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
11002 Mouse_HLInfo *hlinfo = &dpyinfo->mouse_highlight;
11003 #ifdef USE_X_TOOLKIT
11004 Lisp_Object bar;
11005 struct scroll_bar *b;
11006 #endif
11007
11008 block_input ();
11009
11010 /* If a display connection is dead, don't try sending more
11011 commands to the X server. */
11012 if (dpyinfo->display)
11013 {
11014 /* Always exit with visible pointer to avoid weird issue
11015 with Xfixes (Bug#17609). */
11016 if (f->pointer_invisible)
11017 FRAME_DISPLAY_INFO (f)->toggle_visible_pointer (f, 0);
11018
11019 /* We must free faces before destroying windows because some
11020 font-driver (e.g. xft) access a window while finishing a
11021 face. */
11022 free_frame_faces (f);
11023
11024 if (f->output_data.x->icon_desc)
11025 XDestroyWindow (FRAME_X_DISPLAY (f), f->output_data.x->icon_desc);
11026
11027 #ifdef USE_X_TOOLKIT
11028 /* Explicitly destroy the scroll bars of the frame. Without
11029 this, we get "BadDrawable" errors from the toolkit later on,
11030 presumably from expose events generated for the disappearing
11031 toolkit scroll bars. */
11032 for (bar = FRAME_SCROLL_BARS (f); !NILP (bar); bar = b->next)
11033 {
11034 b = XSCROLL_BAR (bar);
11035 x_scroll_bar_remove (b);
11036 }
11037 #endif
11038
11039 #ifdef HAVE_X_I18N
11040 if (FRAME_XIC (f))
11041 free_frame_xic (f);
11042 #endif
11043
11044 x_free_cr_resources (f);
11045 #ifdef USE_X_TOOLKIT
11046 if (f->output_data.x->widget)
11047 {
11048 XtDestroyWidget (f->output_data.x->widget);
11049 f->output_data.x->widget = NULL;
11050 }
11051 /* Tooltips don't have widgets, only a simple X window, even if
11052 we are using a toolkit. */
11053 else if (FRAME_X_WINDOW (f))
11054 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
11055
11056 free_frame_menubar (f);
11057
11058 if (f->shell_position)
11059 xfree (f->shell_position);
11060 #else /* !USE_X_TOOLKIT */
11061
11062 #ifdef USE_GTK
11063 xg_free_frame_widgets (f);
11064 #endif /* USE_GTK */
11065
11066 if (FRAME_X_WINDOW (f))
11067 XDestroyWindow (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
11068 #endif /* !USE_X_TOOLKIT */
11069
11070 unload_color (f, FRAME_FOREGROUND_PIXEL (f));
11071 unload_color (f, FRAME_BACKGROUND_PIXEL (f));
11072 unload_color (f, f->output_data.x->cursor_pixel);
11073 unload_color (f, f->output_data.x->cursor_foreground_pixel);
11074 unload_color (f, f->output_data.x->border_pixel);
11075 unload_color (f, f->output_data.x->mouse_pixel);
11076
11077 if (f->output_data.x->scroll_bar_background_pixel != -1)
11078 unload_color (f, f->output_data.x->scroll_bar_background_pixel);
11079 if (f->output_data.x->scroll_bar_foreground_pixel != -1)
11080 unload_color (f, f->output_data.x->scroll_bar_foreground_pixel);
11081 #if defined (USE_LUCID) && defined (USE_TOOLKIT_SCROLL_BARS)
11082 /* Scrollbar shadow colors. */
11083 if (f->output_data.x->scroll_bar_top_shadow_pixel != -1)
11084 unload_color (f, f->output_data.x->scroll_bar_top_shadow_pixel);
11085 if (f->output_data.x->scroll_bar_bottom_shadow_pixel != -1)
11086 unload_color (f, f->output_data.x->scroll_bar_bottom_shadow_pixel);
11087 #endif /* USE_LUCID && USE_TOOLKIT_SCROLL_BARS */
11088 if (f->output_data.x->white_relief.pixel != -1)
11089 unload_color (f, f->output_data.x->white_relief.pixel);
11090 if (f->output_data.x->black_relief.pixel != -1)
11091 unload_color (f, f->output_data.x->black_relief.pixel);
11092
11093 x_free_gcs (f);
11094
11095 /* Free extra GCs allocated by x_setup_relief_colors. */
11096 if (f->output_data.x->white_relief.gc)
11097 {
11098 XFreeGC (dpyinfo->display, f->output_data.x->white_relief.gc);
11099 f->output_data.x->white_relief.gc = 0;
11100 }
11101 if (f->output_data.x->black_relief.gc)
11102 {
11103 XFreeGC (dpyinfo->display, f->output_data.x->black_relief.gc);
11104 f->output_data.x->black_relief.gc = 0;
11105 }
11106
11107 /* Free cursors. */
11108 if (f->output_data.x->text_cursor != 0)
11109 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->text_cursor);
11110 if (f->output_data.x->nontext_cursor != 0)
11111 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->nontext_cursor);
11112 if (f->output_data.x->modeline_cursor != 0)
11113 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->modeline_cursor);
11114 if (f->output_data.x->hand_cursor != 0)
11115 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->hand_cursor);
11116 if (f->output_data.x->hourglass_cursor != 0)
11117 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->hourglass_cursor);
11118 if (f->output_data.x->horizontal_drag_cursor != 0)
11119 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->horizontal_drag_cursor);
11120 if (f->output_data.x->vertical_drag_cursor != 0)
11121 XFreeCursor (FRAME_X_DISPLAY (f), f->output_data.x->vertical_drag_cursor);
11122
11123 XFlush (FRAME_X_DISPLAY (f));
11124 }
11125
11126 xfree (f->output_data.x->saved_menu_event);
11127 xfree (f->output_data.x);
11128 f->output_data.x = NULL;
11129
11130 if (f == dpyinfo->x_focus_frame)
11131 dpyinfo->x_focus_frame = 0;
11132 if (f == dpyinfo->x_focus_event_frame)
11133 dpyinfo->x_focus_event_frame = 0;
11134 if (f == dpyinfo->x_highlight_frame)
11135 dpyinfo->x_highlight_frame = 0;
11136 if (f == hlinfo->mouse_face_mouse_frame)
11137 reset_mouse_highlight (hlinfo);
11138
11139 unblock_input ();
11140 }
11141
11142
11143 /* Destroy the X window of frame F. */
11144
11145 static void
11146 x_destroy_window (struct frame *f)
11147 {
11148 struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
11149
11150 /* If a display connection is dead, don't try sending more
11151 commands to the X server. */
11152 if (dpyinfo->display != 0)
11153 x_free_frame_resources (f);
11154
11155 dpyinfo->reference_count--;
11156 }
11157
11158 \f
11159 /* Setting window manager hints. */
11160
11161 /* Set the normal size hints for the window manager, for frame F.
11162 FLAGS is the flags word to use--or 0 meaning preserve the flags
11163 that the window now has.
11164 If USER_POSITION, set the USPosition
11165 flag (this is useful when FLAGS is 0).
11166 The GTK version is in gtkutils.c. */
11167
11168 #ifndef USE_GTK
11169 void
11170 x_wm_set_size_hint (struct frame *f, long flags, bool user_position)
11171 {
11172 XSizeHints size_hints;
11173 Window window = FRAME_OUTER_WINDOW (f);
11174
11175 if (!window)
11176 return;
11177
11178 #ifdef USE_X_TOOLKIT
11179 if (f->output_data.x->widget)
11180 {
11181 widget_update_wm_size_hints (f->output_data.x->widget);
11182 return;
11183 }
11184 #endif
11185
11186 /* Setting PMaxSize caused various problems. */
11187 size_hints.flags = PResizeInc | PMinSize /* | PMaxSize */;
11188
11189 size_hints.x = f->left_pos;
11190 size_hints.y = f->top_pos;
11191
11192 size_hints.height = FRAME_PIXEL_HEIGHT (f);
11193 size_hints.width = FRAME_PIXEL_WIDTH (f);
11194
11195 size_hints.width_inc = frame_resize_pixelwise ? 1 : FRAME_COLUMN_WIDTH (f);
11196 size_hints.height_inc = frame_resize_pixelwise ? 1 : FRAME_LINE_HEIGHT (f);
11197
11198 size_hints.max_width = x_display_pixel_width (FRAME_DISPLAY_INFO (f))
11199 - FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
11200 size_hints.max_height = x_display_pixel_height (FRAME_DISPLAY_INFO (f))
11201 - FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
11202
11203 /* Calculate the base and minimum sizes. */
11204 {
11205 int base_width, base_height;
11206 int min_rows = 0, min_cols = 0;
11207
11208 base_width = FRAME_TEXT_COLS_TO_PIXEL_WIDTH (f, 0);
11209 base_height = FRAME_TEXT_LINES_TO_PIXEL_HEIGHT (f, 0);
11210
11211 if (frame_resize_pixelwise)
11212 /* Needed to prevent a bad protocol error crash when making the
11213 frame size very small. */
11214 {
11215 min_cols = 2 * min_cols;
11216 min_rows = 2 * min_rows;
11217 }
11218
11219 /* The window manager uses the base width hints to calculate the
11220 current number of rows and columns in the frame while
11221 resizing; min_width and min_height aren't useful for this
11222 purpose, since they might not give the dimensions for a
11223 zero-row, zero-column frame.
11224
11225 We use the base_width and base_height members if we have
11226 them; otherwise, we set the min_width and min_height members
11227 to the size for a zero x zero frame. */
11228
11229 size_hints.flags |= PBaseSize;
11230 size_hints.base_width = base_width;
11231 size_hints.base_height = base_height + FRAME_MENUBAR_HEIGHT (f);
11232 size_hints.min_width = base_width + min_cols * FRAME_COLUMN_WIDTH (f);
11233 size_hints.min_height = base_height + min_rows * FRAME_LINE_HEIGHT (f);
11234 }
11235
11236 /* If we don't need the old flags, we don't need the old hint at all. */
11237 if (flags)
11238 {
11239 size_hints.flags |= flags;
11240 goto no_read;
11241 }
11242
11243 {
11244 XSizeHints hints; /* Sometimes I hate X Windows... */
11245 long supplied_return;
11246 int value;
11247
11248 value = XGetWMNormalHints (FRAME_X_DISPLAY (f), window, &hints,
11249 &supplied_return);
11250
11251 if (flags)
11252 size_hints.flags |= flags;
11253 else
11254 {
11255 if (value == 0)
11256 hints.flags = 0;
11257 if (hints.flags & PSize)
11258 size_hints.flags |= PSize;
11259 if (hints.flags & PPosition)
11260 size_hints.flags |= PPosition;
11261 if (hints.flags & USPosition)
11262 size_hints.flags |= USPosition;
11263 if (hints.flags & USSize)
11264 size_hints.flags |= USSize;
11265 }
11266 }
11267
11268 no_read:
11269
11270 #ifdef PWinGravity
11271 size_hints.win_gravity = f->win_gravity;
11272 size_hints.flags |= PWinGravity;
11273
11274 if (user_position)
11275 {
11276 size_hints.flags &= ~ PPosition;
11277 size_hints.flags |= USPosition;
11278 }
11279 #endif /* PWinGravity */
11280
11281 XSetWMNormalHints (FRAME_X_DISPLAY (f), window, &size_hints);
11282 }
11283 #endif /* not USE_GTK */
11284
11285 /* Used for IconicState or NormalState */
11286
11287 static void
11288 x_wm_set_window_state (struct frame *f, int state)
11289 {
11290 #ifdef USE_X_TOOLKIT
11291 Arg al[1];
11292
11293 XtSetArg (al[0], XtNinitialState, state);
11294 XtSetValues (f->output_data.x->widget, al, 1);
11295 #else /* not USE_X_TOOLKIT */
11296 Window window = FRAME_X_WINDOW (f);
11297
11298 f->output_data.x->wm_hints.flags |= StateHint;
11299 f->output_data.x->wm_hints.initial_state = state;
11300
11301 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
11302 #endif /* not USE_X_TOOLKIT */
11303 }
11304
11305 static void
11306 x_wm_set_icon_pixmap (struct frame *f, ptrdiff_t pixmap_id)
11307 {
11308 Pixmap icon_pixmap, icon_mask;
11309
11310 #if !defined USE_X_TOOLKIT && !defined USE_GTK
11311 Window window = FRAME_OUTER_WINDOW (f);
11312 #endif
11313
11314 if (pixmap_id > 0)
11315 {
11316 icon_pixmap = x_bitmap_pixmap (f, pixmap_id);
11317 f->output_data.x->wm_hints.icon_pixmap = icon_pixmap;
11318 icon_mask = x_bitmap_mask (f, pixmap_id);
11319 f->output_data.x->wm_hints.icon_mask = icon_mask;
11320 }
11321 else
11322 {
11323 /* It seems there is no way to turn off use of an icon
11324 pixmap. */
11325 return;
11326 }
11327
11328
11329 #ifdef USE_GTK
11330 {
11331 xg_set_frame_icon (f, icon_pixmap, icon_mask);
11332 return;
11333 }
11334
11335 #elif defined (USE_X_TOOLKIT) /* same as in x_wm_set_window_state. */
11336
11337 {
11338 Arg al[1];
11339 XtSetArg (al[0], XtNiconPixmap, icon_pixmap);
11340 XtSetValues (f->output_data.x->widget, al, 1);
11341 XtSetArg (al[0], XtNiconMask, icon_mask);
11342 XtSetValues (f->output_data.x->widget, al, 1);
11343 }
11344
11345 #else /* not USE_X_TOOLKIT && not USE_GTK */
11346
11347 f->output_data.x->wm_hints.flags |= (IconPixmapHint | IconMaskHint);
11348 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
11349
11350 #endif /* not USE_X_TOOLKIT && not USE_GTK */
11351 }
11352
11353 void
11354 x_wm_set_icon_position (struct frame *f, int icon_x, int icon_y)
11355 {
11356 Window window = FRAME_OUTER_WINDOW (f);
11357
11358 f->output_data.x->wm_hints.flags |= IconPositionHint;
11359 f->output_data.x->wm_hints.icon_x = icon_x;
11360 f->output_data.x->wm_hints.icon_y = icon_y;
11361
11362 XSetWMHints (FRAME_X_DISPLAY (f), window, &f->output_data.x->wm_hints);
11363 }
11364
11365 \f
11366 /***********************************************************************
11367 Fonts
11368 ***********************************************************************/
11369
11370 #ifdef GLYPH_DEBUG
11371
11372 /* Check that FONT is valid on frame F. It is if it can be found in F's
11373 font table. */
11374
11375 static void
11376 x_check_font (struct frame *f, struct font *font)
11377 {
11378 eassert (font != NULL && ! NILP (font->props[FONT_TYPE_INDEX]));
11379 if (font->driver->check)
11380 eassert (font->driver->check (f, font) == 0);
11381 }
11382
11383 #endif /* GLYPH_DEBUG */
11384
11385 \f
11386 /***********************************************************************
11387 Initialization
11388 ***********************************************************************/
11389
11390 #ifdef USE_X_TOOLKIT
11391 static XrmOptionDescRec emacs_options[] = {
11392 {"-geometry", ".geometry", XrmoptionSepArg, NULL},
11393 {"-iconic", ".iconic", XrmoptionNoArg, (XtPointer) "yes"},
11394
11395 {"-internal-border-width", "*EmacsScreen.internalBorderWidth",
11396 XrmoptionSepArg, NULL},
11397 {"-ib", "*EmacsScreen.internalBorderWidth", XrmoptionSepArg, NULL},
11398
11399 {"-T", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
11400 {"-wn", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
11401 {"-title", "*EmacsShell.title", XrmoptionSepArg, (XtPointer) NULL},
11402 {"-iconname", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
11403 {"-in", "*EmacsShell.iconName", XrmoptionSepArg, (XtPointer) NULL},
11404 {"-mc", "*pointerColor", XrmoptionSepArg, (XtPointer) NULL},
11405 {"-cr", "*cursorColor", XrmoptionSepArg, (XtPointer) NULL}
11406 };
11407
11408 /* Whether atimer for Xt timeouts is activated or not. */
11409
11410 static bool x_timeout_atimer_activated_flag;
11411
11412 #endif /* USE_X_TOOLKIT */
11413
11414 static int x_initialized;
11415
11416 /* Test whether two display-name strings agree up to the dot that separates
11417 the screen number from the server number. */
11418 static bool
11419 same_x_server (const char *name1, const char *name2)
11420 {
11421 bool seen_colon = false;
11422 Lisp_Object sysname = Fsystem_name ();
11423 const char *system_name = SSDATA (sysname);
11424 ptrdiff_t system_name_length = SBYTES (sysname);
11425 ptrdiff_t length_until_period = 0;
11426
11427 while (system_name[length_until_period] != 0
11428 && system_name[length_until_period] != '.')
11429 length_until_period++;
11430
11431 /* Treat `unix' like an empty host name. */
11432 if (! strncmp (name1, "unix:", 5))
11433 name1 += 4;
11434 if (! strncmp (name2, "unix:", 5))
11435 name2 += 4;
11436 /* Treat this host's name like an empty host name. */
11437 if (! strncmp (name1, system_name, system_name_length)
11438 && name1[system_name_length] == ':')
11439 name1 += system_name_length;
11440 if (! strncmp (name2, system_name, system_name_length)
11441 && name2[system_name_length] == ':')
11442 name2 += system_name_length;
11443 /* Treat this host's domainless name like an empty host name. */
11444 if (! strncmp (name1, system_name, length_until_period)
11445 && name1[length_until_period] == ':')
11446 name1 += length_until_period;
11447 if (! strncmp (name2, system_name, length_until_period)
11448 && name2[length_until_period] == ':')
11449 name2 += length_until_period;
11450
11451 for (; *name1 != '\0' && *name1 == *name2; name1++, name2++)
11452 {
11453 if (*name1 == ':')
11454 seen_colon = true;
11455 if (seen_colon && *name1 == '.')
11456 return true;
11457 }
11458 return (seen_colon
11459 && (*name1 == '.' || *name1 == '\0')
11460 && (*name2 == '.' || *name2 == '\0'));
11461 }
11462
11463 /* Count number of set bits in mask and number of bits to shift to
11464 get to the first bit. With MASK 0x7e0, *BITS is set to 6, and *OFFSET
11465 to 5. */
11466 static void
11467 get_bits_and_offset (unsigned long mask, int *bits, int *offset)
11468 {
11469 int nr = 0;
11470 int off = 0;
11471
11472 while (!(mask & 1))
11473 {
11474 off++;
11475 mask >>= 1;
11476 }
11477
11478 while (mask & 1)
11479 {
11480 nr++;
11481 mask >>= 1;
11482 }
11483
11484 *offset = off;
11485 *bits = nr;
11486 }
11487
11488 /* Return true iff display DISPLAY is available for use.
11489 But don't permanently open it, just test its availability. */
11490
11491 bool
11492 x_display_ok (const char *display)
11493 {
11494 /* XOpenDisplay fails if it gets a signal. Block SIGIO which may arrive. */
11495 unrequest_sigio ();
11496 Display *dpy = XOpenDisplay (display);
11497 request_sigio ();
11498 if (!dpy)
11499 return false;
11500 XCloseDisplay (dpy);
11501 return true;
11502 }
11503
11504 #ifdef USE_GTK
11505 static void
11506 my_log_handler (const gchar *log_domain, GLogLevelFlags log_level,
11507 const gchar *msg, gpointer user_data)
11508 {
11509 if (!strstr (msg, "g_set_prgname"))
11510 fprintf (stderr, "%s-WARNING **: %s\n", log_domain, msg);
11511 }
11512 #endif
11513
11514 /* Create invisible cursor on X display referred by DPYINFO. */
11515
11516 static Cursor
11517 make_invisible_cursor (struct x_display_info *dpyinfo)
11518 {
11519 Display *dpy = dpyinfo->display;
11520 static char const no_data[] = { 0 };
11521 Pixmap pix;
11522 XColor col;
11523 Cursor c = 0;
11524
11525 x_catch_errors (dpy);
11526 pix = XCreateBitmapFromData (dpy, dpyinfo->root_window, no_data, 1, 1);
11527 if (! x_had_errors_p (dpy) && pix != None)
11528 {
11529 Cursor pixc;
11530 col.pixel = 0;
11531 col.red = col.green = col.blue = 0;
11532 col.flags = DoRed | DoGreen | DoBlue;
11533 pixc = XCreatePixmapCursor (dpy, pix, pix, &col, &col, 0, 0);
11534 if (! x_had_errors_p (dpy) && pixc != None)
11535 c = pixc;
11536 XFreePixmap (dpy, pix);
11537 }
11538
11539 x_uncatch_errors ();
11540
11541 return c;
11542 }
11543
11544 /* True if DPY supports Xfixes extension >= 4. */
11545
11546 static bool
11547 x_probe_xfixes_extension (Display *dpy)
11548 {
11549 #ifdef HAVE_XFIXES
11550 int major, minor;
11551 return XFixesQueryVersion (dpy, &major, &minor) && major >= 4;
11552 #else
11553 return false;
11554 #endif /* HAVE_XFIXES */
11555 }
11556
11557 /* Toggle mouse pointer visibility on frame F by using Xfixes functions. */
11558
11559 static void
11560 xfixes_toggle_visible_pointer (struct frame *f, bool invisible)
11561 {
11562 #ifdef HAVE_XFIXES
11563 if (invisible)
11564 XFixesHideCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
11565 else
11566 XFixesShowCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f));
11567 f->pointer_invisible = invisible;
11568 #else
11569 emacs_abort ();
11570 #endif /* HAVE_XFIXES */
11571 }
11572
11573 /* Toggle mouse pointer visibility on frame F by using invisible cursor. */
11574
11575 static void
11576 x_toggle_visible_pointer (struct frame *f, bool invisible)
11577 {
11578 eassert (FRAME_DISPLAY_INFO (f)->invisible_cursor != 0);
11579 if (invisible)
11580 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
11581 FRAME_DISPLAY_INFO (f)->invisible_cursor);
11582 else
11583 XDefineCursor (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
11584 f->output_data.x->current_cursor);
11585 f->pointer_invisible = invisible;
11586 }
11587
11588 /* Setup pointer blanking, prefer Xfixes if available. */
11589
11590 static void
11591 x_setup_pointer_blanking (struct x_display_info *dpyinfo)
11592 {
11593 /* FIXME: the brave tester should set EMACS_XFIXES because we're suspecting
11594 X server bug, see http://debbugs.gnu.org/cgi/bugreport.cgi?bug=17609. */
11595 if (egetenv ("EMACS_XFIXES") && x_probe_xfixes_extension (dpyinfo->display))
11596 dpyinfo->toggle_visible_pointer = xfixes_toggle_visible_pointer;
11597 else
11598 {
11599 dpyinfo->toggle_visible_pointer = x_toggle_visible_pointer;
11600 dpyinfo->invisible_cursor = make_invisible_cursor (dpyinfo);
11601 }
11602 }
11603
11604 /* Current X display connection identifier. Incremented for each next
11605 connection established. */
11606 static unsigned x_display_id;
11607
11608 /* Open a connection to X display DISPLAY_NAME, and return
11609 the structure that describes the open display.
11610 If we cannot contact the display, return null. */
11611
11612 struct x_display_info *
11613 x_term_init (Lisp_Object display_name, char *xrm_option, char *resource_name)
11614 {
11615 Display *dpy;
11616 struct terminal *terminal;
11617 struct x_display_info *dpyinfo;
11618 XrmDatabase xrdb;
11619 ptrdiff_t lim;
11620
11621 block_input ();
11622
11623 if (!x_initialized)
11624 {
11625 x_initialize ();
11626 ++x_initialized;
11627 }
11628
11629 if (! x_display_ok (SSDATA (display_name)))
11630 error ("Display %s can't be opened", SSDATA (display_name));
11631
11632 #ifdef USE_GTK
11633 {
11634 #define NUM_ARGV 10
11635 int argc;
11636 char *argv[NUM_ARGV];
11637 char **argv2 = argv;
11638 guint id;
11639
11640 if (x_initialized++ > 1)
11641 {
11642 xg_display_open (SSDATA (display_name), &dpy);
11643 }
11644 else
11645 {
11646 static char display_opt[] = "--display";
11647 static char name_opt[] = "--name";
11648
11649 for (argc = 0; argc < NUM_ARGV; ++argc)
11650 argv[argc] = 0;
11651
11652 argc = 0;
11653 argv[argc++] = initial_argv[0];
11654
11655 if (! NILP (display_name))
11656 {
11657 argv[argc++] = display_opt;
11658 argv[argc++] = SSDATA (display_name);
11659 }
11660
11661 argv[argc++] = name_opt;
11662 argv[argc++] = resource_name;
11663
11664 XSetLocaleModifiers ("");
11665
11666 /* Work around GLib bug that outputs a faulty warning. See
11667 https://bugzilla.gnome.org/show_bug.cgi?id=563627. */
11668 id = g_log_set_handler ("GLib", G_LOG_LEVEL_WARNING | G_LOG_FLAG_FATAL
11669 | G_LOG_FLAG_RECURSION, my_log_handler, NULL);
11670
11671 /* NULL window -> events for all windows go to our function.
11672 Call before gtk_init so Gtk+ event filters comes after our. */
11673 gdk_window_add_filter (NULL, event_handler_gdk, NULL);
11674
11675 /* gtk_init does set_locale. Fix locale before and after. */
11676 fixup_locale ();
11677 unrequest_sigio (); /* See comment in x_display_ok. */
11678 gtk_init (&argc, &argv2);
11679 request_sigio ();
11680 fixup_locale ();
11681
11682 g_log_remove_handler ("GLib", id);
11683
11684 xg_initialize ();
11685
11686 dpy = DEFAULT_GDK_DISPLAY ();
11687
11688 #if ! GTK_CHECK_VERSION (2, 90, 0)
11689 /* Load our own gtkrc if it exists. */
11690 {
11691 const char *file = "~/.emacs.d/gtkrc";
11692 Lisp_Object s, abs_file;
11693
11694 s = build_string (file);
11695 abs_file = Fexpand_file_name (s, Qnil);
11696
11697 if (! NILP (abs_file) && !NILP (Ffile_readable_p (abs_file)))
11698 gtk_rc_parse (SSDATA (abs_file));
11699 }
11700 #endif
11701
11702 XSetErrorHandler (x_error_handler);
11703 XSetIOErrorHandler (x_io_error_quitter);
11704 }
11705 }
11706 #else /* not USE_GTK */
11707 #ifdef USE_X_TOOLKIT
11708 /* weiner@footloose.sps.mot.com reports that this causes
11709 errors with X11R5:
11710 X protocol error: BadAtom (invalid Atom parameter)
11711 on protocol request 18skiloaf.
11712 So let's not use it until R6. */
11713 #ifdef HAVE_X11XTR6
11714 XtSetLanguageProc (NULL, NULL, NULL);
11715 #endif
11716
11717 {
11718 int argc = 0;
11719 char *argv[3];
11720
11721 argv[0] = "";
11722 argc = 1;
11723 if (xrm_option)
11724 {
11725 argv[argc++] = "-xrm";
11726 argv[argc++] = xrm_option;
11727 }
11728 turn_on_atimers (false);
11729 unrequest_sigio (); /* See comment in x_display_ok. */
11730 dpy = XtOpenDisplay (Xt_app_con, SSDATA (display_name),
11731 resource_name, EMACS_CLASS,
11732 emacs_options, XtNumber (emacs_options),
11733 &argc, argv);
11734 request_sigio ();
11735 turn_on_atimers (true);
11736
11737 #ifdef HAVE_X11XTR6
11738 /* I think this is to compensate for XtSetLanguageProc. */
11739 fixup_locale ();
11740 #endif
11741 }
11742
11743 #else /* not USE_X_TOOLKIT */
11744 XSetLocaleModifiers ("");
11745 unrequest_sigio (); // See comment in x_display_ok.
11746 dpy = XOpenDisplay (SSDATA (display_name));
11747 request_sigio ();
11748 #endif /* not USE_X_TOOLKIT */
11749 #endif /* not USE_GTK*/
11750
11751 /* Detect failure. */
11752 if (dpy == 0)
11753 {
11754 unblock_input ();
11755 return 0;
11756 }
11757
11758 /* We have definitely succeeded. Record the new connection. */
11759
11760 dpyinfo = xzalloc (sizeof *dpyinfo);
11761 terminal = x_create_terminal (dpyinfo);
11762
11763 {
11764 struct x_display_info *share;
11765
11766 for (share = x_display_list; share; share = share->next)
11767 if (same_x_server (SSDATA (XCAR (share->name_list_element)),
11768 SSDATA (display_name)))
11769 break;
11770 if (share)
11771 terminal->kboard = share->terminal->kboard;
11772 else
11773 {
11774 terminal->kboard = allocate_kboard (Qx);
11775
11776 if (!EQ (XSYMBOL (Qvendor_specific_keysyms)->function, Qunbound))
11777 {
11778 char *vendor = ServerVendor (dpy);
11779
11780 /* Protect terminal from GC before removing it from the
11781 list of terminals. */
11782 struct gcpro gcpro1;
11783 Lisp_Object gcpro_term;
11784 XSETTERMINAL (gcpro_term, terminal);
11785 GCPRO1 (gcpro_term);
11786
11787 /* Temporarily hide the partially initialized terminal. */
11788 terminal_list = terminal->next_terminal;
11789 unblock_input ();
11790 kset_system_key_alist
11791 (terminal->kboard,
11792 call1 (Qvendor_specific_keysyms,
11793 vendor ? build_string (vendor) : empty_unibyte_string));
11794 block_input ();
11795 terminal->next_terminal = terminal_list;
11796 terminal_list = terminal;
11797 UNGCPRO;
11798 }
11799
11800 /* Don't let the initial kboard remain current longer than necessary.
11801 That would cause problems if a file loaded on startup tries to
11802 prompt in the mini-buffer. */
11803 if (current_kboard == initial_kboard)
11804 current_kboard = terminal->kboard;
11805 }
11806 terminal->kboard->reference_count++;
11807 }
11808
11809 /* Put this display on the chain. */
11810 dpyinfo->next = x_display_list;
11811 x_display_list = dpyinfo;
11812
11813 dpyinfo->name_list_element = Fcons (display_name, Qnil);
11814 dpyinfo->display = dpy;
11815 dpyinfo->connection = ConnectionNumber (dpyinfo->display);
11816
11817 /* Set the name of the terminal. */
11818 terminal->name = xlispstrdup (display_name);
11819
11820 #if false
11821 XSetAfterFunction (x_current_display, x_trace_wire);
11822 #endif
11823
11824 lim = min (PTRDIFF_MAX, SIZE_MAX) - sizeof "@";
11825 Lisp_Object system_name = Fsystem_name ();
11826 if (lim - SBYTES (Vinvocation_name) < SBYTES (system_name))
11827 memory_full (SIZE_MAX);
11828 dpyinfo->x_id = ++x_display_id;
11829 dpyinfo->x_id_name = xmalloc (SBYTES (Vinvocation_name)
11830 + SBYTES (system_name) + 2);
11831 char *nametail = lispstpcpy (dpyinfo->x_id_name, Vinvocation_name);
11832 *nametail++ = '@';
11833 lispstpcpy (nametail, system_name);
11834
11835 /* Figure out which modifier bits mean what. */
11836 x_find_modifier_meanings (dpyinfo);
11837
11838 /* Get the scroll bar cursor. */
11839 #ifdef USE_GTK
11840 /* We must create a GTK cursor, it is required for GTK widgets. */
11841 dpyinfo->xg_cursor = xg_create_default_cursor (dpyinfo->display);
11842 #endif /* USE_GTK */
11843
11844 dpyinfo->vertical_scroll_bar_cursor
11845 = XCreateFontCursor (dpyinfo->display, XC_sb_v_double_arrow);
11846
11847 dpyinfo->horizontal_scroll_bar_cursor
11848 = XCreateFontCursor (dpyinfo->display, XC_sb_h_double_arrow);
11849
11850 xrdb = x_load_resources (dpyinfo->display, xrm_option,
11851 resource_name, EMACS_CLASS);
11852 #ifdef HAVE_XRMSETDATABASE
11853 XrmSetDatabase (dpyinfo->display, xrdb);
11854 #else
11855 dpyinfo->display->db = xrdb;
11856 #endif
11857 /* Put the rdb where we can find it in a way that works on
11858 all versions. */
11859 dpyinfo->xrdb = xrdb;
11860
11861 dpyinfo->screen = ScreenOfDisplay (dpyinfo->display,
11862 DefaultScreen (dpyinfo->display));
11863 select_visual (dpyinfo);
11864 dpyinfo->cmap = DefaultColormapOfScreen (dpyinfo->screen);
11865 dpyinfo->root_window = RootWindowOfScreen (dpyinfo->screen);
11866 dpyinfo->icon_bitmap_id = -1;
11867 dpyinfo->wm_type = X_WMTYPE_UNKNOWN;
11868
11869 reset_mouse_highlight (&dpyinfo->mouse_highlight);
11870
11871 /* See if we can construct pixel values from RGB values. */
11872 if (dpyinfo->visual->class == TrueColor)
11873 {
11874 get_bits_and_offset (dpyinfo->visual->red_mask,
11875 &dpyinfo->red_bits, &dpyinfo->red_offset);
11876 get_bits_and_offset (dpyinfo->visual->blue_mask,
11877 &dpyinfo->blue_bits, &dpyinfo->blue_offset);
11878 get_bits_and_offset (dpyinfo->visual->green_mask,
11879 &dpyinfo->green_bits, &dpyinfo->green_offset);
11880 }
11881
11882 /* See if a private colormap is requested. */
11883 if (dpyinfo->visual == DefaultVisualOfScreen (dpyinfo->screen))
11884 {
11885 if (dpyinfo->visual->class == PseudoColor)
11886 {
11887 AUTO_STRING (privateColormap, "privateColormap");
11888 AUTO_STRING (PrivateColormap, "PrivateColormap");
11889 Lisp_Object value
11890 = display_x_get_resource (dpyinfo, privateColormap,
11891 PrivateColormap, Qnil, Qnil);
11892 if (STRINGP (value)
11893 && (!strcmp (SSDATA (value), "true")
11894 || !strcmp (SSDATA (value), "on")))
11895 dpyinfo->cmap = XCopyColormapAndFree (dpyinfo->display, dpyinfo->cmap);
11896 }
11897 }
11898 else
11899 dpyinfo->cmap = XCreateColormap (dpyinfo->display, dpyinfo->root_window,
11900 dpyinfo->visual, AllocNone);
11901
11902 #ifdef HAVE_XFT
11903 {
11904 /* If we are using Xft, the following precautions should be made:
11905
11906 1. Make sure that the Xrender extension is added before the Xft one.
11907 Otherwise, the close-display hook set by Xft is called after the one
11908 for Xrender, and the former tries to re-add the latter. This results
11909 in inconsistency of internal states and leads to X protocol error when
11910 one reconnects to the same X server (Bug#1696).
11911
11912 2. Check dpi value in X resources. It is better we use it as well,
11913 since Xft will use it, as will all Gnome applications. If our real DPI
11914 is smaller or larger than the one Xft uses, our font will look smaller
11915 or larger than other for other applications, even if it is the same
11916 font name (monospace-10 for example). */
11917
11918 int event_base, error_base;
11919 char *v;
11920 double d;
11921
11922 XRenderQueryExtension (dpyinfo->display, &event_base, &error_base);
11923
11924 v = XGetDefault (dpyinfo->display, "Xft", "dpi");
11925 if (v != NULL && sscanf (v, "%lf", &d) == 1)
11926 dpyinfo->resy = dpyinfo->resx = d;
11927 }
11928 #endif
11929
11930 if (dpyinfo->resy < 1)
11931 {
11932 int screen_number = XScreenNumberOfScreen (dpyinfo->screen);
11933 double pixels = DisplayHeight (dpyinfo->display, screen_number);
11934 double mm = DisplayHeightMM (dpyinfo->display, screen_number);
11935 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
11936 dpyinfo->resy = (mm < 1) ? 100 : pixels * 25.4 / mm;
11937 pixels = DisplayWidth (dpyinfo->display, screen_number);
11938 mm = DisplayWidthMM (dpyinfo->display, screen_number);
11939 /* Mac OS X 10.3's Xserver sometimes reports 0.0mm. */
11940 dpyinfo->resx = (mm < 1) ? 100 : pixels * 25.4 / mm;
11941 }
11942
11943 {
11944 static const struct
11945 {
11946 const char *name;
11947 int offset;
11948 } atom_refs[] = {
11949 #define ATOM_REFS_INIT(string, member) \
11950 { string, offsetof (struct x_display_info, member) },
11951 ATOM_REFS_INIT ("WM_PROTOCOLS", Xatom_wm_protocols)
11952 ATOM_REFS_INIT ("WM_TAKE_FOCUS", Xatom_wm_take_focus)
11953 ATOM_REFS_INIT ("WM_SAVE_YOURSELF", Xatom_wm_save_yourself)
11954 ATOM_REFS_INIT ("WM_DELETE_WINDOW", Xatom_wm_delete_window)
11955 ATOM_REFS_INIT ("WM_CHANGE_STATE", Xatom_wm_change_state)
11956 ATOM_REFS_INIT ("WM_CONFIGURE_DENIED", Xatom_wm_configure_denied)
11957 ATOM_REFS_INIT ("WM_MOVED", Xatom_wm_window_moved)
11958 ATOM_REFS_INIT ("WM_CLIENT_LEADER", Xatom_wm_client_leader)
11959 ATOM_REFS_INIT ("Editres", Xatom_editres)
11960 ATOM_REFS_INIT ("CLIPBOARD", Xatom_CLIPBOARD)
11961 ATOM_REFS_INIT ("TIMESTAMP", Xatom_TIMESTAMP)
11962 ATOM_REFS_INIT ("TEXT", Xatom_TEXT)
11963 ATOM_REFS_INIT ("COMPOUND_TEXT", Xatom_COMPOUND_TEXT)
11964 ATOM_REFS_INIT ("UTF8_STRING", Xatom_UTF8_STRING)
11965 ATOM_REFS_INIT ("DELETE", Xatom_DELETE)
11966 ATOM_REFS_INIT ("MULTIPLE", Xatom_MULTIPLE)
11967 ATOM_REFS_INIT ("INCR", Xatom_INCR)
11968 ATOM_REFS_INIT ("_EMACS_TMP_", Xatom_EMACS_TMP)
11969 ATOM_REFS_INIT ("TARGETS", Xatom_TARGETS)
11970 ATOM_REFS_INIT ("NULL", Xatom_NULL)
11971 ATOM_REFS_INIT ("ATOM", Xatom_ATOM)
11972 ATOM_REFS_INIT ("ATOM_PAIR", Xatom_ATOM_PAIR)
11973 ATOM_REFS_INIT ("CLIPBOARD_MANAGER", Xatom_CLIPBOARD_MANAGER)
11974 ATOM_REFS_INIT ("_XEMBED_INFO", Xatom_XEMBED_INFO)
11975 /* For properties of font. */
11976 ATOM_REFS_INIT ("PIXEL_SIZE", Xatom_PIXEL_SIZE)
11977 ATOM_REFS_INIT ("AVERAGE_WIDTH", Xatom_AVERAGE_WIDTH)
11978 ATOM_REFS_INIT ("_MULE_BASELINE_OFFSET", Xatom_MULE_BASELINE_OFFSET)
11979 ATOM_REFS_INIT ("_MULE_RELATIVE_COMPOSE", Xatom_MULE_RELATIVE_COMPOSE)
11980 ATOM_REFS_INIT ("_MULE_DEFAULT_ASCENT", Xatom_MULE_DEFAULT_ASCENT)
11981 /* Ghostscript support. */
11982 ATOM_REFS_INIT ("DONE", Xatom_DONE)
11983 ATOM_REFS_INIT ("PAGE", Xatom_PAGE)
11984 ATOM_REFS_INIT ("SCROLLBAR", Xatom_Scrollbar)
11985 ATOM_REFS_INIT ("HORIZONTAL_SCROLLBAR", Xatom_Horizontal_Scrollbar)
11986 ATOM_REFS_INIT ("_XEMBED", Xatom_XEMBED)
11987 /* EWMH */
11988 ATOM_REFS_INIT ("_NET_WM_STATE", Xatom_net_wm_state)
11989 ATOM_REFS_INIT ("_NET_WM_STATE_FULLSCREEN", Xatom_net_wm_state_fullscreen)
11990 ATOM_REFS_INIT ("_NET_WM_STATE_MAXIMIZED_HORZ",
11991 Xatom_net_wm_state_maximized_horz)
11992 ATOM_REFS_INIT ("_NET_WM_STATE_MAXIMIZED_VERT",
11993 Xatom_net_wm_state_maximized_vert)
11994 ATOM_REFS_INIT ("_NET_WM_STATE_STICKY", Xatom_net_wm_state_sticky)
11995 ATOM_REFS_INIT ("_NET_WM_STATE_HIDDEN", Xatom_net_wm_state_hidden)
11996 ATOM_REFS_INIT ("_NET_WM_WINDOW_TYPE", Xatom_net_window_type)
11997 ATOM_REFS_INIT ("_NET_WM_WINDOW_TYPE_TOOLTIP",
11998 Xatom_net_window_type_tooltip)
11999 ATOM_REFS_INIT ("_NET_WM_ICON_NAME", Xatom_net_wm_icon_name)
12000 ATOM_REFS_INIT ("_NET_WM_NAME", Xatom_net_wm_name)
12001 ATOM_REFS_INIT ("_NET_SUPPORTED", Xatom_net_supported)
12002 ATOM_REFS_INIT ("_NET_SUPPORTING_WM_CHECK", Xatom_net_supporting_wm_check)
12003 ATOM_REFS_INIT ("_NET_WM_WINDOW_OPACITY", Xatom_net_wm_window_opacity)
12004 ATOM_REFS_INIT ("_NET_ACTIVE_WINDOW", Xatom_net_active_window)
12005 ATOM_REFS_INIT ("_NET_FRAME_EXTENTS", Xatom_net_frame_extents)
12006 ATOM_REFS_INIT ("_NET_CURRENT_DESKTOP", Xatom_net_current_desktop)
12007 ATOM_REFS_INIT ("_NET_WORKAREA", Xatom_net_workarea)
12008 /* Session management */
12009 ATOM_REFS_INIT ("SM_CLIENT_ID", Xatom_SM_CLIENT_ID)
12010 ATOM_REFS_INIT ("_XSETTINGS_SETTINGS", Xatom_xsettings_prop)
12011 ATOM_REFS_INIT ("MANAGER", Xatom_xsettings_mgr)
12012 };
12013
12014 int i;
12015 enum { atom_count = ARRAYELTS (atom_refs) };
12016 /* 1 for _XSETTINGS_SN. */
12017 enum { total_atom_count = 1 + atom_count };
12018 Atom atoms_return[total_atom_count];
12019 char *atom_names[total_atom_count];
12020 static char const xsettings_fmt[] = "_XSETTINGS_S%d";
12021 char xsettings_atom_name[sizeof xsettings_fmt - 2
12022 + INT_STRLEN_BOUND (int)];
12023
12024 for (i = 0; i < atom_count; i++)
12025 atom_names[i] = (char *) atom_refs[i].name;
12026
12027 /* Build _XSETTINGS_SN atom name. */
12028 sprintf (xsettings_atom_name, xsettings_fmt,
12029 XScreenNumberOfScreen (dpyinfo->screen));
12030 atom_names[i] = xsettings_atom_name;
12031
12032 XInternAtoms (dpyinfo->display, atom_names, total_atom_count,
12033 False, atoms_return);
12034
12035 for (i = 0; i < atom_count; i++)
12036 *(Atom *) ((char *) dpyinfo + atom_refs[i].offset) = atoms_return[i];
12037
12038 /* Manually copy last atom. */
12039 dpyinfo->Xatom_xsettings_sel = atoms_return[i];
12040 }
12041
12042 dpyinfo->x_dnd_atoms_size = 8;
12043 dpyinfo->x_dnd_atoms = xmalloc (sizeof *dpyinfo->x_dnd_atoms
12044 * dpyinfo->x_dnd_atoms_size);
12045 dpyinfo->gray
12046 = XCreatePixmapFromBitmapData (dpyinfo->display, dpyinfo->root_window,
12047 gray_bits, gray_width, gray_height,
12048 1, 0, 1);
12049
12050 x_setup_pointer_blanking (dpyinfo);
12051
12052 #ifdef HAVE_X_I18N
12053 xim_initialize (dpyinfo, resource_name);
12054 #endif
12055
12056 xsettings_initialize (dpyinfo);
12057
12058 /* This is only needed for distinguishing keyboard and process input. */
12059 if (dpyinfo->connection != 0)
12060 add_keyboard_wait_descriptor (dpyinfo->connection);
12061
12062 #ifdef F_SETOWN
12063 fcntl (dpyinfo->connection, F_SETOWN, getpid ());
12064 #endif /* ! defined (F_SETOWN) */
12065
12066 if (interrupt_input)
12067 init_sigio (dpyinfo->connection);
12068
12069 #ifdef USE_LUCID
12070 {
12071 XrmValue d, fr, to;
12072 Font font;
12073
12074 dpy = dpyinfo->display;
12075 d.addr = (XPointer)&dpy;
12076 d.size = sizeof (Display *);
12077 fr.addr = XtDefaultFont;
12078 fr.size = sizeof (XtDefaultFont);
12079 to.size = sizeof (Font *);
12080 to.addr = (XPointer)&font;
12081 x_catch_errors (dpy);
12082 if (!XtCallConverter (dpy, XtCvtStringToFont, &d, 1, &fr, &to, NULL))
12083 emacs_abort ();
12084 if (x_had_errors_p (dpy) || !XQueryFont (dpy, font))
12085 XrmPutLineResource (&xrdb, "Emacs.dialog.*.font: 9x15");
12086 /* Do not free XFontStruct returned by the above call to XQueryFont.
12087 This leads to X protocol errors at XtCloseDisplay (Bug#18403). */
12088 x_uncatch_errors ();
12089 }
12090 #endif
12091
12092 /* See if we should run in synchronous mode. This is useful
12093 for debugging X code. */
12094 {
12095 AUTO_STRING (synchronous, "synchronous");
12096 AUTO_STRING (Synchronous, "Synchronous");
12097 Lisp_Object value = display_x_get_resource (dpyinfo, synchronous,
12098 Synchronous, Qnil, Qnil);
12099 if (STRINGP (value)
12100 && (!strcmp (SSDATA (value), "true")
12101 || !strcmp (SSDATA (value), "on")))
12102 XSynchronize (dpyinfo->display, True);
12103 }
12104
12105 {
12106 AUTO_STRING (useXIM, "useXIM");
12107 AUTO_STRING (UseXIM, "UseXIM");
12108 Lisp_Object value = display_x_get_resource (dpyinfo, useXIM, UseXIM,
12109 Qnil, Qnil);
12110 #ifdef USE_XIM
12111 if (STRINGP (value)
12112 && (!strcmp (SSDATA (value), "false")
12113 || !strcmp (SSDATA (value), "off")))
12114 use_xim = false;
12115 #else
12116 if (STRINGP (value)
12117 && (!strcmp (SSDATA (value), "true")
12118 || !strcmp (SSDATA (value), "on")))
12119 use_xim = true;
12120 #endif
12121 }
12122
12123 #ifdef HAVE_X_SM
12124 /* Only do this for the very first display in the Emacs session.
12125 Ignore X session management when Emacs was first started on a
12126 tty or started as a daemon. */
12127 if (terminal->id == 1 && ! IS_DAEMON)
12128 x_session_initialize (dpyinfo);
12129 #endif
12130
12131 #ifdef USE_CAIRO
12132 x_extension_initialize (dpyinfo);
12133 #endif
12134
12135 unblock_input ();
12136
12137 return dpyinfo;
12138 }
12139 \f
12140 /* Get rid of display DPYINFO, deleting all frames on it,
12141 and without sending any more commands to the X server. */
12142
12143 static void
12144 x_delete_display (struct x_display_info *dpyinfo)
12145 {
12146 struct terminal *t;
12147
12148 /* Close all frames and delete the generic struct terminal for this
12149 X display. */
12150 for (t = terminal_list; t; t = t->next_terminal)
12151 if (t->type == output_x_window && t->display_info.x == dpyinfo)
12152 {
12153 #ifdef HAVE_X_SM
12154 /* Close X session management when we close its display. */
12155 if (t->id == 1 && x_session_have_connection ())
12156 x_session_close ();
12157 #endif
12158 delete_terminal (t);
12159 break;
12160 }
12161
12162 if (next_noop_dpyinfo == dpyinfo)
12163 next_noop_dpyinfo = dpyinfo->next;
12164
12165 if (x_display_list == dpyinfo)
12166 x_display_list = dpyinfo->next;
12167 else
12168 {
12169 struct x_display_info *tail;
12170
12171 for (tail = x_display_list; tail; tail = tail->next)
12172 if (tail->next == dpyinfo)
12173 tail->next = tail->next->next;
12174 }
12175
12176 xfree (dpyinfo->x_id_name);
12177 xfree (dpyinfo->x_dnd_atoms);
12178 xfree (dpyinfo->color_cells);
12179 xfree (dpyinfo);
12180 }
12181
12182 #ifdef USE_X_TOOLKIT
12183
12184 /* Atimer callback function for TIMER. Called every 0.1s to process
12185 Xt timeouts, if needed. We must avoid calling XtAppPending as
12186 much as possible because that function does an implicit XFlush
12187 that slows us down. */
12188
12189 static void
12190 x_process_timeouts (struct atimer *timer)
12191 {
12192 block_input ();
12193 x_timeout_atimer_activated_flag = false;
12194 if (toolkit_scroll_bar_interaction || popup_activated ())
12195 {
12196 while (XtAppPending (Xt_app_con) & XtIMTimer)
12197 XtAppProcessEvent (Xt_app_con, XtIMTimer);
12198 /* Reactivate the atimer for next time. */
12199 x_activate_timeout_atimer ();
12200 }
12201 unblock_input ();
12202 }
12203
12204 /* Install an asynchronous timer that processes Xt timeout events
12205 every 0.1s as long as either `toolkit_scroll_bar_interaction' or
12206 `popup_activated_flag' (in xmenu.c) is set. Make sure to call this
12207 function whenever these variables are set. This is necessary
12208 because some widget sets use timeouts internally, for example the
12209 LessTif menu bar, or the Xaw3d scroll bar. When Xt timeouts aren't
12210 processed, these widgets don't behave normally. */
12211
12212 void
12213 x_activate_timeout_atimer (void)
12214 {
12215 block_input ();
12216 if (!x_timeout_atimer_activated_flag)
12217 {
12218 struct timespec interval = make_timespec (0, 100 * 1000 * 1000);
12219 start_atimer (ATIMER_RELATIVE, interval, x_process_timeouts, 0);
12220 x_timeout_atimer_activated_flag = true;
12221 }
12222 unblock_input ();
12223 }
12224
12225 #endif /* USE_X_TOOLKIT */
12226
12227 \f
12228 /* Set up use of X before we make the first connection. */
12229
12230 static struct redisplay_interface x_redisplay_interface =
12231 {
12232 x_frame_parm_handlers,
12233 x_produce_glyphs,
12234 x_write_glyphs,
12235 x_insert_glyphs,
12236 x_clear_end_of_line,
12237 x_scroll_run,
12238 x_after_update_window_line,
12239 x_update_window_begin,
12240 x_update_window_end,
12241 x_flush,
12242 x_clear_window_mouse_face,
12243 x_get_glyph_overhangs,
12244 x_fix_overlapping_area,
12245 x_draw_fringe_bitmap,
12246 #ifdef USE_CAIRO
12247 x_cr_define_fringe_bitmap,
12248 x_cr_destroy_fringe_bitmap,
12249 #else
12250 0, /* define_fringe_bitmap */
12251 0, /* destroy_fringe_bitmap */
12252 #endif
12253 x_compute_glyph_string_overhangs,
12254 x_draw_glyph_string,
12255 x_define_frame_cursor,
12256 x_clear_frame_area,
12257 x_draw_window_cursor,
12258 x_draw_vertical_window_border,
12259 x_draw_window_divider,
12260 x_shift_glyphs_for_insert, /* Never called; see comment in function. */
12261 x_show_hourglass,
12262 x_hide_hourglass
12263 };
12264
12265
12266 /* This function is called when the last frame on a display is deleted. */
12267 void
12268 x_delete_terminal (struct terminal *terminal)
12269 {
12270 struct x_display_info *dpyinfo = terminal->display_info.x;
12271
12272 /* Protect against recursive calls. delete_frame in
12273 delete_terminal calls us back when it deletes our last frame. */
12274 if (!terminal->name)
12275 return;
12276
12277 block_input ();
12278 #ifdef HAVE_X_I18N
12279 /* We must close our connection to the XIM server before closing the
12280 X display. */
12281 if (dpyinfo->xim)
12282 xim_close_dpy (dpyinfo);
12283 #endif
12284
12285 /* Normally, the display is available... */
12286 if (dpyinfo->display)
12287 {
12288 x_destroy_all_bitmaps (dpyinfo);
12289 XSetCloseDownMode (dpyinfo->display, DestroyAll);
12290
12291 /* Whether or not XCloseDisplay destroys the associated resource
12292 database depends on the version of libX11. To avoid both
12293 crash and memory leak, we dissociate the database from the
12294 display and then destroy dpyinfo->xrdb ourselves.
12295
12296 Unfortunately, the above strategy does not work in some
12297 situations due to a bug in newer versions of libX11: because
12298 XrmSetDatabase doesn't clear the flag XlibDisplayDfltRMDB if
12299 dpy->db is NULL, XCloseDisplay destroys the associated
12300 database whereas it has not been created by XGetDefault
12301 (Bug#21974 in freedesktop.org Bugzilla). As a workaround, we
12302 don't destroy the database here in order to avoid the crash
12303 in the above situations for now, though that may cause memory
12304 leaks in other situations. */
12305 #if false
12306 #ifdef HAVE_XRMSETDATABASE
12307 XrmSetDatabase (dpyinfo->display, NULL);
12308 #else
12309 dpyinfo->display->db = NULL;
12310 #endif
12311 /* We used to call XrmDestroyDatabase from x_delete_display, but
12312 some older versions of libX11 crash if we call it after
12313 closing all the displays. */
12314 XrmDestroyDatabase (dpyinfo->xrdb);
12315 #endif
12316
12317 #ifdef USE_GTK
12318 xg_display_close (dpyinfo->display);
12319 #else
12320 #ifdef USE_X_TOOLKIT
12321 XtCloseDisplay (dpyinfo->display);
12322 #else
12323 XCloseDisplay (dpyinfo->display);
12324 #endif
12325 #endif /* ! USE_GTK */
12326 /* Do not close the connection here because it's already closed
12327 by X(t)CloseDisplay (Bug#18403). */
12328 dpyinfo->display = NULL;
12329 }
12330
12331 /* ...but if called from x_connection_closed, the display may already
12332 be closed and dpyinfo->display was set to 0 to indicate that. Since
12333 X server is most likely gone, explicit close is the only reliable
12334 way to continue and avoid Bug#19147. */
12335 else if (dpyinfo->connection >= 0)
12336 emacs_close (dpyinfo->connection);
12337
12338 /* No more input on this descriptor. */
12339 delete_keyboard_wait_descriptor (dpyinfo->connection);
12340 /* Mark as dead. */
12341 dpyinfo->connection = -1;
12342
12343 x_delete_display (dpyinfo);
12344 unblock_input ();
12345 }
12346
12347 /* Create a struct terminal, initialize it with the X11 specific
12348 functions and make DISPLAY->TERMINAL point to it. */
12349
12350 static struct terminal *
12351 x_create_terminal (struct x_display_info *dpyinfo)
12352 {
12353 struct terminal *terminal;
12354
12355 terminal = create_terminal (output_x_window, &x_redisplay_interface);
12356
12357 terminal->display_info.x = dpyinfo;
12358 dpyinfo->terminal = terminal;
12359
12360 /* kboard is initialized in x_term_init. */
12361
12362 terminal->clear_frame_hook = x_clear_frame;
12363 terminal->ins_del_lines_hook = x_ins_del_lines;
12364 terminal->delete_glyphs_hook = x_delete_glyphs;
12365 terminal->ring_bell_hook = XTring_bell;
12366 terminal->toggle_invisible_pointer_hook = XTtoggle_invisible_pointer;
12367 terminal->update_begin_hook = x_update_begin;
12368 terminal->update_end_hook = x_update_end;
12369 terminal->read_socket_hook = XTread_socket;
12370 terminal->frame_up_to_date_hook = XTframe_up_to_date;
12371 terminal->mouse_position_hook = XTmouse_position;
12372 terminal->frame_rehighlight_hook = XTframe_rehighlight;
12373 terminal->frame_raise_lower_hook = XTframe_raise_lower;
12374 terminal->fullscreen_hook = XTfullscreen_hook;
12375 terminal->menu_show_hook = x_menu_show;
12376 #if defined (USE_X_TOOLKIT) || defined (USE_GTK)
12377 terminal->popup_dialog_hook = xw_popup_dialog;
12378 #endif
12379 terminal->set_vertical_scroll_bar_hook = XTset_vertical_scroll_bar;
12380 terminal->set_horizontal_scroll_bar_hook = XTset_horizontal_scroll_bar;
12381 terminal->condemn_scroll_bars_hook = XTcondemn_scroll_bars;
12382 terminal->redeem_scroll_bar_hook = XTredeem_scroll_bar;
12383 terminal->judge_scroll_bars_hook = XTjudge_scroll_bars;
12384 terminal->delete_frame_hook = x_destroy_window;
12385 terminal->delete_terminal_hook = x_delete_terminal;
12386 /* Other hooks are NULL by default. */
12387
12388 return terminal;
12389 }
12390
12391 static void
12392 x_initialize (void)
12393 {
12394 baud_rate = 19200;
12395
12396 x_noop_count = 0;
12397 any_help_event_p = false;
12398 ignore_next_mouse_click_timeout = 0;
12399
12400 #ifdef USE_GTK
12401 current_count = -1;
12402 #endif
12403
12404 /* Try to use interrupt input; if we can't, then start polling. */
12405 Fset_input_interrupt_mode (Qt);
12406
12407 #ifdef USE_X_TOOLKIT
12408 XtToolkitInitialize ();
12409
12410 Xt_app_con = XtCreateApplicationContext ();
12411
12412 /* Register a converter from strings to pixels, which uses
12413 Emacs' color allocation infrastructure. */
12414 XtAppSetTypeConverter (Xt_app_con,
12415 XtRString, XtRPixel, cvt_string_to_pixel,
12416 cvt_string_to_pixel_args,
12417 XtNumber (cvt_string_to_pixel_args),
12418 XtCacheByDisplay, cvt_pixel_dtor);
12419
12420 XtAppSetFallbackResources (Xt_app_con, Xt_default_resources);
12421 #endif
12422
12423 #ifdef USE_TOOLKIT_SCROLL_BARS
12424 #ifndef USE_GTK
12425 xaw3d_arrow_scroll = False;
12426 xaw3d_pick_top = True;
12427 #endif
12428 #endif
12429
12430 #ifdef USE_CAIRO
12431 x_cr_init_fringe (&x_redisplay_interface);
12432 #endif
12433
12434 /* Note that there is no real way portable across R3/R4 to get the
12435 original error handler. */
12436 XSetErrorHandler (x_error_handler);
12437 XSetIOErrorHandler (x_io_error_quitter);
12438 }
12439
12440 #ifdef USE_GTK
12441 void
12442 init_xterm (void)
12443 {
12444 /* Emacs can handle only core input events, so make sure
12445 Gtk doesn't use Xinput or Xinput2 extensions. */
12446 xputenv ("GDK_CORE_DEVICE_EVENTS=1");
12447 }
12448 #endif
12449
12450 void
12451 syms_of_xterm (void)
12452 {
12453 x_error_message = NULL;
12454
12455 DEFSYM (Qvendor_specific_keysyms, "vendor-specific-keysyms");
12456 DEFSYM (Qlatin_1, "latin-1");
12457
12458 #ifdef USE_GTK
12459 xg_default_icon_file = build_pure_c_string ("icons/hicolor/scalable/apps/emacs.svg");
12460 staticpro (&xg_default_icon_file);
12461
12462 DEFSYM (Qx_gtk_map_stock, "x-gtk-map-stock");
12463 #endif
12464
12465 DEFVAR_BOOL ("x-use-underline-position-properties",
12466 x_use_underline_position_properties,
12467 doc: /* Non-nil means make use of UNDERLINE_POSITION font properties.
12468 A value of nil means ignore them. If you encounter fonts with bogus
12469 UNDERLINE_POSITION font properties, for example 7x13 on XFree prior
12470 to 4.1, set this to nil. You can also use `underline-minimum-offset'
12471 to override the font's UNDERLINE_POSITION for small font display
12472 sizes. */);
12473 x_use_underline_position_properties = true;
12474
12475 DEFVAR_BOOL ("x-underline-at-descent-line",
12476 x_underline_at_descent_line,
12477 doc: /* Non-nil means to draw the underline at the same place as the descent line.
12478 A value of nil means to draw the underline according to the value of the
12479 variable `x-use-underline-position-properties', which is usually at the
12480 baseline level. The default value is nil. */);
12481 x_underline_at_descent_line = false;
12482
12483 DEFVAR_BOOL ("x-mouse-click-focus-ignore-position",
12484 x_mouse_click_focus_ignore_position,
12485 doc: /* Non-nil means that a mouse click to focus a frame does not move point.
12486 This variable is only used when the window manager requires that you
12487 click on a frame to select it (give it focus). In that case, a value
12488 of nil, means that the selected window and cursor position changes to
12489 reflect the mouse click position, while a non-nil value means that the
12490 selected window or cursor position is preserved. */);
12491 x_mouse_click_focus_ignore_position = false;
12492
12493 DEFVAR_LISP ("x-toolkit-scroll-bars", Vx_toolkit_scroll_bars,
12494 doc: /* Which toolkit scroll bars Emacs uses, if any.
12495 A value of nil means Emacs doesn't use toolkit scroll bars.
12496 With the X Window system, the value is a symbol describing the
12497 X toolkit. Possible values are: gtk, motif, xaw, or xaw3d.
12498 With MS Windows or Nextstep, the value is t. */);
12499 #ifdef USE_TOOLKIT_SCROLL_BARS
12500 #ifdef USE_MOTIF
12501 Vx_toolkit_scroll_bars = intern_c_string ("motif");
12502 #elif defined HAVE_XAW3D
12503 Vx_toolkit_scroll_bars = intern_c_string ("xaw3d");
12504 #elif USE_GTK
12505 Vx_toolkit_scroll_bars = intern_c_string ("gtk");
12506 #else
12507 Vx_toolkit_scroll_bars = intern_c_string ("xaw");
12508 #endif
12509 #else
12510 Vx_toolkit_scroll_bars = Qnil;
12511 #endif
12512
12513 DEFSYM (Qmodifier_value, "modifier-value");
12514 DEFSYM (Qalt, "alt");
12515 Fput (Qalt, Qmodifier_value, make_number (alt_modifier));
12516 DEFSYM (Qhyper, "hyper");
12517 Fput (Qhyper, Qmodifier_value, make_number (hyper_modifier));
12518 DEFSYM (Qmeta, "meta");
12519 Fput (Qmeta, Qmodifier_value, make_number (meta_modifier));
12520 DEFSYM (Qsuper, "super");
12521 Fput (Qsuper, Qmodifier_value, make_number (super_modifier));
12522
12523 DEFVAR_LISP ("x-alt-keysym", Vx_alt_keysym,
12524 doc: /* Which keys Emacs uses for the alt modifier.
12525 This should be one of the symbols `alt', `hyper', `meta', `super'.
12526 For example, `alt' means use the Alt_L and Alt_R keysyms. The default
12527 is nil, which is the same as `alt'. */);
12528 Vx_alt_keysym = Qnil;
12529
12530 DEFVAR_LISP ("x-hyper-keysym", Vx_hyper_keysym,
12531 doc: /* Which keys Emacs uses for the hyper modifier.
12532 This should be one of the symbols `alt', `hyper', `meta', `super'.
12533 For example, `hyper' means use the Hyper_L and Hyper_R keysyms. The
12534 default is nil, which is the same as `hyper'. */);
12535 Vx_hyper_keysym = Qnil;
12536
12537 DEFVAR_LISP ("x-meta-keysym", Vx_meta_keysym,
12538 doc: /* Which keys Emacs uses for the meta modifier.
12539 This should be one of the symbols `alt', `hyper', `meta', `super'.
12540 For example, `meta' means use the Meta_L and Meta_R keysyms. The
12541 default is nil, which is the same as `meta'. */);
12542 Vx_meta_keysym = Qnil;
12543
12544 DEFVAR_LISP ("x-super-keysym", Vx_super_keysym,
12545 doc: /* Which keys Emacs uses for the super modifier.
12546 This should be one of the symbols `alt', `hyper', `meta', `super'.
12547 For example, `super' means use the Super_L and Super_R keysyms. The
12548 default is nil, which is the same as `super'. */);
12549 Vx_super_keysym = Qnil;
12550
12551 DEFVAR_LISP ("x-keysym-table", Vx_keysym_table,
12552 doc: /* Hash table of character codes indexed by X keysym codes. */);
12553 Vx_keysym_table = make_hash_table (hashtest_eql, make_number (900),
12554 make_float (DEFAULT_REHASH_SIZE),
12555 make_float (DEFAULT_REHASH_THRESHOLD),
12556 Qnil);
12557
12558 DEFVAR_BOOL ("x-frame-normalize-before-maximize",
12559 x_frame_normalize_before_maximize,
12560 doc: /* Non-nil means normalize frame before maximizing.
12561 If this variable is t, Emacs first asks the window manager to give the
12562 frame its normal size, and only then the final state, whenever changing
12563 from a full-height, full-width or full-both state to the maximized one
12564 or when changing from the maximized to the full-height or full-width
12565 state.
12566
12567 Set this variable only if your window manager cannot handle the
12568 transition between the various maximization states. */);
12569 x_frame_normalize_before_maximize = false;
12570 }