w32term.c 177 KB
Newer Older
1
/* Implementation of GUI terminal on the Microsoft W32 API.
2
   Copyright (C) 1989, 93, 94, 95, 96, 1997, 1998, 1999, 2000, 2001
3
   Free Software Foundation, Inc.
Geoff Voelker's avatar
Geoff Voelker committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.

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 19
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Karl Heuer's avatar
Karl Heuer committed
20
Boston, MA 02111-1307, USA.  */
Geoff Voelker's avatar
Geoff Voelker committed
21 22

#include <config.h>
23
#include <signal.h>
Geoff Voelker's avatar
Geoff Voelker committed
24
#include <stdio.h>
25
#include <stdlib.h>
Geoff Voelker's avatar
Geoff Voelker committed
26
#include "lisp.h"
Geoff Voelker's avatar
Geoff Voelker committed
27
#include "charset.h"
Geoff Voelker's avatar
Geoff Voelker committed
28 29
#include "blockinput.h"

Andrew Innes's avatar
Andrew Innes committed
30
#include "w32heap.h"
31
#include "w32term.h"
32
#include "w32bdf.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
33
#include <shellapi.h>
Geoff Voelker's avatar
Geoff Voelker committed
34 35 36

#include "systty.h"
#include "systime.h"
37
#include "atimer.h"
Stefan Monnier's avatar
Stefan Monnier committed
38
#include "keymap.h"
Geoff Voelker's avatar
Geoff Voelker committed
39 40 41 42 43 44

#include <ctype.h>
#include <errno.h>
#include <setjmp.h>
#include <sys/stat.h>

45
#include "keyboard.h"
Geoff Voelker's avatar
Geoff Voelker committed
46 47
#include "frame.h"
#include "dispextern.h"
48
#include "fontset.h"
Geoff Voelker's avatar
Geoff Voelker committed
49 50 51 52 53 54 55 56
#include "termhooks.h"
#include "termopts.h"
#include "termchar.h"
#include "gnu.h"
#include "disptab.h"
#include "buffer.h"
#include "window.h"
#include "intervals.h"
57
#include "composite.h"
58
#include "coding.h"
Geoff Voelker's avatar
Geoff Voelker committed
59

60 61 62
#define abs(x)	((x) < 0 ? -(x) : (x))


Kim F. Storm's avatar
Kim F. Storm committed
63
/* Fringe bitmaps.  */
64

Kim F. Storm's avatar
Kim F. Storm committed
65
static HBITMAP fringe_bmp[MAX_FRINGE_BITMAPS];
66

67
/* Non-nil means Emacs uses toolkit scroll bars.  */
68

69
Lisp_Object Vx_toolkit_scroll_bars;
70

71
/* Temporary variables for w32_read_socket.  */
72

73 74
static int last_mousemove_x = 0;
static int last_mousemove_y = 0;
75 76 77 78 79 80

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

static int any_help_event_p;

81 82 83
/* Last window where we saw the mouse.  Used by mouse-autoselect-window.  */
static Lisp_Object last_window;

Geoff Voelker's avatar
Geoff Voelker committed
84 85
extern unsigned int msh_mousewheel;

Geoff Voelker's avatar
Geoff Voelker committed
86 87
extern void free_frame_menubar ();

88
extern int w32_codepage_for_font (char *fontname);
89
extern Cursor w32_load_cursor (LPCTSTR name);
90

91 92
extern glyph_metric *w32_BDF_TextMetric(bdffont *fontp,
					unsigned char *text, int dim);
Geoff Voelker's avatar
Geoff Voelker committed
93 94
extern Lisp_Object Vwindow_system;

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

/* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
104
   one for each element of w32_display_list and in the same order.
Geoff Voelker's avatar
Geoff Voelker committed
105 106
   NAME is the name of the frame.
   FONT-LIST-CACHE records previous values returned by x-list-fonts.  */
107
Lisp_Object w32_display_name_list;
Geoff Voelker's avatar
Geoff Voelker committed
108 109 110

/* Frame being updated by update_frame.  This is declared in term.c.
   This is set by update_begin and looked at by all the
111
   w32 functions.  It is zero while not inside an update.
112
   In that case, the w32 functions assume that `SELECTED_FRAME ()'
Geoff Voelker's avatar
Geoff Voelker committed
113 114 115 116 117 118
   is the frame to apply to.  */
extern struct frame *updating_frame;

/* This is a frame waiting to be autoraised, within w32_read_socket.  */
struct frame *pending_autoraise_frame;

119 120 121 122 123
/* 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;
124
int w32_use_visible_system_caret;
125

126
/* Flag to enable Unicode output in case users wish to use programs
127 128
   like Twinbridge on '95 rather than installed system level support
   for Far East languages.  */
129
int w32_enable_unicode_output;
130

131 132
DWORD dwWindowsThreadId = 0;
HANDLE hWindowsThread = NULL;
Geoff Voelker's avatar
Geoff Voelker committed
133 134 135
DWORD dwMainThreadId = 0;
HANDLE hMainThread = NULL;

136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
#ifndef SIF_ALL
/* These definitions are new with Windows 95. */
#define SIF_RANGE           0x0001
#define SIF_PAGE            0x0002
#define SIF_POS             0x0004
#define SIF_DISABLENOSCROLL 0x0008
#define SIF_TRACKPOS        0x0010
#define SIF_ALL             (SIF_RANGE | SIF_PAGE | SIF_POS | SIF_TRACKPOS)

