xterm.c 328 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 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
19 20
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21

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

25 26
#include <config.h>

27 28 29 30
/* 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>

31 32
#include <stdio.h>

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

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

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

70
#include "charset.h"
Kenichi Handa's avatar
Kenichi Handa committed
71
#include "coding.h"
72
#include "ccl.h"
73
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
74
#include "dispextern.h"
75
#include "fontset.h"
Jim Blandy's avatar
Jim Blandy committed
76 77 78 79 80 81
#include "termhooks.h"
#include "termopts.h"
#include "termchar.h"
#include "gnu.h"
#include "disptab.h"
#include "buffer.h"
82
#include "window.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
83
#include "keyboard.h"
Karl Heuer's avatar
Karl Heuer committed
84
#include "intervals.h"
Andreas Schwab's avatar
Andreas Schwab committed
85
#include "process.h"
Gerd Moellmann's avatar
Gerd Moellmann committed
86
#include "atimer.h"
Stefan Monnier's avatar
Stefan Monnier committed
87
#include "keymap.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

158 159
#define abs(x)	((x) < 0 ? -(x) : (x))

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

167 168


169
/* Non-nil means Emacs uses toolkit scroll bars.  */
170

171
Lisp_Object Vx_toolkit_scroll_bars;
172 173 174 175 176 177

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

static int any_help_event_p;

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

181 182 183 184
/* Non-zero means make use of UNDERLINE_POSITION font properties.  */

int x_use_underline_position_properties;

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

int x_underline_at_descent_line;

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

192
struct x_display_info *x_display_list;
Jim Blandy's avatar
Jim Blandy committed
193

194 195 196 197 198
/* 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.  */

199
Lisp_Object x_display_name_list;
200

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

206
extern struct frame *updating_frame;
Jim Blandy's avatar
Jim Blandy committed
207

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

210 211
struct frame *pending_autoraise_frame;

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

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

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

222 223 224 225 226 227 228 229 230 231 232
/* 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;

233 234
/* Mouse movement.

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

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

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

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

259 260
/* The scroll bar in which the last X motion event occurred.

261 262
   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
263 264
   an ordinary motion.

265 266 267 268
   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.  */

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

278 279
static Time last_mouse_movement_time;

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

static Time last_user_time;

284 285 286
/* Incremented by XTread_socket whenever it really tries to read
   events.  */

287 288 289 290 291 292
#ifdef __STDC__
static int volatile input_signal_count;
#else
static int input_signal_count;
#endif

293
/* Used locally within XTread_socket.  */
294

295
static int x_noop_count;
Jim Blandy's avatar
Jim Blandy committed
296

297
/* Initial values of argv and argc.  */
298

299 300
extern char **initial_argv;
extern int initial_argc;
Jim Blandy's avatar
Jim Blandy committed
301

302
extern Lisp_Object Vcommand_line_args, Vsystem_name;
Jim Blandy's avatar
Jim Blandy committed
303

304
/* Tells if a window manager is present or not.  */
305 306

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

308
extern Lisp_Object Qeql;
309

Jim Blandy's avatar
Jim Blandy committed
310 311
extern int errno;

312
/* A mask of extra modifier bits to put into every keyboard char.  */
313

314
extern EMACS_INT extra_keyboard_modifiers;
315

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

322
static Lisp_Object Qvendor_specific_keysyms;
Dave Love's avatar
Dave Love committed
323
static Lisp_Object Qlatin_1;
324

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

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

333 334 335 336 337 338 339 340 341 342 343
static int x_io_error_quitter P_ ((Display *));
static void x_font_min_bounds P_ ((XFontStruct *, int *, int *));
static int x_compute_min_glyph_bounds P_ ((struct frame *));
static void x_update_end P_ ((struct frame *));
static void XTframe_up_to_date P_ ((struct frame *));
static void XTset_terminal_modes P_ ((void));
static void XTreset_terminal_modes P_ ((void));
static void x_clear_frame P_ ((void));
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 *));
344 345 346 347
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 *));
348 349 350
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 *));
351 352
static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int,
				   enum text_cursor_kinds));
353

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

371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389

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

static void
x_flush (f)
     struct frame *f;
{
  BLOCK_INPUT;
  if (f == NULL)
    {
      Lisp_Object rest, frame;
      FOR_EACH_FRAME (rest, frame)
	x_flush (XFRAME (frame));
    }
  else if (FRAME_X_P (f))
    XFlush (FRAME_X_DISPLAY (f));
  UNBLOCK_INPUT;
}

