xterm.c 342 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* X Communication module for terminals which understand the X protocol.
Glenn Morris's avatar
Glenn Morris committed
2

3
Copyright (C) 1989, 1993-2014 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

7
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
8
it under the terms of the GNU General Public License as published by
9 10
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

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/>.  */
Jim Blandy's avatar
Jim Blandy committed
19

20
/* New display code by Gerd Moellmann <gerd@gnu.org>.  */
21 22
/* Xt features made by Fred Pierresteguy.  */

23
#include <config.h>
24 25
#include <stdio.h>

Jim Blandy's avatar
Jim Blandy committed
26
#include "lisp.h"
27
#include "blockinput.h"
28 29
#include "syssignal.h"

Jim Blandy's avatar
Jim Blandy committed
30 31 32
/* This may include sys/types.h, and that somehow loses
   if this is not done before the other system files.  */
#include "xterm.h"
33
#include <X11/cursorfont.h>
Jim Blandy's avatar
Jim Blandy committed
34

35 36 37 38 39
/* If we have Xfixes extension, use it for pointer blanking.  */
#ifdef HAVE_XFIXES
#include <X11/extensions/Xfixes.h>
#endif

40 41 42 43 44
/* Using Xft implies that XRender is available.  */
#ifdef HAVE_XFT
#include <X11/extensions/Xrender.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
45 46 47 48
/* Load sys/types.h if not already loaded.
   In some systems loading it twice is suicidal.  */
#ifndef makedev
#include <sys/types.h>
49
#endif /* makedev */
Jim Blandy's avatar
Jim Blandy committed
50 51 52

#include <sys/ioctl.h>

Jim Blandy's avatar
Jim Blandy committed
53
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
54 55 56 57

#include <fcntl.h>
#include <errno.h>
#include <sys/stat.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
58 59
/* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed.  */
/* #include <sys/param.h>  */
Jim Blandy's avatar
Jim Blandy committed
60

61
#include "charset.h"
Kenichi Handa's avatar
Kenichi Handa committed
62
#include "character.h"
Kenichi Handa's avatar
Kenichi Handa committed
63
#include "coding.h"
64
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
65
#include "dispextern.h"
66
#include "fontset.h"
Jim Blandy's avatar
Jim Blandy committed
67 68 69
#include "termhooks.h"
#include "termopts.h"
#include "termchar.h"
70
#include "emacs-icon.h"
Jim Blandy's avatar
Jim Blandy committed
71 72
#include "disptab.h"
#include "buffer.h"
73
#include "window.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
74
#include "keyboard.h"
Karl Heuer's avatar
Karl Heuer committed
75
#include "intervals.h"
Andreas Schwab's avatar
Andreas Schwab committed
76
#include "process.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
77
#include "atimer.h"
Stefan Monnier's avatar
Stefan Monnier committed
78
#include "keymap.h"
79
#include "font.h"
80
#include "xsettings.h"
81
#include "xgselect.h"
82
#include "sysselect.h"
83
#include "menu.h"
Jim Blandy's avatar
Jim Blandy committed
84

85 86 87 88
#ifdef USE_X_TOOLKIT
#include <X11/Shell.h>
#endif

89 90
#include <unistd.h>

Jan Djärv's avatar
Jan Djärv committed
91 92
#ifdef USE_GTK
#include "gtkutil.h"
Jan Djärv's avatar
Jan Djärv committed
93 94 95
#ifdef HAVE_GTK3
#include <X11/Xproto.h>
#endif
Jan Djärv's avatar
Jan Djärv committed
96 97
#endif

98
#if defined (USE_LUCID) || defined (USE_MOTIF)
99
#include "../lwlib/xlwmenu.h"
100 101
#endif

Jan Djärv's avatar
Jan Djärv committed
102
#ifdef USE_X_TOOLKIT
Juanma Barranquero's avatar
Juanma Barranquero committed
103
#if !defined (NO_EDITRES)
104
#define HACK_EDITRES
105
extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
106
#endif /* not NO_EDITRES */
107 108 109 110 111

/* Include toolkit specific headers for the scroll bar widget.  */

#ifdef USE_TOOLKIT_SCROLL_BARS
#if defined USE_MOTIF
112
#include <Xm/Xm.h>		/* For LESSTIF_VERSION */
113
#include <Xm/ScrollBar.h>
114 115 116
#else /* !USE_MOTIF i.e. use Xaw */

#ifdef HAVE_XAW3D
117 118
#include <X11/Xaw3d/Simple.h>
#include <X11/Xaw3d/Scrollbar.h>
119
#include <X11/Xaw3d/ThreeD.h>
120 121 122 123 124 125 126 127
#else /* !HAVE_XAW3D */
#include <X11/Xaw/Simple.h>
#include <X11/Xaw/Scrollbar.h>
#endif /* !HAVE_XAW3D */
#ifndef XtNpickTop
#define XtNpickTop "pickTop"
#endif /* !XtNpickTop */
#endif /* !USE_MOTIF */
128 129
#endif /* USE_TOOLKIT_SCROLL_BARS */

