w32term.c 211 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-2017 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 Cursor w32_load_cursor (LPCTSTR name);
89

Geoff Voelker's avatar
Geoff Voelker committed
90 91 92 93
#define x_any_window_to_frame x_window_to_frame
#define x_top_window_to_frame x_window_to_frame


94 95
/* 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
96
struct w32_display_info *x_display_list;
Geoff Voelker's avatar
Geoff Voelker committed
97

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

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

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

Daniel Colascione's avatar
Daniel Colascione committed
118
#endif /* compiling for pre-Win2k */
119

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

#ifndef LWA_ALPHA
#define LWA_ALPHA 0x02
#endif
126 127 128 129 130
/* 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
131

132 133 134 135 136 137 138 139 140
/* 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

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

154
int vertical_scroll_bar_min_handle;
155
int horizontal_scroll_bar_min_handle;
156 157
int vertical_scroll_bar_top_border;
int vertical_scroll_bar_bottom_border;
158 159
int horizontal_scroll_bar_left_border;
int horizontal_scroll_bar_right_border;
160 161 162

int last_scroll_bar_drag_pos;

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

Daniel Colascione's avatar
Daniel Colascione committed
166 167 168 169
#ifdef CYGWIN
int w32_message_fd = -1;
#endif /* CYGWIN */

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
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 *);
void x_raise_frame (struct frame *);
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);
196 197
static void w32_clip_to_row (struct window *, struct glyph_row *,
			     enum glyph_row_area, HDC);
198 199
static BOOL my_show_window (struct frame *, HWND, int);
static void my_set_window_pos (HWND, HWND, int, int, int, int, UINT);
200
#if 0
201
static void my_set_focus (struct frame *, HWND);
202
#endif
203 204
static void my_set_foreground_window (HWND);
static void my_destroy_window (struct frame *, HWND);
Dmitry Antipov's avatar
Dmitry Antipov committed
205
static void w32fullscreen_hook (struct frame *);
206

207
#ifdef GLYPH_DEBUG
208 209 210
static void x_check_font (struct frame *, struct font *);
#endif

Geoff Voelker's avatar
Geoff Voelker committed
211

212 213 214 215
/***********************************************************************
			      Debugging
 ***********************************************************************/

Geoff Voelker's avatar
Geoff Voelker committed
216
#if 0
217 218 219

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

221
struct record
Geoff Voelker's avatar
Geoff Voelker committed
222 223 224 225 226 227 228 229 230
{
  char *locus;
  int type;
};

struct record event_record[100];

int event_record_index;

231
record_event (char *locus, int type)
Geoff Voelker's avatar
Geoff Voelker committed
232 233 234 235 236 237 238 239 240 241 242
{
  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 */

243

244
static void
245
XChangeGC (void *ignore, XGCValues *gc, unsigned long mask,
246
	   XGCValues *xgcv)
247 248 249 250 251 252 253 254 255
{
  if (mask & GCForeground)
    gc->foreground = xgcv->foreground;
  if (mask & GCBackground)
    gc->background = xgcv->background;
  if (mask & GCFont)
    gc->font = xgcv->font;
}

256
XGCValues *
Eli Zaretskii's avatar
Eli Zaretskii committed
257
XCreateGC (void *ignore, HWND wignore, unsigned long mask, XGCValues *xgcv)
258
{
Dmitry Antipov's avatar
Dmitry Antipov committed
259
  XGCValues *gc = xzalloc (sizeof (XGCValues));
260 261 262 263 264 265

  XChangeGC (ignore, gc, mask, xgcv);

  return gc;
}

266 267
#if 0	/* unused for now, see x_draw_image_glyph_string below */
static void
268 269
XGetGCValues (void *ignore, XGCValues *gc,
	      unsigned long mask, XGCValues *xgcv)
270 271 272
{
  XChangeGC (ignore, xgcv, mask, gc);
}
273
#endif
274 275 276 277 278 279 280 281 282 283 284 285 286 287

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

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
/* 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);
    }
}

308 309 310 311 312 313 314 315 316
static void
x_get_scale_factor(struct w32_display_info *dpyinfo, int *scale_x, int *scale_y)
{
  const int base_res = 96;

  *scale_x = *scale_y = 1;

  if (dpyinfo)
    {
317 318 319 320
      if (dpyinfo->resx > base_res)
	*scale_x = floor (dpyinfo->resx / base_res);
      if (dpyinfo->resy > base_res)
	*scale_y = floor (dpyinfo->resy / base_res);
321 322 323
    }
}

324 325 326 327 328 329 330 331 332 333 334
/*
   Draw a wavy line under S. The wave fills wave_height pixels from y0.

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

*/

335
static void
336 337
w32_draw_underwave (struct glyph_string *s, COLORREF color)
{
338 339 340 341 342 343
  struct w32_display_info *dpyinfo = FRAME_DISPLAY_INFO (s->f);

  int scale_x, scale_y;
  x_get_scale_factor (dpyinfo, &scale_x, &scale_y);

  int wave_height = 3 * scale_y, wave_length = 2 * scale_x, thickness = scale_y;
344 345 346 347 348 349 350 351
  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;
352
  y0 = s->ybase + wave_height / 2 - scale_y;
353 354 355 356 357
  width = s->width;
  xmax = x0 + width;

  /* Find and set clipping rectangle */

358 359 360 361 362
  wave_clip.x = x0;
  wave_clip.y = y0;
  wave_clip.width = width;
  wave_clip.height = wave_height;

363 364 365 366 367 368
  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;

369
  hp = CreatePen (PS_SOLID, thickness, color);
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 396 397 398 399 400
  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);
}
401 402

