xterm.c 318 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
#ifdef USE_LUCID
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 152 153 154 155
/* This is a list of cons cells, each of the form (NAME
   . FONT-LIST-CACHE), one for each element of x_display_list and in
   the same order.  NAME is the name of the frame.  FONT-LIST-CACHE
   records previous values returned by x-list-fonts.  */

156
Lisp_Object x_display_name_list;
157

158 159
/* This is a frame waiting to be auto-raised, within XTread_socket.  */

160 161
static struct frame *pending_autoraise_frame;

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 180
/* Mouse movement.

181
   Formerly, we used PointerMotionHintMask (in standard_event_mask)
182 183 184 185 186 187
   so that we would have to call XQueryPointer after each MotionNotify
   event to ask for another such event.  However, this made mouse tracking
   slow, and there was a bug that made it eventually stop.

   Simply asking for MotionNotify all the time seems to work better.

188 189 190 191 192 193 194 195 196
   In order to avoid asking for motion events and then throwing most
   of them away or busy-polling the server for mouse positions, we ask
   the server for pointer motion hints.  This means that we get only
   one event per group of mouse movements.  "Groups" are delimited by
   other kinds of events (focus changes and button clicks, for
   example), or by XQueryPointer calls; when one of these happens, we
   get another MotionNotify event the next time the mouse moves.  This
   is at least as efficient as getting motion events when mouse
   tracking is on, and I suspect only negligibly worse when tracking
197
   is off.  */
198 199 200

/* Where the mouse was last time we reported a mouse event.  */

201
static XRectangle last_mouse_glyph;
Dmitry Antipov's avatar
Dmitry Antipov committed
202
static struct frame *last_mouse_glyph_frame;
203

204 205
/* The scroll bar in which the last X motion event occurred.

206 207
   If the last X motion event occurred in a scroll bar, we set this so
   XTmouse_position can know whether to report a scroll bar motion or
208 209
   an ordinary motion.

210 211 212 213
   If the last X motion event didn't occur in a scroll bar, we set
   this to Qnil, to tell XTmouse_position to return an ordinary motion
   event.  */

214 215
static Lisp_Object last_mouse_scroll_bar;

216 217 218 219 220 221 222 223 224
/* This is a hack.  We would really prefer that XTmouse_position would
   return the time associated with the position it returns, but there
   doesn't seem to be any way to wrest the time-stamp from the server
   along with the position query.  So, we just keep track of the time
   of the last movement we received, and return that in hopes that
   it's somewhat accurate.  */

static Time last_mouse_movement_time;

225 226 227
/* Incremented by XTread_socket whenever it really tries to read
   events.  */

228 229
static int volatile input_signal_count;

230
/* Used locally within XTread_socket.  */
231

232
static int x_noop_count;
Jim Blandy's avatar
Jim Blandy committed
233

234 235
static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;

236
static Lisp_Object Qvendor_specific_keysyms;
Dave Love's avatar
Dave Love committed
237
static Lisp_Object Qlatin_1;
238

239 240 241
#ifdef USE_GTK
/* The name of the Emacs icon file.  */
static Lisp_Object xg_default_icon_file;
242 243 244

/* Used in gtkutil.c.  */
Lisp_Object Qx_gtk_map_stock;
245 246
#endif

247 248 249
/* Some functions take this as char *, not const char *.  */
static char emacs_class[] = EMACS_CLASS;

Andreas Schwab's avatar
Andreas Schwab committed
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271
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
  };
272

273
static bool x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
274
static void x_set_window_size_1 (struct frame *, int, int, int);
275 276
static void x_raise_frame (struct frame *);
static void x_lower_frame (struct frame *);
277 278 279 280 281 282 283
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 *);
284
static _Noreturn void x_ins_del_lines (struct frame *, int, int);
285 286 287 288 289 290 291 292 293 294 295
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);

296 297
static void x_clip_to_row (struct window *, struct glyph_row *,
			   enum glyph_row_area, GC);
298 299 300 301 302 303 304
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 *,
305
                                        Time *);
