xterm.c 317 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 27 28
#ifdef HAVE_X_WINDOWS

#include "lisp.h"
29
#include "blockinput.h"
30 31
#include "syssignal.h"

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

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

#include <sys/ioctl.h>

Jim Blandy's avatar
Jim Blandy committed
45
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
46 47 48 49

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

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

76 77 78 79
#ifdef USE_X_TOOLKIT
#include <X11/Shell.h>
#endif

80 81
#include <unistd.h>

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

89
#ifdef USE_LUCID
90
#include "../lwlib/xlwmenu.h"
91 92
#endif

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

/* 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>
105 106 107
#else /* !USE_MOTIF i.e. use Xaw */

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

121 122
#endif /* USE_X_TOOLKIT */

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

130 131
#include "bitmaps/gray.xbm"

132 133 134 135
#ifdef HAVE_XKB
#include <X11/XKBlib.h>
#endif

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

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

146
static bool any_help_event_p;
147 148 149 150

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

151
struct x_display_info *x_display_list;
Jim Blandy's avatar
Jim Blandy committed
152

153 154 155 156 157
/* 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.  */

158
Lisp_Object x_display_name_list;
159

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

162 163 164 165 166 167 168 169
static struct frame *pending_autoraise_frame;

/* This is a frame waiting for an event matching mask, within XTread_socket.  */

static struct {
  struct frame *f;
  int eventtype;
} pending_event_wait;
170

171 172 173
#ifdef USE_X_TOOLKIT
/* The application context for Xt use.  */
XtAppContext Xt_app_con;
174
static String Xt_default_resources[] = {0};
175

Gerd Moellmann's avatar
Gerd Moellmann committed
176 177 178
/* Non-zero means user is interacting with a toolkit scroll bar.  */

static int toolkit_scroll_bar_interaction;
179
#endif /* USE_X_TOOLKIT */
Jim Blandy's avatar
Jim Blandy committed
180

Kenichi Handa's avatar
Kenichi Handa committed
181 182 183 184 185 186
/* 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).  */

static unsigned long ignore_next_mouse_click_timeout;

187 188
/* Mouse movement.

189
   Formerly, we used PointerMotionHintMask (in standard_event_mask)
190 191 192 193 194 195
   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.

196 197 198 199 200 201 202 203 204
   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
205
   is off.  */
206 207 208

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

209
static XRectangle last_mouse_glyph;
Dmitry Antipov's avatar
Dmitry Antipov committed
210
static struct frame *last_mouse_glyph_frame;
211

212 213
/* The scroll bar in which the last X motion event occurred.

214 215
   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
216 217
   an ordinary motion.

218 219 220 221
   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.  */

222 223
static Lisp_Object last_mouse_scroll_bar;

224 225 226 227 228 229 230 231 232
/* 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;

Jan Djärv's avatar
Jan Djärv committed
233 234 235 236
/* Time for last user interaction as returned in X events.  */

static Time last_user_time;

237 238 239
/* Incremented by XTread_socket whenever it really tries to read
   events.  */

240 241
static int volatile input_signal_count;

242
/* Used locally within XTread_socket.  */
243

244
static int x_noop_count;
Jim Blandy's avatar
Jim Blandy committed
245

246 247
static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;

248
static Lisp_Object Qvendor_specific_keysyms;
Dave Love's avatar
Dave Love committed
249
static Lisp_Object Qlatin_1;
250

251 252 253
#ifdef USE_GTK
/* The name of the Emacs icon file.  */
static Lisp_Object xg_default_icon_file;
254 255 256

/* Used in gtkutil.c.  */
Lisp_Object Qx_gtk_map_stock;
257 258
#endif

259 260 261
/* Some functions take this as char *, not const char *.  */
static char emacs_class[] = EMACS_CLASS;

Andreas Schwab's avatar
Andreas Schwab committed
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
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
  };
284

285
static bool x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
286
static void x_set_window_size_1 (struct frame *, int, int, int);
287 288
static void x_raise_frame (struct frame *);
static void x_lower_frame (struct frame *);
289 290 291 292 293 294 295
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 *);
296
static _Noreturn void x_ins_del_lines (struct frame *, int, int);
297 298 299 300 301 302 303 304 305 306 307 308 309
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 x_detect_focus_change (struct x_display_info *,
                                   XEvent *, 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);

