xterm.c 318 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* X Communication module for terminals which understand the X protocol.
2
   Copyright (C) 1989, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
3
                 2002, 2003, 2004, 2005 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

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 "coding.h"
71
#include "ccl.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 78 79 80
#include "termhooks.h"
#include "termopts.h"
#include "termchar.h"
#include "gnu.h"
#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"
Jim Blandy's avatar
Jim Blandy committed
87

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

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

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

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

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

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

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

/* Include toolkit specific headers for the scroll bar widget.  */

#ifdef USE_TOOLKIT_SCROLL_BARS
#if defined USE_MOTIF
#include <Xm/Xm.h>		/* for LESSTIF_VERSION */
#include <Xm/ScrollBar.h>
127 128 129
#else /* !USE_MOTIF i.e. use Xaw */

#ifdef HAVE_XAW3D
130 131
#include <X11/Xaw3d/Simple.h>
#include <X11/Xaw3d/Scrollbar.h>
132
#include <X11/Xaw3d/ThreeD.h>
133 134 135 136 137 138 139 140
#else /* !HAVE_XAW3D */
#include <X11/Xaw/Simple.h>
#include <X11/Xaw/Scrollbar.h>
#endif /* !HAVE_XAW3D */
#ifndef XtNpickTop
#define XtNpickTop "pickTop"
#endif /* !XtNpickTop */
#endif /* !USE_MOTIF */
141 142
#endif /* USE_TOOLKIT_SCROLL_BARS */

143 144
#endif /* USE_X_TOOLKIT */

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

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

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

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

166 167


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

170
Lisp_Object Vx_toolkit_scroll_bars;
171 172 173 174 175 176

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

static int any_help_event_p;

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

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

int x_use_underline_position_properties;

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
struct frame *pending_autoraise_frame;

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

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

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

217 218 219 220 221 222 223 224 225 226 227
/* 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;

228 229
/* Mouse movement.

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

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

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

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

254 255
/* The scroll bar in which the last X motion event occurred.

256 257
   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
258 259
   an ordinary motion.

260 261 262 263
   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.  */

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

273 274
static Time last_mouse_movement_time;

275 276 277
/* Incremented by XTread_socket whenever it really tries to read
   events.  */

278 279 280 281 282 283
#ifdef __STDC__
static int volatile input_signal_count;
#else
static int input_signal_count;
#endif

284
/* Used locally within XTread_socket.  */
285

286
static int x_noop_count;
Jim Blandy's avatar
Jim Blandy committed
287

288
/* Initial values of argv and argc.  */
289

290 291
extern char **initial_argv;
extern int initial_argc;
Jim Blandy's avatar
Jim Blandy committed
292

293
extern Lisp_Object Vcommand_line_args, Vsystem_name;
Jim Blandy's avatar
Jim Blandy committed
294

295
/* Tells if a window manager is present or not.  */
296 297

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

299
extern Lisp_Object Qeql;
300

Jim Blandy's avatar
Jim Blandy committed
301 302
extern int errno;

303
/* A mask of extra modifier bits to put into every keyboard char.  */
304

305
extern EMACS_INT extra_keyboard_modifiers;
306

307 308 309
/* 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
310
Lisp_Object Vx_keysym_table;
311 312
static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;

313
static Lisp_Object Qvendor_specific_keysyms;
Dave Love's avatar
Dave Love committed
314
static Lisp_Object Qlatin_1;
315

316 317 318 319
/* Used in x_flush.  */

extern Lisp_Object Vinhibit_redisplay;

Gerd Moellmann's avatar
Gerd Moellmann committed
320
extern XrmDatabase x_load_resources P_ ((Display *, char *, char *, char *));
Dave Love's avatar
Dave Love committed
321
extern int x_bitmap_mask P_ ((FRAME_PTR, int));
322

