xterm.c 320 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* X Communication module for terminals which understand the X protocol.
Glenn Morris's avatar
Glenn Morris committed
2

3
Copyright (C) 1989, 1993-2011
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 49 50

#include <sys/ioctl.h>

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

#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
58 59
/* Caused redefinition of DBL_DIG on Netbsd; seems not to be needed.  */
/* #include <sys/param.h>  */
Jim Blandy's avatar
Jim Blandy committed
60

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

85 86 87 88
#ifdef USE_X_TOOLKIT
#include <X11/Shell.h>
#endif

89 90 91
#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
Paul Eggert's avatar
Paul Eggert committed
92

93 94
#include <unistd.h>

Jan Djärv's avatar
Jan Djärv committed
95 96 97 98
#ifdef USE_GTK
#include "gtkutil.h"
#endif

99
#ifdef USE_LUCID
100
#include "../lwlib/xlwmenu.h"
101 102
#endif

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

/* 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>
115 116 117
#else /* !USE_MOTIF i.e. use Xaw */

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

131 132
#endif /* USE_X_TOOLKIT */

133
#ifdef USE_X_TOOLKIT
Karl Heuer's avatar
Karl Heuer committed
134
#include "widget.h"
135 136 137 138 139
#ifndef XtNinitialState
#define XtNinitialState "initialState"
#endif
#endif

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

147 148 149 150 151 152 153


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

static int any_help_event_p;

154
/* Last window where we saw the mouse.  Used by mouse-autoselect-window.  */
155
static Lisp_Object last_window;
156

157 158 159
/* This is a chain of structures for all the X displays currently in
   use.  */

160
struct x_display_info *x_display_list;
Jim Blandy's avatar
Jim Blandy committed
161

162 163 164 165 166
/* 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.  */

167
Lisp_Object x_display_name_list;
168

169
/* Frame being updated by update_frame.  This is declared in term.c.
170 171 172 173
   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.  */

174
extern struct frame *updating_frame;
Jim Blandy's avatar
Jim Blandy committed
175

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

178 179 180 181 182 183 184 185
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;
186

187 188 189
#ifdef USE_X_TOOLKIT
/* The application context for Xt use.  */
XtAppContext Xt_app_con;
190 191
static String Xt_default_resources[] = {0};
#endif /* USE_X_TOOLKIT */
192

Gerd Moellmann's avatar
Gerd Moellmann committed
193 194 195
/* Non-zero means user is interacting with a toolkit scroll bar.  */

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

Kenichi Handa's avatar
Kenichi Handa committed
197 198 199 200 201 202
/* 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;

203 204
/* Mouse movement.

205
   Formerly, we used PointerMotionHintMask (in standard_event_mask)
206 207 208 209 210 211
   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.

212 213 214 215 216 217 218 219 220
   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
221
   is off.  */
222 223 224

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

225
static XRectangle last_mouse_glyph;
Kim F. Storm's avatar
Kim F. Storm committed
226
static FRAME_PTR last_mouse_glyph_frame;
227 228
static Lisp_Object last_mouse_press_frame;

229 230
/* The scroll bar in which the last X motion event occurred.

231 232
   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
233 234
   an ordinary motion.

235 236 237 238
   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.  */

239 240 241 242
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
243
   doesn't seem to be any way to wrest the time-stamp from the server
244 245 246
   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.  */
247

248 249
static Time last_mouse_movement_time;

Jan Djärv's avatar
Jan Djärv committed
250 251 252 253
/* Time for last user interaction as returned in X events.  */

static Time last_user_time;

254 255 256
/* Incremented by XTread_socket whenever it really tries to read
   events.  */

257 258 259 260 261 262
#ifdef __STDC__
static int volatile input_signal_count;
#else
static int input_signal_count;
#endif

263
/* Used locally within XTread_socket.  */
264

265
static int x_noop_count;
Jim Blandy's avatar
Jim Blandy committed
266

