xterm.c 319 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, 2010
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
#include <stdio.h>
31
#include <setjmp.h>
32

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

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

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

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

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

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

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

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

93 94 95 96
#ifdef USE_X_TOOLKIT
#include <X11/Shell.h>
#endif

97 98 99 100 101 102 103
#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
104 105 106 107
#ifdef USE_GTK
#include "gtkutil.h"
#endif

108
#ifdef USE_LUCID
Dave Love's avatar
Dave Love committed
109
extern int xlwmenu_window_p P_ ((Widget w, Window window));
110 111 112
extern void xlwmenu_redisplay P_ ((Widget));
#endif

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

Gerd Moellmann's avatar
Gerd Moellmann committed
115
extern void free_frame_menubar P_ ((struct frame *));
Jan Djärv's avatar
Jan Djärv committed
116
#endif
117

Jan Djärv's avatar
Jan Djärv committed
118
#ifdef USE_X_TOOLKIT
Dan Nicolaescu's avatar
Dan Nicolaescu committed
119
#if !defined(NO_EDITRES)
120 121 122
#define HACK_EDITRES
extern void _XEditResCheckMessages ();
#endif /* not NO_EDITRES */
123 124 125 126 127 128 129

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

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

146 147
#endif /* USE_X_TOOLKIT */

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

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

162 163


164
/* Non-nil means Emacs uses toolkit scroll bars.  */
165

166
Lisp_Object Vx_toolkit_scroll_bars;
167 168 169 170 171 172

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

static int any_help_event_p;

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

176 177 178 179
/* Non-zero means make use of UNDERLINE_POSITION font properties.  */

int x_use_underline_position_properties;

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

int x_underline_at_descent_line;

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

187
struct x_display_info *x_display_list;
Jim Blandy's avatar
Jim Blandy committed
188

189 190 191 192 193
/* 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.  */

194
Lisp_Object x_display_name_list;
195

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

201
extern struct frame *updating_frame;
Jim Blandy's avatar
Jim Blandy committed
202

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

205 206 207 208 209 210 211 212
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;
213

214 215 216
#ifdef USE_X_TOOLKIT
/* The application context for Xt use.  */
XtAppContext Xt_app_con;
217 218
static String Xt_default_resources[] = {0};
#endif /* USE_X_TOOLKIT */
219

Gerd Moellmann's avatar
Gerd Moellmann committed
220 221 222
/* Non-zero means user is interacting with a toolkit scroll bar.  */

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

Kenichi Handa's avatar
Kenichi Handa committed
224 225 226 227 228 229 230 231 232 233 234
/* 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;

235 236
/* Mouse movement.

237
   Formerly, we used PointerMotionHintMask (in standard_event_mask)
238 239 240 241 242 243
   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.

244 245 246 247 248 249 250 251 252
   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
253
   is off.  */
254 255 256

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

257
static XRectangle last_mouse_glyph;
Kim F. Storm's avatar
Kim F. Storm committed
258
static FRAME_PTR last_mouse_glyph_frame;
259 260
static Lisp_Object last_mouse_press_frame;

261 262
/* The scroll bar in which the last X motion event occurred.

263 264
   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
265 266
   an ordinary motion.

267 268 269 270
   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.  */

271 272 273 274
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
275
   doesn't seem to be any way to wrest the time-stamp from the server
276 277 278
   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.  */
279

280 281
static Time last_mouse_movement_time;

Jan Djärv's avatar
Jan Djärv committed
282 283 284 285
/* Time for last user interaction as returned in X events.  */

static Time last_user_time;

286 287 288
/* Incremented by XTread_socket whenever it really tries to read
   events.  */

289 290 291 292 293 294
#ifdef __STDC__
static int volatile input_signal_count;
#else
static int input_signal_count;
#endif

295
/* Used locally within XTread_socket.  */
296

297
static int x_noop_count;
Jim Blandy's avatar
Jim Blandy committed
298

299
/* Initial values of argv and argc.  */
300