typedef struct tagSCROLLINFO
{
    UINT    cbSize;
    UINT    fMask;
    int     nMin;
    int     nMax;
    UINT    nPage;
    int     nPos;
    int     nTrackPos;
}   SCROLLINFO, FAR *LPSCROLLINFO;
typedef SCROLLINFO CONST FAR *LPCSCROLLINFO;
#endif /* SIF_ALL */

/* Dynamic linking to new proportional scroll bar functions. */
int (PASCAL *pfnSetScrollInfo) (HWND hwnd, int fnBar, LPSCROLLINFO lpsi, BOOL fRedraw);
BOOL (PASCAL *pfnGetScrollInfo) (HWND hwnd, int fnBar, LPSCROLLINFO lpsi);

int vertical_scroll_bar_min_handle;
int vertical_scroll_bar_top_border;
int vertical_scroll_bar_bottom_border;

int last_scroll_bar_drag_pos;

Geoff Voelker's avatar
Geoff Voelker committed
168 169 170
/* Mouse movement. */

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

Geoff Voelker's avatar
Geoff Voelker committed
172
static RECT last_mouse_glyph;
173
static Lisp_Object last_mouse_press_frame;
Geoff Voelker's avatar
Geoff Voelker committed
174

175
Lisp_Object Vw32_num_mouse_buttons;
Geoff Voelker's avatar
Geoff Voelker committed
176

177
Lisp_Object Vw32_swap_mouse_buttons;
Geoff Voelker's avatar
Geoff Voelker committed
178

179 180 181 182 183 184
/* Control whether x_raise_frame also sets input focus.  */
Lisp_Object Vw32_grab_focus_on_raise;

/* Control whether Caps Lock affects non-ascii characters.  */
Lisp_Object Vw32_capslock_is_shiftlock;

185 186 187
/* Control whether right-alt and left-ctrl should be recognized as AltGr.  */
Lisp_Object Vw32_recognize_altgr;

Geoff Voelker's avatar
Geoff Voelker committed
188 189 190
/* The scroll bar in which the last motion event occurred.

   If the last motion event occurred in a scroll bar, we set this
191
   so w32_mouse_position can know whether to report a scroll bar motion or
Geoff Voelker's avatar
Geoff Voelker committed
192 193 194
   an ordinary motion.

   If the last motion event didn't occur in a scroll bar, we set this
195
   to Qnil, to tell w32_mouse_position to return an ordinary motion event.  */
196 197
static Lisp_Object last_mouse_scroll_bar;
static int last_mouse_scroll_bar_pos;
Geoff Voelker's avatar
Geoff Voelker committed
198

199
/* This is a hack.  We would really prefer that w32_mouse_position would
Geoff Voelker's avatar
Geoff Voelker committed
200
   return the time associated with the position it returns, but there
201
   doesn't seem to be any way to wrest the time-stamp from the server
Geoff Voelker's avatar
Geoff Voelker committed
202 203 204 205
   along with the position query.  So, we just keep track of the time
   of the last movement we received, and return that in hopes that
   it's somewhat accurate.  */

206 207 208 209
static Time last_mouse_movement_time;

/* Incremented by w32_read_socket whenever it really tries to read
   events.  */
210

Geoff Voelker's avatar
Geoff Voelker committed
211 212 213 214 215 216 217 218 219 220
#ifdef __STDC__
static int volatile input_signal_count;
#else
static int input_signal_count;
#endif

extern Lisp_Object Vcommand_line_args, Vsystem_name;

extern Lisp_Object Qface, Qmouse_face;

221
#ifndef USE_CRT_DLL
Geoff Voelker's avatar
Geoff Voelker committed
222
extern int errno;
223
#endif
Geoff Voelker's avatar
Geoff Voelker committed
224 225

/* A mask of extra modifier bits to put into every keyboard char.  */
226

227
extern EMACS_INT extra_keyboard_modifiers;
Geoff Voelker's avatar
Geoff Voelker committed
228

229
static void x_update_window_end P_ ((struct window *, int, int));
230 231 232
void w32_delete_display P_ ((struct w32_display_info *));
static void w32_handle_tool_bar_click P_ ((struct frame *,
                                          struct input_event *));
233
void w32_define_cursor P_ ((Window, Cursor));
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251

void x_lower_frame P_ ((struct frame *));
void x_scroll_bar_clear P_ ((struct frame *));
void x_wm_set_size_hint P_ ((struct frame *, long, int));
void x_raise_frame P_ ((struct frame *));
void x_set_window_size P_ ((struct frame *, int, int, int));
void x_wm_set_window_state P_ ((struct frame *, int));
void x_wm_set_icon_pixmap P_ ((struct frame *, int));
void w32_initialize P_ ((void));
static void x_font_min_bounds P_ ((XFontStruct *, int *, int *));
int x_compute_min_glyph_bounds P_ ((struct frame *));
static void x_update_end P_ ((struct frame *));
static void w32_frame_up_to_date P_ ((struct frame *));
static void w32_set_terminal_modes P_ ((void));
static void w32_reset_terminal_modes P_ ((void));
static void x_clear_frame P_ ((void));
static void frame_highlight P_ ((struct frame *));
static void frame_unhighlight P_ ((struct frame *));
252 253
static void x_new_focus_frame P_ ((struct w32_display_info *,
				   struct frame *));
254 255 256
static void w32_frame_rehighlight P_ ((struct frame *));
static void x_frame_rehighlight P_ ((struct w32_display_info *));
static void x_draw_hollow_cursor P_ ((struct window *, struct glyph_row *));
257 258
static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int,
				   enum text_cursor_kinds));
