xterm.c 318 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* X Communication module for terminals which understand the X protocol.
2
   Copyright (C) 1989, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
Glenn Morris's avatar
Glenn Morris committed
3
                 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
Glenn Morris's avatar
Glenn Morris committed
4
                 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
12 13 14 15 16 17 18

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

21
/* New display code by Gerd Moellmann <gerd@gnu.org>.  */
22 23
/* Xt features made by Fred Pierresteguy.  */

24 25
#include <config.h>

26 27 28 29
/* On 4.3 these lose if they come after xterm.h.  */
/* Putting these at the beginning seems to be standard for other .c files.  */
#include <signal.h>

30 31
#include <stdio.h>

Jim Blandy's avatar
Jim Blandy committed
32 33 34
#ifdef HAVE_X_WINDOWS

#include "lisp.h"
35
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
36

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

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

52
#ifdef BSD_SYSTEM
Jim Blandy's avatar
Jim Blandy committed
53
#include <sys/ioctl.h>
54
#endif /* ! defined (BSD_SYSTEM) */
Jim Blandy's avatar
Jim Blandy committed
55

Jim Blandy's avatar
Jim Blandy committed
56
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
57

58
#ifndef INCLUDED_FCNTL
Jim Blandy's avatar
Jim Blandy committed
59
#include <fcntl.h>
60
#endif
Jim Blandy's avatar
Jim Blandy committed
61 62 63 64
#include <ctype.h>
#include <errno.h>
#include <setjmp.h>
#include <sys/stat.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
65 66
/* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed.  */
/* #include <sys/param.h>  */
Jim Blandy's avatar
Jim Blandy committed
67

68
#include "charset.h"
Kenichi Handa's avatar
Kenichi Handa committed
69
#include "character.h"
Kenichi Handa's avatar
Kenichi Handa committed
70
#include "coding.h"
71
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
72
#include "dispextern.h"
73
#include "fontset.h"
Jim Blandy's avatar
Jim Blandy committed
74 75 76
#include "termhooks.h"
#include "termopts.h"
#include "termchar.h"
77
#include "emacs-icon.h"
Jim Blandy's avatar
Jim Blandy committed
78 79
#include "disptab.h"
#include "buffer.h"
80
#include "window.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
81
#include "keyboard.h"
Karl Heuer's avatar
Karl Heuer committed
82
#include "intervals.h"
Andreas Schwab's avatar
Andreas Schwab committed
83
#include "process.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
84
#include "atimer.h"
Stefan Monnier's avatar
Stefan Monnier committed
85
#include "keymap.h"
86
#include "font.h"
87
#include "fontset.h"
Jim Blandy's avatar
Jim Blandy committed
88

89 90 91 92
#ifdef USE_X_TOOLKIT
#include <X11/Shell.h>
#endif

93 94 95 96 97 98 99
#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

Jan Djärv's avatar
Jan Djärv committed
100 101 102 103
#ifdef USE_GTK
#include "gtkutil.h"
#endif

104
#ifdef USE_LUCID
Dave Love's avatar
Dave Love committed
105
extern int xlwmenu_window_p P_ ((Widget w, Window window));
106 107 108
extern void xlwmenu_redisplay P_ ((Widget));
#endif

Jan Djärv's avatar
Jan Djärv committed
109
#if defined (USE_X_TOOLKIT) || defined (USE_GTK)
110

Gerd Moellmann's avatar
Gerd Moellmann committed
111 112 113
extern void free_frame_menubar P_ ((struct frame *));
extern struct frame *x_menubar_window_to_frame P_ ((struct x_display_info *,
						    int));
Jan Djärv's avatar
Jan Djärv committed
114
#endif
115

Jan Djärv's avatar
Jan Djärv committed
116
#ifdef USE_X_TOOLKIT
117 118 119 120
#if (XtSpecificationRelease >= 5) && !defined(NO_EDITRES)
#define HACK_EDITRES
extern void _XEditResCheckMessages ();
#endif /* not NO_EDITRES */
121 122 123 124 125 126 127

/* 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>
128 129 130
#else /* !USE_MOTIF i.e. use Xaw */

