w32term.c 178 KB
Newer Older
1
/* Implementation of GUI terminal on the Microsoft W32 API.
2 3
   Copyright (C) 1989, 1993, 1994, 1995, 1996, 1997, 1998,
                 1999, 2000, 2001, 2002, 2003, 2004, 2005,
Glenn Morris's avatar
Glenn Morris committed
4
                 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
Geoff Voelker's avatar
Geoff Voelker committed
5 6 7

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Geoff Voelker's avatar
Geoff Voelker committed
20 21

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

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

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

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

#include "w32heap.h"
#include <shellapi.h>
Geoff Voelker's avatar
Geoff Voelker committed
58

Jason Rumney's avatar
Jason Rumney committed
59
#include "font.h"
60
#include "w32font.h"
61

Kim F. Storm's avatar
Kim F. Storm committed
62
/* Fringe bitmaps.  */
63

64 65
static int max_fringe_bmp = 0;
static HBITMAP *fringe_bmp = 0;
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
/* 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

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

static int any_help_event_p;

86 87 88
/* Last window where we saw the mouse.  Used by mouse-autoselect-window.  */
static Lisp_Object last_window;

89
/* Non-zero means make use of UNDERLINE_POSITION font properties.  */
90 91
int x_use_underline_position_properties;

92 93 94 95
/* Non-zero means to draw the underline at the same place as the descent line.  */

int x_underline_at_descent_line;

Geoff Voelker's avatar
Geoff Voelker committed
96 97
extern unsigned int msh_mousewheel;

98
extern void free_frame_menubar (struct frame *);
Geoff Voelker's avatar
Geoff Voelker committed
99

100
extern int w32_codepage_for_font (char *fontname);
101
extern Cursor w32_load_cursor (LPCTSTR name);
102

Geoff Voelker's avatar
Geoff Voelker committed
103 104
extern Lisp_Object Vwindow_system;

Geoff Voelker's avatar
Geoff Voelker committed
105 106 107 108
#define x_any_window_to_frame x_window_to_frame
#define x_top_window_to_frame x_window_to_frame


109 110
/* 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
111
struct w32_display_info *x_display_list;
Geoff Voelker's avatar
Geoff Voelker committed
112 113

/* This is a list of cons cells, each of the form (NAME . FONT-LIST-CACHE),
114
   one for each element of w32_display_list and in the same order.
Geoff Voelker's avatar
Geoff Voelker committed
115 116
   NAME is the name of the frame.
   FONT-LIST-CACHE records previous values returned by x-list-fonts.  */
117
Lisp_Object w32_display_name_list;
Geoff Voelker's avatar
Geoff Voelker committed
118

119 120 121 122 123 124 125 126 127 128 129

#ifndef GLYPHSET
/* Pre Windows 2000, this was not available, but define it here so
   that Emacs compiled on such a platform will run on newer versions.  */

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

Juanma Barranquero's avatar
Juanma Barranquero committed
130
typedef struct tagGLYPHSET
131 132 133 134 135 136
{
  DWORD cbThis;
  DWORD flAccel;
  DWORD cGlyphsSupported;
  DWORD cRanges;
  WCRANGE ranges[1];
Juanma Barranquero's avatar
Juanma Barranquero committed
137
} GLYPHSET;
138 139 140

#endif

141
/* Dynamic linking to SetLayeredWindowAttribute (only since 2000).  */
142
BOOL (WINAPI *pfnSetLayeredWindowAttributes) (HWND, COLORREF, BYTE, DWORD);
143 144 145 146

#ifndef LWA_ALPHA
#define LWA_ALPHA 0x02
#endif
147 148 149 150 151
/* 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
152

Geoff Voelker's avatar
Geoff Voelker committed
153 154
/* Frame being updated by update_frame.  This is declared in term.c.
   This is set by update_begin and looked at by all the
155
   w32 functions.  It is zero while not inside an update.
156
   In that case, the w32 functions assume that `SELECTED_FRAME ()'
Geoff Voelker's avatar
Geoff Voelker committed
157 158 159 160 161 162
   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;

163 164 165 166 167
/* 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;
168
int w32_use_visible_system_caret;
169

170 171
DWORD dwWindowsThreadId = 0;
HANDLE hWindowsThread = NULL;
Geoff Voelker's avatar
Geoff Voelker committed
172 173 174
DWORD dwMainThreadId = 0;
HANDLE hMainThread = NULL;

175 176 177 178 179 180
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
181 182 183 184
/* Mouse movement. */

