w32term.c 188 KB
Newer Older
1
/* Implementation of GUI terminal on the Microsoft Windows API.
Glenn Morris's avatar
Glenn Morris committed
2

3
Copyright (C) 1989, 1993-2014 Free Software Foundation, Inc.
Geoff Voelker's avatar
Geoff Voelker committed
4 5 6

This file is part of GNU Emacs.

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

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
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Geoff Voelker's avatar
Geoff Voelker committed
19 20

#include <config.h>
21
#include <signal.h>
Geoff Voelker's avatar
Geoff Voelker committed
22 23 24
#include <stdio.h>
#include "lisp.h"
#include "blockinput.h"
25
#include "w32term.h"
Geoff Voelker's avatar
Geoff Voelker committed
26 27 28 29 30 31 32

#include "systty.h"
#include "systime.h"

#include <ctype.h>
#include <errno.h>
#include <sys/stat.h>
33
#include <imm.h>
Geoff Voelker's avatar
Geoff Voelker committed
34

35 36 37 38
#include "charset.h"
#include "character.h"
#include "coding.h"
#include "ccl.h"
Geoff Voelker's avatar
Geoff Voelker committed
39 40
#include "frame.h"
#include "dispextern.h"
41
#include "fontset.h"
Geoff Voelker's avatar
Geoff Voelker committed
42 43 44 45 46 47
#include "termhooks.h"
#include "termopts.h"
#include "termchar.h"
#include "disptab.h"
#include "buffer.h"
#include "window.h"
48
#include "keyboard.h"
Geoff Voelker's avatar
Geoff Voelker committed
49
#include "intervals.h"
50 51 52 53
#include "process.h"
#include "atimer.h"
#include "keymap.h"

Daniel Colascione's avatar
Daniel Colascione committed
54
#ifdef WINDOWSNT
55
#include "w32.h"	/* for filename_from_utf16, filename_from_ansi */
56
#include "w32heap.h"
Daniel Colascione's avatar
Daniel Colascione committed
57 58 59 60 61 62
#endif

#ifndef WINDOWSNT
#include <io.h> /* for get_osfhandle */
#endif

63
#include <shellapi.h>
Geoff Voelker's avatar
Geoff Voelker committed
64

Jason Rumney's avatar
Jason Rumney committed
65
#include "font.h"
66
#include "w32font.h"
67

Kim F. Storm's avatar
Kim F. Storm committed
68
/* Fringe bitmaps.  */
69

70 71
static int max_fringe_bmp = 0;
static HBITMAP *fringe_bmp = 0;
72

73
/* Temporary variables for w32_read_socket.  */
74

75 76
static int last_mousemove_x = 0;
static int last_mousemove_y = 0;
77

78 79 80 81 82
/* Define GET_WHEEL_DELTA_WPARAM macro if system headers don't.  */
#ifndef GET_WHEEL_DELTA_WPARAM
#define GET_WHEEL_DELTA_WPARAM(wparam) ((short)HIWORD (wparam))
#endif

83 84 85 86 87
/* Non-zero means that a HELP_EVENT has been generated since Emacs
   start.  */

static int any_help_event_p;

Geoff Voelker's avatar
Geoff Voelker committed
88 89
extern unsigned int msh_mousewheel;

90
extern void free_frame_menubar (struct frame *);
Geoff Voelker's avatar
Geoff Voelker committed
91

92
extern int w32_codepage_for_font (char *fontname);
93
extern Cursor w32_load_cursor (LPCTSTR name);
94

Geoff Voelker's avatar
Geoff Voelker committed
95 96 97 98
#define x_any_window_to_frame x_window_to_frame
#define x_top_window_to_frame x_window_to_frame


99 100
/* This is display since w32 does not support multiple ones.  */
struct w32_display_info one_w32_display_info;
Andrew Innes's avatar
Andrew Innes committed
101
struct w32_display_info *x_display_list;
Geoff Voelker's avatar
Geoff Voelker committed
102

103
#if _WIN32_WINNT < 0x0500 && !defined(_W64)
104
/* Pre Windows 2000, this was not available, but define it here so
105 106
   that Emacs compiled on such a platform will run on newer versions.
   MinGW64 (_W64) defines these unconditionally, so avoid redefining.  */
107 108 109 110 111 112 113

typedef struct tagWCRANGE
{
  WCHAR wcLow;
  USHORT cGlyphs;
} WCRANGE;

Juanma Barranquero's avatar
Juanma Barranquero committed
114
typedef struct tagGLYPHSET
115 116 117 118 119 120
{
  DWORD cbThis;
  DWORD flAccel;
  DWORD cGlyphsSupported;
  DWORD cRanges;
  WCRANGE ranges[1];
Juanma Barranquero's avatar
Juanma Barranquero committed
121
} GLYPHSET;
122

Daniel Colascione's avatar
Daniel Colascione committed
123
#endif /* compiling for pre-Win2k */
124

125
/* Dynamic linking to SetLayeredWindowAttribute (only since 2000).  */
126
BOOL (WINAPI *pfnSetLayeredWindowAttributes) (HWND, COLORREF, BYTE, DWORD);
127 128 129 130

