xterm.c 347 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 8 9

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
10
the Free Software Foundation; either version 3, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
11 12 13 14 15 16 17 18 19
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
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22

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

26 27
#include <config.h>

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

32 33
#include <stdio.h>

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

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

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

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

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

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
105 106 107 108
#ifdef USE_FONT_BACKEND
#include "font.h"
#endif	/* USE_FONT_BACKEND */

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
116 117 118
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
119
#endif
120

Jan Djärv's avatar
Jan Djärv committed
121
#ifdef USE_X_TOOLKIT
122 123 124 125
#if (XtSpecificationRelease >= 5) && !defined(NO_EDITRES)
#define HACK_EDITRES
extern void _XEditResCheckMessages ();
#endif /* not NO_EDITRES */
126 127 128 129 130 131 132

/* 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>
133 134 135
#else /* !USE_MOTIF i.e. use Xaw */

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

149 150
#endif /* USE_X_TOOLKIT */

Jan Djärv's avatar
Jan Djärv committed
151
#if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK)
152
#define x_any_window_to_frame x_window_to_frame
153
#define x_top_window_to_frame x_window_to_frame
154 155
#endif

156
#ifdef USE_X_TOOLKIT
Karl Heuer's avatar
Karl Heuer committed
157
#include "widget.h"
158 159 160 161 162
#ifndef XtNinitialState
#define XtNinitialState "initialState"
#endif
#endif

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

170 171


172
/* Non-nil means Emacs uses toolkit scroll bars.  */
173

174
Lisp_Object Vx_toolkit_scroll_bars;
175 176 177 178 179 180

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

static int any_help_event_p;

181
/* Last window where we saw the mouse.  Used by mouse-autoselect-window.  */
182
static Lisp_Object last_window;
183

184 185 186 187
/* Non-zero means make use of UNDERLINE_POSITION font properties.  */

int x_use_underline_position_properties;

188 189 190 191
/* Non-zero means to draw the underline at the same place as the descent line.  */

int x_underline_at_descent_line;

192 193 194
/* This is a chain of structures for all the X displays currently in
   use.  */

195
struct x_display_info *x_display_list;
Jim Blandy's avatar
Jim Blandy committed
196

197 198 199 200 201
/* 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.  */

202
Lisp_Object x_display_name_list;
203

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

209
extern struct frame *updating_frame;
Jim Blandy's avatar
Jim Blandy committed
210

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

213 214
struct frame *pending_autoraise_frame;

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

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

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

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

236 237
/* Mouse movement.

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

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

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

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

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

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

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

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

281 282
static Time last_mouse_movement_time;

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

static Time last_user_time;

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

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

296
/* Used locally within XTread_socket.  */
297

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

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

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

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

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

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

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

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

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

317
extern EMACS_INT extra_keyboard_modifiers;
318

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

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

328 329 330 331
/* Used in x_flush.  */

extern Lisp_Object Vinhibit_redisplay;

Gerd Moellmann's avatar
Gerd Moellmann committed
332
extern XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
Dave Love's avatar
Dave Love committed
333
extern int x_bitmap_mask P_ ((FRAME_PTR, int));
334

335
static int x_alloc_nearest_color_1 P_ ((Display *, Colormap, XColor *));
336
static void x_set_window_size_1 P_ ((struct frame *, int, int, int));
337
static const XColor *x_color_cells P_ ((Display *, int *));
338
static void x_update_window_end P_ ((struct window *, int, int));
339

340
static int x_io_error_quitter P_ ((Display *));
341 342
static struct terminal *x_create_terminal P_ ((struct x_display_info *));
void x_delete_terminal P_ ((struct terminal *));
343 344 345 346
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 *));
347 348
static void XTset_terminal_modes P_ ((struct terminal *));
static void XTreset_terminal_modes P_ ((struct terminal *));
Karoly Lorentey's avatar
Karoly Lorentey committed
349
static void x_clear_frame P_ ((struct frame *));
350 351 352
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
353 354 355 356
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 *));
357 358 359
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 *));
360 361
static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int,
				   enum text_cursor_kinds));
362

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

382 383 384 385 386 387 388

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

