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

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 1989, 1993-2019 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
Paul Eggert's avatar
Paul Eggert committed
18
along with GNU Emacs.  If not, see <https://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"
26
#include "w32common.h"	/* for OS version info */
Geoff Voelker's avatar
Geoff Voelker committed
27 28 29 30

#include <ctype.h>
#include <errno.h>
#include <sys/stat.h>
31 32 33
#ifdef CYGWIN
#include <fcntl.h>	/* for O_RDWR */
#endif
34
#include <imm.h>
35
#include <math.h>
Geoff Voelker's avatar
Geoff Voelker committed
36

37
#include "coding.h"
Geoff Voelker's avatar
Geoff Voelker committed
38
#include "frame.h"
39
#include "fontset.h"
Geoff Voelker's avatar
Geoff Voelker committed
40 41 42 43 44
#include "termhooks.h"
#include "termopts.h"
#include "termchar.h"
#include "buffer.h"
#include "window.h"
45
#include "keyboard.h"
46
#include "menu.h"	/* for w32_menu_show */
47

Daniel Colascione's avatar
Daniel Colascione committed
48
#ifdef WINDOWSNT
49
#include "w32.h"	/* for filename_from_utf16, filename_from_ansi */
Daniel Colascione's avatar
Daniel Colascione committed
50 51 52 53 54 55
#endif

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

56
#include <shellapi.h>
Geoff Voelker's avatar
Geoff Voelker committed
57

Jason Rumney's avatar
Jason Rumney committed
58
#include "font.h"
59
#include "w32font.h"
60 61 62 63

#if 0	/* TODO: stipple */
#include "bitmaps/gray.xbm"
#endif
64

Kim F. Storm's avatar
Kim F. Storm committed
65
/* Fringe bitmaps.  */
66

67 68
static int max_fringe_bmp = 0;
static HBITMAP *fringe_bmp = 0;
69

70
/* Temporary variables for w32_read_socket.  */
71

72 73
static int last_mousemove_x = 0;
static int last_mousemove_y = 0;
74

75 76 77 78 79
/* 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

80 81 82 83 84
/* 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
85 86
extern unsigned int msh_mousewheel;

87
extern int w32_codepage_for_font (char *fontname);
88
extern HCURSOR w32_load_cursor (LPCTSTR name);
89

Geoff Voelker's avatar
Geoff Voelker committed
90

91 92
/* 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
93
struct w32_display_info *x_display_list;
Geoff Voelker's avatar
Geoff Voelker committed
94

95
#if _WIN32_WINNT < 0x0500 && !defined(MINGW_W64)
96
/* Pre Windows 2000, this was not available, but define it here so
97
   that Emacs compiled on such a platform will run on newer versions.
98
   MinGW64 defines these unconditionally, so avoid redefining.  */
99 100 101 102 103 104 105

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

Juanma Barranquero's avatar
Juanma Barranquero committed
106
typedef struct tagGLYPHSET
107 108 109 110 111 112
{
  DWORD cbThis;
  DWORD flAccel;
  DWORD cGlyphsSupported;
  DWORD cRanges;
  WCRANGE ranges[1];
Juanma Barranquero's avatar
Juanma Barranquero committed
113
} GLYPHSET;
114

Daniel Colascione's avatar
Daniel Colascione committed
115
#endif /* compiling for pre-Win2k */
116

117
/* Dynamic linking to SetLayeredWindowAttribute (only since 2000).  */
118
BOOL (WINAPI *pfnSetLayeredWindowAttributes) (HWND, COLORREF, BYTE, DWORD);
119 120 121 122

#ifndef LWA_ALPHA
#define LWA_ALPHA 0x02
#endif
123 124 125 126 127
/* 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
128

129 130 131 132 133 134 135 136 137
/* 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

138 139 140 141 142
/* 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;
143 144 145
struct window *w32_system_caret_window;
int w32_system_caret_hdr_height;
int w32_system_caret_mode_height;
146 147
DWORD dwWindowsThreadId = 0;
HANDLE hWindowsThread = NULL;
Geoff Voelker's avatar
Geoff Voelker committed
148 149 150
DWORD dwMainThreadId = 0;
HANDLE hMainThread = NULL;

151
int vertical_scroll_bar_min_handle;
152
int horizontal_scroll_bar_min_handle;
153 154
int vertical_scroll_bar_top_border;
int vertical_scroll_bar_bottom_border;
155 156
int horizontal_scroll_bar_left_border;
int horizontal_scroll_bar_right_border;
157 158 159

int last_scroll_bar_drag_pos;

160 161 162
/* Keyboard code page - may be changed by language-change events.  */
int w32_keyboard_codepage;