130 131
#endif /* USE_X_TOOLKIT */

132
#ifdef USE_X_TOOLKIT
Karl Heuer's avatar
Karl Heuer committed
133
#include "widget.h"
134 135 136 137 138
#ifndef XtNinitialState
#define XtNinitialState "initialState"
#endif
#endif

139 140
#include "bitmaps/gray.xbm"

141 142 143 144
#ifdef HAVE_XKB
#include <X11/XKBlib.h>
#endif

Dave Love's avatar
Dave Love committed
145
/* Default to using XIM if available.  */
146
#ifdef USE_XIM
147
bool use_xim = true;
148
#else
149
bool use_xim = false;  /* configure --without-xim */
150 151
#endif

152 153 154
/* Non-zero means that a HELP_EVENT has been generated since Emacs
   start.  */

155
static bool any_help_event_p;
156 157 158 159

/* This is a chain of structures for all the X displays currently in
   use.  */

160
struct x_display_info *x_display_list;
Jim Blandy's avatar
Jim Blandy committed
161

162
#ifdef USE_X_TOOLKIT
163

164 165
/* The application context for Xt use.  */
XtAppContext Xt_app_con;
166
static String Xt_default_resources[] = {0};
167

Gerd Moellmann's avatar
Gerd Moellmann committed
168
/* Non-zero means user is interacting with a toolkit scroll bar.  */
169
static bool toolkit_scroll_bar_interaction;
Gerd Moellmann's avatar
Gerd Moellmann committed
170

171
#endif /* USE_X_TOOLKIT */
Jim Blandy's avatar
Jim Blandy committed
172

Kenichi Handa's avatar
Kenichi Handa committed
173 174 175 176
/* Non-zero timeout value means ignore next mouse click if it arrives
   before that timeout elapses (i.e. as part of the same sequence of
   events resulting from clicking on a frame to select it).  */

177
static Time ignore_next_mouse_click_timeout;
Kenichi Handa's avatar
Kenichi Handa committed
178

179
/* Used locally within XTread_socket.  */
180

181
static int x_noop_count;
Jim Blandy's avatar
Jim Blandy committed
182

183 184
static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;

185
static Lisp_Object Qvendor_specific_keysyms;
Dave Love's avatar
Dave Love committed
186
static Lisp_Object Qlatin_1;
187

188 189 190
#ifdef USE_GTK
/* The name of the Emacs icon file.  */
static Lisp_Object xg_default_icon_file;
191 192 193

/* Used in gtkutil.c.  */
Lisp_Object Qx_gtk_map_stock;
194 195
#endif

196 197 198
/* Some functions take this as char *, not const char *.  */
static char emacs_class[] = EMACS_CLASS;

Andreas Schwab's avatar
Andreas Schwab committed
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220
enum xembed_info
  {
    XEMBED_MAPPED = 1 << 0
  };

enum xembed_message
  {
    XEMBED_EMBEDDED_NOTIFY        = 0,
    XEMBED_WINDOW_ACTIVATE        = 1,
    XEMBED_WINDOW_DEACTIVATE      = 2,
    XEMBED_REQUEST_FOCUS          = 3,
    XEMBED_FOCUS_IN               = 4,
    XEMBED_FOCUS_OUT              = 5,
    XEMBED_FOCUS_NEXT             = 6,
    XEMBED_FOCUS_PREV             = 7,

    XEMBED_MODALITY_ON            = 10,
    XEMBED_MODALITY_OFF           = 11,
    XEMBED_REGISTER_ACCELERATOR   = 12,
    XEMBED_UNREGISTER_ACCELERATOR = 13,
    XEMBED_ACTIVATE_ACCELERATOR   = 14
  };
221

222
static bool x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
223
static void x_set_window_size_1 (struct frame *, int, int, int, bool);
224 225
static void x_raise_frame (struct frame *);
static void x_lower_frame (struct frame *);
226 227 228 229 230 231
static const XColor *x_color_cells (Display *, int *);
static int x_io_error_quitter (Display *);
static struct terminal *x_create_terminal (struct x_display_info *);
static void x_update_end (struct frame *);
static void XTframe_up_to_date (struct frame *);
static void x_clear_frame (struct frame *);
232
static _Noreturn void x_ins_del_lines (struct frame *, int, int);
233 234 235 236 237 238 239 240 241 242 243
static void frame_highlight (struct frame *);
static void frame_unhighlight (struct frame *);
static void x_new_focus_frame (struct x_display_info *, struct frame *);
static void  x_focus_changed (int, int, struct x_display_info *,
                              struct frame *, struct input_event *);
static void XTframe_rehighlight (struct frame *);
static void x_frame_rehighlight (struct x_display_info *);
static void x_draw_hollow_cursor (struct window *, struct glyph_row *);
static void x_draw_bar_cursor (struct window *, struct glyph_row *, int,
                               enum text_cursor_kinds);

244 245
static void x_clip_to_row (struct window *, struct glyph_row *,
			   enum glyph_row_area, GC);