259
static void w32_clip_to_row P_ ((struct window *, struct glyph_row *, HDC));
260

Geoff Voelker's avatar
Geoff Voelker committed
261 262 263
static Lisp_Object Qvendor_specific_keysyms;


264 265 266 267
/***********************************************************************
			      Debugging
 ***********************************************************************/

Geoff Voelker's avatar
Geoff Voelker committed
268
#if 0
269 270 271

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

273
struct record
Geoff Voelker's avatar
Geoff Voelker committed
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
{
  char *locus;
  int type;
};

struct record event_record[100];

int event_record_index;

record_event (locus, type)
     char *locus;
     int type;
{
  if (event_record_index == sizeof (event_record) / sizeof (struct record))
    event_record_index = 0;

  event_record[event_record_index].locus = locus;
  event_record[event_record_index].type = type;
  event_record_index++;
}

#endif /* 0 */

297

298 299 300
void
XChangeGC (void * ignore, XGCValues* gc, unsigned long mask,
	   XGCValues *xgcv)
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
{
  if (mask & GCForeground)
    gc->foreground = xgcv->foreground;
  if (mask & GCBackground)
    gc->background = xgcv->background;
  if (mask & GCFont)
    gc->font = xgcv->font;
}

XGCValues *XCreateGC (void * ignore, Window window, unsigned long mask,
                      XGCValues *xgcv)
{
  XGCValues *gc = (XGCValues *) xmalloc (sizeof (XGCValues));
  bzero (gc, sizeof (XGCValues));

  XChangeGC (ignore, gc, mask, xgcv);

  return gc;
}

321 322
void
XGetGCValues (void* ignore, XGCValues *gc,
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
                   unsigned long mask, XGCValues *xgcv)
{
  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);
}


/* 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. */
364
void
365
w32_fill_rect (f, hdc, pix, lprect)
Geoff Voelker's avatar
Geoff Voelker committed
366
     FRAME_PTR f;
367
     HDC hdc;
Geoff Voelker's avatar
Geoff Voelker committed
368 369 370 371
     COLORREF pix;
     RECT * lprect;
{
  HBRUSH hb;
372

Geoff Voelker's avatar
Geoff Voelker committed
373 374 375 376 377
  hb = CreateSolidBrush (pix);
  FillRect (hdc, lprect, hb);
  DeleteObject (hb);
}

