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

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

Geoff Voelker's avatar
Geoff Voelker committed
91 92
extern void free_frame_menubar ();

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

96 97
extern glyph_metric *w32_BDF_TextMetric(bdffont *fontp,
					unsigned char *text, int dim);
Geoff Voelker's avatar
Geoff Voelker committed
98 99
extern Lisp_Object Vwindow_system;

Geoff Voelker's avatar
Geoff Voelker committed
100 101 102 103
#define x_any_window_to_frame x_window_to_frame
#define x_top_window_to_frame x_window_to_frame


104 105
/* 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
106
struct w32_display_info *x_display_list;
Geoff Voelker's avatar
Geoff Voelker committed
107 108

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

/* Frame being updated by update_frame.  This is declared in term.c.
   This is set by update_begin and looked at by all the
116
   w32 functions.  It is zero while not inside an update.
117
   In that case, the w32 functions assume that `SELECTED_FRAME ()'
Geoff Voelker's avatar
Geoff Voelker committed
118 119 120 121 122 123
   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;

124 125 126 127 128
/* 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;
129
int w32_use_visible_system_caret;
130

131
/* Flag to enable Unicode output in case users wish to use programs
132 133
   like Twinbridge on '95 rather than installed system level support
   for Far East languages.  */
134
int w32_enable_unicode_output;
135

136 137
DWORD dwWindowsThreadId = 0;
HANDLE hWindowsThread = NULL;
Geoff Voelker's avatar
Geoff Voelker committed
138 139 140
DWORD dwMainThreadId = 0;
HANDLE hMainThread = NULL;

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 168 169 170 171 172
#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
173 174 175
/* Mouse movement. */

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

Geoff Voelker's avatar
Geoff Voelker committed
177
static RECT last_mouse_glyph;
178
static Lisp_Object last_mouse_press_frame;
Geoff Voelker's avatar
Geoff Voelker committed
179

180
Lisp_Object Vw32_num_mouse_buttons;
Geoff Voelker's avatar
Geoff Voelker committed
181

182
Lisp_Object Vw32_swap_mouse_buttons;
Geoff Voelker's avatar
Geoff Voelker committed
183

184 185 186 187 188 189
/* 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;

190 191 192
/* Control whether right-alt and left-ctrl should be recognized as AltGr.  */
Lisp_Object Vw32_recognize_altgr;

Geoff Voelker's avatar
Geoff Voelker committed
193 194 195
/* The scroll bar in which the last motion event occurred.

   If the last motion event occurred in a scroll bar, we set this
196
   so w32_mouse_position can know whether to report a scroll bar motion or
Geoff Voelker's avatar
Geoff Voelker committed
197 198 199
   an ordinary motion.

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

204
/* This is a hack.  We would really prefer that w32_mouse_position would
Geoff Voelker's avatar
Geoff Voelker committed
205
   return the time associated with the position it returns, but there
206
   doesn't seem to be any way to wrest the time-stamp from the server
Geoff Voelker's avatar
Geoff Voelker committed
207 208 209 210
   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.  */

211 212 213 214
static Time last_mouse_movement_time;

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

Geoff Voelker's avatar
Geoff Voelker committed
216 217 218 219 220 221 222 223
#ifdef __STDC__
static int volatile input_signal_count;
#else
static int input_signal_count;
#endif

extern Lisp_Object Vcommand_line_args, Vsystem_name;

224
#ifndef USE_CRT_DLL
Geoff Voelker's avatar
Geoff Voelker committed
225
extern int errno;
226
#endif
Geoff Voelker's avatar
Geoff Voelker committed
227 228

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

230
extern EMACS_INT extra_keyboard_modifiers;
Geoff Voelker's avatar
Geoff Voelker committed
231

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

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 *));
255 256
static void x_new_focus_frame P_ ((struct w32_display_info *,
				   struct frame *));
257 258 259
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 *));
260 261
static void x_draw_bar_cursor P_ ((struct window *, struct glyph_row *, int,
				   enum text_cursor_kinds));
262
static void w32_clip_to_row P_ ((struct window *, struct glyph_row *, HDC));
263

Geoff Voelker's avatar
Geoff Voelker committed
264 265 266
static Lisp_Object Qvendor_specific_keysyms;


267 268 269 270
/***********************************************************************
			      Debugging
 ***********************************************************************/

Geoff Voelker's avatar
Geoff Voelker committed
271
#if 0
272 273 274

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