310 311
static void x_clip_to_row (struct window *, struct glyph_row *,
			   enum glyph_row_area, GC);
312 313 314 315 316 317 318
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 *,
319
                                        Time *);
320
static int x_handle_net_wm_state (struct frame *, XPropertyEvent *);
321 322 323 324 325
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);
static int handle_one_xevent (struct x_display_info *, XEvent *,
                              int *, struct input_event *);
326
#ifdef USE_GTK
327 328
static int x_dispatch_event (XEvent *, Display *);
#endif
329
/* Don't declare this _Noreturn because we want no
330
   interference with debugging failing X calls.  */
331
static void x_connection_closed (Display *, const char *);
332
static void x_wm_set_window_state (struct frame *, int);
333
static void x_wm_set_icon_pixmap (struct frame *, ptrdiff_t);
334
static void x_initialize (void);
Jan Djärv's avatar
Jan Djärv committed
335

336 337 338 339

/* Flush display of frame F, or of all frames if F is null.  */

static void
340
x_flush (struct frame *f)
341
{
342 343 344 345 346
  /* Don't call XFlush when it is not safe to redisplay; the X
     connection may be broken.  */
  if (!NILP (Vinhibit_redisplay))
    return;

347
  block_input ();
348 349 350 351 352 353
  if (f)
    {
      eassert (FRAME_X_P (f));
      XFlush (FRAME_X_DISPLAY (f));
    }
  else
354
    {
355 356 357 358
      /* Flush all displays and so all frames on them.  */
      struct x_display_info *xdi;
      for (xdi = x_display_list; xdi; xdi = xdi->next)
	XFlush (xdi->display);
359
    }
360
  unblock_input ();
361 362
}

Jim Blandy's avatar
Jim Blandy committed
363

364 365 366 367 368 369 370
/* 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
371
#define XFlush(DISPLAY)	(void) 0
372

373

374 375 376 377
/***********************************************************************
			      Debugging
 ***********************************************************************/

378
#if 0
379 380 381

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

Juanma Barranquero's avatar
Juanma Barranquero committed
383
struct record
384 385 386 387 388 389 390 391 392
{
  char *locus;
  int type;
};

struct record event_record[100];

int event_record_index;

Andreas Schwab's avatar
Andreas Schwab committed
393 394
void
record_event (char *locus, int type)
395 396 397 398 399 400 401 402 403 404
{
  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 */
405 406


407

408 409 410
/* Return the struct x_display_info corresponding to DPY.  */

struct x_display_info *
411
x_display_info_for_display (Display *dpy)
412 413 414 415 416 417
{
  struct x_display_info *dpyinfo;

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

419 420
  return 0;
}
421

422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
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);

  while (wi != FRAME_X_DISPLAY_INFO (f)->root_window)
    {
      Window root;
      Window *children;
      unsigned int nchildren;

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

  return win;
}

443 444 445
#define OPAQUE  0xffffffff

void
446
x_set_frame_alpha (struct frame *f)
447 448 449 450
{
  struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
  Display *dpy = FRAME_X_DISPLAY (f);
  Window win = FRAME_OUTER_WINDOW (f);
451 452
  double alpha = 1.0;
  double alpha_min = 1.0;
453
  unsigned long opac;
454
  Window parent;
455

456 457 458 459 460 461 462 463 464 465
  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;

466 467 468
  if (alpha < 0.0)
    return;
  else if (alpha > 1.0)
469 470 471 472
    alpha = 1.0;
  else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
    alpha = alpha_min;

473
  opac = alpha * OPAQUE;
474

475 476 477 478 479 480 481 482 483 484 485 486 487
  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);

488 489 490 491
  /* return unless necessary */
  {
    unsigned char *data;
    Atom actual;
492
    int rc, format;
493 494
    unsigned long n, left;

495
    rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
496 497 498
			     0L, 1L, False, XA_CARDINAL,
			     &actual, &format, &n, &left,
			     &data);
499 500

    if (rc == Success && actual != None)
501
      {
502
        unsigned long value = *(unsigned long *)data;
503
	XFree (data);
504
	if (value == opac)
505 506 507 508 509
	  {
	    x_uncatch_errors ();
	    return;
	  }
      }
510 511
  }

512
  XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
