xterm.c 312 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 4
                 2002, 2003, 2004, 2005, 2006, 2007, 2008
                 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"
Jim Blandy's avatar
Jim Blandy committed
87

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

92 93 94 95 96 97 98
#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
99 100 101 102
#ifdef USE_GTK
#include "gtkutil.h"
#endif

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
110 111 112
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
113
#endif
114

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

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

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

143 144
#endif /* USE_X_TOOLKIT */

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

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

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

164 165


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

168
Lisp_Object Vx_toolkit_scroll_bars;
169 170 171 172 173 174

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

static int any_help_event_p;

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

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

int x_use_underline_position_properties;

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

int x_underline_at_descent_line;

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

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

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

196
Lisp_Object x_display_name_list;
197

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

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

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

207 208
struct frame *pending_autoraise_frame;

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
219 220 221 222 223 224 225 226 227 228 229
/* 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;

230 231
/* Mouse movement.

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

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

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

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

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

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

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

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

275 276
static Time last_mouse_movement_time;

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

static Time last_user_time;

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

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

290
/* Used locally within XTread_socket.  */
291

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

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

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

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

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

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

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

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

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

311
extern EMACS_INT extra_keyboard_modifiers;
312

313 314 315
/* 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
316
Lisp_Object Vx_keysym_table;
317 318
static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;

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

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

extern Lisp_Object Vinhibit_redisplay;

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

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

334
static int x_io_error_quitter P_ ((Display *));
335 336
static struct terminal *x_create_terminal P_ ((struct x_display_info *));
void x_delete_terminal P_ ((struct terminal *));
337 338
static void x_update_end P_ ((struct frame *));
static void XTframe_up_to_date P_ ((struct frame *));
339 340
static void XTset_terminal_modes P_ ((struct terminal *));
static void XTreset_terminal_modes P_ ((struct terminal *));
Karoly Lorentey's avatar
Karoly Lorentey committed
341
static void x_clear_frame P_ ((struct frame *));
342 343 344
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
345 346 347 348
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 *));
349 350 351
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 *));
352 353
static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int,
				   enum text_cursor_kinds));
354

355
static void x_clip_to_row P_ ((struct window *, struct glyph_row *, int, GC));
356
static void x_flush P_ ((struct frame *f));
Gerd Moellmann's avatar
Gerd Moellmann committed
357 358 359
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
360
static struct scroll_bar *x_window_to_scroll_bar P_ ((Display *, Window));
Gerd Moellmann's avatar
Gerd Moellmann committed
361 362 363 364
static void x_scroll_bar_report_motion P_ ((struct frame **, Lisp_Object *,
					    enum scroll_bar_part *,
					    Lisp_Object *, Lisp_Object *,
					    unsigned long *));
365
static void x_check_fullscreen P_ ((struct frame *));
366 367
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
368 369
static int handle_one_xevent P_ ((struct x_display_info *, XEvent *,
				  int *, struct input_event *));
370 371 372
/* 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
373

374 375 376 377 378 379 380

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

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

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

Jim Blandy's avatar
Jim Blandy committed
399

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

409

410 411 412 413
/***********************************************************************
			      Debugging
 ***********************************************************************/

414
#if 0
415 416 417

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

Juanma Barranquero's avatar
Juanma Barranquero committed
419
struct record
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
{
  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 */
442 443


444

445 446 447 448 449 450 451 452 453 454 455
/* 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;
456

457 458
  return 0;
}
459

460 461 462 463 464


/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
Juanma Barranquero's avatar
Juanma Barranquero committed
465

466 467 468 469 470
/* 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
471

Andreas Schwab's avatar
Andreas Schwab committed
472
static void
473
x_update_begin (f)
Jim Blandy's avatar
Jim Blandy committed
474
     struct frame *f;
475
{
476 477
  /* Nothing to do.  */
}
Jim Blandy's avatar
Jim Blandy committed
478 479


480 481 482
/* 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
483

484 485 486 487 488 489
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
490

491 492
  updated_window = w;
  set_output_cursor (&w->cursor);
493

494
  BLOCK_INPUT;
495

496
  if (f == display_info->mouse_face_mouse_frame)
497
    {
498
      /* Don't do highlighting for mouse motion during the update.  */
499
      display_info->mouse_face_defer = 1;
500

501 502
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
503
      if (FRAME_GARBAGED_P (f))
504 505
	display_info->mouse_face_window = Qnil;

506 507 508 509 510 511
#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
512