246 247 248
static void x_flush (struct frame *f);
static void x_update_begin (struct frame *);
static void x_update_window_begin (struct window *);
249
static struct scroll_bar *x_window_to_scroll_bar (Display *, Window, int);
250 251 252
static void x_scroll_bar_report_motion (struct frame **, Lisp_Object *,
                                        enum scroll_bar_part *,
                                        Lisp_Object *, Lisp_Object *,
253
                                        Time *);
254 255 256 257
static void x_horizontal_scroll_bar_report_motion (struct frame **, Lisp_Object *,
						   enum scroll_bar_part *,
						   Lisp_Object *, Lisp_Object *,
						   Time *);
258
static int x_handle_net_wm_state (struct frame *, const XPropertyEvent *);
259 260 261
static void x_check_fullscreen (struct frame *);
static void x_check_expected_move (struct frame *, int, int);
static void x_sync_with_move (struct frame *, int, int, int);
262
static int handle_one_xevent (struct x_display_info *,
263
			      const XEvent *, int *,
264
			      struct input_event *);
265 266 267
#if ! (defined USE_X_TOOLKIT || defined USE_MOTIF)
static int x_dispatch_event (XEvent *, Display *);
#endif
268
/* Don't declare this _Noreturn because we want no
269
   interference with debugging failing X calls.  */
270
static void x_connection_closed (Display *, const char *);
271
static void x_wm_set_window_state (struct frame *, int);
272
static void x_wm_set_icon_pixmap (struct frame *, ptrdiff_t);
273
static void x_initialize (void);
Jan Djärv's avatar
Jan Djärv committed
274

275
static int get_current_wm_state (struct frame *, Window, int *, int *);
276

Dmitry Antipov's avatar
Dmitry Antipov committed
277
/* Flush display of frame F.  */
278 279

static void
280
x_flush (struct frame *f)
281
{
Dmitry Antipov's avatar
Dmitry Antipov committed
282
  eassert (f && FRAME_X_P (f));
283 284 285 286 287
  /* Don't call XFlush when it is not safe to redisplay; the X
     connection may be broken.  */
  if (!NILP (Vinhibit_redisplay))
    return;

288
  block_input ();
Dmitry Antipov's avatar
Dmitry Antipov committed
289
  XFlush (FRAME_X_DISPLAY (f));
290
  unblock_input ();
291 292
}

Jim Blandy's avatar
Jim Blandy committed
293

294 295 296 297 298 299 300
/* Remove calls to XFlush by defining XFlush to an empty replacement.
   Calls to XFlush should be unnecessary because the X output buffer
   is flushed automatically as needed by calls to XPending,
   XNextEvent, or XWindowEvent according to the XFlush man page.
   XTread_socket calls XPending.  Removing XFlush improves
   performance.  */

Juanma Barranquero's avatar
Juanma Barranquero committed
301
#define XFlush(DISPLAY)	(void) 0
302

303

304 305 306 307
/***********************************************************************
			      Debugging
 ***********************************************************************/

308
#if 0
309 310 311

/* This is a function useful for recording debugging information about
   the sequence of occurrences in this file.  */
312

Juanma Barranquero's avatar
Juanma Barranquero committed
313
struct record
314 315 316 317 318 319 320 321 322
{
  char *locus;
  int type;
};

struct record event_record[100];

int event_record_index;

Andreas Schwab's avatar
Andreas Schwab committed
323 324
void
record_event (char *locus, int type)
325
{
326
  if (event_record_index == ARRAYELTS (event_record))
327 328 329 330 331 332 333 334
    event_record_index = 0;

  event_record[event_record_index].locus = locus;
  event_record[event_record_index].type = type;
  event_record_index++;
}

#endif /* 0 */
335 336


337

338 339 340
/* Return the struct x_display_info corresponding to DPY.  */

struct x_display_info *
341
x_display_info_for_display (Display *dpy)
342 343 344 345 346 347
{
  struct x_display_info *dpyinfo;

  for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
    if (dpyinfo->display == dpy)
      return dpyinfo;
348

349 350
  return 0;
}
351

352 353 354 355 356 357 358
static Window
x_find_topmost_parent (struct frame *f)
{
  struct x_output *x = f->output_data.x;
  Window win = None, wi = x->parent_desc;
  Display *dpy = FRAME_X_DISPLAY (f);

359
  while (wi != FRAME_DISPLAY_INFO (f)->root_window)
360 361 362 363 364 365
    {
      Window root;
      Window *children;
      unsigned int nchildren;

      win = wi;
366 367 368 369
      if (XQueryTree (dpy, win, &root, &wi, &children, &nchildren))
	XFree (children);
      else
	break;
370 371 372 373 374
    }

  return win;
}

375 376 377
#define OPAQUE  0xffffffff

