xterm.c 322 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-2012 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 "fontset.h"
73
#include "xsettings.h"
74
#include "xgselect.h"
75
#include "sysselect.h"
Jim Blandy's avatar
Jim Blandy committed
76

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

81 82
#include <unistd.h>

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

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

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

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

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

122 123
#endif /* USE_X_TOOLKIT */

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

131 132
#include "bitmaps/gray.xbm"

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

140 141 142 143 144 145 146


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

static int any_help_event_p;

147
/* Last window where we saw the mouse.  Used by mouse-autoselect-window.  */
148
static Lisp_Object last_window;
149

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

153
struct x_display_info *x_display_list;
Jim Blandy's avatar
Jim Blandy committed
154

155 156 157 158 159
/* 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.  */

160
Lisp_Object x_display_name_list;
161

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

164 165 166 167 168 169 170 171
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;
172

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

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

static int toolkit_scroll_bar_interaction;
181
#endif /* USE_X_TOOLKIT */
Jim Blandy's avatar
Jim Blandy committed
182

Kenichi Handa's avatar
Kenichi Handa committed
183 184 185 186 187 188
/* 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;

189 190
/* Mouse movement.

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

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

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

211
static XRectangle last_mouse_glyph;
Kim F. Storm's avatar
Kim F. Storm committed
212
static FRAME_PTR last_mouse_glyph_frame;
213 214
static Lisp_Object last_mouse_press_frame;

215 216
/* The scroll bar in which the last X motion event occurred.

217 218
   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
219 220
   an ordinary motion.

221 222 223 224
   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.  */

225 226 227 228
static Lisp_Object last_mouse_scroll_bar;

/* This is a hack.  We would really prefer that XTmouse_position would
   return the time associated with the position it returns, but there
229
   doesn't seem to be any way to wrest the time-stamp from the server
230 231 232
   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.  */
233

234 235
static Time last_mouse_movement_time;

Jan Djärv's avatar
Jan Djärv committed
236 237 238 239
/* Time for last user interaction as returned in X events.  */

static Time last_user_time;

240 241 242
/* Incremented by XTread_socket whenever it really tries to read
   events.  */

243 244
static int volatile input_signal_count;

245
/* Used locally within XTread_socket.  */
246

247
static int x_noop_count;
Jim Blandy's avatar
Jim Blandy committed
248

249 250
static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;

251
static Lisp_Object Qvendor_specific_keysyms;
Dave Love's avatar
Dave Love committed
252
static Lisp_Object Qlatin_1;
253

254 255 256
#ifdef USE_GTK
/* The name of the Emacs icon file.  */
static Lisp_Object xg_default_icon_file;
257 258 259

/* Used in gtkutil.c.  */
Lisp_Object Qx_gtk_map_stock;
260 261
#endif

262 263 264
/* Some functions take this as char *, not const char *.  */
static char emacs_class[] = EMACS_CLASS;

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

Andreas Schwab's avatar
Andreas Schwab committed
288
/* Used in x_flush.  */
289

290
static bool x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
291
static void x_set_window_size_1 (struct frame *, int, int, int);
292 293
static void x_raise_frame (struct frame *);
static void x_lower_frame (struct frame *);
294 295 296 297 298 299 300 301 302 303 304
static const XColor *x_color_cells (Display *, int *);
static void x_update_window_end (struct window *, int, 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 XTset_terminal_modes (struct terminal *);
static void XTreset_terminal_modes (struct terminal *);
static void x_clear_frame (struct frame *);
305
static _Noreturn void x_ins_del_lines (struct frame *, int, int);
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
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);

static void x_clip_to_row (struct window *, struct glyph_row *, int, GC);
static void x_flush (struct frame *f);
static void x_update_begin (struct frame *);
static void x_update_window_begin (struct window *);
static void x_after_update_window_line (struct glyph_row *);
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 *,
328
                                        Time *);
329
static int x_handle_net_wm_state (struct frame *, XPropertyEvent *);
330 331 332 333 334
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 *);
335
#ifdef USE_GTK
336 337
static int x_dispatch_event (XEvent *, Display *);
#endif
338
/* Don't declare this _Noreturn because we want no
339
   interference with debugging failing X calls.  */
