xterm.c 313 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-2013 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

/* Load sys/types.h if not already loaded.
   In some systems loading it twice is suicidal.  */
#ifndef makedev
#include <sys/types.h>
39
#endif /* makedev */
Jim Blandy's avatar
Jim Blandy committed
40 41 42

#include <sys/ioctl.h>

Jim Blandy's avatar
Jim Blandy committed
43
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
44 45 46 47

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

51
#include "charset.h"
Kenichi Handa's avatar
Kenichi Handa committed
52
#include "character.h"
Kenichi Handa's avatar
Kenichi Handa committed
53
#include "coding.h"
54
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
55
#include "dispextern.h"
56
#include "fontset.h"
Jim Blandy's avatar
Jim Blandy committed
57 58 59
#include "termhooks.h"
#include "termopts.h"
#include "termchar.h"
60
#include "emacs-icon.h"
Jim Blandy's avatar
Jim Blandy committed
61 62
#include "disptab.h"
#include "buffer.h"
63
#include "window.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
64
#include "keyboard.h"
Karl Heuer's avatar
Karl Heuer committed
65
#include "intervals.h"
Andreas Schwab's avatar
Andreas Schwab committed
66
#include "process.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
67
#include "atimer.h"
Stefan Monnier's avatar
Stefan Monnier committed
68
#include "keymap.h"
69
#include "font.h"
70
#include "xsettings.h"
71
#include "xgselect.h"
72
#include "sysselect.h"
Jim Blandy's avatar
Jim Blandy committed
73

74 75 76 77
#ifdef USE_X_TOOLKIT
#include <X11/Shell.h>
#endif

78 79
#include <unistd.h>

Jan Djärv's avatar
Jan Djärv committed
80 81
#ifdef USE_GTK
#include "gtkutil.h"
Jan Djärv's avatar
Jan Djärv committed
82 83 84
#ifdef HAVE_GTK3
#include <X11/Xproto.h>
#endif
Jan Djärv's avatar
Jan Djärv committed
85 86
#endif

87
#if defined (USE_LUCID) || defined (USE_MOTIF)
88
#include "../lwlib/xlwmenu.h"
89 90
#endif

Jan Djärv's avatar
Jan Djärv committed
91
#ifdef USE_X_TOOLKIT
Juanma Barranquero's avatar
Juanma Barranquero committed
92
#if !defined (NO_EDITRES)
93
#define HACK_EDITRES
94
extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
95
#endif /* not NO_EDITRES */
96 97 98 99 100 101 102

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

#ifdef USE_TOOLKIT_SCROLL_BARS
#if defined USE_MOTIF
#include <Xm/Xm.h>		/* for LESSTIF_VERSION */
#include <Xm/ScrollBar.h>
103 104 105
#else /* !USE_MOTIF i.e. use Xaw */

#ifdef HAVE_XAW3D
106 107
#include <X11/Xaw3d/Simple.h>
#include <X11/Xaw3d/Scrollbar.h>
108
#include <X11/Xaw3d/ThreeD.h>
109 110 111 112 113 114 115 116
#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 */
117 118
#endif /* USE_TOOLKIT_SCROLL_BARS */

119 120
#endif /* USE_X_TOOLKIT */

121
#ifdef USE_X_TOOLKIT
Karl Heuer's avatar
Karl Heuer committed
122
#include "widget.h"
123 124 125 126 127
#ifndef XtNinitialState
#define XtNinitialState "initialState"
#endif
#endif

128 129
#include "bitmaps/gray.xbm"

130 131 132 133
#ifdef HAVE_XKB
#include <X11/XKBlib.h>
#endif

Dave Love's avatar
Dave Love committed
134
/* Default to using XIM if available.  */
135
#ifdef USE_XIM
Dave Love's avatar
Dave Love committed
136
int use_xim = 1;
137 138 139 140
#else
int use_xim = 0;  /* configure --without-xim */
#endif

141 142 143
/* Non-zero means that a HELP_EVENT has been generated since Emacs
   start.  */

144
static bool any_help_event_p;
145 146 147 148

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