#ifndef LWA_ALPHA
#define LWA_ALPHA 0x02
#endif
131 132 133 134 135
/* WS_EX_LAYERED is defined unconditionally by MingW, but only for W2K and
   later targets by MSVC headers.  */
#ifndef WS_EX_LAYERED
#define WS_EX_LAYERED 0x80000
#endif
136

137 138 139 140 141 142 143 144 145
/* SM_CXVIRTUALSCREEN and SM_CYVIRTUALSCREEN are not defined on 95 and
   NT4.  */
#ifndef SM_CXVIRTUALSCREEN
#define SM_CXVIRTUALSCREEN 78
#endif
#ifndef SM_CYVIRTUALSCREEN
#define SM_CYVIRTUALSCREEN 79
#endif

146 147 148 149 150
/* The handle of the frame that currently owns the system caret.  */
HWND w32_system_caret_hwnd;
int w32_system_caret_height;
int w32_system_caret_x;
int w32_system_caret_y;
151 152 153
struct window *w32_system_caret_window;
int w32_system_caret_hdr_height;
int w32_system_caret_mode_height;
154 155
DWORD dwWindowsThreadId = 0;
HANDLE hWindowsThread = NULL;
Geoff Voelker's avatar
Geoff Voelker committed
156 157 158
DWORD dwMainThreadId = 0;
HANDLE hMainThread = NULL;

159 160 161 162 163 164
int vertical_scroll_bar_min_handle;
int vertical_scroll_bar_top_border;
int vertical_scroll_bar_bottom_border;

int last_scroll_bar_drag_pos;

165 166 167
/* Keyboard code page - may be changed by language-change events.  */
int w32_keyboard_codepage;

168 169
/* Incremented by w32_read_socket whenever it really tries to read
   events.  */
Geoff Voelker's avatar
Geoff Voelker committed
170 171
static int volatile input_signal_count;

Daniel Colascione's avatar
Daniel Colascione committed
172 173 174 175
#ifdef CYGWIN
int w32_message_fd = -1;
#endif /* CYGWIN */

176 177 178 179 180 181
static void w32_handle_tool_bar_click (struct frame *,
                                       struct input_event *);
static void w32_define_cursor (Window, Cursor);

void x_lower_frame (struct frame *);
void x_scroll_bar_clear (struct frame *);
182
void x_wm_set_size_hint (struct frame *, long, bool);
183
void x_raise_frame (struct frame *);
184
void x_set_window_size (struct frame *, int, int, int, bool);
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
void x_wm_set_window_state (struct frame *, int);
void x_wm_set_icon_pixmap (struct frame *, int);
static void w32_initialize (void);
static void x_update_end (struct frame *);
static void w32_frame_up_to_date (struct frame *);
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 w32_display_info *,
                               struct frame *);
static void x_focus_changed (int, int, struct w32_display_info *,
                             struct frame *, struct input_event *);
static void w32_detect_focus_change (struct w32_display_info *,
                                     W32Msg *, struct input_event *);
static void w32_frame_rehighlight (struct frame *);
static void x_frame_rehighlight (struct w32_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);
204 205
static void w32_clip_to_row (struct window *, struct glyph_row *,
			     enum glyph_row_area, HDC);
206 207
static BOOL my_show_window (struct frame *, HWND, int);
static void my_set_window_pos (HWND, HWND, int, int, int, int, UINT);
208
#if 0
209
static void my_set_focus (struct frame *, HWND);
210
#endif
211 212
static void my_set_foreground_window (HWND);
static void my_destroy_window (struct frame *, HWND);
Dmitry Antipov's avatar
Dmitry Antipov committed
213
static void w32fullscreen_hook (struct frame *);
214

215
#ifdef GLYPH_DEBUG
216 217 218
static void x_check_font (struct frame *, struct font *);
#endif

Geoff Voelker's avatar
Geoff Voelker committed
219
static Lisp_Object Qvendor_specific_keysyms;
220 221
static Lisp_Object Qadded, Qremoved, Qmodified;
static Lisp_Object Qrenamed_from, Qrenamed_to;
Geoff Voelker's avatar
Geoff Voelker committed
222 223


224 225 226 227
/***********************************************************************
			      Debugging
 ***********************************************************************/

Geoff Voelker's avatar
Geoff Voelker committed
228
#if 0
229 230 231

/* This is a function useful for recording debugging information about
   the sequence of occurrences in this file.  */
Geoff Voelker's avatar
Geoff Voelker committed
232

233
struct record
Geoff Voelker's avatar
Geoff Voelker committed
234 235 236 237 238 239 240 241 242
{
  char *locus;
  int type;
};

struct record event_record[100];

int event_record_index;