340
static void x_connection_closed (Display *, const char *);
341
static void x_wm_set_window_state (struct frame *, int);
342
static void x_wm_set_icon_pixmap (struct frame *, ptrdiff_t);
343
static void x_initialize (void);
Jan Djärv's avatar
Jan Djärv committed
344

345 346 347 348

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

static void
349
x_flush (struct frame *f)
350
{
351 352 353 354 355
  /* Don't call XFlush when it is not safe to redisplay; the X
     connection may be broken.  */
  if (!NILP (Vinhibit_redisplay))
    return;

356
  block_input ();
357 358 359 360
  if (f == NULL)
    {
      Lisp_Object rest, frame;
      FOR_EACH_FRAME (rest, frame)
361 362
        if (FRAME_X_P (XFRAME (frame)))
          x_flush (XFRAME (frame));
363 364 365
    }
  else if (FRAME_X_P (f))
    XFlush (FRAME_X_DISPLAY (f));
366
  unblock_input ();
367 368
}

Jim Blandy's avatar
Jim Blandy committed
369

370 371 372 373 374 375 376
/* 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
377
#define XFlush(DISPLAY)	(void) 0
378

379

380 381 382 383
/***********************************************************************
			      Debugging
 ***********************************************************************/

384
#if 0
385 386 387

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

Juanma Barranquero's avatar
Juanma Barranquero committed
389
struct record
390 391 392 393 394 395 396 397 398
{
  char *locus;
  int type;
};

struct record event_record[100];

int event_record_index;

Andreas Schwab's avatar
Andreas Schwab committed
399 400
void
record_event (char *locus, int type)
401 402 403 404 405 406 407 408 409 410
{
  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 */
411 412


413

414 415 416
/* Return the struct x_display_info corresponding to DPY.  */

struct x_display_info *
417
x_display_info_for_display (Display *dpy)
418 419 420 421 422 423
{
  struct x_display_info *dpyinfo;

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

425 426
  return 0;
}
427

428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
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;
}

449 450 451
#define OPAQUE  0xffffffff

void
452
x_set_frame_alpha (struct frame *f)
453 454 455 456
{
  struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
  Display *dpy = FRAME_X_DISPLAY (f);
  Window win = FRAME_OUTER_WINDOW (f);
457 458
  double alpha = 1.0;
  double alpha_min = 1.0;
459
  unsigned long opac;
460
  Window parent;
461

462 463 464 465 466 467 468 469 470 471
  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;

472 473 474
  if (alpha < 0.0)
    return;
  else if (alpha > 1.0)
475 476 477 478
    alpha = 1.0;
  else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
    alpha = alpha_min;

479
  opac = alpha * OPAQUE;
480

481 482 483 484 485 486 487 488 489 490 491 492 493
  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);

494 495 496 497
  /* return unless necessary */
  {
    unsigned char *data;
    Atom actual;
498
    int rc, format;
499 500
    unsigned long n, left;

501
    rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
502 503 504
			     0L, 1L, False, XA_CARDINAL,
			     &actual, &format, &n, &left,
			     &data);
505 506

    if (rc == Success && actual != None)
507
      {
508
        unsigned long value = *(unsigned long *)data;
509
	XFree (data);
510
	if (value == opac)
511 512 513 514 515
	  {
	    x_uncatch_errors ();
	    return;
	  }
      }
516 517
  }

518
  XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
519 520
		   XA_CARDINAL, 32, PropModeReplace,
		   (unsigned char *) &opac, 1L);
521
  x_uncatch_errors ();
522
}
523

524
int
525
x_display_pixel_height (struct x_display_info *dpyinfo)
526 527 528 529 530
{
  return HeightOfScreen (dpyinfo->screen);
}

int
531
x_display_pixel_width (struct x_display_info *dpyinfo)
532 533 534 535
{
  return WidthOfScreen (dpyinfo->screen);
}

536 537 538 539

/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
Juanma Barranquero's avatar
Juanma Barranquero committed
540

541 542 543 544 545
/* 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
546

Andreas Schwab's avatar
Andreas Schwab committed
547
static void
548
x_update_begin (struct frame *f)
549
{
550 551
  /* Nothing to do.  */
}
Jim Blandy's avatar
Jim Blandy committed
552 553