306
static int x_handle_net_wm_state (struct frame *, const XPropertyEvent *);
307 308 309
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);
310
static int handle_one_xevent (struct x_display_info *,
311
			      const XEvent *, int *,
312
			      struct input_event *);
313
#ifdef USE_GTK
314 315
static int x_dispatch_event (XEvent *, Display *);
#endif
316
/* Don't declare this _Noreturn because we want no
317
   interference with debugging failing X calls.  */
318
static void x_connection_closed (Display *, const char *);
319
static void x_wm_set_window_state (struct frame *, int);
320
static void x_wm_set_icon_pixmap (struct frame *, ptrdiff_t);
321
static void x_initialize (void);
Jan Djärv's avatar
Jan Djärv committed
322

323

Dmitry Antipov's avatar
Dmitry Antipov committed
324
/* Flush display of frame F.  */
325 326

static void
327
x_flush (struct frame *f)
328
{
Dmitry Antipov's avatar
Dmitry Antipov committed
329
  eassert (f && FRAME_X_P (f));
330 331 332 333 334
  /* Don't call XFlush when it is not safe to redisplay; the X
     connection may be broken.  */
  if (!NILP (Vinhibit_redisplay))
    return;

335
  block_input ();
Dmitry Antipov's avatar
Dmitry Antipov committed
336
  XFlush (FRAME_X_DISPLAY (f));
337
  unblock_input ();
338 339
}

Jim Blandy's avatar
Jim Blandy committed
340

341 342 343 344 345 346 347
/* 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
348
#define XFlush(DISPLAY)	(void) 0
349

350

351 352 353 354
/***********************************************************************
			      Debugging
 ***********************************************************************/

355
#if 0
356 357 358

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

Juanma Barranquero's avatar
Juanma Barranquero committed
360
struct record
361 362 363 364 365 366 367 368 369
{
  char *locus;
  int type;
};

struct record event_record[100];

int event_record_index;

Andreas Schwab's avatar
Andreas Schwab committed
370 371
void
record_event (char *locus, int type)
372 373 374 375 376 377 378 379 380 381
{
  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 */
382 383


384

385 386 387
/* Return the struct x_display_info corresponding to DPY.  */

struct x_display_info *
388
x_display_info_for_display (Display *dpy)
389 390 391 392 393 394
{
  struct x_display_info *dpyinfo;

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

396 397
  return 0;
}
398

399 400 401 402 403 404 405
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);

406
  while (wi != FRAME_DISPLAY_INFO (f)->root_window)
407 408 409 410 411 412 413 414 415 416 417 418 419
    {
      Window root;
      Window *children;
      unsigned int nchildren;

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

  return win;
}

420 421 422
#define OPAQUE  0xffffffff

void
423
x_set_frame_alpha (struct frame *f)
424
{
425
  struct x_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
426 427
  Display *dpy = FRAME_X_DISPLAY (f);
  Window win = FRAME_OUTER_WINDOW (f);
428 429
  double alpha = 1.0;
  double alpha_min = 1.0;
430
  unsigned long opac;
431
  Window parent;
432

433 434 435 436 437 438 439 440 441 442
  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;

443 444 445
  if (alpha < 0.0)
    return;
  else if (alpha > 1.0)
446 447 448 449
    alpha = 1.0;
  else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
    alpha = alpha_min;

450
  opac = alpha * OPAQUE;
451

452 453 454 455 456 457 458 459 460 461 462 463 464
  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);

465 466 467 468
  /* return unless necessary */
  {
    unsigned char *data;
    Atom actual;
469
    int rc, format;
470 471
    unsigned long n, left;

472
    rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
473 474 475
			     0L, 1L, False, XA_CARDINAL,
			     &actual, &format, &n, &left,
			     &data);
476 477

    if (rc == Success && actual != None)
478
      {
479
        unsigned long value = *(unsigned long *)data;
480
	XFree (data);
481
	if (value == opac)
482 483 484 485 486
	  {
	    x_uncatch_errors ();
	    return;
	  }
      }
