xterm.c 323 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
#include <signal.h>
25
#include <stdio.h>
26
#include <setjmp.h>
27

Jim Blandy's avatar
Jim Blandy committed
28 29 30
#ifdef HAVE_X_WINDOWS

#include "lisp.h"
31
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
32

33 34 35 36
/* Need syssignal.h for various externs and definitions that may be required
   by some configurations for calls to signal later in this source file.  */
#include "syssignal.h"

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

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

#include <sys/ioctl.h>

Jim Blandy's avatar
Jim Blandy committed
50
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
51 52 53 54 55 56

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

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

84 85 86 87
#ifdef USE_X_TOOLKIT
#include <X11/Shell.h>
#endif

88 89 90
#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
Paul Eggert's avatar
Paul Eggert committed
91

92 93
#include <unistd.h>

Jan Djärv's avatar
Jan Djärv committed
94 95
#ifdef USE_GTK
#include "gtkutil.h"
Jan Djärv's avatar
Jan Djärv committed
96 97 98
#ifdef HAVE_GTK3
#include <X11/Xproto.h>
#endif
Jan Djärv's avatar
Jan Djärv committed
99 100
#endif

101
#ifdef USE_LUCID
102
#include "../lwlib/xlwmenu.h"
103 104
#endif

Jan Djärv's avatar
Jan Djärv committed
105
#ifdef USE_X_TOOLKIT
Juanma Barranquero's avatar
Juanma Barranquero committed
106
#if !defined (NO_EDITRES)
107
#define HACK_EDITRES
108
extern void _XEditResCheckMessages (Widget, XtPointer, XEvent *, Boolean *);
109
#endif /* not NO_EDITRES */
110 111 112 113 114 115 116

/* 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>
117 118 119
#else /* !USE_MOTIF i.e. use Xaw */

#ifdef HAVE_XAW3D
120 121
#include <X11/Xaw3d/Simple.h>
#include <X11/Xaw3d/Scrollbar.h>
122
#include <X11/Xaw3d/ThreeD.h>
123 124 125 126 127 128 129 130
#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 */
131 132
#endif /* USE_TOOLKIT_SCROLL_BARS */

133 134
#endif /* USE_X_TOOLKIT */

135
#ifdef USE_X_TOOLKIT
Karl Heuer's avatar
Karl Heuer committed
136
#include "widget.h"
137 138 139 140 141
#ifndef XtNinitialState
#define XtNinitialState "initialState"
#endif
#endif

Dave Love's avatar
Dave Love committed
142
/* Default to using XIM if available.  */
143
#ifdef USE_XIM
Dave Love's avatar
Dave Love committed
144
int use_xim = 1;
145 146 147 148
#else
int use_xim = 0;  /* configure --without-xim */
#endif

149 150 151 152 153 154 155


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

static int any_help_event_p;

156
/* Last window where we saw the mouse.  Used by mouse-autoselect-window.  */
157
static Lisp_Object last_window;
158

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

162
struct x_display_info *x_display_list;
Jim Blandy's avatar
Jim Blandy committed
163

164 165 166 167 168
/* 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.  */

169
Lisp_Object x_display_name_list;
170

171
/* Frame being updated by update_frame.  This is declared in term.c.
172 173 174 175
   This is set by update_begin and looked at by all the XT functions.
   It is zero while not inside an update.  In that case, the XT
   functions assume that `selected_frame' is the frame to apply to.  */

176
extern struct frame *updating_frame;
Jim Blandy's avatar
Jim Blandy committed
177

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

180 181 182 183 184 185 186 187
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;
188

189 190 191
#ifdef USE_X_TOOLKIT
/* The application context for Xt use.  */
XtAppContext Xt_app_con;
192
static String Xt_default_resources[] = {0};
193

Gerd Moellmann's avatar
Gerd Moellmann committed
194 195 196
/* Non-zero means user is interacting with a toolkit scroll bar.  */

static int toolkit_scroll_bar_interaction;
197
#endif /* USE_X_TOOLKIT */
Jim Blandy's avatar
Jim Blandy committed
198

Kenichi Handa's avatar
Kenichi Handa committed
199 200 201 202 203 204
/* 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;

205 206
/* Mouse movement.

207
   Formerly, we used PointerMotionHintMask (in standard_event_mask)
208 209 210 211 212 213
   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.

214 215 216 217 218 219 220 221 222
   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
223
   is off.  */
224 225 226

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