276
struct record
Geoff Voelker's avatar
Geoff Voelker committed
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
{
  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 */

300

301 302 303
void
XChangeGC (void * ignore, XGCValues* gc, unsigned long mask,
	   XGCValues *xgcv)
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
{
  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;
}

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

Geoff Voelker's avatar
Geoff Voelker committed
376 377 378 379 380
  hb = CreateSolidBrush (pix);
  FillRect (hdc, lprect, hb);
  DeleteObject (hb);
}

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

388 389 390 391 392 393 394 395 396
  /* 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);
    }

397
  release_frame_dc (f, hdc);
Geoff Voelker's avatar
Geoff Voelker committed
398 399 400
}


401 402 403
/***********************************************************************
		    Starting and ending an update
 ***********************************************************************/
404

405 406 407
/* 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
408
   each window being updated.  */
Geoff Voelker's avatar
Geoff Voelker committed
409

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

Andrew Innes's avatar
Andrew Innes committed
416 417 418
  if (! FRAME_W32_P (f))
    return;

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

428 429 430 431 432 433 434 435 436 437 438 439

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

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

446 447
  updated_window = w;
  set_output_cursor (&w->cursor);
Geoff Voelker's avatar
Geoff Voelker committed
448 449 450

  BLOCK_INPUT;

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

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

461 462 463 464 465 466
#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.  */
467

468 469 470 471 472 473 474
      /* 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
475
	{
476
	  int i;
Geoff Voelker's avatar
Geoff Voelker committed
477

478 479
          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
480 481
	      break;

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

  UNBLOCK_INPUT;
}

491
/* Draw a vertical window border from (x,y0) to (x,y1)  */
492

493
static void
494
w32_draw_vertical_window_border (w, x, y0, y1)
495
     struct window *w;
496
     int x, y0, y1;
Geoff Voelker's avatar
Geoff Voelker committed
497
{
498
  struct frame *f = XFRAME (WINDOW_FRAME (w));
499 500
  RECT r;
  HDC hdc;
501

502 503 504 505
  r.left = x;
  r.right = x + 1;
  r.top = y0;
  r.bottom = y1;
506

507 508 509
  hdc = get_frame_dc (f);
  w32_fill_rect (f, hdc, FRAME_FOREGROUND_PIXEL (f), &r);
  release_frame_dc (f, hdc);
510
}
Geoff Voelker's avatar
Geoff Voelker committed
511

512

513 514 515 516 517 518 519 520 521 522 523 524
/* 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. */
525 526

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

533 534 535
  if (!w->pseudo_window_p)
    {
      BLOCK_INPUT;
536

537
      if (cursor_on_p)
538 539 540
	display_and_set_cursor (w, 1, output_cursor.hpos,
				output_cursor.vpos,
				output_cursor.x, output_cursor.y);
541

542 543 544
      x_draw_vertical_border (w);
      UNBLOCK_INPUT;
    }
545 546 547 548 549 550 551 552 553 554

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

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

563 564 565
  updated_window = NULL;
}

566 567 568 569

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

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

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

581

582 583 584
/* 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
585

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

594 595 596 597 598 599 600 601 602 603 604
      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
605 606
    }
}
607 608 609


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

624
  xassert (w);
625

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

633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
  /* 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));
648

649 650 651 652 653 654 655 656 657
      /* 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);
658
	w32_clear_area (f, hdc, FRAME_PIXEL_WIDTH (f) - width,
659 660 661
			y, width, height);
	release_frame_dc (f, hdc);
      }
662 663 664 665 666
      UNBLOCK_INPUT;
    }
}


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

  hdc = get_frame_dc (f);
683 684

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

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

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

Kim F. Storm's avatar
Kim F. Storm committed
699 700
      compat_hdc = CreateCompatibleDC (hdc);
      SaveDC (hdc);
701

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

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

Kim F. Storm's avatar
Kim F. Storm committed
710 711 712
      SelectObject (compat_hdc, horig_obj);
      DeleteDC (compat_hdc);
      RestoreDC (hdc, -1);
713
    }
714

Kim F. Storm's avatar
Kim F. Storm committed
715
  w32_set_clip_rectangle (hdc, NULL);
716 717 718 719

  release_frame_dc (f, hdc);
}

Geoff Voelker's avatar
Geoff Voelker committed
720

721 722 723 724
/* 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
725

726 727
static void
w32_set_terminal_modes (void)
Geoff Voelker's avatar
Geoff Voelker committed
728 729 730
{
}

731 732
/* 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
733

734 735
static void
w32_reset_terminal_modes (void)
Geoff Voelker's avatar
Geoff Voelker committed
736 737
{
}
738

739

740

741 742 743 744 745 746
/***********************************************************************
			   Display Iterator
 ***********************************************************************/