301 302
extern char **initial_argv;
extern int initial_argc;
Jim Blandy's avatar
Jim Blandy committed
303

304
extern Lisp_Object Vcommand_line_args, Vsystem_name;
Jim Blandy's avatar
Jim Blandy committed
305

306
/* Tells if a window manager is present or not.  */
307 308

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

Kenichi Handa's avatar
Kenichi Handa committed
310
extern Lisp_Object Qeql;
311

Jim Blandy's avatar
Jim Blandy committed
312 313
extern int errno;

314
/* A mask of extra modifier bits to put into every keyboard char.  */
315

316
extern EMACS_INT extra_keyboard_modifiers;
317

318 319 320
/* 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
321
Lisp_Object Vx_keysym_table;
322 323
static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;

324
static Lisp_Object Qvendor_specific_keysyms;
Dave Love's avatar
Dave Love committed
325
static Lisp_Object Qlatin_1;
326

327 328 329
#ifdef USE_GTK
/* The name of the Emacs icon file.  */
static Lisp_Object xg_default_icon_file;
330 331 332

/* Used in gtkutil.c.  */
Lisp_Object Qx_gtk_map_stock;
333 334
#endif

335 336 337 338
/* Used in x_flush.  */

extern Lisp_Object Vinhibit_redisplay;

Gerd Moellmann's avatar
Gerd Moellmann committed
339
extern XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
Dave Love's avatar
Dave Love committed
340
extern int x_bitmap_mask P_ ((FRAME_PTR, int));
341

342
static int x_alloc_nearest_color_1 P_ ((Display *, Colormap, XColor *));
343
static void x_set_window_size_1 P_ ((struct frame *, int, int, int));
344
static const XColor *x_color_cells P_ ((Display *, int *));
345
static void x_update_window_end P_ ((struct window *, int, int));
346

347
static int x_io_error_quitter P_ ((Display *));
348 349
static struct terminal *x_create_terminal P_ ((struct x_display_info *));
void x_delete_terminal P_ ((struct terminal *));
350 351
static void x_update_end P_ ((struct frame *));
static void XTframe_up_to_date P_ ((struct frame *));
352 353
static void XTset_terminal_modes P_ ((struct terminal *));
static void XTreset_terminal_modes P_ ((struct terminal *));
Karoly Lorentey's avatar
Karoly Lorentey committed
354
static void x_clear_frame P_ ((struct frame *));
355 356 357
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
358 359 360 361
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 *));
362 363 364
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 *));
365 366
static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int,
				   enum text_cursor_kinds));
367

368
static void x_clip_to_row P_ ((struct window *, struct glyph_row *, int, GC));
369
static void x_flush P_ ((struct frame *f));
Gerd Moellmann's avatar
Gerd Moellmann committed
370 371 372
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
373
static struct scroll_bar *x_window_to_scroll_bar P_ ((Display *, Window));
Gerd Moellmann's avatar
Gerd Moellmann committed
374 375 376 377
static void x_scroll_bar_report_motion P_ ((struct frame **, Lisp_Object *,
					    enum scroll_bar_part *,
					    Lisp_Object *, Lisp_Object *,
					    unsigned long *));
378
static void x_handle_net_wm_state P_ ((struct frame *, XPropertyEvent *));
379
static void x_check_fullscreen P_ ((struct frame *));
380 381
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
382 383
static int handle_one_xevent P_ ((struct x_display_info *, XEvent *,
				  int *, struct input_event *));
384 385 386
/* 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
387

388 389 390 391 392 393 394

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

static void
x_flush (f)
     struct frame *f;
{
395 396 397 398 399
  /* Don't call XFlush when it is not safe to redisplay; the X
     connection may be broken.  */
  if (!NILP (Vinhibit_redisplay))
    return;

400 401 402 403 404
  BLOCK_INPUT;
  if (f == NULL)
    {
      Lisp_Object rest, frame;
      FOR_EACH_FRAME (rest, frame)
405 406
        if (FRAME_X_P (XFRAME (frame)))
          x_flush (XFRAME (frame));
407 408 409 410 411 412
    }
  else if (FRAME_X_P (f))
    XFlush (FRAME_X_DISPLAY (f));
  UNBLOCK_INPUT;
}