Jim Blandy's avatar
Jim Blandy committed
390

391 392 393 394 395 396 397
/* 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
398
#define XFlush(DISPLAY)	(void) 0
399

400

401 402 403 404
/***********************************************************************
			      Debugging
 ***********************************************************************/

405
#if 0
406 407 408

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

Juanma Barranquero's avatar
Juanma Barranquero committed
410
struct record
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432
{
  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 */
433 434


435

436 437 438 439 440 441 442 443 444 445 446
/* 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;
447

448 449
  return 0;
}
450

451 452 453 454 455

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

457 458 459 460 461
/* 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
462

Andreas Schwab's avatar
Andreas Schwab committed
463
static void
464
x_update_begin (f)
Jim Blandy's avatar
Jim Blandy committed
465
     struct frame *f;
466
{
467 468
  /* Nothing to do.  */
}
Jim Blandy's avatar
Jim Blandy committed
469 470


471 472 473
/* 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
474

475 476 477 478 479 480
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
481

482 483
  updated_window = w;
  set_output_cursor (&w->cursor);
484

485
  BLOCK_INPUT;
486

487
  if (f == display_info->mouse_face_mouse_frame)
488
    {
489
      /* Don't do highlighting for mouse motion during the update.  */
490
      display_info->mouse_face_defer = 1;
491

492 493
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
494
      if (FRAME_GARBAGED_P (f))
495 496
	display_info->mouse_face_window = Qnil;

497 498 499 500 501 502
#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
503

504 505 506 507 508 509 510
      /* 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))
511
	{
512
	  int i;
513

514 515
	  for (i = 0; i < w->desired_matrix->nrows; ++i)
	    if (MATRIX_ROW_ENABLED_P (w->desired_matrix, i))
516 517
	      break;

518 519
	  if (i < w->desired_matrix->nrows)
	    clear_mouse_face (display_info);
520
	}
521
#endif /* 0 */
522
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
523

Jim Blandy's avatar
Jim Blandy committed
524 525 526
  UNBLOCK_INPUT;
}

527

528
/* Draw a vertical window border from (x,y0) to (x,y1)  */
529

Andreas Schwab's avatar
Andreas Schwab committed
530
static void
531
x_draw_vertical_window_border (w, x, y0, y1)
532
     struct window *w;
533
     int x, y0, y1;
534
{
535
  struct frame *f = XFRAME (WINDOW_FRAME (w));
536 537 538 539 540 541
  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);
542

543 544
  XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
	     f->output_data.x->normal_gc, x, y0, x, y1);
545
}
Juanma Barranquero's avatar
Juanma Barranquero committed
546

547 548 549 550 551 552 553 554 555 556 557 558
/* 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.  */
559 560

static void
561
x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
562
     struct window *w;
563
     int cursor_on_p, mouse_face_overwritten_p;
564
{
565
  struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
Juanma Barranquero's avatar
Juanma Barranquero committed
566

567 568 569
  if (!w->pseudo_window_p)
    {
      BLOCK_INPUT;
570

571
      if (cursor_on_p)
572 573 574
	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
575

576 577
      if (draw_window_fringes (w, 1))
	x_draw_vertical_border (w);
578

579 580
      UNBLOCK_INPUT;
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
581

582 583 584 585 586 587 588 589
  /* 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
590

591 592
  updated_window = NULL;
}
Jim Blandy's avatar
Jim Blandy committed
593 594


595 596 597 598 599 600 601 602
/* 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.  */
603
  FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
604

605
#ifndef XFlush
606
  BLOCK_INPUT;
607
  XFlush (FRAME_X_DISPLAY (f));
Jim Blandy's avatar
Jim Blandy committed
608
  UNBLOCK_INPUT;
609
#endif
Jim Blandy's avatar
Jim Blandy committed
610
}
611

612 613 614 615

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

Andreas Schwab's avatar
Andreas Schwab committed
617
static void
618
XTframe_up_to_date (f)
619
     struct frame *f;
620
{
621
  if (FRAME_X_P (f))
622
    {
623
      struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
624

625 626 627 628 629 630 631 632 633 634 635
      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;
	}
636
    }
637
}
638 639 640


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
641
   arrow bitmaps, or clear the fringes if no bitmaps are required
