xterm.c 316 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* X Communication module for terminals which understand the X protocol.
2
   Copyright (C) 1989, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001,
Glenn Morris's avatar
Glenn Morris committed
3
                 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
Glenn Morris's avatar
Glenn Morris committed
4
                 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20

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

24
#include <config.h>
25
#include <signal.h>
26
#include <stdio.h>
27
#include <setjmp.h>
28

Jim Blandy's avatar
Jim Blandy committed
29 30 31
#ifdef HAVE_X_WINDOWS

#include "lisp.h"
32
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
33

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

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

Dan Nicolaescu's avatar
Dan Nicolaescu committed
49
#ifdef HAVE_SYS_IOCTL_H
Jim Blandy's avatar
Jim Blandy committed
50
#include <sys/ioctl.h>
Dan Nicolaescu's avatar
Dan Nicolaescu committed
51
#endif /* ! defined (HAVE_SYS_IOCTL_H) */
Jim Blandy's avatar
Jim Blandy committed
52

Jim Blandy's avatar
Jim Blandy committed
53
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
54 55 56 57 58 59

#include <fcntl.h>
#include <ctype.h>
#include <errno.h>
#include <setjmp.h>
#include <sys/stat.h>
Richard M. Stallman's avatar
Richard M. Stallman committed
60 61
/* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed.  */
/* #include <sys/param.h>  */
Jim Blandy's avatar
Jim Blandy committed
62

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

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

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

102
#ifdef USE_LUCID
103
#include "../lwlib/xlwmenu.h"
104 105
#endif

Jan Djärv's avatar
Jan Djärv committed
106
#ifdef USE_X_TOOLKIT
Dan Nicolaescu's avatar
Dan Nicolaescu committed
107
#if !defined(NO_EDITRES)
108 109 110
#define HACK_EDITRES
extern void _XEditResCheckMessages ();
#endif /* not NO_EDITRES */
111 112 113 114 115 116 117

/* 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>
118 119 120
#else /* !USE_MOTIF i.e. use Xaw */

#ifdef HAVE_XAW3D
121 122
#include <X11/Xaw3d/Simple.h>
#include <X11/Xaw3d/Scrollbar.h>
123
#include <X11/Xaw3d/ThreeD.h>
124 125 126 127 128 129 130 131
#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 */
132 133
#endif /* USE_TOOLKIT_SCROLL_BARS */

134 135
#endif /* USE_X_TOOLKIT */

136
#ifdef USE_X_TOOLKIT
Karl Heuer's avatar
Karl Heuer committed
137
#include "widget.h"
138 139 140 141 142
#ifndef XtNinitialState
#define XtNinitialState "initialState"
#endif
#endif

Dave Love's avatar
Dave Love committed
143
/* Default to using XIM if available.  */
144
#ifdef USE_XIM
Dave Love's avatar
Dave Love committed
145
int use_xim = 1;
146 147 148 149
#else
int use_xim = 0;  /* configure --without-xim */
#endif

150 151


152
/* Non-nil means Emacs uses toolkit scroll bars.  */
153

154
Lisp_Object Vx_toolkit_scroll_bars;
155 156 157 158 159 160

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

static int any_help_event_p;

161
/* Last window where we saw the mouse.  Used by mouse-autoselect-window.  */
162
static Lisp_Object last_window;
163

164 165 166 167
/* Non-zero means make use of UNDERLINE_POSITION font properties.  */

int x_use_underline_position_properties;

168 169 170 171
/* Non-zero means to draw the underline at the same place as the descent line.  */

int x_underline_at_descent_line;

172 173 174
/* This is a chain of structures for all the X displays currently in
   use.  */

175
struct x_display_info *x_display_list;
Jim Blandy's avatar
Jim Blandy committed
176

177 178 179 180 181
/* 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.  */

182
Lisp_Object x_display_name_list;
183

184
/* Frame being updated by update_frame.  This is declared in term.c.
185 186 187 188
   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.  */

189
extern struct frame *updating_frame;
Jim Blandy's avatar
Jim Blandy committed
190

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

193 194 195 196 197 198 199 200
static struct frame *pending_autoraise_frame;