267 268
static Lisp_Object Qalt, Qhyper, Qmeta, Qsuper, Qmodifier_value;

269
static Lisp_Object Qvendor_specific_keysyms;
Dave Love's avatar
Dave Love committed
270
static Lisp_Object Qlatin_1;
271

272 273 274
#ifdef USE_GTK
/* The name of the Emacs icon file.  */
static Lisp_Object xg_default_icon_file;
275 276 277

/* Used in gtkutil.c.  */
Lisp_Object Qx_gtk_map_stock;
278 279
#endif

280 281 282
/* Some functions take this as char *, not const char *.  */
static char emacs_class[] = EMACS_CLASS;

Andreas Schwab's avatar
Andreas Schwab committed
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
/* XEmbed implementation.  */

#define XEMBED_VERSION 0

enum xembed_info
  {
    XEMBED_MAPPED = 1 << 0
  };

enum xembed_message
  {
    XEMBED_EMBEDDED_NOTIFY        = 0,
    XEMBED_WINDOW_ACTIVATE        = 1,
    XEMBED_WINDOW_DEACTIVATE      = 2,
    XEMBED_REQUEST_FOCUS          = 3,
    XEMBED_FOCUS_IN               = 4,
    XEMBED_FOCUS_OUT              = 5,
    XEMBED_FOCUS_NEXT             = 6,
    XEMBED_FOCUS_PREV             = 7,

    XEMBED_MODALITY_ON            = 10,
    XEMBED_MODALITY_OFF           = 11,
    XEMBED_REGISTER_ACCELERATOR   = 12,
    XEMBED_UNREGISTER_ACCELERATOR = 13,
    XEMBED_ACTIVATE_ACCELERATOR   = 14
  };
309

Andreas Schwab's avatar
Andreas Schwab committed
310
/* Used in x_flush.  */
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

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 *);
354 355
/* Don't declare this NO_RETURN because we want no
   interference with debugging failing X calls.  */
356
static SIGTYPE x_connection_closed (Display *, const char *);
Jan Djärv's avatar
Jan Djärv committed
357

358 359 360 361

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

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

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

Jim Blandy's avatar
Jim Blandy committed
382

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

392

393 394 395 396
/***********************************************************************
			      Debugging
 ***********************************************************************/

397
#if 0
398 399 400

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

Juanma Barranquero's avatar
Juanma Barranquero committed
402
struct record
403 404 405 406 407 408 409 410 411
{
  char *locus;
  int type;
};

struct record event_record[100];

int event_record_index;

Andreas Schwab's avatar
Andreas Schwab committed
412 413
void
record_event (char *locus, int type)
414 415 416 417 418 419 420 421 422 423
{
  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 */
424 425


426

427 428 429
/* Return the struct x_display_info corresponding to DPY.  */

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

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

438 439
  return 0;
}
440

441 442 443
#define OPAQUE  0xffffffff

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

453 454 455
  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. */
456
    win = FRAME_X_OUTPUT (f)->parent_desc;
457 458 459 460 461 462 463 464 465 466 467

  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;

468 469 470
  if (alpha < 0.0)
    return;
  else if (alpha > 1.0)
471 472 473 474
    alpha = 1.0;
  else if (0.0 <= alpha && alpha < alpha_min && alpha_min <= 1.0)
    alpha = alpha_min;

475
  opac = alpha * OPAQUE;
476 477 478 479 480

  /* return unless necessary */
  {
    unsigned char *data;
    Atom actual;
481
    int rc, format;
482 483
    unsigned long n, left;

484
    x_catch_errors (dpy);
485
    rc = XGetWindowProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
486 487 488
			     0L, 1L, False, XA_CARDINAL,
			     &actual, &format, &n, &left,
			     &data);
489 490

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

502
  x_catch_errors (dpy);
503
  XChangeProperty (dpy, win, dpyinfo->Xatom_net_wm_window_opacity,
504 505
		   XA_CARDINAL, 32, PropModeReplace,
		   (unsigned char *) &opac, 1L);