149
struct x_display_info *x_display_list;
Jim Blandy's avatar
Jim Blandy committed
150

151
#ifdef USE_X_TOOLKIT
152

153 154
/* The application context for Xt use.  */
XtAppContext Xt_app_con;
155
static String Xt_default_resources[] = {0};
156

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

160
#endif /* USE_X_TOOLKIT */
Jim Blandy's avatar
Jim Blandy committed
161

Kenichi Handa's avatar
Kenichi Handa committed
162 163 164 165
/* 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).  */

166
static Time ignore_next_mouse_click_timeout;
Kenichi Handa's avatar
Kenichi Handa committed
167

168 169 170
/* Incremented by XTread_socket whenever it really tries to read
   events.  */

171 172
static int volatile input_signal_count;

173
/* Used locally within XTread_socket.  */
174

175
static int x_noop_count;
Jim Blandy's avatar
Jim Blandy committed
176

177 178
static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;

179
static Lisp_Object Qvendor_specific_keysyms;
Dave Love's avatar
Dave Love committed
180
static Lisp_Object Qlatin_1;
181

182 183 184
#ifdef USE_GTK
/* The name of the Emacs icon file.  */
static Lisp_Object xg_default_icon_file;
185 186 187

/* Used in gtkutil.c.  */
Lisp_Object Qx_gtk_map_stock;
188 189
#endif

190 191 192
/* Some functions take this as char *, not const char *.  */
static char emacs_class[] = EMACS_CLASS;

Andreas Schwab's avatar
Andreas Schwab committed
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
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
  };
215

216
static bool x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
217
static void x_set_window_size_1 (struct frame *, int, int, int);
218 219
static void x_raise_frame (struct frame *);
static void x_lower_frame (struct frame *);
220 221 222 223 224 225 226
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 *);
void x_delete_terminal (struct terminal *);
static void x_update_end (struct frame *);
static void XTframe_up_to_date (struct frame *);
static void x_clear_frame (struct frame *);
227
static _Noreturn void x_ins_del_lines (struct frame *, int, int);
228 229 230 231 232 233 234 235 236 237 238
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);

239 240
static void x_clip_to_row (struct window *, struct glyph_row *,
			   enum glyph_row_area, GC);
241 242 243 244 245 246 247
static void x_flush (struct frame *f);
static void x_update_begin (struct frame *);
static void x_update_window_begin (struct window *);
static struct scroll_bar *x_window_to_scroll_bar (Display *, Window);
static void x_scroll_bar_report_motion (struct frame **, Lisp_Object *,
                                        enum scroll_bar_part *,
                                        Lisp_Object *, Lisp_Object *,
248
                                        Time *);
249
static int x_handle_net_wm_state (struct frame *, const XPropertyEvent *);
250 251 252
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);
253
static int handle_one_xevent (struct x_display_info *,
254
			      const XEvent *, int *,
255
			      struct input_event *);
256
#ifdef USE_GTK
257 258
static int x_dispatch_event (XEvent *, Display *);
#endif
259
/* Don't declare this _Noreturn because we want no
260
   interference with debugging failing X calls.  */
261
static void x_connection_closed (Display *, const char *);
262
static void x_wm_set_window_state (struct frame *, int);
263
static void x_wm_set_icon_pixmap (struct frame *, ptrdiff_t);
264
static void x_initialize (void);
Jan Djärv's avatar
Jan Djärv committed
265

266

Dmitry Antipov's avatar
Dmitry Antipov committed
267
/* Flush display of frame F.  */
268 269

static void
270
x_flush (struct frame *f)
271
{
Dmitry Antipov's avatar
Dmitry Antipov committed
272
  eassert (f && FRAME_X_P (f));
273 274 275 276 277
  /* Don't call XFlush when it is not safe to redisplay; the X
     connection may be broken.  */
  if (!NILP (Vinhibit_redisplay))
    return;

278
  block_input ();
Dmitry Antipov's avatar
Dmitry Antipov committed
279
  XFlush (FRAME_X_DISPLAY (f));
280
  unblock_input ();
281 282
}