227
static XRectangle last_mouse_glyph;
Kim F. Storm's avatar
Kim F. Storm committed
228
static FRAME_PTR last_mouse_glyph_frame;
229 230
static Lisp_Object last_mouse_press_frame;

231 232
/* The scroll bar in which the last X motion event occurred.

233 234
   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
235 236
   an ordinary motion.

237 238 239 240
   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.  */

241 242 243 244
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
245
   doesn't seem to be any way to wrest the time-stamp from the server
246 247 248
   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.  */
249

250 251
static Time last_mouse_movement_time;

Jan Djärv's avatar
Jan Djärv committed
252 253 254 255
/* Time for last user interaction as returned in X events.  */

static Time last_user_time;

256 257 258
/* Incremented by XTread_socket whenever it really tries to read
   events.  */

259 260
static int volatile input_signal_count;

261
/* Used locally within XTread_socket.  */
262

263
static int x_noop_count;
Jim Blandy's avatar
Jim Blandy committed
264

265 266
static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;

267
static Lisp_Object Qvendor_specific_keysyms;
Dave Love's avatar
Dave Love committed
268
static Lisp_Object Qlatin_1;
269

270 271 272
#ifdef USE_GTK
/* The name of the Emacs icon file.  */
static Lisp_Object xg_default_icon_file;
273 274 275

/* Used in gtkutil.c.  */
Lisp_Object Qx_gtk_map_stock;
276 277
#endif

278 279 280
/* Some functions take this as char *, not const char *.  */
static char emacs_class[] = EMACS_CLASS;

Andreas Schwab's avatar
Andreas Schwab committed
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
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
  };
303

Andreas Schwab's avatar
Andreas Schwab committed
304
/* Used in x_flush.  */
305 306 307

static int x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
static void x_set_window_size_1 (struct frame *, int, int, int);
308 309
static void x_raise_frame (struct frame *);
static void x_lower_frame (struct frame *);
310 311 312 313 314 315 316 317 318 319 320
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 *);
321
static void x_ins_del_lines (struct frame *, int, int) NO_RETURN;
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
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 *,
344
                                        Time *);
345
static int x_handle_net_wm_state (struct frame *, XPropertyEvent *);
346 347 348 349 350
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 *);
351
#ifdef USE_GTK
352 353
static int x_dispatch_event (XEvent *, Display *);
#endif
354 355
/* Don't declare this NO_RETURN because we want no
   interference with debugging failing X calls.  */
356
static void x_connection_closed (Display *, const char *);
357
static void x_wm_set_window_state (struct frame *, int);
358
static void x_wm_set_icon_pixmap (struct frame *, ptrdiff_t);
359
static void x_initialize (void);
Jan Djärv's avatar
Jan Djärv committed
360

361 362 363 364

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

static void
365
x_flush (struct frame *f)
366
{
367 368 369 370 371
  /* Don't call XFlush when it is not safe to redisplay; the X
     connection may be broken.  */
  if (!NILP (Vinhibit_redisplay))
    return;

372 373 374 375 376
  BLOCK_INPUT;
  if (f == NULL)
    {
      Lisp_Object rest, frame;
      FOR_EACH_FRAME (rest, frame)
377 378
        if (FRAME_X_P (XFRAME (frame)))
          x_flush (XFRAME (frame));
379 380 381 382 383 384
    }
  else if (FRAME_X_P (f))
    XFlush (FRAME_X_DISPLAY (f));
  UNBLOCK_INPUT;
}

Jim Blandy's avatar
Jim Blandy committed
385

386 387 388 389 390 391 392
/* 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
393
#define XFlush(DISPLAY)	(void) 0
394

395

396 397 398 399
/***********************************************************************
			      Debugging
 ***********************************************************************/

400
#if 0
401 402 403

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

Juanma Barranquero's avatar
Juanma Barranquero committed
405
struct record
406 407 408 409 410 411 412 413 414
{
  char *locus;
  int type;
};

struct record event_record[100];

int event_record_index;

Andreas Schwab's avatar
Andreas Schwab committed
415 416
void
record_event (char *locus, int type)
417 418 419 420 421 422 423 424 425 426
{
  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 */
427 428


429

430 431 432
/* Return the struct x_display_info corresponding to DPY.  */

struct x_display_info *
433
x_display_info_for_display (Display *dpy)
434 435 436 437 438 439
{
  struct x_display_info *dpyinfo;

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

441 442
  return 0;
}
443

444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464
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;
}

465 466 467
#define OPAQUE  0xffffffff