323
static int x_alloc_nearest_color_1 P_ ((Display *, Colormap, XColor *));
324
static void x_set_window_size_1 P_ ((struct frame *, int, int, int));
325
static const XColor *x_color_cells P_ ((Display *, int *));
326
static void x_update_window_end P_ ((struct window *, int, int));
327 328 329 330 331 332 333 334 335 336 337 338 339 340
void x_delete_display P_ ((struct x_display_info *));
static unsigned int x_x_to_emacs_modifiers P_ ((struct x_display_info *,
						unsigned));
static int x_io_error_quitter P_ ((Display *));
int x_catch_errors P_ ((Display *));
void x_uncatch_errors P_ ((Display *, int));
void x_lower_frame P_ ((struct frame *));
void x_scroll_bar_clear P_ ((struct frame *));
int x_had_errors_p P_ ((Display *));
void x_wm_set_size_hint P_ ((struct frame *, long, int));
void x_raise_frame P_ ((struct frame *));
void x_set_window_size P_ ((struct frame *, int, int, int));
void x_wm_set_window_state P_ ((struct frame *, int));
void x_wm_set_icon_pixmap P_ ((struct frame *, int));
341 342
struct device *x_create_device P_ ((struct x_display_info *));
void x_delete_device P_ ((struct device *));
343 344 345 346 347
void x_initialize P_ ((void));
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 *));
348 349
static void XTset_terminal_modes P_ ((struct device *));
static void XTreset_terminal_modes P_ ((struct device *));
Karoly Lorentey's avatar
Karoly Lorentey committed
350
static void x_clear_frame P_ ((struct frame *));
351 352 353
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 *));
354 355 356 357
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 *));
358 359 360
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 *));
361 362
static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int,
				   enum text_cursor_kinds));
363

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

379 380 381 382 383 384 385

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

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

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

Jim Blandy's avatar
Jim Blandy committed
404

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

414

415 416 417 418
/***********************************************************************
			      Debugging
 ***********************************************************************/

419
#if 0
420 421 422

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

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


449

450 451 452 453 454 455 456 457 458 459 460
/* 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;
461

462 463
  return 0;
}
464

465 466 467 468 469

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

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

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

484

485 486 487
/* 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
488

489 490 491 492 493 494
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
495

496 497
  updated_window = w;
  set_output_cursor (&w->cursor);
498

499
  BLOCK_INPUT;
500

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

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

511 512 513 514 515 516
#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
517

518 519 520 521 522 523 524
      /* 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))
525
	{
526
	  int i;
527

528 529
	  for (i = 0; i < w->desired_matrix->nrows; ++i)
	    if (MATRIX_ROW_ENABLED_P (w->desired_matrix, i))
530 531
	      break;

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

Jim Blandy's avatar
Jim Blandy committed
538 539 540
  UNBLOCK_INPUT;
}

541

542
/* Draw a vertical window border from (x,y0) to (x,y1)  */
543

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

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

561 562 563 564 565 566 567 568 569 570 571 572
/* 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.  */
573 574

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

581 582 583
  if (!w->pseudo_window_p)
    {
      BLOCK_INPUT;
584

585
      if (cursor_on_p)
586 587 588
	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
589

590 591
      if (draw_window_fringes (w, 1))
	x_draw_vertical_border (w);
592

593 594
      UNBLOCK_INPUT;
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
595

596 597 598 599 600 601 602 603
  /* 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
604

605 606
  updated_window = NULL;
}
Jim Blandy's avatar
Jim Blandy committed
607 608


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

619
#ifndef XFlush
620
  BLOCK_INPUT;
621
  XFlush (FRAME_X_DISPLAY (f));
Jim Blandy's avatar
Jim Blandy committed
622
  UNBLOCK_INPUT;
623
#endif
Jim Blandy's avatar
Jim Blandy committed
624
}
625

626 627 628 629

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

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

639 640 641 642 643 644 645 646 647 648 649
      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;
	}
650
    }
651
}
652 653 654


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

669
  xassert (w);
Juanma Barranquero's avatar
Juanma Barranquero committed
670

671
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
672
    desired_row->redraw_fringe_bitmaps_p = 1;
Juanma Barranquero's avatar
Juanma Barranquero committed
673

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

690 691 692 693
      /* 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
694

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

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

  /* Must clip because of partially visible lines.  */
719 720 721 722 723 724 725 726 727
  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;
728
      x_clip_to_row (w, row, -1, gc);
729 730 731 732
      row->y = oldY;
      row->visible_height = oldVH;
    }
  else