/* Function prototypes of this page.  */

747
static XCharStruct *w32_per_char_metric P_ ((XFontStruct *,
748 749
                                             wchar_t *, int));
static int w32_encode_char P_ ((int, wchar_t *, struct font_info *, int *));
750

751 752 753

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

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

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

  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;
783
      pcm->descent = -bdf_metric->bboy;
784 785

      return 1;
786
    }
787
  return 0;
788 789 790
}


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

802
  xassert (font && char2b);
803 804
  xassert (font->hfont);
  xassert (font_type == UNICODE_FONT || font_type == ANSI_FONT);
805

806
  old_font = SelectObject (hdc, font->hfont);
807

808
  if ((font->tm.tmPitchAndFamily & TMPF_TRUETYPE) != 0)
809
    {
810 811 812 813
      ABC char_widths;

      if (font_type == UNICODE_FONT)
	retval = GetCharABCWidthsW (hdc, *char2b, *char2b, &char_widths);
814
      else
815 816 817 818
	retval = GetCharABCWidthsA (hdc, *char2b, *char2b, &char_widths);

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

823 824 825 826
	  /* 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);
827
#endif
828
	  pcm->width = char_widths.abcA + char_widths.abcB + char_widths.abcC;
829
#if 0
830 831 832 833
	  /* 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;
834
#endif
835
	  pcm->lbearing = char_widths.abcA;
836
	  pcm->rbearing = char_widths.abcA + char_widths.abcB;
837 838
	  pcm->ascent = FONT_BASE (font);
	  pcm->descent = FONT_DESCENT (font);
839
	}
840
    }
841 842

  if (!retval)
843
    {
844 845 846 847 848 849
      /* 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.  */
850 851 852 853 854

      /* 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. */
855 856 857 858 859 860
      SIZE sz;

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

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


873 874
  if (pcm->width == 0 && (pcm->rbearing - pcm->lbearing) == 0)
    {
875
      retval = FALSE;
876 877
    }

878 879 880 881 882 883 884 885 886 887 888
  SelectObject (hdc, old_font);
  ReleaseDC (NULL, hdc);

  return retval;
}


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

  xassert (font && char2b);

Jason Rumney's avatar
Jason Rumney committed
897 898 899 900 901 902 903 904 905 906 907
  /* TODO: This function is currently called through the RIF, and in
     some cases font_type is UNKNOWN_FONT. We currently allow the
     cached metrics to be used, which seems to work, but in cases
     where font_type is UNKNOWN_FONT, we probably haven't encoded
     char2b appropriately. All callers need checking to see what they
     are passing.  This is most likely to affect variable width fonts
     outside the Latin-1 range, particularly in languages like Thai
     that rely on rbearing and lbearing to provide composition. I
     don't think that is working currently anyway, but we don't seem
     to have anyone testing such languages on Windows.  */

908
  /* Handle the common cases quickly.  */
909
  if (!font->bdf && font->per_char == NULL)
910 911
    /* TODO: determine whether char2b exists in font?  */
    return &font->max_bounds;
912
  else if (!font->bdf && *char2b < 128)
913 914
    return &font->per_char[*char2b];

915 916
  xassert (font_type != UNKNOWN_FONT);

917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
  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.  */
942 943 944 945 946 947 948 949 950 951
      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);
        }
952 953 954
    }
  else
    {
955 956 957 958
      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))
959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
	{
	  /* 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);
    }
979 980 981
}


982 983 984 985 986 987 988
/* Determine if a font is double byte. */
int w32_font_is_double_byte (XFontStruct *font)
{
  return font->double_byte_p;
}


989
static BOOL
990 991 992 993 994 995 996 997 998
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)));
}

999 1000 1001
/* Encode CHAR2B using encoding information from FONT_INFO.  CHAR2B is
   the two-byte form of C.  Encoding is returned in *CHAR2B.  */

1002
static int /* enum w32_char_font_type */
1003
w32_encode_char (c, char2b, font_info, two_byte_p)
1004 1005 1006
     int c;
     wchar_t *char2b;
     struct font_info *font_info;
1007
     int * two_byte_p;