/* Draw a hollow rectangle at the specified position.  */
403
static void
404 405 406 407 408 409 410 411 412 413 414
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);

415 416 417 418 419
  /* 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
Paul Eggert's avatar
Paul Eggert committed
420
     https://lists.gnu.org/archives/html/emacs-devel/2014-10/msg00546.html.  */
421
  Rectangle (hdc, x, y, x + width + 1, y + height + 1);
422 423 424 425 426 427 428 429

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

/* Draw a filled rectangle at the specified position. */
430
void
Dmitry Antipov's avatar
Dmitry Antipov committed
431
w32_fill_rect (struct frame *f, HDC hdc, COLORREF pix, RECT *lprect)
Geoff Voelker's avatar
Geoff Voelker committed
432 433
{
  HBRUSH hb;
434

Geoff Voelker's avatar
Geoff Voelker committed
435 436 437 438 439
  hb = CreateSolidBrush (pix);
  FillRect (hdc, lprect, hb);
  DeleteObject (hb);
}

440
void
Dmitry Antipov's avatar
Dmitry Antipov committed
441
w32_clear_window (struct frame *f)
Geoff Voelker's avatar
Geoff Voelker committed
442 443
{
  RECT rect;
444
  HDC hdc = get_frame_dc (f);
Geoff Voelker's avatar
Geoff Voelker committed
445

446 447 448 449 450 451 452 453 454
  /* 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);
    }

455
  release_frame_dc (f, hdc);
Geoff Voelker's avatar
Geoff Voelker committed
456 457
}

458 459 460
#define OPAQUE_FRAME 255

void
461
x_set_frame_alpha (struct frame *f)
462
{
463
  struct w32_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
464 465 466 467 468 469 470 471 472 473
  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;

474
  if (dpyinfo->w32_focus_frame == f)
475 476 477 478 479 480 481 482 483
    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;

484 485 486
  if (alpha < 0.0)
    return;
  else if (alpha > 1.0)
487 488 489 490 491 492 493 494 495
    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
496
    ex_style &= ~WS_EX_LAYERED;
497 498 499 500 501 502 503 504 505
  else
    ex_style |= WS_EX_LAYERED;

  SetWindowLong (window, GWL_EXSTYLE, ex_style);

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

506
int
507
x_display_pixel_height (struct w32_display_info *dpyinfo)
508
{
509 510 511 512 513 514
  int pixels = GetSystemMetrics (SM_CYVIRTUALSCREEN);

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

515
  return pixels;
516 517 518
}

int
519
x_display_pixel_width (struct w32_display_info *dpyinfo)
520
{
521 522 523 524 525 526
  int pixels = GetSystemMetrics (SM_CXVIRTUALSCREEN);

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

527
  return pixels;
528 529
}

Geoff Voelker's avatar
Geoff Voelker committed
530

531 532 533
/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
534

535 536 537
/* 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
538
   each window being updated.  */
Geoff Voelker's avatar
Geoff Voelker committed
539

540
static void
541
x_update_begin (struct frame *f)
Geoff Voelker's avatar
Geoff Voelker committed
542
{
543
  struct w32_display_info *display_info = FRAME_DISPLAY_INFO (f);
544

Andrew Innes's avatar
Andrew Innes committed
545 546 547
  if (! FRAME_W32_P (f))
    return;

548 549 550 551 552 553 554
  /* 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;
  }
555
}
Geoff Voelker's avatar
Geoff Voelker committed
556

557

558
/* Start update of window W.  */
559 560

static void
561
x_update_window_begin (struct window *w)
562 563
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
564
  Mouse_HLInfo *hlinfo = MOUSE_HL_INFO (f);
565

566
  /* Hide the system caret during an update.  */
567 568
  if (w32_use_visible_system_caret && w32_system_caret_hwnd)
    {
569 570
      SendMessageTimeout (w32_system_caret_hwnd, WM_EMACS_HIDE_CARET, 0, 0,
			  0, 6000, NULL);
571
    }
572

573
  w->output_cursor = w->cursor;
Geoff Voelker's avatar
Geoff Voelker committed
574

575
  block_input ();
Geoff Voelker's avatar
Geoff Voelker committed
576

577
  if (f == hlinfo->mouse_face_mouse_frame)
Geoff Voelker's avatar
Geoff Voelker committed
578 579
    {
      /* Don't do highlighting for mouse motion during the update.  */
580
      hlinfo->mouse_face_defer = true;
Geoff Voelker's avatar
Geoff Voelker committed
581

582 583
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
Geoff Voelker's avatar
Geoff Voelker committed
584
      if (FRAME_GARBAGED_P (f))
585
	hlinfo->mouse_face_window = Qnil;
586

587 588 589 590 591 592
#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.  */
593

594 595 596 597 598
      /* 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.  */
599 600
      if (!NILP (hlinfo->mouse_face_window)
	  && w == XWINDOW (hlinfo->mouse_face_window))
Geoff Voelker's avatar
Geoff Voelker committed
601
	{
602
	  int i;
Geoff Voelker's avatar
Geoff Voelker committed
603

604 605
          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
606 607
	      break;

608
	  if (i < w->desired_matrix->nrows)
609
	    clear_mouse_face (hlinfo);
Geoff Voelker's avatar
Geoff Voelker committed
610
	}
611
#endif /* 0 */
Geoff Voelker's avatar
Geoff Voelker committed
612 613
    }

614
  unblock_input ();
Geoff Voelker's avatar
Geoff Voelker committed
615 616
}

617
/* Draw a vertical window border from (x,y0) to (x,y1)  */
618

619
static void
620
w32_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
Geoff Voelker's avatar
Geoff Voelker committed
621
{
622
  struct frame *f = XFRAME (WINDOW_FRAME (w));
623 624
  RECT r;
  HDC hdc;
625
  struct face *face;
626

627 628 629 630
  r.left = x;
  r.right = x + 1;
  r.top = y0;
  r.bottom = y1;
631

632
  hdc = get_frame_dc (f);
633
  face = FACE_FROM_ID_OR_NULL (f, VERTICAL_BORDER_FACE_ID);
634 635 636 637 638
  if (face)
    w32_fill_rect (f, hdc, face->foreground, &r);
  else
    w32_fill_rect (f, hdc, FRAME_FOREGROUND_PIXEL (f), &r);

639
  release_frame_dc (f, hdc);
640
}
Geoff Voelker's avatar
Geoff Voelker committed
641

642

643 644 645 646 647 648
/* 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));
649
  HDC hdc = get_frame_dc (f);
650
  struct face *face = FACE_FROM_ID_OR_NULL (f, WINDOW_DIVIDER_FACE_ID);
651
  struct face *face_first
652
    = FACE_FROM_ID_OR_NULL (f, WINDOW_DIVIDER_FIRST_PIXEL_FACE_ID);
653
  struct face *face_last
654
    = FACE_FROM_ID_OR_NULL (f, WINDOW_DIVIDER_LAST_PIXEL_FACE_ID);
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
  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);
    }
677
  else
678
    w32_fill_area_abs (f, hdc, color, x0, y0, x1, y1);
679 680 681 682

  release_frame_dc (f, hdc);
}

683
/* End update of window W.
684 685 686 687 688 689 690 691 692 693 694

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

static void
697 698
x_update_window_end (struct window *w, bool cursor_on_p,
		     bool mouse_face_overwritten_p)
699 700 701
{
  if (!w->pseudo_window_p)
    {
702
      block_input ();
703

704
      if (cursor_on_p)
705
	display_and_set_cursor (w, true,
706 707
				w->output_cursor.hpos, w->output_cursor.vpos,
				w->output_cursor.x, w->output_cursor.y);
708

709
      if (draw_window_fringes (w, true))
710 711 712 713 714 715
	{
	  if (WINDOW_RIGHT_DIVIDER_WIDTH (w))
	    x_draw_right_divider (w);
	  else
	    x_draw_vertical_border (w);
	}
Kenichi Handa's avatar
Kenichi Handa committed
716

717
      unblock_input ();
718
    }
719 720 721 722

  /* If a row with mouse-face was overwritten, arrange for
     XTframe_up_to_date to redisplay the mouse highlight.  */
  if (mouse_face_overwritten_p)
723 724 725 726 727 728 729
    {
      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;
    }
730

731 732 733
  /* 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.  */
734 735
  if (w32_use_visible_system_caret && w32_system_caret_hwnd)
    {
736 737
      SendMessageTimeout (w32_system_caret_hwnd, WM_EMACS_SHOW_CARET, 0, 0,
			  0, 6000, NULL);
738
    }
739 740
}