Jim Blandy's avatar
Jim Blandy committed
283

284 285 286 287 288 289 290
/* 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
291
#define XFlush(DISPLAY)	(void) 0
292

293

294 295 296 297
/***********************************************************************
			      Debugging
 ***********************************************************************/

298
#if 0
299 300 301

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

Juanma Barranquero's avatar
Juanma Barranquero committed
303
struct record
304 305 306 307 308 309 310 311 312
{
  char *locus;
  int type;
};

struct record event_record[100];

int event_record_index;

Andreas Schwab's avatar
Andreas Schwab committed
313 314
void
record_event (char *locus, int type)
315 316 317 318 319 320 321 322 323 324
{
  if (event_record_index == sizeof (event_record) / sizeof (struct record))
    event_record_index = 0;

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

#endif /* 0 */
325 326


327

328 329 330
/* Return the struct x_display_info corresponding to DPY.  */

struct x_display_info *
331
x_display_info_for_display (Display *dpy)
332 333 334 335 336 337
{
  struct x_display_info *dpyinfo;

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

339 340
  return 0;
}
341

342 343 344 345 346 347 348
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);

349
  while (wi != FRAME_DISPLAY_INFO (f)->root_window)
350 351 352 353 354 355 356 357 358 359 360 361 362
    {
      Window root;
      Window *children;
      unsigned int nchildren;

      win = wi;
      XQueryTree (dpy, win, &root, &wi, &children, &nchildren);
      XFree (children);
    }

  return win;
}

363 364 365
#define OPAQUE  0xffffffff

void
366
x_set_frame_alpha (struct frame *f)
367
{
368
  struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
369 370
  Display *dpy = FRAME_X_DISPLAY (f);
  Window win = FRAME_OUTER_WINDOW (f);
371 372
  double alpha = 1.0;
  double alpha_min = 1.0;
373
  unsigned long opac;
374
  Window parent;
375

376 377 378 379 380 381 382 383 384 385
  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;

386 387 388
  if (alpha < 0.0)
    return;
  else if (alpha > 1.0)
389 390 391 392
    alpha = 1.0;
  else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
    alpha = alpha_min;

393
  opac = alpha * OPAQUE;
394

395 396 397 398 399 400 401 402 403 404 405 406 407
  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,
                     (unsigned char *) &opac, 1L);

408 409 410 411
  /* return unless necessary */
  {
    unsigned char *data;
    Atom actual;
412
    int rc, format;
413 414
    unsigned long n, left;

415
    rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
416 417 418
			     0L, 1L, False, XA_CARDINAL,
			     &actual, &format, &n, &left,
			     &data);
419 420

    if (rc == Success && actual != None)
421
      {
422
        unsigned long value = *(unsigned long *)data;
423
	XFree (data);
424
	if (value == opac)
425 426 427 428 429
	  {
	    x_uncatch_errors ();
	    return;
	  }
      }
430 431
  }

432
  XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
433 434
		   XA_CARDINAL, 32, PropModeReplace,
		   (unsigned char *) &opac, 1L);
435
  x_uncatch_errors ();
436
}
437

438
int
439
x_display_pixel_height (struct x_display_info *dpyinfo)
440 441 442 443 444
{
  return HeightOfScreen (dpyinfo->screen);
}

int
445
x_display_pixel_width (struct x_display_info *dpyinfo)
446 447 448 449
{
  return WidthOfScreen (dpyinfo->screen);
}

450 451 452 453

/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
Juanma Barranquero's avatar
Juanma Barranquero committed
454

455 456 457 458 459
/* 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
460

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


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

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

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

478
  block_input ();
479

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

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

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

494

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

Andreas Schwab's avatar
Andreas Schwab committed
497
static void
498
x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
499
{
500
  struct frame *f = XFRAME (WINDOW_FRAME (w));
501 502 503 504 505 506
  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);
507

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

512
/* End update of window W.
513 514 515 516 517 518 519 520 521 522 523

   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.  */
524 525

static void
526 527
x_update_window_end (struct window *w, bool cursor_on_p,
		     bool mouse_face_overwritten_p)