void
468
x_set_frame_alpha (struct frame *f)
469 470 471 472
{
  struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
  Display *dpy = FRAME_X_DISPLAY (f);
  Window win = FRAME_OUTER_WINDOW (f);
473 474
  double alpha = 1.0;
  double alpha_min = 1.0;
475
  unsigned long opac;
476
  Window parent;
477

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

488 489 490
  if (alpha < 0.0)
    return;
  else if (alpha > 1.0)
491 492 493 494
    alpha = 1.0;
  else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
    alpha = alpha_min;

495
  opac = alpha * OPAQUE;
496

497 498 499 500 501 502 503 504 505 506 507 508 509
  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);

510 511 512 513
  /* return unless necessary */
  {
    unsigned char *data;
    Atom actual;
514
    int rc, format;
515 516
    unsigned long n, left;

517
    rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
518 519 520
			     0L, 1L, False, XA_CARDINAL,
			     &actual, &format, &n, &left,
			     &data);
521 522

    if (rc == Success && actual != None)
523
      {
524
        unsigned long value = *(unsigned long *)data;
525
	XFree ((void *) data);
526
	if (value == opac)
527 528 529 530 531
	  {
	    x_uncatch_errors ();
	    return;
	  }
      }
532 533
  }

534
  XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
535 536
		   XA_CARDINAL, 32, PropModeReplace,
		   (unsigned char *) &opac, 1L);
537
  x_uncatch_errors ();
538
}
539

540
int
541
x_display_pixel_height (struct x_display_info *dpyinfo)
542 543 544 545 546
{
  return HeightOfScreen (dpyinfo->screen);
}

int
547
x_display_pixel_width (struct x_display_info *dpyinfo)
548 549 550 551
{
  return WidthOfScreen (dpyinfo->screen);
}

552 553 554 555

/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
Juanma Barranquero's avatar
Juanma Barranquero committed
556

557 558 559 560 561
/* 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
562

Andreas Schwab's avatar
Andreas Schwab committed
563
static void
564
x_update_begin (struct frame *f)
565
{
566 567
  /* Nothing to do.  */
}
Jim Blandy's avatar
Jim Blandy committed
568 569


570 571 572
/* 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
573

574
static void
575
x_update_window_begin (struct window *w)
576 577
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
578
  Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
Juanma Barranquero's avatar
Juanma Barranquero committed
579

580 581
  updated_window = w;
  set_output_cursor (&w->cursor);
582

583
  BLOCK_INPUT;
584

585
  if (f == hlinfo->mouse_face_mouse_frame)
586
    {
587
      /* Don't do highlighting for mouse motion during the update.  */
588
      hlinfo->mouse_face_defer = 1;
589

590 591
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
592
      if (FRAME_GARBAGED_P (f))
593
	hlinfo->mouse_face_window = Qnil;
594
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
595

Jim Blandy's avatar
Jim Blandy committed
596 597 598
  UNBLOCK_INPUT;
}

599

600
/* Draw a vertical window border from (x,y0) to (x,y1)  */
601

Andreas Schwab's avatar
Andreas Schwab committed
602
static void
603
x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
604
{
605
  struct frame *f = XFRAME (WINDOW_FRAME (w));
606 607 608 609 610 611
  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);
612

613 614
  XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
	     f->output_data.x->normal_gc, x, y0, x, y1);
615
}
Juanma Barranquero's avatar
Juanma Barranquero committed
616

617 618 619 620 621 622 623 624 625 626 627 628
/* 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.  */
629 630