378
void
379
w32_clear_window (f)
Geoff Voelker's avatar
Geoff Voelker committed
380 381 382
     FRAME_PTR f;
{
  RECT rect;
383
  HDC hdc = get_frame_dc (f);
Geoff Voelker's avatar
Geoff Voelker committed
384

385 386 387 388 389 390 391 392 393
  /* 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);
    }

394
  release_frame_dc (f, hdc);
Geoff Voelker's avatar
Geoff Voelker committed
395 396 397
}


398 399 400
/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
401

402 403 404
/* 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
405
   each window being updated.  */
Geoff Voelker's avatar
Geoff Voelker committed
406

407
static void
408
x_update_begin (f)
Geoff Voelker's avatar
Geoff Voelker committed
409 410
     struct frame *f;
{
411 412
  struct w32_display_info *display_info = FRAME_W32_DISPLAY_INFO (f);

Andrew Innes's avatar
Andrew Innes committed
413 414 415
  if (! FRAME_W32_P (f))
    return;

416 417 418 419 420 421 422
  /* 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;
  }
423
}
Geoff Voelker's avatar
Geoff Voelker committed
424

425 426 427 428 429 430 431 432 433 434 435 436

/* Start update of window W.  Set the global variable updated_window
   to the window being updated and set output_cursor to the cursor
   position of W.  */

static void
x_update_window_begin (w)
     struct window *w;
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  struct w32_display_info *display_info = FRAME_W32_DISPLAY_INFO (f);

437
  /* Hide the system caret during an update.  */
438 439 440 441
  if (w32_use_visible_system_caret && w32_system_caret_hwnd)
    {
      SendMessage (w32_system_caret_hwnd, WM_EMACS_HIDE_CARET, 0, 0);
    }
442

443 444
  updated_window = w;
  set_output_cursor (&w->cursor);
Geoff Voelker's avatar
Geoff Voelker committed
445 446 447

  BLOCK_INPUT;

448
  if (f == display_info->mouse_face_mouse_frame)
Geoff Voelker's avatar
Geoff Voelker committed
449 450
    {
      /* Don't do highlighting for mouse motion during the update.  */
451
      display_info->mouse_face_defer = 1;
Geoff Voelker's avatar
Geoff Voelker committed
452

453 454
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
Geoff Voelker's avatar
Geoff Voelker committed
455
      if (FRAME_GARBAGED_P (f))
456 457
	display_info->mouse_face_window = Qnil;

458 459 460 461 462 463
#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.  */
464

465 466 467 468 469 470 471
      /* 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.  */
      if (!NILP (display_info->mouse_face_window)
	  && w == XWINDOW (display_info->mouse_face_window))
Geoff Voelker's avatar
Geoff Voelker committed
472
	{
473
	  int i;
Geoff Voelker's avatar
Geoff Voelker committed
474

475 476
          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
477 478
	      break;

479 480
	  if (i < w->desired_matrix->nrows)
	    clear_mouse_face (display_info);
Geoff Voelker's avatar
Geoff Voelker committed
481
	}
482
#endif /* 0 */
Geoff Voelker's avatar
Geoff Voelker committed
483 484 485 486 487
    }

  UNBLOCK_INPUT;
}

488
/* Draw a vertical window border from (x,y0) to (x,y1)  */
489

490
static void
491
w32_draw_vertical_window_border (w, x, y0, y1)
492
     struct window *w;
493
     int x, y0, y1;
Geoff Voelker's avatar
Geoff Voelker committed
494
{
495
  struct frame *f = XFRAME (WINDOW_FRAME (w));
496 497 498 499 500 501 502
  RECT r;
  HDC hdc;
  
  r.left = x;
  r.right = x + 1;
  r.top = y0;
  r.bottom = y1;
503

504 505 506
  hdc = get_frame_dc (f);
  w32_fill_rect (f, hdc, FRAME_FOREGROUND_PIXEL (f), &r);
  release_frame_dc (f, hdc);
507
}
Geoff Voelker's avatar
Geoff Voelker committed
508

509

510 511 512 513 514 515 516 517 518 519 520 521
/* End update of window W (which is equal to updated_window).

   Draw vertical borders between horizontally adjacent windows, and
   display W's cursor if CURSOR_ON_P is non-zero.

   MOUSE_FACE_OVERWRITTEN_P non-zero means that some row containing
   glyphs in mouse-face were overwritten.  In that case we have to
   make sure that the mouse-highlight is properly redrawn.

   W may be a menu bar pseudo-window in case we don't have X toolkit
   support. Such windows don't have a cursor, so don't display it
   here. */
522 523

static void
524
x_update_window_end (w, cursor_on_p, mouse_face_overwritten_p)
525
     struct window *w;
526
     int cursor_on_p, mouse_face_overwritten_p;
527
{
528
  struct w32_display_info *dpyinfo = FRAME_W32_DISPLAY_INFO (XFRAME (w->frame));
529

530 531 532
  if (!w->pseudo_window_p)
    {
      BLOCK_INPUT;
533

534
      if (cursor_on_p)
535 536 537
	display_and_set_cursor (w, 1, output_cursor.hpos,
				output_cursor.vpos,
				output_cursor.x, output_cursor.y);
538

539 540 541
      x_draw_vertical_border (w);
      UNBLOCK_INPUT;
    }
542 543 544 545 546 547 548 549 550 551

  /* If a row with mouse-face was overwritten, arrange for
     XTframe_up_to_date to redisplay the mouse highlight.  */
  if (mouse_face_overwritten_p)
    {
      dpyinfo->mouse_face_beg_row = dpyinfo->mouse_face_beg_col = -1;
      dpyinfo->mouse_face_end_row = dpyinfo->mouse_face_end_col = -1;
      dpyinfo->mouse_face_window = Qnil;
    }

552 553 554
  /* 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.  */
555 556 557 558
  if (w32_use_visible_system_caret && w32_system_caret_hwnd)
    {
      SendMessage (w32_system_caret_hwnd, WM_EMACS_SHOW_CARET, 0, 0);
    }
559

560 561 562
  updated_window = NULL;
}

563 564 565 566

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

567 568 569 570
static void
x_update_end (f)
     struct frame *f;
{
Andrew Innes's avatar
Andrew Innes committed
571 572 573
  if (! FRAME_W32_P (f))
    return;

574 575
  /* Mouse highlight may be displayed again.  */
  FRAME_W32_DISPLAY_INFO (f)->mouse_face_defer = 0;
Geoff Voelker's avatar
Geoff Voelker committed
576 577
}

578

579 580 581
/* This function is called from various places in xdisp.c whenever a
   complete update has been performed.  The global variable
   updated_window is not available here.  */
Geoff Voelker's avatar
Geoff Voelker committed
582

583
static void
584
w32_frame_up_to_date (f)
585
     struct frame *f;
Geoff Voelker's avatar
Geoff Voelker committed
586
{
587
  if (FRAME_W32_P (f))
Geoff Voelker's avatar
Geoff Voelker committed
588
    {
589
      struct w32_display_info *dpyinfo = FRAME_W32_DISPLAY_INFO (f);
590

591 592 593 594 595 596 597 598 599 600 601
      if (dpyinfo->mouse_face_deferred_gc
	  || f == dpyinfo->mouse_face_mouse_frame)
	{
	  BLOCK_INPUT;
	  if (dpyinfo->mouse_face_mouse_frame)
	    note_mouse_highlight (dpyinfo->mouse_face_mouse_frame,
				  dpyinfo->mouse_face_mouse_x,
				  dpyinfo->mouse_face_mouse_y);
	  dpyinfo->mouse_face_deferred_gc = 0;
	  UNBLOCK_INPUT;
	}
Geoff Voelker's avatar
Geoff Voelker committed
602 603
    }
}
604 605 606


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
607
   arrow bitmaps, or clear the fringes if no bitmaps are required
608
   before DESIRED_ROW is made current.  The window being updated is
609
   found in updated_window.  This function is called from
610 611 612 613 614 615 616 617
   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
x_after_update_window_line (desired_row)
     struct glyph_row *desired_row;
{
  struct window *w = updated_window;
618 619 620
  struct frame *f;
  int width, height;

621
  xassert (w);
622

623 624 625
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
    {
      BLOCK_INPUT;
Kim F. Storm's avatar
Kim F. Storm committed
626
      draw_row_fringe_bitmaps (w, desired_row);
627 628
      UNBLOCK_INPUT;
    }
629

630 631 632 633 634 635 636 637 638 639 640 641 642 643 644
  /* When a window has disappeared, make sure that no rest of
     full-width rows stays visible in the internal border.  Could
     check here if updated_window is the leftmost/rightmost window,
     but I guess it's not worth doing since vertically split windows
     are almost never used, internal border is rarely set, and the
     overhead is very small.  */
  if (windows_or_buffers_changed
      && desired_row->full_width_p
      && (f = XFRAME (w->frame),
	  width = FRAME_INTERNAL_BORDER_WIDTH (f),
	  width != 0)
      && (height = desired_row->visible_height,
	  height > 0))
    {
      int y = WINDOW_TO_FRAME_PIXEL_Y (w, max (0, desired_row->y));
645

646 647 648 649 650 651 652 653 654
      /* Internal border is drawn below the tool bar.  */
      if (WINDOWP (f->tool_bar_window)
	  && w == XWINDOW (f->tool_bar_window))
	y -= width;

      BLOCK_INPUT;
      {
	HDC hdc = get_frame_dc (f);
	w32_clear_area (f, hdc, 0, y, width, height);
655
	w32_clear_area (f, hdc, FRAME_PIXEL_WIDTH (f) - width,
656 657 658
			y, width, height);
	release_frame_dc (f, hdc);
      }
659 660 661 662 663
      UNBLOCK_INPUT;
    }
}


Kim F. Storm's avatar
Kim F. Storm committed
664
/* Draw the bitmap WHICH in one of the left or right fringes of
665 666 667 668 669
   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
Kim F. Storm's avatar
Kim F. Storm committed
670
w32_draw_fringe_bitmap (w, row, p)
671 672
     struct window *w;
     struct glyph_row *row;
Kim F. Storm's avatar
Kim F. Storm committed
673
     struct draw_fringe_bitmap_params *p;
674 675
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
Kim F. Storm's avatar
Kim F. Storm committed
676 677 678 679
  HDC hdc;
  struct face *face = p->face;

  hdc = get_frame_dc (f);
680 681

  /* Must clip because of partially visible lines.  */
682
  w32_clip_to_row (w, row, hdc);
683

Kim F. Storm's avatar
Kim F. Storm committed
684
  if (p->bx >= 0)
685
    {
686
      w32_fill_area (f, hdc, face->background,
Kim F. Storm's avatar
Kim F. Storm committed
687
		     p->bx, p->by, p->nx, p->ny);
688 689
    }

Kim F. Storm's avatar
Kim F. Storm committed
690 691 692 693 694
  if (p->which != NO_FRINGE_BITMAP)
    {
      HBITMAP pixmap = fringe_bmp[p->which];
      HDC compat_hdc;
      HANDLE horig_obj;
695

Kim F. Storm's avatar
Kim F. Storm committed
696 697
      compat_hdc = CreateCompatibleDC (hdc);
      SaveDC (hdc);
698

Kim F. Storm's avatar
Kim F. Storm committed
699 700 701
      horig_obj = SelectObject (compat_hdc, pixmap);
      SetTextColor (hdc, face->background);
      SetBkColor (hdc, face->foreground);
702

Kim F. Storm's avatar
Kim F. Storm committed
703 704 705
      BitBlt (hdc, p->x, p->y, p->wd, p->h,
	      compat_hdc, 0, p->dh,
	      SRCCOPY);
706

Kim F. Storm's avatar
Kim F. Storm committed
707 708 709
      SelectObject (compat_hdc, horig_obj);
      DeleteDC (compat_hdc);
      RestoreDC (hdc, -1);
710
    }
711

Kim F. Storm's avatar
Kim F. Storm committed
712
  w32_set_clip_rectangle (hdc, NULL);
713 714 715 716

  release_frame_dc (f, hdc);
}