554 555 556
/* Start update of window W.  Set the global variable updated_window
   to the window being updated and set output_cursor to the cursor
   position of W.  */
Jim Blandy's avatar
Jim Blandy committed
557

558
static void
559
x_update_window_begin (struct window *w)
560 561
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
562
  Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
Juanma Barranquero's avatar
Juanma Barranquero committed
563

564 565
  updated_window = w;
  set_output_cursor (&w->cursor);
566

567
  block_input ();
568

569
  if (f == hlinfo->mouse_face_mouse_frame)
570
    {
571
      /* Don't do highlighting for mouse motion during the update.  */
572
      hlinfo->mouse_face_defer = 1;
573

574 575
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
576
      if (FRAME_GARBAGED_P (f))
577
	hlinfo->mouse_face_window = Qnil;
578
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
579

580
  unblock_input ();
Jim Blandy's avatar
Jim Blandy committed
581 582
}

583

584
/* Draw a vertical window border from (x,y0) to (x,y1)  */
585

Andreas Schwab's avatar
Andreas Schwab committed
586
static void
587
x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
588
{
589
  struct frame *f = XFRAME (WINDOW_FRAME (w));
590 591 592 593 594 595
  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);
596

597 598
  XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
	     f->output_data.x->normal_gc, x, y0, x, y1);
599
}
Juanma Barranquero's avatar
Juanma Barranquero committed
600

601 602 603 604 605 606 607 608 609 610 611 612
/* End update of window W (which is equal to updated_window).

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

static void
615
x_update_window_end (struct window *w, int cursor_on_p, int mouse_face_overwritten_p)
616
{
617
  Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
Juanma Barranquero's avatar
Juanma Barranquero committed
618

619 620
  if (!w->pseudo_window_p)
    {
621
      block_input ();
622

623
      if (cursor_on_p)
624 625 626
	display_and_set_cursor (w, 1, output_cursor.hpos,
				output_cursor.vpos,
				output_cursor.x, output_cursor.y);
Juanma Barranquero's avatar
Juanma Barranquero committed
627

628 629
      if (draw_window_fringes (w, 1))
	x_draw_vertical_border (w);
Kenichi Handa's avatar
Kenichi Handa committed
630

631
      unblock_input ();
632
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
633

634 635 636 637
  /* If a row with mouse-face was overwritten, arrange for
     XTframe_up_to_date to redisplay the mouse highlight.  */
  if (mouse_face_overwritten_p)
    {
638 639 640
      hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
      hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
      hlinfo->mouse_face_window = Qnil;
641
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
642

643 644
  updated_window = NULL;
}
Jim Blandy's avatar
Jim Blandy committed
645 646


647 648 649 650
/* End update of frame F.  This function is installed as a hook in
   update_end.  */

static void
651
x_update_end (struct frame *f)
652 653
{
  /* Mouse highlight may be displayed again.  */
654
  MOUSE_HL_INFO (f)->mouse_face_defer = 0;
655

656
#ifndef XFlush
657
  block_input ();
658
  XFlush (FRAME_X_DISPLAY (f));
659
  unblock_input ();
660
#endif
Jim Blandy's avatar
Jim Blandy committed
661
}
662

663 664 665 666

/* This function is called from various places in xdisp.c whenever a
   complete update has been performed.  The global variable
   updated_window is not available here.  */
667

Andreas Schwab's avatar
Andreas Schwab committed
668
static void
669
XTframe_up_to_date (struct frame *f)
670
{
671
  if (FRAME_X_P (f))
672
    {
673
      Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
674

675 676
      if (hlinfo->mouse_face_deferred_gc
	  || f == hlinfo->mouse_face_mouse_frame)
677
	{
678
	  block_input ();
679 680 681 682 683
	  if (hlinfo->mouse_face_mouse_frame)
	    note_mouse_highlight (hlinfo->mouse_face_mouse_frame,
				  hlinfo->mouse_face_mouse_x,
				  hlinfo->mouse_face_mouse_y);
	  hlinfo->mouse_face_deferred_gc = 0;
684
	  unblock_input ();
685
	}
686
    }
687
}
688 689 690


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
691
   arrow bitmaps, or clear the fringes if no bitmaps are required
692 693 694 695 696 697
   before DESIRED_ROW is made current.  The window being updated is
   found in updated_window.  This function It is called from
   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