static void
631
x_update_window_end (struct window *w, int cursor_on_p, int mouse_face_overwritten_p)
632
{
633
  Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
Juanma Barranquero's avatar
Juanma Barranquero committed
634

635 636 637
  if (!w->pseudo_window_p)
    {
      BLOCK_INPUT;
638

639
      if (cursor_on_p)
640 641 642
	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
643

644 645
      if (draw_window_fringes (w, 1))
	x_draw_vertical_border (w);
Kenichi Handa's avatar
Kenichi Handa committed
646

647 648
      UNBLOCK_INPUT;
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
649

650 651 652 653
  /* If a row with mouse-face was overwritten, arrange for
     XTframe_up_to_date to redisplay the mouse highlight.  */
  if (mouse_face_overwritten_p)
    {
654 655 656
      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;
657
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
658

659 660
  updated_window = NULL;
}
Jim Blandy's avatar
Jim Blandy committed
661 662


663 664 665 666
/* End update of frame F.  This function is installed as a hook in
   update_end.  */

static void
667
x_update_end (struct frame *f)
668 669
{
  /* Mouse highlight may be displayed again.  */
670
  MOUSE_HL_INFO (f)->mouse_face_defer = 0;
671

672
#ifndef XFlush
673
  BLOCK_INPUT;
674
  XFlush (FRAME_X_DISPLAY (f));
Jim Blandy's avatar
Jim Blandy committed
675
  UNBLOCK_INPUT;
676
#endif
Jim Blandy's avatar
Jim Blandy committed
677
}
678

679 680 681 682

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

Andreas Schwab's avatar
Andreas Schwab committed
684
static void
685
XTframe_up_to_date (struct frame *f)
686
{
687
  if (FRAME_X_P (f))
688
    {
689
      Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
690

691 692
      if (hlinfo->mouse_face_deferred_gc
	  || f == hlinfo->mouse_face_mouse_frame)
693 694
	{
	  BLOCK_INPUT;
695 696 697 698 699
	  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;
700 701
	  UNBLOCK_INPUT;
	}
702
    }
703
}
704 705 706


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
707
   arrow bitmaps, or clear the fringes if no bitmaps are required
708 709 710 711 712 713
   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
714
x_after_update_window_line (struct glyph_row *desired_row)
715 716
{
  struct window *w = updated_window;
717
  struct frame *f;
718
  int width, height;
Juanma Barranquero's avatar
Juanma Barranquero committed
719

720
  xassert (w);
Juanma Barranquero's avatar
Juanma Barranquero committed
721

722
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
Kenichi Handa's avatar
Kenichi Handa committed
723
    desired_row->redraw_fringe_bitmaps_p = 1;
Juanma Barranquero's avatar
Juanma Barranquero committed
724

725 726 727 728 729 730 731 732 733 734
  /* 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
      && (f = XFRAME (w->frame),
	  width = FRAME_INTERNAL_BORDER_WIDTH (f),
735 736 737
	  width != 0)
      && (height = desired_row->visible_height,
	  height > 0))
738 739
    {
      int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
740

741 742 743 744
      BLOCK_INPUT;
      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),
745
		    FRAME_PIXEL_WIDTH (f) - width,
746
		    y, width, height, False);
747 748 749 750 751
      UNBLOCK_INPUT;
    }
}

static void
752
x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
753 754 755 756 757
{
  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
758
  struct face *face = p->face;
759 760

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

763
  if (!p->overlay_p)
764
    {
765 766
      int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;

767 768 769 770 771 772 773 774
      /* 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
775

776 777 778 779 780 781 782 783 784 785 786 787 788
#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)
	    {
789 790 791
	      int bar_area_x = WINDOW_SCROLL_BAR_AREA_X (w);
	      int bar_area_width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
				    * FRAME_COLUMN_WIDTH (f));
792 793 794 795

	      if (bx < 0)
		{
		  /* Bitmap fills the fringe.  */
796 797 798 799
		  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;
800 801 802 803
		  if (bx >= 0)
		    {
		      int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);

804
		      nx = bar_area_width - sb_width;
805 806 807 808 809 810 811
		      by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
							    row->y));
		      ny = row->visible_height;
		    }
		}
	      else
		{
812
		  if (bar_area_x + bar_area_width == bx)
813
		    {
814 815
		      bx = bar_area_x + sb_width;
		      nx += bar_area_width - sb_width;
816
		    }
817 818
		  else if (bx + nx == bar_area_x)
		    nx += bar_area_width - sb_width;
819 820 821 822 823 824
		}
	    }
	}
#endif
      if (bx >= 0 && nx > 0)
	XFillRectangle (display, window, face->gc, bx, by, nx, ny);
Kim F. Storm's avatar
Kim F. Storm committed
825

826 827 828 829
      if (!face->stipple)
	XSetForeground (display, face->gc, face->foreground);
    }

Kenichi Handa's avatar
Kenichi Handa committed
830
  if (p->which)
831
    {
832
      char *bits;
Kenichi Handa's avatar
Kenichi Handa committed
833
      Pixmap pixmap, clipmask = (Pixmap) 0;
Kim F. Storm's avatar
Kim F. Storm committed
834
      int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
Kenichi Handa's avatar
Kenichi Handa committed
835 836 837
      XGCValues gcv;

      if (p->wd > 8)
838
	bits = (char *) (p->bits + p->dh);
Kenichi Handa's avatar
Kenichi Handa committed
839
      else
840
	bits = (char *) p->bits + p->dh;
Kim F. Storm's avatar
Kim F. Storm committed
841

842 843
      /* Draw the bitmap.  I believe these small pixmaps can be cached
	 by the server.  */
Kim F. Storm's avatar
Kim F. Storm committed
844
      pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
Kenichi Handa's avatar
Kenichi Handa committed
845 846 847 848
					    (p->cursor_p
					     ? (p->overlay_p ? face->background
						: f->output_data.x->cursor_pixel)
					     : face->foreground),
849
					    face->background, depth);