Daniel Colascione's avatar
Daniel Colascione committed
163 164 165 166
#ifdef CYGWIN
int w32_message_fd = -1;
#endif /* CYGWIN */

167 168
static void w32_handle_tool_bar_click (struct frame *,
                                       struct input_event *);
169
static void w32_define_cursor (Window, Emacs_Cursor);
170

171 172 173
static void w32_scroll_bar_clear (struct frame *);
static void w32_raise_frame (struct frame *);
static void w32_lower_frame (struct frame *);
174
static void w32_initialize (void);
175
static void w32_update_end (struct frame *);
176
static void w32_frame_up_to_date (struct frame *);
177
static void w32_clear_frame (struct frame *);
178 179
static void w32_frame_highlight (struct frame *);
static void w32_frame_unhighlight (struct frame *);
180 181 182
static void w32_new_focus_frame (struct w32_display_info *,
                                 struct frame *);
static void w32_focus_changed (int, int, struct w32_display_info *,
183 184 185 186
                             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 *);
187 188 189
static void w32_frame_rehighlight_1 (struct w32_display_info *);
static void w32_draw_hollow_cursor (struct window *, struct glyph_row *);
static void w32_draw_bar_cursor (struct window *, struct glyph_row *, int,
190
                               enum text_cursor_kinds);
191 192
static void w32_clip_to_row (struct window *, struct glyph_row *,
			     enum glyph_row_area, HDC);
193 194
static BOOL my_show_window (struct frame *, HWND, int);
static void my_set_window_pos (HWND, HWND, int, int, int, int, UINT);
195
#if 0
196
static void my_set_focus (struct frame *, HWND);
197
#endif
198 199
static void my_set_foreground_window (HWND);
static void my_destroy_window (struct frame *, HWND);
Dmitry Antipov's avatar
Dmitry Antipov committed
200
static void w32fullscreen_hook (struct frame *);
201

202
#ifdef GLYPH_DEBUG
203
static void w32_check_font (struct frame *, struct font *);
204 205
#endif

Geoff Voelker's avatar
Geoff Voelker committed
206

207 208 209 210
/***********************************************************************
			      Debugging
 ***********************************************************************/

Geoff Voelker's avatar
Geoff Voelker committed
211
#if 0
212 213 214

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

216
struct record
Geoff Voelker's avatar
Geoff Voelker committed
217 218 219 220 221 222 223 224 225
{
  char *locus;
  int type;
};

struct record event_record[100];

int event_record_index;