513 514 515 516 517 518 519
      /* 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))
520
	{
521
	  int i;
522

523 524
	  for (i = 0; i < w->desired_matrix->nrows; ++i)
	    if (MATRIX_ROW_ENABLED_P (w->desired_matrix, i))
525 526
	      break;

527 528
	  if (i < w->desired_matrix->nrows)
	    clear_mouse_face (display_info);
529
	}
530
#endif /* 0 */
531
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
532

Jim Blandy's avatar
Jim Blandy committed
533 534 535
  UNBLOCK_INPUT;
}

536

537
/* Draw a vertical window border from (x,y0) to (x,y1)  */
538

Andreas Schwab's avatar
Andreas Schwab committed
539
static void
540
x_draw_vertical_window_border (w, x, y0, y1)
541
     struct window *w;
542
     int x, y0, y1;
543
{
544
  struct frame *f = XFRAME (WINDOW_FRAME (w));
545 546 547 548 549 550
  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);
551

552 553
  XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
	     f->output_data.x->normal_gc, x, y0, x, y1);
554
}
Juanma Barranquero's avatar
Juanma Barranquero committed
555

556 557 558 559 560 561 562 563 564 565 566 567
/* 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.  */
568 569

static void
570
x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
571
     struct window *w;
572
     int cursor_on_p, mouse_face_overwritten_p;
573
{
574
  struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
Juanma Barranquero's avatar
Juanma Barranquero committed
575

576 577 578
  if (!w->pseudo_window_p)
    {
      BLOCK_INPUT;
579

580
      if (cursor_on_p)
581 582 583
	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
584

585 586
      if (draw_window_fringes (w, 1))
	x_draw_vertical_border (w);
Kenichi Handa's avatar
Kenichi Handa committed
587

588 589
      UNBLOCK_INPUT;
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
590

591 592 593 594 595 596 597 598
  /* 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
599

600 601
  updated_window = NULL;
}
Jim Blandy's avatar
Jim Blandy committed
602 603


604 605 606 607 608 609 610 611
/* 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.  */
612
  FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
613

614
#ifndef XFlush
615
  BLOCK_INPUT;
616
  XFlush (FRAME_X_DISPLAY (f));
Jim Blandy's avatar
Jim Blandy committed
617
  UNBLOCK_INPUT;
618
#endif
Jim Blandy's avatar
Jim Blandy committed
619
}
620

621 622 623 624

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

Andreas Schwab's avatar
Andreas Schwab committed
626
static void
627
XTframe_up_to_date (f)
628
     struct frame *f;
629
{
630
  if (FRAME_X_P (f))
631
    {
632
      struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
633

634 635 636 637 638 639 640 641 642 643 644
      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;
	}
645
    }
646
}
647 648 649


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
650
   arrow bitmaps, or clear the fringes if no bitmaps are required
651 652 653 654 655 656 657 658 659 660
   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;
661
  struct frame *f;
662
  int width, height;
Juanma Barranquero's avatar
Juanma Barranquero committed
663

664
  xassert (w);
Juanma Barranquero's avatar
Juanma Barranquero committed
665

666
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
Kenichi Handa's avatar
Kenichi Handa committed
667
    desired_row->redraw_fringe_bitmaps_p = 1;
Juanma Barranquero's avatar
Juanma Barranquero committed
668

669 670 671 672 673 674 675 676 677 678
  /* 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),
679 680 681
	  width != 0)
      && (height = desired_row->visible_height,
	  height > 0))
682 683
    {
      int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
684

685 686 687 688
      /* 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
689

690 691 692 693
      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),
694
		    FRAME_PIXEL_WIDTH (f) - width,
695
		    y, width, height, False);
696 697 698 699 700
      UNBLOCK_INPUT;
    }
}

static void
Kim F. Storm's avatar
Kim F. Storm committed
701
x_draw_fringe_bitmap (w, row, p)
702 703
     struct window *w;
     struct glyph_row *row;
Kim F. Storm's avatar
Kim F. Storm committed
704
     struct draw_fringe_bitmap_params *p;
705 706 707 708 709
{
  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
710
  struct face *face = p->face;
Kenichi Handa's avatar
Kenichi Handa committed
711
  int rowY;
712 713

  /* Must clip because of partially visible lines.  */
Kenichi Handa's avatar
Kenichi Handa committed
714 715 716 717 718 719 720 721 722
  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;
723
      x_clip_to_row (w, row, -1, gc);
Kenichi Handa's avatar
Kenichi Handa committed
724 725 726 727
      row->y = oldY;
      row->visible_height = oldVH;
    }
  else
728
    x_clip_to_row (w, row, -1, gc);