/* Where the mouse was last time we reported a mouse event.  */
static RECT last_mouse_glyph;
185
static FRAME_PTR last_mouse_glyph_frame;
186
static Lisp_Object last_mouse_press_frame;
Geoff Voelker's avatar
Geoff Voelker committed
187

188
int w32_num_mouse_buttons;
Geoff Voelker's avatar
Geoff Voelker committed
189

190
Lisp_Object Vw32_swap_mouse_buttons;
Geoff Voelker's avatar
Geoff Voelker committed
191

192 193 194 195 196 197
/* 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;

198 199 200
/* Control whether right-alt and left-ctrl should be recognized as AltGr.  */
Lisp_Object Vw32_recognize_altgr;

Geoff Voelker's avatar
Geoff Voelker committed
201 202 203
/* The scroll bar in which the last motion event occurred.

   If the last motion event occurred in a scroll bar, we set this
204
   so w32_mouse_position can know whether to report a scroll bar motion or
Geoff Voelker's avatar
Geoff Voelker committed
205 206 207
   an ordinary motion.

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

212
/* This is a hack.  We would really prefer that w32_mouse_position would
Geoff Voelker's avatar
Geoff Voelker committed
213
   return the time associated with the position it returns, but there
214
   doesn't seem to be any way to wrest the time-stamp from the server
Geoff Voelker's avatar
Geoff Voelker committed
215 216 217
   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.  */
218 219 220 221
static Time last_mouse_movement_time;

/* Incremented by w32_read_socket whenever it really tries to read
   events.  */
Geoff Voelker's avatar
Geoff Voelker committed
222 223 224 225 226 227 228 229 230
#ifdef __STDC__
static int volatile input_signal_count;
#else
static int input_signal_count;
#endif

extern Lisp_Object Vcommand_line_args, Vsystem_name;

/* A mask of extra modifier bits to put into every keyboard char.  */
231
extern EMACS_INT extra_keyboard_modifiers;
Geoff Voelker's avatar
Geoff Voelker committed
232

233 234 235
/* Keyboard code page - may be changed by language-change events.  */
static int keyboard_codepage;

236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
static void x_update_window_end (struct window *, int, int);
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_wm_set_size_hint (struct frame *, long, int);
void x_raise_frame (struct frame *);
void x_set_window_size (struct frame *, int, int, int);
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 w32_set_terminal_modes (struct terminal *);
static void w32_reset_terminal_modes (struct terminal *);
static void x_clear_frame (struct frame *);
static void frame_highlight (struct frame *);
static void frame_unhighlight (struct frame *);
static void x_new_focus_frame (struct 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);
static void w32_clip_to_row (struct window *, struct glyph_row *, int, HDC);
static BOOL my_show_window (struct frame *, HWND, int);
static void my_set_window_pos (HWND, HWND, int, int, int, int, UINT);
270
#if 0
271
static void my_set_focus (struct frame *, HWND);
272
#endif
273 274
static void my_set_foreground_window (HWND);
static void my_destroy_window (struct frame *, HWND);
275

Geoff Voelker's avatar
Geoff Voelker committed
276 277 278
static Lisp_Object Qvendor_specific_keysyms;


279 280 281 282
/***********************************************************************
			      Debugging
 ***********************************************************************/

Geoff Voelker's avatar
Geoff Voelker committed
283
#if 0
284 285 286

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

288
struct record
Geoff Voelker's avatar
Geoff Voelker committed
289 290 291 292 293 294 295 296 297
{
  char *locus;
  int type;
};

struct record event_record[100];

int event_record_index;