528 529 530
{
  if (!w->pseudo_window_p)
    {
531
      block_input ();
532

533
      if (cursor_on_p)
534 535 536
	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
537

538 539
      if (draw_window_fringes (w, 1))
	x_draw_vertical_border (w);
Kenichi Handa's avatar
Kenichi Handa committed
540

541
      unblock_input ();
542
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
543

544 545 546
  /* If a row with mouse-face was overwritten, arrange for
     XTframe_up_to_date to redisplay the mouse highlight.  */
  if (mouse_face_overwritten_p)
547
    reset_mouse_highlight (MOUSE_HL_INFO (XFRAME (w->frame)));
548
}
Jim Blandy's avatar
Jim Blandy committed
549 550


551 552 553 554
/* End update of frame F.  This function is installed as a hook in
   update_end.  */

static void
555
x_update_end (struct frame *f)
556 557
{
  /* Mouse highlight may be displayed again.  */
558
  MOUSE_HL_INFO (f)->mouse_face_defer = 0;
559

560
#ifndef XFlush
561
  block_input ();
562
  XFlush (FRAME_X_DISPLAY (f));
563
  unblock_input ();
564
#endif
Jim Blandy's avatar
Jim Blandy committed
565
}
566

567

568 569
/* This function is called from various places in xdisp.c
   whenever a complete update has been performed.  */
570

Andreas Schwab's avatar
Andreas Schwab committed
571
static void
572
XTframe_up_to_date (struct frame *f)
573
{
574
  if (FRAME_X_P (f))
575
    FRAME_MOUSE_UPDATE (f);
576
}
577 578 579


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
580
   arrow bitmaps, or clear the fringes if no bitmaps are required
581
   before DESIRED_ROW is made current.  This function is called from
582 583 584 585
   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
586
x_after_update_window_line (struct window *w, struct glyph_row *desired_row)
587
{
588
  struct frame *f;
589
  int width, height;
Juanma Barranquero's avatar
Juanma Barranquero committed
590

591
  eassert (w);
Juanma Barranquero's avatar
Juanma Barranquero committed
592

593
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
Kenichi Handa's avatar
Kenichi Handa committed
594
    desired_row->redraw_fringe_bitmaps_p = 1;
Juanma Barranquero's avatar
Juanma Barranquero committed
595

596 597
  /* When a window has disappeared, make sure that no rest of
     full-width rows stays visible in the internal border.  Could
598
     check here if updated window is the leftmost/rightmost window,
599 600 601 602 603
     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.  */
  if (windows_or_buffers_changed
      && desired_row->full_width_p
604
      && (f = XFRAME (w->frame),
605
	  width = FRAME_INTERNAL_BORDER_WIDTH (f),
606 607 608
	  width != 0)
      && (height = desired_row->visible_height,
	  height > 0))
609 610
    {
      int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
611

612
      block_input ();
613
      x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
614
		    0, y, width, height);
615
      x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
616
		    FRAME_PIXEL_WIDTH (f) - width,
617
		    y, width, height);
618
      unblock_input ();
619 620 621 622
    }
}

static void
623
x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
624 625 626 627 628
{
  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
629
  struct face *face = p->face;
630 631

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

634
  if (!p->overlay_p)
635
    {
636 637
      int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;

638 639 640 641 642 643 644 645
      /* 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
646

647 648 649 650 651 652 653 654 655 656 657 658 659
#ifdef USE_TOOLKIT_SCROLL_BARS
      /* If the fringe is adjacent to the left (right) scroll bar of a
	 leftmost (rightmost, respectively) window, then extend its
	 background to the gap between the fringe and the bar.  */
      if ((WINDOW_LEFTMOST_P (w)
	   && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
	  || (WINDOW_RIGHTMOST_P (w)
	      && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
	{
	  int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);

	  if (sb_width > 0)
	    {
660 661 662
	      int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
	      int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
				    * FRAME_COLUMN_WIDTH (f));
663 664 665 666

	      if (bx < 0)
		{
		  /* Bitmap fills the fringe.  */
667 668 669 670
		  if (bar_area_x + bar_area_width == p->x)
		    bx = bar_area_x + sb_width;
		  else if (p->x + p->wd == bar_area_x)
		    bx = bar_area_x;
671 672 673 674
		  if (bx >= 0)
		    {
		      int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);

675
		      nx = bar_area_width - sb_width;
676 677 678 679 680 681 682
		      by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
							    row->y));
		      ny = row->visible_height;
		    }
		}
	      else
		{
683
		  if (bar_area_x + bar_area_width == bx)
684
		    {
685 686
		      bx = bar_area_x + sb_width;
		      nx += bar_area_width - sb_width;
687
		    }
688 689
		  else if (bx + nx == bar_area_x)
		    nx += bar_area_width - sb_width;
690 691 692 693 694 695
		}
	    }
	}