226
record_event (char *locus, int type)
Geoff Voelker's avatar
Geoff Voelker committed
227 228 229 230 231 232 233 234 235 236 237
{
  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 */

238

239
static void
240
XChangeGC (void *ignore, XGCValues *gc, unsigned long mask,
241
	   XGCValues *xgcv)
242 243 244 245 246 247 248 249 250
{
  if (mask & GCForeground)
    gc->foreground = xgcv->foreground;
  if (mask & GCBackground)
    gc->background = xgcv->background;
  if (mask & GCFont)
    gc->font = xgcv->font;
}

251
XGCValues *
Eli Zaretskii's avatar
Eli Zaretskii committed
252
XCreateGC (void *ignore, HWND wignore, unsigned long mask, XGCValues *xgcv)
253
{
Dmitry Antipov's avatar
Dmitry Antipov committed
254
  XGCValues *gc = xzalloc (sizeof (XGCValues));
255 256 257 258 259 260

  XChangeGC (ignore, gc, mask, xgcv);

  return gc;
}

261
#if 0	/* unused for now, see w32_draw_image_glyph_string below */
262
static void
263 264
XGetGCValues (void *ignore, XGCValues *gc,
	      unsigned long mask, XGCValues *xgcv)
265 266 267
{
  XChangeGC (ignore, xgcv, mask, gc);
}
268
#endif
269 270 271 272 273 274 275 276 277 278 279 280 281 282

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

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302
/* 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);
    }
}

303
static void
304
w32_get_scale_factor(struct w32_display_info *dpyinfo, int *scale_x, int *scale_y)
305 306 307 308 309 310 311
{
  const int base_res = 96;

  *scale_x = *scale_y = 1;

  if (dpyinfo)
    {
312 313 314 315
      if (dpyinfo->resx > base_res)
	*scale_x = floor (dpyinfo->resx / base_res);
      if (dpyinfo->resy > base_res)
	*scale_y = floor (dpyinfo->resy / base_res);
316 317 318
    }
}

319 320 321 322 323 324 325 326 327 328 329
/*
   Draw a wavy line under S. The wave fills wave_height pixels from y0.

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

*/

330
static void
331 332
w32_draw_underwave (struct glyph_string *s, COLORREF color)
{
333 334 335
  struct w32_display_info *dpyinfo = FRAME_DISPLAY_INFO (s->f);

  int scale_x, scale_y;
336
  w32_get_scale_factor (dpyinfo, &scale_x, &scale_y);
337 338

  int wave_height = 3 * scale_y, wave_length = 2 * scale_x, thickness = scale_y;
339 340 341 342 343 344 345 346
  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;
347
  y0 = s->ybase + wave_height / 2 - scale_y;
348 349 350 351 352
  width = s->width;
  xmax = x0 + width;

  /* Find and set clipping rectangle */

353 354 355 356 357
  wave_clip.x = x0;
  wave_clip.y = y0;
  wave_clip.width = width;
  wave_clip.height = wave_height;

358 359 360
  get_glyph_string_clip_rect (s, &w32_string_clip);
  CONVERT_TO_XRECT (string_clip, w32_string_clip);

361
  if (!gui_intersect_rectangles (&wave_clip, &string_clip, &final_clip))
362 363
    return;

364
  hp = CreatePen (PS_SOLID, thickness, color);
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 390 391 392 393 394 395
  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);
}
396 397

/* Draw a hollow rectangle at the specified position.  */
398
static void
399 400 401 402 403 404 405 406 407 408 409
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);

410 411 412 413 414
  /* We enlarge WIDTH and HEIGHT by 1 to be bug-compatible to the
     brain-dead design of XDrawRectangle, which draws a rectangle that
     is 1 pixel wider and higher than its arguments WIDTH and HEIGHT.
     This allows us to keep the code that calls this function similar
     to the corresponding code in xterm.c.  For the details, see
415
     https://lists.gnu.org/r/emacs-devel/2014-10/msg00546.html.  */
416
  Rectangle (hdc, x, y, x + width + 1, y + height + 1);
417 418 419 420 421 422 423 424

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

/* Draw a filled rectangle at the specified position. */
425
void
Dmitry Antipov's avatar
Dmitry Antipov committed
426
w32_fill_rect (struct frame *f, HDC hdc, COLORREF pix, RECT *lprect)
Geoff Voelker's avatar
Geoff Voelker committed
427 428
{
  HBRUSH hb;
429

Geoff Voelker's avatar
Geoff Voelker committed
430 431 432 433 434
  hb = CreateSolidBrush (pix);
  FillRect (hdc, lprect, hb);
  DeleteObject (hb);
}