#ifdef HAVE_XAW3D
131 132
#include <X11/Xaw3d/Simple.h>
#include <X11/Xaw3d/Scrollbar.h>
133
#include <X11/Xaw3d/ThreeD.h>
134 135 136 137 138 139 140 141
#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 */
142 143
#endif /* USE_TOOLKIT_SCROLL_BARS */

144 145
#endif /* USE_X_TOOLKIT */

Jan Djärv's avatar
Jan Djärv committed
146
#if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
147
#define x_any_window_to_frame x_window_to_frame
148
#define x_top_window_to_frame x_window_to_frame
149 150
#endif

151
#ifdef USE_X_TOOLKIT
Karl Heuer's avatar
Karl Heuer committed
152
#include "widget.h"
153 154 155 156 157
#ifndef XtNinitialState
#define XtNinitialState "initialState"
#endif
#endif

Dave Love's avatar
Dave Love committed
158
/* Default to using XIM if available.  */
159
#ifdef USE_XIM
Dave Love's avatar
Dave Love committed
160
int use_xim = 1;
161 162 163 164
#else
int use_xim = 0;  /* configure --without-xim */
#endif

165 166


167
/* Non-nil means Emacs uses toolkit scroll bars.  */
168

169
Lisp_Object Vx_toolkit_scroll_bars;
170 171 172 173 174 175

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

static int any_help_event_p;

176
/* Last window where we saw the mouse.  Used by mouse-autoselect-window.  */
177
static Lisp_Object last_window;
178

179 180 181 182
/* Non-zero means make use of UNDERLINE_POSITION font properties.  */

int x_use_underline_position_properties;

183 184 185 186
/* Non-zero means to draw the underline at the same place as the descent line.  */

int x_underline_at_descent_line;

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

190
struct x_display_info *x_display_list;
Jim Blandy's avatar
Jim Blandy committed
191

192 193 194 195 196
/* 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.  */

197
Lisp_Object x_display_name_list;
198

199
/* Frame being updated by update_frame.  This is declared in term.c.
200 201 202 203
   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.  */

204
extern struct frame *updating_frame;
Jim Blandy's avatar
Jim Blandy committed
205

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

208 209
struct frame *pending_autoraise_frame;

210 211 212
#ifdef USE_X_TOOLKIT
/* The application context for Xt use.  */
XtAppContext Xt_app_con;
213 214
static String Xt_default_resources[] = {0};
#endif /* USE_X_TOOLKIT */
215

Gerd Moellmann's avatar
Gerd Moellmann committed
216 217 218
/* Non-zero means user is interacting with a toolkit scroll bar.  */

static int toolkit_scroll_bar_interaction;
Jim Blandy's avatar
Jim Blandy committed
219

Kenichi Handa's avatar
Kenichi Handa committed
220 221 222 223 224 225 226 227 228 229 230
/* Non-zero means to not move point as a result of clicking on a
   frame to focus it (when focus-follows-mouse is nil).  */

int x_mouse_click_focus_ignore_position;

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

231 232
/* Mouse movement.

233
   Formerly, we used PointerMotionHintMask (in standard_event_mask)
234 235 236 237 238 239
   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.

240 241 242 243 244 245 246 247 248
   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
249
   is off.  */
250 251 252

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

253
static XRectangle last_mouse_glyph;
Kim F. Storm's avatar
Kim F. Storm committed
254
static FRAME_PTR last_mouse_glyph_frame;
255 256
static Lisp_Object last_mouse_press_frame;

257 258
/* The scroll bar in which the last X motion event occurred.

259 260
   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
261 262
   an ordinary motion.

263 264 265 266
   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.  */

267 268 269 270
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
271
   doesn't seem to be any way to wrest the time-stamp from the server
272 273 274
   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.  */
275

276 277
static Time last_mouse_movement_time;

Jan Djärv's avatar
Jan Djärv committed
278 279 280 281
/* Time for last user interaction as returned in X events.  */

static Time last_user_time;

282 283 284
/* Incremented by XTread_socket whenever it really tries to read
   events.  */