#endif
      if (bx >= 0 && nx > 0)
	XFillRectangle (display, window, face->gc, bx, by, nx, ny);
Kim F. Storm's avatar
Kim F. Storm committed
696

697 698 699 700
      if (!face->stipple)
	XSetForeground (display, face->gc, face->foreground);
    }

Kenichi Handa's avatar
Kenichi Handa committed
701
  if (p->which)
702
    {
703
      char *bits;
Kenichi Handa's avatar
Kenichi Handa committed
704
      Pixmap pixmap, clipmask = (Pixmap) 0;
Kim F. Storm's avatar
Kim F. Storm committed
705
      int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
Kenichi Handa's avatar
Kenichi Handa committed
706 707 708
      XGCValues gcv;

      if (p->wd > 8)
709
	bits = (char *) (p->bits + p->dh);
Kenichi Handa's avatar
Kenichi Handa committed
710
      else
711
	bits = (char *) p->bits + p->dh;
Kim F. Storm's avatar
Kim F. Storm committed
712

713 714
      /* Draw the bitmap.  I believe these small pixmaps can be cached
	 by the server.  */
Kim F. Storm's avatar
Kim F. Storm committed
715
      pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
Kenichi Handa's avatar
Kenichi Handa committed
716 717 718 719
					    (p->cursor_p
					     ? (p->overlay_p ? face->background
						: f->output_data.x->cursor_pixel)
					     : face->foreground),
720
					    face->background, depth);
Kenichi Handa's avatar
Kenichi Handa committed
721 722 723 724

      if (p->overlay_p)
	{
	  clipmask = XCreatePixmapFromBitmapData (display,
725
						  FRAME_DISPLAY_INFO (f)->root_window,
Kenichi Handa's avatar
Kenichi Handa committed
726 727 728 729 730 731 732 733
						  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
734 735
      XCopyArea (display, pixmap, window, gc, 0, 0,
		 p->wd, p->h, p->x, p->y);
736
      XFreePixmap (display, pixmap);
Kenichi Handa's avatar
Kenichi Handa committed
737 738 739 740 741 742 743

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

746 747 748 749 750 751 752 753 754
  XSetClipMask (display, gc, None);
}

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



755 756 757 758 759 760
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 *);
761
static _Noreturn void x_delete_glyphs (struct frame *, int);
762 763 764 765
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 *);
766 767
static bool x_alloc_lighter_color (struct frame *, Display *, Colormap,
				   unsigned long *, double, int);
768 769 770 771 772 773 774 775 776 777 778 779 780 781
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
782
static void x_scroll_bar_clear (struct frame *);
783

784
#ifdef GLYPH_DEBUG
785
static void x_check_font (struct frame *, struct font *);
786
#endif
787 788 789 790 791 792


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

static void
793
x_set_cursor_gc (struct glyph_string *s)
794 795 796 797
{
  if (s->font == FRAME_FONT (s->f)
      && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
      && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
798
      && !s->cmp)
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826
    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;
827
      mask = GCForeground | GCBackground | GCGraphicsExposures;
828

829 830
      if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
	XChangeGC (s->display, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
831 832
		   mask, &xgcv);
      else
833
	FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
834 835
	  = XCreateGC (s->display, s->window, mask, &xgcv);

836
      s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
837 838 839 840 841
    }
}


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