642 643 644 645 646 647 648 649 650 651
   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;
652
  struct frame *f;
653
  int width, height;
Juanma Barranquero's avatar
Juanma Barranquero committed
654

655
  xassert (w);
Juanma Barranquero's avatar
Juanma Barranquero committed
656

657
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
658
    desired_row->redraw_fringe_bitmaps_p = 1;
Juanma Barranquero's avatar
Juanma Barranquero committed
659

660 661 662 663 664 665 666 667 668 669
  /* 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),
670 671 672
	  width != 0)
      && (height = desired_row->visible_height,
	  height > 0))
673 674
    {
      int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
675

676 677 678 679
      /* 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
680

681 682 683 684
      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),
685
		    FRAME_PIXEL_WIDTH (f) - width,
686
		    y, width, height, False);
687 688 689 690 691
      UNBLOCK_INPUT;
    }
}

static void
Kim F. Storm's avatar
Kim F. Storm committed
692
x_draw_fringe_bitmap (w, row, p)
693 694
     struct window *w;
     struct glyph_row *row;
Kim F. Storm's avatar
Kim F. Storm committed
695
     struct draw_fringe_bitmap_params *p;
696 697 698 699 700
{
  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
701
  struct face *face = p->face;
702
  int rowY;
703 704

  /* Must clip because of partially visible lines.  */
705 706 707 708 709 710 711 712 713
  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;
714
      x_clip_to_row (w, row, -1, gc);
715 716 717 718
      row->y = oldY;
      row->visible_height = oldVH;
    }
  else
719
    x_clip_to_row (w, row, -1, gc);
720

721
  if (p->bx >= 0 && !p->overlay_p)
722 723 724 725 726 727 728 729 730
    {
      /* 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
731

732
      XFillRectangle (display, window, face->gc,
Kim F. Storm's avatar
Kim F. Storm committed
733 734
		      p->bx, p->by, p->nx, p->ny);

735 736 737 738
      if (!face->stipple)
	XSetForeground (display, face->gc, face->foreground);
    }

739
  if (p->which)
740
    {
741
      unsigned char *bits;
742
      Pixmap pixmap, clipmask = (Pixmap) 0;
Kim F. Storm's avatar
Kim F. Storm committed
743
      int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
744
      XGCValues gcv;
Kim F. Storm's avatar
Kim F. Storm committed
745

746 747 748 749 750
      if (p->wd > 8)
	bits = (unsigned char *)(p->bits + p->dh);
      else
	bits = (unsigned char *)p->bits + p->dh;

751 752
      /* Draw the bitmap.  I believe these small pixmaps can be cached
	 by the server.  */
Kim F. Storm's avatar
Kim F. Storm committed
753
      pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
754 755 756 757
					    (p->cursor_p
					     ? (p->overlay_p ? face->background
						: f->output_data.x->cursor_pixel)
					     : face->foreground),
758
					    face->background, depth);
759 760 761

      if (p->overlay_p)
	{
762
	  clipmask = XCreatePixmapFromBitmapData (display,
763
						  FRAME_X_DISPLAY_INFO (f)->root_window,
764
						  bits, p->wd, p->h,
765 766 767
						  1, 0, 1);
	  gcv.clip_mask = clipmask;
	  gcv.clip_x_origin = p->x;
768
	  gcv.clip_y_origin = p->y;
769 770 771
	  XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
	}

Kim F. Storm's avatar
Kim F. Storm committed
772 773
      XCopyArea (display, pixmap, window, gc, 0, 0,
		 p->wd, p->h, p->x, p->y);
774
      XFreePixmap (display, pixmap);
775 776 777 778 779 780 781

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

784 785 786
  XSetClipMask (display, gc, None);
}

Jim Blandy's avatar
Jim Blandy committed
787

788 789 790 791 792

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

Andreas Schwab's avatar
Andreas Schwab committed
794
static void
Jim Blandy's avatar
Jim Blandy committed
795 796 797 798
XTset_terminal_modes ()
{
}

799 800
/* 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
801

Andreas Schwab's avatar
Andreas Schwab committed
802
static void
Jim Blandy's avatar
Jim Blandy committed
803 804 805
XTreset_terminal_modes ()
{
}
806 807 808 809 810 811 812 813 814



/***********************************************************************
			   Display Iterator
 ***********************************************************************/

/* Function prototypes of this page.  */

815
static int x_encode_char P_ ((int, XChar2b *, struct font_info *, int *));
816 817