243
record_event (char *locus, int type)
Geoff Voelker's avatar
Geoff Voelker committed
244 245 246 247 248 249 250 251 252 253 254
{
  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 */

255

256
void
257
XChangeGC (void *ignore, XGCValues *gc, unsigned long mask,
258
	   XGCValues *xgcv)
259 260 261 262 263 264 265 266 267
{
  if (mask & GCForeground)
    gc->foreground = xgcv->foreground;
  if (mask & GCBackground)
    gc->background = xgcv->background;
  if (mask & GCFont)
    gc->font = xgcv->font;
}

268 269
XGCValues *
XCreateGC (void *ignore, Window window, unsigned long mask, XGCValues *xgcv)
270
{
Dmitry Antipov's avatar
Dmitry Antipov committed
271
  XGCValues *gc = xzalloc (sizeof (XGCValues));
272 273 274 275 276 277

  XChangeGC (ignore, gc, mask, xgcv);

  return gc;
}

278
void
279 280
XGetGCValues (void *ignore, XGCValues *gc,
	      unsigned long mask, XGCValues *xgcv)
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
{
  XChangeGC (ignore, xgcv, mask, gc);
}

static void
w32_set_clip_rectangle (HDC hdc, RECT *rect)
{
  if (rect)
    {
      HRGN clip_region = CreateRectRgnIndirect (rect);
      SelectClipRgn (hdc, clip_region);
      DeleteObject (clip_region);
    }
  else
    SelectClipRgn (hdc, NULL);
}

298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
/* Restore clipping rectangle in S */
static void
w32_restore_glyph_string_clip (struct glyph_string *s)
{
  RECT *r = s->clip;
  int n = s->num_clips;

  if (n == 1)
    w32_set_clip_rectangle (s->hdc, r);
  else if (n > 1)
    {
      HRGN clip1 = CreateRectRgnIndirect (r);
      HRGN clip2 = CreateRectRgnIndirect (r + 1);
      if (CombineRgn (clip1, clip1, clip2, RGN_OR) != ERROR)
        SelectClipRgn (s->hdc, clip1);
      DeleteObject (clip1);
      DeleteObject (clip2);
    }
}

/*
   Draw a wavy line under S. The wave fills wave_height pixels from y0.

                    x0         wave_length = 2
                                 --
                y0   *   *   *   *   *
                     |* * * * * * * * *
    wave_height = 3  | *   *   *   *

*/

void
w32_draw_underwave (struct glyph_string *s, COLORREF color)
{
332
  int wave_height = 3, wave_length = 2;
333 334 335 336 337 338 339 340
  int dx, dy, x0, y0, width, x1, y1, x2, y2, odd, xmax;
  XRectangle wave_clip, string_clip, final_clip;
  RECT w32_final_clip, w32_string_clip;
  HPEN hp, oldhp;

  dx = wave_length;
  dy = wave_height - 1;
  x0 = s->x;
341
  y0 = s->ybase - wave_height + 3;
342 343 344 345 346
  width = s->width;
  xmax = x0 + width;

  /* Find and set clipping rectangle */

347 348 349 350 351
  wave_clip.x = x0;
  wave_clip.y = y0;
  wave_clip.width = width;
  wave_clip.height = wave_height;

352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
  get_glyph_string_clip_rect (s, &w32_string_clip);
  CONVERT_TO_XRECT (string_clip, w32_string_clip);

  if (!x_intersect_rectangles (&wave_clip, &string_clip, &final_clip))
    return;

  hp = CreatePen (PS_SOLID, 0, color);
  oldhp = SelectObject (s->hdc, hp);
  CONVERT_FROM_XRECT (final_clip, w32_final_clip);
  w32_set_clip_rectangle (s->hdc, &w32_final_clip);

  /* Draw the waves */

  x1 = x0 - (x0 % dx);
  x2 = x1 + dx;
  odd = (x1/dx) % 2;
  y1 = y2 = y0;

  if (odd)
    y1 += dy;
  else
    y2 += dy;

  MoveToEx (s->hdc, x1, y1, NULL);

  while (x1 <= xmax)
    {
      LineTo (s->hdc, x2, y2);
      x1  = x2, y1 = y2;
      x2 += dx, y2 = y0 + odd*dy;
      odd = !odd;
    }

  /* Restore previous pen and clipping rectangle(s) */
  w32_restore_glyph_string_clip (s);
  SelectObject (s->hdc, oldhp);
  DeleteObject (hp);
}
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412

/* Draw a hollow rectangle at the specified position.  */
void
w32_draw_rectangle (HDC hdc, XGCValues *gc, int x, int y,
                    int width, int height)
{
  HBRUSH hb, oldhb;
  HPEN hp, oldhp;

  hb = CreateSolidBrush (gc->background);
  hp = CreatePen (PS_SOLID, 0, gc->foreground);
  oldhb = SelectObject (hdc, hb);
  oldhp = SelectObject (hdc, hp);

  Rectangle (hdc, x, y, x + width, y + height);

  SelectObject (hdc, oldhb);
  SelectObject (hdc, oldhp);
  DeleteObject (hb);
  DeleteObject (hp);
}

/* Draw a filled rectangle at the specified position. */
413
void
Dmitry Antipov's avatar
Dmitry Antipov committed
414
w32_fill_rect (struct frame *f, HDC hdc, COLORREF pix, RECT *lprect)
Geoff Voelker's avatar
Geoff Voelker committed
415 416
{
  HBRUSH hb;
417

Geoff Voelker's avatar
Geoff Voelker committed
418 419 420 421 422
  hb = CreateSolidBrush (pix);
  FillRect (hdc, lprect, hb);
  DeleteObject (hb);
}

423
void
Dmitry Antipov's avatar
Dmitry Antipov committed
424
w32_clear_window (struct frame *f)
Geoff Voelker's avatar
Geoff Voelker committed
425 426
{
  RECT rect;
427
  HDC hdc = get_frame_dc (f);
Geoff Voelker's avatar
Geoff Voelker committed
428

429 430 431 432 433 434 435 436 437
  /* Under certain conditions, this can be called at startup with
     a console frame pointer before the GUI frame is created. An HDC
     of 0 indicates this. */
  if (hdc)
    {
      GetClientRect (FRAME_W32_WINDOW (f), &rect);
      w32_clear_rect (f, hdc, &rect);
    }

438
  release_frame_dc (f, hdc);
Geoff Voelker's avatar
Geoff Voelker committed
439 440
}

441 442 443
#define OPAQUE_FRAME 255

void
444
x_set_frame_alpha (struct frame *f)
445
{
446
  struct w32_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
  double alpha = 1.0;
  double alpha_min = 1.0;
  BYTE opac;
  LONG ex_style;
  HWND window = FRAME_W32_WINDOW (f);

  /* Older versions of Windows do not support transparency.  */
  if (!pfnSetLayeredWindowAttributes)
    return;

  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;

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

  opac = alpha * OPAQUE_FRAME;

  ex_style = GetWindowLong (window, GWL_EXSTYLE);

  if (opac == OPAQUE_FRAME)
Jason Rumney's avatar
Jason Rumney committed
479
    ex_style &= ~WS_EX_LAYERED;
480 481 482 483 484 485 486 487 488
  else
    ex_style |= WS_EX_LAYERED;

  SetWindowLong (window, GWL_EXSTYLE, ex_style);

  if (opac != OPAQUE_FRAME)
    pfnSetLayeredWindowAttributes (window, 0, opac, LWA_ALPHA);
}

489
int
490
x_display_pixel_height (struct w32_display_info *dpyinfo)
491
{
492 493 494 495 496 497
  int pixels = GetSystemMetrics (SM_CYVIRTUALSCREEN);

  if (pixels == 0)
    /* Fallback for Windows 95 or NT 4.0.  */
    pixels = GetSystemMetrics (SM_CYSCREEN);

498
  return pixels;
499 500 501
}

int
502
x_display_pixel_width (struct w32_display_info *dpyinfo)
503
{
504 505 506 507 508 509
  int pixels = GetSystemMetrics (SM_CXVIRTUALSCREEN);

  if (pixels == 0)
    /* Fallback for Windows 95 or NT 4.0.  */
    pixels = GetSystemMetrics (SM_CXSCREEN);

510
  return pixels;
511 512
}

Geoff Voelker's avatar
Geoff Voelker committed
513

514 515 516
/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
517

518 519 520
/* 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
521
   each window being updated.  */
Geoff Voelker's avatar
Geoff Voelker committed
522

523
static void
524
x_update_begin (struct frame *f)
Geoff Voelker's avatar
Geoff Voelker committed
525
{
526
  struct w32_display_info *display_info = FRAME_DISPLAY_INFO (f);
527

Andrew Innes's avatar
Andrew Innes committed
528 529 530
  if (! FRAME_W32_P (f))
    return;

531 532 533 534 535 536 537
  /* Regenerate display palette before drawing if list of requested
     colors has changed. */
  if (display_info->regen_palette)
  {
    w32_regenerate_palette (f);
    display_info->regen_palette = FALSE;
  }
538
}
Geoff Voelker's avatar
Geoff Voelker committed
539

540

541
/* Start update of window W.  */
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);
548