/* This is a frame waiting for an event matching mask, within XTread_socket.  */

static struct {
  struct frame *f;
  int eventtype;
} pending_event_wait;
201

202 203 204
#ifdef USE_X_TOOLKIT
/* The application context for Xt use.  */
XtAppContext Xt_app_con;
205 206
static String Xt_default_resources[] = {0};
#endif /* USE_X_TOOLKIT */
207

Gerd Moellmann's avatar
Gerd Moellmann committed
208 209 210
/* Non-zero means user is interacting with a toolkit scroll bar.  */

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

Kenichi Handa's avatar
Kenichi Handa committed
212 213 214 215 216 217 218 219 220 221 222
/* 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;

223 224
/* Mouse movement.

225
   Formerly, we used PointerMotionHintMask (in standard_event_mask)
226 227 228 229 230 231
   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.

232 233 234 235 236 237 238 239 240
   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
241
   is off.  */
242 243 244

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

245
static XRectangle last_mouse_glyph;
Kim F. Storm's avatar
Kim F. Storm committed
246
static FRAME_PTR last_mouse_glyph_frame;
247 248
static Lisp_Object last_mouse_press_frame;

249 250
/* The scroll bar in which the last X motion event occurred.

251 252
   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
253 254
   an ordinary motion.

255 256 257 258
   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.  */

259 260 261 262
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
263
   doesn't seem to be any way to wrest the time-stamp from the server
264 265 266
   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.  */
267

268 269
static Time last_mouse_movement_time;

Jan Djärv's avatar
Jan Djärv committed
270 271 272 273
/* Time for last user interaction as returned in X events.  */

static Time last_user_time;

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

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

283
/* Used locally within XTread_socket.  */
284

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

287 288 289
/* 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
290
Lisp_Object Vx_keysym_table;
291 292
static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;

293
static Lisp_Object Qvendor_specific_keysyms;
Dave Love's avatar
Dave Love committed
294
static Lisp_Object Qlatin_1;
295

296 297 298
#ifdef USE_GTK
/* The name of the Emacs icon file.  */
static Lisp_Object xg_default_icon_file;
299 300 301

/* Used in gtkutil.c.  */
Lisp_Object Qx_gtk_map_stock;
302 303
#endif

304 305 306
/* Some functions take this as char *, not const char *.  */
static char emacs_class[] = EMACS_CLASS;

307 308
/* Used in x_flush.  */

309 310
extern XrmDatabase x_load_resources (Display *, const char *, const char *,
				     const char *);
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
extern int x_bitmap_mask (FRAME_PTR, int);

static int x_alloc_nearest_color_1 (Display *, Colormap, XColor *);
static void x_set_window_size_1 (struct frame *, int, int, int);
static const XColor *x_color_cells (Display *, int *);
static void x_update_window_end (struct window *, int, int);

static int x_io_error_quitter (Display *);
static struct terminal *x_create_terminal (struct x_display_info *);
void x_delete_terminal (struct terminal *);
static void x_update_end (struct frame *);
static void XTframe_up_to_date (struct frame *);
static void XTset_terminal_modes (struct terminal *);
static void XTreset_terminal_modes (struct terminal *);
static void x_clear_frame (struct frame *);
static void frame_highlight (struct frame *);
static void frame_unhighlight (struct frame *);
static void x_new_focus_frame (struct x_display_info *, struct frame *);
static void  x_focus_changed (int, int, struct x_display_info *,
                              struct frame *, struct input_event *);
static void x_detect_focus_change (struct x_display_info *,
                                   XEvent *, struct input_event *);
static void XTframe_rehighlight (struct frame *);
static void x_frame_rehighlight (struct x_display_info *);
static void x_draw_hollow_cursor (struct window *, struct glyph_row *);
static void x_draw_bar_cursor (struct window *, struct glyph_row *, int,
                               enum text_cursor_kinds);

static void x_clip_to_row (struct window *, struct glyph_row *, int, GC);
static void x_flush (struct frame *f);
static void x_update_begin (struct frame *);
static void x_update_window_begin (struct window *);
static void x_after_update_window_line (struct glyph_row *);
static struct scroll_bar *x_window_to_scroll_bar (Display *, Window);
static void x_scroll_bar_report_motion (struct frame **, Lisp_Object *,
                                        enum scroll_bar_part *,
                                        Lisp_Object *, Lisp_Object *,
                                        unsigned long *);