843
static void
844
x_set_mouse_face_gc (struct glyph_string *s)
Juanma Barranquero's avatar
Juanma Barranquero committed
845
{
846
  int face_id;
847
  struct face *face;
848

849
  /* What face has to be used last for the mouse face?  */
850
  face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
851
  face = FACE_FROM_ID (s->f, face_id);
852 853
  if (face == NULL)
    face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
Juanma Barranquero's avatar
Juanma Barranquero committed
854

855
  if (s->first_glyph->type == CHAR_GLYPH)
856
    face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
857
  else
858
    face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
859 860 861 862 863 864 865 866
  s->face = FACE_FROM_ID (s->f, face_id);
  PREPARE_FACE_FOR_DISPLAY (s->f, s->face);

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

871 872 873
      xgcv.background = s->face->background;
      xgcv.foreground = s->face->foreground;
      xgcv.graphics_exposures = False;
874
      mask = GCForeground | GCBackground | GCGraphicsExposures;
Juanma Barranquero's avatar
Juanma Barranquero committed
875

876 877
      if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
	XChangeGC (s->display, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
878 879
		   mask, &xgcv);
      else
880
	FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
881
	  = XCreateGC (s->display, s->window, mask, &xgcv);
Juanma Barranquero's avatar
Juanma Barranquero committed
882

883
      s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
884

885
    }
886
  eassert (s->gc != 0);
887 888 889 890 891 892 893
}


/* 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.  */

894
static void
895
x_set_mode_line_face_gc (struct glyph_string *s)
Juanma Barranquero's avatar
Juanma Barranquero committed
896
{
897 898 899 900 901 902 903 904
  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.  */

905
static void
906
x_set_glyph_string_gc (struct glyph_string *s)
907
{
908
  PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
Juanma Barranquero's avatar
Juanma Barranquero committed
909

910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
  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
    {
      s->gc = s->face->gc;
      s->stippled_p = s->face->stipple != 0;
    }

  /* GC must have been set.  */
943
  eassert (s->gc != 0);
944 945 946 947 948 949
}


/* 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.  */

950
static void
951
x_set_glyph_string_clipping (struct glyph_string *s)
952
{
953 954 955 956 957 958
  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;
959 960 961
}


962 963 964 965 966
/* 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
967
x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
968 969
{
  XRectangle r;
Kenichi Handa's avatar
Kenichi Handa committed
970

971 972 973 974 975 976
  r.x = src->x;
  r.width = src->width;
  r.y = src->y;
  r.height = src->height;
  dst->clip[0] = r;
  dst->num_clips = 1;
977 978 979 980
  XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
}


981
/* RIF:
982
   Compute left and right overhang of glyph string S.  */
983

984
static void
985
x_compute_glyph_string_overhangs (struct glyph_string *s)
986
{
987
  if (s->cmp == NULL
988 989
      && (s->first_glyph->type == CHAR_GLYPH
	  || s->first_glyph->type == COMPOSITE_GLYPH))
990
    {
991
      struct font_metrics metrics;
Kenichi Handa's avatar
Kenichi Handa committed
992

993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008
      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);
	}
1009 1010 1011
      s->right_overhang = (metrics.rbearing > metrics.width
			   ? metrics.rbearing - metrics.width : 0);
      s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1012
    }
1013 1014 1015 1016 1017
  else if (s->cmp)
    {
      s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
      s->left_overhang = - s->cmp->lbearing;
    }
1018 1019 1020 1021 1022
}


/* Fill rectangle X, Y, W, H with background color of glyph string S.  */

1023
static void
1024
x_clear_glyph_string_rect (struct glyph_string *s, int x, int y, int w, int h)
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
{
  XGCValues xgcv;
  XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
  XSetForeground (s->display, s->gc, xgcv.background);
  XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
  XSetForeground (s->display, s->gc, xgcv.foreground);
}


/* Draw the background of glyph_string S.  If S->background_filled_p
   is non-zero don't draw it.  FORCE_P non-zero means draw the
   background even if it wouldn't be drawn normally.  This is used