435
void
Dmitry Antipov's avatar
Dmitry Antipov committed
436
w32_clear_window (struct frame *f)
Geoff Voelker's avatar
Geoff Voelker committed
437 438
{
  RECT rect;
439
  HDC hdc = get_frame_dc (f);
Geoff Voelker's avatar
Geoff Voelker committed
440

441 442 443 444 445 446 447 448 449
  /* 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);
    }

450
  release_frame_dc (f, hdc);
Geoff Voelker's avatar
Geoff Voelker committed
451 452
}

453 454
#define OPAQUE_FRAME 255

455 456
static void
w32_set_frame_alpha (struct frame *f)
457
{
458
  struct w32_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
459 460 461 462 463 464 465 466 467 468
  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;

469
  if (dpyinfo->w32_focus_frame == f)
470 471 472 473 474 475
    alpha = f->alpha[0];
  else
    alpha = f->alpha[1];

  if (FLOATP (Vframe_alpha_lower_limit))
    alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
476
  else if (FIXNUMP (Vframe_alpha_lower_limit))
Tom Tromey's avatar
Tom Tromey committed
477
    alpha_min = (XFIXNUM (Vframe_alpha_lower_limit)) / 100.0;
478

479 480 481
  if (alpha < 0.0)
    return;
  else if (alpha > 1.0)
482 483 484 485 486 487 488 489 490
    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
491
    ex_style &= ~WS_EX_LAYERED;
492 493 494 495 496 497 498 499 500
  else
    ex_style |= WS_EX_LAYERED;

  SetWindowLong (window, GWL_EXSTYLE, ex_style);

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

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

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

510
  return pixels;
511 512 513
}

int
514
w32_display_pixel_width (struct w32_display_info *dpyinfo)
515
{
516 517 518 519 520 521
  int pixels = GetSystemMetrics (SM_CXVIRTUALSCREEN);

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

522
  return pixels;
523 524
}

Geoff Voelker's avatar
Geoff Voelker committed
525

526 527 528
/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
529

530 531
/* 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.
532
   This function is called prior to calls to gui_update_window_begin
533
   for each window being updated.  */
Geoff Voelker's avatar
Geoff Voelker committed
534

535
static void
536
w32_update_begin (struct frame *f)
Geoff Voelker's avatar
Geoff Voelker committed
537
{
538
  struct w32_display_info *display_info = FRAME_DISPLAY_INFO (f);
539

Andrew Innes's avatar
Andrew Innes committed
540 541 542
  if (! FRAME_W32_P (f))
    return;

543 544 545 546 547 548 549
  /* 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;
  }
550
}
Geoff Voelker's avatar
Geoff Voelker committed
551

552

553
/* Start update of window W.  */
554 555

static void
556
w32_update_window_begin (struct window *w)
557
{
558
  /* Hide the system caret during an update.  */
559 560
  if (w32_use_visible_system_caret && w32_system_caret_hwnd)
    {
561 562
      SendMessageTimeout (w32_system_caret_hwnd, WM_EMACS_HIDE_CARET, 0, 0,
			  0, 6000, NULL);
563
    }
Geoff Voelker's avatar
Geoff Voelker committed
564 565
}

566
/* Draw a vertical window border from (x,y0) to (x,y1)  */
567

568
static void
569
w32_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
Geoff Voelker's avatar
Geoff Voelker committed
570
{
571
  struct frame *f = XFRAME (WINDOW_FRAME (w));
572 573
  RECT r;
  HDC hdc;
574
  struct face *face;
575

576 577 578 579
  r.left = x;
  r.right = x + 1;
  r.top = y0;
  r.bottom = y1;
580

581
  hdc = get_frame_dc (f);
582
  face = FACE_FROM_ID_OR_NULL (f, VERTICAL_BORDER_FACE_ID);
583 584 585 586 587
  if (face)
    w32_fill_rect (f, hdc, face->foreground, &r);
  else
    w32_fill_rect (f, hdc, FRAME_FOREGROUND_PIXEL (f), &r);

588
  release_frame_dc (f, hdc);
589
}
Geoff Voelker's avatar
Geoff Voelker committed
590

591

592 593 594 595 596 597
/* 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));
598
  HDC hdc = get_frame_dc (f);
599
  struct face *face = FACE_FROM_ID_OR_NULL (f, WINDOW_DIVIDER_FACE_ID);
600
  struct face *face_first
601
    = FACE_FROM_ID_OR_NULL (f, WINDOW_DIVIDER_FIRST_PIXEL_FACE_ID);
602
  struct face *face_last
603
    = FACE_FROM_ID_OR_NULL (f, WINDOW_DIVIDER_LAST_PIXEL_FACE_ID);
604 605 606 607 608 609 610 611
  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));

612 613 614
  if ((y1 - y0 > x1 - x0) && (x1 - x0 >= 3))
    /* A vertical divider, at least three pixels wide: Draw first and
       last pixels differently.  */
615 616 617 618 619
    {
      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);
    }
620 621 622
  else if ((x1 - x0 > y1 - y0) && (y1 - y0 >= 3))
    /* A horizontal divider, at least three pixels high: Draw first and
       last pixels differently.  */
623 624 625 626 627
    {
      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);
    }
628
  else
629 630
    /* In any other case do not draw the first and last pixels
       differently.  */