static void x_handle_net_wm_state (struct frame *, XPropertyEvent *);
static void x_check_fullscreen (struct frame *);
static void x_check_expected_move (struct frame *, int, int);
static void x_sync_with_move (struct frame *, int, int, int);
static int handle_one_xevent (struct x_display_info *, XEvent *,
                              int *, struct input_event *);
355 356
/* Don't declare this NO_RETURN because we want no
   interference with debugging failing X calls.  */
357
static SIGTYPE x_connection_closed (Display *, const char *);
Jan Djärv's avatar
Jan Djärv committed
358

359 360 361 362

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

static void
363
x_flush (struct frame *f)
364
{
365 366 367 368 369
  /* Don't call XFlush when it is not safe to redisplay; the X
     connection may be broken.  */
  if (!NILP (Vinhibit_redisplay))
    return;

370 371 372 373 374
  BLOCK_INPUT;
  if (f == NULL)
    {
      Lisp_Object rest, frame;
      FOR_EACH_FRAME (rest, frame)
375 376
        if (FRAME_X_P (XFRAME (frame)))
          x_flush (XFRAME (frame));
377 378 379 380 381 382
    }
  else if (FRAME_X_P (f))
    XFlush (FRAME_X_DISPLAY (f));
  UNBLOCK_INPUT;
}

Jim Blandy's avatar
Jim Blandy committed
383

384 385 386 387 388 389 390
/* 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
391
#define XFlush(DISPLAY)	(void) 0
392

393

394 395 396 397
/***********************************************************************
			      Debugging
 ***********************************************************************/

398
#if 0
399 400 401

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

Juanma Barranquero's avatar
Juanma Barranquero committed
403
struct record
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
{
  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 */
426 427


428

429 430 431
/* Return the struct x_display_info corresponding to DPY.  */

struct x_display_info *
432
x_display_info_for_display (Display *dpy)
433 434 435 436 437 438
{
  struct x_display_info *dpyinfo;

  for (dpyinfo = x_display_list; dpyinfo; dpyinfo = dpyinfo->next)
    if (dpyinfo->display == dpy)
      return dpyinfo;
439

440 441
  return 0;
}
442

443 444 445 446
#define OPAQUE  0xffffffff
#define OPACITY "_NET_WM_WINDOW_OPACITY"

void
447
x_set_frame_alpha (struct frame *f)
448 449 450 451
{
  struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
  Display *dpy = FRAME_X_DISPLAY (f);
  Window win = FRAME_OUTER_WINDOW (f);
452 453
  double alpha = 1.0;
  double alpha_min = 1.0;
454 455
  unsigned long opac;

456 457 458
  if (FRAME_X_DISPLAY_INFO (f)->root_window != FRAME_X_OUTPUT (f)->parent_desc)
    /* Since the WM decoration lies under the FRAME_OUTER_WINDOW,
       we must treat the former instead of the latter. */
459
    win = FRAME_X_OUTPUT (f)->parent_desc;
460 461 462 463 464 465 466 467 468 469 470

  if (dpyinfo->x_highlight_frame == f)
    alpha = f->alpha[0];
  else
    alpha = f->alpha[1];

  if (FLOATP (Vframe_alpha_lower_limit))
    alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
  else if (INTEGERP (Vframe_alpha_lower_limit))
    alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;

471 472 473
  if (alpha < 0.0)
    return;
  else if (alpha > 1.0)
474 475 476 477
    alpha = 1.0;
  else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
    alpha = alpha_min;

478
  opac = alpha * OPAQUE;
479 480 481 482 483

  /* return unless necessary */
  {
    unsigned char *data;
    Atom actual;
484
    int rc, format;
485 486
    unsigned long n, left;

487
    x_catch_errors (dpy);
488 489 490 491
    rc = XGetWindowProperty (dpy, win, XInternAtom(dpy, OPACITY, False),
			     0L, 1L, False, XA_CARDINAL,
			     &actual, &format, &n, &left,
			     &data);
492 493

    if (rc == Success && actual != None)
494
      if (*(unsigned long *)data == opac)
495 496
	{
	  XFree ((void *) data);
497
	  x_uncatch_errors ();
498 499 500
	  return;
	}
      else
501
	XFree ((void *) data);
502
    x_uncatch_errors ();
503 504
  }

505
  x_catch_errors (dpy);
506 507 508
  XChangeProperty (dpy, win, XInternAtom (dpy, OPACITY, False),
		   XA_CARDINAL, 32, PropModeReplace,
		   (unsigned char *) &opac, 1L);
509
  x_uncatch_errors ();
510
}
511

512
int
513
x_display_pixel_height (struct x_display_info *dpyinfo)
514 515 516 517 518
{
  return HeightOfScreen (dpyinfo->screen);
}

int
519
x_display_pixel_width (struct x_display_info *dpyinfo)
520 521 522 523
{
  return WidthOfScreen (dpyinfo->screen);
}

524 525 526 527

/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
Juanma Barranquero's avatar
Juanma Barranquero committed
528

529 530 531 532 533
/* 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
534

Andreas Schwab's avatar
Andreas Schwab committed
535
static void
536
x_update_begin (struct frame *f)
537
{
538 539
  /* Nothing to do.  */
}
Jim Blandy's avatar
Jim Blandy committed
540 541