285 286 287 288 289 290
#ifdef __STDC__
static int volatile input_signal_count;
#else
static int input_signal_count;
#endif

291
/* Used locally within XTread_socket.  */
292

293
static int x_noop_count;
Jim Blandy's avatar
Jim Blandy committed
294

295
/* Initial values of argv and argc.  */
296

297 298
extern char **initial_argv;
extern int initial_argc;
Jim Blandy's avatar
Jim Blandy committed
299

300
extern Lisp_Object Vcommand_line_args, Vsystem_name;
Jim Blandy's avatar
Jim Blandy committed
301

302
/* Tells if a window manager is present or not.  */
303 304

extern Lisp_Object Vx_no_window_manager;
Jim Blandy's avatar
Jim Blandy committed
305

Kenichi Handa's avatar
Kenichi Handa committed
306
extern Lisp_Object Qeql;
307

Jim Blandy's avatar
Jim Blandy committed
308 309
extern int errno;

310
/* A mask of extra modifier bits to put into every keyboard char.  */
311

312
extern EMACS_INT extra_keyboard_modifiers;
313

314 315 316
/* The keysyms to use for the various modifiers.  */

Lisp_Object Vx_alt_keysym, Vx_hyper_keysym, Vx_meta_keysym, Vx_super_keysym;
Dave Love's avatar
Dave Love committed
317
Lisp_Object Vx_keysym_table;
318 319
static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;

320
static Lisp_Object Qvendor_specific_keysyms;
Dave Love's avatar
Dave Love committed
321
static Lisp_Object Qlatin_1;
322

323 324 325 326
/* Used in x_flush.  */

extern Lisp_Object Vinhibit_redisplay;

Gerd Moellmann's avatar
Gerd Moellmann committed
327
extern XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
Dave Love's avatar
Dave Love committed
328
extern int x_bitmap_mask P_ ((FRAME_PTR, int));
329

330
static int x_alloc_nearest_color_1 P_ ((Display *, Colormap, XColor *));
331
static void x_set_window_size_1 P_ ((struct frame *, int, int, int));
332
static const XColor *x_color_cells P_ ((Display *, int *));
333
static void x_update_window_end P_ ((struct window *, int, int));
334

335
static int x_io_error_quitter P_ ((Display *));
336 337
static struct terminal *x_create_terminal P_ ((struct x_display_info *));
void x_delete_terminal P_ ((struct terminal *));
338 339
static void x_update_end P_ ((struct frame *));
static void XTframe_up_to_date P_ ((struct frame *));
340 341
static void XTset_terminal_modes P_ ((struct terminal *));
static void XTreset_terminal_modes P_ ((struct terminal *));
Karoly Lorentey's avatar
Karoly Lorentey committed
342
static void x_clear_frame P_ ((struct frame *));
343 344 345
static void frame_highlight P_ ((struct frame *));
static void frame_unhighlight P_ ((struct frame *));
static void x_new_focus_frame P_ ((struct x_display_info *, struct frame *));
Kenichi Handa's avatar
Kenichi Handa committed
346 347 348 349
static void  x_focus_changed P_ ((int, int, struct x_display_info *,
				  struct frame *, struct input_event *));
static void x_detect_focus_change P_ ((struct x_display_info *,
                                       XEvent *, struct input_event *));
350 351 352
static void XTframe_rehighlight P_ ((struct frame *));
static void x_frame_rehighlight P_ ((struct x_display_info *));
static void x_draw_hollow_cursor P_ ((struct window *, struct glyph_row *));
353 354
static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int,
				   enum text_cursor_kinds));
355

356
static void x_clip_to_row P_ ((struct window *, struct glyph_row *, int, GC));
357
static void x_flush P_ ((struct frame *f));
Gerd Moellmann's avatar
Gerd Moellmann committed
358 359 360
static void x_update_begin P_ ((struct frame *));
static void x_update_window_begin P_ ((struct window *));
static void x_after_update_window_line P_ ((struct glyph_row *));
Kenichi Handa's avatar
Kenichi Handa committed
361
static struct scroll_bar *x_window_to_scroll_bar P_ ((Display *, Window));
Gerd Moellmann's avatar
Gerd Moellmann committed
362 363 364 365
static void x_scroll_bar_report_motion P_ ((struct frame **, Lisp_Object *,
					    enum scroll_bar_part *,
					    Lisp_Object *, Lisp_Object *,
					    unsigned long *));