298
record_event (char *locus, int type)
Geoff Voelker's avatar
Geoff Voelker committed
299 300 301 302 303 304 305 306 307 308 309
{
  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 */

310

311
void
312
XChangeGC (void *ignore, XGCValues *gc, unsigned long mask,
313
	   XGCValues *xgcv)
314 315 316 317 318 319 320 321 322
{
  if (mask & GCForeground)
    gc->foreground = xgcv->foreground;
  if (mask & GCBackground)
    gc->background = xgcv->background;
  if (mask & GCFont)
    gc->font = xgcv->font;
}

323 324
XGCValues *
XCreateGC (void *ignore, Window window, unsigned long mask, XGCValues *xgcv)
325 326
{
  XGCValues *gc = (XGCValues *) xmalloc (sizeof (XGCValues));
327
  memset (gc, 0, sizeof (XGCValues));
328 329 330 331 332 333

  XChangeGC (ignore, gc, mask, xgcv);

  return gc;
}

334
void
335 336
XGetGCValues (void *ignore, XGCValues *gc,
	      unsigned long mask, XGCValues *xgcv)
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 364 365 366 367 368 369 370 371 372 373 374 375 376
{
  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. */
377
void
378
w32_fill_rect (FRAME_PTR f, HDC hdc, COLORREF pix, RECT *lprect)
Geoff Voelker's avatar
Geoff Voelker committed
379 380
{
  HBRUSH hb;
381

Geoff Voelker's avatar
Geoff Voelker committed
382 383 384 385 386
  hb = CreateSolidBrush (pix);
  FillRect (hdc, lprect, hb);
  DeleteObject (hb);
}

387
void
388
w32_clear_window (FRAME_PTR f)
Geoff Voelker's avatar
Geoff Voelker committed
389 390
{
  RECT rect;
391
  HDC hdc = get_frame_dc (f);
Geoff Voelker's avatar
Geoff Voelker committed
392

393 394 395 396 397 398 399 400 401
  /* 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);
    }

402
  release_frame_dc (f, hdc);
Geoff Voelker's avatar
Geoff Voelker committed
403 404
}

405 406 407
#define OPAQUE_FRAME 255

void
408
x_set_frame_alpha (struct frame *f)
409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
{
  struct w32_display_info *dpyinfo = FRAME_W32_DISPLAY_INFO (f);
  double alpha = 1.0;
  double alpha_min = 1.0;
  BYTE opac;
  LONG ex_style;
  HWND window = FRAME_W32_WINDOW (f);

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

  if (dpyinfo->x_highlight_frame == f)
    alpha = f->alpha[0];
  else
    alpha = f->alpha[1];

  if (FLOATP (Vframe_alpha_lower_limit))
    alpha_min = XFLOAT_DATA (Vframe_alpha_lower_limit);
  else if (INTEGERP (Vframe_alpha_lower_limit))
    alpha_min = (XINT (Vframe_alpha_lower_limit)) / 100.0;

431 432 433
  if (alpha < 0.0)
    return;
  else if (alpha > 1.0)
434 435 436 437 438 439 440 441 442
    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
443
    ex_style &= ~WS_EX_LAYERED;
444 445 446 447 448 449 450 451 452
  else
    ex_style |= WS_EX_LAYERED;

  SetWindowLong (window, GWL_EXSTYLE, ex_style);

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

453
int
454
x_display_pixel_height (struct w32_display_info *dpyinfo)
455
{
456 457 458 459
  HDC dc = GetDC (NULL);
  int pixels = GetDeviceCaps (dc, VERTRES);
  ReleaseDC (NULL, dc);
  return pixels;
460 461 462
}

int
463
x_display_pixel_width (struct w32_display_info *dpyinfo)
464
{
465 466 467 468
  HDC dc = GetDC (NULL);
  int pixels = GetDeviceCaps (dc, HORZRES);
  ReleaseDC (NULL, dc);
  return pixels;
469 470
}

Geoff Voelker's avatar
Geoff Voelker committed
471

472 473 474
/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
475

476 477 478
/* 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
479
   each window being updated.  */
Geoff Voelker's avatar
Geoff Voelker committed
480

481
static void
482
x_update_begin (struct frame *f)
Geoff Voelker's avatar
Geoff Voelker committed
483
{
484 485
  struct w32_display_info *display_info = FRAME_W32_DISPLAY_INFO (f);

Andrew Innes's avatar
Andrew Innes committed
486 487 488
  if (! FRAME_W32_P (f))
    return;

489 490 491 492 493 494 495
  /* 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;
  }
496
}
Geoff Voelker's avatar
Geoff Voelker committed
497

498 499 500 501 502 503

/* 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
504
x_update_window_begin (struct window *w)
505 506 507 508
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
  struct w32_display_info *display_info = FRAME_W32_DISPLAY_INFO (f);

509
  /* Hide the system caret during an update.  */
510 511 512 513
  if (w32_use_visible_system_caret && w32_system_caret_hwnd)
    {
      SendMessage (w32_system_caret_hwnd, WM_EMACS_HIDE_CARET, 0, 0);
    }
514

515 516
  updated_window = w;
  set_output_cursor (&w->cursor);
Geoff Voelker's avatar
Geoff Voelker committed
517 518 519

  BLOCK_INPUT;

520
  if (f == display_info->mouse_face_mouse_frame)
Geoff Voelker's avatar
Geoff Voelker committed
521 522
    {
      /* Don't do highlighting for mouse motion during the update.  */
523
      display_info->mouse_face_defer = 1;
Geoff Voelker's avatar
Geoff Voelker committed
524

525 526
      /* If F needs to be redrawn, simply forget about any prior mouse
	 highlighting.  */
Geoff Voelker's avatar
Geoff Voelker committed
527
      if (FRAME_GARBAGED_P (f))
528 529
	display_info->mouse_face_window = Qnil;

530 531 532 533 534 535
#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.  */
536

537 538 539 540 541 542 543
      /* 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
544
	{
545
	  int i;
Geoff Voelker's avatar
Geoff Voelker committed
546

547 548
          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
549 550
	      break;

551 552
	  if (i < w->desired_matrix->nrows)
	    clear_mouse_face (display_info);
Geoff Voelker's avatar
Geoff Voelker committed
553
	}
554
#endif /* 0 */
Geoff Voelker's avatar
Geoff Voelker committed
555 556 557 558 559
    }

  UNBLOCK_INPUT;
}

560
/* Draw a vertical window border from (x,y0) to (x,y1)  */
561

562
static void
563
w32_draw_vertical_window_border (struct window *w, int x, int y0, int y1)
Geoff Voelker's avatar
Geoff Voelker committed
564
{
565
  struct frame *f = XFRAME (WINDOW_FRAME (w));
566 567
  RECT r;
  HDC hdc;
568
  struct face *face;
569

570 571 572 573
  r.left = x;
  r.right = x + 1;
  r.top = y0;
  r.bottom = y1;
574

575
  hdc = get_frame_dc (f);
576 577 578 579 580 581
  face = FACE_FROM_ID (f, VERTICAL_BORDER_FACE_ID);
  if (face)
    w32_fill_rect (f, hdc, face->foreground, &r);
  else
    w32_fill_rect (f, hdc, FRAME_FOREGROUND_PIXEL (f), &r);

582
  release_frame_dc (f, hdc);
583
}
Geoff Voelker's avatar
Geoff Voelker committed
584

585

586 587 588 589 590 591 592 593 594 595 596 597
/* End update of window W (which is equal to updated_window).

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

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

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

static void
600 601
x_update_window_end (struct window *w, int cursor_on_p,
		     int mouse_face_overwritten_p)
602
{
603
  struct w32_display_info *dpyinfo = FRAME_W32_DISPLAY_INFO (XFRAME (w->frame));
604

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

609
      if (cursor_on_p)
610 611 612
	display_and_set_cursor (w, 1, output_cursor.hpos,
				output_cursor.vpos,
				output_cursor.x, output_cursor.y);
613

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

617 618
      UNBLOCK_INPUT;
    }
619 620 621 622 623 624 625 626 627 628

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

629 630 631
  /* 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.  */
632 633 634 635
  if (w32_use_visible_system_caret && w32_system_caret_hwnd)
    {
      SendMessage (w32_system_caret_hwnd, WM_EMACS_SHOW_CARET, 0, 0);
    }
636

637 638 639
  updated_window = NULL;
}

640 641 642 643

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

644
static void
645
x_update_end (struct frame *f)
646
{
Andrew Innes's avatar
Andrew Innes committed
647 648 649
  if (! FRAME_W32_P (f))
    return;

650 651
  /* Mouse highlight may be displayed again.  */
  FRAME_W32_DISPLAY_INFO (f)->mouse_face_defer = 0;
Geoff Voelker's avatar
Geoff Voelker committed
652 653
}

654

655 656 657
/* 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
658

659
static void
660
w32_frame_up_to_date (struct frame *f)
Geoff Voelker's avatar
Geoff Voelker committed
661
{
662
  if (FRAME_W32_P (f))
Geoff Voelker's avatar
Geoff Voelker committed
663
    {
664
      struct w32_display_info *dpyinfo = FRAME_W32_DISPLAY_INFO (f);
665

666 667 668 669 670 671 672 673 674 675 676
      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
677 678
    }
}
679 680 681


/* Draw truncation mark bitmaps, continuation mark bitmaps, overlay
Kim F. Storm's avatar
Kim F. Storm committed
682
   arrow bitmaps, or clear the fringes if no bitmaps are required
683
   before DESIRED_ROW is made current.  The window being updated is
684
   found in updated_window.  This function is called from
685 686 687 688
   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
689
x_after_update_window_line (struct glyph_row *desired_row)
690 691
{
  struct window *w = updated_window;
692 693 694
  struct frame *f;
  int width, height;

695
  xassert (w);
696

697
  if (!desired_row->mode_line_p && !w->pseudo_window_p)
Kenichi Handa's avatar
Kenichi Handa committed
698
    desired_row->redraw_fringe_bitmaps_p = 1;
699

700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
  /* 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));
715

716 717 718 719
      BLOCK_INPUT;
      {
	HDC hdc = get_frame_dc (f);
	w32_clear_area (f, hdc, 0, y, width, height);
720
	w32_clear_area (f, hdc, FRAME_PIXEL_WIDTH (f) - width,
721 722 723
			y, width, height);
	release_frame_dc (f, hdc);
      }
724 725 726 727 728
      UNBLOCK_INPUT;
    }
}


Kim F. Storm's avatar
Kim F. Storm committed
729
/* Draw the bitmap WHICH in one of the left or right fringes of
730 731 732 733 734
   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
735 736
w32_draw_fringe_bitmap (struct window *w, struct glyph_row *row,
			struct draw_fringe_bitmap_params *p)
737 738
{
  struct frame *f = XFRAME (WINDOW_FRAME (w));
Kim F. Storm's avatar
Kim F. Storm committed
739 740 741 742
  HDC hdc;
  struct face *face = p->face;

  hdc = get_frame_dc (f);
743

744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797
  if (!p->overlay_p)
    {
      int bx = p->bx, by = p->by, nx = p->nx, ny = p->ny;

      /* If the fringe is adjacent to the left (right) scroll bar of a
	 leftmost (rightmost, respectively) window, then extend its
	 background to the gap between the fringe and the bar.  */
      if ((WINDOW_LEFTMOST_P (w)
	   && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_LEFT (w))
	  || (WINDOW_RIGHTMOST_P (w)
	      && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w)))
	{
	  int sb_width = WINDOW_CONFIG_SCROLL_BAR_WIDTH (w);

	  if (sb_width > 0)
	    {
	      int left = WINDOW_SCROLL_BAR_AREA_X (w);
	      int width = (WINDOW_CONFIG_SCROLL_BAR_COLS (w)
			   * FRAME_COLUMN_WIDTH (f));

	      if (bx < 0)
		{
		  /* Bitmap fills the fringe.  */
		  if (left + width == p->x)
		    bx = left + sb_width;
		  else if (p->x + p->wd == left)
		    bx = left;
		  if (bx >= 0)
		    {
		      int header_line_height = WINDOW_HEADER_LINE_HEIGHT (w);

		      nx = width - sb_width;
		      by = WINDOW_TO_FRAME_PIXEL_Y (w, max (header_line_height,
							    row->y));
		      ny = row->visible_height;
		    }
		}
	      else
		{
		  if (left + width == bx)
		    {
		      bx = left + sb_width;
		      nx += width - sb_width;
		    }
		  else if (bx + nx == left)
		    nx += width - sb_width;
		}
	    }
	}

      if (bx >= 0 && nx > 0)
	w32_fill_area (f, hdc, face->background, bx, by, nx, ny);
    }