542 543 544
/* 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
545

546
static void
547
x_update_window_begin (struct window *w)
548 549 550
{
  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
551

552 553
  updated_window = w;
  set_output_cursor (&w->cursor);
554

555
  BLOCK_INPUT;
556

557
  if (f == display_info->mouse_face_mouse_frame)
558
    {
559
      /* Don't do highlighting for mouse motion during the update.  */
560
      display_info->mouse_face_defer = 1;
561

562 563
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
564
      if (FRAME_GARBAGED_P (f))
565
	display_info->mouse_face_window = Qnil;
566
    }
Richard M. Stallman's avatar
Richard M. Stallman committed
567

Jim Blandy's avatar
Jim Blandy committed
568 569 570
  UNBLOCK_INPUT;
}

571

572
/* Draw a vertical window border from (x,y0) to (x,y1)  */
573

Andreas Schwab's avatar
Andreas Schwab committed
574
static void
575
x_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
576
{
577
  struct frame *f = XFRAME (WINDOW_FRAME (w));
578 579 580 581 582 583
  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);
584

585 586
  XDrawLine (FRAME_X_DISPLAY (f), FRAME_X_WINDOW (f),
	     f->output_data.x->normal_gc, x, y0, x, y1);
587
}
Juanma Barranquero's avatar
Juanma Barranquero committed
588

589 590 591 592 593 594 595 596 597 598 599 600
/* 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.  */
601 602