366
static void x_handle_net_wm_state P_ ((struct frame *, XPropertyEvent *));
367
static void x_check_fullscreen P_ ((struct frame *));
368 369
static void x_check_expected_move P_ ((struct frame *, int, int));
static void x_sync_with_move P_ ((struct frame *, int, int, int));
Kenichi Handa's avatar
Kenichi Handa committed
370 371
static int handle_one_xevent P_ ((struct x_display_info *, XEvent *,
				  int *, struct input_event *));
372 373 374
/* Don't declare this NO_RETURN because we want no
   interference with debugging failing X calls.  */
static SIGTYPE x_connection_closed P_ ((Display *, char *));
Jan Djärv's avatar
Jan Djärv committed
375

376 377 378 379 380 381 382

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

static void
x_flush (f)
     struct frame *f;
{
383 384 385 386 387
  /* Don't call XFlush when it is not safe to redisplay; the X
     connection may be broken.  */
  if (!NILP (Vinhibit_redisplay))
    return;

388 389 390 391 392
  BLOCK_INPUT;
  if (f == NULL)
    {
      Lisp_Object rest, frame;
      FOR_EACH_FRAME (rest, frame)
393 394
        if (FRAME_X_P (XFRAME (frame)))
          x_flush (XFRAME (frame));
395 396 397 398 399 400
    }
  else if (FRAME_X_P (f))
    XFlush (FRAME_X_DISPLAY (f));
  UNBLOCK_INPUT;
}

Jim Blandy's avatar
Jim Blandy committed
401

402 403 404 405 406 407 408
/* 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
409
#define XFlush(DISPLAY)	(void) 0
410

411

412 413 414 415
/***********************************************************************
			      Debugging
 ***********************************************************************/

416
#if 0
417 418 419

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

Juanma Barranquero's avatar
Juanma Barranquero committed
421
struct record
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
{
  char *locus;
  int type;
};

struct record event_record[100];

int event_record_index;

record_event (locus, type)
     char *locus;
     int type;
{
  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 */
444 445


446

447 448 449 450 451 452 453 454 455 456 457
/* Return the struct x_display_info corresponding to DPY.  */

struct x_display_info *
x_display_info_for_display (dpy)
     Display *dpy;
{
  struct x_display_info *dpyinfo;

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

459 460
  return 0;
}
461

462 463 464 465 466 467 468 469 470 471
#define OPAQUE  0xffffffff
#define OPACITY "_NET_WM_WINDOW_OPACITY"

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

476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
  if (FRAME_X_DISPLAY_INFO (f)->root_window != FRAME_X_OUTPUT (f)->parent_desc)
    /* Since the WM decoration lies under the FRAME_OUTER_WINDOW,
       we must treat the former instead of the latter. */
    win = FRAME_X_OUTPUT(f)->parent_desc;

  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;

491 492 493
  if (alpha < 0.0)
    return;
  else if (alpha > 1.0)
494 495 496 497
    alpha = 1.0;
  else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
    alpha = alpha_min;

498
  opac = alpha * OPAQUE;
499 500 501 502 503

  /* return unless necessary */
  {
    unsigned char *data;
    Atom actual;
504
    int rc, format;
505 506
    unsigned long n, left;

507 508 509 510 511 512 513
    x_catch_errors (dpy);
    rc = XGetWindowProperty(dpy, win, XInternAtom(dpy, OPACITY, False),
			    0L, 1L, False, XA_CARDINAL,
			    &actual, &format, &n, &left,
			    &data);

    if (rc == Success && actual != None)
514
      if (*(unsigned long *)data == opac)
515 516
	{
	  XFree ((void *) data);
517
	  x_uncatch_errors ();
518 519 520
	  return;
	}
      else
521
	XFree ((void *) data);
522
    x_uncatch_errors ();
523 524
  }

525
  x_catch_errors (dpy);
526 527 528
  XChangeProperty (dpy, win, XInternAtom (dpy, OPACITY, False),
		   XA_CARDINAL, 32, PropModeReplace,
		   (unsigned char *) &opac, 1L);
529
  x_uncatch_errors ();
530
}
531