Kenichi Handa's avatar
Kenichi Handa committed
850 851 852 853 854 855 856 857 858 859 860 861 862

      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
863 864
      XCopyArea (display, pixmap, window, gc, 0, 0,
		 p->wd, p->h, p->x, p->y);
865
      XFreePixmap (display, pixmap);
Kenichi Handa's avatar
Kenichi Handa committed
866 867 868 869 870 871 872

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

875 876 877
  XSetClipMask (display, gc, None);
}

Jim Blandy's avatar
Jim Blandy committed
878

879 880 881 882 883

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

Andreas Schwab's avatar
Andreas Schwab committed
885
static void
886
XTset_terminal_modes (struct terminal *terminal)
Jim Blandy's avatar
Jim Blandy committed
887 888 889
{
}

890 891
/* 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
892

Andreas Schwab's avatar
Andreas Schwab committed
893
static void
894
XTreset_terminal_modes (struct terminal *terminal)
Jim Blandy's avatar
Jim Blandy committed
895 896
{
}
897 898 899 900 901 902 903 904

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



905 906 907 908 909 910 911 912
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 *);
913
static void x_delete_glyphs (struct frame *, int) NO_RETURN;
914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933
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 *);
static int x_alloc_lighter_color (struct frame *, Display *, Colormap,
                                  unsigned long *, double, int);
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
934
static void x_scroll_bar_clear (struct frame *);
935 936

#if GLYPH_DEBUG
937
static void x_check_font (struct frame *, struct font *);
938
#endif
939 940 941 942 943 944


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

static void
945
x_set_cursor_gc (struct glyph_string *s)
946 947 948 949
{
  if (s->font == FRAME_FONT (s->f)
      && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
      && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
950
      && !s->cmp)
951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
    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;
979
      mask = GCForeground | GCBackground | GCGraphicsExposures;
980 981 982 983 984 985 986 987 988 989 990 991 992 993

      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
994

995
static void
996
x_set_mouse_face_gc (struct glyph_string *s)
Juanma Barranquero's avatar
Juanma Barranquero committed
997
{
998
  int face_id;
999
  struct face *face;
1000

1001
  /* What face has to be used last for the mouse face?  */
1002
  face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
1003
  face = FACE_FROM_ID (s->f, face_id);
1004 1005
  if (face == NULL)
    face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
Juanma Barranquero's avatar
Juanma Barranquero committed
1006

1007
  if (s->first_glyph->type == CHAR_GLYPH)
1008
    face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1009
  else
1010
    face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1011 1012 1013 1014 1015 1016 1017 1018
  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
1019
	 except for FONT.  */
1020 1021
      XGCValues xgcv;
      unsigned long mask;
Juanma Barranquero's avatar
Juanma Barranquero committed
1022

1023 1024 1025
      xgcv.background = s->face->background;
      xgcv.foreground = s->face->foreground;
      xgcv.graphics_exposures = False;
1026
      mask = GCForeground | GCBackground | GCGraphicsExposures;
Juanma Barranquero's avatar
Juanma Barranquero committed
1027

1028 1029 1030 1031 1032 1033
      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
1034

1035 1036
      s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;

1037
    }
1038 1039 1040 1041 1042 1043 1044 1045
  xassert (s->gc != 0);
}


/* 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
1046
static inline void
1047
x_set_mode_line_face_gc (struct glyph_string *s)
Juanma Barranquero's avatar
Juanma Barranquero committed
1048
{
1049 1050 1051 1052 1053 1054 1055 1056
  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
1057
static inline void
1058
x_set_glyph_string_gc (struct glyph_string *s)
1059
{
1060
  PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
Juanma Barranquero's avatar
Juanma Barranquero committed
1061

1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
  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.  */
  xassert (s->gc != 0);
}


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

Paul Eggert's avatar
Paul Eggert committed
1102
static inline void
1103
x_set_glyph_string_clipping (struct glyph_string *s)
1104
{
1105 1106 1107 1108 1109 1110
  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;
1111 1112 1113
}


1114 1115