733
    x_clip_to_row (w, row, -1, gc);
734

735
  if (p->bx >= 0 && !p->overlay_p)
736 737 738 739 740 741 742 743 744
    {
      /* 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
745

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

749 750 751 752
      if (!face->stipple)
	XSetForeground (display, face->gc, face->foreground);
    }

753
  if (p->which)
754
    {
755
      unsigned char *bits;
756
      Pixmap pixmap, clipmask = (Pixmap) 0;
Kim F. Storm's avatar
Kim F. Storm committed
757
      int depth = DefaultDepthOfScreen (FRAME_X_SCREEN (f));
758
      XGCValues gcv;
Kim F. Storm's avatar
Kim F. Storm committed
759

760 761 762 763
      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
764

765 766
      /* Draw the bitmap.  I believe these small pixmaps can be cached
	 by the server.  */
Kim F. Storm's avatar
Kim F. Storm committed
767
      pixmap = XCreatePixmapFromBitmapData (display, window, bits, p->wd, p->h,
768 769 770 771
					    (p->cursor_p
					     ? (p->overlay_p ? face->background
						: f->output_data.x->cursor_pixel)
					     : face->foreground),
772
					    face->background, depth);
773 774 775

      if (p->overlay_p)
	{
776
	  clipmask = XCreatePixmapFromBitmapData (display,
777
						  FRAME_X_DISPLAY_INFO (f)->root_window,
778
						  bits, p->wd, p->h,
779 780 781
						  1, 0, 1);
	  gcv.clip_mask = clipmask;
	  gcv.clip_x_origin = p->x;
782
	  gcv.clip_y_origin = p->y;
783 784 785
	  XChangeGC (display, gc, GCClipMask | GCClipXOrigin | GCClipYOrigin, &gcv);
	}

Kim F. Storm's avatar
Kim F. Storm committed
786 787
      XCopyArea (display, pixmap, window, gc, 0, 0,
		 p->wd, p->h, p->x, p->y);
788
      XFreePixmap (display, pixmap);
789 790 791 792 793 794 795

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

798 799 800
  XSetClipMask (display, gc, None);
}

Jim Blandy's avatar
Jim Blandy committed
801

802 803 804 805 806

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

Andreas Schwab's avatar
Andreas Schwab committed
808
static void
809
XTset_terminal_modes (struct device *device)
Jim Blandy's avatar
Jim Blandy committed
810 811 812
{
}

813 814
/* 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
815

Andreas Schwab's avatar
Andreas Schwab committed
816
static void
817
XTreset_terminal_modes (struct device *device)
Jim Blandy's avatar
Jim Blandy committed
818 819
{
}
820 821 822 823 824 825 826 827 828


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

/* Function prototypes of this page.  */

829
static int x_encode_char P_ ((int, XChar2b *, struct font_info *, int *));
830 831


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

835 836
static XCharStruct *
x_per_char_metric (font, char2b, font_type)
837 838
     XFontStruct *font;
     XChar2b *char2b;
839
     int font_type;  /* unused on X */