532 533 534 535 536 537 538 539 540 541 542 543 544 545
int
x_display_pixel_height (dpyinfo)
     struct x_display_info *dpyinfo;
{
  return HeightOfScreen (dpyinfo->screen);
}

int
x_display_pixel_width (dpyinfo)
     struct x_display_info *dpyinfo;
{
  return WidthOfScreen (dpyinfo->screen);
}

546 547 548 549

/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
Juanma Barranquero's avatar
Juanma Barranquero committed
550

551 552 553 554 555
/* 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
556

Andreas Schwab's avatar
Andreas Schwab committed
557
static void
558
x_update_begin (f)
Jim Blandy's avatar
Jim Blandy committed
559
     struct frame *f;
560
{
561 562
  /* Nothing to do.  */
}
Jim Blandy's avatar
Jim Blandy committed
563 564


565 566 567
/* 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
568

569 570 571 572 573 574
static void
x_update_window_begin (w)
     struct window *w;
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  struct x_display_info *display_info = FRAME_X_DISPLAY_INFO (f);
Juanma Barranquero's avatar
Juanma Barranquero committed
575

576 577
  updated_window = w;
  set_output_cursor (&w->cursor);
578

579
  BLOCK_INPUT;
580

581
  if (f == display_info->mouse_face_mouse_frame)
582
    {
583
      /* Don't do highlighting for mouse motion during the update.  */
584
      display_info->mouse_face_defer = 1;
585

586 587
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
588
      if (FRAME_GARBAGED_P (f))
589 590
	display_info->mouse_face_window = Qnil;

591 592 593 594 595 596
#if 0 /* Rows in a current matrix containing glyphs in mouse-face have
	 their mouse_face_p flag set, which means that they are always
	 unequal to rows in a desired matrix which never have that
	 flag set.  So, rows containing mouse-face glyphs are never
	 scrolled, and we don't have to switch the mouse highlight off
	 here to prevent it from being scrolled.  */
Juanma Barranquero's avatar
Juanma Barranquero committed
597

598 599 600 601 602 603 604
      /* Can we tell that this update does not affect the window
	 where the mouse highlight is?  If so, no need to turn off.
	 Likewise, don't do anything if the frame is garbaged;
	 in that case, the frame's current matrix that we would use
	 is all wrong, and we will redisplay that line anyway.  */
      if (!NILP (display_info->mouse_face_window)
	  && w == XWINDOW (display_info->mouse_face_window))
605
	{
606
	  int i;
607

608 609
	  for (i = 0; i < w->desired_matrix->nrows; ++i)
	    if (MATRIX_ROW_ENABLED_P (w->desired_matrix, i))
610 611
	      break;

612 613
	  if (i < w->desired_matrix->nrows)
	    clear_mouse_face (display_info);
614
	}
615
#endif /* 0 */
616
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
617

Jim Blandy's avatar
Jim Blandy committed
618 619 620
  UNBLOCK_INPUT;
}

621

622
/* Draw a vertical window border from (x,y0) to (x,y1)  */
623

Andreas Schwab's avatar
Andreas Schwab committed
624
static void
625
x_draw_vertical_window_border (w, x, y0, y1)
626
     struct window *w;
627
     int x, y0, y1;
628
{
629
  struct frame *f = XFRAME (WINDOW_FRAME (w));
630 631 632 633 634 635
  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);
636

637 638
  XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
	     f->output_data.x->normal_gc, x, y0, x, y1);
639
}
Juanma Barranquero's avatar
Juanma Barranquero committed
640

641 642 643 644 645 646 647 648 649 650 651 652
/* 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.  */
653 654

static void
655
x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
656
     struct window *w;
657
     int cursor_on_p, mouse_face_overwritten_p;