487 488
  }

489
  XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
490 491
		   XA_CARDINAL, 32, PropModeReplace,
		   (unsigned char *) &opac, 1L);
492
  x_uncatch_errors ();
493
}
494

495
int
496
x_display_pixel_height (struct x_display_info *dpyinfo)
497 498 499 500 501
{
  return HeightOfScreen (dpyinfo->screen);
}

int
502
x_display_pixel_width (struct x_display_info *dpyinfo)
503 504 505 506
{
  return WidthOfScreen (dpyinfo->screen);
}

507 508 509 510

/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
Juanma Barranquero's avatar
Juanma Barranquero committed
511

512 513 514 515 516
/* 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
517

Andreas Schwab's avatar
Andreas Schwab committed
518
static void
519
x_update_begin (struct frame *f)
520
{
521 522
  /* Nothing to do.  */
}
Jim Blandy's avatar
Jim Blandy committed
523 524


525
/* Start update of window W.  */
Jim Blandy's avatar
Jim Blandy committed
526

527
static void
528
x_update_window_begin (struct window *w)
529 530
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
531
  Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
Juanma Barranquero's avatar
Juanma Barranquero committed
532

533
  w->output_cursor = w->cursor;
534

535
  block_input ();
536

537
  if (f == hlinfo->mouse_face_mouse_frame)
538
    {
539
      /* Don't do highlighting for mouse motion during the update.  */
540
      hlinfo->mouse_face_defer = 1;
541

542 543
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
544
      if (FRAME_GARBAGED_P (f))
545
	hlinfo->mouse_face_window = Qnil;
546
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
547

548
  unblock_input ();
Jim Blandy's avatar
Jim Blandy committed
549 550
}

551

552
/* Draw a vertical window border from (x,y0) to (x,y1)  */
553

Andreas Schwab's avatar
Andreas Schwab committed
554
static void
555
x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
556
{
557
  struct frame *f = XFRAME (WINDOW_FRAME (w));
558 559 560 561 562 563
  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);
564

565 566
  XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
	     f->output_data.x->normal_gc, x, y0, x, y1);
567
}
Juanma Barranquero's avatar
Juanma Barranquero committed
568

569
/* End update of window W.
570 571 572 573 574 575 576 577 578 579 580

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

static void
583 584
x_update_window_end (struct window *w, bool cursor_on_p,
		     bool mouse_face_overwritten_p)
585 586 587
{
  if (!w->pseudo_window_p)
    {
588
      block_input ();
589

590
      if (cursor_on_p)
591 592 593
	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
594

595 596
      if (draw_window_fringes (w, 1))
	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
    reset_mouse_highlight (MOUSE_HL_INFO (XFRAME (w->frame)));
605
}
Jim Blandy's avatar
Jim Blandy committed
606 607


608 609 610 611
/* End update of frame F.  This function is installed as a hook in
   update_end.  */

static void
612
x_update_end (struct frame *f)
613 614
{
  /* Mouse highlight may be displayed again.  */
615
  MOUSE_HL_INFO (f)->mouse_face_defer = 0;
616

617
#ifndef XFlush
618
  block_input ();
619
  XFlush (FRAME_X_DISPLAY (f));
620
  unblock_input ();
621
#endif
Jim Blandy's avatar
Jim Blandy committed
622
}
623

624

625 626
/* This function is called from various places in xdisp.c
   whenever a complete update has been performed.  */
627

Andreas Schwab's avatar
Andreas Schwab committed
628
static void
629
XTframe_up_to_date (struct frame *f)
630
{
631
  if (FRAME_X_P (f))
632
    FRAME_MOUSE_UPDATE (f);
633
}
634 635 636


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
637
   arrow bitmaps, or clear the fringes if no bitmaps are required
638
   before DESIRED_ROW is made current.  This function is called from
639 640 641 642
   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