Geoff Voelker's avatar
Geoff Voelker committed
717

718 719 720 721
/* This is called when starting Emacs and when restarting after
   suspend.  When starting Emacs, no window is mapped.  And nothing
   must be done to Emacs's own window if it is suspended (though that
   rarely happens).  */
Geoff Voelker's avatar
Geoff Voelker committed
722

723 724
static void
w32_set_terminal_modes (void)
Geoff Voelker's avatar
Geoff Voelker committed
725 726 727
{
}

728 729
/* This is called when exiting or suspending Emacs. Exiting will make
   the W32 windows go away, and suspending requires no action. */
Geoff Voelker's avatar
Geoff Voelker committed
730

731 732
static void
w32_reset_terminal_modes (void)
Geoff Voelker's avatar
Geoff Voelker committed
733 734
{
}
735

736

737

738 739 740 741 742 743
/***********************************************************************
			   Display Iterator
 ***********************************************************************/

/* Function prototypes of this page.  */

744
static XCharStruct *w32_per_char_metric P_ ((XFontStruct *,
745 746
                                             wchar_t *, int));
static int w32_encode_char P_ ((int, wchar_t *, struct font_info *, int *));
747

748 749 750

/* Get metrics of character CHAR2B in FONT.  Value is always non-null.
   If CHAR2B is not contained in FONT, the font's default character
751
   metric is returned. */
752

753 754
static int
w32_bdf_per_char_metric (font, char2b, dim, pcm)
755 756 757
     XFontStruct *font;
     wchar_t *char2b;
     int dim;
758
     XCharStruct * pcm;