658
{
659
  struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
Juanma Barranquero's avatar
Juanma Barranquero committed
660

661 662 663
  if (!w->pseudo_window_p)
    {
      BLOCK_INPUT;
664

665
      if (cursor_on_p)
666 667 668
	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
669

670 671
      if (draw_window_fringes (w, 1))
	x_draw_vertical_border (w);
Kenichi Handa's avatar
Kenichi Handa committed
672

673 674
      UNBLOCK_INPUT;
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
675

676 677 678 679 680 681 682 683
  /* If a row with mouse-face was overwritten, arrange for
     XTframe_up_to_date to redisplay the mouse highlight.  */
  if (mouse_face_overwritten_p)
    {
      dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
      dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
      dpyinfo->mouse_face_window = Qnil;
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
684

685 686
  updated_window = NULL;
}
Jim Blandy's avatar
Jim Blandy committed
687 688


689 690 691 692 693 694 695 696
/* End update of frame F.  This function is installed as a hook in
   update_end.  */

static void
x_update_end (f)
     struct frame *f;
{
  /* Mouse highlight may be displayed again.  */
697
  FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
698

699
#ifndef XFlush
700
  BLOCK_INPUT;
701
  XFlush (FRAME_X_DISPLAY (f));
Jim Blandy's avatar
Jim Blandy committed
702
  UNBLOCK_INPUT;
703
#endif
Jim Blandy's avatar
Jim Blandy committed
704
}
705

706 707 708 709

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

Andreas Schwab's avatar
Andreas Schwab committed
711
static void
712
XTframe_up_to_date (f)
713
     struct frame *f;
714
{
715
  if (FRAME_X_P (f))
716
    {
717
      struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
718

719 720 721 722 723 724 725 726 727 728 729
      if (dpyinfo->mouse_face_deferred_gc
	  || f == dpyinfo->mouse_face_mouse_frame)
	{
	  BLOCK_INPUT;
	  if (dpyinfo->mouse_face_mouse_frame)
	    note_mouse_highlight (dpyinfo->mouse_face_mouse_frame,
				  dpyinfo->mouse_face_mouse_x,
				  dpyinfo->mouse_face_mouse_y);
	  dpyinfo->mouse_face_deferred_gc = 0;
	  UNBLOCK_INPUT;
	}
730
    }
731
}
732 733 734


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
735
   arrow bitmaps, or clear the fringes if no bitmaps are required
736 737 738 739 740 741 742 743 744 745
   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
x_after_update_window_line (desired_row)
     struct glyph_row *desired_row;
{
  struct window *w = updated_window;
746
  struct frame *f;
747
  int width, height;
Juanma Barranquero's avatar
Juanma Barranquero committed
748

749
  xassert (w);
Juanma Barranquero's avatar
Juanma Barranquero committed
750

751
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
Kenichi Handa's avatar
Kenichi Handa committed
752
    desired_row->redraw_fringe_bitmaps_p = 1;
Juanma Barranquero's avatar
Juanma Barranquero committed
753

754 755 756 757 758 759 760 761 762 763
  /* 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),
764 765 766
	  width != 0)
      && (height = desired_row->visible_height,
	  height > 0))
767 768
    {
      int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
769

770 771 772 773
      /* Internal border is drawn below the tool bar.  */
      if (WINDOWP (f->tool_bar_window)
	  && w == XWINDOW (f->tool_bar_window))
	y -= width;
Juanma Barranquero's avatar
Juanma Barranquero committed
774

775 776 777 778
      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),
779
		    FRAME_PIXEL_WIDTH (f) - width,
780
		    y, width, height, False);
781 782 783 784 785
      UNBLOCK_INPUT;
    }
}

static void
Kim F. Storm's avatar
Kim F. Storm committed
786
x_draw_fringe_bitmap (w, row, p)
787 788
     struct window *w;
     struct glyph_row *row;
Kim F. Storm's avatar
Kim F. Storm committed
789
     struct draw_fringe_bitmap_params *p;
