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 163 164
#ifdef USE_X_TOOLKIT
/* The application context for Xt use.  */
XtAppContext Xt_app_con;
165
static String Xt_default_resources[] = {0};
166

Gerd Moellmann's avatar
Gerd Moellmann committed
167 168 169
/* Non-zero means user is interacting with a toolkit scroll bar.  */

static int toolkit_scroll_bar_interaction;
170
#endif /* USE_X_TOOLKIT */
Jim Blandy's avatar
Jim Blandy committed
171

Kenichi Handa's avatar
Kenichi Handa committed
172 173 174 175 176 177
/* 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;

178 179
/* Mouse movement.

180
   Formerly, we used PointerMotionHintMask (in standard_event_mask)
181 182 183 184 185 186
   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.

187 188 189 190 191 192 193 194 195
   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
196
   is off.  */
197 198 199

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

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

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

205 206
   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
207 208
   an ordinary motion.

209 210 211 212
   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.  */

213 214
static Lisp_Object last_mouse_scroll_bar;

215 216 217 218 219 220 221 222 223
/* 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;

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

227 228
static int volatile input_signal_count;

229
/* Used locally within XTread_socket.  */
230

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

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

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

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

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

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

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

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

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

321

Dmitry Antipov's avatar
Dmitry Antipov committed
322
/* Flush display of frame F.  */
323 324

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

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

Jim Blandy's avatar
Jim Blandy committed
338

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

348

349 350 351 352
/***********************************************************************
			      Debugging
 ***********************************************************************/

353
#if 0
354 355 356

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

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

struct record event_record[100];

int event_record_index;

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


382

383 384 385
/* Return the struct x_display_info corresponding to DPY.  */

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

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

394 395
  return 0;
}
396

397 398 399 400 401 402 403
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);

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

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

  return win;
}

418 419 420
#define OPAQUE  0xffffffff

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

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

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

448
  opac = alpha * OPAQUE;
449

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

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

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

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

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

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

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

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

510 511 512 513 514
/* 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
515

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


523
/* Start update of window W.  */
Jim Blandy's avatar
Jim Blandy committed
524

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

531
  w->output_cursor = w->cursor;
532

533
  block_input ();
534

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

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

546
  unblock_input ();
Jim Blandy's avatar
Jim Blandy committed
547 548
}

549

550
/* Draw a vertical window border from (x,y0) to (x,y1)  */
551

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

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

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

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

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

588
      if (cursor_on_p)
589 590 591
	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
592

593 594
      if (draw_window_fringes (w, 1))
	x_draw_vertical_border (w);
Kenichi Handa's avatar
Kenichi Handa committed
595

596
      unblock_input ();
597
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
598

599 600 601
  /* If a row with mouse-face was overwritten, arrange for
     XTframe_up_to_date to redisplay the mouse highlight.  */
  if (mouse_face_overwritten_p)
602
    reset_mouse_highlight (MOUSE_HL_INFO (XFRAME (w->frame)));
603
}
Jim Blandy's avatar
Jim Blandy committed
604 605


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

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

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

622

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

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


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

646
  eassert (w);
Juanma Barranquero's avatar
Juanma Barranquero committed
647

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



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

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


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

static void
848
x_set_cursor_gc (struct glyph_string *s)
849 850 851 852
{
  if (s->font == FRAME_FONT (s->f)
      && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
      && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
853
      && !s->cmp)
854 855 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
    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;
882
      mask = GCForeground | GCBackground | GCGraphicsExposures;
883

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

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


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

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

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

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

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

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

938
      s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
939

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


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

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

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

965 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
  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.  */
998
  eassert (s->gc != 0);
999 1000 1001 1002 1003 1004
}


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

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


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

1026 1027 1028 1029 1030 1031
  r.x = src->x;
  r.width = src->width;
  r.y = src->y;
  r.height = src->height;
  dst->clip[0] = r;
  dst->num_clips = 1;
1032 1033 1034 1035
  XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
}


1036
/* RIF:
1037
   Compute left and right overhang of glyph string S.  */
1038

1039
static void
1040
x_compute_glyph_string_overhangs (struct glyph_string *s)
1041
{
1042
  if (s->cmp == NULL