643
x_after_update_window_line (struct window *w, struct glyph_row *desired_row)
644
{
645
  struct frame *f;
646
  int width, height;
Juanma Barranquero's avatar
Juanma Barranquero committed
647

648
  eassert (w);
Juanma Barranquero's avatar
Juanma Barranquero committed
649

650
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
Kenichi Handa's avatar
Kenichi Handa committed
651
    desired_row->redraw_fringe_bitmaps_p = 1;
Juanma Barranquero's avatar
Juanma Barranquero committed
652

653 654
  /* When a window has disappeared, make sure that no rest of
     full-width rows stays visible in the internal border.  Could
655
     check here if updated window is the leftmost/rightmost window,
656 657 658 659 660
     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
661
      && (f = XFRAME (w->frame),
662
	  width = FRAME_INTERNAL_BORDER_WIDTH (f),
663 664 665
	  width != 0)
      && (height = desired_row->visible_height,
	  height > 0))
666 667
    {
      int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
668

669
      block_input ();
670
      x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
671
		    0, y, width, height);
672
      x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
673
		    FRAME_PIXEL_WIDTH (f) - width,
674
		    y, width, height);
675
      unblock_input ();
676 677 678 679
    }
}

static void
680
x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
681 682 683 684 685
{
  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
686
  struct face *face = p->face;
687 688

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

691
  if (!p->overlay_p)
692
    {
693 694
      int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;

695 696 697 698 699 700 701 702
      /* 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
703

704 705 706 707 708 709 710 711 712 713 714 715 716
#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)
	    {
717 718 719
	      int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
	      int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
				    * FRAME_COLUMN_WIDTH (f));
720 721 722 723

	      if (bx < 0)
		{
		  /* Bitmap fills the fringe.  */
724 725 726 727
		  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;
728 729 730 731
		  if (bx >= 0)
		    {
		      int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);

732
		      nx = bar_area_width - sb_width;
733 734 735 736 737 738 739
		      by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
							    row->y));
		      ny = row->visible_height;
		    }
		}
	      else
		{
740
		  if (bar_area_x + bar_area_width == bx)
741
		    {
742 743
		      bx = bar_area_x + sb_width;
		      nx += bar_area_width - sb_width;
744
		    }
745 746
		  else if (bx + nx == bar_area_x)
		    nx += bar_area_width - sb_width;
747 748 749 750 751 752
		}
	    }
	}
#endif
      if (bx >= 0 && nx > 0)
	XFillRectangle (display, window, face->gc, bx, by, nx, ny);
Kim F. Storm's avatar
Kim F. Storm committed
753

754 755 756 757
      if (!face->stipple)
	XSetForeground (display, face->gc, face->foreground);
    }

Kenichi Handa's avatar
Kenichi Handa committed
758
  if (p->which)
759
    {
760
      char *bits;
Kenichi Handa's avatar
Kenichi Handa committed
761
      Pixmap pixmap, clipmask = (Pixmap) 0;
Kim F. Storm's avatar
Kim F. Storm committed
762
      int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
Kenichi Handa's avatar
Kenichi Handa committed
763 764 765
      XGCValues gcv;

      if (p->wd > 8)
766
	bits = (char *) (p->bits + p->dh);
Kenichi Handa's avatar
Kenichi Handa committed
767
      else
768
	bits = (char *) p->bits + p->dh;
Kim F. Storm's avatar
Kim F. Storm committed
769

770 771
      /* Draw the bitmap.  I believe these small pixmaps can be cached
	 by the server.  */
Kim F. Storm's avatar
Kim F. Storm committed
772
      pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
Kenichi Handa's avatar
Kenichi Handa committed
773 774 775 776
					    (p->cursor_p
					     ? (p->overlay_p ? face->background
						: f->output_data.x->cursor_pixel)
					     : face->foreground),
777
					    face->background, depth);