790 791 792 793 794
{
  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
795
  struct face *face = p->face;
Kenichi Handa's avatar
Kenichi Handa committed
796
  int rowY;
797 798

  /* Must clip because of partially visible lines.  */
Kenichi Handa's avatar
Kenichi Handa committed
799 800 801 802 803 804 805 806 807
  rowY = WINDOW_TO_FRAME_PIXEL_Y (w, row->y);
  if (p->y < rowY)
    {
      /* Adjust position of "bottom aligned" bitmap on partially
	 visible last row.  */
      int oldY = row->y;
      int oldVH = row->visible_height;
      row->visible_height = p->h;
      row->y -= rowY - p->y;
808
      x_clip_to_row (w, row, -1, gc);
Kenichi Handa's avatar
Kenichi Handa committed
809 810 811 812
      row->y = oldY;
      row->visible_height = oldVH;
    }
  else
813
    x_clip_to_row (w, row, -1, gc);
814

815
  if (!p->overlay_p)
816
    {
817 818
      int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;

819 820 821 822 823 824 825 826
      /* 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
827

828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876
#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)
	    {
	      int left = WINDOW_SCROLL_BAR_AREA_X (w);
	      int width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
			   * FRAME_COLUMN_WIDTH (f));

	      if (bx < 0)
		{
		  /* Bitmap fills the fringe.  */
		  if (left + width == p->x)
		    bx = left + sb_width;
		  else if (p->x + p->wd == left)
		    bx = left;
		  if (bx >= 0)
		    {
		      int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);

		      nx = width - sb_width;
		      by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
							    row->y));
		      ny = row->visible_height;
		    }
		}
	      else
		{
		  if (left + width == bx)
		    {
		      bx = left + sb_width;
		      nx += width - sb_width;
		    }
		  else if (bx + nx == left)
		    nx += width - sb_width;
		}
	    }
	}
#endif
      if (bx >= 0 && nx > 0)
	XFillRectangle (display, window, face->gc, bx, by, nx, ny);
Kim F. Storm's avatar
Kim F. Storm committed
877

878 879 880 881
      if (!face->stipple)
	XSetForeground (display, face->gc, face->foreground);
    }

Kenichi Handa's avatar
Kenichi Handa committed
882
  if (p->which)
883
    {
Kenichi Handa's avatar
Kenichi Handa committed
884 885
      unsigned char *bits;
      Pixmap pixmap, clipmask = (Pixmap) 0;
Kim F. Storm's avatar
Kim F. Storm committed
886
      int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
Kenichi Handa's avatar
Kenichi Handa committed
887 888 889 890 891 892
      XGCValues gcv;

      if (p->wd > 8)
	bits = (unsigned char *)(p->bits + p->dh);
      else
	bits = (unsigned char *)p->bits + p->dh;
Kim F. Storm's avatar
Kim F. Storm committed
893

894 895
      /* Draw the bitmap.  I believe these small pixmaps can be cached
	 by the server.  */
Kim F. Storm's avatar
Kim F. Storm committed
896
      pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
Kenichi Handa's avatar
Kenichi Handa committed
897 898 899 900
					    (p->cursor_p
					     ? (p->overlay_p ? face->background
						: f->output_data.x->cursor_pixel)
					     : face->foreground),
901
					    face->background, depth);
Kenichi Handa's avatar
Kenichi Handa committed
902 903 904 905 906 907 908 909 910 911 912 913 914

      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
915 916
      XCopyArea (display, pixmap, window, gc, 0, 0,
		 p->wd, p->h, p->x, p->y);
917
      XFreePixmap (display, pixmap);
Kenichi Handa's avatar
Kenichi Handa committed
918 919 920 921 922 923 924

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

927 928 929
  XSetClipMask (display, gc, None);
}

Jim Blandy's avatar
Jim Blandy committed
930

931 932 933 934 935

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

Andreas Schwab's avatar
Andreas Schwab committed
937
static void
938
XTset_terminal_modes (struct terminal *terminal)
Jim Blandy's avatar
Jim Blandy committed
939 940 941
{
}