759 760 761 762 763
{
  glyph_metric * bdf_metric;
  char buf[2];

  if (dim == 1)
764
    buf[0] = (char)(*char2b);
765 766
  else
    {
767 768
      buf[0] = XCHAR2B_BYTE1 (char2b);
      buf[1] = XCHAR2B_BYTE2 (char2b);
769 770 771 772 773 774 775 776 777 778 779
    }

  bdf_metric = w32_BDF_TextMetric (font->bdf, buf, dim);

  if (bdf_metric)
    {
      pcm->width = bdf_metric->dwidth;
      pcm->lbearing = bdf_metric->bbox;
      pcm->rbearing = bdf_metric->dwidth
                    - (bdf_metric->bbox + bdf_metric->bbw);
      pcm->ascent = bdf_metric->bboy + bdf_metric->bbh;
780
      pcm->descent = -bdf_metric->bboy;
781 782

      return 1;
783
    }
784
  return 0;
785 786 787
}


788 789
static int
w32_native_per_char_metric (font, char2b, font_type, pcm)
790 791
     XFontStruct *font;
     wchar_t *char2b;
792
     enum w32_char_font_type font_type;
793
     XCharStruct * pcm;
794
{
795 796 797
  HDC hdc = GetDC (NULL);
  HFONT old_font;
  BOOL retval = FALSE;
798

799
  xassert (font && char2b);
800 801
  xassert (font->hfont);
  xassert (font_type == UNICODE_FONT || font_type == ANSI_FONT);
802

803
  old_font = SelectObject (hdc, font->hfont);
804

805
  if ((font->tm.tmPitchAndFamily & TMPF_TRUETYPE) != 0)
806
    {
807 808 809 810
      ABC char_widths;

      if (font_type == UNICODE_FONT)
	retval = GetCharABCWidthsW (hdc, *char2b, *char2b, &char_widths);
811
      else
812 813 814 815
	retval = GetCharABCWidthsA (hdc, *char2b, *char2b, &char_widths);

      if (retval)
	{
816 817 818 819
#if 0
	  /* Disabled until we can find a way to get the right results
	     on all versions of Windows.  */

820 821 822 823
	  /* Don't trust the ABC widths.  For synthesized fonts they are
	     wrong, and so is the result of GetCharWidth()!  */
	  int real_width;
	  GetCharWidth (hdc, *char2b, *char2b, &real_width);
824
#endif
825
	  pcm->width = char_widths.abcA + char_widths.abcB + char_widths.abcC;
826
#if 0
827 828 829 830
	  /* As far as I can tell, this is the best way to determine what
	     ExtTextOut will do with the broken font.  */
	  if (pcm->width != real_width)
	    pcm->width = (pcm->width + real_width) / 2;
831
#endif
832
	  pcm->lbearing = char_widths.abcA;
833
	  pcm->rbearing = char_widths.abcA + char_widths.abcB;
834 835
	  pcm->ascent = FONT_BASE (font);
	  pcm->descent = FONT_DESCENT (font);
836
	}
837
    }
838 839

  if (!retval)
840
    {
841 842 843 844 845 846
      /* Either font is not a True-type font, or GetCharABCWidthsW
	 failed (it is not supported on Windows 9x for instance), so we
	 can't determine the full info we would like.  All is not lost
	 though - we can call GetTextExtentPoint32 to get rbearing and
	 deduce width based on the font's per-string overhang.  lbearing
	 is assumed to be zero.  */
847 848 849 850 851

      /* TODO: Some Thai characters (and other composites if Windows
         supports them) do have lbearing, and report their total width
         as zero. Need some way of handling them when
         GetCharABCWidthsW fails. */
852 853 854 855 856 857
      SIZE sz;

      if (font_type == UNICODE_FONT)
	retval = GetTextExtentPoint32W (hdc, char2b, 1, &sz);
      else
	retval = GetTextExtentPoint32A (hdc, (char*)char2b, 1, &sz);
858 859

      if (retval)
860
	{
861 862
	  pcm->width = sz.cx - font->tm.tmOverhang;
	  pcm->rbearing = sz.cx;
863
	  pcm->lbearing = 0;
864 865
	  pcm->ascent = FONT_BASE (font);
	  pcm->descent = FONT_DESCENT (font);
866
	}
867 868 869
    }


870 871
  if (pcm->width == 0 && (pcm->rbearing - pcm->lbearing) == 0)
    {
872
      retval = FALSE;
873 874
    }

875 876 877 878 879 880 881 882 883 884 885
  SelectObject (hdc, old_font);
  ReleaseDC (NULL, hdc);

  return retval;
}


static XCharStruct *
w32_per_char_metric (font, char2b, font_type)
     XFontStruct *font;
     wchar_t *char2b;
886
     int /* enum w32_char_font_type */ font_type;
887 888 889 890 891 892 893 894 895
{
  /* The result metric information.  */
  XCharStruct *pcm;
  BOOL retval;

  xassert (font && char2b);
  xassert (font_type != UNKNOWN_FONT);

  /* Handle the common cases quickly.  */
896
  if (!font->bdf && font->per_char == NULL)
897 898
    /* TODO: determine whether char2b exists in font?  */
    return &font->max_bounds;
899
  else if (!font->bdf && *char2b < 128)
900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926
    return &font->per_char[*char2b];

  pcm = &font->scratch;

  if (font_type == BDF_1D_FONT)
    retval = w32_bdf_per_char_metric (font, char2b, 1, pcm);
  else if (font_type == BDF_2D_FONT)
    retval = w32_bdf_per_char_metric (font, char2b, 2, pcm);
  else
    retval = w32_native_per_char_metric (font, char2b, font_type, pcm);

  if (retval)
    return pcm;

  return NULL;
}