void
378
x_set_frame_alpha (struct frame *f)
379
{
380
  struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
381 382
  Display *dpy = FRAME_X_DISPLAY (f);
  Window win = FRAME_OUTER_WINDOW (f);
383 384
  double alpha = 1.0;
  double alpha_min = 1.0;
385
  unsigned long opac;
386
  Window parent;
387

388 389 390 391 392 393 394 395 396 397
  if (dpyinfo->x_highlight_frame == f)
    alpha = f->alpha[0];
  else
    alpha = f->alpha[1];

  if (FLOATP (Vframe_alpha_lower_limit))
    alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
  else if (INTEGERP (Vframe_alpha_lower_limit))
    alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;

398 399 400
  if (alpha < 0.0)
    return;
  else if (alpha > 1.0)
401
    alpha = 1.0;
Paul Eggert's avatar
Paul Eggert committed
402
  else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
403 404
    alpha = alpha_min;

405
  opac = alpha * OPAQUE;
406

407 408 409 410 411 412 413 414 415 416 417
  x_catch_errors (dpy);

  /* If there is a parent from the window manager, put the property there
     also, to work around broken window managers that fail to do that.
     Do this unconditionally as this function is called on reparent when
     alpha has not changed on the frame.  */

  parent = x_find_topmost_parent (f);
  if (parent != None)
    XChangeProperty (dpy, parent, dpyinfo->Xatom_net_wm_window_opacity,
                     XA_CARDINAL, 32, PropModeReplace,
418
                     (unsigned char *) &opac, 1);
419

420 421 422 423
  /* return unless necessary */
  {
    unsigned char *data;
    Atom actual;
424
    int rc, format;
425 426
    unsigned long n, left;

427
    rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
428
			     0, 1, False, XA_CARDINAL,
429 430
			     &actual, &format, &n, &left,
			     &data);
431 432

    if (rc == Success && actual != None)
433
      {
434
        unsigned long value = *(unsigned long *)data;
435
	XFree (data);
436
	if (value == opac)
437 438 439 440 441
	  {
	    x_uncatch_errors ();
	    return;
	  }
      }
442 443
  }

444
  XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
445
		   XA_CARDINAL, 32, PropModeReplace,
446
		   (unsigned char *) &opac, 1);
447
  x_uncatch_errors ();
448
}
449 450 451 452

/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
Juanma Barranquero's avatar
Juanma Barranquero committed
453

454 455 456 457 458
/* Start an update of frame F.  This function is installed as a hook
   for update_begin, i.e. it is called when update_begin is called.
   This function is called prior to calls to x_update_window_begin for
   each window being updated.  Currently, there is nothing to do here
   because all interesting stuff is done on a window basis.  */
Jim Blandy's avatar
Jim Blandy committed
459

Andreas Schwab's avatar
Andreas Schwab committed
460
static void
461
x_update_begin (struct frame *f)
462
{
463 464
  /* Nothing to do.  */
}
Jim Blandy's avatar
Jim Blandy committed
465 466


467
/* Start update of window W.  */
Jim Blandy's avatar
Jim Blandy committed
468

469
static void
470
x_update_window_begin (struct window *w)
471 472
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
473
  Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
Juanma Barranquero's avatar
Juanma Barranquero committed
474

475
  w->output_cursor = w->cursor;
476

477
  block_input ();
478

479
  if (f == hlinfo->mouse_face_mouse_frame)
480
    {
481
      /* Don't do highlighting for mouse motion during the update.  */
482
      hlinfo->mouse_face_defer = 1;
483

484 485
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
486
      if (FRAME_GARBAGED_P (f))
487
	hlinfo->mouse_face_window = Qnil;
488
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
489

490
  unblock_input ();
Jim Blandy's avatar
Jim Blandy committed
491 492
}

493

494
/* Draw a vertical window border from (x,y0) to (x,y1)  */
495

Andreas Schwab's avatar
Andreas Schwab committed
496
static void
497
x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
498
{
499
  struct frame *f = XFRAME (WINDOW_FRAME (w));
500 501 502 503 504 505
  struct face *face;

  face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
  if (face)
    XSetForeground (FRAME_X_DISPLAY (f), f->output_data.x->normal_gc,
		    face->foreground);
506

507 508
  XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
	     f->output_data.x->normal_gc, x, y0, x, y1);
509
}
Juanma Barranquero's avatar
Juanma Barranquero committed
510

511 512 513 514 515 516
/* Draw a window divider from (x0,y0) to (x1,y1)  */