Kenichi Handa's avatar
Kenichi Handa committed
778 779 780 781

      if (p->overlay_p)
	{
	  clipmask = XCreatePixmapFromBitmapData (display,
782
						  FRAME_DISPLAY_INFO (f)->root_window,
Kenichi Handa's avatar
Kenichi Handa committed
783 784 785 786 787 788 789 790
						  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
791 792
      XCopyArea (display, pixmap, window, gc, 0, 0,
		 p->wd, p->h, p->x, p->y);
793
      XFreePixmap (display, pixmap);
Kenichi Handa's avatar
Kenichi Handa committed
794 795 796 797 798 799 800

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

803 804 805 806 807 808 809 810 811
  XSetClipMask (display, gc, None);
}

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



812 813 814 815 816 817
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 *);
818
static _Noreturn void x_delete_glyphs (struct frame *, int);
819 820 821 822
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 *);
823 824
static bool x_alloc_lighter_color (struct frame *, Display *, Colormap,
				   unsigned long *, double, int);
825 826 827 828 829 830 831 832 833 834 835 836 837 838
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
839
static void x_scroll_bar_clear (struct frame *);
840

841
#ifdef GLYPH_DEBUG
842
static void x_check_font (struct frame *, struct font *);
843
#endif
844 845 846 847 848 849


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

static void
850
x_set_cursor_gc (struct glyph_string *s)
851 852 853 854
{
  if (s->font == FRAME_FONT (s->f)
      && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
      && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
855
      && !s->cmp)
856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883
    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;
884
      mask = GCForeground | GCBackground | GCGraphicsExposures;
885

886 887
      if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
	XChangeGC (s->display, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
888 889
		   mask, &xgcv);
      else
890
	FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
891 892
	  = XCreateGC (s->display, s->window, mask, &xgcv);

893
      s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
894 895 896 897 898
    }
}


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

900
static void
901
x_set_mouse_face_gc (struct glyph_string *s)
Juanma Barranquero's avatar
Juanma Barranquero committed
902
{
903
  int face_id;
904
  struct face *face;
905

906
  /* What face has to be used last for the mouse face?  */
907
  face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
908
  face = FACE_FROM_ID (s->f, face_id);
909 910
  if (face == NULL)
    face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
Juanma Barranquero's avatar
Juanma Barranquero committed
911

912
  if (s->first_glyph->type == CHAR_GLYPH)
913
    face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
914
  else
915
    face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
916 917 918 919 920 921 922 923
  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
924
	 except for FONT.  */
925 926
      XGCValues xgcv;
      unsigned long mask;
Juanma Barranquero's avatar
Juanma Barranquero committed
927

928 929 930
      xgcv.background = s->face->background;
      xgcv.foreground = s->face->foreground;
      xgcv.graphics_exposures = False;
931
      mask = GCForeground | GCBackground | GCGraphicsExposures;
Juanma Barranquero's avatar
Juanma Barranquero committed
932

933 934
      if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
	XChangeGC (s->display, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
935 936
		   mask, &xgcv);
      else
937
	FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
938
	  = XCreateGC (s->display, s->window, mask, &xgcv);
Juanma Barranquero's avatar
Juanma Barranquero committed
939

940
      s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
941

942
    }
943
  eassert (s->gc != 0);
944 945 946 947 948 949 950
}


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

951
static void
952
x_set_mode_line_face_gc (struct glyph_string *s)
Juanma Barranquero's avatar
Juanma Barranquero committed
953
{
954 955 956 957 958 959 960 961
  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.  */

962
static void
963
x_set_glyph_string_gc (struct glyph_string *s)
964
{
965
  PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
Juanma Barranquero's avatar
Juanma Barranquero committed
966

967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999
  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.  */
1000
  eassert (s->gc != 0);
1001 1002 1003 1004 1005 1006
}


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

1007
static void
1008
x_set_glyph_string_clipping (struct glyph_string *s)
1009
{
1010 1011 1012 1013 1014 1015
  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;
1016 1017 1018
}


1019 1020 1021 1022 1023
/* 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
1024
x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1025 1026
{
  XRectangle r;
Kenichi Handa's avatar
Kenichi Handa committed
1027

1028 1029 1030 1031 1032 1033
  r.x = src->x;
  r.width = src->width;
  r.y = src->y;
  r.height = src->height;
  dst->clip[0] = r;
  dst->num_clips = 1;
1034 1035