void
w32_cache_char_metrics (font)
     XFontStruct *font;
{
  wchar_t char2b = L'x';

  /* Cache char metrics for the common cases.  */
  if (font->bdf)
    {
      /* TODO: determine whether font is fixed-pitch.  */
927 928 929 930 931 932 933 934 935 936
      if (!w32_bdf_per_char_metric (font, &char2b, 1, &font->max_bounds))
        {
          /* Use the font width and height as max bounds, as not all BDF
             fonts contain the letter 'x'. */
          font->max_bounds.width = FONT_MAX_WIDTH (font);
          font->max_bounds.lbearing = -font->bdf->llx;
          font->max_bounds.rbearing = FONT_MAX_WIDTH (font) - font->bdf->urx;
          font->max_bounds.ascent = FONT_BASE (font);
          font->max_bounds.descent = FONT_DESCENT (font);
        }
937 938 939
    }
  else
    {
940 941 942 943
      if (((font->tm.tmPitchAndFamily & TMPF_FIXED_PITCH) != 0)
          /* Some fonts (eg DBCS fonts) are marked as fixed width even
             though they contain characters of different widths. */
          || (font->tm.tmMaxCharWidth != font->tm.tmAveCharWidth))
944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963
	{
	  /* Font is not fixed pitch, so cache per_char info for the
             ASCII characters.  It would be much more work, and probably
             not worth it, to cache other chars, since we may change
             between using Unicode and ANSI text drawing functions at
             run-time.  */
	  int i;

	  font->per_char = xmalloc (128 * sizeof(XCharStruct));
	  for (i = 0; i < 128; i++)
	    {
	      char2b = i;
	      w32_native_per_char_metric (font, &char2b, ANSI_FONT,
					  &font->per_char[i]);
	    }
	}
      else
	w32_native_per_char_metric (font, &char2b, ANSI_FONT,
				    &font->max_bounds);
    }
964 965 966
}


967 968 969 970 971 972 973
/* Determine if a font is double byte. */
int w32_font_is_double_byte (XFontStruct *font)
{
  return font->double_byte_p;
}


974
static BOOL
975 976 977 978 979 980 981 982 983
w32_use_unicode_for_codepage (codepage)
     int codepage;
{
  /* If the current codepage is supported, use Unicode for output. */
  return (w32_enable_unicode_output
          && codepage != CP_8BIT
          && (codepage == CP_UNICODE || IsValidCodePage (codepage)));
}

984 985 986
/* Encode CHAR2B using encoding information from FONT_INFO.  CHAR2B is
   the two-byte form of C.  Encoding is returned in *CHAR2B.  */

987
static int /* enum w32_char_font_type */
988
w32_encode_char (c, char2b, font_info, two_byte_p)
989 990 991
     int c;
     wchar_t *char2b;
     struct font_info *font_info;
992
     int * two_byte_p;
993 994 995
{
  int charset = CHAR_CHARSET (c);
  int codepage;
996
  int unicode_p = 0;
997
  int internal_two_byte_p = 0;
998

999 1000
  XFontStruct *font = font_info->font;

1001
  internal_two_byte_p = w32_font_is_double_byte (font);
1002

1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
  /* FONT_INFO may define a scheme by which to encode byte1 and byte2.
     This may be either a program in a special encoder language or a
     fixed encoding.  */
  if (font_info->font_encoder)
    {
      /* It's a program.  */
      struct ccl_program *ccl = font_info->font_encoder;

      if (CHARSET_DIMENSION (charset) == 1)
	{
	  ccl->reg[0] = charset;
1014
	  ccl->reg[1] = XCHAR2B_BYTE2 (char2b);
1015
	  ccl->reg[2] = -1;
1016 1017 1018 1019
	}
      else
	{
	  ccl->reg[0] = charset;
1020 1021
	  ccl->reg[1] = XCHAR2B_BYTE1 (char2b);
	  ccl->reg[2] = XCHAR2B_BYTE2 (char2b);
1022 1023 1024 1025 1026 1027
	}

      ccl_driver (ccl, NULL, NULL, 0, 0, NULL);

      /* We assume that MSBs are appropriately set/reset by CCL
	 program.  */
1028
      if (!internal_two_byte_p)	/* 1-byte font */
1029
	STORE_XCHAR2B (char2b, 0, ccl->reg[1]);
1030
      else
1031
	STORE_XCHAR2B (char2b, ccl->reg[1], ccl->reg[2]);
1032 1033 1034 1035 1036 1037
    }
  else if (font_info->encoding[charset])
    {
      /* Fixed encoding scheme.  See fontset.h for the meaning of the
	 encoding numbers.  */
      int enc = font_info->encoding[charset];
1038

1039 1040
      if ((enc == 1 || enc == 2)
	  && CHARSET_DIMENSION (charset) == 2)
1041
	STORE_XCHAR2B (char2b, XCHAR2B_BYTE1 (char2b) | 0x80, XCHAR2B_BYTE2 (char2b));
1042

1043 1044
      if (enc == 1 || enc == 3
          || (enc == 4 && CHARSET_DIMENSION (charset) == 1))
1045
	STORE_XCHAR2B (char2b, XCHAR2B_BYTE1 (char2b), XCHAR2B_BYTE2 (char2b) | 0x80);
1046 1047 1048 1049
      else if (enc == 4)
        {
          int sjis1, sjis2;

1050
          ENCODE_SJIS (XCHAR2B_BYTE1 (char2b), XCHAR2B_BYTE2 (char2b),
1051
                       sjis1, sjis2);
1052
          STORE_XCHAR2B (char2b, sjis1, sjis2);
1053 1054
        }
    }
1055
  codepage = font_info->codepage;
1056 1057 1058 1059

  /* If charset is not ASCII or Latin-1, may need to move it into
     Unicode space.  */
  if ( font && !font->bdf && w32_use_unicode_for_codepage (codepage)
1060 1061
       && charset != CHARSET_ASCII && charset != charset_latin_iso8859_1
       && charset != CHARSET_8_BIT_CONTROL && charset != CHARSET_8_BIT_GRAPHIC)
1062 1063
    {
      char temp[3];
1064 1065
      temp[0] = XCHAR2B_BYTE1 (char2b);
      temp[1] = XCHAR2B_BYTE2 (char2b);
1066
      temp[2] = '\0';
1067 1068 1069 1070 1071 1072 1073
      if (codepage != CP_UNICODE)
        {
          if (temp[0])
            MultiByteToWideChar (codepage, 0, temp, 2, char2b, 1);
          else
            MultiByteToWideChar (codepage, 0, temp+1, 1, char2b, 1);
        }
1074
      unicode_p = 1;
1075
      internal_two_byte_p = 1;
1076
    }
1077 1078 1079 1080

  if (two_byte_p)
    *two_byte_p = internal_two_byte_p;

1081 1082
  if (!font)
    return UNKNOWN_FONT;
1083 1084
  else if (font->bdf && CHARSET_DIMENSION (charset) == 1)
    return BDF_1D_FONT;
1085
  else if (font->bdf)
1086
    return BDF_2D_FONT;
1087 1088 1089 1090
  else if (unicode_p)
    return UNICODE_FONT;
  else
    return ANSI_FONT;
1091 1092 1093
}