549
  /* Hide the system caret during an update.  */
550 551 552 553
  if (w32_use_visible_system_caret && w32_system_caret_hwnd)
    {
      SendMessage (w32_system_caret_hwnd, WM_EMACS_HIDE_CARET, 0, 0);
    }
554

555
  w->output_cursor = w->cursor;
Geoff Voelker's avatar
Geoff Voelker committed
556

557
  block_input ();
Geoff Voelker's avatar
Geoff Voelker committed
558

559
  if (f == hlinfo->mouse_face_mouse_frame)
Geoff Voelker's avatar
Geoff Voelker committed
560 561
    {
      /* Don't do highlighting for mouse motion during the update.  */
562
      hlinfo->mouse_face_defer = 1;
Geoff Voelker's avatar
Geoff Voelker committed
563

564 565
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
Geoff Voelker's avatar
Geoff Voelker committed
566
      if (FRAME_GARBAGED_P (f))
567
	hlinfo->mouse_face_window = Qnil;
568

569 570 571 572 573 574
#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.  */
575

576 577 578 579 580
      /* 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.  */
581 582
      if (!NILP (hlinfo->mouse_face_window)
	  && w == XWINDOW (hlinfo->mouse_face_window))
Geoff Voelker's avatar
Geoff Voelker committed
583
	{
584
	  int i;
Geoff Voelker's avatar
Geoff Voelker committed
585

586 587
          for (i = 0; i < w->desired_matrix->nrows; ++i)
	    if (MATRIX_ROW_ENABLED_P (w->desired_matrix, i))
Geoff Voelker's avatar
Geoff Voelker committed
588 589
	      break;

590
	  if (i < w->desired_matrix->nrows)
591
	    clear_mouse_face (hlinfo);
Geoff Voelker's avatar
Geoff Voelker committed
592
	}
593
#endif /* 0 */
Geoff Voelker's avatar
Geoff Voelker committed
594 595
    }