static void
x_flush (f)
     struct frame *f;
{
389 390 391 392 393
  /* Don't call XFlush when it is not safe to redisplay; the X
     connection may be broken.  */
  if (!NILP (Vinhibit_redisplay))
    return;

394 395 396 397 398
  BLOCK_INPUT;
  if (f == NULL)
    {
      Lisp_Object rest, frame;
      FOR_EACH_FRAME (rest, frame)
399 400
        if (FRAME_X_P (XFRAME (frame)))
          x_flush (XFRAME (frame));
401 402 403 404 405 406
    }
  else if (FRAME_X_P (f))
    XFlush (FRAME_X_DISPLAY (f));
  UNBLOCK_INPUT;
}

Jim Blandy's avatar
Jim Blandy committed
407

408 409 410 411 412 413 414
/* 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
415
#define XFlush(DISPLAY)	(void) 0
416

417

418 419 420 421
/***********************************************************************
			      Debugging
 ***********************************************************************/

422
#if 0
423 424 425

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

Juanma Barranquero's avatar
Juanma Barranquero committed
427
struct record
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
{
  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 */
450 451


452

453 454 455 456 457 458 459 460 461 462 463
/* 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;
464

465 466
  return 0;
}
467

468 469 470 471 472

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

474 475 476 477 478
/* 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
479

Andreas Schwab's avatar
Andreas Schwab committed
480
static void
481
x_update_begin (f)
Jim Blandy's avatar
Jim Blandy committed
482
     struct frame *f;
483
{
484 485
  /* Nothing to do.  */
}
Jim Blandy's avatar
Jim Blandy committed
486 487


488 489 490
/* 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
491

492 493 494 495 496 497
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
498

499 500
  updated_window = w;
  set_output_cursor (&w->cursor);
501

502
  BLOCK_INPUT;
503

504
  if (f == display_info->mouse_face_mouse_frame)
505
    {
506
      /* Don't do highlighting for mouse motion during the update.  */
507
      display_info->mouse_face_defer = 1;
508

509 510
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
511
      if (FRAME_GARBAGED_P (f))
512 513
	display_info->mouse_face_window = Qnil;

514 515 516 517 518 519
#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
520

521 522 523 524 525 526 527
      /* 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))
528
	{
529
	  int i;
530

531 532
	  for (i = 0; i < w->desired_matrix->nrows; ++i)
	    if (MATRIX_ROW_ENABLED_P (w->desired_matrix, i))
533 534
	      break;

535 536
	  if (i < w->desired_matrix->nrows)
	    clear_mouse_face (display_info);
537
	}
538
#endif /* 0 */
539
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
540

Jim Blandy's avatar
Jim Blandy committed
541 542 543
  UNBLOCK_INPUT;
}

544

545
/* Draw a vertical window border from (x,y0) to (x,y1)  */
546

Andreas Schwab's avatar
Andreas Schwab committed
547
static void
548
x_draw_vertical_window_border (w, x, y0, y1)
549
     struct window *w;
550
     int x, y0, y1;
551
{
552
  struct frame *f = XFRAME (WINDOW_FRAME (w));
553 554 555 556 557 558
  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);
559

560 561
  XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
	     f->output_data.x->normal_gc, x, y0, x, y1);
562
}
Juanma Barranquero's avatar
Juanma Barranquero committed
563

564 565 566 567 568 569 570 571 572 573 574 575
/* 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.  */
576 577

static void
578
x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
579
     struct window *w;
580
     int cursor_on_p, mouse_face_overwritten_p;
581
{
582
  struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
Juanma Barranquero's avatar
Juanma Barranquero committed
583

584 585 586
  if (!w->pseudo_window_p)
    {
      BLOCK_INPUT;
587

588
      if (cursor_on_p)
589 590 591
	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
592

593 594
      if (draw_window_fringes (w, 1))
	x_draw_vertical_border (w);
Kenichi Handa's avatar
Kenichi Handa committed
595

596 597
      UNBLOCK_INPUT;
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
598

599 600 601 602 603 604 605 606
  /* 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
607

608 609
  updated_window = NULL;
}
Jim Blandy's avatar
Jim Blandy committed
610 611


612 613 614 615 616 617 618 619
/* 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.  */
620
  FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
621

622
#ifndef XFlush
623
  BLOCK_INPUT;
624
  XFlush (FRAME_X_DISPLAY (f));
Jim Blandy's avatar
Jim Blandy committed
625
  UNBLOCK_INPUT;
626
#endif
Jim Blandy's avatar
Jim Blandy committed
627
}
628

629 630 631 632

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

Andreas Schwab's avatar
Andreas Schwab committed
634
static void
635
XTframe_up_to_date (f)
636
     struct frame *f;
637
{
638
  if (FRAME_X_P (f))
639
    {
640
      struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
641

642 643 644 645 646 647 648 649 650 651 652
      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;
	}
653
    }
654
}
655 656 657


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
658
   arrow bitmaps, or clear the fringes if no bitmaps are required