Geoff Voelker's avatar
Geoff Voelker committed
1094

1095 1096 1097 1098 1099
/***********************************************************************
			    Glyph display
 ***********************************************************************/


1100
/* Encapsulate the different ways of displaying text under W32.  */
1101

1102 1103
static void
w32_text_out (s, x, y,chars,nchars)
1104 1105 1106 1107 1108
     struct glyph_string * s;
     int x, y;
     wchar_t * chars;
     int nchars;
{
1109
  int charset_dim = w32_font_is_double_byte (s->gc->font) ? 2 : 1;
1110 1111
  if (s->gc->font->bdf)
    w32_BDF_TextOut (s->gc->font->bdf, s->hdc,
1112 1113
                     x, y, (char *) chars, charset_dim,
                     nchars * charset_dim, 0);
1114
  else if (s->first_glyph->font_type == UNICODE_FONT)
1115 1116
    ExtTextOutW (s->hdc, x, y, 0, NULL, chars, nchars, NULL);
  else
1117 1118
    ExtTextOutA (s->hdc, x, y, 0, NULL, (char *) chars,
		 nchars * charset_dim, NULL);
1119 1120
}

1121 1122


1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147
static void x_set_glyph_string_clipping P_ ((struct glyph_string *));
static void x_set_glyph_string_gc P_ ((struct glyph_string *));
static void x_draw_glyph_string_background P_ ((struct glyph_string *,
						int));
static void x_draw_glyph_string_foreground P_ ((struct glyph_string *));
static void x_draw_composite_glyph_string_foreground P_ ((struct glyph_string *));
static void x_draw_glyph_string_box P_ ((struct glyph_string *));
static void x_draw_glyph_string  P_ ((struct glyph_string *));
static void x_set_cursor_gc P_ ((struct glyph_string *));
static void x_set_mode_line_face_gc P_ ((struct glyph_string *));
static void x_set_mouse_face_gc P_ ((struct glyph_string *));
static int w32_alloc_lighter_color (struct frame *, COLORREF *, double, int);
static void w32_setup_relief_color P_ ((struct frame *, struct relief *,
                                        double, int, COLORREF));
static void x_setup_relief_colors P_ ((struct glyph_string *));
static void x_draw_image_glyph_string P_ ((struct glyph_string *));
static void x_draw_image_relief P_ ((struct glyph_string *));
static void x_draw_image_foreground P_ ((struct glyph_string *));
static void w32_draw_image_foreground_1 P_ ((struct glyph_string *, HBITMAP));
static void x_clear_glyph_string_rect P_ ((struct glyph_string *, int,
					   int, int, int));
static void w32_draw_relief_rect P_ ((struct frame *, int, int, int, int,
				    int, int, int, int, RECT *));
static void w32_draw_box_rect P_ ((struct glyph_string *, int, int, int, int,
				 int, int, int, RECT *));
1148 1149 1150 1151

#if GLYPH_DEBUG
static void x_check_font P_ ((struct frame *, XFontStruct *));
#endif
1152

1153

1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 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 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
/* Set S->gc to a suitable GC for drawing glyph string S in cursor
   face.  */

static void
x_set_cursor_gc (s)
     struct glyph_string *s;
{
  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;

      if (FRAME_W32_DISPLAY_INFO (s->f)->scratch_cursor_gc)
	XChangeGC (NULL, FRAME_W32_DISPLAY_INFO (s->f)->scratch_cursor_gc,
		   mask, &xgcv);
      else
	FRAME_W32_DISPLAY_INFO (s->f)->scratch_cursor_gc