513 514
		   XA_CARDINAL, 32, PropModeReplace,
		   (unsigned char *) &opac, 1L);
515
  x_uncatch_errors ();
516
}
517

518
int
519
x_display_pixel_height (struct x_display_info *dpyinfo)
520 521 522 523 524
{
  return HeightOfScreen (dpyinfo->screen);
}

int
525
x_display_pixel_width (struct x_display_info *dpyinfo)
526 527 528 529
{
  return WidthOfScreen (dpyinfo->screen);
}

530 531 532 533

/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
Juanma Barranquero's avatar
Juanma Barranquero committed
534

535 536 537 538 539
/* 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
540

Andreas Schwab's avatar
Andreas Schwab committed
541
static void
542
x_update_begin (struct frame *f)
543
{
544 545
  /* Nothing to do.  */
}
Jim Blandy's avatar
Jim Blandy committed
546 547


548
/* Start update of window W.  */
Jim Blandy's avatar
Jim Blandy committed
549

550
static void
551
x_update_window_begin (struct window *w)
552 553
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
554
  Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
Juanma Barranquero's avatar
Juanma Barranquero committed
555

556
  w->output_cursor = w->cursor;
557

558
  block_input ();
559

560
  if (f == hlinfo->mouse_face_mouse_frame)
561
    {
562
      /* Don't do highlighting for mouse motion during the update.  */
563
      hlinfo->mouse_face_defer = 1;
564

565 566
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
567
      if (FRAME_GARBAGED_P (f))
568
	hlinfo->mouse_face_window = Qnil;
569
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
570

571
  unblock_input ();
Jim Blandy's avatar
Jim Blandy committed
572 573
}

574

575
/* Draw a vertical window border from (x,y0) to (x,y1)  */
576

Andreas Schwab's avatar
Andreas Schwab committed
577
static void
578
x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
579
{
580
  struct frame *f = XFRAME (WINDOW_FRAME (w));
581 582 583 584 585 586
  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);
587

588 589
  XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
	     f->output_data.x->normal_gc, x, y0, x, y1);
590
}
Juanma Barranquero's avatar
Juanma Barranquero committed
591

592
/* End update of window W.
593 594 595 596 597 598 599 600 601 602 603

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

static void
606 607
x_update_window_end (struct window *w, bool cursor_on_p,
		     bool mouse_face_overwritten_p)
608 609 610
{
  if (!w->pseudo_window_p)
    {
611
      block_input ();
612

613
      if (cursor_on_p)
614 615 616
	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
617

618 619
      if (draw_window_fringes (w, 1))
	x_draw_vertical_border (w);
Kenichi Handa's avatar
Kenichi Handa committed
620

621
      unblock_input ();
622
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
623

624 625 626
  /* If a row with mouse-face was overwritten, arrange for
     XTframe_up_to_date to redisplay the mouse highlight.  */
  if (mouse_face_overwritten_p)
627
    reset_mouse_highlight (MOUSE_HL_INFO (XFRAME (w->frame)));
628
}
Jim Blandy's avatar
Jim Blandy committed
629 630


631 632 633 634
/* End update of frame F.  This function is installed as a hook in
   update_end.  */

static void
635
x_update_end (struct frame *f)
636 637
{
  /* Mouse highlight may be displayed again.  */
638
  MOUSE_HL_INFO (f)->mouse_face_defer = 0;
639

640
#ifndef XFlush
641
  block_input ();
642
  XFlush (FRAME_X_DISPLAY (f));
643
  unblock_input ();
644
#endif
Jim Blandy's avatar
Jim Blandy committed
645
}
646

647

648 649
/* This function is called from various places in xdisp.c
   whenever a complete update has been performed.  */
650

Andreas Schwab's avatar
Andreas Schwab committed
651
static void
652
XTframe_up_to_date (struct frame *f)
653
{
654
  if (FRAME_X_P (f))
655
    FRAME_MOUSE_UPDATE (f);
656
}
657 658 659


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
660
   arrow bitmaps, or clear the fringes if no bitmaps are required
661
   before DESIRED_ROW is made current.  This function is called from
662 663 664 665
   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