Gerd Moellmann's avatar
Gerd Moellmann committed
818 819
/* Get metrics of character CHAR2B in FONT.  Value is null if CHAR2B
   is not contained in the font.  */
820

821 822
static XCharStruct *
x_per_char_metric (font, char2b, font_type)
823 824
     XFontStruct *font;
     XChar2b *char2b;
825
     int font_type;  /* unused on X */
826 827 828
{
  /* The result metric information.  */
  XCharStruct *pcm = NULL;
Jim Blandy's avatar
Jim Blandy committed
829

830
  xassert (font && char2b);
Jim Blandy's avatar
Jim Blandy committed
831

832
  if (font->per_char != NULL)
Jim Blandy's avatar
Jim Blandy committed
833
    {
834
      if (font->min_byte1 == 0 && font->max_byte1 == 0)
835
	{
836 837 838 839 840 841 842 843 844 845
	  /* min_char_or_byte2 specifies the linear character index
	     corresponding to the first element of the per_char array,
	     max_char_or_byte2 is the index of the last character.  A
	     character with non-zero CHAR2B->byte1 is not in the font.
	     A character with byte2 less than min_char_or_byte2 or
	     greater max_char_or_byte2 is not in the font.  */
	  if (char2b->byte1 == 0
	      && char2b->byte2 >= font->min_char_or_byte2
	      && char2b->byte2 <= font->max_char_or_byte2)
	    pcm = font->per_char + char2b->byte2 - font->min_char_or_byte2;
846
	}
847
      else
Jim Blandy's avatar
Jim Blandy committed
848
	{
849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
	  /* If either min_byte1 or max_byte1 are nonzero, both
	     min_char_or_byte2 and max_char_or_byte2 are less than
	     256, and the 2-byte character index values corresponding
	     to the per_char array element N (counting from 0) are:

	     byte1 = N/D + min_byte1
	     byte2 = N\D + min_char_or_byte2

	     where:

	     D = max_char_or_byte2 - min_char_or_byte2 + 1
	     / = integer division
	     \ = integer modulus  */
	  if (char2b->byte1 >= font->min_byte1
	      && char2b->byte1 <= font->max_byte1
	      && char2b->byte2 >= font->min_char_or_byte2
	      && char2b->byte2 <= font->max_char_or_byte2)
	    {
	      pcm = (font->per_char
		     + ((font->max_char_or_byte2 - font->min_char_or_byte2 + 1)
			* (char2b->byte1 - font->min_byte1))
		     + (char2b->byte2 - font->min_char_or_byte2));
	    }
Jim Blandy's avatar
Jim Blandy committed
872
	}
873 874 875 876 877 878 879 880 881 882
    }
  else
    {
      /* If the per_char pointer is null, all glyphs between the first
	 and last character indexes inclusive have the same
	 information, as given by both min_bounds and max_bounds.  */
      if (char2b->byte2 >= font->min_char_or_byte2
	  && char2b->byte2 <= font->max_char_or_byte2)
	pcm = &font->max_bounds;
    }
Jim Blandy's avatar
Jim Blandy committed
883

884
  return ((pcm == NULL
885
	   || (pcm->width == 0 && (pcm->rbearing - pcm->lbearing) == 0))
886
	  ? NULL : pcm);
887
}
888

889

890 891
/* Encode CHAR2B using encoding information from FONT_INFO.  CHAR2B is
   the two-byte form of C.  Encoding is returned in *CHAR2B.  */
892

893 894
static int
x_encode_char (c, char2b, font_info, two_byte_p)
895 896 897
     int c;
     XChar2b *char2b;
     struct font_info *font_info;
898
     int *two_byte_p;