Jim Blandy's avatar
Jim Blandy committed
413

414 415 416 417 418 419 420
/* 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
421
#define XFlush(DISPLAY)	(void) 0
422

423

424 425 426 427
/***********************************************************************
			      Debugging
 ***********************************************************************/

428
#if 0
429 430 431

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

Juanma Barranquero's avatar
Juanma Barranquero committed
433
struct record
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
{
  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 */
456 457


458

459 460 461 462 463 464 465 466 467 468 469
/* 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;
470

471 472
  return 0;
}
473

474 475 476 477 478 479 480 481 482 483
#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);
484 485
  double alpha = 1.0;
  double alpha_min = 1.0;
486 487
  unsigned long opac;

488 489 490 491 492 493 494 495 496 497 498 499 500 501 502
  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;

503 504 505
  if (alpha < 0.0)
    return;
  else if (alpha > 1.0)
506 507 508 509
    alpha = 1.0;
  else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
    alpha = alpha_min;

510
  opac = alpha * OPAQUE;
511 512 513 514 515

  /* return unless necessary */
  {
    unsigned char *data;
    Atom actual;
516
    int rc, format;
517 518
    unsigned long n, left;

519 520 521 522 523 524 525
    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)
526
      if (*(unsigned long *)data == opac)
527 528
	{
	  XFree ((void *) data);
529
	  x_uncatch_errors ();
530 531 532
	  return;
	}
      else
533
	XFree ((void *) data);
534
    x_uncatch_errors ();
535 536
  }

537
  x_catch_errors (dpy);
538 539 540
  XChangeProperty (dpy, win, XInternAtom (dpy, OPACITY, False),
		   XA_CARDINAL, 32, PropModeReplace,
		   (unsigned char *) &opac, 1L);
541
  x_uncatch_errors ();
542
}
543

544 545 546 547 548 549 550 551 552 553 554 555 556 557
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);
}

558 559 560 561

/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
Juanma Barranquero's avatar
Juanma Barranquero committed
562

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

Andreas Schwab's avatar
Andreas Schwab committed
569
static void
570
x_update_begin (f)
Jim Blandy's avatar
Jim Blandy committed
571
     struct frame *f;
572
{
573 574
  /* Nothing to do.  */
}
Jim Blandy's avatar
Jim Blandy committed
575 576


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

581 582 583 584 585 586
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
587

588 589
  updated_window = w;
  set_output_cursor (&w->cursor);
590

591
  BLOCK_INPUT;
592

593
  if (f == display_info->mouse_face_mouse_frame)
594
    {
595
      /* Don't do highlighting for mouse motion during the update.  */
596
      display_info->mouse_face_defer = 1;
597

598 599
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
600
      if (FRAME_GARBAGED_P (f))
601
	display_info->mouse_face_window = Qnil;
602
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
603

Jim Blandy's avatar
Jim Blandy committed
604 605 606
  UNBLOCK_INPUT;
}

607

608
/* Draw a vertical window border from (x,y0) to (x,y1)  */
609

Andreas Schwab's avatar
Andreas Schwab committed
610
static void
611
x_draw_vertical_window_border (w, x, y0, y1)
612
     struct window *w;
613
     int x, y0, y1;
614
{
615
  struct frame *f = XFRAME (WINDOW_FRAME (w));
616 617 618 619 620 621
  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);
622

623 624
  XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
	     f->output_data.x->normal_gc, x, y0, x, y1);
625
}
Juanma Barranquero's avatar
Juanma Barranquero committed
626

627 628 629 630 631 632 633 634 635 636 637 638
/* 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.  */
639 640

static void
641
x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
642
     struct window *w;
643
     int cursor_on_p, mouse_face_overwritten_p;