596
  unblock_input ();
Geoff Voelker's avatar
Geoff Voelker committed
597 598
}

599
/* Draw a vertical window border from (x,y0) to (x,y1)  */
600

601
static void
602
w32_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
Geoff Voelker's avatar
Geoff Voelker committed
603
{
604
  struct frame *f = XFRAME (WINDOW_FRAME (w));
605 606
  RECT r;
  HDC hdc;
607
  struct face *face;
608

609 610 611 612
  r.left = x;
  r.right = x + 1;
  r.top = y0;
  r.bottom = y1;
613

614
  hdc = get_frame_dc (f);
615 616 617 618 619 620
  face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
  if (face)
    w32_fill_rect (f, hdc, face->foreground, &r);
  else
    w32_fill_rect (f, hdc, FRAME_FOREGROUND_PIXEL (f), &r);

621
  release_frame_dc (f, hdc);
622
}
Geoff Voelker's avatar
Geoff Voelker committed
623

624

625 626 627 628 629 630
/* Draw a window divider from (x0, y0) to (x1, y1)  */

static void
w32_draw_window_divider (struct window *w, int x0, int x1, int y0, int y1)
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
  HDC hdc = get_frame_dc (f);
  struct face *face = FACE_FROM_ID (f, WINDOW_DIVIDER_FACE_ID);
  struct face *face_first = FACE_FROM_ID (f, WINDOW_DIVIDER_FIRST_PIXEL_FACE_ID);
  struct face *face_last = FACE_FROM_ID (f, WINDOW_DIVIDER_LAST_PIXEL_FACE_ID);
  unsigned long color = face ? face->foreground : FRAME_FOREGROUND_PIXEL (f);
  unsigned long color_first = (face_first
			       ? face_first->foreground
			       : FRAME_FOREGROUND_PIXEL (f));
  unsigned long color_last = (face_last
			      ? face_last->foreground
			      : FRAME_FOREGROUND_PIXEL (f));

  if (y1 - y0 > x1 - x0 && x1 - x0 > 2)
    /* Vertical.  */
    {
      w32_fill_area_abs (f, hdc, color_first, x0, y0, x0 + 1, y1);
      w32_fill_area_abs (f, hdc, color, x0 + 1, y0, x1 - 1, y1);
      w32_fill_area_abs (f, hdc, color_last, x1 - 1, y0, x1, y1);
    }
  else if (x1 - x0 > y1 - y0 && y1 - y0 > 3)
    /* Horizontal.  */
    {
      w32_fill_area_abs (f, hdc, color_first, x0, y0, x1, y0 + 1);
      w32_fill_area_abs (f, hdc, color, x0, y0 + 1, x1, y1 - 1);
      w32_fill_area_abs (f, hdc, color_last, x0, y1 - 1, x1, y1);
    }
657
  else
658
    w32_fill_area_abs (f, hdc, color, x0, y0, x1, y1);
659 660 661 662

  release_frame_dc (f, hdc);
}

663
/* End update of window W.
664 665 666 667 668 669 670 671 672 673 674

   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. */
675 676

static void
677 678
x_update_window_end (struct window *w, bool cursor_on_p,
		     bool mouse_face_overwritten_p)
679 680 681
{
  if (!w->pseudo_window_p)
    {
682
      block_input ();
683

684
      if (cursor_on_p)
685 686 687
	display_and_set_cursor (w, 1,
				w->output_cursor.hpos, w->output_cursor.vpos,
				w->output_cursor.x, w->output_cursor.y);
688

689
      if (draw_window_fringes (w, 1))
690 691 692 693 694 695
	{
	  if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
	    x_draw_right_divider (w);
	  else
	    x_draw_vertical_border (w);
	}
Kenichi Handa's avatar
Kenichi Handa committed
696

697
      unblock_input ();
698
    }
699 700 701 702

  /* If a row with mouse-face was overwritten, arrange for
     XTframe_up_to_date to redisplay the mouse highlight.  */
  if (mouse_face_overwritten_p)
703 704 705 706 707 708 709
    {
      Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (XFRAME (w->frame));

      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;
    }
710

711 712 713
  /* Unhide the caret.  This won't actually show the cursor, unless it
     was visible before the corresponding call to HideCaret in
     x_update_window_begin.  */
714 715 716 717
  if (w32_use_visible_system_caret && w32_system_caret_hwnd)
    {
      SendMessage (w32_system_caret_hwnd, WM_EMACS_SHOW_CARET, 0, 0);
    }
718 719
}

720 721 722 723

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