1008 1009 1010
{
  int charset = CHAR_CHARSET (c);
  int codepage;
1011
  int unicode_p = 0;
1012
  int internal_two_byte_p = 0;
1013

1014 1015
  XFontStruct *font = font_info->font;

1016
  internal_two_byte_p = w32_font_is_double_byte (font);
1017

1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
  /* 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;
1029
	  ccl->reg[1] = XCHAR2B_BYTE2 (char2b);
1030
	  ccl->reg[2] = -1;
1031 1032 1033 1034
	}
      else
	{
	  ccl->reg[0] = charset;
1035 1036
	  ccl->reg[1] = XCHAR2B_BYTE1 (char2b);
	  ccl->reg[2] = XCHAR2B_BYTE2 (char2b);
1037 1038 1039 1040 1041 1042
	}

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

      /* We assume that MSBs are appropriately set/reset by CCL
	 program.  */
1043
      if (!internal_two_byte_p)	/* 1-byte font */
1044
	STORE_XCHAR2B (char2b, 0, ccl->reg[1]);
1045
      else
1046
	STORE_XCHAR2B (char2b, ccl->reg[1], ccl->reg[2]);
1047 1048 1049 1050 1051 1052
    }
  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];
1053

1054 1055
      if ((enc == 1 || enc == 2)
	  && CHARSET_DIMENSION (charset) == 2)
1056
	STORE_XCHAR2B (char2b, XCHAR2B_BYTE1 (char2b) | 0x80, XCHAR2B_BYTE2 (char2b));
1057

1058 1059
      if (enc == 1 || enc == 3
          || (enc == 4 && CHARSET_DIMENSION (charset) == 1))
1060
	STORE_XCHAR2B (char2b, XCHAR2B_BYTE1 (char2b), XCHAR2B_BYTE2 (char2b) | 0x80);
1061 1062 1063 1064
      else if (enc == 4)
        {
          int sjis1, sjis2;

1065
          ENCODE_SJIS (XCHAR2B_BYTE1 (char2b), XCHAR2B_BYTE2 (char2b),
1066
                       sjis1, sjis2);
1067
          STORE_XCHAR2B (char2b, sjis1, sjis2);
1068 1069
        }
    }
1070
  codepage = font_info->codepage;
1071 1072 1073 1074

  /* 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)
1075 1076
       && charset != CHARSET_ASCII && charset != charset_latin_iso8859_1
       && charset != CHARSET_8_BIT_CONTROL && charset != CHARSET_8_BIT_GRAPHIC)
1077 1078
    {
      char temp[3];
1079 1080
      temp[0] = XCHAR2B_BYTE1 (char2b);
      temp[1] = XCHAR2B_BYTE2 (char2b);
1081
      temp[2] = '\0';
1082 1083 1084 1085 1086 1087 1088
      if (codepage != CP_UNICODE)
        {
          if (temp[0])
            MultiByteToWideChar (codepage, 0, temp, 2, char2b, 1);
          else
            MultiByteToWideChar (codepage, 0, temp+1, 1, char2b, 1);
        }
1089
      unicode_p = 1;
1090
      internal_two_byte_p = 1;
1091
    }
1092 1093 1094 1095

  if (two_byte_p)
    *two_byte_p = internal_two_byte_p;

1096 1097
  if (!font)
    return UNKNOWN_FONT;
1098 1099
  else if (font->bdf && CHARSET_DIMENSION (charset) == 1)
    return BDF_1D_FONT;
1100
  else if (font->bdf)
1101
    return BDF_2D_FONT;
1102 1103 1104 1105
  else if (unicode_p)
    return UNICODE_FONT;
  else
    return ANSI_FONT;
1106 1107 1108
}


Geoff Voelker's avatar
Geoff Voelker committed
1109

1110 1111 1112 1113 1114
/***********************************************************************
			    Glyph display
 ***********************************************************************/


1115
/* Encapsulate the different ways of displaying text under W32.  */
1116

1117 1118
static void
w32_text_out (s, x, y,chars,nchars)
1119 1120 1121 1122 1123
     struct glyph_string * s;
     int x, y;
     wchar_t * chars;
     int nchars;
{
1124 1125 1126
  int charset_dim = w32_font_is_double_byte (s->font) ? 2 : 1;
  if (s->font->bdf)
    w32_BDF_TextOut (s->font->bdf, s->hdc,
1127 1128
                     x, y, (char *) chars, charset_dim,
                     nchars * charset_dim, 0);
1129
  else if (s->first_glyph->font_type == UNICODE_FONT)
1130 1131
    ExtTextOutW (s->hdc, x, y, 0, NULL, chars, nchars, NULL);
  else
1132 1133
    ExtTextOutA (s->hdc, x, y, 0, NULL, (char *) chars,
		 nchars * charset_dim, NULL);
1134 1135
}

1136 1137


1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
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 *));
1163 1164 1165 1166

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

1168

1169 1170 1171