644
{
645
  struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
Juanma Barranquero's avatar
Juanma Barranquero committed
646

647 648 649
  if (!w->pseudo_window_p)
    {
      BLOCK_INPUT;
650

651
      if (cursor_on_p)
652 653 654
	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
655

656 657
      if (draw_window_fringes (w, 1))
	x_draw_vertical_border (w);
Kenichi Handa's avatar
Kenichi Handa committed
658

659 660
      UNBLOCK_INPUT;
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
661

662 663 664 665 666 667 668 669
  /* 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
670

671 672
  updated_window = NULL;
}
Jim Blandy's avatar
Jim Blandy committed
673 674


675 676 677 678 679 680 681 682
/* 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.  */
683
  FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
684

685
#ifndef XFlush
686
  BLOCK_INPUT;
687
  XFlush (FRAME_X_DISPLAY (f));
Jim Blandy's avatar
Jim Blandy committed
688
  UNBLOCK_INPUT;
689
#endif
Jim Blandy's avatar
Jim Blandy committed
690
}
691

692 693 694 695

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

Andreas Schwab's avatar
Andreas Schwab committed
697
static void
698
XTframe_up_to_date (f)
699
     struct frame *f;
700
{
701
  if (FRAME_X_P (f))
702
    {
703
      struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
704

705 706 707 708 709 710 711 712 713 714 715
      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;
	}
716
    }
717
}
718 719 720


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
721
   arrow bitmaps, or clear the fringes if no bitmaps are required
722 723 724 725 726 727 728 729 730 731
   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;
732
  struct frame *f;
733
  int width, height;
Juanma Barranquero's avatar
Juanma Barranquero committed
734

735
  xassert (w);
Juanma Barranquero's avatar
Juanma Barranquero committed
736

737
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
Kenichi Handa's avatar
Kenichi Handa committed
738
    desired_row->redraw_fringe_bitmaps_p = 1;
Juanma Barranquero's avatar
Juanma Barranquero committed
739

740 741 742 743 744 745 746 747 748 749
  /* 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),
750 751 752
	  width != 0)
      && (height = desired_row->visible_height,
	  height > 0))
753 754
    {
      int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
755

756 757 758 759
      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),
760
		    FRAME_PIXEL_WIDTH (f) - width,
761
		    y, width, height, False);
762 763 764 765 766
      UNBLOCK_INPUT;
    }
}

static void
Kim F. Storm's avatar
Kim F. Storm committed
767
x_draw_fringe_bitmap (w, row, p)
768 769
     struct window *w;
     struct glyph_row *row;
Kim F. Storm's avatar
Kim F. Storm committed
770
     struct draw_fringe_bitmap_params *p;
771 772 773 774 775
{
  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
776
  struct face *face = p->face;
Kenichi Handa's avatar
Kenichi Handa committed
777
  int rowY;
778 779

  /* Must clip because of partially visible lines.  */
Kenichi Handa's avatar
Kenichi Handa committed
780 781 782 783 784 785 786 787 788
  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;
789
      x_clip_to_row (w, row, -1, gc);
Kenichi Handa's avatar
Kenichi Handa committed
790 791 792 793
      row->y = oldY;
      row->visible_height = oldVH;
    }
  else
794
    x_clip_to_row (w, row, -1, gc);
795

796
  if (!p->overlay_p)
797
    {
798 799
      int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;

800 801 802 803 804 805 806 807
      /* 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
808

809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 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
#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
858

859 860 861 862
      if (!face->stipple)
	XSetForeground (display, face->gc, face->foreground);
    }

Kenichi Handa's avatar
Kenichi Handa committed
863
  if (p->which)
864
    {
Kenichi Handa's avatar
Kenichi Handa committed
865 866
      unsigned char *bits;
      Pixmap pixmap, clipmask = (Pixmap) 0;
Kim F. Storm's avatar
Kim F. Storm committed
867
      int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
Kenichi Handa's avatar
Kenichi Handa committed
868 869 870 871 872 873
      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
874

875 876
      /* Draw the bitmap.  I believe these small pixmaps can be cached
	 by the server.  */
Kim F. Storm's avatar
Kim F. Storm committed
877
      pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
Kenichi Handa's avatar
Kenichi Handa committed
878 879 880 881
					    (p->cursor_p
					     ? (p->overlay_p ? face->background
						: f->output_data.x->cursor_pixel)
					     : face->foreground),
882
					    face->background, depth);