506
  x_uncatch_errors ();
507
}
508

509
int
510
x_display_pixel_height (struct x_display_info *dpyinfo)
511 512 513 514 515
{
  return HeightOfScreen (dpyinfo->screen);
}

int
516
x_display_pixel_width (struct x_display_info *dpyinfo)
517 518 519 520
{
  return WidthOfScreen (dpyinfo->screen);
}

521 522 523 524

/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
Juanma Barranquero's avatar
Juanma Barranquero committed
525

526 527 528 529 530
/* 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
531

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


539 540 541
/* 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
542

543
static void
544
x_update_window_begin (struct window *w)
545 546
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
547
  Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
Juanma Barranquero's avatar
Juanma Barranquero committed
548

549 550
  updated_window = w;
  set_output_cursor (&w->cursor);
551

552
  BLOCK_INPUT;
553

554
  if (f == hlinfo->mouse_face_mouse_frame)
555
    {
556
      /* Don't do highlighting for mouse motion during the update.  */
557
      hlinfo->mouse_face_defer = 1;
558

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

Jim Blandy's avatar
Jim Blandy committed
565 566 567
  UNBLOCK_INPUT;
}

568

569
/* Draw a vertical window border from (x,y0) to (x,y1)  */
570

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

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

586 587 588 589 590 591 592 593 594 595 596 597
/* 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.  */
598 599

static void
600
x_update_window_end (struct window *w, int cursor_on_p, int mouse_face_overwritten_p)
601
{
602
  Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));
Juanma Barranquero's avatar
Juanma Barranquero committed
603