840 841 842
{
  /* The result metric information.  */
  XCharStruct *pcm = NULL;
Jim Blandy's avatar
Jim Blandy committed
843

844
  xassert (font && char2b);
Jim Blandy's avatar
Jim Blandy committed
845

846
  if (font->per_char != NULL)
Jim Blandy's avatar
Jim Blandy committed
847
    {
848
      if (font->min_byte1 == 0 && font->max_byte1 == 0)
849
	{
850 851 852 853 854 855 856 857 858 859
	  /* 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;
860
	}
861
      else
Jim Blandy's avatar
Jim Blandy committed
862
	{
863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
	  /* 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
886
	}
887 888 889 890 891 892 893 894 895 896
    }
  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
897

898
  return ((pcm == NULL
899
	   || (pcm->width == 0 && (pcm->rbearing - pcm->lbearing) == 0))
900
	  ? NULL : pcm);
901
}
902

903

904 905
/* Encode CHAR2B using encoding information from FONT_INFO.  CHAR2B is
   the two-byte form of C.  Encoding is returned in *CHAR2B.  */
906

907 908
static int
x_encode_char (c, char2b, font_info, two_byte_p)
909 910 911
     int c;
     XChar2b *char2b;
     struct font_info *font_info;
912
     int *two_byte_p;
913 914 915 916 917 918 919 920 921 922 923 924
{
  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;

925
      check_ccl_update (ccl);
926 927 928 929
      if (CHARSET_DIMENSION (charset) == 1)
	{
	  ccl->reg[0] = charset;
	  ccl->reg[1] = char2b->byte2;
930
	  ccl->reg[2] = -1;
931 932 933 934 935 936 937
	}
      else
	{
	  ccl->reg[0] = charset;
	  ccl->reg[1] = char2b->byte1;
	  ccl->reg[2] = char2b->byte2;
	}
Juanma Barranquero's avatar
Juanma Barranquero committed
938

939
      ccl_driver (ccl, NULL, NULL, 0, 0, NULL);
Juanma Barranquero's avatar
Juanma Barranquero committed
940

941 942 943
      /* We assume that MSBs are appropriately set/reset by CCL
	 program.  */
      if (font->max_byte1 == 0)	/* 1-byte font */
944
	char2b->byte1 = 0, char2b->byte2 = ccl->reg[1];
945 946 947 948 949 950 951 952
      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
953

954 955 956
      if ((enc == 1 || enc == 2)
	  && CHARSET_DIMENSION (charset) == 2)
	char2b->byte1 |= 0x80;
Juanma Barranquero's avatar
Juanma Barranquero committed
957

958 959 960 961
      if (enc == 1 || enc == 3)
	char2b->byte2 |= 0x80;
    }

962
  if (two_byte_p)
963
    *two_byte_p = ((XFontStruct *) (font_info->font))->max_byte1 > 0;
964

965
  return FONT_TYPE_UNKNOWN;
966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
}



/***********************************************************************
			    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 *));
981
static void x_draw_composite_glyph_string_foreground P_ ((struct glyph_string *));
982 983 984 985 986 987 988
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,
989
				      unsigned long *, double, int));
990
static void x_setup_relief_color P_ ((struct frame *, struct relief *,
991
				      double, int, unsigned long));
992 993 994 995 996 997 998 999
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,
1000 1001
				    int, int, int, int, int, int,
				    XRectangle *));
1002 1003
static void x_draw_box_rect P_ ((struct glyph_string *, int, int, int, int,
				 int, int, int, XRectangle *));
1004 1005 1006 1007

#if GLYPH_DEBUG
static void x_check_font P_ ((struct frame *, XFontStruct *));
#endif
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019


/* 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)
1020
      && !s->cmp)
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 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
    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
1065

1066 1067 1068
static void
x_set_mouse_face_gc (s)
     struct glyph_string *s;
Juanma Barranquero's avatar
Juanma Barranquero committed
1069
{
1070
  int face_id;
1071
  struct face *face;
1072

1073
  /* What face has to be used last for the mouse face?  */
1074
  face_id = FRAME_X_DISPLAY_INFO (s->f)->mouse_face_face_id;
1075
  face = FACE_FROM_ID (s->f, face_id);
1076 1077
  if (face == NULL)
    face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
Juanma Barranquero's avatar
Juanma Barranquero committed
1078

1079 1080 1081