631
    w32_fill_area_abs (f, hdc, color, x0, y0, x1, y1);
632 633 634 635

  release_frame_dc (f, hdc);
}

636
/* End update of window W.
637 638 639 640 641 642 643 644 645 646 647

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

static void
650
w32_update_window_end (struct window *w, bool cursor_on_p,
651
                       bool mouse_face_overwritten_p)
652
{
653 654
  /* Unhide the caret.  This won't actually show the cursor, unless it
     was visible before the corresponding call to HideCaret in
655
     w32_update_window_begin.  */
656 657
  if (w32_use_visible_system_caret && w32_system_caret_hwnd)
    {
658 659
      SendMessageTimeout (w32_system_caret_hwnd, WM_EMACS_SHOW_CARET, 0, 0,
			  0, 6000, NULL);
660
    }
661 662
}

663 664 665 666

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

667
static void
668
w32_update_end (struct frame *f)
669
{
Andrew Innes's avatar
Andrew Innes committed
670 671 672
  if (! FRAME_W32_P (f))
    return;

673
  /* Mouse highlight may be displayed again.  */
674
  MOUSE_HL_INFO (f)->mouse_face_defer = false;
Geoff Voelker's avatar
Geoff Voelker committed
675 676
}

677

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

681
static void
682
w32_frame_up_to_date (struct frame *f)
Geoff Voelker's avatar
Geoff Voelker committed
683
{
684
  if (FRAME_W32_P (f))
685
    FRAME_MOUSE_UPDATE (f);
Geoff Voelker's avatar
Geoff Voelker committed
686
}
687 688 689


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
690
   arrow bitmaps, or clear the fringes if no bitmaps are required
691
   before DESIRED_ROW is made current.  This function is called from
692 693 694 695
   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
696
w32_after_update_window_line (struct window *w, struct glyph_row *desired_row)
697
{
698 699 700
  struct frame *f;
  int width, height;

701
  eassert (w);
702

703
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
704
    desired_row->redraw_fringe_bitmaps_p = true;
705

706 707
  /* When a window has disappeared, make sure that no rest of
     full-width rows stays visible in the internal border.  Could
708
     check here if updated window is the leftmost/rightmost window,
709 710 711 712 713
     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
714
      && (f = XFRAME (w->frame),
715 716 717 718 719 720
	  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));
721 722 723 724 725
      int face_id =
	!NILP (Vface_remapping_alist)
	? lookup_basic_face (NULL, f, INTERNAL_BORDER_FACE_ID)
	: INTERNAL_BORDER_FACE_ID;
      struct face *face = FACE_FROM_ID_OR_NULL (f, face_id);
726

727
      block_input ();
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746

      HDC hdc = get_frame_dc (f);
      if (face)
	{
	  /* Fill border with internal border face.  */
	  unsigned long color = face->background;

	  w32_fill_area (f, hdc, color, 0, y, width, height);
	  w32_fill_area (f, hdc, color, FRAME_PIXEL_WIDTH (f) - width,
			 y, width, height);
	}
      else
	{
	  w32_clear_area (f, hdc, 0, y, width, height);
	  w32_clear_area (f, hdc, FRAME_PIXEL_WIDTH (f) - width,
			  y, width, height);
	}
      release_frame_dc (f, hdc);

747
      unblock_input ();
748 749 750 751
    }
}