798
  /* Must clip because of partially visible lines.  */
799
  w32_clip_to_row (w, row, -1, hdc);
800

801
  if (p->which && p->which < max_fringe_bmp)
Kim F. Storm's avatar
Kim F. Storm committed
802 803 804 805
    {
      HBITMAP pixmap = fringe_bmp[p->which];
      HDC compat_hdc;
      HANDLE horig_obj;
806

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

Kim F. Storm's avatar
Kim F. Storm committed
809
      SaveDC (hdc);
810

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

Kenichi Handa's avatar
Kenichi Handa committed
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
      /* 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);
	}
847

Kim F. Storm's avatar
Kim F. Storm committed
848 849 850
      SelectObject (compat_hdc, horig_obj);
      DeleteDC (compat_hdc);
      RestoreDC (hdc, -1);
851
    }
852

Kim F. Storm's avatar
Kim F. Storm committed
853
  w32_set_clip_rectangle (hdc, NULL);
854 855 856 857

  release_frame_dc (f, hdc);
}

Kenichi Handa's avatar
Kenichi Handa committed
858
static void
859
w32_define_fringe_bitmap (int which, unsigned short *bits, int h, int wd)
Kenichi Handa's avatar
Kenichi Handa committed
860
{
861 862 863 864 865 866 867 868 869
  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
870 871 872 873
  fringe_bmp[which] = CreateBitmap (wd, h, 1, 1, bits);
}

static void
874
w32_destroy_fringe_bitmap (int which)
Kenichi Handa's avatar
Kenichi Handa committed
875
{
876 877 878
  if (which >= max_fringe_bmp)
    return;

Kenichi Handa's avatar
Kenichi Handa committed
879 880 881 882 883 884
  if (fringe_bmp[which])
    DeleteObject (fringe_bmp[which]);
  fringe_bmp[which] = 0;
}


Geoff Voelker's avatar
Geoff Voelker committed
885

886 887 888 889
/* 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
890

891
static void
892
w32_set_terminal_modes (struct terminal *term)
Geoff Voelker's avatar
Geoff Voelker committed
893 894 895
{
}

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

899
static void
900
w32_reset_terminal_modes (struct terminal *term)
Geoff Voelker's avatar
Geoff Voelker committed
901 902
{
}
903

904

905

906 907 908 909 910 911
/***********************************************************************
			   Display Iterator
 ***********************************************************************/

/* Function prototypes of this page.  */

912 913 914 915 916 917 918 919 920 921 922
static void x_set_glyph_string_clipping (struct glyph_string *);
static void x_set_glyph_string_gc (struct glyph_string *);
static void x_draw_glyph_string_background (struct glyph_string *,
                                            int);
static void x_draw_glyph_string_foreground (struct glyph_string *);
static void x_draw_composite_glyph_string_foreground (struct glyph_string *);
static void x_draw_glyph_string_box (struct glyph_string *);
static void x_draw_glyph_string  (struct glyph_string *);
static void x_set_cursor_gc (struct glyph_string *);
static void x_set_mode_line_face_gc (struct glyph_string *);
static void x_set_mouse_face_gc (struct glyph_string *);
923
static int w32_alloc_lighter_color (struct frame *, COLORREF *, double, int);
924 925 926 927 928 929 930 931 932 933 934 935 936 937
static void w32_setup_relief_color (struct frame *, struct relief *,
                                    double, int, COLORREF);
static void x_setup_relief_colors (struct glyph_string *);
static void x_draw_image_glyph_string (struct glyph_string *);
static void x_draw_image_relief (struct glyph_string *);
static void x_draw_image_foreground (struct glyph_string *);
static void w32_draw_image_foreground_1 (struct glyph_string *, HBITMAP);
static void x_clear_glyph_string_rect (struct glyph_string *, int,
                                       int, int, int);
static void w32_draw_relief_rect (struct frame *, int, int, int, int,
                                  int, int, int, int, int, int,
                                  RECT *);
static void w32_draw_box_rect (struct glyph_string *, int, int, int, int,
                               int, int, int, RECT *);
938

939

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

static void
944
x_set_cursor_gc (struct glyph_string *s)
945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
{
  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
	  = XCreateGC (NULL, s->window, mask, &xgcv);

      s->gc = FRAME_W32_DISPLAY_INFO (s->f)->scratch_cursor_gc;
    }
}


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