static void
x_draw_window_divider (struct window *w, int x0, int x1, int y0, int y1)
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561
  struct face *face = FACE_FROM_ID (f, WINDOW_DIVIDER_FACE_ID);
  struct face *face_first = FACE_FROM_ID (f, WINDOW_DIVIDER_FIRST_PIXEL_FACE_ID);
  struct face *face_last = FACE_FROM_ID (f, WINDOW_DIVIDER_LAST_PIXEL_FACE_ID);
  unsigned long color = face ? face->foreground : FRAME_FOREGROUND_PIXEL (f);
  unsigned long color_first = (face_first
			       ? face_first->foreground
			       : FRAME_FOREGROUND_PIXEL (f));
  unsigned long color_last = (face_last
			      ? face_last->foreground
			      : FRAME_FOREGROUND_PIXEL (f));
  Display *display = FRAME_X_DISPLAY (f);
  Window window = FRAME_X_WINDOW (f);

  if (y1 - y0 > x1 - x0 && x1 - x0 > 2)
    /* Vertical.  */
    {
      XSetForeground (display, f->output_data.x->normal_gc, color_first);
      XFillRectangle (display, window, f->output_data.x->normal_gc,
		      x0, y0, 1, y1 - y0);
      XSetForeground (display, f->output_data.x->normal_gc, color);
      XFillRectangle (display, window, f->output_data.x->normal_gc,
		      x0 + 1, y0, x1 - x0 - 2, y1 - y0);
      XSetForeground (display, f->output_data.x->normal_gc, color_last);
      XFillRectangle (display, window, f->output_data.x->normal_gc,
		      x1 - 1, y0, 1, y1 - y0);
    }
  else if (x1 - x0 > y1 - y0 && y1 - y0 > 3)
    /* Horizontal.  */
    {
      XSetForeground (display, f->output_data.x->normal_gc, color_first);
      XFillRectangle (display, window, f->output_data.x->normal_gc,
		      x0, y0, x1 - x0, 1);
      XSetForeground (display, f->output_data.x->normal_gc, color);
      XFillRectangle (display, window, f->output_data.x->normal_gc,
		      x0, y0 + 1, x1 - x0, y1 - y0 - 2);
      XSetForeground (display, f->output_data.x->normal_gc, color_last);
      XFillRectangle (display, window, f->output_data.x->normal_gc,
		      x0, y1 - 1, x1 - x0, 1);
    }
  else
    {
      XSetForeground (display, f->output_data.x->normal_gc, color);
      XFillRectangle (display, window, f->output_data.x->normal_gc,
		      x0, y0, x1 - x0, y1 - y0);
    }
562 563
}

564
/* End update of window W.
565 566 567 568 569 570 571 572 573 574 575

   Draw vertical borders between horizontally adjacent windows, and
   display W's cursor if CURSOR_ON_P is non-zero.

   MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
   glyphs in mouse-face were overwritten.  In that case we have to
   make sure that the mouse-highlight is properly redrawn.

   W may be a menu bar pseudo-window in case we don't have X toolkit
   support.  Such windows don't have a cursor, so don't display it
   here.  */
576 577

static void
578 579
x_update_window_end (struct window *w, bool cursor_on_p,
		     bool mouse_face_overwritten_p)
580 581 582
{
  if (!w->pseudo_window_p)
    {
583
      block_input ();
584

585
      if (cursor_on_p)
586 587 588
	display_and_set_cursor (w, 1,
				w->output_cursor.hpos, w->output_cursor.vpos,
				w->output_cursor.x, w->output_cursor.y);
Juanma Barranquero's avatar
Juanma Barranquero committed
589

590
      if (draw_window_fringes (w, 1))
591 592 593 594 595 596
	{
	  if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
	    x_draw_right_divider (w);
	  else
	    x_draw_vertical_border (w);
	}
Kenichi Handa's avatar
Kenichi Handa committed
597

598
      unblock_input ();
599
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
600

601 602 603
  /* If a row with mouse-face was overwritten, arrange for
     XTframe_up_to_date to redisplay the mouse highlight.  */
  if (mouse_face_overwritten_p)
604 605 606 607 608 609 610
    {
      Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));

      hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
      hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
      hlinfo->mouse_face_window = Qnil;
    }
611
}
Jim Blandy's avatar
Jim Blandy committed
612 613


614 615 616 617
/* End update of frame F.  This function is installed as a hook in
   update_end.  */

static void
618
x_update_end (struct frame *f)
619 620
{
  /* Mouse highlight may be displayed again.  */
621
  MOUSE_HL_INFO (f)->mouse_face_defer = 0;
622

623
#ifndef XFlush
624
  block_input ();
625
  XFlush (FRAME_X_DISPLAY (f));
626
  unblock_input ();
627
#endif
Jim Blandy's avatar
Jim Blandy committed
628
}
629

630

631 632
/* This function is called from various places in xdisp.c
   whenever a complete update has been performed.  */
633

Andreas Schwab's avatar
Andreas Schwab committed
634
static void
635
XTframe_up_to_date (struct frame *f)
636
{
637
  if (FRAME_X_P (f))
638
    FRAME_MOUSE_UPDATE (f);
639
}
640 641


642 643
/* Clear under internal border if any (GTK has its own version). */
#ifndef USE_GTK
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
void
x_clear_under_internal_border (struct frame *f)
{
  if (FRAME_INTERNAL_BORDER_WIDTH (f) > 0)
    {
      Display *display = FRAME_X_DISPLAY (f);
      Window window = FRAME_X_WINDOW (f);
      int border = FRAME_INTERNAL_BORDER_WIDTH (f);
      int width = FRAME_PIXEL_WIDTH (f);
      int height = FRAME_PIXEL_HEIGHT (f);
      int margin = FRAME_TOP_MARGIN_HEIGHT (f);

      block_input ();
      x_clear_area (display, window, 0, 0, border, height);
      x_clear_area (display, window, 0, margin, width, border);
      x_clear_area (display, window, width - border, 0, border, height);
      x_clear_area (display, window, 0, height - border, width, border);
      unblock_input ();
    }
}
#endif