666
x_after_update_window_line (struct window *w, struct glyph_row *desired_row)
667
{
668
  struct frame *f;
669
  int width, height;
Juanma Barranquero's avatar
Juanma Barranquero committed
670

671
  eassert (w);
Juanma Barranquero's avatar
Juanma Barranquero committed
672

673
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
Kenichi Handa's avatar
Kenichi Handa committed
674
    desired_row->redraw_fringe_bitmaps_p = 1;
Juanma Barranquero's avatar
Juanma Barranquero committed
675

676 677
  /* When a window has disappeared, make sure that no rest of
     full-width rows stays visible in the internal border.  Could
678
     check here if updated window is the leftmost/rightmost window,
679 680 681 682 683
     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
684
      && (f = XFRAME (w->frame),
685
	  width = FRAME_INTERNAL_BORDER_WIDTH (f),
686 687 688
	  width != 0)
      && (height = desired_row->visible_height,
	  height > 0))
689 690
    {
      int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
691

692
      block_input ();
693
      x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
694
		    0, y, width, height);
695
      x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
696
		    FRAME_PIXEL_WIDTH (f) - width,
697
		    y, width, height);
698
      unblock_input ();
699 700 701 702
    }
}

static void
703
x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
704 705 706 707 708
{
  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
709
  struct face *face = p->face;
710 711

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

714
  if (!p->overlay_p)
715
    {
716 717
      int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;

718 719 720 721 722 723 724 725
      /* 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
726

727 728 729 730 731 732 733 734 735 736 737 738 739
#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)
	    {
740 741 742
	      int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
	      int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
				    * FRAME_COLUMN_WIDTH (f));
743 744 745 746

	      if (bx < 0)
		{
		  /* Bitmap fills the fringe.  */
747 748 749 750
		  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;
751 752 753 754
		  if (bx >= 0)
		    {
		      int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);

755
		      nx = bar_area_width - sb_width;
756 757 758 759 760 761 762
		      by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
							    row->y));
		      ny = row->visible_height;
		    }
		}
	      else
		{
763
		  if (bar_area_x + bar_area_width == bx)
764
		    {
765 766
		      bx = bar_area_x + sb_width;
		      nx += bar_area_width - sb_width;
767
		    }
768 769
		  else if (bx + nx == bar_area_x)
		    nx += bar_area_width - sb_width;
770 771 772 773 774 775
		}
	    }
	}
#endif
      if (bx >= 0 && nx > 0)
	XFillRectangle (display, window, face->gc, bx, by, nx, ny);
Kim F. Storm's avatar
Kim F. Storm committed
776

777 778 779 780
      if (!face->stipple)
	XSetForeground (display, face->gc, face->foreground);
    }

Kenichi Handa's avatar
Kenichi Handa committed
781
  if (p->which)
782
    {
783
      char *bits;
Kenichi Handa's avatar
Kenichi Handa committed
784
      Pixmap pixmap, clipmask = (Pixmap) 0;
Kim F. Storm's avatar
Kim F. Storm committed
785
      int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
Kenichi Handa's avatar
Kenichi Handa committed
786 787 788
      XGCValues gcv;

      if (p->wd > 8)
789
	bits = (char *) (p->bits + p->dh);
Kenichi Handa's avatar
Kenichi Handa committed
790
      else
791
	bits = (char *) p->bits + p->dh;
Kim F. Storm's avatar
Kim F. Storm committed
792

793 794
      /* Draw the bitmap.  I believe these small pixmaps can be cached
	 by the server.  */
Kim F. Storm's avatar
Kim F. Storm committed
795
      pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
Kenichi Handa's avatar
Kenichi Handa committed
796 797 798 799
					    (p->cursor_p
					     ? (p->overlay_p ? face->background
						: f->output_data.x->cursor_pixel)
					     : face->foreground),
800
					    face->background, depth);
Kenichi Handa's avatar
Kenichi Handa committed
801 802 803 804 805 806 807 808 809 810 811 812 813

      if (p->overlay_p)
	{
	  clipmask = XCreatePixmapFromBitmapData (display,
						  FRAME_X_DISPLAY_INFO (f)->root_window,
						  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
814 815
      XCopyArea (display, pixmap, window, gc, 0, 0,
		 p->wd, p->h, p->x, p->y);
816
      XFreePixmap (display, pixmap);
Kenichi Handa's avatar
Kenichi Handa committed
817 818 819 820 821 822 823

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

826 827 828 829 830 831 832 833 834
  XSetClipMask (display, gc, None);
}

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



835 836 837 838 839 840
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 *);
841
static _Noreturn void x_delete_glyphs (struct frame *, int);
842 843 844 845
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 *);
846 847
static bool x_alloc_lighter_color (struct frame *, Display *, Colormap,
				   unsigned long *, double, int);