994
static void
995
x_set_mouse_face_gc (struct glyph_string *s)
996
{
997
  int face_id;
998
  struct face *face;
999

1000
  /* What face has to be used last for the mouse face?  */
1001
  face_id = FRAME_W32_DISPLAY_INFO (s->f)->mouse_face_face_id;
1002
  face = FACE_FROM_ID (s->f, face_id);
1003 1004
  if (face == NULL)
    face = FACE_FROM_ID (s->f, MOUSE_FACE_ID);
1005

1006
  if (s->first_glyph->type == CHAR_GLYPH)
1007
    face_id = FACE_FOR_CHAR (s->f, face, s->first_glyph->u.ch, -1, Qnil);
1008
  else
1009
    face_id = FACE_FOR_CHAR (s->f, face, 0, -1, Qnil);
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021
  s->face = FACE_FROM_ID (s->f, face_id);
  PREPARE_FACE_FOR_DISPLAY (s->f, s->face);

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

1023 1024 1025 1026 1027
      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;
1028

1029 1030 1031 1032 1033 1034
      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
	  = XCreateGC (NULL, s->window, mask, &xgcv);
1035

1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
      s->gc = FRAME_W32_DISPLAY_INFO (s->f)->scratch_cursor_gc;
    }

  xassert (s->gc != 0);
}