741 742 743 744

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

745
static void
746
x_update_end (struct frame *f)
747
{
Andrew Innes's avatar
Andrew Innes committed
748 749 750
  if (! FRAME_W32_P (f))
    return;

751
  /* Mouse highlight may be displayed again.  */
752
  MOUSE_HL_INFO (f)->mouse_face_defer = false;
Geoff Voelker's avatar
Geoff Voelker committed
753 754
}

755

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

759
static void
760
w32_frame_up_to_date (struct frame *f)
Geoff Voelker's avatar
Geoff Voelker committed
761
{
762
  if (FRAME_W32_P (f))
763
    FRAME_MOUSE_UPDATE (f);
Geoff Voelker's avatar
Geoff Voelker committed
764
}
765 766 767


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
768
   arrow bitmaps, or clear the fringes if no bitmaps are required
769
   before DESIRED_ROW is made current.  This function is called from
770 771 772 773
   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
774
x_after_update_window_line (struct window *w, struct glyph_row *desired_row)
775
{
776 777 778
  struct frame *f;
  int width, height;

779
  eassert (w);
780

781
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
782
    desired_row->redraw_fringe_bitmaps_p = true;
783

784 785
  /* When a window has disappeared, make sure that no rest of
     full-width rows stays visible in the internal border.  Could
786
     check here if updated window is the leftmost/rightmost window,
787 788 789 790 791
     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
792
      && (f = XFRAME (w->frame),
793 794 795 796 797 798
	  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));
799

800
      block_input ();
801 802
      {
	HDC hdc = get_frame_dc (f);
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819
	struct face *face = FACE_FROM_ID_OR_NULL (f, INTERNAL_BORDER_FACE_ID);

	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);
	  }
820 821
	release_frame_dc (f, hdc);
      }
822
      unblock_input ();
823 824 825 826
    }
}


Kim F. Storm's avatar
Kim F. Storm committed
827
/* Draw the bitmap WHICH in one of the left or right fringes of
828 829 830 831 832
   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
833 834
w32_draw_fringe_bitmap (struct window *w, struct glyph_row *row,
			struct draw_fringe_bitmap_params *p)
835 836
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
Kim F. Storm's avatar
Kim F. Storm committed
837 838 839 840
  HDC hdc;
  struct face *face = p->face;

  hdc = get_frame_dc (f);
841 842

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

845 846 847 848
  if (p->bx >= 0 && !p->overlay_p)
    w32_fill_area (f, hdc, face->background,
		   p->bx, p->by, p->nx, p->ny);

849
  if (p->which && p->which < max_fringe_bmp)
Kim F. Storm's avatar
Kim F. Storm committed
850 851 852 853
    {
      HBITMAP pixmap = fringe_bmp[p->which];
      HDC compat_hdc;
      HANDLE horig_obj;
854

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

Kim F. Storm's avatar
Kim F. Storm committed
857
      SaveDC (hdc);
858

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

Kenichi Handa's avatar
Kenichi Handa committed
861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
      /* 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);
	}
895

Kim F. Storm's avatar
Kim F. Storm committed
896 897 898
      SelectObject (compat_hdc, horig_obj);
      DeleteDC (compat_hdc);
      RestoreDC (hdc, -1);
899
    }
900

Kim F. Storm's avatar
Kim F. Storm committed
901
  w32_set_clip_rectangle (hdc, NULL);
902 903 904 905

  release_frame_dc (f, hdc);
}

Kenichi Handa's avatar
Kenichi Handa committed
906
static void
907
w32_define_fringe_bitmap (int which, unsigned short *bits, int h, int wd)
Kenichi Handa's avatar
Kenichi Handa committed
908
{
909 910 911 912 913 914 915 916 917
  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
918 919 920 921
  fringe_bmp[which] = CreateBitmap (wd, h, 1, 1, bits);
}

static void
922
w32_destroy_fringe_bitmap (int which)
Kenichi Handa's avatar
Kenichi Handa committed
923
{
924 925 926
  if (which >= max_fringe_bmp)
    return;

Kenichi Handa's avatar
Kenichi Handa committed
927 928 929 930 931
  if (fringe_bmp[which])
    DeleteObject (fringe_bmp[which]);
  fringe_bmp[which] = 0;
}

932 933 934 935 936 937
/***********************************************************************
			   Display Iterator
 ***********************************************************************/

/* Function prototypes of this page.  */

938 939 940
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 *,
941
                                            bool);