666
/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
667
   arrow bitmaps, or clear the fringes if no bitmaps are required
668
   before DESIRED_ROW is made current.  This function is called from
669 670 671 672
   update_window_line only if it is known that there are differences
   between bitmaps to be drawn between current row and DESIRED_ROW.  */

static void
673
x_after_update_window_line (struct window *w, struct glyph_row *desired_row)
674
{
675
  eassert (w);
Juanma Barranquero's avatar
Juanma Barranquero committed
676

677
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
Kenichi Handa's avatar
Kenichi Handa committed
678
    desired_row->redraw_fringe_bitmaps_p = 1;
Juanma Barranquero's avatar
Juanma Barranquero committed
679

680
#ifdef USE_X_TOOLKIT
681 682
  /* When a window has disappeared, make sure that no rest of
     full-width rows stays visible in the internal border.  Could
683
     check here if updated window is the leftmost/rightmost window,
684 685 686
     but I guess it's not worth doing since vertically split windows
     are almost never used, internal border is rarely set, and the
     overhead is very small.  */
687 688 689 690 691 692 693 694 695 696 697 698 699
  {
    struct frame *f;
    int width, height;

    if (windows_or_buffers_changed
	&& desired_row->full_width_p
	&& (f = XFRAME (w->frame),
	    width = FRAME_INTERNAL_BORDER_WIDTH (f),
	    width != 0)
	&& (height = desired_row->visible_height,
	    height > 0))
      {
	int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
700

701 702 703 704 705 706 707 708 709 710
	block_input ();
	x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
		      0, y, width, height);
	x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
		      FRAME_PIXEL_WIDTH (f) - width,
		      y, width, height);
	unblock_input ();
      }
  }
#endif
711 712 713
}

static void
714
x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
715 716 717 718 719
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  Display *display = FRAME_X_DISPLAY (f);
  Window window = FRAME_X_WINDOW (f);
  GC gc = f->output_data.x->normal_gc;
Kim F. Storm's avatar
Kim F. Storm committed
720
  struct face *face = p->face;
721 722

  /* Must clip because of partially visible lines.  */
723
  x_clip_to_row (w, row, ANY_AREA, gc);
724

725
  if (p->bx >= 0 && !p->overlay_p)
726 727 728 729 730 731 732 733 734
    {
      /* In case the same realized face is used for fringes and
	 for something displayed in the text (e.g. face `region' on
	 mono-displays, the fill style may have been changed to
	 FillSolid in x_draw_glyph_string_background.  */
      if (face->stipple)
	XSetFillStyle (display, face->gc, FillOpaqueStippled);
      else
	XSetForeground (display, face->gc, face->background);
Juanma Barranquero's avatar
Juanma Barranquero committed
735

736 737
      XFillRectangle (display, window, face->gc,
		      p->bx, p->by, p->nx, p->ny);
Kim F. Storm's avatar
Kim F. Storm committed
738

739 740 741 742
      if (!face->stipple)
	XSetForeground (display, face->gc, face->foreground);
    }

Kenichi Handa's avatar
Kenichi Handa committed
743
  if (p->which)
744
    {
745
      char *bits;
Kenichi Handa's avatar
Kenichi Handa committed
746
      Pixmap pixmap, clipmask = (Pixmap) 0;
Kim F. Storm's avatar
Kim F. Storm committed
747
      int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
Kenichi Handa's avatar
Kenichi Handa committed
748 749 750
      XGCValues gcv;

      if (p->wd > 8)
751
	bits = (char *) (p->bits + p->dh);
Kenichi Handa's avatar
Kenichi Handa committed
752
      else
753
	bits = (char *) p->bits + p->dh;
Kim F. Storm's avatar
Kim F. Storm committed
754

755 756
      /* Draw the bitmap.  I believe these small pixmaps can be cached
	 by the server.  */
Kim F. Storm's avatar
Kim F. Storm committed
757
      pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
Kenichi Handa's avatar
Kenichi Handa committed
758 759 760 761
					    (p->cursor_p
					     ? (p->overlay_p ? face->background
						: f->output_data.x->cursor_pixel)
					     : face->foreground),
762
					    face->background, depth);
Kenichi Handa's avatar
Kenichi Handa committed
763 764 765 766

      if (p->overlay_p)
	{
	  clipmask = XCreatePixmapFromBitmapData (display,
767
						  FRAME_DISPLAY_INFO (f)->root_window,
Kenichi Handa's avatar
Kenichi Handa committed
768 769 770 771 772 773 774 775
						  bits, p->wd, p->h,
						  1, 0, 1);
	  gcv.clip_mask = clipmask;
	  gcv.clip_x_origin = p->x;
	  gcv.clip_y_origin = p->y;
	  XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
	}