724
static void
725
x_update_end (struct frame *f)
726
{
Andrew Innes's avatar
Andrew Innes committed
727 728 729
  if (! FRAME_W32_P (f))
    return;

730
  /* Mouse highlight may be displayed again.  */
731
  MOUSE_HL_INFO (f)->mouse_face_defer = 0;
Geoff Voelker's avatar
Geoff Voelker committed
732 733
}

734

735 736
/* This function is called from various places in xdisp.c
   whenever a complete update has been performed.  */
Geoff Voelker's avatar
Geoff Voelker committed
737

738
static void
739
w32_frame_up_to_date (struct frame *f)
Geoff Voelker's avatar
Geoff Voelker committed
740
{
741
  if (FRAME_W32_P (f))
742
    FRAME_MOUSE_UPDATE (f);
Geoff Voelker's avatar
Geoff Voelker committed
743
}
744 745 746


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
747
   arrow bitmaps, or clear the fringes if no bitmaps are required
748
   before DESIRED_ROW is made current.  This function is called from
749 750 751 752
   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
753
x_after_update_window_line (struct window *w, struct glyph_row *desired_row)
754
{
755 756 757
  struct frame *f;
  int width, height;

758
  eassert (w);
759

760
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
Kenichi Handa's avatar
Kenichi Handa committed
761
    desired_row->redraw_fringe_bitmaps_p = 1;
762

763 764
  /* When a window has disappeared, make sure that no rest of
     full-width rows stays visible in the internal border.  Could
765
     check here if updated window is the leftmost/rightmost window,
766 767 768 769 770
     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
771
      && (f = XFRAME (w->frame),
772 773 774 775 776 777
	  width = FRAME_INTERNAL_BORDER_WIDTH (f),
	  width != 0)
      && (height = desired_row->visible_height,
	  height > 0))
    {
      int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
778

779
      block_input ();
780 781 782
      {
	HDC hdc = get_frame_dc (f);
	w32_clear_area (f, hdc, 0, y, width, height);
783
	w32_clear_area (f, hdc, FRAME_PIXEL_WIDTH (f) - width,
784 785 786
			y, width, height);
	release_frame_dc (f, hdc);
      }
787
      unblock_input ();
788 789 790 791
    }
}


Kim F. Storm's avatar
Kim F. Storm committed
792
/* Draw the bitmap WHICH in one of the left or right fringes of
793 794 795 796 797
   window W.  ROW is the glyph row for which to display the bitmap; it
   determines the vertical position at which the bitmap has to be
   drawn.  */

static void
798 799
w32_draw_fringe_bitmap (struct window *w, struct glyph_row *row,
			struct draw_fringe_bitmap_params *p)
800 801
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
Kim F. Storm's avatar
Kim F. Storm committed
802 803 804 805
  HDC hdc;
  struct face *face = p->face;

  hdc = get_frame_dc (f);
806 807

  /* Must clip because of partially visible lines.  */
808
  w32_clip_to_row (w, row, ANY_AREA, hdc);
809

810 811 812 813
  if (p->bx >= 0 && !p->overlay_p)
    w32_fill_area (f, hdc, face->background,
		   p->bx, p->by, p->nx, p->ny);

814
  if (p->which && p->which < max_fringe_bmp)
Kim F. Storm's avatar
Kim F. Storm committed
815 816 817 818
    {
      HBITMAP pixmap = fringe_bmp[p->which];
      HDC compat_hdc;
      HANDLE horig_obj;
819

Kim F. Storm's avatar
Kim F. Storm committed
820
      compat_hdc = CreateCompatibleDC (hdc);
Kenichi Handa's avatar
Kenichi Handa committed
821

Kim F. Storm's avatar
Kim F. Storm committed
822
      SaveDC (hdc);
823

Kim F. Storm's avatar
Kim F. Storm committed
824
      horig_obj = SelectObject (compat_hdc, pixmap);
825

Kenichi Handa's avatar
Kenichi Handa committed
826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859
      /* Paint overlays transparently.  */
      if (p->overlay_p)
	{
	  HBRUSH h_brush, h_orig_brush;

	  SetTextColor (hdc, BLACK_PIX_DEFAULT (f));
	  SetBkColor (hdc, WHITE_PIX_DEFAULT (f));
	  h_brush = CreateSolidBrush (face->foreground);
	  h_orig_brush = SelectObject (hdc, h_brush);

	  BitBlt (hdc, p->x, p->y, p->wd, p->h,
		  compat_hdc, 0, p->dh,
		  DSTINVERT);
	  BitBlt (hdc, p->x, p->y, p->wd, p->h,
		  compat_hdc, 0, p->dh,
		  0x2E064A);
	  BitBlt (hdc, p->x, p->y, p->wd, p->h,
		  compat_hdc, 0, p->dh,
		  DSTINVERT);

	  SelectObject (hdc, h_orig_brush);
	  DeleteObject (h_brush);
	}
      else
	{
	  SetTextColor (hdc, face->background);
	  SetBkColor (hdc, (p->cursor_p
			    ? f->output_data.w32->cursor_pixel
			    : face->foreground));

	  BitBlt (hdc, p->x, p->y, p->wd, p->h,
		  compat_hdc, 0, p->dh,
		  SRCCOPY);
	}
860

Kim F. Storm's avatar
Kim F. Storm committed
861 862 863
      SelectObject (compat_hdc, horig_obj);
      DeleteDC (compat_hdc);
      RestoreDC (hdc, -1);
864
    }
865

Kim F. Storm's avatar
Kim F. Storm committed
866
  w32_set_clip_rectangle (hdc, NULL);
867 868 869 870

  release_frame_dc (f, hdc);
}