698
x_after_update_window_line (struct glyph_row *desired_row)
699 700
{
  struct window *w = updated_window;
701
  struct frame *f;
702
  int width, height;
Juanma Barranquero's avatar
Juanma Barranquero committed
703

704
  eassert (w);
Juanma Barranquero's avatar
Juanma Barranquero committed
705

706
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
Kenichi Handa's avatar
Kenichi Handa committed
707
    desired_row->redraw_fringe_bitmaps_p = 1;
Juanma Barranquero's avatar
Juanma Barranquero committed
708

709 710 711 712 713 714 715 716
  /* When a window has disappeared, make sure that no rest of
     full-width rows stays visible in the internal border.  Could
     check here if updated_window is the leftmost/rightmost window,
     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
717
      && (f = XFRAME (w->frame),
718
	  width = FRAME_INTERNAL_BORDER_WIDTH (f),
719 720 721
	  width != 0)
      && (height = desired_row->visible_height,
	  height > 0))
722 723
    {
      int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
724

725
      block_input ();
726 727 728
      x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
		    0, y, width, height, False);
      x_clear_area (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
729
		    FRAME_PIXEL_WIDTH (f) - width,
730
		    y, width, height, False);
731
      unblock_input ();
732 733 734 735
    }
}

static void
736
x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
737 738 739 740 741
{
  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
742
  struct face *face = p->face;
743 744

  /* Must clip because of partially visible lines.  */
745
  x_clip_to_row (w, row, -1, gc);
746

747
  if (!p->overlay_p)
748
    {
749 750
      int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;

751 752 753 754 755 756 757 758
      /* 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
759

760 761 762 763 764 765 766 767 768 769 770 771 772
#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)
	    {
773 774 775
	      int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
	      int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
				    * FRAME_COLUMN_WIDTH (f));
776 777 778 779

	      if (bx < 0)
		{
		  /* Bitmap fills the fringe.  */
780 781 782 783
		  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;
784 785 786 787
		  if (bx >= 0)
		    {
		      int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);

788
		      nx = bar_area_width - sb_width;
789 790 791 792 793 794 795
		      by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
							    row->y));
		      ny = row->visible_height;
		    }
		}
	      else
		{
796
		  if (bar_area_x + bar_area_width == bx)
797
		    {
798 799
		      bx = bar_area_x + sb_width;
		      nx += bar_area_width - sb_width;
800
		    }
801 802
		  else if (bx + nx == bar_area_x)
		    nx += bar_area_width - sb_width;
803 804 805 806 807 808
		}
	    }
	}
#endif
      if (bx >= 0 && nx > 0)
	XFillRectangle (display, window, face->gc, bx, by, nx, ny);
Kim F. Storm's avatar
Kim F. Storm committed
809

810 811 812 813
      if (!face->stipple)
	XSetForeground (display, face->gc, face->foreground);
    }

Kenichi Handa's avatar
Kenichi Handa committed
814
  if (p->which)
815
    {
816
      char *bits;
Kenichi Handa's avatar
Kenichi Handa committed
817
      Pixmap pixmap, clipmask = (Pixmap) 0;
Kim F. Storm's avatar
Kim F. Storm committed
818
      int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
Kenichi Handa's avatar
Kenichi Handa committed
819 820 821
      XGCValues gcv;

      if (p->wd > 8)
822
	bits = (char *) (p->bits + p->dh);
Kenichi Handa's avatar
Kenichi Handa committed
823
      else
824
	bits = (char *) p->bits + p->dh;
Kim F. Storm's avatar
Kim F. Storm committed
825

826 827
      /* Draw the bitmap.  I believe these small pixmaps can be cached
	 by the server.  */
Kim F. Storm's avatar
Kim F. Storm committed
828
      pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
Kenichi Handa's avatar
Kenichi Handa committed
829 830 831 832
					    (p->cursor_p
					     ? (p->overlay_p ? face->background
						: f->output_data.x->cursor_pixel)
					     : face->foreground),
833
					    face->background, depth);
Kenichi Handa's avatar
Kenichi Handa committed
834 835 836 837 838 839 840 841 842 843 844 845 846

      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
847 848
      XCopyArea (display, pixmap, window, gc, 0, 0,
		 p->wd, p->h, p->x, p->y);