942 943 944 945 946 947 948
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 *);
949
static int w32_alloc_lighter_color (struct frame *, COLORREF *, double, int);
950 951 952 953 954 955 956 957 958 959 960 961 962
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,
963
                               int, bool, bool, RECT *);
964

965

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

static void
970
x_set_cursor_gc (struct glyph_string *s)
971 972 973 974
{
  if (s->font == FRAME_FONT (s->f)
      && s->face->background == FRAME_BACKGROUND_PIXEL (s->f)
      && s->face->foreground == FRAME_FOREGROUND_PIXEL (s->f)
975 976 977 978
      /* 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
979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
      && !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;

1010 1011
      if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
	XChangeGC (NULL, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1012 1013
		   mask, &xgcv);
      else
1014
	FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
Eli Zaretskii's avatar
Eli Zaretskii committed
1015
	  = XCreateGC (NULL, FRAME_W32_WINDOW (s->f), mask, &xgcv);
1016

1017
      s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1018 1019 1020 1021 1022
    }
}


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

1024
static void
1025
x_set_mouse_face_gc (struct glyph_string *s)
1026
{
1027
  int face_id;
1028
  struct face *face;
1029

1030
  /* What face has to be used last for the mouse face?  */
1031
  face_id = MOUSE_HL_INFO (s->f)->mouse_face_face_id;
1032
  face = FACE_FROM_ID_OR_NULL (s->f, face_id);
1033 1034
  if (face == NULL)
    face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
1035

1036
  if (s->first_glyph->type == CHAR_GLYPH)
1037
    face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1038
  else
1039
    face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1040
  s->face = FACE_FROM_ID (s->f, face_id);
1041
  prepare_face_for_display (s->f, s->face);
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051

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

1053 1054 1055 1056 1057
      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;
1058

1059 1060
      if (FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc)
	XChangeGC (NULL, FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc,
1061 1062
		   mask, &xgcv);
      else
1063
	FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc
Eli Zaretskii's avatar
Eli Zaretskii committed
1064
	  = XCreateGC (NULL, FRAME_W32_WINDOW (s->f), mask, &xgcv);
1065

1066
      s->gc = FRAME_DISPLAY_INFO (s->f)->scratch_cursor_gc;
1067 1068
    }

1069
  eassert (s->gc != 0);
1070 1071 1072 1073 1074 1075 1076
}