729

730
  if (!p->overlay_p)
731
    {
732 733
      int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;

734 735 736 737 738 739 740 741
      /* 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
742

743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
#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
792

793 794 795 796
      if (!face->stipple)
	XSetForeground (display, face->gc, face->foreground);
    }

Kenichi Handa's avatar
Kenichi Handa committed
797
  if (p->which)
798
    {
Kenichi Handa's avatar
Kenichi Handa committed
799 800
      unsigned char *bits;
      Pixmap pixmap, clipmask = (Pixmap) 0;
Kim F. Storm's avatar
Kim F. Storm committed
801
      int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
Kenichi Handa's avatar
Kenichi Handa committed
802 803 804 805 806 807
      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
808

809 810
      /* Draw the bitmap.  I believe these small pixmaps can be cached
	 by the server.  */
Kim F. Storm's avatar
Kim F. Storm committed
811
      pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
Kenichi Handa's avatar
Kenichi Handa committed
812 813 814 815
					    (p->cursor_p
					     ? (p->overlay_p ? face->background
						: f->output_data.x->cursor_pixel)
					     : face->foreground),
816
					    face->background, depth);
Kenichi Handa's avatar
Kenichi Handa committed
817 818 819 820 821 822 823 824 825 826 827 828 829

      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
830 831
      XCopyArea (display, pixmap, window, gc, 0, 0,
		 p->wd, p->h, p->x, p->y);
832
      XFreePixmap (display, pixmap);
Kenichi Handa's avatar
Kenichi Handa committed
833 834 835 836 837 838 839

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

842 843 844
  XSetClipMask (display, gc, None);
}

Jim Blandy's avatar
Jim Blandy committed
845

846 847 848 849 850

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

Andreas Schwab's avatar
Andreas Schwab committed
852
static void
853
XTset_terminal_modes (struct terminal *terminal)
Jim Blandy's avatar
Jim Blandy committed
854 855 856
{
}

857 858
/* 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
859

Andreas Schwab's avatar
Andreas Schwab committed
860
static void
861
XTreset_terminal_modes (struct terminal *terminal)
Jim Blandy's avatar
Jim Blandy committed
862 863
{
}
864 865 866 867 868 869 870 871 872 873 874 875 876


/***********************************************************************
			    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 *));
877
static void x_draw_composite_glyph_string_foreground P_ ((struct glyph_string *));
878 879 880 881 882 883 884
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,
885
				      unsigned long *, double, int));
886
static void x_setup_relief_color P_ ((struct frame *, struct relief *,
887
				      double, int, unsigned long));
888 889 890 891 892 893 894 895
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,
896 897
				    int, int, int, int, int, int,
				    XRectangle *));
898 899
static void x_draw_box_rect P_ ((struct glyph_string *, int, int, int, int,
				 int, int, int, XRectangle *));
900 901

#if GLYPH_DEBUG
902
static void x_check_font P_ ((struct frame *, struct font *));
903
#endif
904 905 906 907 908 909 910 911 912 913 914 915


/* 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)
916
      && !s->cmp)
917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
    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;
945
      mask = GCForeground | GCBackground | GCGraphicsExposures;
946 947 948 949 950 951 952 953 954 955 956 957 958 959

      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
960

961 962 963
static void
x_set_mouse_face_gc (s)
     struct glyph_string *s;
Juanma Barranquero's avatar
Juanma Barranquero committed
964
{
965
  int face_id;
966
  struct face *face;
967

968
  /* What face has to be used last for the mouse face?  */
969
  face_id = FRAME_X_DISPLAY_INFO (s->f)->mouse_face_face_id;
970
  face = FACE_FROM_ID (s->f, face_id);
971 972
  if (face == NULL)
    face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
Juanma Barranquero's avatar
Juanma Barranquero committed
973

974
  if (s->first_glyph->type == CHAR_GLYPH)
975
    face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
976
  else
977
    face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
978 979 980 981 982 983 984 985
  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
986
	 except for FONT.  */
987 988
      XGCValues xgcv;
      unsigned long mask;
Juanma Barranquero's avatar
Juanma Barranquero committed
989

990 991 992
      xgcv.background = s->face->background;
      xgcv.foreground = s->face->foreground;
      xgcv.graphics_exposures = False;
993
      mask = GCForeground | GCBackground | GCGraphicsExposures;
Juanma Barranquero's avatar
Juanma Barranquero committed
994

995 996 997 998 999 1000
      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
1001

1002 1003
      s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;

1004
    }
1005 1006 1007 1008 1009 1010 1011