Kenichi Handa's avatar
Kenichi Handa committed
871
static void
872
w32_define_fringe_bitmap (int which, unsigned short *bits, int h, int wd)
Kenichi Handa's avatar
Kenichi Handa committed
873
{
874 875 876 877 878 879 880 881 882
  if (which >= max_fringe_bmp)
    {
      int i = max_fringe_bmp;
      max_fringe_bmp = which + 20;
      fringe_bmp = (HBITMAP *) xrealloc (fringe_bmp, max_fringe_bmp * sizeof (HBITMAP));
      while (i < max_fringe_bmp)
	fringe_bmp[i++] = 0;
    }

Kenichi Handa's avatar
Kenichi Handa committed
883 884 885 886
  fringe_bmp[which] = CreateBitmap (wd, h, 1, 1, bits);
}

static void
887
w32_destroy_fringe_bitmap (int which)
Kenichi Handa's avatar
Kenichi Handa committed
888
{
889 890 891
  if (which >= max_fringe_bmp)
    return;

Kenichi Handa's avatar
Kenichi Handa committed
892 893 894 895 896
  if (fringe_bmp[which])
    DeleteObject (fringe_bmp[which]);
  fringe_bmp[which] = 0;
}

897 898 899 900 901 902
/***********************************************************************
			   Display Iterator
 ***********************************************************************/

/* Function prototypes of this page.  */

903 904 905 906 907 908 909 910 911 912 913
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_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 *);
914
static int w32_alloc_lighter_color (struct frame *, COLORREF *, double, int);
915 916 917 918 919 920 921 922 923 924 925 926 927 928
static void w32_setup_relief_color (struct frame *, struct relief *,
                                    double, int, COLORREF);
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 w32_draw_image_foreground_1 (struct glyph_string *, HBITMAP);
static void x_clear_glyph_string_rect (struct glyph_string *, int,
                                       int, int, int);
static void w32_draw_relief_rect (struct frame *, int, int, int, int,
                                  int, int, int, int, int, int,
                                  RECT *);
static void w32_draw_box_rect (struct glyph_string *, int, int, int, int,
                               int, int, int, RECT *);
929

930

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

static void
935
x_set_cursor_gc (struct glyph_string *s)
936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
{
  if (s->font == FRAME_FONT (s->f)
      && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
      && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
      && !s->cmp)
    s->gc = s->f->output_data.w32->cursor_gc;
  else
    {
      /* Cursor on non-default face: must merge.  */
      XGCValues xgcv;
      unsigned long mask;

      xgcv.background = s->f->output_data.w32->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.w32->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;
      mask = GCForeground | GCBackground | GCFont;

971 972
      if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
	XChangeGC (NULL, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
973 974
		   mask, &xgcv);
      else
975
	FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
976 977
	  = XCreateGC (NULL, s->window, mask, &xgcv);

978
      s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
979 980 981 982 983
    }
}


/* Set up S->gc of glyph string S for drawing text in mouse face.  */
984

985
static void
986
x_set_mouse_face_gc (struct glyph_string *s)
987
{
988
  int face_id;
989
  struct face *face;
990

991
  /* What face has to be used last for the mouse face?  */
992
  face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
993
  face = FACE_FROM_ID (s->f, face_id);
994 995
  if (face == NULL)
    face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
996

997
  if (s->first_glyph->type == CHAR_GLYPH)
998
    face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
999
  else
1000
    face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
  s->face = FACE_FROM_ID (s->f, face_id);
  PREPARE_FACE_FOR_DISPLAY (s->f, s->face);

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

1014 1015 1016 1017 1018
      xgcv.background = s->face->background;
      xgcv.foreground = s->face->foreground;
      IF_DEBUG (x_check_font (s->f, s->font));
      xgcv.font = s->font;
      mask = GCForeground | GCBackground | GCFont;
1019

1020 1021
      if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
	XChangeGC (NULL, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1022 1023
		   mask, &xgcv);
      else
1024
	FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
1025
	  = XCreateGC (NULL, s->window, mask, &xgcv);
1026

1027
      s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1028 1029
    }

1030
  eassert (s->gc != 0);
1031 1032 1033 1034 1035 1036 1037
}


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