Kim F. Storm's avatar
Kim F. Storm committed
776 777
      XCopyArea (display, pixmap, window, gc, 0, 0,
		 p->wd, p->h, p->x, p->y);
778
      XFreePixmap (display, pixmap);
Kenichi Handa's avatar
Kenichi Handa committed
779 780 781 782 783 784 785

      if (p->overlay_p)
	{
	  gcv.clip_mask = (Pixmap) 0;
	  XChangeGC (display, gc, GCClipMask, &gcv);
	  XFreePixmap (display, clipmask);
	}
786
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
787

788 789 790 791 792 793 794 795 796
  XSetClipMask (display, gc, None);
}

/***********************************************************************
			    Glyph display
 ***********************************************************************/



797 798 799 800 801 802
static void x_set_glyph_string_clipping (struct glyph_string *);
static void x_set_glyph_string_gc (struct glyph_string *);
static void x_draw_glyph_string_foreground (struct glyph_string *);
static void x_draw_composite_glyph_string_foreground (struct glyph_string *);
static void x_draw_glyph_string_box (struct glyph_string *);
static void x_draw_glyph_string  (struct glyph_string *);
803
static _Noreturn void x_delete_glyphs (struct frame *, int);
804 805 806 807
static void x_compute_glyph_string_overhangs (struct glyph_string *);
static void x_set_cursor_gc (struct glyph_string *);
static void x_set_mode_line_face_gc (struct glyph_string *);
static void x_set_mouse_face_gc (struct glyph_string *);
808 809
static bool x_alloc_lighter_color (struct frame *, Display *, Colormap,
				   unsigned long *, double, int);
810 811 812 813 814 815 816 817 818 819 820 821 822 823
static void x_setup_relief_color (struct frame *, struct relief *,
                                  double, int, unsigned long);
static void x_setup_relief_colors (struct glyph_string *);
static void x_draw_image_glyph_string (struct glyph_string *);
static void x_draw_image_relief (struct glyph_string *);
static void x_draw_image_foreground (struct glyph_string *);
static void x_draw_image_foreground_1 (struct glyph_string *, Pixmap);
static void x_clear_glyph_string_rect (struct glyph_string *, int,
                                       int, int, int);
static void x_draw_relief_rect (struct frame *, int, int, int, int,
                                int, int, int, int, int, int,
                                XRectangle *);
static void x_draw_box_rect (struct glyph_string *, int, int, int, int,
                             int, int, int, XRectangle *);
Andreas Schwab's avatar
Andreas Schwab committed
824
static void x_scroll_bar_clear (struct frame *);
825

826
#ifdef GLYPH_DEBUG
827
static void x_check_font (struct frame *, struct font *);
828
#endif
829 830 831 832 833 834


/* Set S->gc to a suitable GC for drawing glyph string S in cursor
   face.  */

static void
835
x_set_cursor_gc (struct glyph_string *s)
836 837 838 839
{
  if (s->font == FRAME_FONT (s->f)
      && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
      && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
840
      && !s->cmp)
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868
    s->gc = s->f->output_data.x->cursor_gc;
  else
    {
      /* Cursor on non-default face: must merge.  */
      XGCValues xgcv;
      unsigned long mask;

      xgcv.background = s->f->output_data.x->cursor_pixel;
      xgcv.foreground = s->face->background;

      /* If the glyph would be invisible, try a different foreground.  */
      if (xgcv.foreground == xgcv.background)
	xgcv.foreground = s->face->foreground;
      if (xgcv.foreground == xgcv.background)
	xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
      if (xgcv.foreground == xgcv.background)
	xgcv.foreground = s->face->foreground;

      /* Make sure the cursor is distinct from text in this face.  */
      if (xgcv.background == s->face->background
	  && xgcv.foreground == s->face->foreground)
	{
	  xgcv.background = s->face->foreground;
	  xgcv.foreground = s->face->background;
	}

      IF_DEBUG (x_check_font (s->f, s->font));
      xgcv.graphics_exposures = False;
869
      mask = GCForeground | GCBackground | GCGraphicsExposures;
870

871 872
      if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
	XChangeGC (s->display, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
873 874
		   mask, &xgcv);
      else
875
	FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
876 877
	  = XCreateGC (s->display, s->window, mask, &xgcv);

878
      s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
879 880 881 882 883
    }
}


/* Set up S->gc of glyph string S for drawing text in mouse face.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
884

885
static void
886
x_set_mouse_face_gc (struct glyph_string *s)
Juanma Barranquero's avatar
Juanma Barranquero committed
887
{
888
  int face_id;
889
  struct face *face;
890

891
  /* What face has to be used last for the mouse face?  */
892
  face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
893
  face = FACE_FROM_ID (s->f, face_id);
894 895
  if (face == NULL)
    face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
Juanma Barranquero's avatar
Juanma Barranquero committed
896

897
  if (s->first_glyph->type == CHAR_GLYPH)
898
    face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
899
  else
900
    face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
901
  s->face = FACE_FROM_ID (s->f, face_id);
902
  prepare_face_for_display (s->f, s->face);