604 605 606
  if (!w->pseudo_window_p)
    {
      BLOCK_INPUT;
607

608
      if (cursor_on_p)
609 610 611
	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
612

613 614
      if (draw_window_fringes (w, 1))
	x_draw_vertical_border (w);
Kenichi Handa's avatar
Kenichi Handa committed
615

616 617
      UNBLOCK_INPUT;
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
618

619 620 621 622
  /* If a row with mouse-face was overwritten, arrange for
     XTframe_up_to_date to redisplay the mouse highlight.  */
  if (mouse_face_overwritten_p)
    {
623 624 625
      hlinfo->mouse_face_beg_row = hlinfo->mouse_face_beg_col = -1;
      hlinfo->mouse_face_end_row = hlinfo->mouse_face_end_col = -1;
      hlinfo->mouse_face_window = Qnil;
626
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
627

628 629
  updated_window = NULL;
}
Jim Blandy's avatar
Jim Blandy committed
630 631


632 633 634 635
/* End update of frame F.  This function is installed as a hook in
   update_end.  */

static void
636
x_update_end (struct frame *f)
637 638
{
  /* Mouse highlight may be displayed again.  */
639
  MOUSE_HL_INFO (f)->mouse_face_defer = 0;
640

641
#ifndef XFlush
642
  BLOCK_INPUT;
643
  XFlush (FRAME_X_DISPLAY (f));
Jim Blandy's avatar
Jim Blandy committed
644
  UNBLOCK_INPUT;
645
#endif
Jim Blandy's avatar
Jim Blandy committed
646
}
647

648 649 650 651

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

Andreas Schwab's avatar
Andreas Schwab committed
653
static void
654
XTframe_up_to_date (struct frame *f)
655
{
656
  if (FRAME_X_P (f))
657
    {
658
      Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
659

660 661
      if (hlinfo->mouse_face_deferred_gc
	  || f == hlinfo->mouse_face_mouse_frame)
662 663
	{
	  BLOCK_INPUT;
664 665 666 667 668
	  if (hlinfo->mouse_face_mouse_frame)
	    note_mouse_highlight (hlinfo->mouse_face_mouse_frame,
				  hlinfo->mouse_face_mouse_x,
				  hlinfo->mouse_face_mouse_y);
	  hlinfo->mouse_face_deferred_gc = 0;
669 670
	  UNBLOCK_INPUT;
	}
671
    }
672
}
673 674 675


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

689
  xassert (w);
Juanma Barranquero's avatar
Juanma Barranquero committed
690

691
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
Kenichi Handa's avatar
Kenichi Handa committed
692
    desired_row->redraw_fringe_bitmaps_p = 1;
Juanma Barranquero's avatar
Juanma Barranquero committed
693

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

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

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

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

732
  if (!p->overlay_p)
733
    {
734 735
      int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;

736 737 738 739 740 741 742 743
      /* 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
744

745 746 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
#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
794

795 796 797 798
      if (!face->stipple)
	XSetForeground (display, face->gc, face->foreground);
    }

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

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

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

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

844 845 846
  XSetClipMask (display, gc, None);
}

Jim Blandy's avatar
Jim Blandy committed
847

848 849 850 851 852

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

Andreas Schwab's avatar
Andreas Schwab committed
854
static void
855
XTset_terminal_modes (struct terminal *terminal)
Jim Blandy's avatar
Jim Blandy committed
856 857 858
{
}

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

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

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



874 875 876 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
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 *);
Andreas Schwab's avatar
Andreas Schwab committed
902
static void x_scroll_bar_clear (struct frame *);
903 904

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


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

static void
913
x_set_cursor_gc (struct glyph_string *s)
914 915 916 917
{
  if (s->font == FRAME_FONT (s->f)
      && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
      && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
918
      && !s->cmp)
919 920 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
    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;
947
      mask = GCForeground | GCBackground | GCGraphicsExposures;
948 949 950 951 952 953 954 955 956 957 958 959 960 961

      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
962

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

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

975
  if (s->first_glyph->type == CHAR_GLYPH)
976
    face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
977
  else
978
    face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
979 980 981 982 983 984 985 986
  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
987
	 except for FONT.  */
988 989
      XGCValues xgcv;
      unsigned long mask;
Juanma Barranquero's avatar
Juanma Barranquero committed
990

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

996 997 998 999 1000 1001
      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
1002

1003 1004
      s->gc = FRAME_X_DISPLAY_INFO (s->f)->scratch_cursor_gc;

1005
    }
1006 1007 1008 1009 1010 1011 1012 1013 1014
  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
1015
x_set_mode_line_face_gc (struct glyph_string *s)
Juanma Barranquero's avatar
Juanma Barranquero committed
1016
{
1017 1018 1019 1020 1021 1022 1023 1024 1025
  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
1026
x_set_glyph_string_gc (struct glyph_string *s)
1027
{
1028
  PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
Juanma Barranquero's avatar
Juanma Barranquero committed
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 1065 1066 1067 1068 1069 1070
  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
1071
x_set_glyph_string_clipping (struct glyph_string *s)
1072
{
1073 1074 1075 1076 1077 1078
  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;
1079 1080 1081
}


1082 1083 1084 1085 1086
/* 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
1087
x_set_glyph_string_clipping_exactly (struct glyph_string *src, struct glyph_string *dst)
1088 1089
{
  XRectangle r;
Kenichi Handa's avatar
Kenichi Handa committed
1090

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


1101
/* RIF:
1102
   Compute left and right overhang of glyph string S.  */
1103

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

1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128
      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);
	}
1129 1130 1131
      s->right_overhang = (metrics.rbearing > metrics.width
			   ? metrics.rbearing - metrics.width : 0);
      s->left_overhang = metrics.lbearing < 0 ? - metrics.lbearing : 0;
1132
    }
1133 1134 1135 1136 1137
  else if (s->cmp)
    {
      s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
      s->left_overhang = - s->cmp->lbearing;
    }
1138 1139 1140 1141 1142 1143
}


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

static INLINE void
1144
x_clear_glyph_string_rect (struct glyph_string *s, int x, int y, int w, int h)
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
{
  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
1157 1158
   when a string preceding S draws into the background of S, or S
   contains the first component of a composition.  */
1159 1160

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