Kenichi Handa's avatar
Kenichi Handa committed
883 884 885 886 887 888 889 890 891 892 893 894 895

      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
896 897
      XCopyArea (display, pixmap, window, gc, 0, 0,
		 p->wd, p->h, p->x, p->y);
898
      XFreePixmap (display, pixmap);
Kenichi Handa's avatar
Kenichi Handa committed
899 900 901 902 903 904 905

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

908 909 910
  XSetClipMask (display, gc, None);
}

Jim Blandy's avatar
Jim Blandy committed
911

912 913 914 915 916

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

Andreas Schwab's avatar
Andreas Schwab committed
918
static void
919
XTset_terminal_modes (struct terminal *terminal)
Jim Blandy's avatar
Jim Blandy committed
920 921 922
{
}

923 924
/* 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
925

Andreas Schwab's avatar
Andreas Schwab committed
926
static void
927
XTreset_terminal_modes (struct terminal *terminal)
Jim Blandy's avatar
Jim Blandy committed
928 929
{
}
930 931 932 933 934 935 936 937 938 939 940 941 942


/***********************************************************************
			    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 *));
943
static void x_draw_composite_glyph_string_foreground P_ ((struct glyph_string *));
944 945 946 947 948 949 950
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,
951
				      unsigned long *, double, int));
952
static void x_setup_relief_color P_ ((struct frame *, struct relief *,
953
				      double, int, unsigned long));
954 955 956 957 958 959 960 961
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,
962 963
				    int, int, int, int, int, int,
				    XRectangle *));
964 965
static void x_draw_box_rect P_ ((struct glyph_string *, int, int, int, int,
				 int, int, int, XRectangle *));
966 967

#if GLYPH_DEBUG
968
static void x_check_font P_ ((struct frame *, struct font *));
969
#endif
970 971 972 973 974 975 976 977 978 979 980 981


/* 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)
982
      && !s->cmp)
983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
    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;
1011
      mask = GCForeground | GCBackground | GCGraphicsExposures;
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025

      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
1026

1027 1028 1029
static void
x_set_mouse_face_gc (s)
     struct glyph_string *s;
Juanma Barranquero's avatar
Juanma Barranquero committed
1030
{
1031
  int face_id;
1032
  struct face *face;
1033

1034
  /* What face has to be used last for the mouse face?  */
1035
  face_id = FRAME_X_DISPLAY_INFO (s->f)->mouse_face_face_id;
1036
  face = FACE_FROM_ID (s->f, face_id);
1037 1038
  if (face == NULL)
    face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
Juanma Barranquero's avatar
Juanma Barranquero committed
1039

1040
  if (s->first_glyph->type == CHAR_GLYPH)
1041
    face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1042
  else
1043
    face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1044 1045 1046 1047 1048 1049 1050 1051
  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
1052
	 except for FONT.  */
1053 1054
      XGCValues xgcv;
      unsigned long mask;
Juanma Barranquero's avatar
Juanma Barranquero committed
1055

1056 1057 1058
      xgcv.background = s->face->background;
      xgcv.foreground = s->face->foreground;
      xgcv.graphics_exposures = False;
1059
      mask = GCForeground | GCBackground | GCGraphicsExposures;
Juanma Barranquero's avatar
Juanma Barranquero committed
1060

1061 1062 1063 1064 1065 1066
      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
1067

1068 1069
      s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;

1070
    }
1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
  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
1082
{
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094
  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.  */

static INLINE void
x_set_glyph_string_gc (s)
     struct glyph_string *s;
{
1095
  PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
Juanma Barranquero's avatar
Juanma Barranquero committed
1096

1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
  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)