899 900 901 902 903 904 905 906 907 908 909 910
{
  int charset = CHAR_CHARSET (c);
  XFontStruct *font = font_info->font;

  /* FONT_INFO may define a scheme by which to encode byte1 and byte2.
     This may be either a program in a special encoder language or a
     fixed encoding.  */
  if (font_info->font_encoder)
    {
      /* It's a program.  */
      struct ccl_program *ccl = font_info->font_encoder;

911
      check_ccl_update (ccl);
912 913 914 915
      if (CHARSET_DIMENSION (charset) == 1)
	{
	  ccl->reg[0] = charset;
	  ccl->reg[1] = char2b->byte2;
916
	  ccl->reg[2] = -1;
917 918 919 920 921 922 923
	}
      else
	{
	  ccl->reg[0] = charset;
	  ccl->reg[1] = char2b->byte1;
	  ccl->reg[2] = char2b->byte2;
	}
Juanma Barranquero's avatar
Juanma Barranquero committed
924

925
      ccl_driver (ccl, NULL, NULL, 0, 0, NULL);
Juanma Barranquero's avatar
Juanma Barranquero committed
926

927 928 929
      /* We assume that MSBs are appropriately set/reset by CCL
	 program.  */
      if (font->max_byte1 == 0)	/* 1-byte font */
930
	char2b->byte1 = 0, char2b->byte2 = ccl->reg[1];
931 932 933 934 935 936 937 938
      else
	char2b->byte1 = ccl->reg[1], char2b->byte2 = ccl->reg[2];
    }
  else if (font_info->encoding[charset])
    {
      /* Fixed encoding scheme.  See fontset.h for the meaning of the
	 encoding numbers.  */
      int enc = font_info->encoding[charset];
Juanma Barranquero's avatar
Juanma Barranquero committed
939

940 941 942
      if ((enc == 1 || enc == 2)
	  && CHARSET_DIMENSION (charset) == 2)
	char2b->byte1 |= 0x80;
Juanma Barranquero's avatar
Juanma Barranquero committed
943

944 945 946 947
      if (enc == 1 || enc == 3)
	char2b->byte2 |= 0x80;
    }

948
  if (two_byte_p)
949
    *two_byte_p = ((XFontStruct *) (font_info->font))->max_byte1 > 0;
950

951
  return FONT_TYPE_UNKNOWN;
952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
}



/***********************************************************************
			    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 *));
967
static void x_draw_composite_glyph_string_foreground P_ ((struct glyph_string *));
968 969 970 971 972 973 974
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,
975
				      unsigned long *, double, int));
976
static void x_setup_relief_color P_ ((struct frame *, struct relief *,
977
				      double, int, unsigned long));
978 979 980 981 982 983 984 985
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,
986 987
				    int, int, int, int, int, int,
				    XRectangle *));
988 989
static void x_draw_box_rect P_ ((struct glyph_string *, int, int, int, int,
				 int, int, int, XRectangle *));
990 991 992 993

#if GLYPH_DEBUG
static void x_check_font P_ ((struct frame *, XFontStruct *));
#endif
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005


/* 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)
1006
      && !s->cmp)
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050
    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.font = s->font->fid;
      xgcv.graphics_exposures = False;
      mask = GCForeground | GCBackground | GCFont | GCGraphicsExposures;

      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
1051

1052 1053 1054
static void
x_set_mouse_face_gc (s)
     struct glyph_string *s;
Juanma Barranquero's avatar
Juanma Barranquero committed
1055
{
1056
  int face_id;
1057
  struct face *face;
1058

1059
  /* What face has to be used last for the mouse face?  */
1060
  face_id = FRAME_X_DISPLAY_INFO (s->f)->mouse_face_face_id;
1061
  face = FACE_FROM_ID (s->f, face_id);
1062 1063
  if (face == NULL)
    face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
Juanma Barranquero's avatar
Juanma Barranquero committed
1064

1065 1066 1067 1068
  if (s->first_glyph->type == CHAR_GLYPH)
    face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch);
  else
    face_id = FACE_FOR_CHAR (s->f, face, 0);
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
  s->face = FACE_FROM_ID (s->f, face_id);
  PREPARE_FACE_FOR_DISPLAY (s->f, s->face);

  /* If font in this face is same as S->font, use it.  */
  if (s->font == s->face->font)
    s->gc = s->face->gc;
  else
    {
      /* Otherwise construct scratch_cursor_gc with values from FACE
	 but font FONT.  */
      XGCValues xgcv;
      unsigned long mask;
Juanma Barranquero's avatar
Juanma Barranquero committed
1081

1082 1083 1084 1085 1086 1087
      xgcv.background = s->face->background;
      xgcv.foreground = s->face->foreground;
      IF_DEBUG (x_check_font (s->f, s->font));
      xgcv.font = s->font->fid;
      xgcv.graphics_exposures = False;
      mask = GCForeground | GCBackground | GCFont | GCGraphicsExposures;
Juanma Barranquero's avatar
Juanma Barranquero committed
1088

1089 1090 1091 1092 1093 1094
      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
1095