Kim F. Storm's avatar
Kim F. Storm committed
752
/* Draw the bitmap WHICH in one of the left or right fringes of
753 754 755 756 757
   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
758 759
w32_draw_fringe_bitmap (struct window *w, struct glyph_row *row,
			struct draw_fringe_bitmap_params *p)
760 761
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
Kim F. Storm's avatar
Kim F. Storm committed
762 763 764 765
  HDC hdc;
  struct face *face = p->face;

  hdc = get_frame_dc (f);
766 767

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

770 771 772 773
  if (p->bx >= 0 && !p->overlay_p)
    w32_fill_area (f, hdc, face->background,
		   p->bx, p->by, p->nx, p->ny);

774
  if (p->which && p->which < max_fringe_bmp)
Kim F. Storm's avatar
Kim F. Storm committed
775 776 777 778
    {
      HBITMAP pixmap = fringe_bmp[p->which];
      HDC compat_hdc;
      HANDLE horig_obj;
779

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

Kim F. Storm's avatar
Kim F. Storm committed
782
      SaveDC (hdc);
783

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

Kenichi Handa's avatar
Kenichi Handa committed
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
      /* 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);
	}
820

Kim F. Storm's avatar
Kim F. Storm committed
821 822 823
      SelectObject (compat_hdc, horig_obj);
      DeleteDC (compat_hdc);
      RestoreDC (hdc, -1);
824
    }
825

Kim F. Storm's avatar
Kim F. Storm committed
826
  w32_set_clip_rectangle (hdc, NULL);
827 828 829 830

  release_frame_dc (f, hdc);
}

Kenichi Handa's avatar
Kenichi Handa committed
831
static void
832
w32_define_fringe_bitmap (int which, unsigned short *bits, int h, int wd)
Kenichi Handa's avatar
Kenichi Handa committed
833
{
834 835 836 837 838 839 840 841 842
  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
843 844 845 846
  fringe_bmp[which] = CreateBitmap (wd, h, 1, 1, bits);
}

static void
847
w32_destroy_fringe_bitmap (int which)
Kenichi Handa's avatar
Kenichi Handa committed
848
{
849 850 851
  if (which >= max_fringe_bmp)
    return;

Kenichi Handa's avatar
Kenichi Handa committed
852 853 854 855 856
  if (fringe_bmp[which])
    DeleteObject (fringe_bmp[which]);
  fringe_bmp[which] = 0;
}

857 858 859 860 861 862
/***********************************************************************
			   Display Iterator
 ***********************************************************************/

/* Function prototypes of this page.  */

863 864 865 866 867 868 869 870 871 872 873
static void w32_set_glyph_string_clipping (struct glyph_string *);
static void w32_set_glyph_string_gc (struct glyph_string *);
static void w32_draw_glyph_string_background (struct glyph_string *,
                                              bool);
static void w32_draw_glyph_string_foreground (struct glyph_string *);
static void w32_draw_composite_glyph_string_foreground (struct glyph_string *);
static void w32_draw_glyph_string_box (struct glyph_string *);
static void w32_draw_glyph_string  (struct glyph_string *);
static void w32_set_cursor_gc (struct glyph_string *);
static void w32_set_mode_line_face_gc (struct glyph_string *);
static void w32_set_mouse_face_gc (struct glyph_string *);
874
static int w32_alloc_lighter_color (struct frame *, COLORREF *, double, int);
875 876
static void w32_setup_relief_color (struct frame *, struct relief *,
                                    double, int, COLORREF);
877 878 879 880
static void w32_setup_relief_colors (struct glyph_string *);
static void w32_draw_image_glyph_string (struct glyph_string *);
static void w32_draw_image_relief (struct glyph_string *);
static void w32_draw_image_foreground (struct glyph_string *);
881
static void w32_draw_image_foreground_1 (struct glyph_string *, HBITMAP);
882 883
static void w32_clear_glyph_string_rect (struct glyph_string *, int,
                                         int, int, int);
884 885 886 887
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,
888
                               int, bool, bool, RECT *);
889

890

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

static void
895
w32_set_cursor_gc (struct glyph_string *s)
896 897 898 899
{
  if (s->font == FRAME_FONT (s->f)
      && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
      && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
900 901 902 903
      /* Sometimes we are not called for each change in the default
	 face's background color (e.g., bug#26851), so the additional
	 test in the next line gives us a chance to resync.  */
      && s->f->output_data.w32->cursor_gc->foreground == s->face->background
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
      && !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;
	}

931
      IF_DEBUG (w32_check_font (s->f, s->font));
932 933 934
      xgcv.font = s->font;
      mask = GCForeground | GCBackground | GCFont;

935 936
      if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
	XChangeGC (NULL, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
937 938
		   mask, &xgcv);
      else
939
	FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
Eli Zaretskii's avatar
Eli Zaretskii committed
940
	  = XCreateGC (NULL, FRAME_W32_WINDOW (s->f), mask, &xgcv);
941

942
      s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
943 944 945 946 947
    }
}


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