/* 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
1077
static inline void
1078
x_set_mode_line_face_gc (struct glyph_string *s)
1079
{
1080 1081 1082 1083 1084 1085 1086 1087
  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
1088
static inline void
1089
x_set_glyph_string_gc (struct glyph_string *s)
1090
{
1091
  prepare_face_for_display (s->f, s->face);
1092

1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
  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);
1106
      s->stippled_p = false;
1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
    }
  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
1120
    emacs_abort ();
1121 1122

  /* GC must have been set.  */
1123
  eassert (s->gc != 0);
1124 1125 1126 1127 1128 1129
}


/* 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
1130
static inline void
1131
x_set_glyph_string_clipping (struct glyph_string *s)
1132
{
1133 1134 1135 1136 1137 1138 1139
  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)
    {
1140 1141 1142 1143
      HRGN clip1 = CreateRectRgnIndirect (r);
      HRGN clip2 = CreateRectRgnIndirect (r + 1);
      if (CombineRgn (clip1, clip1, clip2, RGN_OR) != ERROR)
        SelectClipRgn (s->hdc, clip1);
1144 1145 1146 1147
      DeleteObject (clip1);
      DeleteObject (clip2);
    }
    s->num_clips = n;
1148 1149
}

Jason Rumney's avatar
Jason Rumney committed
1150 1151 1152 1153 1154
/* 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
1155 1156
x_set_glyph_string_clipping_exactly (struct glyph_string *src,
				     struct glyph_string *dst)
Jason Rumney's avatar
Jason Rumney committed
1157 1158 1159
{
  RECT r;

1160 1161 1162 1163 1164 1165
  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
1166 1167
  w32_set_clip_rectangle (dst->hdc, &r);
}
1168

1169
/* RIF:
1170
   Compute left and right overhang of glyph string S.  */