848 849 850 851 852 853 854 855 856 857 858 859 860 861
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
862
static void x_scroll_bar_clear (struct frame *);
863

864
#ifdef GLYPH_DEBUG
865
static void x_check_font (struct frame *, struct font *);
866
#endif
867 868 869 870 871 872


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

static void
873
x_set_cursor_gc (struct glyph_string *s)
874 875 876 877
{
  if (s->font == FRAME_FONT (s->f)
      && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
      && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
878
      && !s->cmp)
879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906
    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;
907
      mask = GCForeground | GCBackground | GCGraphicsExposures;
908 909 910 911 912 913 914 915 916 917 918 919 920 921

      if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
	XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
		   mask, &xgcv);
      else
	FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
	  = XCreateGC (s->display, s->window, mask, &xgcv);

      s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;
    }
}


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

923
static void
924
x_set_mouse_face_gc (struct glyph_string *s)
Juanma Barranquero's avatar
Juanma Barranquero committed
925
{
926
  int face_id;
927
  struct face *face;
928

929
  /* What face has to be used last for the mouse face?  */
930
  face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
931
  face = FACE_FROM_ID (s->f, face_id);
932 933
  if (face == NULL)
    face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
Juanma Barranquero's avatar
Juanma Barranquero committed
934

935
  if (s->first_glyph->type == CHAR_GLYPH)
936
    face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
937
  else
938
    face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
939 940 941 942 943 944 945 946
  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
947
	 except for FONT.  */
948 949
      XGCValues xgcv;
      unsigned long mask;
Juanma Barranquero's avatar
Juanma Barranquero committed
950

951 952 953
      xgcv.background = s->face->background;
      xgcv.foreground = s->face->foreground;
      xgcv.graphics_exposures = False;
954
      mask = GCForeground | GCBackground | GCGraphicsExposures;
Juanma Barranquero's avatar
Juanma Barranquero committed
955

956 957 958 959 960 961
      if (FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc)
	XChangeGC (s->display, FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc,
		   mask, &xgcv);
      else
	FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc
	  = XCreateGC (s->display, s->window, mask, &xgcv);
Juanma Barranquero's avatar
Juanma Barranquero committed
962

963 964
      s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;

965
    }
966
  eassert (s->gc != 0);
967 968 969 970 971 972 973
}


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

974
static void
975
x_set_mode_line_face_gc (struct glyph_string *s)
Juanma Barranquero's avatar
Juanma Barranquero committed
976
{
977 978 979 980 981 982 983 984
  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.  */

985
static void
986
x_set_glyph_string_gc (struct glyph_string *s)
987
{
988
  PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
Juanma Barranquero's avatar
Juanma Barranquero committed
989

990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
  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.  */
1023
  eassert (s->gc != 0);
1024 1025 1026 1027 1028 1029
}


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

1030
static void
1031
x_set_glyph_string_clipping (struct glyph_string *s)
1032
{
1033 1034 1035 1036 1037 1038
  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;
1039 1040 1041
}


1042 1043 1044 1045 1046
/* 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
1047
x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1048 1049
{
  XRectangle r;
Kenichi Handa's avatar
Kenichi Handa committed
1050

1051 1052 1053 1054 1055 1056
  r.x = src->x;
  r.width = src->width;
  r.y = src->y;
  r.height = src->height;
  dst->clip[0] = r;
  dst->num_clips = 1;
1057 1058 1059 1060
  XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
}


1061
/* RIF:
1062
   Compute left and right overhang of glyph string S.  */
1063

1064
static void
1065
x_compute_glyph_string_overhangs (struct glyph_string *s)
1066
{
1067
  if (s->cmp == NULL
1068 1069
      && (s->first_glyph->type == CHAR_GLYPH
	  || s->first_glyph->type == COMPOSITE_GLYPH))
1070
    {
1071
      struct font_metrics metrics;
Kenichi Handa's avatar
Kenichi Handa committed
1072

1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087