659 660 661 662 663 664 665 666 667 668
   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;
669
  struct frame *f;
670
  int width, height;
Juanma Barranquero's avatar
Juanma Barranquero committed
671

672
  xassert (w);
Juanma Barranquero's avatar
Juanma Barranquero committed
673

674
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
Kenichi Handa's avatar
Kenichi Handa committed
675
    desired_row->redraw_fringe_bitmaps_p = 1;
Juanma Barranquero's avatar
Juanma Barranquero committed
676

677 678 679 680 681 682 683 684 685 686
  /* 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),
687 688 689
	  width != 0)
      && (height = desired_row->visible_height,
	  height > 0))
690 691
    {
      int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
692

693 694 695 696
      /* 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
697

698 699 700 701
      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),
702
		    FRAME_PIXEL_WIDTH (f) - width,
703
		    y, width, height, False);
704 705 706 707 708
      UNBLOCK_INPUT;
    }
}

static void
Kim F. Storm's avatar
Kim F. Storm committed
709
x_draw_fringe_bitmap (w, row, p)
710 711
     struct window *w;
     struct glyph_row *row;
Kim F. Storm's avatar
Kim F. Storm committed
712
     struct draw_fringe_bitmap_params *p;
713 714 715 716 717
{
  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
718
  struct face *face = p->face;
Kenichi Handa's avatar
Kenichi Handa committed
719
  int rowY;
720 721

  /* Must clip because of partially visible lines.  */
Kenichi Handa's avatar
Kenichi Handa committed
722 723 724 725 726 727 728 729 730
  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;
731
      x_clip_to_row (w, row, -1, gc);
Kenichi Handa's avatar
Kenichi Handa committed
732 733 734 735
      row->y = oldY;
      row->visible_height = oldVH;
    }
  else
736
    x_clip_to_row (w, row, -1, gc);
737

738
  if (!p->overlay_p)