903 904 905 906 907 908

  if (s->font == s->face->font)
    s->gc = s->face->gc;
  else
    {
      /* Otherwise construct scratch_cursor_gc with values from FACE
909
	 except for FONT.  */
910 911
      XGCValues xgcv;
      unsigned long mask;
Juanma Barranquero's avatar
Juanma Barranquero committed
912

913 914 915
      xgcv.background = s->face->background;
      xgcv.foreground = s->face->foreground;
      xgcv.graphics_exposures = False;
916
      mask = GCForeground | GCBackground | GCGraphicsExposures;
Juanma Barranquero's avatar
Juanma Barranquero committed
917

918 919
      if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
	XChangeGC (s->display, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
920 921
		   mask, &xgcv);
      else
922
	FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
923
	  = XCreateGC (s->display, s->window, mask, &xgcv);
Juanma Barranquero's avatar
Juanma Barranquero committed
924

925
      s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
926

927
    }
928
  eassert (s->gc != 0);
929 930 931 932 933 934 935
}


/* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
   Faces to use in the mode line have already been computed when the
   matrix was built, so there isn't much to do, here.  */

936
static void
937
x_set_mode_line_face_gc (struct glyph_string *s)
Juanma Barranquero's avatar
Juanma Barranquero committed
938
{
939 940 941 942 943 944 945 946
  s->gc = s->face->gc;
}


/* Set S->gc of glyph string S for drawing that glyph string.  Set
   S->stippled_p to a non-zero value if the face of S has a stipple
   pattern.  */

947
static void
948
x_set_glyph_string_gc (struct glyph_string *s)
949
{
950
  prepare_face_for_display (s->f, s->face);
Juanma Barranquero's avatar
Juanma Barranquero committed
951

952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
  if (s->hl == DRAW_NORMAL_TEXT)
    {
      s->gc = s->face->gc;
      s->stippled_p = s->face->stipple != 0;
    }
  else if (s->hl == DRAW_INVERSE_VIDEO)
    {
      x_set_mode_line_face_gc (s);
      s->stippled_p = s->face->stipple != 0;
    }
  else if (s->hl == DRAW_CURSOR)
    {
      x_set_cursor_gc (s);
      s->stippled_p = 0;
    }
  else if (s->hl == DRAW_MOUSE_FACE)
    {
      x_set_mouse_face_gc (s);
      s->stippled_p = s->face->stipple != 0;
    }
  else if (s->hl == DRAW_IMAGE_RAISED
	   || s->hl == DRAW_IMAGE_SUNKEN)
    {
      s->gc = s->face->gc;
      s->stippled_p = s->face->stipple != 0;
    }
  else
979
    emacs_abort ();
980 981

  /* GC must have been set.  */
982
  eassert (s->gc != 0);
983 984 985 986 987 988
}


/* Set clipping for output of glyph string S.  S may be part of a mode
   line or menu if we don't have X toolkit support.  */

989
static void
990
x_set_glyph_string_clipping (struct glyph_string *s)
991
{
992 993 994 995 996 997
  XRectangle *r = s->clip;
  int n = get_glyph_string_clip_rects (s, r, 2);

  if (n > 0)
    XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
  s->num_clips = n;
998 999 1000
}


1001 1002 1003 1004 1005
/* Set SRC's clipping for output of glyph string DST.  This is called
   when we are drawing DST's left_overhang or right_overhang only in
   the area of SRC.  */

static void
1006
x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1007 1008
{
  XRectangle r;
Kenichi Handa's avatar
Kenichi Handa committed
1009

1010 1011 1012 1013 1014 1015
  r.x = src->x;
  r.width = src->width;
  r.y = src->y;
  r.height = src->height;
  dst->clip[0] = r;
  dst->num_clips = 1;
1016 1017 1018 1019
  XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
}


1020
/* RIF:
1021
   Compute left and right overhang of glyph string S.  */
1022

1023
static void
1024
x_compute_glyph_string_overhangs (struct glyph_string *s)
1025
{
1026
  if (s->cmp == NULL
1027 1028
      && (s->first_glyph->type == CHAR_GLYPH
	  || s->first_glyph->type == COMPOSITE_GLYPH))
1029
    {
1030
      struct font_metrics metrics;
Kenichi Handa's avatar
Kenichi Handa committed
1031

1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
      if (s->first_glyph->type == CHAR_GLYPH)
	{
	  unsigned *code = alloca (sizeof (unsigned) * s->nchars);
	  struct font *font = s->font;
	  int i;

	  for (i = 0; i < s->nchars; i++)
	    code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
	  font->driver->text_extents (font, code, s->nchars, &metrics);
	}
      else
	{
	  Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);

	  composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
	}
1048 1049 1050
      s->right_overhang = (metrics.rbearing > metrics.width
			   ? metrics.rbearing - metrics.width : 0);
      s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1051
    }
1052 1053 1054 1055 1056
  else if (s->cmp)
    {
      s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
      s->left_overhang = - s->cmp->lbearing;
    }
1057 1058