/* Set S->gc of glyph string S to a GC suitable for drawing a mode line.
   Faces to use in the mode line have already been computed when the
   matrix was built, so there isn't much to do, here.  */

static INLINE void
1048
x_set_mode_line_face_gc (struct glyph_string *s)
1049
{
1050 1051 1052 1053 1054 1055 1056 1057 1058
  s->gc = s->face->gc;
}


/* Set S->gc of glyph string S for drawing that glyph string.  Set
   S->stippled_p to a non-zero value if the face of S has a stipple
   pattern.  */

static INLINE void
1059
x_set_glyph_string_gc (struct glyph_string *s)
1060
{
1061
  PREPARE_FACE_FOR_DISPLAY (s->f, s->face);
1062

1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103
  if (s->hl == DRAW_NORMAL_TEXT)
    {
      s->gc = s->face->gc;
      s->stippled_p = s->face->stipple != 0;
    }
  else if (s->hl == DRAW_INVERSE_VIDEO)
    {
      x_set_mode_line_face_gc (s);
      s->stippled_p = s->face->stipple != 0;
    }
  else if (s->hl == DRAW_CURSOR)
    {
      x_set_cursor_gc (s);
      s->stippled_p = 0;
    }
  else if (s->hl == DRAW_MOUSE_FACE)
    {
      x_set_mouse_face_gc (s);
      s->stippled_p = s->face->stipple != 0;
    }
  else if (s->hl == DRAW_IMAGE_RAISED
	   || s->hl == DRAW_IMAGE_SUNKEN)
    {
      s->gc = s->face->gc;
      s->stippled_p = s->face->stipple != 0;
    }
  else
    {
      s->gc = s->face->gc;
      s->stippled_p = s->face->stipple != 0;
    }

  /* GC must have been set.  */
  xassert (s->gc != 0);
}


/* Set clipping for output of glyph string S.  S may be part of a mode
   line or menu if we don't have X toolkit support.  */

static INLINE void
1104
x_set_glyph_string_clipping (struct glyph_string *s)
1105
{
1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
  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)
    {
      HRGN full_clip, clip1, clip2;
      clip1 = CreateRectRgnIndirect (r);
      clip2 = CreateRectRgnIndirect (r + 1);
      if (CombineRgn (full_clip, clip1, clip2, RGN_OR) != ERROR)
        {
          SelectClipRgn (s->hdc, full_clip);
        }
      DeleteObject (clip1);
      DeleteObject (clip2);
      DeleteObject (full_clip);
    }
    s->num_clips = n;
1125 1126
}

Jason Rumney's avatar
Jason Rumney committed
1127 1128 1129 1130 1131
/* 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
1132 1133
x_set_glyph_string_clipping_exactly (struct glyph_string *src,
				     struct glyph_string *dst)
Jason Rumney's avatar
Jason Rumney committed
1134 1135 1136
{
  RECT r;

1137 1138 1139 1140 1141 1142
  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
1143 1144
  w32_set_clip_rectangle (dst->hdc, &r);
}
1145