739
    {
740 741
      int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;

742 743 744 745 746 747 748 749
      /* 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
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 792 793 794 795 796 797 798 799
#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
800

801 802 803 804
      if (!face->stipple)
	XSetForeground (display, face->gc, face->foreground);
    }

Kenichi Handa's avatar
Kenichi Handa committed
805
  if (p->which)
806
    {
Kenichi Handa's avatar
Kenichi Handa committed
807 808
      unsigned char *bits;
      Pixmap pixmap, clipmask = (Pixmap) 0;
Kim F. Storm's avatar
Kim F. Storm committed
809
      int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
Kenichi Handa's avatar
Kenichi Handa committed
810 811 812 813 814 815
      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
816

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

      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
838 839
      XCopyArea (display, pixmap, window, gc, 0, 0,
		 p->wd, p->h, p->x, p->y);
840
      XFreePixmap (display, pixmap);
Kenichi Handa's avatar
Kenichi Handa committed
841 842 843 844 845 846 847

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

850 851 852
  XSetClipMask (display, gc, None);
}

Jim Blandy's avatar
Jim Blandy committed
853

854 855 856 857 858

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

Andreas Schwab's avatar
Andreas Schwab committed
860
static void
861
XTset_terminal_modes (struct terminal *terminal)
Jim Blandy's avatar
Jim Blandy committed
862 863 864
{
}

865 866
/* 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
867

Andreas Schwab's avatar
Andreas Schwab committed
868
static void
869
XTreset_terminal_modes (struct terminal *terminal)
Jim Blandy's avatar
Jim Blandy committed
870 871
{
}
872 873 874 875 876 877 878 879 880


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

/* Function prototypes of this page.  */

Kenichi Handa's avatar
Kenichi Handa committed
881 882
static int x_encode_char P_ ((int, XChar2b *, struct font_info *,
			      struct charset *, int *));
883 884


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

888 889
static XCharStruct *
x_per_char_metric (font, char2b, font_type)
890 891
     XFontStruct *font;
     XChar2b *char2b;
892
     int font_type;  /* unused on X */
893 894 895
{
  /* The result metric information.  */
  XCharStruct *pcm = NULL;
Jim Blandy's avatar
Jim Blandy committed
896

897
  xassert (font && char2b);
Jim Blandy's avatar
Jim Blandy committed
898

899
  if (font->per_char != NULL)
Jim Blandy's avatar
Jim Blandy committed
900
    {
901
      if (font->min_byte1 == 0 && font->max_byte1 == 0)
902
	{
903 904 905 906 907 908 909 910 911 912
	  /* 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;
913
	}
914
      else
Jim Blandy's avatar
Jim Blandy committed
915
	{
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938
	  /* 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
939
	}
940 941 942 943 944 945 946 947 948 949
    }
  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
950

951
  return ((pcm == NULL
952
	   || (pcm->width == 0 && (pcm->rbearing - pcm->lbearing) == 0))
953
	  ? NULL : pcm);
954
}
955

956

957 958
/* Encode CHAR2B using encoding information from FONT_INFO.  CHAR2B is
   the two-byte form of C.  Encoding is returned in *CHAR2B.  */
959

960
static int
Kenichi Handa's avatar
Kenichi Handa committed
961
x_encode_char (c, char2b, font_info, charset, two_byte_p)
962 963 964
     int c;
     XChar2b *char2b;
     struct font_info *font_info;
Kenichi Handa's avatar
Kenichi Handa committed
965
     struct charset *charset;
966
     int *two_byte_p;
967 968 969 970 971 972 973 974 975 976 977
{
  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;

978
      check_ccl_update (ccl);
979 980
      if (CHARSET_DIMENSION (charset) == 1)
	{
Kenichi Handa's avatar
Kenichi Handa committed
981
	  ccl->reg[0] = CHARSET_ID (charset);
982
	  ccl->reg[1] = char2b->byte2;
983
	  ccl->reg[2] = -1;
984 985 986
	}
      else
	{
Kenichi Handa's avatar
Kenichi Handa committed
987
	  ccl->reg[0] = CHARSET_ID (charset);
988 989 990
	  ccl->reg[1] = char2b->byte1;
	  ccl->reg[2] = char2b->byte2;
	}
Juanma Barranquero's avatar
Juanma Barranquero committed
991

992
      ccl_driver (ccl, NULL, NULL, 0, 0, Qnil);
Juanma Barranquero's avatar
Juanma Barranquero committed
993

994 995 996
      /* We assume that MSBs are appropriately set/reset by CCL
	 program.  */
      if (font->max_byte1 == 0)	/* 1-byte font */
Kenichi Handa's avatar
Kenichi Handa committed
997
	STORE_XCHAR2B (char2b, 0, ccl->reg[1]);
998
      else
Kenichi Handa's avatar
Kenichi Handa committed
999
	STORE_XCHAR2B (char2b, ccl->reg[1], ccl->reg[2]);
1000
    }
Kenichi Handa's avatar
Kenichi Handa committed
1001
  else if (font_info->encoding_type)
1002 1003 1004
    {
      /* Fixed encoding scheme.  See fontset.h for the meaning of the
	 encoding numbers.  */
Kenichi Handa's avatar
Kenichi Handa committed
1005
      unsigned char enc = font_info->encoding_type;
Juanma Barranquero's avatar
Juanma Barranquero committed
1006

1007 1008 1009
      if ((enc == 1 || enc == 2)
	  && CHARSET_DIMENSION (charset) == 2)
	char2b->byte1 |= 0x80;
Juanma Barranquero's avatar
Juanma Barranquero committed
1010

1011 1012 1013 1014
      if (enc == 1 || enc == 3)
	char2b->byte2 |= 0x80;
    }

1015
  if (two_byte_p)
1016
    *two_byte_p = ((XFontStruct *) (font_info->font))->max_byte1 > 0;
1017

1018
  return FONT_TYPE_UNKNOWN;
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
}



/***********************************************************************
			    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 *));
1034
static void x_draw_composite_glyph_string_foreground P_ ((struct glyph_string *));
1035 1036 1037 1038 1039 1040 1041
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,
1042
				      unsigned long *, double, int));
1043
static void x_setup_relief_color P_ ((struct frame *, struct relief *,
1044
				      double, int, unsigned long));
1045 1046 1047 1048 1049 1050 1051 1052
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,
1053 1054
				    int, int, int, int, int, int,
				    XRectangle *));
1055 1056
static void x_draw_box_rect P_ ((struct glyph_string *, int, int, int, int,
				 int, int, int, XRectangle *));
1057 1058 1059 1060

#if GLYPH_DEBUG
static void x_check_font P_ ((struct frame *, XFontStruct *));
#endif
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072


/* 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)
1073
      && !s->cmp)
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100
    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));
1101 1102 1103