849
      XFreePixmap (display, pixmap);
Kenichi Handa's avatar
Kenichi Handa committed
850 851 852 853 854 855 856

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

859 860 861
  XSetClipMask (display, gc, None);
}

Jim Blandy's avatar
Jim Blandy committed
862

863 864 865 866 867

/* This is called when starting Emacs and when restarting after
   suspend.  When starting Emacs, no X window is mapped.  And nothing
   must be done to Emacs's own window if it is suspended (though that
   rarely happens).  */
Jim Blandy's avatar
Jim Blandy committed
868

Andreas Schwab's avatar
Andreas Schwab committed
869
static void
870
XTset_terminal_modes (struct terminal *terminal)
Jim Blandy's avatar
Jim Blandy committed
871 872 873
{
}

874 875
/* This is called when exiting or suspending Emacs.  Exiting will make
   the X-windows go away, and suspending requires no action.  */
Jim Blandy's avatar
Jim Blandy committed
876

Andreas Schwab's avatar
Andreas Schwab committed
877
static void
878
XTreset_terminal_modes (struct terminal *terminal)
Jim Blandy's avatar
Jim Blandy committed
879 880
{
}
881 882 883 884 885 886 887 888

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



889 890 891 892 893 894 895 896
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_background (struct glyph_string *,
                                            int);
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 *);
897
static _Noreturn void x_delete_glyphs (struct frame *, int);
898 899 900 901
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 *);
902 903
static bool x_alloc_lighter_color (struct frame *, Display *, Colormap,
				   unsigned long *, double, int);
904 905 906 907 908 909 910 911 912 913 914 915 916 917
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
918
static void x_scroll_bar_clear (struct frame *);
919

920
#ifdef GLYPH_DEBUG
921
static void x_check_font (struct frame *, struct font *);
922
#endif
923 924 925 926 927 928


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

static void
929
x_set_cursor_gc (struct glyph_string *s)
930 931 932 933
{
  if (s->font == FRAME_FONT (s->f)
      && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
      && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
934
      && !s->cmp)
935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962
    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;
963
      mask = GCForeground | GCBackground | GCGraphicsExposures;
964 965 966 967 968 969 970 971 972 973 974 975 976 977

      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
978

979
static void
980
x_set_mouse_face_gc (struct glyph_string *s)
Juanma Barranquero's avatar
Juanma Barranquero committed
981
{
982
  int face_id;
983
  struct face *face;
984

985
  /* What face has to be used last for the mouse face?  */
986
  face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
987
  face = FACE_FROM_ID (s->f, face_id);
988 989
  if (face == NULL)
    face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
Juanma Barranquero's avatar
Juanma Barranquero committed
990

991
  if (s->first_glyph->type == CHAR_GLYPH)
992
    face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
993
  else
994
    face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
995 996 997 998 999 1000 1001 1002
  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
1003
	 except for FONT.  */
1004 1005
      XGCValues xgcv;
      unsigned long mask;
Juanma Barranquero's avatar
Juanma Barranquero committed
1006

1007 1008 1009
      xgcv.background = s->face->background;
      xgcv.foreground = s->face->foreground;
      xgcv.graphics_exposures = False;
1010
      mask = GCForeground | GCBackground | GCGraphicsExposures;
Juanma Barranquero's avatar
Juanma Barranquero committed
1011

1012 1013 1014 1015 1016 1017
      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
1018

1019 1020
      s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;

1021
    }
1022
  eassert (s->gc != 0);
1023 1024 1025 1026 1027 1028 1029
}


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

Paul Eggert's avatar
Paul Eggert committed
1030
static inline void
1031
x_set_mode_line_face_gc (struct glyph_string *s)
Juanma Barranquero's avatar
Juanma Barranquero committed
1032
{
1033 1034 1035 1036 1037 1038 1039 1040
  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.  */

Paul Eggert's avatar
Paul Eggert committed
1041
static inline void
1042
x_set_glyph_string_gc (struct glyph_string *s)
1043
{
1044
  PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
Juanma Barranquero's avatar
Juanma Barranquero committed
1045

1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078
  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.  */
1079
  eassert (s->gc != 0);
1080 1081 1082 1083 1084 1085
}


/* Set clipping for output of glyph string S.