949
static void
950
w32_set_mouse_face_gc (struct glyph_string *s)
951
{
952
  int face_id;
953
  struct face *face;
954

955
  /* What face has to be used last for the mouse face?  */
956
  face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
957
  face = FACE_FROM_ID_OR_NULL (s->f, face_id);
958 959
  if (face == NULL)
    face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
960

961
  if (s->first_glyph->type == CHAR_GLYPH)
962
    face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
963
  else
964
    face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
965
  s->face = FACE_FROM_ID (s->f, face_id);
966
  prepare_face_for_display (s->f, s->face);
967 968 969 970 971 972 973 974 975 976

  /* 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;
977

978 979
      xgcv.background = s->face->background;
      xgcv.foreground = s->face->foreground;
980
      IF_DEBUG (w32_check_font (s->f, s->font));
981 982
      xgcv.font = s->font;
      mask = GCForeground | GCBackground | GCFont;
983

984 985
      if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
	XChangeGC (NULL, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
986 987
		   mask, &xgcv);
      else
988
	FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
Eli Zaretskii's avatar
Eli Zaretskii committed
989
	  = XCreateGC (NULL, FRAME_W32_WINDOW (s->f), mask, &xgcv);
990

991
      s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
992 993
    }

994
  eassert (s->gc != 0);
995 996 997 998 999 1000 1001
}


/* 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
1002
static inline void
1003
w32_set_mode_line_face_gc (struct glyph_string *s)
1004
{
1005 1006 1007 1008 1009 1010 1011 1012
  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
1013
static inline void
1014
w32_set_glyph_string_gc (struct glyph_string *s)
1015
{
1016
  prepare_face_for_display (s->f, s->face);
1017

1018 1019 1020 1021 1022 1023 1024
  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)
    {
1025
      w32_set_mode_line_face_gc (s);
1026 1027 1028 1029
      s->stippled_p = s->face->stipple != 0;
    }
  else if (s->hl == DRAW_CURSOR)
    {
1030
      w32_set_cursor_gc (s);
1031
      s->stippled_p = false;
1032 1033 1034
    }
  else if (s->hl == DRAW_MOUSE_FACE)
    {
1035
      w32_set_mouse_face_gc (s);
1036 1037 1038 1039 1040 1041 1042 1043 1044
      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
1045
    emacs_abort ();
1046 1047

  /* GC must have been set.  */
1048
  eassert (s->gc != 0);
1049 1050 1051 1052 1053 1054
}


/* 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
1055
static inline void
1056
w32_set_glyph_string_clipping (struct glyph_string *s)
1057
{
1058 1059 1060 1061 1062 1063 1064
  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)
    {
1065 1066 1067 1068
      HRGN clip1 = CreateRectRgnIndirect (r);
      HRGN clip2 = CreateRectRgnIndirect (r + 1);
      if (CombineRgn (clip1, clip1, clip2, RGN_OR) != ERROR)
        SelectClipRgn (s->hdc, clip1);
1069 1070 1071 1072
      DeleteObject (clip1);
      DeleteObject (clip2);
    }
    s->num_clips = n;
1073 1074
}

Jason Rumney's avatar
Jason Rumney committed
1075 1076 1077 1078 1079
/* 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
1080 1081
w32_set_glyph_string_clipping_exactly (struct glyph_string *src,
                                       struct glyph_string *dst)
Jason Rumney's avatar
Jason Rumney committed
1082 1083 1084
{
  RECT r;

1085 1086 1087 1088 1089 1090
  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
1091 1092
  w32_set_clip_rectangle (dst->hdc, &r);
}
1093

1094
/* RIF:
1095
   Compute left and right overhang of glyph string S.  */
1096

1097
static void
1098
w32_compute_glyph_string_overhangs (struct glyph_string *s)
1099
{
1100
  if (s->cmp == NULL
1101 1102
      && s->first_glyph->type == CHAR_GLYPH
      && !s->font_not_found_p)
1103
    {
1104 1105 1106 1107
      unsigned *code = alloca (sizeof (unsigned) * s->nchars);
      struct font *font = s->font;
      struct font_metrics metrics;
      int i;
1108

1109 1110 1111 1112 1113 1114
      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;
1115 1116 1117 1118 1119 1120
    }
  else if (s->cmp)
    {
      s->right_overhang = s->cmp->rbearing - s->cmp->pixel_width;
      s->left_overhang = -s->cmp->lbearing;
    }
1121 1122 1123 1124
}

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

Paul Eggert's avatar