static void
603
x_update_window_end (struct window *w, int cursor_on_p, int mouse_face_overwritten_p)
604
{
605
  struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (XFRAME (w->frame));
Juanma Barranquero's avatar
Juanma Barranquero committed
606

607 608 609
  if (!w->pseudo_window_p)
    {
      BLOCK_INPUT;
610

611
      if (cursor_on_p)
612 613 614
	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
615

616 617
      if (draw_window_fringes (w, 1))
	x_draw_vertical_border (w);
Kenichi Handa's avatar
Kenichi Handa committed
618

619 620
      UNBLOCK_INPUT;
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
621

622 623 624 625 626 627 628 629
  /* 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
630

631 632
  updated_window = NULL;
}
Jim Blandy's avatar
Jim Blandy committed
633 634


635 636 637 638
/* End update of frame F.  This function is installed as a hook in
   update_end.  */

static void
639
x_update_end (struct frame *f)
640 641
{
  /* Mouse highlight may be displayed again.  */
642
  FRAME_X_DISPLAY_INFO (f)->mouse_face_defer = 0;
643

644
#ifndef XFlush
645
  BLOCK_INPUT;
646
  XFlush (FRAME_X_DISPLAY (f));
Jim Blandy's avatar
Jim Blandy committed
647
  UNBLOCK_INPUT;
648
#endif
Jim Blandy's avatar
Jim Blandy committed
649
}
650

651 652 653 654

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

Andreas Schwab's avatar
Andreas Schwab committed
656
static void
657
XTframe_up_to_date (struct frame *f)
658
{
659
  if (FRAME_X_P (f))
660
    {
661
      struct x_display_info *dpyinfo = FRAME_X_DISPLAY_INFO (f);
662

663 664 665 666 667 668 669 670 671 672 673
      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;
	}
674
    }
675
}
676 677 678


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
679
   arrow bitmaps, or clear the fringes if no bitmaps are required
680 681 682 683 684 685
   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
686
x_after_update_window_line (struct glyph_row *desired_row)
687 688
{
  struct window *w = updated_window;
689
  struct frame *f;
690
  int width, height;
Juanma Barranquero's avatar
Juanma Barranquero committed
691

692
  xassert (w);
Juanma Barranquero's avatar
Juanma Barranquero committed
693

694
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
Kenichi Handa's avatar
Kenichi Handa committed
695
    desired_row->redraw_fringe_bitmaps_p = 1;
Juanma Barranquero's avatar
Juanma Barranquero committed
696

697 698 699 700 701 702 703 704 705 706
  /* 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),
707 708 709
	  width != 0)
      && (height = desired_row->visible_height,
	  height > 0))
710 711
    {
      int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
712

713 714 715 716
      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),
717
		    FRAME_PIXEL_WIDTH (f) - width,
718
		    y, width, height, False);
719 720 721 722 723
      UNBLOCK_INPUT;
    }
}

static void
724
x_draw_fringe_bitmap (struct window *w, struct glyph_row *row, struct draw_fringe_bitmap_params *p)
725 726 727 728 729
{
  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
730
  struct face *face = p->face;
731 732

  /* Must clip because of partially visible lines.  */
733
  x_clip_to_row (w, row, -1, gc);
734

735
  if (!p->overlay_p)
736
    {
737 738
      int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;

739 740 741 742 743 744 745 746
      /* 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
747

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

798 799 800 801
      if (!face->stipple)
	XSetForeground (display, face->gc, face->foreground);
    }

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

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

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

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

847 848 849
  XSetClipMask (display, gc, None);
}

Jim Blandy's avatar
Jim Blandy committed
850

851 852 853 854 855

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

Andreas Schwab's avatar
Andreas Schwab committed
857
static void
858
XTset_terminal_modes (struct terminal *terminal)
Jim Blandy's avatar
Jim Blandy committed
859 860 861
{
}

862 863
/* 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
864

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


/***********************************************************************
			    Glyph display
 ***********************************************************************/



877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904
static void x_set_glyph_string_clipping (struct glyph_string *);
static void x_set_glyph_string_gc (struct glyph_string *);
static void x_draw_glyph_string_background (struct glyph_string *,
                                            int);
static void x_draw_glyph_string_foreground (struct glyph_string *);
static void x_draw_composite_glyph_string_foreground (struct glyph_string *);
static void x_draw_glyph_string_box (struct glyph_string *);
static void x_draw_glyph_string  (struct glyph_string *);
static void x_compute_glyph_string_overhangs (struct glyph_string *);
static void x_set_cursor_gc (struct glyph_string *);
static void x_set_mode_line_face_gc (struct glyph_string *);
static void x_set_mouse_face_gc (struct glyph_string *);
static int x_alloc_lighter_color (struct frame *, Display *, Colormap,
                                  unsigned long *, double, int);
static void x_setup_relief_color (struct frame *, struct relief *,
                                  double, int, unsigned long);
static void x_setup_relief_colors (struct glyph_string *);
static void x_draw_image_glyph_string (struct glyph_string *);
static void x_draw_image_relief (struct glyph_string *);
static void x_draw_image_foreground (struct glyph_string *);
static void x_draw_image_foreground_1 (struct glyph_string *, Pixmap);
static void x_clear_glyph_string_rect (struct glyph_string *, int,
                                       int, int, int);
static void x_draw_relief_rect (struct frame *, int, int, int, int,
                                int, int, int, int, int, int,
                                XRectangle *);
static void x_draw_box_rect (struct glyph_string *, int, int, int, int,
                             int, int, int, XRectangle *);
905 906

#if GLYPH_DEBUG
907
static void x_check_font (struct frame *, struct font *);
908
#endif
909 910 911 912 913 914


/* Set S->gc to a suitable GC for drawing glyph string S in cursor
   face.  */

static void
915
x_set_cursor_gc (struct glyph_string *s)
916 917 918 919
{
  if (s->font == FRAME_FONT (s->f)
      && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
      && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
920
      && !s->cmp)
921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
    s->gc = s->f->output_data.x->cursor_gc;
  else
    {
      /* Cursor on non-default face: must merge.  */
      XGCValues xgcv;
      unsigned long mask;

      xgcv.background = s->f->output_data.x->cursor_pixel;
      xgcv.foreground = s->face->background;

      /* If the glyph would be invisible, try a different foreground.  */
      if (xgcv.foreground == xgcv.background)
	xgcv.foreground = s->face->foreground;
      if (xgcv.foreground == xgcv.background)
	xgcv.foreground = s->f->output_data.x->cursor_foreground_pixel;
      if (xgcv.foreground == xgcv.background)
	xgcv.foreground = s->face->foreground;

      /* Make sure the cursor is distinct from text in this face.  */
      if (xgcv.background == s->face->background
	  && xgcv.foreground == s->face->foreground)
	{
	  xgcv.background = s->face->foreground;
	  xgcv.foreground = s->face->background;
	}

      IF_DEBUG (x_check_font (s->f, s->font));
      xgcv.graphics_exposures = False;
949
      mask = GCForeground | GCBackground | GCGraphicsExposures;
950 951 952 953 954 955 956 957 958 959 960 961 962 963

      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
964

965
static void
966
x_set_mouse_face_gc (struct glyph_string *s)
Juanma Barranquero's avatar
Juanma Barranquero committed
967
{
968
  int face_id;
969
  struct face *face;
970

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

977
  if (s->first_glyph->type == CHAR_GLYPH)
978
    face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
979
  else
980
    face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
981 982 983 984 985 986 987 988
  s->face = FACE_FROM_ID (s->f, face_id);
  PREPARE_FACE_FOR_DISPLAY (s->f, s->face);

  if (s->font == s->face->font)
    s->gc = s->face->gc;
  else
    {
      /* Otherwise construct scratch_cursor_gc with values from FACE
989
	 except for FONT.  */
990 991
      XGCValues xgcv;
      unsigned long mask;
Juanma Barranquero's avatar
Juanma Barranquero committed
992

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

998 999 1000 1001 1002 1003
      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
1004

1005 1006
      s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;

1007
    }
1008 1009 1010 1011 1012 1013 1014 1015 1016
  xassert (s->gc != 0);
}


/* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
   Faces to use in the mode line have already been computed when the
   matrix was built, so there isn't much to do, here.  */

static INLINE void
1017
x_set_mode_line_face_gc (struct glyph_string *s)
Juanma Barranquero's avatar
Juanma Barranquero committed
1018
{
1019 1020 1021 1022 1023 1024 1025 1026 1027
  s->gc = s->face->gc;
}


/* Set S->gc of glyph string S for drawing that glyph string.  Set
   S->stippled_p to a non-zero value if the face of S has a stipple
   pattern.  */

static INLINE void
1028
x_set_glyph_string_gc (struct glyph_string *s)
1029
{
1030
  PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
Juanma Barranquero's avatar
Juanma Barranquero committed
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 1065 1066 1067 1068 1069 1070 1071 1072
  if (s->hl == DRAW_NORMAL_TEXT)
    {
      s->gc = s->face->gc;
      s->stippled_p = s->face->stipple != 0;
    }
  else if (s->hl == DRAW_INVERSE_VIDEO)
    {
      x_set_mode_line_face_gc (s);
      s->stippled_p = s->face->stipple != 0;
    }
  else if (s->hl == DRAW_CURSOR)
    {
      x_set_cursor_gc (s);
      s->stippled_p = 0;
    }
  else if (s->hl == DRAW_MOUSE_FACE)
    {
      x_set_mouse_face_gc (s);
      s->stippled_p = s->face->stipple != 0;
    }
  else if (s->hl == DRAW_IMAGE_RAISED
	   || s->hl == DRAW_IMAGE_SUNKEN)
    {
      s->gc = s->face->gc;
      s->stippled_p = s->face->stipple != 0;
    }
  else
    {
      s->gc = s->face->gc;
      s->stippled_p = s->face->stipple != 0;
    }

  /* GC must have been set.  */
  xassert (s->gc != 0);
}


/* Set clipping for output of glyph string S.  S may be part of a mode
   line or menu if we don't have X toolkit support.  */

static INLINE void
1073
x_set_glyph_string_clipping (struct glyph_string *s)
1074
{
1075 1076 1077 1078 1079 1080
  XRectangle *r = s->clip;
  int n = get_glyph_string_clip_rects (s, r, 2);

  if (n > 0)
    XSetClipRectangles (s->display, s->gc, 0, 0, r, n, Unsorted);
  s->num_clips = n;
1081 1082 1083
}


1084 1085 1086 1087 1088
/* Set SRC's clipping for output of glyph string DST.  This is called
   when we are drawing DST's left_overhang or right_overhang only in
   the area of SRC.  */

static void
1089
x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1090 1091
{
  XRectangle r;
Kenichi Handa's avatar
Kenichi Handa committed
1092

1093 1094 1095 1096 1097 1098
  r.x = src->x;
  r.width = src->width;
  r.y = src->y;
  r.height = src->height;
  dst->clip[0] = r;
  dst->num_clips = 1;
1099 1100 1101 1102
  XSetClipRectangles (dst->display, dst->gc, 0, 0, &r, 1, Unsorted);
}


1103
/* RIF:
1104
   Compute left and right overhang of glyph string S.  */
1105

1106
static void
1107
x_compute_glyph_string_overhangs (struct glyph_string *s)
1108
{
1109
  if (s->cmp == NULL
1110 1111
      && (s->first_glyph->type == CHAR_GLYPH
	  || s->first_glyph->type == COMPOSITE_GLYPH))
1112
    {
1113
      struct font_metrics metrics;
Kenichi Handa's avatar
Kenichi Handa committed
1114

1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
      if (s->first_glyph->type == CHAR_GLYPH)
	{
	  unsigned *code = alloca (sizeof (unsigned) * s->nchars);
	  struct font *font = s->font;
	  int i;

	  for (i = 0; i < s->nchars; i++)
	    code[i] = (s->char2b[i].byte1 << 8) | s->char2b[i].byte2;
	  font->driver->text_extents (font, code, s->nchars, &metrics);
	}
      else
	{
	  Lisp_Object gstring = composition_gstring_from_id (s->cmp_id);

	  composition_gstring_width (gstring, s->cmp_from, s->cmp_to, &metrics);
	}
1131 1132 1133
      s->right_overhang = (metrics.rbearing > metrics.width
			   ? metrics.rbearing - metrics.width : 0);
      s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1134
    }
1135 1136 1137 1138 1139
  else if (s->cmp)
    {
      s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
      s->left_overhang = - s->cmp->lbearing;
    }
1140 1141 1142 1143 1144 1145
}


/* Fill rectangle X, Y, W, H with background color of glyph string S.  */

static INLINE void
1146
x_clear_glyph_string_rect (struct glyph_string *s, int x, int y, int w, int h)
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
{
  XGCValues xgcv;
  XGetGCValues (s->display, s->gc, GCForeground | GCBackground, &xgcv);
  XSetForeground (s->display, s->gc, xgcv.background);
  XFillRectangle (s->display, s->window, s->gc, x, y, w, h);
  XSetForeground (s->display, s->gc, xgcv.foreground);
}


/* Draw the background of glyph_string S.  If S->background_filled_p
   is non-zero don't draw it.  FORCE_P non-zero means draw the
   background even if it wouldn't be drawn normally.  This is used
1159 1160
   when a string preceding S draws into the background of S, or S
   contains the first component of a composition.  */
1161 1162

static void
1163
x_draw_glyph_string_background (struct glyph_string *s, int force_p)
1164 1165 1166 1167 1168
{
  /* Nothing to do if background has already been drawn or if it
     shouldn't be drawn in the first place.  */