Paul Eggert's avatar
Paul Eggert committed
1038
static inline void
1039
x_set_mode_line_face_gc (struct glyph_string *s)
1040
{
1041 1042 1043 1044 1045 1046 1047 1048
  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.  */

Paul Eggert's avatar
Paul Eggert committed
1049
static inline void
1050
x_set_glyph_string_gc (struct glyph_string *s)
1051
{
1052
  PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1053

1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
  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.  */
1087
  eassert (s->gc != 0);
1088 1089 1090 1091 1092 1093
}


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

Paul Eggert's avatar
Paul Eggert committed
1094
static inline void
1095
x_set_glyph_string_clipping (struct glyph_string *s)
1096
{
1097 1098 1099 1100 1101 1102 1103
  RECT *r = s->clip;
  int n = get_glyph_string_clip_rects (s, r, 2);

  if (n == 1)
    w32_set_clip_rectangle (s->hdc, r);
  else if (n > 1)
    {
1104 1105 1106 1107
      HRGN clip1 = CreateRectRgnIndirect (r);
      HRGN clip2 = CreateRectRgnIndirect (r + 1);
      if (CombineRgn (clip1, clip1, clip2, RGN_OR) != ERROR)
        SelectClipRgn (s->hdc, clip1);
1108 1109 1110 1111
      DeleteObject (clip1);
      DeleteObject (clip2);
    }
    s->num_clips = n;
1112 1113
}

Jason Rumney's avatar
Jason Rumney committed
1114 1115 1116 1117 1118
/* 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
1119 1120
x_set_glyph_string_clipping_exactly (struct glyph_string *src,
				     struct glyph_string *dst)
Jason Rumney's avatar
Jason Rumney committed
1121 1122 1123
{
  RECT r;

1124 1125 1126 1127 1128 1129
  r.left = src->x;
  r.right = r.left + src->width;
  r.top = src->y;
  r.bottom = r.top + src->height;
  dst->clip[0] = r;
  dst->num_clips = 1;
Jason Rumney's avatar
Jason Rumney committed
1130 1131
  w32_set_clip_rectangle (dst->hdc, &r);
}
1132

1133
/* RIF:
1134
   Compute left and right overhang of glyph string S.  */
1135

1136
static void
1137
w32_compute_glyph_string_overhangs (struct glyph_string *s)
1138
{
1139
  if (s->cmp == NULL
1140 1141
      && s->first_glyph->type == CHAR_GLYPH
      && !s->font_not_found_p)
1142
    {
1143 1144 1145 1146
      unsigned *code = alloca (sizeof (unsigned) * s->nchars);
      struct font *font = s->font;
      struct font_metrics metrics;
      int i;
1147

1148 1149 1150 1151 1152 1153
      for (i = 0; i < s->nchars; i++)
	code[i] = s->char2b[i];
      font->driver->text_extents (font, code, s->nchars, &metrics);
      s->right_overhang = (metrics.rbearing > metrics.width
			   ? metrics.rbearing - metrics.width : 0);
      s->left_overhang = metrics.lbearing < 0 ? -metrics.lbearing : 0;
1154 1155 1156 1157 1158 1159
    }
  else if (s->cmp)
    {
      s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
      s->left_overhang = -s->cmp->lbearing;
    }
1160 1161 1162 1163
}

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

Paul Eggert's avatar
Paul Eggert committed
1164
static inline void
1165 1166
x_clear_glyph_string_rect (struct glyph_string *s,
			   int x, int y, int w, int h)
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195
{
  int real_x = x;
  int real_y = y;
  int real_w = w;
  int real_h = h;
#if 0
  /* Take clipping into account.  */
  if (s->gc->clip_mask == Rect)
    {
      real_x = max (real_x, s->gc->clip_rectangle.left);
      real_y = max (real_y, s->gc->clip_rectangle.top);
      real_w = min (real_w, s->gc->clip_rectangle.right
                    - s->gc->clip_rectangle.left);
      real_h = min (real_h, s->gc->clip_rectangle.bottom
                    - s->gc->clip_rectangle.top);
    }
#endif
  w32_fill_area (s->f, s->hdc, s->gc->background, real_x, real_y,
                 real_w, real_h);
}


/* 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
   when a string preceding S draws into the background of S, or S
   contains the first component of a composition.  */

static void
1196
x_draw_glyph_string_background (struct glyph_string *s, int force_p)
1197 1198 1199 1200 1201
{
  /* 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)
    {
1202 1203
      int box_line_width = max (s->face->box_line_width, 0);

1204
#if 0 /* TODO: stipple */
1205 1206 1207 1208 1209
      if (s->stippled_p)
	{
	  /* Fill background with a stipple pattern.  */
	  XSetFillStyle (s->display, s->gc, FillOpaqueStippled);
	  XFillRectangle (s->display, s->window, s->gc, s->x,
1210
			  s->y + box_line_width,
1211
			  s->background_width,
1212
			  s->height - 2 * box_line_width);
1213 1214 1215 1216 1217
	  XSetFillStyle (s->display, s->gc, FillSolid);
	  s->background_filled_p = 1;
	}
      else
#endif
1218
        if (FONT_HEIGHT (s->font) < s->height - 2 * box_line_width
1219 1220 1221 1222
	       || s->font_not_found_p
	       || s->extends_to_end_of_line_p
	       || force_p)
	{
1223
	  x_clear_glyph_string_rect (s, s->x, s->y + box_line_width,
1224
				     s->background_width,
1225