942 943
/* 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
944

Andreas Schwab's avatar
Andreas Schwab committed
945
static void
946
XTreset_terminal_modes (struct terminal *terminal)
Jim Blandy's avatar
Jim Blandy committed
947 948
{
}
949 950 951 952 953 954 955 956 957 958 959 960 961

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



static void x_set_glyph_string_clipping P_ ((struct glyph_string *));
static void x_set_glyph_string_gc P_ ((struct glyph_string *));
static void x_draw_glyph_string_background P_ ((struct glyph_string *,
						int));
static void x_draw_glyph_string_foreground P_ ((struct glyph_string *));
962
static void x_draw_composite_glyph_string_foreground P_ ((struct glyph_string *));
963 964 965 966 967 968 969
static void x_draw_glyph_string_box P_ ((struct glyph_string *));
static void x_draw_glyph_string  P_ ((struct glyph_string *));
static void x_compute_glyph_string_overhangs P_ ((struct glyph_string *));
static void x_set_cursor_gc P_ ((struct glyph_string *));
static void x_set_mode_line_face_gc P_ ((struct glyph_string *));
static void x_set_mouse_face_gc P_ ((struct glyph_string *));
static int x_alloc_lighter_color P_ ((struct frame *, Display *, Colormap,
970
				      unsigned long *, double, int));
971
static void x_setup_relief_color P_ ((struct frame *, struct relief *,
972
				      double, int, unsigned long));
973 974 975 976 977 978 979 980
static void x_setup_relief_colors P_ ((struct glyph_string *));
static void x_draw_image_glyph_string P_ ((struct glyph_string *));
static void x_draw_image_relief P_ ((struct glyph_string *));
static void x_draw_image_foreground P_ ((struct glyph_string *));
static void x_draw_image_foreground_1 P_ ((struct glyph_string *, Pixmap));
static void x_clear_glyph_string_rect P_ ((struct glyph_string *, int,
					   int, int, int));
static void x_draw_relief_rect P_ ((struct frame *, int, int, int, int,
981 982
				    int, int, int, int, int, int,
				    XRectangle *));
983 984
static void x_draw_box_rect P_ ((struct glyph_string *, int, int, int, int,
				 int, int, int, XRectangle *));
985 986

#if GLYPH_DEBUG
987
static void x_check_font P_ ((struct frame *, struct font *));
988
#endif
989 990 991 992 993 994 995 996 997 998 999 1000


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

static void
x_set_cursor_gc (s)
     struct glyph_string *s;
{
  if (s->font == FRAME_FONT (s->f)
      && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
      && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
1001
      && !s->cmp)
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
    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;
1030
      mask = GCForeground | GCBackground | GCGraphicsExposures;
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044

      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
1045

1046 1047 1048
static void
x_set_mouse_face_gc (s)
     struct glyph_string *s;
Juanma Barranquero's avatar
Juanma Barranquero committed
1049
{
1050
  int face_id;
1051
  struct face *face;
1052

1053
  /* What face has to be used last for the mouse face?  */
1054
  face_id = FRAME_X_DISPLAY_INFO (s->f)->mouse_face_face_id;
1055
  face = FACE_FROM_ID (s->f, face_id);
1056 1057
  if (face == NULL)
    face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
Juanma Barranquero's avatar
Juanma Barranquero committed
1058

1059
  if (s->first_glyph->type == CHAR_GLYPH)
1060
    face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1061
  else
1062
    face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1063 1064 1065 1066 1067 1068 1069 1070
  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
1071
	 except for FONT.  */
1072 1073
      XGCValues xgcv;
      unsigned long mask;
Juanma Barranquero's avatar
Juanma Barranquero committed
1074

1075 1076 1077
      xgcv.background = s->face->background;
      xgcv.foreground = s->face->foreground;
      xgcv.graphics_exposures = False;
1078
      mask = GCForeground | GCBackground | GCGraphicsExposures;
Juanma Barranquero's avatar
Juanma Barranquero committed
1079

1080 1081 1082 1083 1084 1085
      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
1086

1087 1088
      s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;

1089
    }
1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
  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.  */

static INLINE void
x_set_mode_line_face_gc (s)
     struct glyph_string *s;
Juanma Barranquero's avatar
Juanma Barranquero committed
1101
{
1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
  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.  */