Replace "Maintainer: FSF" with the emacs-devel mailing address
[bpt/emacs.git] / src / w32fns.c
CommitLineData
b46a6a83 1/* Graphical user interface functions for the Microsoft Windows API.
7c051dd8 2
ba318903 3Copyright (C) 1989, 1992-2014 Free Software Foundation, Inc.
ee78dc32
GV
4
5This file is part of GNU Emacs.
6
9ec0b715 7GNU Emacs is free software: you can redistribute it and/or modify
ee78dc32 8it under the terms of the GNU General Public License as published by
9ec0b715
GM
9the Free Software Foundation, either version 3 of the License, or
10(at your option) any later version.
ee78dc32
GV
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
9ec0b715 18along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
ee78dc32
GV
19
20/* Added by Kevin Gallo */
21
ee78dc32 22#include <config.h>
1edf84e7
GV
23
24#include <signal.h>
ee78dc32 25#include <stdio.h>
1edf84e7
GV
26#include <limits.h>
27#include <errno.h>
b00afeae 28#include <math.h>
1005b4b9 29#include <fcntl.h>
c8e3a9c3 30#include <unistd.h>
ee78dc32
GV
31
32#include "lisp.h"
33#include "w32term.h"
34#include "frame.h"
35#include "window.h"
e5560ff7 36#include "character.h"
ee78dc32 37#include "buffer.h"
6fc2811b 38#include "intervals.h"
10b4bc33
JR
39#include "dispextern.h"
40#include "keyboard.h"
ee78dc32 41#include "blockinput.h"
57bda87a 42#include "epaths.h"
10b4bc33 43#include "charset.h"
4587b026 44#include "coding.h"
3545439c 45#include "ccl.h"
10b4bc33 46#include "fontset.h"
6fc2811b 47#include "systime.h"
10b4bc33 48#include "termhooks.h"
0fda9b75 49
501199a3
DC
50#include "w32common.h"
51
52#ifdef WINDOWSNT
10b4bc33 53#include "w32heap.h"
2c47be65 54#include <mbstring.h>
501199a3 55#endif /* WINDOWSNT */
0fda9b75
DC
56
57#if CYGWIN
58#include "cygw32.h"
59#else
5cba3209 60#include "w32.h"
0fda9b75 61#endif
6fc2811b
JR
62
63#include "bitmaps/gray.xbm"
ee78dc32 64
60860eb3 65#include <commctrl.h>
ee78dc32 66#include <commdlg.h>
cb9e33d4 67#include <shellapi.h>
6fc2811b 68#include <ctype.h>
6b61353c 69#include <winspool.h>
d5781bb6 70#include <objbase.h>
ee78dc32 71
1030b26b 72#include <dlgs.h>
820eff5a 73#include <imm.h>
1030b26b 74
a1fe5c00 75#include "font.h"
1cc06b86 76#include "w32font.h"
a1fe5c00 77
6cf29fe8
JR
78#ifndef FOF_NO_CONNECTED_ELEMENTS
79#define FOF_NO_CONNECTED_ELEMENTS 0x2000
80#endif
81
b56ceb92
JB
82void syms_of_w32fns (void);
83void globals_of_w32fns (void);
9785d95b 84
b56ceb92 85extern void free_frame_menubar (struct frame *);
f57e2426
J
86extern int w32_console_toggle_lock_key (int, Lisp_Object);
87extern void w32_menu_display_help (HWND, HMENU, UINT, UINT);
88extern void w32_free_menu_strings (HWND);
89extern const char *map_w32_filename (const char *, const char **);
0fda9b75 90extern char * w32_strerror (int error_no);
9eb16b62 91
c06c382a 92/* If non-NULL, a handle to a frame where to display the hourglass cursor. */
d148e14d
JR
93static HWND hourglass_hwnd = NULL;
94
c9b2104d
JR
95#ifndef IDC_HAND
96#define IDC_HAND MAKEINTRESOURCE(32649)
97#endif
98
ee78dc32 99Lisp_Object Qsuppress_icon;
ee78dc32 100Lisp_Object Qundefined_color;
dc220243 101Lisp_Object Qcancel_timer;
27129af9 102Lisp_Object Qfont_param;
adcc3809
GV
103Lisp_Object Qhyper;
104Lisp_Object Qsuper;
105Lisp_Object Qmeta;
106Lisp_Object Qalt;
107Lisp_Object Qctrl;
108Lisp_Object Qcontrol;
109Lisp_Object Qshift;
cf13177e 110static Lisp_Object Qgeometry, Qworkarea, Qmm_size, Qframes;
adcc3809 111
dfff8a69 112
5a8a15ec
JR
113/* Prefix for system colors. */
114#define SYSTEM_COLOR_PREFIX "System"
115#define SYSTEM_COLOR_PREFIX_LEN (sizeof (SYSTEM_COLOR_PREFIX) - 1)
116
5ac45f98
GV
117/* State variables for emulating a three button mouse. */
118#define LMOUSE 1
119#define MMOUSE 2
120#define RMOUSE 4
121
122static int button_state = 0;
fbd6baed 123static W32Msg saved_mouse_button_msg;
48094ace 124static unsigned mouse_button_timer = 0; /* non-zero when timer is active */
fbd6baed 125static W32Msg saved_mouse_move_msg;
48094ace 126static unsigned mouse_move_timer = 0;
84fb1139 127
9eb16b62
JR
128/* Window that is tracking the mouse. */
129static HWND track_mouse_window;
f60ae425 130
64f0809d
JR
131/* Multi-monitor API definitions that are not pulled from the headers
132 since we are compiling for NT 4. */
133#ifndef MONITOR_DEFAULT_TO_NEAREST
134#define MONITOR_DEFAULT_TO_NEAREST 2
135#endif
cf13177e
YM
136#ifndef MONITORINFOF_PRIMARY
137#define MONITORINFOF_PRIMARY 1
138#endif
139#ifndef SM_XVIRTUALSCREEN
140#define SM_XVIRTUALSCREEN 76
141#endif
142#ifndef SM_YVIRTUALSCREEN
143#define SM_YVIRTUALSCREEN 77
144#endif
64f0809d
JR
145/* MinGW headers define MONITORINFO unconditionally, but MSVC ones don't.
146 To avoid a compile error on one or the other, redefine with a new name. */
147struct MONITOR_INFO
148{
149 DWORD cbSize;
150 RECT rcMonitor;
151 RECT rcWork;
152 DWORD dwFlags;
153};
154
cf13177e
YM
155#ifndef CCHDEVICENAME
156#define CCHDEVICENAME 32
157#endif
158struct MONITOR_INFO_EX
159{
160 DWORD cbSize;
161 RECT rcMonitor;
162 RECT rcWork;
163 DWORD dwFlags;
164 char szDevice[CCHDEVICENAME];
165};
166
a6fc3b5c 167/* Reportedly, MSVC does not have this in its headers. */
62aba0d4 168#if defined (_MSC_VER) && _WIN32_WINNT < 0x0500
8e764ce0
EZ
169DECLARE_HANDLE(HMONITOR);
170#endif
171
ccc0fdaa
JR
172typedef BOOL (WINAPI * TrackMouseEvent_Proc)
173 (IN OUT LPTRACKMOUSEEVENT lpEventTrack);
820eff5a
JR
174typedef LONG (WINAPI * ImmGetCompositionString_Proc)
175 (IN HIMC context, IN DWORD index, OUT LPVOID buffer, IN DWORD bufLen);
176typedef HIMC (WINAPI * ImmGetContext_Proc) (IN HWND window);
c902b920
JR
177typedef HWND (WINAPI * ImmReleaseContext_Proc) (IN HWND wnd, IN HIMC context);
178typedef HWND (WINAPI * ImmSetCompositionWindow_Proc) (IN HIMC context,
179 IN COMPOSITIONFORM *form);
64f0809d
JR
180typedef HMONITOR (WINAPI * MonitorFromPoint_Proc) (IN POINT pt, IN DWORD flags);
181typedef BOOL (WINAPI * GetMonitorInfo_Proc)
182 (IN HMONITOR monitor, OUT struct MONITOR_INFO* info);
1f635a07
EC
183typedef HMONITOR (WINAPI * MonitorFromWindow_Proc)
184 (IN HWND hwnd, IN DWORD dwFlags);
cf13177e
YM
185typedef BOOL CALLBACK (* MonitorEnum_Proc)
186 (IN HMONITOR monitor, IN HDC hdc, IN RECT *rcMonitor, IN LPARAM dwData);
187typedef BOOL (WINAPI * EnumDisplayMonitors_Proc)
188 (IN HDC hdc, IN RECT *rcClip, IN MonitorEnum_Proc fnEnum, IN LPARAM dwData);
f60ae425 189
ccc0fdaa 190TrackMouseEvent_Proc track_mouse_event_fn = NULL;
820eff5a
JR
191ImmGetCompositionString_Proc get_composition_string_fn = NULL;
192ImmGetContext_Proc get_ime_context_fn = NULL;
c902b920
JR
193ImmReleaseContext_Proc release_ime_context_fn = NULL;
194ImmSetCompositionWindow_Proc set_ime_composition_window_fn = NULL;
64f0809d
JR
195MonitorFromPoint_Proc monitor_from_point_fn = NULL;
196GetMonitorInfo_Proc get_monitor_info_fn = NULL;
1f635a07 197MonitorFromWindow_Proc monitor_from_window_fn = NULL;
cf13177e 198EnumDisplayMonitors_Proc enum_display_monitors_fn = NULL;
820eff5a 199
0fda9b75
DC
200#ifdef NTGUI_UNICODE
201#define unicode_append_menu AppendMenuW
202#else /* !NTGUI_UNICODE */
b4005349 203extern AppendMenuW_Proc unicode_append_menu;
0fda9b75 204#endif /* NTGUI_UNICODE */
9eb16b62 205
820eff5a
JR
206/* Flag to selectively ignore WM_IME_CHAR messages. */
207static int ignore_ime_char = 0;
208
93fbe8b7 209/* W95 mousewheel handler */
7d0393cf 210unsigned int msh_mousewheel = 0;
93fbe8b7 211
48094ace 212/* Timers */
84fb1139
KH
213#define MOUSE_BUTTON_ID 1
214#define MOUSE_MOVE_ID 2
48094ace
JR
215#define MENU_FREE_ID 3
216/* The delay (milliseconds) before a menu is freed after WM_EXITMENULOOP
217 is received. */
218#define MENU_FREE_DELAY 1000
219static unsigned menu_free_timer = 0;
5ac45f98 220
e509cfa6 221#ifdef GLYPH_DEBUG
85fece3e 222static int image_cache_refcount, dpyinfo_refcount;
937e601e
AI
223#endif
224
d285988b 225static HWND w32_visible_system_caret_hwnd;
65906840 226
9b855fd6
EZ
227static int w32_unicode_gui;
228
5d22ded9
JR
229/* From w32menu.c */
230extern HMENU current_popup_menu;
58e55497 231static int menubar_in_use = 0;
5d22ded9 232
cbfedb1c 233/* From w32uniscribe.c */
b56ceb92 234extern void syms_of_w32uniscribe (void);
cbfedb1c 235extern int uniscribe_available;
cbfedb1c 236
d148e14d 237/* Function prototypes for hourglass support. */
f57e2426
J
238static void w32_show_hourglass (struct frame *);
239static void w32_hide_hourglass (void);
d148e14d 240
0fda9b75 241#ifdef WINDOWSNT
791ef5f8 242/* From w32inevt.c */
0fda9b75
DC
243extern int faked_key;
244#endif /* WINDOWSNT */
245
246/* This gives us the page size and the size of the allocation unit on NT. */
247SYSTEM_INFO sysinfo_cache;
248
249/* This gives us version, build, and platform identification. */
250OSVERSIONINFO osinfo_cache;
251
c7b36b95 252DWORD_PTR syspage_mask = 0;
0fda9b75
DC
253
254/* The major and minor versions of NT. */
255int w32_major_version;
256int w32_minor_version;
257int w32_build_number;
258
259/* Distinguish between Windows NT and Windows 95. */
260int os_subtype;
261
262#ifdef HAVE_NTGUI
263HINSTANCE hinst = NULL;
264#endif
265
266static unsigned int sound_type = 0xFFFFFFFF;
267#define MB_EMACS_SILENT (0xFFFFFFFF - 1)
d148e14d 268
7d0393cf 269/* Let the user specify a display with a frame.
fbd6baed 270 nil stands for the selected frame--or, if that is not a w32 frame,
ee78dc32
GV
271 the first display on the list. */
272
6d906347 273struct w32_display_info *
b56ceb92 274check_x_display_info (Lisp_Object frame)
ee78dc32
GV
275{
276 if (NILP (frame))
277 {
6fc2811b 278 struct frame *sf = XFRAME (selected_frame);
7d0393cf 279
6fc2811b 280 if (FRAME_W32_P (sf) && FRAME_LIVE_P (sf))
aad3612f 281 return FRAME_DISPLAY_INFO (sf);
ee78dc32 282 else
fbd6baed 283 return &one_w32_display_info;
ee78dc32
GV
284 }
285 else if (STRINGP (frame))
286 return x_display_info_for_name (frame);
287 else
288 {
a10c8269 289 struct frame *f;
ee78dc32 290
b7826503 291 CHECK_LIVE_FRAME (frame);
ee78dc32 292 f = XFRAME (frame);
fbd6baed 293 if (! FRAME_W32_P (f))
21517c3d 294 error ("Non-W32 frame used");
aad3612f 295 return FRAME_DISPLAY_INFO (f);
ee78dc32
GV
296 }
297}
298\f
fbd6baed 299/* Return the Emacs frame-object corresponding to an w32 window.
ee78dc32
GV
300 It could be the frame's main window or an icon window. */
301
ee78dc32 302struct frame *
b56ceb92 303x_window_to_frame (struct w32_display_info *dpyinfo, HWND wdesc)
ee78dc32
GV
304{
305 Lisp_Object tail, frame;
306 struct frame *f;
307
5b04e9f9 308 FOR_EACH_FRAME (tail, frame)
ee78dc32 309 {
ee78dc32 310 f = XFRAME (frame);
aad3612f 311 if (!FRAME_W32_P (f) || FRAME_DISPLAY_INFO (f) != dpyinfo)
ee78dc32 312 continue;
f79e6790 313
fbd6baed 314 if (FRAME_W32_WINDOW (f) == wdesc)
ee78dc32
GV
315 return f;
316 }
317 return 0;
318}
319
320\f
f57e2426 321static Lisp_Object unwind_create_frame (Lisp_Object);
b1dc4084 322static void unwind_create_tip_frame (Lisp_Object);
f57e2426
J
323static void my_create_window (struct frame *);
324static void my_create_tip_window (struct frame *);
6d906347 325
767b1ff0 326/* TODO: Native Input Method support; see x_create_im. */
f57e2426
J
327void x_set_foreground_color (struct frame *, Lisp_Object, Lisp_Object);
328void x_set_background_color (struct frame *, Lisp_Object, Lisp_Object);
329void x_set_mouse_color (struct frame *, Lisp_Object, Lisp_Object);
330void x_set_cursor_color (struct frame *, Lisp_Object, Lisp_Object);
331void x_set_border_color (struct frame *, Lisp_Object, Lisp_Object);
332void x_set_cursor_type (struct frame *, Lisp_Object, Lisp_Object);
333void x_set_icon_type (struct frame *, Lisp_Object, Lisp_Object);
334void x_set_icon_name (struct frame *, Lisp_Object, Lisp_Object);
335void x_explicitly_set_name (struct frame *, Lisp_Object, Lisp_Object);
336void x_set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
337void x_set_title (struct frame *, Lisp_Object, Lisp_Object);
338void x_set_tool_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
ee78dc32 339
ee78dc32 340
ee78dc32 341\f
ee78dc32
GV
342
343/* Store the screen positions of frame F into XPTR and YPTR.
344 These are the positions of the containing window manager window,
345 not Emacs's own window. */
346
347void
a10c8269 348x_real_positions (struct frame *f, int *xptr, int *yptr)
ee78dc32
GV
349{
350 POINT pt;
f7b9d4d1 351 RECT rect;
3c190163 352
ee04257d
JR
353 /* Get the bounds of the WM window. */
354 GetWindowRect (FRAME_W32_WINDOW (f), &rect);
f7b9d4d1 355
ee04257d
JR
356 pt.x = 0;
357 pt.y = 0;
ee78dc32 358
ee04257d
JR
359 /* Convert (0, 0) in the client area to screen co-ordinates. */
360 ClientToScreen (FRAME_W32_WINDOW (f), &pt);
ee78dc32 361
f7b9d4d1 362 /* Remember x_pixels_diff and y_pixels_diff. */
be786000
KS
363 f->x_pixels_diff = pt.x - rect.left;
364 f->y_pixels_diff = pt.y - rect.top;
f7b9d4d1 365
ee04257d
JR
366 *xptr = rect.left;
367 *yptr = rect.top;
ee78dc32
GV
368}
369
1f635a07
EC
370/* Returns the window rectangle appropriate for the given fullscreen mode.
371 The normal rect parameter was the window's rectangle prior to entering
372 fullscreen mode. If multiple monitor support is available, the nearest
373 monitor to the window is chosen. */
374
375void
376w32_fullscreen_rect (HWND hwnd, int fsmode, RECT normal, RECT *rect)
377{
378 struct MONITOR_INFO mi = { sizeof(mi) };
379 if (monitor_from_window_fn && get_monitor_info_fn)
380 {
381 HMONITOR monitor =
382 monitor_from_window_fn (hwnd, MONITOR_DEFAULT_TO_NEAREST);
383 get_monitor_info_fn (monitor, &mi);
384 }
385 else
386 {
387 mi.rcMonitor.left = 0;
388 mi.rcMonitor.top = 0;
389 mi.rcMonitor.right = GetSystemMetrics (SM_CXSCREEN);
390 mi.rcMonitor.bottom = GetSystemMetrics (SM_CYSCREEN);
391 mi.rcWork.left = 0;
392 mi.rcWork.top = 0;
393 mi.rcWork.right = GetSystemMetrics (SM_CXMAXIMIZED);
394 mi.rcWork.bottom = GetSystemMetrics (SM_CYMAXIMIZED);
395 }
396
397 switch (fsmode)
398 {
399 case FULLSCREEN_BOTH:
400 rect->left = mi.rcMonitor.left;
401 rect->top = mi.rcMonitor.top;
402 rect->right = mi.rcMonitor.right;
403 rect->bottom = mi.rcMonitor.bottom;
404 break;
1f635a07
EC
405 case FULLSCREEN_WIDTH:
406 rect->left = mi.rcWork.left;
407 rect->top = normal.top;
408 rect->right = mi.rcWork.right;
409 rect->bottom = normal.bottom;
410 break;
411 case FULLSCREEN_HEIGHT:
412 rect->left = normal.left;
413 rect->top = mi.rcWork.top;
414 rect->right = normal.right;
415 rect->bottom = mi.rcWork.bottom;
416 break;
1f635a07
EC
417 default:
418 *rect = normal;
419 break;
420 }
421}
422
ee78dc32
GV
423\f
424
74e1aeec
JR
425DEFUN ("w32-define-rgb-color", Fw32_define_rgb_color,
426 Sw32_define_rgb_color, 4, 4, 0,
23f250f4 427 doc: /* Convert RGB numbers to a Windows color reference and associate with NAME.
02b39a28 428This adds or updates a named color to `w32-color-map', making it
74e1aeec
JR
429available for use. The original entry's RGB ref is returned, or nil
430if the entry is new. */)
5842a27b 431 (Lisp_Object red, Lisp_Object green, Lisp_Object blue, Lisp_Object name)
ee78dc32 432{
5ac45f98
GV
433 Lisp_Object rgb;
434 Lisp_Object oldrgb = Qnil;
435 Lisp_Object entry;
436
b7826503
PJ
437 CHECK_NUMBER (red);
438 CHECK_NUMBER (green);
439 CHECK_NUMBER (blue);
440 CHECK_STRING (name);
ee78dc32 441
74084731 442 XSETINT (rgb, RGB (XUINT (red), XUINT (green), XUINT (blue)));
ee78dc32 443
4d7e6e51 444 block_input ();
ee78dc32 445
fbd6baed
GV
446 /* replace existing entry in w32-color-map or add new entry. */
447 entry = Fassoc (name, Vw32_color_map);
5ac45f98
GV
448 if (NILP (entry))
449 {
450 entry = Fcons (name, rgb);
fbd6baed 451 Vw32_color_map = Fcons (entry, Vw32_color_map);
5ac45f98
GV
452 }
453 else
454 {
455 oldrgb = Fcdr (entry);
456 Fsetcdr (entry, rgb);
457 }
458
4d7e6e51 459 unblock_input ();
5ac45f98
GV
460
461 return (oldrgb);
ee78dc32
GV
462}
463
fbd6baed 464/* The default colors for the w32 color map */
7d0393cf 465typedef struct colormap_t
ee78dc32
GV
466{
467 char *name;
468 COLORREF colorref;
469} colormap_t;
470
7d0393cf 471colormap_t w32_color_map[] =
ee78dc32 472{
1da8a614
GV
473 {"snow" , PALETTERGB (255,250,250)},
474 {"ghost white" , PALETTERGB (248,248,255)},
475 {"GhostWhite" , PALETTERGB (248,248,255)},
476 {"white smoke" , PALETTERGB (245,245,245)},
477 {"WhiteSmoke" , PALETTERGB (245,245,245)},
478 {"gainsboro" , PALETTERGB (220,220,220)},
479 {"floral white" , PALETTERGB (255,250,240)},
480 {"FloralWhite" , PALETTERGB (255,250,240)},
481 {"old lace" , PALETTERGB (253,245,230)},
482 {"OldLace" , PALETTERGB (253,245,230)},
483 {"linen" , PALETTERGB (250,240,230)},
484 {"antique white" , PALETTERGB (250,235,215)},
485 {"AntiqueWhite" , PALETTERGB (250,235,215)},
486 {"papaya whip" , PALETTERGB (255,239,213)},
487 {"PapayaWhip" , PALETTERGB (255,239,213)},
488 {"blanched almond" , PALETTERGB (255,235,205)},
489 {"BlanchedAlmond" , PALETTERGB (255,235,205)},
490 {"bisque" , PALETTERGB (255,228,196)},
491 {"peach puff" , PALETTERGB (255,218,185)},
492 {"PeachPuff" , PALETTERGB (255,218,185)},
493 {"navajo white" , PALETTERGB (255,222,173)},
494 {"NavajoWhite" , PALETTERGB (255,222,173)},
495 {"moccasin" , PALETTERGB (255,228,181)},
496 {"cornsilk" , PALETTERGB (255,248,220)},
497 {"ivory" , PALETTERGB (255,255,240)},
498 {"lemon chiffon" , PALETTERGB (255,250,205)},
499 {"LemonChiffon" , PALETTERGB (255,250,205)},
500 {"seashell" , PALETTERGB (255,245,238)},
501 {"honeydew" , PALETTERGB (240,255,240)},
502 {"mint cream" , PALETTERGB (245,255,250)},
503 {"MintCream" , PALETTERGB (245,255,250)},
504 {"azure" , PALETTERGB (240,255,255)},
505 {"alice blue" , PALETTERGB (240,248,255)},
506 {"AliceBlue" , PALETTERGB (240,248,255)},
507 {"lavender" , PALETTERGB (230,230,250)},
508 {"lavender blush" , PALETTERGB (255,240,245)},
509 {"LavenderBlush" , PALETTERGB (255,240,245)},
510 {"misty rose" , PALETTERGB (255,228,225)},
511 {"MistyRose" , PALETTERGB (255,228,225)},
512 {"white" , PALETTERGB (255,255,255)},
513 {"black" , PALETTERGB ( 0, 0, 0)},
514 {"dark slate gray" , PALETTERGB ( 47, 79, 79)},
515 {"DarkSlateGray" , PALETTERGB ( 47, 79, 79)},
516 {"dark slate grey" , PALETTERGB ( 47, 79, 79)},
517 {"DarkSlateGrey" , PALETTERGB ( 47, 79, 79)},
518 {"dim gray" , PALETTERGB (105,105,105)},
519 {"DimGray" , PALETTERGB (105,105,105)},
520 {"dim grey" , PALETTERGB (105,105,105)},
521 {"DimGrey" , PALETTERGB (105,105,105)},
522 {"slate gray" , PALETTERGB (112,128,144)},
523 {"SlateGray" , PALETTERGB (112,128,144)},
524 {"slate grey" , PALETTERGB (112,128,144)},
525 {"SlateGrey" , PALETTERGB (112,128,144)},
526 {"light slate gray" , PALETTERGB (119,136,153)},
527 {"LightSlateGray" , PALETTERGB (119,136,153)},
528 {"light slate grey" , PALETTERGB (119,136,153)},
529 {"LightSlateGrey" , PALETTERGB (119,136,153)},
530 {"gray" , PALETTERGB (190,190,190)},
531 {"grey" , PALETTERGB (190,190,190)},
532 {"light grey" , PALETTERGB (211,211,211)},
533 {"LightGrey" , PALETTERGB (211,211,211)},
534 {"light gray" , PALETTERGB (211,211,211)},
535 {"LightGray" , PALETTERGB (211,211,211)},
536 {"midnight blue" , PALETTERGB ( 25, 25,112)},
537 {"MidnightBlue" , PALETTERGB ( 25, 25,112)},
538 {"navy" , PALETTERGB ( 0, 0,128)},
539 {"navy blue" , PALETTERGB ( 0, 0,128)},
540 {"NavyBlue" , PALETTERGB ( 0, 0,128)},
541 {"cornflower blue" , PALETTERGB (100,149,237)},
542 {"CornflowerBlue" , PALETTERGB (100,149,237)},
543 {"dark slate blue" , PALETTERGB ( 72, 61,139)},
544 {"DarkSlateBlue" , PALETTERGB ( 72, 61,139)},
545 {"slate blue" , PALETTERGB (106, 90,205)},
546 {"SlateBlue" , PALETTERGB (106, 90,205)},
547 {"medium slate blue" , PALETTERGB (123,104,238)},
548 {"MediumSlateBlue" , PALETTERGB (123,104,238)},
549 {"light slate blue" , PALETTERGB (132,112,255)},
550 {"LightSlateBlue" , PALETTERGB (132,112,255)},
551 {"medium blue" , PALETTERGB ( 0, 0,205)},
552 {"MediumBlue" , PALETTERGB ( 0, 0,205)},
553 {"royal blue" , PALETTERGB ( 65,105,225)},
554 {"RoyalBlue" , PALETTERGB ( 65,105,225)},
555 {"blue" , PALETTERGB ( 0, 0,255)},
556 {"dodger blue" , PALETTERGB ( 30,144,255)},
557 {"DodgerBlue" , PALETTERGB ( 30,144,255)},
558 {"deep sky blue" , PALETTERGB ( 0,191,255)},
559 {"DeepSkyBlue" , PALETTERGB ( 0,191,255)},
560 {"sky blue" , PALETTERGB (135,206,235)},
561 {"SkyBlue" , PALETTERGB (135,206,235)},
562 {"light sky blue" , PALETTERGB (135,206,250)},
563 {"LightSkyBlue" , PALETTERGB (135,206,250)},
564 {"steel blue" , PALETTERGB ( 70,130,180)},
565 {"SteelBlue" , PALETTERGB ( 70,130,180)},
566 {"light steel blue" , PALETTERGB (176,196,222)},
567 {"LightSteelBlue" , PALETTERGB (176,196,222)},
568 {"light blue" , PALETTERGB (173,216,230)},
569 {"LightBlue" , PALETTERGB (173,216,230)},
570 {"powder blue" , PALETTERGB (176,224,230)},
571 {"PowderBlue" , PALETTERGB (176,224,230)},
572 {"pale turquoise" , PALETTERGB (175,238,238)},
573 {"PaleTurquoise" , PALETTERGB (175,238,238)},
574 {"dark turquoise" , PALETTERGB ( 0,206,209)},
575 {"DarkTurquoise" , PALETTERGB ( 0,206,209)},
576 {"medium turquoise" , PALETTERGB ( 72,209,204)},
577 {"MediumTurquoise" , PALETTERGB ( 72,209,204)},
578 {"turquoise" , PALETTERGB ( 64,224,208)},
579 {"cyan" , PALETTERGB ( 0,255,255)},
580 {"light cyan" , PALETTERGB (224,255,255)},
581 {"LightCyan" , PALETTERGB (224,255,255)},
582 {"cadet blue" , PALETTERGB ( 95,158,160)},
583 {"CadetBlue" , PALETTERGB ( 95,158,160)},
584 {"medium aquamarine" , PALETTERGB (102,205,170)},
585 {"MediumAquamarine" , PALETTERGB (102,205,170)},
586 {"aquamarine" , PALETTERGB (127,255,212)},
587 {"dark green" , PALETTERGB ( 0,100, 0)},
588 {"DarkGreen" , PALETTERGB ( 0,100, 0)},
589 {"dark olive green" , PALETTERGB ( 85,107, 47)},
590 {"DarkOliveGreen" , PALETTERGB ( 85,107, 47)},
591 {"dark sea green" , PALETTERGB (143,188,143)},
592 {"DarkSeaGreen" , PALETTERGB (143,188,143)},
593 {"sea green" , PALETTERGB ( 46,139, 87)},
594 {"SeaGreen" , PALETTERGB ( 46,139, 87)},
595 {"medium sea green" , PALETTERGB ( 60,179,113)},
596 {"MediumSeaGreen" , PALETTERGB ( 60,179,113)},
597 {"light sea green" , PALETTERGB ( 32,178,170)},
598 {"LightSeaGreen" , PALETTERGB ( 32,178,170)},
599 {"pale green" , PALETTERGB (152,251,152)},
600 {"PaleGreen" , PALETTERGB (152,251,152)},
601 {"spring green" , PALETTERGB ( 0,255,127)},
602 {"SpringGreen" , PALETTERGB ( 0,255,127)},
603 {"lawn green" , PALETTERGB (124,252, 0)},
604 {"LawnGreen" , PALETTERGB (124,252, 0)},
605 {"green" , PALETTERGB ( 0,255, 0)},
606 {"chartreuse" , PALETTERGB (127,255, 0)},
607 {"medium spring green" , PALETTERGB ( 0,250,154)},
608 {"MediumSpringGreen" , PALETTERGB ( 0,250,154)},
609 {"green yellow" , PALETTERGB (173,255, 47)},
610 {"GreenYellow" , PALETTERGB (173,255, 47)},
611 {"lime green" , PALETTERGB ( 50,205, 50)},
612 {"LimeGreen" , PALETTERGB ( 50,205, 50)},
613 {"yellow green" , PALETTERGB (154,205, 50)},
614 {"YellowGreen" , PALETTERGB (154,205, 50)},
615 {"forest green" , PALETTERGB ( 34,139, 34)},
616 {"ForestGreen" , PALETTERGB ( 34,139, 34)},
617 {"olive drab" , PALETTERGB (107,142, 35)},
618 {"OliveDrab" , PALETTERGB (107,142, 35)},
619 {"dark khaki" , PALETTERGB (189,183,107)},
620 {"DarkKhaki" , PALETTERGB (189,183,107)},
621 {"khaki" , PALETTERGB (240,230,140)},
622 {"pale goldenrod" , PALETTERGB (238,232,170)},
623 {"PaleGoldenrod" , PALETTERGB (238,232,170)},
624 {"light goldenrod yellow" , PALETTERGB (250,250,210)},
625 {"LightGoldenrodYellow" , PALETTERGB (250,250,210)},
626 {"light yellow" , PALETTERGB (255,255,224)},
627 {"LightYellow" , PALETTERGB (255,255,224)},
628 {"yellow" , PALETTERGB (255,255, 0)},
629 {"gold" , PALETTERGB (255,215, 0)},
630 {"light goldenrod" , PALETTERGB (238,221,130)},
631 {"LightGoldenrod" , PALETTERGB (238,221,130)},
632 {"goldenrod" , PALETTERGB (218,165, 32)},
633 {"dark goldenrod" , PALETTERGB (184,134, 11)},
634 {"DarkGoldenrod" , PALETTERGB (184,134, 11)},
635 {"rosy brown" , PALETTERGB (188,143,143)},
636 {"RosyBrown" , PALETTERGB (188,143,143)},
637 {"indian red" , PALETTERGB (205, 92, 92)},
638 {"IndianRed" , PALETTERGB (205, 92, 92)},
639 {"saddle brown" , PALETTERGB (139, 69, 19)},
640 {"SaddleBrown" , PALETTERGB (139, 69, 19)},
641 {"sienna" , PALETTERGB (160, 82, 45)},
642 {"peru" , PALETTERGB (205,133, 63)},
643 {"burlywood" , PALETTERGB (222,184,135)},
644 {"beige" , PALETTERGB (245,245,220)},
645 {"wheat" , PALETTERGB (245,222,179)},
646 {"sandy brown" , PALETTERGB (244,164, 96)},
647 {"SandyBrown" , PALETTERGB (244,164, 96)},
648 {"tan" , PALETTERGB (210,180,140)},
649 {"chocolate" , PALETTERGB (210,105, 30)},
650 {"firebrick" , PALETTERGB (178,34, 34)},
651 {"brown" , PALETTERGB (165,42, 42)},
652 {"dark salmon" , PALETTERGB (233,150,122)},
653 {"DarkSalmon" , PALETTERGB (233,150,122)},
654 {"salmon" , PALETTERGB (250,128,114)},
655 {"light salmon" , PALETTERGB (255,160,122)},
656 {"LightSalmon" , PALETTERGB (255,160,122)},
657 {"orange" , PALETTERGB (255,165, 0)},
658 {"dark orange" , PALETTERGB (255,140, 0)},
659 {"DarkOrange" , PALETTERGB (255,140, 0)},
660 {"coral" , PALETTERGB (255,127, 80)},
661 {"light coral" , PALETTERGB (240,128,128)},
662 {"LightCoral" , PALETTERGB (240,128,128)},
663 {"tomato" , PALETTERGB (255, 99, 71)},
664 {"orange red" , PALETTERGB (255, 69, 0)},
665 {"OrangeRed" , PALETTERGB (255, 69, 0)},
666 {"red" , PALETTERGB (255, 0, 0)},
667 {"hot pink" , PALETTERGB (255,105,180)},
668 {"HotPink" , PALETTERGB (255,105,180)},
669 {"deep pink" , PALETTERGB (255, 20,147)},
670 {"DeepPink" , PALETTERGB (255, 20,147)},
671 {"pink" , PALETTERGB (255,192,203)},
672 {"light pink" , PALETTERGB (255,182,193)},
673 {"LightPink" , PALETTERGB (255,182,193)},
674 {"pale violet red" , PALETTERGB (219,112,147)},
675 {"PaleVioletRed" , PALETTERGB (219,112,147)},
676 {"maroon" , PALETTERGB (176, 48, 96)},
677 {"medium violet red" , PALETTERGB (199, 21,133)},
678 {"MediumVioletRed" , PALETTERGB (199, 21,133)},
679 {"violet red" , PALETTERGB (208, 32,144)},
680 {"VioletRed" , PALETTERGB (208, 32,144)},
681 {"magenta" , PALETTERGB (255, 0,255)},
682 {"violet" , PALETTERGB (238,130,238)},
683 {"plum" , PALETTERGB (221,160,221)},
684 {"orchid" , PALETTERGB (218,112,214)},
685 {"medium orchid" , PALETTERGB (186, 85,211)},
686 {"MediumOrchid" , PALETTERGB (186, 85,211)},
687 {"dark orchid" , PALETTERGB (153, 50,204)},
688 {"DarkOrchid" , PALETTERGB (153, 50,204)},
689 {"dark violet" , PALETTERGB (148, 0,211)},
690 {"DarkViolet" , PALETTERGB (148, 0,211)},
691 {"blue violet" , PALETTERGB (138, 43,226)},
692 {"BlueViolet" , PALETTERGB (138, 43,226)},
693 {"purple" , PALETTERGB (160, 32,240)},
694 {"medium purple" , PALETTERGB (147,112,219)},
695 {"MediumPurple" , PALETTERGB (147,112,219)},
696 {"thistle" , PALETTERGB (216,191,216)},
697 {"gray0" , PALETTERGB ( 0, 0, 0)},
698 {"grey0" , PALETTERGB ( 0, 0, 0)},
699 {"dark grey" , PALETTERGB (169,169,169)},
700 {"DarkGrey" , PALETTERGB (169,169,169)},
701 {"dark gray" , PALETTERGB (169,169,169)},
702 {"DarkGray" , PALETTERGB (169,169,169)},
703 {"dark blue" , PALETTERGB ( 0, 0,139)},
704 {"DarkBlue" , PALETTERGB ( 0, 0,139)},
705 {"dark cyan" , PALETTERGB ( 0,139,139)},
706 {"DarkCyan" , PALETTERGB ( 0,139,139)},
707 {"dark magenta" , PALETTERGB (139, 0,139)},
708 {"DarkMagenta" , PALETTERGB (139, 0,139)},
709 {"dark red" , PALETTERGB (139, 0, 0)},
710 {"DarkRed" , PALETTERGB (139, 0, 0)},
711 {"light green" , PALETTERGB (144,238,144)},
712 {"LightGreen" , PALETTERGB (144,238,144)},
ee78dc32
GV
713};
714
5430d399
JB
715static Lisp_Object
716w32_default_color_map (void)
ee78dc32
GV
717{
718 int i;
fbd6baed 719 colormap_t *pc = w32_color_map;
ee78dc32 720 Lisp_Object cmap;
7d0393cf 721
4d7e6e51 722 block_input ();
7d0393cf 723
ee78dc32 724 cmap = Qnil;
7d0393cf
JB
725
726 for (i = 0; i < sizeof (w32_color_map) / sizeof (w32_color_map[0]);
ee78dc32
GV
727 pc++, i++)
728 cmap = Fcons (Fcons (build_string (pc->name),
729 make_number (pc->colorref)),
730 cmap);
7d0393cf 731
4d7e6e51 732 unblock_input ();
7d0393cf 733
ee78dc32
GV
734 return (cmap);
735}
ee78dc32 736
5430d399
JB
737DEFUN ("w32-default-color-map", Fw32_default_color_map, Sw32_default_color_map,
738 0, 0, 0, doc: /* Return the default color map. */)
739 (void)
740{
741 return w32_default_color_map ();
742}
743
2ba49441 744static Lisp_Object
b6f4e300 745w32_color_map_lookup (const char *colorname)
5d7fed93
GV
746{
747 Lisp_Object tail, ret = Qnil;
748
4d7e6e51 749 block_input ();
5d7fed93 750
99784d63 751 for (tail = Vw32_color_map; CONSP (tail); tail = XCDR (tail))
5d7fed93
GV
752 {
753 register Lisp_Object elt, tem;
754
99784d63 755 elt = XCAR (tail);
5d7fed93
GV
756 if (!CONSP (elt)) continue;
757
7d7bbefd 758 tem = XCAR (elt);
5d7fed93 759
d5db4077 760 if (lstrcmpi (SDATA (tem), colorname) == 0)
5d7fed93 761 {
2ba49441 762 ret = Fcdr (elt);
5d7fed93
GV
763 break;
764 }
765
766 QUIT;
767 }
768
4d7e6e51 769 unblock_input ();
5d7fed93
GV
770
771 return ret;
772}
773
5a8a15ec
JR
774
775static void
b56ceb92 776add_system_logical_colors_to_map (Lisp_Object *system_colors)
5a8a15ec
JR
777{
778 HKEY colors_key;
779
780 /* Other registry operations are done with input blocked. */
4d7e6e51 781 block_input ();
5a8a15ec
JR
782
783 /* Look for "Control Panel/Colors" under User and Machine registry
784 settings. */
785 if (RegOpenKeyEx (HKEY_CURRENT_USER, "Control Panel\\Colors", 0,
786 KEY_READ, &colors_key) == ERROR_SUCCESS
787 || RegOpenKeyEx (HKEY_LOCAL_MACHINE, "Control Panel\\Colors", 0,
788 KEY_READ, &colors_key) == ERROR_SUCCESS)
789 {
790 /* List all keys. */
791 char color_buffer[64];
792 char full_name_buffer[MAX_PATH + SYSTEM_COLOR_PREFIX_LEN];
793 int index = 0;
794 DWORD name_size, color_size;
795 char *name_buffer = full_name_buffer + SYSTEM_COLOR_PREFIX_LEN;
796
797 name_size = sizeof (full_name_buffer) - SYSTEM_COLOR_PREFIX_LEN;
798 color_size = sizeof (color_buffer);
799
800 strcpy (full_name_buffer, SYSTEM_COLOR_PREFIX);
801
802 while (RegEnumValueA (colors_key, index, name_buffer, &name_size,
803 NULL, NULL, color_buffer, &color_size)
804 == ERROR_SUCCESS)
805 {
806 int r, g, b;
807 if (sscanf (color_buffer, " %u %u %u", &r, &g, &b) == 3)
808 *system_colors = Fcons (Fcons (build_string (full_name_buffer),
809 make_number (RGB (r, g, b))),
810 *system_colors);
811
812 name_size = sizeof (full_name_buffer) - SYSTEM_COLOR_PREFIX_LEN;
813 color_size = sizeof (color_buffer);
814 index++;
815 }
816 RegCloseKey (colors_key);
817 }
818
4d7e6e51 819 unblock_input ();
5a8a15ec
JR
820}
821
822
2ba49441 823static Lisp_Object
b6f4e300 824x_to_w32_color (const char * colorname)
ee78dc32 825{
8edb0a6f
JR
826 register Lisp_Object ret = Qnil;
827
4d7e6e51 828 block_input ();
1edf84e7
GV
829
830 if (colorname[0] == '#')
831 {
832 /* Could be an old-style RGB Device specification. */
b6f4e300
EZ
833 int size = strlen (colorname + 1);
834 char *color = alloca (size + 1);
7d0393cf 835
b6f4e300 836 strcpy (color, colorname + 1);
1edf84e7
GV
837 if (size == 3 || size == 6 || size == 9 || size == 12)
838 {
839 UINT colorval;
840 int i, pos;
841 pos = 0;
842 size /= 3;
843 colorval = 0;
7d0393cf 844
1edf84e7
GV
845 for (i = 0; i < 3; i++)
846 {
847 char *end;
848 char t;
849 unsigned long value;
850
851 /* The check for 'x' in the following conditional takes into
852 account the fact that strtol allows a "0x" in front of
853 our numbers, and we don't. */
74084731 854 if (!isxdigit (color[0]) || color[1] == 'x')
1edf84e7
GV
855 break;
856 t = color[size];
857 color[size] = '\0';
74084731 858 value = strtoul (color, &end, 16);
1edf84e7
GV
859 color[size] = t;
860 if (errno == ERANGE || end - color != size)
861 break;
862 switch (size)
863 {
864 case 1:
865 value = value * 0x10;
866 break;
867 case 2:
868 break;
869 case 3:
870 value /= 0x10;
871 break;
872 case 4:
873 value /= 0x100;
874 break;
875 }
876 colorval |= (value << pos);
877 pos += 0x8;
878 if (i == 2)
879 {
4d7e6e51 880 unblock_input ();
2ba49441
JR
881 XSETINT (ret, colorval);
882 return ret;
1edf84e7
GV
883 }
884 color = end;
885 }
886 }
887 }
74084731 888 else if (strnicmp (colorname, "rgb:", 4) == 0)
1edf84e7 889 {
b6f4e300 890 const char *color;
1edf84e7
GV
891 UINT colorval;
892 int i, pos;
893 pos = 0;
894
895 colorval = 0;
896 color = colorname + 4;
897 for (i = 0; i < 3; i++)
898 {
899 char *end;
900 unsigned long value;
7d0393cf 901
1edf84e7
GV
902 /* The check for 'x' in the following conditional takes into
903 account the fact that strtol allows a "0x" in front of
904 our numbers, and we don't. */
74084731 905 if (!isxdigit (color[0]) || color[1] == 'x')
1edf84e7 906 break;
74084731 907 value = strtoul (color, &end, 16);
1edf84e7
GV
908 if (errno == ERANGE)
909 break;
910 switch (end - color)
911 {
912 case 1:
913 value = value * 0x10 + value;
914 break;
915 case 2:
916 break;
917 case 3:
918 value /= 0x10;
919 break;
920 case 4:
921 value /= 0x100;
922 break;
923 default:
924 value = ULONG_MAX;
925 }
926 if (value == ULONG_MAX)
927 break;
928 colorval |= (value << pos);
929 pos += 0x8;
930 if (i == 2)
931 {
932 if (*end != '\0')
933 break;
4d7e6e51 934 unblock_input ();
2ba49441
JR
935 XSETINT (ret, colorval);
936 return ret;
1edf84e7
GV
937 }
938 if (*end != '/')
939 break;
940 color = end + 1;
941 }
942 }
74084731 943 else if (strnicmp (colorname, "rgbi:", 5) == 0)
1edf84e7
GV
944 {
945 /* This is an RGB Intensity specification. */
b6f4e300 946 const char *color;
1edf84e7
GV
947 UINT colorval;
948 int i, pos;
949 pos = 0;
950
951 colorval = 0;
952 color = colorname + 5;
953 for (i = 0; i < 3; i++)
954 {
955 char *end;
956 double value;
957 UINT val;
958
74084731 959 value = strtod (color, &end);
1edf84e7
GV
960 if (errno == ERANGE)
961 break;
962 if (value < 0.0 || value > 1.0)
963 break;
964 val = (UINT)(0x100 * value);
7d0393cf 965 /* We used 0x100 instead of 0xFF to give a continuous
1edf84e7
GV
966 range between 0.0 and 1.0 inclusive. The next statement
967 fixes the 1.0 case. */
968 if (val == 0x100)
969 val = 0xFF;
970 colorval |= (val << pos);
971 pos += 0x8;
972 if (i == 2)
973 {
974 if (*end != '\0')
975 break;
4d7e6e51 976 unblock_input ();
2ba49441
JR
977 XSETINT (ret, colorval);
978 return ret;
1edf84e7
GV
979 }
980 if (*end != '/')
981 break;
982 color = end + 1;
983 }
984 }
985 /* I am not going to attempt to handle any of the CIE color schemes
986 or TekHVC, since I don't know the algorithms for conversion to
987 RGB. */
f695b4b1
GV
988
989 /* If we fail to lookup the color name in w32_color_map, then check the
7d0393cf 990 colorname to see if it can be crudely approximated: If the X color
f695b4b1
GV
991 ends in a number (e.g., "darkseagreen2"), strip the number and
992 return the result of looking up the base color name. */
993 ret = w32_color_map_lookup (colorname);
7d0393cf 994 if (NILP (ret))
ee78dc32 995 {
f695b4b1 996 int len = strlen (colorname);
ee78dc32 997
7d0393cf 998 if (isdigit (colorname[len - 1]))
f695b4b1 999 {
8b77111c 1000 char *ptr, *approx = alloca (len + 1);
ee78dc32 1001
f695b4b1
GV
1002 strcpy (approx, colorname);
1003 ptr = &approx[len - 1];
7d0393cf 1004 while (ptr > approx && isdigit (*ptr))
f695b4b1 1005 *ptr-- = '\0';
ee78dc32 1006
f695b4b1 1007 ret = w32_color_map_lookup (approx);
ee78dc32 1008 }
ee78dc32 1009 }
7d0393cf 1010
4d7e6e51 1011 unblock_input ();
ee78dc32
GV
1012 return ret;
1013}
1014
5ac45f98 1015void
a10c8269 1016w32_regenerate_palette (struct frame *f)
5ac45f98 1017{
fbd6baed 1018 struct w32_palette_entry * list;
5ac45f98
GV
1019 LOGPALETTE * log_palette;
1020 HPALETTE new_palette;
1021 int i;
1022
1023 /* don't bother trying to create palette if not supported */
aad3612f 1024 if (! FRAME_DISPLAY_INFO (f)->has_palette)
5ac45f98
GV
1025 return;
1026
1027 log_palette = (LOGPALETTE *)
1028 alloca (sizeof (LOGPALETTE) +
aad3612f 1029 FRAME_DISPLAY_INFO (f)->num_colors * sizeof (PALETTEENTRY));
5ac45f98 1030 log_palette->palVersion = 0x300;
aad3612f 1031 log_palette->palNumEntries = FRAME_DISPLAY_INFO (f)->num_colors;
5ac45f98 1032
aad3612f 1033 list = FRAME_DISPLAY_INFO (f)->color_list;
5ac45f98 1034 for (i = 0;
aad3612f 1035 i < FRAME_DISPLAY_INFO (f)->num_colors;
5ac45f98
GV
1036 i++, list = list->next)
1037 log_palette->palPalEntry[i] = list->entry;
1038
1039 new_palette = CreatePalette (log_palette);
1040
1041 enter_crit ();
1042
aad3612f
DA
1043 if (FRAME_DISPLAY_INFO (f)->palette)
1044 DeleteObject (FRAME_DISPLAY_INFO (f)->palette);
1045 FRAME_DISPLAY_INFO (f)->palette = new_palette;
5ac45f98
GV
1046
1047 /* Realize display palette and garbage all frames. */
1048 release_frame_dc (f, get_frame_dc (f));
1049
1050 leave_crit ();
1051}
1052
fbd6baed
GV
1053#define W32_COLOR(pe) RGB (pe.peRed, pe.peGreen, pe.peBlue)
1054#define SET_W32_COLOR(pe, color) \
5ac45f98
GV
1055 do \
1056 { \
1057 pe.peRed = GetRValue (color); \
1058 pe.peGreen = GetGValue (color); \
1059 pe.peBlue = GetBValue (color); \
1060 pe.peFlags = 0; \
1061 } while (0)
1062
1063#if 0
1064/* Keep these around in case we ever want to track color usage. */
1065void
a10c8269 1066w32_map_color (struct frame *f, COLORREF color)
5ac45f98 1067{
aad3612f 1068 struct w32_palette_entry * list = FRAME_DISPLAY_INFO (f)->color_list;
5ac45f98 1069
fbd6baed 1070 if (NILP (Vw32_enable_palette))
5ac45f98
GV
1071 return;
1072
1073 /* check if color is already mapped */
1074 while (list)
1075 {
fbd6baed 1076 if (W32_COLOR (list->entry) == color)
5ac45f98
GV
1077 {
1078 ++list->refcount;
1079 return;
1080 }
1081 list = list->next;
1082 }
1083
1084 /* not already mapped, so add to list and recreate Windows palette */
23f86fce 1085 list = xmalloc (sizeof (struct w32_palette_entry));
fbd6baed 1086 SET_W32_COLOR (list->entry, color);
5ac45f98 1087 list->refcount = 1;
aad3612f
DA
1088 list->next = FRAME_DISPLAY_INFO (f)->color_list;
1089 FRAME_DISPLAY_INFO (f)->color_list = list;
1090 FRAME_DISPLAY_INFO (f)->num_colors++;
5ac45f98
GV
1091
1092 /* set flag that palette must be regenerated */
aad3612f 1093 FRAME_DISPLAY_INFO (f)->regen_palette = TRUE;
5ac45f98
GV
1094}
1095
1096void
a10c8269 1097w32_unmap_color (struct frame *f, COLORREF color)
5ac45f98 1098{
aad3612f
DA
1099 struct w32_palette_entry * list = FRAME_DISPLAY_INFO (f)->color_list;
1100 struct w32_palette_entry **prev = &FRAME_DISPLAY_INFO (f)->color_list;
5ac45f98 1101
fbd6baed 1102 if (NILP (Vw32_enable_palette))
5ac45f98
GV
1103 return;
1104
1105 /* check if color is already mapped */
1106 while (list)
1107 {
fbd6baed 1108 if (W32_COLOR (list->entry) == color)
5ac45f98
GV
1109 {
1110 if (--list->refcount == 0)
1111 {
1112 *prev = list->next;
1113 xfree (list);
aad3612f 1114 FRAME_DISPLAY_INFO (f)->num_colors--;
5ac45f98
GV
1115 break;
1116 }
1117 else
1118 return;
1119 }
1120 prev = &list->next;
1121 list = list->next;
1122 }
1123
1124 /* set flag that palette must be regenerated */
aad3612f 1125 FRAME_DISPLAY_INFO (f)->regen_palette = TRUE;
5ac45f98
GV
1126}
1127#endif
1128
6fc2811b
JR
1129
1130/* Gamma-correct COLOR on frame F. */
1131
1132void
b56ceb92 1133gamma_correct (struct frame *f, COLORREF *color)
6fc2811b
JR
1134{
1135 if (f->gamma)
1136 {
1137 *color = PALETTERGB (
1138 pow (GetRValue (*color) / 255.0, f->gamma) * 255.0 + 0.5,
1139 pow (GetGValue (*color) / 255.0, f->gamma) * 255.0 + 0.5,
1140 pow (GetBValue (*color) / 255.0, f->gamma) * 255.0 + 0.5);
1141 }
1142}
1143
1144
ee78dc32
GV
1145/* Decide if color named COLOR is valid for the display associated with
1146 the selected frame; if so, return the rgb values in COLOR_DEF.
1147 If ALLOC is nonzero, allocate a new colormap cell. */
1148
1149int
a10c8269 1150w32_defined_color (struct frame *f, const char *color, XColor *color_def, int alloc)
ee78dc32
GV
1151{
1152 register Lisp_Object tem;
6fc2811b 1153 COLORREF w32_color_ref;
3c190163 1154
fbd6baed 1155 tem = x_to_w32_color (color);
3c190163 1156
7d0393cf 1157 if (!NILP (tem))
ee78dc32 1158 {
d88c567c
JR
1159 if (f)
1160 {
1161 /* Apply gamma correction. */
1162 w32_color_ref = XUINT (tem);
1163 gamma_correct (f, &w32_color_ref);
1164 XSETINT (tem, w32_color_ref);
1165 }
9badad41
JR
1166
1167 /* Map this color to the palette if it is enabled. */
fbd6baed 1168 if (!NILP (Vw32_enable_palette))
5ac45f98 1169 {
fbd6baed 1170 struct w32_palette_entry * entry =
d88c567c 1171 one_w32_display_info.color_list;
fbd6baed 1172 struct w32_palette_entry ** prev =
d88c567c 1173 &one_w32_display_info.color_list;
7d0393cf 1174
5ac45f98
GV
1175 /* check if color is already mapped */
1176 while (entry)
1177 {
fbd6baed 1178 if (W32_COLOR (entry->entry) == XUINT (tem))
5ac45f98
GV
1179 break;
1180 prev = &entry->next;
1181 entry = entry->next;
1182 }
1183
1184 if (entry == NULL && alloc)
1185 {
1186 /* not already mapped, so add to list */
23f86fce 1187 entry = xmalloc (sizeof (struct w32_palette_entry));
fbd6baed 1188 SET_W32_COLOR (entry->entry, XUINT (tem));
5ac45f98
GV
1189 entry->next = NULL;
1190 *prev = entry;
d88c567c 1191 one_w32_display_info.num_colors++;
5ac45f98
GV
1192
1193 /* set flag that palette must be regenerated */
d88c567c 1194 one_w32_display_info.regen_palette = TRUE;
5ac45f98
GV
1195 }
1196 }
1197 /* Ensure COLORREF value is snapped to nearest color in (default)
1198 palette by simulating the PALETTERGB macro. This works whether
1199 or not the display device has a palette. */
6fc2811b
JR
1200 w32_color_ref = XUINT (tem) | 0x2000000;
1201
6fc2811b 1202 color_def->pixel = w32_color_ref;
197edd35
JR
1203 color_def->red = GetRValue (w32_color_ref) * 256;
1204 color_def->green = GetGValue (w32_color_ref) * 256;
1205 color_def->blue = GetBValue (w32_color_ref) * 256;
6fc2811b 1206
ee78dc32 1207 return 1;
5ac45f98 1208 }
7d0393cf 1209 else
3c190163
GV
1210 {
1211 return 0;
1212 }
ee78dc32
GV
1213}
1214
1215/* Given a string ARG naming a color, compute a pixel value from it
1216 suitable for screen F.
1217 If F is not a color screen, return DEF (default) regardless of what
1218 ARG says. */
1219
1220int
a10c8269 1221x_decode_color (struct frame *f, Lisp_Object arg, int def)
ee78dc32 1222{
6fc2811b 1223 XColor cdef;
ee78dc32 1224
b7826503 1225 CHECK_STRING (arg);
ee78dc32 1226
d5db4077 1227 if (strcmp (SDATA (arg), "black") == 0)
ee78dc32 1228 return BLACK_PIX_DEFAULT (f);
d5db4077 1229 else if (strcmp (SDATA (arg), "white") == 0)
ee78dc32
GV
1230 return WHITE_PIX_DEFAULT (f);
1231
aad3612f 1232 if ((FRAME_DISPLAY_INFO (f)->n_planes * FRAME_DISPLAY_INFO (f)->n_cbits) == 1)
ee78dc32
GV
1233 return def;
1234
6fc2811b 1235 /* w32_defined_color is responsible for coping with failures
ee78dc32 1236 by looking for a near-miss. */
d5db4077 1237 if (w32_defined_color (f, SDATA (arg), &cdef, 1))
6fc2811b 1238 return cdef.pixel;
ee78dc32
GV
1239
1240 /* defined_color failed; return an ultimate default. */
1241 return def;
1242}
1243\f
6fc2811b
JR
1244
1245
ee78dc32
GV
1246/* Functions called only from `x_set_frame_param'
1247 to set individual parameters.
1248
fbd6baed 1249 If FRAME_W32_WINDOW (f) is 0,
ee78dc32
GV
1250 the frame is being created and its window does not exist yet.
1251 In that case, just record the parameter's new value
1252 in the standard place; do not attempt to change the window. */
1253
1254void
b56ceb92 1255x_set_foreground_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
ee78dc32 1256{
3cf3436e
JR
1257 struct w32_output *x = f->output_data.w32;
1258 PIX_TYPE fg, old_fg;
1259
1260 fg = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1261 old_fg = FRAME_FOREGROUND_PIXEL (f);
1262 FRAME_FOREGROUND_PIXEL (f) = fg;
5ac45f98 1263
fbd6baed 1264 if (FRAME_W32_WINDOW (f) != 0)
ee78dc32 1265 {
3cf3436e 1266 if (x->cursor_pixel == old_fg)
1f60c16a
EZ
1267 {
1268 x->cursor_pixel = fg;
1269 x->cursor_gc->background = fg;
1270 }
3cf3436e 1271
6fc2811b 1272 update_face_from_frame_parameter (f, Qforeground_color, arg);
ee78dc32
GV
1273 if (FRAME_VISIBLE_P (f))
1274 redraw_frame (f);
1275 }
1276}
1277
1278void
b56ceb92 1279x_set_background_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
ee78dc32 1280{
6fc2811b 1281 FRAME_BACKGROUND_PIXEL (f)
ee78dc32
GV
1282 = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
1283
fbd6baed 1284 if (FRAME_W32_WINDOW (f) != 0)
ee78dc32 1285 {
6fc2811b
JR
1286 SetWindowLong (FRAME_W32_WINDOW (f), WND_BACKGROUND_INDEX,
1287 FRAME_BACKGROUND_PIXEL (f));
ee78dc32 1288
6fc2811b 1289 update_face_from_frame_parameter (f, Qbackground_color, arg);
ee78dc32
GV
1290
1291 if (FRAME_VISIBLE_P (f))
1292 redraw_frame (f);
1293 }
1294}
1295
1296void
b56ceb92 1297x_set_mouse_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
ee78dc32 1298{
7d63e5e3 1299 Cursor cursor, nontext_cursor, mode_cursor, hand_cursor;
dfc465d3 1300 int count;
ee78dc32
GV
1301 int mask_color;
1302
1303 if (!EQ (Qnil, arg))
fbd6baed 1304 f->output_data.w32->mouse_pixel
ee78dc32 1305 = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
6fc2811b
JR
1306 mask_color = FRAME_BACKGROUND_PIXEL (f);
1307
1308 /* Don't let pointers be invisible. */
fbd6baed 1309 if (mask_color == f->output_data.w32->mouse_pixel
6fc2811b
JR
1310 && mask_color == FRAME_BACKGROUND_PIXEL (f))
1311 f->output_data.w32->mouse_pixel = FRAME_FOREGROUND_PIXEL (f);
ee78dc32 1312
5f004711 1313#if 0 /* TODO : Mouse cursor customization. */
4d7e6e51 1314 block_input ();
ee78dc32
GV
1315
1316 /* It's not okay to crash if the user selects a screwy cursor. */
fadca6c6 1317 count = x_catch_errors (FRAME_W32_DISPLAY (f));
ee78dc32
GV
1318
1319 if (!EQ (Qnil, Vx_pointer_shape))
1320 {
b7826503 1321 CHECK_NUMBER (Vx_pointer_shape);
fbd6baed 1322 cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XINT (Vx_pointer_shape));
ee78dc32
GV
1323 }
1324 else
fbd6baed
GV
1325 cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_xterm);
1326 x_check_errors (FRAME_W32_DISPLAY (f), "bad text pointer cursor: %s");
ee78dc32
GV
1327
1328 if (!EQ (Qnil, Vx_nontext_pointer_shape))
1329 {
b7826503 1330 CHECK_NUMBER (Vx_nontext_pointer_shape);
fbd6baed 1331 nontext_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f),
ee78dc32
GV
1332 XINT (Vx_nontext_pointer_shape));
1333 }
1334 else
fbd6baed
GV
1335 nontext_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_left_ptr);
1336 x_check_errors (FRAME_W32_DISPLAY (f), "bad nontext pointer cursor: %s");
ee78dc32 1337
0af913d7 1338 if (!EQ (Qnil, Vx_hourglass_pointer_shape))
6fc2811b 1339 {
b7826503 1340 CHECK_NUMBER (Vx_hourglass_pointer_shape);
0af913d7
GM
1341 hourglass_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f),
1342 XINT (Vx_hourglass_pointer_shape));
6fc2811b
JR
1343 }
1344 else
0af913d7 1345 hourglass_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_watch);
6fc2811b 1346 x_check_errors (FRAME_W32_DISPLAY (f), "bad busy pointer cursor: %s");
7d0393cf 1347
6fc2811b 1348 x_check_errors (FRAME_W32_DISPLAY (f), "bad nontext pointer cursor: %s");
ee78dc32
GV
1349 if (!EQ (Qnil, Vx_mode_pointer_shape))
1350 {
b7826503 1351 CHECK_NUMBER (Vx_mode_pointer_shape);
fbd6baed 1352 mode_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f),
ee78dc32
GV
1353 XINT (Vx_mode_pointer_shape));
1354 }
1355 else
fbd6baed
GV
1356 mode_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_xterm);
1357 x_check_errors (FRAME_W32_DISPLAY (f), "bad modeline pointer cursor: %s");
ee78dc32
GV
1358
1359 if (!EQ (Qnil, Vx_sensitive_text_pointer_shape))
1360 {
b7826503 1361 CHECK_NUMBER (Vx_sensitive_text_pointer_shape);
7d63e5e3 1362 hand_cursor
fbd6baed 1363 = XCreateFontCursor (FRAME_W32_DISPLAY (f),
ee78dc32
GV
1364 XINT (Vx_sensitive_text_pointer_shape));
1365 }
1366 else
7d63e5e3 1367 hand_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_crosshair);
ee78dc32 1368
4694d762
JR
1369 if (!NILP (Vx_window_horizontal_drag_shape))
1370 {
b7826503 1371 CHECK_NUMBER (Vx_window_horizontal_drag_shape);
4694d762
JR
1372 horizontal_drag_cursor
1373 = XCreateFontCursor (FRAME_X_DISPLAY (f),
1374 XINT (Vx_window_horizontal_drag_shape));
1375 }
1376 else
1377 horizontal_drag_cursor
1378 = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_sb_h_double_arrow);
1379
880e6158
MR
1380 if (!NILP (Vx_window_vertical_drag_shape))
1381 {
1382 CHECK_NUMBER (Vx_window_vertical_drag_shape);
1383 vertical_drag_cursor
1384 = XCreateFontCursor (FRAME_X_DISPLAY (f),
1385 XINT (Vx_window_vertical_drag_shape));
1386 }
1387 else
1388 vertical_drag_cursor
1389 = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_sb_v_double_arrow);
1390
ee78dc32 1391 /* Check and report errors with the above calls. */
fbd6baed 1392 x_check_errors (FRAME_W32_DISPLAY (f), "can't set cursor shape: %s");
fadca6c6 1393 x_uncatch_errors (FRAME_W32_DISPLAY (f), count);
ee78dc32
GV
1394
1395 {
1396 XColor fore_color, back_color;
1397
fbd6baed 1398 fore_color.pixel = f->output_data.w32->mouse_pixel;
ee78dc32 1399 back_color.pixel = mask_color;
fbd6baed
GV
1400 XQueryColor (FRAME_W32_DISPLAY (f),
1401 DefaultColormap (FRAME_W32_DISPLAY (f),
1402 DefaultScreen (FRAME_W32_DISPLAY (f))),
ee78dc32 1403 &fore_color);
fbd6baed
GV
1404 XQueryColor (FRAME_W32_DISPLAY (f),
1405 DefaultColormap (FRAME_W32_DISPLAY (f),
1406 DefaultScreen (FRAME_W32_DISPLAY (f))),
ee78dc32 1407 &back_color);
fbd6baed 1408 XRecolorCursor (FRAME_W32_DISPLAY (f), cursor,
ee78dc32 1409 &fore_color, &back_color);
fbd6baed 1410 XRecolorCursor (FRAME_W32_DISPLAY (f), nontext_cursor,
ee78dc32 1411 &fore_color, &back_color);
fbd6baed 1412 XRecolorCursor (FRAME_W32_DISPLAY (f), mode_cursor,
ee78dc32 1413 &fore_color, &back_color);
7d63e5e3 1414 XRecolorCursor (FRAME_W32_DISPLAY (f), hand_cursor,
ee78dc32 1415 &fore_color, &back_color);
0af913d7 1416 XRecolorCursor (FRAME_W32_DISPLAY (f), hourglass_cursor,
6fc2811b 1417 &fore_color, &back_color);
ee78dc32
GV
1418 }
1419
fbd6baed 1420 if (FRAME_W32_WINDOW (f) != 0)
6fc2811b 1421 XDefineCursor (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f), cursor);
ee78dc32 1422
fbd6baed
GV
1423 if (cursor != f->output_data.w32->text_cursor && f->output_data.w32->text_cursor != 0)
1424 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->text_cursor);
1425 f->output_data.w32->text_cursor = cursor;
1426
1427 if (nontext_cursor != f->output_data.w32->nontext_cursor
1428 && f->output_data.w32->nontext_cursor != 0)
1429 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->nontext_cursor);
1430 f->output_data.w32->nontext_cursor = nontext_cursor;
1431
0af913d7
GM
1432 if (hourglass_cursor != f->output_data.w32->hourglass_cursor
1433 && f->output_data.w32->hourglass_cursor != 0)
1434 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->hourglass_cursor);
1435 f->output_data.w32->hourglass_cursor = hourglass_cursor;
6fc2811b 1436
fbd6baed
GV
1437 if (mode_cursor != f->output_data.w32->modeline_cursor
1438 && f->output_data.w32->modeline_cursor != 0)
1439 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->modeline_cursor);
1440 f->output_data.w32->modeline_cursor = mode_cursor;
7d0393cf 1441
7d63e5e3
KS
1442 if (hand_cursor != f->output_data.w32->hand_cursor
1443 && f->output_data.w32->hand_cursor != 0)
1444 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->hand_cursor);
1445 f->output_data.w32->hand_cursor = hand_cursor;
fbd6baed
GV
1446
1447 XFlush (FRAME_W32_DISPLAY (f));
4d7e6e51 1448 unblock_input ();
6fc2811b
JR
1449
1450 update_face_from_frame_parameter (f, Qmouse_color, arg);
767b1ff0 1451#endif /* TODO */
ee78dc32
GV
1452}
1453
1454void
b56ceb92 1455x_set_cursor_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
ee78dc32 1456{
70a0239a 1457 unsigned long fore_pixel, pixel;
ee78dc32 1458
dfff8a69 1459 if (!NILP (Vx_cursor_fore_pixel))
ee78dc32 1460 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
70a0239a 1461 WHITE_PIX_DEFAULT (f));
ee78dc32 1462 else
6fc2811b 1463 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
70a0239a 1464
6759f872 1465 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
7d0393cf 1466
ee78dc32 1467 /* Make sure that the cursor color differs from the background color. */
70a0239a 1468 if (pixel == FRAME_BACKGROUND_PIXEL (f))
ee78dc32 1469 {
70a0239a
JR
1470 pixel = f->output_data.w32->mouse_pixel;
1471 if (pixel == fore_pixel)
6fc2811b 1472 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
ee78dc32 1473 }
70a0239a 1474
ac849ba4 1475 f->output_data.w32->cursor_foreground_pixel = fore_pixel;
70a0239a 1476 f->output_data.w32->cursor_pixel = pixel;
ee78dc32 1477
fbd6baed 1478 if (FRAME_W32_WINDOW (f) != 0)
ee78dc32 1479 {
4d7e6e51 1480 block_input ();
0327b4cc
JR
1481 /* Update frame's cursor_gc. */
1482 f->output_data.w32->cursor_gc->foreground = fore_pixel;
1483 f->output_data.w32->cursor_gc->background = pixel;
1484
4d7e6e51 1485 unblock_input ();
0327b4cc 1486
ee78dc32
GV
1487 if (FRAME_VISIBLE_P (f))
1488 {
70a0239a
JR
1489 x_update_cursor (f, 0);
1490 x_update_cursor (f, 1);
ee78dc32
GV
1491 }
1492 }
6fc2811b
JR
1493
1494 update_face_from_frame_parameter (f, Qcursor_color, arg);
ee78dc32
GV
1495}
1496
33d52f9c
GV
1497/* Set the border-color of frame F to pixel value PIX.
1498 Note that this does not fully take effect if done before
7d0393cf 1499 F has a window. */
6d906347 1500
33d52f9c 1501void
b56ceb92 1502x_set_border_pixel (struct frame *f, int pix)
33d52f9c 1503{
6d906347 1504
33d52f9c
GV
1505 f->output_data.w32->border_pixel = pix;
1506
be786000 1507 if (FRAME_W32_WINDOW (f) != 0 && f->border_width > 0)
33d52f9c
GV
1508 {
1509 if (FRAME_VISIBLE_P (f))
1510 redraw_frame (f);
1511 }
1512}
1513
ee78dc32
GV
1514/* Set the border-color of frame F to value described by ARG.
1515 ARG can be a string naming a color.
1516 The border-color is used for the border that is drawn by the server.
1517 Note that this does not fully take effect if done before
1518 F has a window; it must be redone when the window is created. */
1519
1520void
b56ceb92 1521x_set_border_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
ee78dc32 1522{
ee78dc32
GV
1523 int pix;
1524
b7826503 1525 CHECK_STRING (arg);
ee78dc32 1526 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
ee78dc32 1527 x_set_border_pixel (f, pix);
6fc2811b 1528 update_face_from_frame_parameter (f, Qborder_color, arg);
ee78dc32
GV
1529}
1530
dfff8a69
JR
1531
1532void
a10c8269 1533x_set_cursor_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
dfff8a69 1534{
50e363e6 1535 set_frame_cursor_types (f, arg);
ee78dc32 1536}
9cda66e4 1537
ee78dc32 1538void
b56ceb92 1539x_set_icon_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
ee78dc32 1540{
ee78dc32
GV
1541 int result;
1542
eb7576ce
GV
1543 if (NILP (arg) && NILP (oldval))
1544 return;
1545
7d0393cf 1546 if (STRINGP (arg) && STRINGP (oldval)
eb7576ce
GV
1547 && EQ (Fstring_equal (oldval, arg), Qt))
1548 return;
1549
1550 if (SYMBOLP (arg) && SYMBOLP (oldval) && EQ (arg, oldval))
ee78dc32
GV
1551 return;
1552
4d7e6e51 1553 block_input ();
ee78dc32 1554
eb7576ce 1555 result = x_bitmap_icon (f, arg);
ee78dc32
GV
1556 if (result)
1557 {
4d7e6e51 1558 unblock_input ();
ee78dc32
GV
1559 error ("No icon window available");
1560 }
1561
4d7e6e51 1562 unblock_input ();
ee78dc32
GV
1563}
1564
ee78dc32 1565void
b56ceb92 1566x_set_icon_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
ee78dc32 1567{
ee78dc32
GV
1568 if (STRINGP (arg))
1569 {
1570 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1571 return;
1572 }
3f65d6f5 1573 else if (!NILP (arg) || NILP (oldval))
ee78dc32
GV
1574 return;
1575
f00af5b1 1576 fset_icon_name (f, arg);
ee78dc32
GV
1577
1578#if 0
fbd6baed 1579 if (f->output_data.w32->icon_bitmap != 0)
ee78dc32
GV
1580 return;
1581
4d7e6e51 1582 block_input ();
ee78dc32
GV
1583
1584 result = x_text_icon (f,
e69b0960
DA
1585 SSDATA ((!NILP (f->icon_name)
1586 ? f->icon_name
1587 : !NILP (f->title)
1588 ? f->title
1589 : f->name)));
ee78dc32
GV
1590
1591 if (result)
1592 {
4d7e6e51 1593 unblock_input ();
ee78dc32
GV
1594 error ("No icon window available");
1595 }
1596
1597 /* If the window was unmapped (and its icon was mapped),
1598 the new icon is not mapped, so map the window in its stead. */
1599 if (FRAME_VISIBLE_P (f))
1600 {
1601#ifdef USE_X_TOOLKIT
fbd6baed 1602 XtPopup (f->output_data.w32->widget, XtGrabNone);
ee78dc32 1603#endif
fbd6baed 1604 XMapWindow (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f));
ee78dc32
GV
1605 }
1606
fbd6baed 1607 XFlush (FRAME_W32_DISPLAY (f));
4d7e6e51 1608 unblock_input ();
ee78dc32
GV
1609#endif
1610}
1611
a1258667 1612\f
ee78dc32 1613void
b56ceb92 1614x_set_menu_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
ee78dc32
GV
1615{
1616 int nlines;
ee78dc32
GV
1617
1618 /* Right now, menu bars don't work properly in minibuf-only frames;
1619 most of the commands try to apply themselves to the minibuffer
6fc2811b 1620 frame itself, and get an error because you can't switch buffers
ee78dc32
GV
1621 in or split the minibuffer window. */
1622 if (FRAME_MINIBUF_ONLY_P (f))
1623 return;
1624
1625 if (INTEGERP (value))
1626 nlines = XINT (value);
1627 else
1628 nlines = 0;
1629
1630 FRAME_MENU_BAR_LINES (f) = 0;
880e6158 1631 FRAME_MENU_BAR_HEIGHT (f) = 0;
ee78dc32
GV
1632 if (nlines)
1633 FRAME_EXTERNAL_MENU_BAR (f) = 1;
1634 else
1635 {
1636 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
1637 free_frame_menubar (f);
1638 FRAME_EXTERNAL_MENU_BAR (f) = 0;
1edf84e7
GV
1639
1640 /* Adjust the frame size so that the client (text) dimensions
1641 remain the same. This depends on FRAME_EXTERNAL_MENU_BAR being
1642 set correctly. */
880e6158 1643 x_set_window_size (f, 0, FRAME_TEXT_WIDTH (f), FRAME_TEXT_HEIGHT (f), 1);
6fc2811b 1644 do_pending_window_change (0);
ee78dc32 1645 }
bd0443bb 1646 adjust_frame_glyphs (f);
6fc2811b
JR
1647}
1648
1649
1650/* Set the number of lines used for the tool bar of frame F to VALUE.
880e6158
MR
1651 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL is
1652 the old number of tool bar lines (and is unused). This function may
1653 change the height of all windows on frame F to match the new tool bar
1654 height. By design, the frame's height doesn't change (but maybe it
1655 should if we don't get enough space otherwise). */
6fc2811b
JR
1656
1657void
b56ceb92 1658x_set_tool_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
6fc2811b 1659{
36f8209a 1660 int delta, nlines, root_height;
880e6158 1661 int unit = FRAME_LINE_HEIGHT (f);
6fc2811b 1662
dc220243
JR
1663 /* Treat tool bars like menu bars. */
1664 if (FRAME_MINIBUF_ONLY_P (f))
1665 return;
1666
6fc2811b
JR
1667 /* Use VALUE only if an integer >= 0. */
1668 if (INTEGERP (value) && XINT (value) >= 0)
1669 nlines = XFASTINT (value);
1670 else
1671 nlines = 0;
1672
1673 /* Make sure we redisplay all windows in this frame. */
94ae2ad4 1674 windows_or_buffers_changed = 23;
6fc2811b 1675
880e6158
MR
1676 /* DELTA is in pixels now. */
1677 delta = (nlines - FRAME_TOOL_BAR_LINES (f)) * unit;
36f8209a 1678
0cbab19e
MR
1679 /* Don't resize the tool-bar to more than we have room for. Note: The
1680 calculations below and the subsequent call to resize_frame_windows
1681 are inherently flawed because they can make the toolbar higher than
1682 the containing frame. */
880e6158 1683 if (delta > 0)
36f8209a 1684 {
880e6158
MR
1685 root_height = WINDOW_PIXEL_HEIGHT (XWINDOW (FRAME_ROOT_WINDOW (f)));
1686 if (root_height - delta < unit)
1687 {
1688 delta = root_height - unit;
0cbab19e
MR
1689 /* When creating a new frame and toolbar mode is enabled, we
1690 need at least one toolbar line. */
1691 nlines = max (FRAME_TOOL_BAR_LINES (f) + delta / unit, 1);
880e6158 1692 }
36f8209a
JR
1693 }
1694
6fc2811b 1695 FRAME_TOOL_BAR_LINES (f) = nlines;
880e6158
MR
1696 FRAME_TOOL_BAR_HEIGHT (f) = nlines * FRAME_LINE_HEIGHT (f);
1697 ++windows_or_buffers_changed;
1698 resize_frame_windows (f, FRAME_TEXT_HEIGHT (f), 0, 1);
bd0443bb 1699 adjust_frame_glyphs (f);
36f8209a
JR
1700
1701 /* We also have to make sure that the internal border at the top of
1702 the frame, below the menu bar or tool bar, is redrawn when the
1703 tool bar disappears. This is so because the internal border is
1704 below the tool bar if one is displayed, but is below the menu bar
1705 if there isn't a tool bar. The tool bar draws into the area
1706 below the menu bar. */
880e6158 1707 if (FRAME_W32_WINDOW (f) && FRAME_TOOL_BAR_HEIGHT (f) == 0)
36f8209a 1708 {
2dc8b986 1709 clear_frame (f);
36f8209a 1710 clear_current_matrices (f);
36f8209a
JR
1711 }
1712
1713 /* If the tool bar gets smaller, the internal border below it
1714 has to be cleared. It was formerly part of the display
1715 of the larger tool bar, and updating windows won't clear it. */
5442c6ce 1716 if (FRAME_INTERNAL_BORDER_WIDTH (f) != 0 && FRAME_VISIBLE_P (f))
36f8209a
JR
1717 {
1718 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
be786000 1719 int width = FRAME_PIXEL_WIDTH (f);
880e6158 1720 int y = nlines * unit;
7d7ccb88 1721 HDC hdc = get_frame_dc (f);
36f8209a 1722
4d7e6e51 1723 block_input ();
7d7ccb88
MR
1724 w32_clear_area (f, hdc, 0, y, width, height);
1725 release_frame_dc (f, hdc);
4d7e6e51 1726 unblock_input ();
36f8209a 1727 }
562dd5e9 1728
7d7ccb88
MR
1729 if (delta < 0 && WINDOWP (f->tool_bar_window))
1730 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
562dd5e9 1731
7d7ccb88 1732 run_window_configuration_change_hook (f);
ee78dc32
GV
1733}
1734
6fc2811b 1735
ee78dc32 1736/* Change the name of frame F to NAME. If NAME is nil, set F's name to
fbd6baed 1737 w32_id_name.
ee78dc32
GV
1738
1739 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1740 name; if NAME is a string, set F's name to NAME and set
1741 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1742
1743 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1744 suggesting a new name, which lisp code should override; if
1745 F->explicit_name is set, ignore the new name; otherwise, set it. */
1746
1747void
b56ceb92 1748x_set_name (struct frame *f, Lisp_Object name, int explicit)
ee78dc32 1749{
7d0393cf 1750 /* Make sure that requests from lisp code override requests from
ee78dc32
GV
1751 Emacs redisplay code. */
1752 if (explicit)
1753 {
1754 /* If we're switching from explicit to implicit, we had better
1755 update the mode lines and thereby update the title. */
1756 if (f->explicit_name && NILP (name))
2ec9db5d 1757 update_mode_lines = 25;
ee78dc32
GV
1758
1759 f->explicit_name = ! NILP (name);
1760 }
1761 else if (f->explicit_name)
1762 return;
1763
fbd6baed 1764 /* If NAME is nil, set the name to the w32_id_name. */
ee78dc32
GV
1765 if (NILP (name))
1766 {
1767 /* Check for no change needed in this very common case
1768 before we do any consing. */
aad3612f 1769 if (!strcmp (FRAME_DISPLAY_INFO (f)->w32_id_name,
e69b0960 1770 SDATA (f->name)))
ee78dc32 1771 return;
aad3612f 1772 name = build_string (FRAME_DISPLAY_INFO (f)->w32_id_name);
ee78dc32
GV
1773 }
1774 else
b7826503 1775 CHECK_STRING (name);
ee78dc32
GV
1776
1777 /* Don't change the name if it's already NAME. */
e69b0960 1778 if (! NILP (Fstring_equal (name, f->name)))
ee78dc32
GV
1779 return;
1780
f00af5b1 1781 fset_name (f, name);
1edf84e7
GV
1782
1783 /* For setting the frame title, the title parameter should override
1784 the name parameter. */
e69b0960
DA
1785 if (! NILP (f->title))
1786 name = f->title;
1edf84e7 1787
fbd6baed 1788 if (FRAME_W32_WINDOW (f))
ee78dc32 1789 {
4d7e6e51 1790 block_input ();
819e2da9
DC
1791 GUI_FN (SetWindowText) (FRAME_W32_WINDOW (f),
1792 GUI_SDATA (GUI_ENCODE_SYSTEM (name)));
4d7e6e51 1793 unblock_input ();
ee78dc32 1794 }
ee78dc32
GV
1795}
1796
1797/* This function should be called when the user's lisp code has
1798 specified a name for the frame; the name will override any set by the
1799 redisplay code. */
1800void
a10c8269 1801x_explicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
ee78dc32
GV
1802{
1803 x_set_name (f, arg, 1);
1804}
1805
1806/* This function should be called by Emacs redisplay code to set the
1807 name; names set this way will never override names set by the user's
1808 lisp code. */
1809void
a10c8269 1810x_implicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
ee78dc32
GV
1811{
1812 x_set_name (f, arg, 0);
1813}
1edf84e7
GV
1814\f
1815/* Change the title of frame F to NAME.
40aa4c27 1816 If NAME is nil, use the frame name as the title. */
ee78dc32 1817
1edf84e7 1818void
b56ceb92 1819x_set_title (struct frame *f, Lisp_Object name, Lisp_Object old_name)
1edf84e7
GV
1820{
1821 /* Don't change the title if it's already NAME. */
e69b0960 1822 if (EQ (name, f->title))
1edf84e7
GV
1823 return;
1824
2ec9db5d 1825 update_mode_lines = 26;
1edf84e7 1826
f00af5b1 1827 fset_title (f, name);
1edf84e7
GV
1828
1829 if (NILP (name))
e69b0960 1830 name = f->name;
1edf84e7
GV
1831
1832 if (FRAME_W32_WINDOW (f))
1833 {
4d7e6e51 1834 block_input ();
819e2da9
DC
1835 GUI_FN (SetWindowText) (FRAME_W32_WINDOW (f),
1836 GUI_SDATA (GUI_ENCODE_SYSTEM (name)));
4d7e6e51 1837 unblock_input ();
1edf84e7
GV
1838 }
1839}
ee78dc32 1840
b56ceb92
JB
1841void
1842x_set_scroll_bar_default_width (struct frame *f)
ee78dc32 1843{
44c5e192 1844 int unit = FRAME_COLUMN_WIDTH (f);
6fc2811b 1845
be786000 1846 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = GetSystemMetrics (SM_CXVSCROLL);
44c5e192
MR
1847 FRAME_CONFIG_SCROLL_BAR_COLS (f)
1848 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + unit - 1) / unit;
ee78dc32 1849}
6d906347 1850
ee78dc32 1851\f
3faa984f 1852/* Subroutines for creating a frame. */
ee78dc32 1853
c9b2104d
JR
1854Cursor
1855w32_load_cursor (LPCTSTR name)
1856{
1857 /* Try first to load cursor from application resource. */
74084731 1858 Cursor cursor = LoadImage ((HINSTANCE) GetModuleHandle (NULL),
c9b2104d
JR
1859 name, IMAGE_CURSOR, 0, 0,
1860 LR_DEFAULTCOLOR | LR_DEFAULTSIZE | LR_SHARED);
1861 if (!cursor)
1862 {
1863 /* Then try to load a shared predefined cursor. */
1864 cursor = LoadImage (NULL, name, IMAGE_CURSOR, 0, 0,
1865 LR_DEFAULTCOLOR | LR_DEFAULTSIZE | LR_SHARED);
1866 }
1867 return cursor;
1868}
ee78dc32 1869
24f981c9 1870static LRESULT CALLBACK w32_wnd_proc (HWND, UINT, WPARAM, LPARAM);
ee78dc32 1871
d30be705
EZ
1872#define INIT_WINDOW_CLASS(WC) \
1873 (WC).style = CS_HREDRAW | CS_VREDRAW; \
1874 (WC).lpfnWndProc = (WNDPROC) w32_wnd_proc; \
1875 (WC).cbClsExtra = 0; \
1876 (WC).cbWndExtra = WND_EXTRA_BYTES; \
1877 (WC).hInstance = hinst; \
1878 (WC).hIcon = LoadIcon (hinst, EMACS_CLASS); \
1879 (WC).hCursor = w32_load_cursor (IDC_ARROW); \
1880 (WC).hbrBackground = NULL; \
1881 (WC).lpszMenuName = NULL; \
1882
74084731 1883static BOOL
b56ceb92 1884w32_init_class (HINSTANCE hinst)
ee78dc32 1885{
9b855fd6 1886 if (w32_unicode_gui)
d30be705
EZ
1887 {
1888 WNDCLASSW uwc;
1889 INIT_WINDOW_CLASS(uwc);
1890 uwc.lpszClassName = L"Emacs";
1891
1892 return RegisterClassW (&uwc);
1893 }
1894 else
1895 {
1896 WNDCLASS wc;
1897 INIT_WINDOW_CLASS(wc);
1898 wc.lpszClassName = EMACS_CLASS;
ee78dc32 1899
d30be705
EZ
1900 return RegisterClassA (&wc);
1901 }
ee78dc32
GV
1902}
1903
74084731 1904static HWND
b56ceb92 1905w32_createscrollbar (struct frame *f, struct scroll_bar * bar)
ee78dc32 1906{
0eed0355
DA
1907 return CreateWindow ("SCROLLBAR", "", SBS_VERT | WS_CHILD | WS_VISIBLE,
1908 /* Position and size of scroll bar. */
c44de18d 1909 bar->left, bar->top, bar->width, bar->height,
0eed0355 1910 FRAME_W32_WINDOW (f), NULL, hinst, NULL);
ee78dc32
GV
1911}
1912
74084731 1913static void
b56ceb92 1914w32_createwindow (struct frame *f)
ee78dc32
GV
1915{
1916 HWND hwnd;
1edf84e7 1917 RECT rect;
df70725f
EZ
1918 Lisp_Object top = Qunbound;
1919 Lisp_Object left = Qunbound;
3faa984f 1920 struct w32_display_info *dpyinfo = &one_w32_display_info;
1edf84e7
GV
1921
1922 rect.left = rect.top = 0;
be786000
KS
1923 rect.right = FRAME_PIXEL_WIDTH (f);
1924 rect.bottom = FRAME_PIXEL_HEIGHT (f);
7d0393cf 1925
1edf84e7
GV
1926 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
1927 FRAME_EXTERNAL_MENU_BAR (f));
7d0393cf 1928
ee78dc32 1929 /* Do first time app init */
7d0393cf 1930
0fda9b75 1931 w32_init_class (hinst);
7d0393cf 1932
2770d589
JR
1933 if (f->size_hint_flags & USPosition || f->size_hint_flags & PPosition)
1934 {
1935 XSETINT (left, f->left_pos);
1936 XSETINT (top, f->top_pos);
1937 }
1938 else if (EQ (left, Qunbound) && EQ (top, Qunbound))
df70725f
EZ
1939 {
1940 /* When called with RES_TYPE_NUMBER, w32_get_arg will return zero
1941 for anything that is not a number and is not Qunbound. */
3faa984f
JR
1942 left = x_get_arg (dpyinfo, Qnil, Qleft, "left", "Left", RES_TYPE_NUMBER);
1943 top = x_get_arg (dpyinfo, Qnil, Qtop, "top", "Top", RES_TYPE_NUMBER);
df70725f 1944 }
48b62d10 1945
1edf84e7
GV
1946 FRAME_W32_WINDOW (f) = hwnd
1947 = CreateWindow (EMACS_CLASS,
1948 f->namebuf,
9ead1b60 1949 f->output_data.w32->dwStyle | WS_CLIPCHILDREN,
48b62d10
EZ
1950 EQ (left, Qunbound) ? CW_USEDEFAULT : XINT (left),
1951 EQ (top, Qunbound) ? CW_USEDEFAULT : XINT (top),
1edf84e7
GV
1952 rect.right - rect.left,
1953 rect.bottom - rect.top,
1954 NULL,
1955 NULL,
1956 hinst,
1957 NULL);
1958
ee78dc32
GV
1959 if (hwnd)
1960 {
be786000
KS
1961 SetWindowLong (hwnd, WND_FONTWIDTH_INDEX, FRAME_COLUMN_WIDTH (f));
1962 SetWindowLong (hwnd, WND_LINEHEIGHT_INDEX, FRAME_LINE_HEIGHT (f));
1963 SetWindowLong (hwnd, WND_BORDER_INDEX, FRAME_INTERNAL_BORDER_WIDTH (f));
880e6158 1964 SetWindowLong (hwnd, WND_SCROLLBAR_INDEX, FRAME_SCROLL_BAR_AREA_WIDTH (f));
6fc2811b 1965 SetWindowLong (hwnd, WND_BACKGROUND_INDEX, FRAME_BACKGROUND_PIXEL (f));
ee78dc32 1966
cb9e33d4
RS
1967 /* Enable drag-n-drop. */
1968 DragAcceptFiles (hwnd, TRUE);
7d0393cf 1969
5ac45f98
GV
1970 /* Do this to discard the default setting specified by our parent. */
1971 ShowWindow (hwnd, SW_HIDE);
1771bb6e
EZ
1972
1973 /* Update frame positions. */
1974 GetWindowRect (hwnd, &rect);
1975 f->left_pos = rect.left;
1976 f->top_pos = rect.top;
3c190163 1977 }
3c190163
GV
1978}
1979
74084731 1980static void
b56ceb92 1981my_post_msg (W32Msg * wmsg, HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
ee78dc32
GV
1982{
1983 wmsg->msg.hwnd = hwnd;
1984 wmsg->msg.message = msg;
1985 wmsg->msg.wParam = wParam;
1986 wmsg->msg.lParam = lParam;
1987 wmsg->msg.time = GetMessageTime ();
1988
1989 post_msg (wmsg);
1990}
1991
e9e23e23 1992/* GetKeyState and MapVirtualKey on Windows 95 do not actually distinguish
a1a80b40
GV
1993 between left and right keys as advertised. We test for this
1994 support dynamically, and set a flag when the support is absent. If
1995 absent, we keep track of the left and right control and alt keys
1996 ourselves. This is particularly necessary on keyboards that rely
1997 upon the AltGr key, which is represented as having the left control
1998 and right alt keys pressed. For these keyboards, we need to know
1999 when the left alt key has been pressed in addition to the AltGr key
2000 so that we can properly support M-AltGr-key sequences (such as M-@
2001 on Swedish keyboards). */
2002
2003#define EMACS_LCONTROL 0
2004#define EMACS_RCONTROL 1
2005#define EMACS_LMENU 2
2006#define EMACS_RMENU 3
2007
2008static int modifiers[4];
2009static int modifiers_recorded;
2010static int modifier_key_support_tested;
2011
2012static void
2013test_modifier_support (unsigned int wparam)
2014{
2015 unsigned int l, r;
2016
2017 if (wparam != VK_CONTROL && wparam != VK_MENU)
2018 return;
2019 if (wparam == VK_CONTROL)
2020 {
2021 l = VK_LCONTROL;
2022 r = VK_RCONTROL;
2023 }
2024 else
2025 {
2026 l = VK_LMENU;
2027 r = VK_RMENU;
2028 }
2029 if (!(GetKeyState (l) & 0x8000) && !(GetKeyState (r) & 0x8000))
2030 modifiers_recorded = 1;
2031 else
2032 modifiers_recorded = 0;
2033 modifier_key_support_tested = 1;
2034}
2035
2036static void
2037record_keydown (unsigned int wparam, unsigned int lparam)
2038{
2039 int i;
2040
2041 if (!modifier_key_support_tested)
2042 test_modifier_support (wparam);
2043
2044 if ((wparam != VK_CONTROL && wparam != VK_MENU) || !modifiers_recorded)
2045 return;
2046
2047 if (wparam == VK_CONTROL)
2048 i = (lparam & 0x1000000) ? EMACS_RCONTROL : EMACS_LCONTROL;
2049 else
2050 i = (lparam & 0x1000000) ? EMACS_RMENU : EMACS_LMENU;
2051
2052 modifiers[i] = 1;
2053}
2054
2055static void
2056record_keyup (unsigned int wparam, unsigned int lparam)
2057{
2058 int i;
2059
2060 if ((wparam != VK_CONTROL && wparam != VK_MENU) || !modifiers_recorded)
2061 return;
2062
2063 if (wparam == VK_CONTROL)
2064 i = (lparam & 0x1000000) ? EMACS_RCONTROL : EMACS_LCONTROL;
2065 else
2066 i = (lparam & 0x1000000) ? EMACS_RMENU : EMACS_LMENU;
2067
2068 modifiers[i] = 0;
2069}
2070
da36a4d6 2071/* Emacs can lose focus while a modifier key has been pressed. When
7d0393cf 2072 it regains focus, be conservative and clear all modifiers since
da36a4d6
GV
2073 we cannot reconstruct the left and right modifier state. */
2074static void
b56ceb92 2075reset_modifiers (void)
da36a4d6 2076{
8681157a
RS
2077 SHORT ctrl, alt;
2078
adcc3809
GV
2079 if (GetFocus () == NULL)
2080 /* Emacs doesn't have keyboard focus. Do nothing. */
da36a4d6 2081 return;
8681157a
RS
2082
2083 ctrl = GetAsyncKeyState (VK_CONTROL);
2084 alt = GetAsyncKeyState (VK_MENU);
2085
8681157a
RS
2086 if (!(ctrl & 0x08000))
2087 /* Clear any recorded control modifier state. */
2088 modifiers[EMACS_RCONTROL] = modifiers[EMACS_LCONTROL] = 0;
2089
2090 if (!(alt & 0x08000))
2091 /* Clear any recorded alt modifier state. */
2092 modifiers[EMACS_RMENU] = modifiers[EMACS_LMENU] = 0;
2093
adcc3809
GV
2094 /* Update the state of all modifier keys, because modifiers used in
2095 hot-key combinations can get stuck on if Emacs loses focus as a
2096 result of a hot-key being pressed. */
2097 {
2098 BYTE keystate[256];
2099
2100#define CURRENT_STATE(key) ((GetAsyncKeyState (key) & 0x8000) >> 8)
2101
2102 GetKeyboardState (keystate);
2103 keystate[VK_SHIFT] = CURRENT_STATE (VK_SHIFT);
2104 keystate[VK_CONTROL] = CURRENT_STATE (VK_CONTROL);
2105 keystate[VK_LCONTROL] = CURRENT_STATE (VK_LCONTROL);
2106 keystate[VK_RCONTROL] = CURRENT_STATE (VK_RCONTROL);
2107 keystate[VK_MENU] = CURRENT_STATE (VK_MENU);
2108 keystate[VK_LMENU] = CURRENT_STATE (VK_LMENU);
2109 keystate[VK_RMENU] = CURRENT_STATE (VK_RMENU);
2110 keystate[VK_LWIN] = CURRENT_STATE (VK_LWIN);
2111 keystate[VK_RWIN] = CURRENT_STATE (VK_RWIN);
2112 keystate[VK_APPS] = CURRENT_STATE (VK_APPS);
2113 SetKeyboardState (keystate);
2114 }
da36a4d6
GV
2115}
2116
7830e24b
RS
2117/* Synchronize modifier state with what is reported with the current
2118 keystroke. Even if we cannot distinguish between left and right
2119 modifier keys, we know that, if no modifiers are set, then neither
2120 the left or right modifier should be set. */
2121static void
b56ceb92 2122sync_modifiers (void)
7830e24b
RS
2123{
2124 if (!modifiers_recorded)
2125 return;
2126
7d0393cf 2127 if (!(GetKeyState (VK_CONTROL) & 0x8000))
7830e24b
RS
2128 modifiers[EMACS_RCONTROL] = modifiers[EMACS_LCONTROL] = 0;
2129
7d0393cf 2130 if (!(GetKeyState (VK_MENU) & 0x8000))
7830e24b
RS
2131 modifiers[EMACS_RMENU] = modifiers[EMACS_LMENU] = 0;
2132}
2133
a1a80b40
GV
2134static int
2135modifier_set (int vkey)
2136{
88002743
EZ
2137 /* Warning: The fact that VK_NUMLOCK is not treated as the other 2
2138 toggle keys is not an omission! If you want to add it, you will
2139 have to make changes in the default sub-case of the WM_KEYDOWN
2140 switch, because if the NUMLOCK modifier is set, the code there
2141 will directly convert any key that looks like an ASCII letter,
2142 and also downcase those that look like upper-case ASCII. */
dab72075
EZ
2143 if (vkey == VK_CAPITAL)
2144 {
2145 if (NILP (Vw32_enable_caps_lock))
2146 return 0;
2147 else
2148 return (GetKeyState (vkey) & 0x1);
2149 }
2150 if (vkey == VK_SCROLL)
2151 {
88002743
EZ
2152 if (NILP (Vw32_scroll_lock_modifier)
2153 /* w32-scroll-lock-modifier can be any non-nil value that is
2154 not one of the modifiers, in which case it shall be ignored. */
2155 || !( EQ (Vw32_scroll_lock_modifier, Qhyper)
2156 || EQ (Vw32_scroll_lock_modifier, Qsuper)
2157 || EQ (Vw32_scroll_lock_modifier, Qmeta)
2158 || EQ (Vw32_scroll_lock_modifier, Qalt)
2159 || EQ (Vw32_scroll_lock_modifier, Qcontrol)
2160 || EQ (Vw32_scroll_lock_modifier, Qshift)))
dab72075
EZ
2161 return 0;
2162 else
2163 return (GetKeyState (vkey) & 0x1);
2164 }
dab72075 2165
a1a80b40
GV
2166 if (!modifiers_recorded)
2167 return (GetKeyState (vkey) & 0x8000);
2168
2169 switch (vkey)
2170 {
2171 case VK_LCONTROL:
2172 return modifiers[EMACS_LCONTROL];
2173 case VK_RCONTROL:
2174 return modifiers[EMACS_RCONTROL];
2175 case VK_LMENU:
2176 return modifiers[EMACS_LMENU];
2177 case VK_RMENU:
2178 return modifiers[EMACS_RMENU];
a1a80b40
GV
2179 }
2180 return (GetKeyState (vkey) & 0x8000);
2181}
2182
ccc2d29c
GV
2183/* Convert between the modifier bits W32 uses and the modifier bits
2184 Emacs uses. */
2185
2186unsigned int
2187w32_key_to_modifier (int key)
2188{
2189 Lisp_Object key_mapping;
2190
2191 switch (key)
2192 {
2193 case VK_LWIN:
2194 key_mapping = Vw32_lwindow_modifier;
2195 break;
2196 case VK_RWIN:
2197 key_mapping = Vw32_rwindow_modifier;
2198 break;
2199 case VK_APPS:
2200 key_mapping = Vw32_apps_modifier;
2201 break;
2202 case VK_SCROLL:
2203 key_mapping = Vw32_scroll_lock_modifier;
2204 break;
2205 default:
2206 key_mapping = Qnil;
2207 }
2208
91af3942 2209 /* NB. This code runs in the input thread, asynchronously to the lisp
adcc3809
GV
2210 thread, so we must be careful to ensure access to lisp data is
2211 thread-safe. The following code is safe because the modifier
2212 variable values are updated atomically from lisp and symbols are
2213 not relocated by GC. Also, we don't have to worry about seeing GC
2214 markbits here. */
2215 if (EQ (key_mapping, Qhyper))
ccc2d29c 2216 return hyper_modifier;
adcc3809 2217 if (EQ (key_mapping, Qsuper))
ccc2d29c 2218 return super_modifier;
adcc3809 2219 if (EQ (key_mapping, Qmeta))
ccc2d29c 2220 return meta_modifier;
adcc3809 2221 if (EQ (key_mapping, Qalt))
ccc2d29c 2222 return alt_modifier;
adcc3809 2223 if (EQ (key_mapping, Qctrl))
ccc2d29c 2224 return ctrl_modifier;
adcc3809 2225 if (EQ (key_mapping, Qcontrol)) /* synonym for ctrl */
ccc2d29c 2226 return ctrl_modifier;
adcc3809 2227 if (EQ (key_mapping, Qshift))
ccc2d29c
GV
2228 return shift_modifier;
2229
2230 /* Don't generate any modifier if not explicitly requested. */
2231 return 0;
2232}
2233
74084731 2234static unsigned int
b56ceb92 2235w32_get_modifiers (void)
ccc2d29c
GV
2236{
2237 return ((modifier_set (VK_SHIFT) ? shift_modifier : 0) |
2238 (modifier_set (VK_CONTROL) ? ctrl_modifier : 0) |
2239 (modifier_set (VK_LWIN) ? w32_key_to_modifier (VK_LWIN) : 0) |
2240 (modifier_set (VK_RWIN) ? w32_key_to_modifier (VK_RWIN) : 0) |
2241 (modifier_set (VK_APPS) ? w32_key_to_modifier (VK_APPS) : 0) |
2242 (modifier_set (VK_SCROLL) ? w32_key_to_modifier (VK_SCROLL) : 0) |
2243 (modifier_set (VK_MENU) ?
2244 ((NILP (Vw32_alt_is_meta)) ? alt_modifier : meta_modifier) : 0));
2245}
2246
a1a80b40
GV
2247/* We map the VK_* modifiers into console modifier constants
2248 so that we can use the same routines to handle both console
2249 and window input. */
2250
2251static int
b56ceb92 2252construct_console_modifiers (void)
a1a80b40
GV
2253{
2254 int mods;
2255
a1a80b40
GV
2256 mods = 0;
2257 mods |= (modifier_set (VK_SHIFT)) ? SHIFT_PRESSED : 0;
2258 mods |= (modifier_set (VK_CAPITAL)) ? CAPSLOCK_ON : 0;
ccc2d29c
GV
2259 mods |= (modifier_set (VK_SCROLL)) ? SCROLLLOCK_ON : 0;
2260 mods |= (modifier_set (VK_NUMLOCK)) ? NUMLOCK_ON : 0;
a1a80b40
GV
2261 mods |= (modifier_set (VK_LCONTROL)) ? LEFT_CTRL_PRESSED : 0;
2262 mods |= (modifier_set (VK_RCONTROL)) ? RIGHT_CTRL_PRESSED : 0;
2263 mods |= (modifier_set (VK_LMENU)) ? LEFT_ALT_PRESSED : 0;
2264 mods |= (modifier_set (VK_RMENU)) ? RIGHT_ALT_PRESSED : 0;
ccc2d29c
GV
2265 mods |= (modifier_set (VK_LWIN)) ? LEFT_WIN_PRESSED : 0;
2266 mods |= (modifier_set (VK_RWIN)) ? RIGHT_WIN_PRESSED : 0;
2267 mods |= (modifier_set (VK_APPS)) ? APPS_PRESSED : 0;
a1a80b40
GV
2268
2269 return mods;
2270}
2271
ccc2d29c
GV
2272static int
2273w32_get_key_modifiers (unsigned int wparam, unsigned int lparam)
da36a4d6 2274{
ccc2d29c
GV
2275 int mods;
2276
2277 /* Convert to emacs modifiers. */
2278 mods = w32_kbd_mods_to_emacs (construct_console_modifiers (), wparam);
2279
2280 return mods;
2281}
da36a4d6 2282
ccc2d29c
GV
2283unsigned int
2284map_keypad_keys (unsigned int virt_key, unsigned int extended)
2285{
2286 if (virt_key < VK_CLEAR || virt_key > VK_DELETE)
2287 return virt_key;
da36a4d6 2288
ccc2d29c 2289 if (virt_key == VK_RETURN)
da36a4d6
GV
2290 return (extended ? VK_NUMPAD_ENTER : VK_RETURN);
2291
ccc2d29c
GV
2292 if (virt_key >= VK_PRIOR && virt_key <= VK_DOWN)
2293 return (!extended ? (VK_NUMPAD_PRIOR + (virt_key - VK_PRIOR)) : virt_key);
2294
2295 if (virt_key == VK_INSERT || virt_key == VK_DELETE)
2296 return (!extended ? (VK_NUMPAD_INSERT + (virt_key - VK_INSERT)) : virt_key);
2297
2298 if (virt_key == VK_CLEAR)
2299 return (!extended ? VK_NUMPAD_CLEAR : virt_key);
2300
2301 return virt_key;
2302}
2303
2304/* List of special key combinations which w32 would normally capture,
74084731 2305 but Emacs should grab instead. Not directly visible to lisp, to
ccc2d29c
GV
2306 simplify synchronization. Each item is an integer encoding a virtual
2307 key code and modifier combination to capture. */
74084731 2308static Lisp_Object w32_grabbed_keys;
ccc2d29c 2309
74084731 2310#define HOTKEY(vk, mods) make_number (((vk) & 255) | ((mods) << 8))
ccc2d29c
GV
2311#define HOTKEY_ID(k) (XFASTINT (k) & 0xbfff)
2312#define HOTKEY_VK_CODE(k) (XFASTINT (k) & 255)
2313#define HOTKEY_MODIFIERS(k) (XFASTINT (k) >> 8)
2314
2ba49441
JR
2315#define RAW_HOTKEY_ID(k) ((k) & 0xbfff)
2316#define RAW_HOTKEY_VK_CODE(k) ((k) & 255)
2317#define RAW_HOTKEY_MODIFIERS(k) ((k) >> 8)
2318
ccc2d29c
GV
2319/* Register hot-keys for reserved key combinations when Emacs has
2320 keyboard focus, since this is the only way Emacs can receive key
2321 combinations like Alt-Tab which are used by the system. */
2322
2323static void
b56ceb92 2324register_hot_keys (HWND hwnd)
ccc2d29c
GV
2325{
2326 Lisp_Object keylist;
2327
8e50cc2d
SM
2328 /* Use CONSP, since we are called asynchronously. */
2329 for (keylist = w32_grabbed_keys; CONSP (keylist); keylist = XCDR (keylist))
ccc2d29c
GV
2330 {
2331 Lisp_Object key = XCAR (keylist);
2332
2333 /* Deleted entries get set to nil. */
2334 if (!INTEGERP (key))
2335 continue;
2336
2337 RegisterHotKey (hwnd, HOTKEY_ID (key),
2338 HOTKEY_MODIFIERS (key), HOTKEY_VK_CODE (key));
2339 }
2340}
2341
2342static void
b56ceb92 2343unregister_hot_keys (HWND hwnd)
ccc2d29c
GV
2344{
2345 Lisp_Object keylist;
2346
8e50cc2d 2347 for (keylist = w32_grabbed_keys; CONSP (keylist); keylist = XCDR (keylist))
ccc2d29c
GV
2348 {
2349 Lisp_Object key = XCAR (keylist);
2350
2351 if (!INTEGERP (key))
2352 continue;
2353
2354 UnregisterHotKey (hwnd, HOTKEY_ID (key));
2355 }
2356}
2357
0fda9b75
DC
2358#if EMACSDEBUG
2359const char*
2360w32_name_of_message (UINT msg)
2361{
2362 unsigned i;
2363 static char buf[64];
2364 static const struct {
2365 UINT msg;
2366 const char* name;
2367 } msgnames[] = {
2368#define M(msg) { msg, # msg }
2369 M (WM_PAINT),
2370 M (WM_TIMER),
2371 M (WM_USER),
2372 M (WM_MOUSEMOVE),
2373 M (WM_LBUTTONUP),
2374 M (WM_KEYDOWN),
2375 M (WM_EMACS_KILL),
2376 M (WM_EMACS_CREATEWINDOW),
2377 M (WM_EMACS_DONE),
2378 M (WM_EMACS_CREATESCROLLBAR),
2379 M (WM_EMACS_SHOWWINDOW),
2380 M (WM_EMACS_SETWINDOWPOS),
2381 M (WM_EMACS_DESTROYWINDOW),
2382 M (WM_EMACS_TRACKPOPUPMENU),
2383 M (WM_EMACS_SETFOCUS),
2384 M (WM_EMACS_SETFOREGROUND),
2385 M (WM_EMACS_SETLOCALE),
2386 M (WM_EMACS_SETKEYBOARDLAYOUT),
2387 M (WM_EMACS_REGISTER_HOT_KEY),
2388 M (WM_EMACS_UNREGISTER_HOT_KEY),
2389 M (WM_EMACS_TOGGLE_LOCK_KEY),
2390 M (WM_EMACS_TRACK_CARET),
2391 M (WM_EMACS_DESTROY_CARET),
2392 M (WM_EMACS_SHOW_CARET),
2393 M (WM_EMACS_HIDE_CARET),
2394 M (WM_EMACS_SETCURSOR),
2395 M (WM_EMACS_PAINT),
2396 M (WM_CHAR),
2397#undef M
2398 { 0, 0 }
2399 };
2400
2401 for (i = 0; msgnames[i].name; ++i)
2402 if (msgnames[i].msg == msg)
2403 return msgnames[i].name;
2404
2405 sprintf (buf, "message 0x%04x", (unsigned)msg);
2406 return buf;
2407}
2408#endif /* EMACSDEBUG */
2409
605a3df6
EZ
2410/* Here's an overview of how Emacs input works in GUI sessions on
2411 MS-Windows. (For description of non-GUI input, see the commentary
2412 before w32_console_read_socket in w32inevt.c.)
d263a633
EZ
2413
2414 System messages are read and processed by w32_msg_pump below. This
2415 function runs in a separate thread. It handles a small number of
2416 custom WM_EMACS_* messages (posted by the main thread, look for
2417 PostMessage calls), and dispatches the rest to w32_wnd_proc, which
2418 is the main window procedure for the entire Emacs application.
2419
2420 w32_wnd_proc also runs in the same separate input thread. It
2421 handles some messages, mostly those that need GDI calls, by itself.
2422 For the others, it calls my_post_msg, which inserts the messages
2423 into the input queue serviced by w32_read_socket.
2424
2425 w32_read_socket runs in the main (a.k.a. "Lisp") thread, and is
2426 called synchronously from keyboard.c when it is known or suspected
2427 that some input is available. w32_read_socket either handles
17917e74
EZ
2428 messages immediately, or converts them into Emacs input events and
2429 stuffs them into kbd_buffer, where kbd_buffer_get_event can get at
2430 them and process them when read_char and its callers require
36a305a7
DC
2431 input.
2432
2433 Under Cygwin with the W32 toolkit, the use of /dev/windows with
2434 select(2) takes the place of w32_read_socket.
2435
2436 */
d263a633 2437
5ac45f98
GV
2438/* Main message dispatch loop. */
2439
1edf84e7
GV
2440static void
2441w32_msg_pump (deferred_msg * msg_buf)
5ac45f98
GV
2442{
2443 MSG msg;
62aba0d4 2444 WPARAM result;
ccc2d29c 2445 HWND focus_window;
93fbe8b7
GV
2446
2447 msh_mousewheel = RegisterWindowMessage (MSH_MOUSEWHEEL);
7d0393cf 2448
9b855fd6 2449 while ((w32_unicode_gui ? GetMessageW : GetMessageA) (&msg, NULL, 0, 0))
5ac45f98 2450 {
0fda9b75
DC
2451
2452 /* DebPrint (("w32_msg_pump: %s time:%u\n", */
2453 /* w32_name_of_message (msg.message), msg.time)); */
2454
5ac45f98
GV
2455 if (msg.hwnd == NULL)
2456 {
2457 switch (msg.message)
2458 {
3ef68e6b
AI
2459 case WM_NULL:
2460 /* Produced by complete_deferred_msg; just ignore. */
2461 break;
5ac45f98 2462 case WM_EMACS_CREATEWINDOW:
d5781bb6
JR
2463 /* Initialize COM for this window. Even though we don't use it,
2464 some third party shell extensions can cause it to be used in
2465 system dialogs, which causes a crash if it is not initialized.
2466 This is a known bug in Windows, which was fixed long ago, but
e1dbe924 2467 the patch for XP is not publicly available until XP SP3,
d5781bb6
JR
2468 and older versions will never be patched. */
2469 CoInitialize (NULL);
fbd6baed 2470 w32_createwindow ((struct frame *) msg.wParam);
1edf84e7 2471 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
1088b922 2472 emacs_abort ();
5ac45f98 2473 break;
dfdb4047
GV
2474 case WM_EMACS_SETLOCALE:
2475 SetThreadLocale (msg.wParam);
2476 /* Reply is not expected. */
2477 break;
ccc2d29c 2478 case WM_EMACS_SETKEYBOARDLAYOUT:
62aba0d4 2479 result = (WPARAM) ActivateKeyboardLayout ((HKL) msg.wParam, 0);
ccc2d29c
GV
2480 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE,
2481 result, 0))
1088b922 2482 emacs_abort ();
ccc2d29c
GV
2483 break;
2484 case WM_EMACS_REGISTER_HOT_KEY:
2485 focus_window = GetFocus ();
2486 if (focus_window != NULL)
2487 RegisterHotKey (focus_window,
2ba49441
JR
2488 RAW_HOTKEY_ID (msg.wParam),
2489 RAW_HOTKEY_MODIFIERS (msg.wParam),
2490 RAW_HOTKEY_VK_CODE (msg.wParam));
ccc2d29c
GV
2491 /* Reply is not expected. */
2492 break;
2493 case WM_EMACS_UNREGISTER_HOT_KEY:
2494 focus_window = GetFocus ();
2495 if (focus_window != NULL)
2ba49441 2496 UnregisterHotKey (focus_window, RAW_HOTKEY_ID (msg.wParam));
adcc3809
GV
2497 /* Mark item as erased. NB: this code must be
2498 thread-safe. The next line is okay because the cons
2499 cell is never made into garbage and is not relocated by
2500 GC. */
fcf14875 2501 XSETCAR (XIL ((EMACS_INT) msg.lParam), Qnil);
ccc2d29c 2502 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
1088b922 2503 emacs_abort ();
ccc2d29c 2504 break;
adcc3809
GV
2505 case WM_EMACS_TOGGLE_LOCK_KEY:
2506 {
2507 int vk_code = (int) msg.wParam;
2508 int cur_state = (GetKeyState (vk_code) & 1);
fcf14875 2509 Lisp_Object new_state = XIL ((EMACS_INT) msg.lParam);
adcc3809
GV
2510
2511 /* NB: This code must be thread-safe. It is safe to
2512 call NILP because symbols are not relocated by GC,
2513 and pointer here is not touched by GC (so the markbit
2514 can't be set). Numbers are safe because they are
2515 immediate values. */
2516 if (NILP (new_state)
2517 || (NUMBERP (new_state)
8edb0a6f 2518 && ((XUINT (new_state)) & 1) != cur_state))
adcc3809
GV
2519 {
2520 one_w32_display_info.faked_key = vk_code;
2521
2522 keybd_event ((BYTE) vk_code,
2523 (BYTE) MapVirtualKey (vk_code, 0),
2524 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
2525 keybd_event ((BYTE) vk_code,
2526 (BYTE) MapVirtualKey (vk_code, 0),
2527 KEYEVENTF_EXTENDEDKEY | 0, 0);
2528 keybd_event ((BYTE) vk_code,
2529 (BYTE) MapVirtualKey (vk_code, 0),
2530 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
2531 cur_state = !cur_state;
2532 }
2533 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE,
2534 cur_state, 0))
1088b922 2535 emacs_abort ();
adcc3809
GV
2536 }
2537 break;
5dff811e
JR
2538#ifdef MSG_DEBUG
2539 /* Broadcast messages make it here, so you need to be looking
2540 for something in particular for this to be useful. */
1edf84e7 2541 default:
0fda9b75 2542 DebPrint (("msg %x not expected by w32_msg_pump\n", msg.message));
5dff811e 2543#endif
5ac45f98
GV
2544 }
2545 }
2546 else
2547 {
9b855fd6 2548 if (w32_unicode_gui)
d30be705
EZ
2549 DispatchMessageW (&msg);
2550 else
2551 DispatchMessageA (&msg);
5ac45f98 2552 }
1edf84e7
GV
2553
2554 /* Exit nested loop when our deferred message has completed. */
2555 if (msg_buf->completed)
2556 break;
5ac45f98 2557 }
1edf84e7
GV
2558}
2559
2560deferred_msg * deferred_msg_head;
2561
2562static deferred_msg *
2563find_deferred_msg (HWND hwnd, UINT msg)
2564{
2565 deferred_msg * item;
2566
2567 /* Don't actually need synchronization for read access, since
2568 modification of single pointer is always atomic. */
2569 /* enter_crit (); */
2570
2571 for (item = deferred_msg_head; item != NULL; item = item->next)
2572 if (item->w32msg.msg.hwnd == hwnd
2573 && item->w32msg.msg.message == msg)
2574 break;
2575
2576 /* leave_crit (); */
2577
2578 return item;
2579}
2580
2581static LRESULT
2582send_deferred_msg (deferred_msg * msg_buf,
2583 HWND hwnd,
2584 UINT msg,
2585 WPARAM wParam,
2586 LPARAM lParam)
2587{
2588 /* Only input thread can send deferred messages. */
2589 if (GetCurrentThreadId () != dwWindowsThreadId)
1088b922 2590 emacs_abort ();
1edf84e7
GV
2591
2592 /* It is an error to send a message that is already deferred. */
2593 if (find_deferred_msg (hwnd, msg) != NULL)
1088b922 2594 emacs_abort ();
1edf84e7
GV
2595
2596 /* Enforced synchronization is not needed because this is the only
2597 function that alters deferred_msg_head, and the following critical
2598 section is guaranteed to only be serially reentered (since only the
2599 input thread can call us). */
2600
2601 /* enter_crit (); */
2602
2603 msg_buf->completed = 0;
2604 msg_buf->next = deferred_msg_head;
2605 deferred_msg_head = msg_buf;
2606 my_post_msg (&msg_buf->w32msg, hwnd, msg, wParam, lParam);
2607
2608 /* leave_crit (); */
2609
2610 /* Start a new nested message loop to process other messages until
2611 this one is completed. */
2612 w32_msg_pump (msg_buf);
2613
2614 deferred_msg_head = msg_buf->next;
2615
2616 return msg_buf->result;
2617}
2618
2619void
2620complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result)
2621{
2622 deferred_msg * msg_buf = find_deferred_msg (hwnd, msg);
2623
2624 if (msg_buf == NULL)
c80e3b4a 2625 /* Message may have been canceled, so don't abort. */
3ef68e6b 2626 return;
1edf84e7
GV
2627
2628 msg_buf->result = result;
2629 msg_buf->completed = 1;
2630
2631 /* Ensure input thread is woken so it notices the completion. */
2632 PostThreadMessage (dwWindowsThreadId, WM_NULL, 0, 0);
2633}
2634
74084731 2635static void
b56ceb92 2636cancel_all_deferred_msgs (void)
3ef68e6b
AI
2637{
2638 deferred_msg * item;
2639
2640 /* Don't actually need synchronization for read access, since
2641 modification of single pointer is always atomic. */
2642 /* enter_crit (); */
2643
2644 for (item = deferred_msg_head; item != NULL; item = item->next)
2645 {
2646 item->result = 0;
2647 item->completed = 1;
2648 }
2649
2650 /* leave_crit (); */
2651
2652 /* Ensure input thread is woken so it notices the completion. */
2653 PostThreadMessage (dwWindowsThreadId, WM_NULL, 0, 0);
2654}
1edf84e7 2655
992dfd90
JR
2656DWORD WINAPI
2657w32_msg_worker (void *arg)
1edf84e7
GV
2658{
2659 MSG msg;
2660 deferred_msg dummy_buf;
2661
2662 /* Ensure our message queue is created */
7d0393cf 2663
1edf84e7 2664 PeekMessage (&msg, NULL, 0, 0, PM_NOREMOVE);
7d0393cf 2665
1edf84e7 2666 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
1088b922 2667 emacs_abort ();
1edf84e7
GV
2668
2669 memset (&dummy_buf, 0, sizeof (dummy_buf));
2670 dummy_buf.w32msg.msg.hwnd = NULL;
2671 dummy_buf.w32msg.msg.message = WM_NULL;
2672
23f250f4 2673 /* This is the initial message loop which should only exit when the
1edf84e7
GV
2674 application quits. */
2675 w32_msg_pump (&dummy_buf);
2676
2677 return 0;
5ac45f98
GV
2678}
2679
f0c947b5 2680static void
b56ceb92 2681signal_user_input (void)
f0c947b5
JR
2682{
2683 /* Interrupt any lisp that wants to be interrupted by input. */
2684 if (!NILP (Vthrow_on_input))
2685 {
2686 Vquit_flag = Vthrow_on_input;
c85efaf7
EZ
2687 /* Doing a QUIT from this thread is a bad idea, since this
2688 unwinds the stack of the Lisp thread, and the Windows runtime
2689 rightfully barfs. Disabled. */
2690#if 0
f0c947b5
JR
2691 /* If we're inside a function that wants immediate quits,
2692 do it now. */
2693 if (immediate_quit && NILP (Vinhibit_quit))
2694 {
2695 immediate_quit = 0;
2696 QUIT;
2697 }
c85efaf7 2698#endif
f0c947b5
JR
2699 }
2700}
2701
2702
3ef68e6b 2703static void
b56ceb92
JB
2704post_character_message (HWND hwnd, UINT msg,
2705 WPARAM wParam, LPARAM lParam,
2706 DWORD modifiers)
3ef68e6b
AI
2707{
2708 W32Msg wmsg;
2709
2710 wmsg.dwModifiers = modifiers;
2711
2712 /* Detect quit_char and set quit-flag directly. Note that we
2713 still need to post a message to ensure the main thread will be
74084731 2714 woken up if blocked in sys_select, but we do NOT want to post
3ef68e6b
AI
2715 the quit_char message itself (because it will usually be as if
2716 the user had typed quit_char twice). Instead, we post a dummy
7d7e0027 2717 message that has no particular effect. */
3ef68e6b
AI
2718 {
2719 int c = wParam;
2720 if (isalpha (c) && wmsg.dwModifiers == ctrl_modifier)
2721 c = make_ctrl_char (c) & 0377;
7d081355 2722 if (c == quit_char
7d7e0027
SM
2723 || (wmsg.dwModifiers == 0
2724 && w32_quit_key && wParam == w32_quit_key))
3ef68e6b
AI
2725 {
2726 Vquit_flag = Qt;
2727
2728 /* The choice of message is somewhat arbitrary, as long as
7d7e0027 2729 the main thread handler just ignores it. */
3ef68e6b
AI
2730 msg = WM_NULL;
2731
2732 /* Interrupt any blocking system calls. */
2733 signal_quit ();
2734
2735 /* As a safety precaution, forcibly complete any deferred
2736 messages. This is a kludge, but I don't see any particularly
2737 clean way to handle the situation where a deferred message is
2738 "dropped" in the lisp thread, and will thus never be
2739 completed, eg. by the user trying to activate the menubar
2740 when the lisp thread is busy, and then typing C-g when the
2741 menubar doesn't open promptly (with the result that the
2742 menubar never responds at all because the deferred
2743 WM_INITMENU message is never completed). Another problem
2744 situation is when the lisp thread calls SendMessage (to send
2745 a window manager command) when a message has been deferred;
2746 the lisp thread gets blocked indefinitely waiting for the
2747 deferred message to be completed, which itself is waiting for
2748 the lisp thread to respond.
2749
2750 Note that we don't want to block the input thread waiting for
c80e3b4a 2751 a response from the lisp thread (although that would at least
3ef68e6b
AI
2752 solve the deadlock problem above), because we want to be able
2753 to receive C-g to interrupt the lisp thread. */
2754 cancel_all_deferred_msgs ();
2755 }
f0c947b5
JR
2756 else
2757 signal_user_input ();
3ef68e6b
AI
2758 }
2759
2760 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2761}
2762
ee78dc32
GV
2763/* Main window procedure */
2764
24f981c9 2765static LRESULT CALLBACK
b56ceb92 2766w32_wnd_proc (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
ee78dc32
GV
2767{
2768 struct frame *f;
fbd6baed
GV
2769 struct w32_display_info *dpyinfo = &one_w32_display_info;
2770 W32Msg wmsg;
84fb1139 2771 int windows_translate;
576ba81c 2772 int key;
84fb1139 2773
a6085637
KH
2774 /* Note that it is okay to call x_window_to_frame, even though we are
2775 not running in the main lisp thread, because frame deletion
2776 requires the lisp thread to synchronize with this thread. Thus, if
2777 a frame struct is returned, it can be used without concern that the
2778 lisp thread might make it disappear while we are using it.
2779
2780 NB. Walking the frame list in this thread is safe (as long as
2781 writes of Lisp_Object slots are atomic, which they are on Windows).
2782 Although delete-frame can destructively modify the frame list while
2783 we are walking it, a garbage collection cannot occur until after
2784 delete-frame has synchronized with this thread.
2785
2786 It is also safe to use functions that make GDI calls, such as
fbd6baed 2787 w32_clear_rect, because these functions must obtain a DC handle
a6085637
KH
2788 from the frame struct using get_frame_dc which is thread-aware. */
2789
7d0393cf 2790 switch (msg)
ee78dc32
GV
2791 {
2792 case WM_ERASEBKGND:
a6085637
KH
2793 f = x_window_to_frame (dpyinfo, hwnd);
2794 if (f)
2795 {
9badad41 2796 HDC hdc = get_frame_dc (f);
a6085637 2797 GetUpdateRect (hwnd, &wmsg.rect, FALSE);
9badad41
JR
2798 w32_clear_rect (f, hdc, &wmsg.rect);
2799 release_frame_dc (f, hdc);
ce6059da
AI
2800
2801#if defined (W32_DEBUG_DISPLAY)
18f0b342
AI
2802 DebPrint (("WM_ERASEBKGND (frame %p): erasing %d,%d-%d,%d\n",
2803 f,
2804 wmsg.rect.left, wmsg.rect.top,
2805 wmsg.rect.right, wmsg.rect.bottom));
ce6059da 2806#endif /* W32_DEBUG_DISPLAY */
a6085637 2807 }
5ac45f98
GV
2808 return 1;
2809 case WM_PALETTECHANGED:
2810 /* ignore our own changes */
2811 if ((HWND)wParam != hwnd)
2812 {
a6085637
KH
2813 f = x_window_to_frame (dpyinfo, hwnd);
2814 if (f)
2815 /* get_frame_dc will realize our palette and force all
2816 frames to be redrawn if needed. */
2817 release_frame_dc (f, get_frame_dc (f));
5ac45f98
GV
2818 }
2819 return 0;
ee78dc32 2820 case WM_PAINT:
ce6059da 2821 {
55dcfc15
AI
2822 PAINTSTRUCT paintStruct;
2823 RECT update_rect;
72af86bd 2824 memset (&update_rect, 0, sizeof (update_rect));
55dcfc15 2825
18f0b342
AI
2826 f = x_window_to_frame (dpyinfo, hwnd);
2827 if (f == 0)
2828 {
2829 DebPrint (("WM_PAINT received for unknown window %p\n", hwnd));
2830 return 0;
2831 }
2832
55dcfc15
AI
2833 /* MSDN Docs say not to call BeginPaint if GetUpdateRect
2834 fails. Apparently this can happen under some
2835 circumstances. */
aa35b6ad 2836 if (GetUpdateRect (hwnd, &update_rect, FALSE) || !w32_strict_painting)
55dcfc15
AI
2837 {
2838 enter_crit ();
2839 BeginPaint (hwnd, &paintStruct);
2840
aa35b6ad
JR
2841 /* The rectangles returned by GetUpdateRect and BeginPaint
2842 do not always match. Play it safe by assuming both areas
2843 are invalid. */
2844 UnionRect (&(wmsg.rect), &update_rect, &(paintStruct.rcPaint));
55dcfc15
AI
2845
2846#if defined (W32_DEBUG_DISPLAY)
18f0b342
AI
2847 DebPrint (("WM_PAINT (frame %p): painting %d,%d-%d,%d\n",
2848 f,
2849 wmsg.rect.left, wmsg.rect.top,
2850 wmsg.rect.right, wmsg.rect.bottom));
2851 DebPrint ((" [update region is %d,%d-%d,%d]\n",
55dcfc15
AI
2852 update_rect.left, update_rect.top,
2853 update_rect.right, update_rect.bottom));
2854#endif
2855 EndPaint (hwnd, &paintStruct);
2856 leave_crit ();
2857
f7b146dc
JR
2858 /* Change the message type to prevent Windows from
2859 combining WM_PAINT messages in the Lisp thread's queue,
2860 since Windows assumes that each message queue is
2861 dedicated to one frame and does not bother checking
2862 that hwnd matches before combining them. */
2863 my_post_msg (&wmsg, hwnd, WM_EMACS_PAINT, wParam, lParam);
7d0393cf 2864
55dcfc15
AI
2865 return 0;
2866 }
c0611964
AI
2867
2868 /* If GetUpdateRect returns 0 (meaning there is no update
2869 region), assume the whole window needs to be repainted. */
74084731 2870 GetClientRect (hwnd, &wmsg.rect);
c0611964
AI
2871 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2872 return 0;
ee78dc32 2873 }
a1a80b40 2874
ccc2d29c
GV
2875 case WM_INPUTLANGCHANGE:
2876 /* Inform lisp thread of keyboard layout changes. */
2877 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2878
2879 /* Clear dead keys in the keyboard state; for simplicity only
2880 preserve modifier key states. */
2881 {
2882 int i;
2883 BYTE keystate[256];
2884
2885 GetKeyboardState (keystate);
2886 for (i = 0; i < 256; i++)
2887 if (1
2888 && i != VK_SHIFT
2889 && i != VK_LSHIFT
2890 && i != VK_RSHIFT
2891 && i != VK_CAPITAL
2892 && i != VK_NUMLOCK
2893 && i != VK_SCROLL
2894 && i != VK_CONTROL
2895 && i != VK_LCONTROL
2896 && i != VK_RCONTROL
2897 && i != VK_MENU
2898 && i != VK_LMENU
2899 && i != VK_RMENU
2900 && i != VK_LWIN
2901 && i != VK_RWIN)
2902 keystate[i] = 0;
2903 SetKeyboardState (keystate);
2904 }
2905 goto dflt;
2906
2907 case WM_HOTKEY:
2908 /* Synchronize hot keys with normal input. */
2909 PostMessage (hwnd, WM_KEYDOWN, HIWORD (lParam), 0);
2910 return (0);
2911
a1a80b40
GV
2912 case WM_KEYUP:
2913 case WM_SYSKEYUP:
2914 record_keyup (wParam, lParam);
2915 goto dflt;
2916
ee78dc32
GV
2917 case WM_KEYDOWN:
2918 case WM_SYSKEYDOWN:
ccc2d29c
GV
2919 /* Ignore keystrokes we fake ourself; see below. */
2920 if (dpyinfo->faked_key == wParam)
2921 {
2922 dpyinfo->faked_key = 0;
576ba81c
AI
2923 /* Make sure TranslateMessage sees them though (as long as
2924 they don't produce WM_CHAR messages). This ensures that
2925 indicator lights are toggled promptly on Windows 9x, for
2926 example. */
bf254037 2927 if (wParam < 256 && lispy_function_keys[wParam])
576ba81c
AI
2928 {
2929 windows_translate = 1;
2930 goto translate;
2931 }
2932 return 0;
ccc2d29c
GV
2933 }
2934
7830e24b
RS
2935 /* Synchronize modifiers with current keystroke. */
2936 sync_modifiers ();
a1a80b40 2937 record_keydown (wParam, lParam);
ccc2d29c 2938 wParam = map_keypad_keys (wParam, (lParam & 0x1000000L) != 0);
84fb1139
KH
2939
2940 windows_translate = 0;
ccc2d29c
GV
2941
2942 switch (wParam)
2943 {
2944 case VK_LWIN:
2945 if (NILP (Vw32_pass_lwindow_to_system))
2946 {
2947 /* Prevent system from acting on keyup (which opens the
2948 Start menu if no other key was pressed) by simulating a
2949 press of Space which we will ignore. */
2950 if (GetAsyncKeyState (wParam) & 1)
2951 {
adcc3809 2952 if (NUMBERP (Vw32_phantom_key_code))
576ba81c 2953 key = XUINT (Vw32_phantom_key_code) & 255;
adcc3809 2954 else
576ba81c
AI
2955 key = VK_SPACE;
2956 dpyinfo->faked_key = key;
2957 keybd_event (key, (BYTE) MapVirtualKey (key, 0), 0, 0);
ccc2d29c
GV
2958 }
2959 }
2960 if (!NILP (Vw32_lwindow_modifier))
2961 return 0;
2962 break;
2963 case VK_RWIN:
2964 if (NILP (Vw32_pass_rwindow_to_system))
2965 {
2966 if (GetAsyncKeyState (wParam) & 1)
2967 {
adcc3809 2968 if (NUMBERP (Vw32_phantom_key_code))
576ba81c 2969 key = XUINT (Vw32_phantom_key_code) & 255;
adcc3809 2970 else
576ba81c
AI
2971 key = VK_SPACE;
2972 dpyinfo->faked_key = key;
2973 keybd_event (key, (BYTE) MapVirtualKey (key, 0), 0, 0);
ccc2d29c
GV
2974 }
2975 }
2976 if (!NILP (Vw32_rwindow_modifier))
2977 return 0;
2978 break;
576ba81c 2979 case VK_APPS:
ccc2d29c
GV
2980 if (!NILP (Vw32_apps_modifier))
2981 return 0;
2982 break;
2983 case VK_MENU:
7d0393cf 2984 if (NILP (Vw32_pass_alt_to_system))
adcc3809
GV
2985 /* Prevent DefWindowProc from activating the menu bar if an
2986 Alt key is pressed and released by itself. */
ccc2d29c 2987 return 0;
84fb1139 2988 windows_translate = 1;
ccc2d29c 2989 break;
7d0393cf 2990 case VK_CAPITAL:
ccc2d29c
GV
2991 /* Decide whether to treat as modifier or function key. */
2992 if (NILP (Vw32_enable_caps_lock))
2993 goto disable_lock_key;
adcc3809
GV
2994 windows_translate = 1;
2995 break;
ccc2d29c
GV
2996 case VK_NUMLOCK:
2997 /* Decide whether to treat as modifier or function key. */
2998 if (NILP (Vw32_enable_num_lock))
2999 goto disable_lock_key;
adcc3809
GV
3000 windows_translate = 1;
3001 break;
ccc2d29c
GV
3002 case VK_SCROLL:
3003 /* Decide whether to treat as modifier or function key. */
3004 if (NILP (Vw32_scroll_lock_modifier))
3005 goto disable_lock_key;
adcc3809
GV
3006 windows_translate = 1;
3007 break;
ccc2d29c 3008 disable_lock_key:
adcc3809
GV
3009 /* Ensure the appropriate lock key state (and indicator light)
3010 remains in the same state. We do this by faking another
3011 press of the relevant key. Apparently, this really is the
3012 only way to toggle the state of the indicator lights. */
3013 dpyinfo->faked_key = wParam;
3014 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3015 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
3016 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3017 KEYEVENTF_EXTENDEDKEY | 0, 0);
3018 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3019 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
3020 /* Ensure indicator lights are updated promptly on Windows 9x
3021 (TranslateMessage apparently does this), after forwarding
3022 input event. */
3023 post_character_message (hwnd, msg, wParam, lParam,
3024 w32_get_key_modifiers (wParam, lParam));
3025 windows_translate = 1;
ccc2d29c 3026 break;
7d0393cf 3027 case VK_CONTROL:
ccc2d29c
GV
3028 case VK_SHIFT:
3029 case VK_PROCESSKEY: /* Generated by IME. */
3030 windows_translate = 1;
3031 break;
adcc3809
GV
3032 case VK_CANCEL:
3033 /* Windows maps Ctrl-Pause (aka Ctrl-Break) into VK_CANCEL,
3034 which is confusing for purposes of key binding; convert
3035 VK_CANCEL events into VK_PAUSE events. */
3036 wParam = VK_PAUSE;
3037 break;
3038 case VK_PAUSE:
3039 /* Windows maps Ctrl-NumLock into VK_PAUSE, which is confusing
3040 for purposes of key binding; convert these back into
3041 VK_NUMLOCK events, at least when we want to see NumLock key
3042 presses. (Note that there is never any possibility that
3043 VK_PAUSE with Ctrl really is C-Pause as per above.) */
3044 if (NILP (Vw32_enable_num_lock) && modifier_set (VK_CONTROL))
3045 wParam = VK_NUMLOCK;
3046 break;
ccc2d29c
GV
3047 default:
3048 /* If not defined as a function key, change it to a WM_CHAR message. */
bf254037 3049 if (wParam > 255 || !lispy_function_keys[wParam])
ccc2d29c 3050 {
adcc3809
GV
3051 DWORD modifiers = construct_console_modifiers ();
3052
ccc2d29c
GV
3053 if (!NILP (Vw32_recognize_altgr)
3054 && modifier_set (VK_LCONTROL) && modifier_set (VK_RMENU))
3055 {
3056 /* Always let TranslateMessage handle AltGr key chords;
3057 for some reason, ToAscii doesn't always process AltGr
3058 chords correctly. */
3059 windows_translate = 1;
3060 }
adcc3809 3061 else if ((modifiers & (~SHIFT_PRESSED & ~CAPSLOCK_ON)) != 0)
ccc2d29c 3062 {
adcc3809
GV
3063 /* Handle key chords including any modifiers other
3064 than shift directly, in order to preserve as much
3065 modifier information as possible. */
ccc2d29c
GV
3066 if ('A' <= wParam && wParam <= 'Z')
3067 {
3068 /* Don't translate modified alphabetic keystrokes,
3069 so the user doesn't need to constantly switch
3070 layout to type control or meta keystrokes when
3071 the normal layout translates alphabetic
3072 characters to non-ascii characters. */
3073 if (!modifier_set (VK_SHIFT))
3074 wParam += ('a' - 'A');
3075 msg = WM_CHAR;
3076 }
3077 else
3078 {
3079 /* Try to handle other keystrokes by determining the
3080 base character (ie. translating the base key plus
3081 shift modifier). */
3082 int add;
ccc2d29c 3083 KEY_EVENT_RECORD key;
7d0393cf 3084
ccc2d29c
GV
3085 key.bKeyDown = TRUE;
3086 key.wRepeatCount = 1;
3087 key.wVirtualKeyCode = wParam;
3088 key.wVirtualScanCode = (lParam & 0xFF0000) >> 16;
3089 key.uChar.AsciiChar = 0;
adcc3809 3090 key.dwControlKeyState = modifiers;
ccc2d29c 3091
302fc036 3092 add = w32_kbd_patch_key (&key, w32_keyboard_codepage);
e1dbe924 3093 /* 0 means an unrecognized keycode, negative means
ccc2d29c
GV
3094 dead key. Ignore both. */
3095 while (--add >= 0)
3096 {
3097 /* Forward asciified character sequence. */
3098 post_character_message
a313b291
JR
3099 (hwnd, WM_CHAR,
3100 (unsigned char) key.uChar.AsciiChar, lParam,
ccc2d29c 3101 w32_get_key_modifiers (wParam, lParam));
302fc036 3102 w32_kbd_patch_key (&key, w32_keyboard_codepage);
ccc2d29c
GV
3103 }
3104 return 0;
3105 }
3106 }
3107 else
3108 {
3109 /* Let TranslateMessage handle everything else. */
3110 windows_translate = 1;
3111 }
3112 }
3113 }
a1a80b40 3114
adcc3809 3115 translate:
84fb1139
KH
3116 if (windows_translate)
3117 {
e9e23e23 3118 MSG windows_msg = { hwnd, msg, wParam, lParam, 0, {0,0} };
e9e23e23
GV
3119 windows_msg.time = GetMessageTime ();
3120 TranslateMessage (&windows_msg);
84fb1139
KH
3121 goto dflt;
3122 }
3123
ee78dc32 3124 /* Fall through */
7d0393cf 3125
ee78dc32
GV
3126 case WM_SYSCHAR:
3127 case WM_CHAR:
d30be705
EZ
3128 if (wParam > 255 )
3129 {
3130 W32Msg wmsg;
3131
3132 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3133 signal_user_input ();
3134 my_post_msg (&wmsg, hwnd, WM_UNICHAR, wParam, lParam);
3135
3136 }
3137 else
3138 post_character_message (hwnd, msg, wParam, lParam,
3139 w32_get_key_modifiers (wParam, lParam));
ee78dc32 3140 break;
da36a4d6 3141
820eff5a
JR
3142 case WM_UNICHAR:
3143 /* WM_UNICHAR looks promising from the docs, but the exact
3144 circumstances in which TranslateMessage sends it is one of those
3145 Microsoft secret API things that EU and US courts are supposed
3146 to have put a stop to already. Spy++ shows it being sent to Notepad
3147 and other MS apps, but never to Emacs.
3148
3149 Some third party IMEs send it in accordance with the official
3150 documentation though, so handle it here.
3151
3152 UNICODE_NOCHAR is used to test for support for this message.
3153 TRUE indicates that the message is supported. */
3154 if (wParam == UNICODE_NOCHAR)
3155 return TRUE;
3156
3157 {
3158 W32Msg wmsg;
3159 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3160 signal_user_input ();
3161 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3162 }
3163 break;
3164
3165 case WM_IME_CHAR:
fe7a3057 3166 /* If we can't get the IME result as Unicode, use default processing,
820eff5a
JR
3167 which will at least allow characters decodable in the system locale
3168 get through. */
3169 if (!get_composition_string_fn)
3170 goto dflt;
3171
3172 else if (!ignore_ime_char)
3173 {
3174 wchar_t * buffer;
3175 int size, i;
3176 W32Msg wmsg;
3177 HIMC context = get_ime_context_fn (hwnd);
3178 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3179 /* Get buffer size. */
9c88f339 3180 size = get_composition_string_fn (context, GCS_RESULTSTR, NULL, 0);
ed3751c8 3181 buffer = alloca (size);
820eff5a
JR
3182 size = get_composition_string_fn (context, GCS_RESULTSTR,
3183 buffer, size);
c902b920
JR
3184 release_ime_context_fn (hwnd, context);
3185
820eff5a
JR
3186 signal_user_input ();
3187 for (i = 0; i < size / sizeof (wchar_t); i++)
3188 {
3189 my_post_msg (&wmsg, hwnd, WM_UNICHAR, (WPARAM) buffer[i],
3190 lParam);
3191 }
2c93b248
JR
3192 /* Ignore the messages for the rest of the
3193 characters in the string that was output above. */
3194 ignore_ime_char = (size / sizeof (wchar_t)) - 1;
820eff5a 3195 }
2c93b248
JR
3196 else
3197 ignore_ime_char--;
3198
820eff5a
JR
3199 break;
3200
c902b920
JR
3201 case WM_IME_STARTCOMPOSITION:
3202 if (!set_ime_composition_window_fn)
3203 goto dflt;
3204 else
3205 {
3206 COMPOSITIONFORM form;
3207 HIMC context;
3208 struct window *w;
3209
b932cad7
EZ
3210 /* Implementation note: The code below does something that
3211 one shouldn't do: it accesses the window object from a
3212 separate thread, while the main (a.k.a. "Lisp") thread
3213 runs and can legitimately delete and even GC it. That is
3214 why we are extra careful not to futz with a window that
3215 is different from the one recorded when the system caret
3216 coordinates were last modified. That is also why we are
3217 careful not to move the IME window if the window
3218 described by W was deleted, as indicated by its buffer
3219 field being reset to nil. */
c902b920 3220 f = x_window_to_frame (dpyinfo, hwnd);
2e5ce5de
EZ
3221 if (!(f && FRAME_LIVE_P (f)))
3222 break;
c902b920 3223 w = XWINDOW (FRAME_SELECTED_WINDOW (f));
b932cad7
EZ
3224 /* Punt if someone changed the frame's selected window
3225 behind our back. */
3226 if (w != w32_system_caret_window)
3227 break;
c902b920
JR
3228
3229 form.dwStyle = CFS_RECT;
3230 form.ptCurrentPos.x = w32_system_caret_x;
3231 form.ptCurrentPos.y = w32_system_caret_y;
3232
3233 form.rcArea.left = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, 0);
b932cad7
EZ
3234 form.rcArea.top = (WINDOW_TOP_EDGE_Y (w)
3235 + w32_system_caret_hdr_height);
c902b920
JR
3236 form.rcArea.right = (WINDOW_BOX_RIGHT_EDGE_X (w)
3237 - WINDOW_RIGHT_MARGIN_WIDTH (w)
3238 - WINDOW_RIGHT_FRINGE_WIDTH (w));
3239 form.rcArea.bottom = (WINDOW_BOTTOM_EDGE_Y (w)
880e6158 3240 - WINDOW_BOTTOM_DIVIDER_WIDTH (w)
b932cad7
EZ
3241 - w32_system_caret_mode_height);
3242
3243 /* Punt if the window was deleted behind our back. */
3244 if (!BUFFERP (w->contents))
3245 break;
c902b920
JR
3246
3247 context = get_ime_context_fn (hwnd);
20d60baf
JR
3248
3249 if (!context)
3250 break;
3251
c902b920
JR
3252 set_ime_composition_window_fn (context, &form);
3253 release_ime_context_fn (hwnd, context);
3254 }
3255 break;
3256
820eff5a
JR
3257 case WM_IME_ENDCOMPOSITION:
3258 ignore_ime_char = 0;
3259 goto dflt;
3260
5ac45f98
GV
3261 /* Simulate middle mouse button events when left and right buttons
3262 are used together, but only if user has two button mouse. */
ee78dc32 3263 case WM_LBUTTONDOWN:
5ac45f98 3264 case WM_RBUTTONDOWN:
2ba49441 3265 if (w32_num_mouse_buttons > 2)
5ac45f98
GV
3266 goto handle_plain_button;
3267
3268 {
3269 int this = (msg == WM_LBUTTONDOWN) ? LMOUSE : RMOUSE;
3270 int other = (msg == WM_LBUTTONDOWN) ? RMOUSE : LMOUSE;
3271
3cb20f4a
RS
3272 if (button_state & this)
3273 return 0;
5ac45f98
GV
3274
3275 if (button_state == 0)
3276 SetCapture (hwnd);
3277
3278 button_state |= this;
3279
3280 if (button_state & other)
3281 {
84fb1139 3282 if (mouse_button_timer)
5ac45f98 3283 {
84fb1139
KH
3284 KillTimer (hwnd, mouse_button_timer);
3285 mouse_button_timer = 0;
5ac45f98
GV
3286
3287 /* Generate middle mouse event instead. */
3288 msg = WM_MBUTTONDOWN;
3289 button_state |= MMOUSE;
3290 }
3291 else if (button_state & MMOUSE)
3292 {
3293 /* Ignore button event if we've already generated a
3294 middle mouse down event. This happens if the
3295 user releases and press one of the two buttons
3296 after we've faked a middle mouse event. */
3297 return 0;
3298 }
3299 else
3300 {
3301 /* Flush out saved message. */
84fb1139 3302 post_msg (&saved_mouse_button_msg);
5ac45f98 3303 }
fbd6baed 3304 wmsg.dwModifiers = w32_get_modifiers ();
5ac45f98 3305 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
f5f69b6b 3306 signal_user_input ();
5ac45f98
GV
3307
3308 /* Clear message buffer. */
84fb1139 3309 saved_mouse_button_msg.msg.hwnd = 0;
5ac45f98
GV
3310 }
3311 else
3312 {
3313 /* Hold onto message for now. */
84fb1139 3314 mouse_button_timer =
adcc3809 3315 SetTimer (hwnd, MOUSE_BUTTON_ID,
2ba49441 3316 w32_mouse_button_tolerance, NULL);
84fb1139
KH
3317 saved_mouse_button_msg.msg.hwnd = hwnd;
3318 saved_mouse_button_msg.msg.message = msg;
3319 saved_mouse_button_msg.msg.wParam = wParam;
3320 saved_mouse_button_msg.msg.lParam = lParam;
3321 saved_mouse_button_msg.msg.time = GetMessageTime ();
fbd6baed 3322 saved_mouse_button_msg.dwModifiers = w32_get_modifiers ();
5ac45f98
GV
3323 }
3324 }
3325 return 0;
3326
ee78dc32 3327 case WM_LBUTTONUP:
5ac45f98 3328 case WM_RBUTTONUP:
2ba49441 3329 if (w32_num_mouse_buttons > 2)
5ac45f98
GV
3330 goto handle_plain_button;
3331
3332 {
3333 int this = (msg == WM_LBUTTONUP) ? LMOUSE : RMOUSE;
3334 int other = (msg == WM_LBUTTONUP) ? RMOUSE : LMOUSE;
3335
3cb20f4a
RS
3336 if ((button_state & this) == 0)
3337 return 0;
5ac45f98
GV
3338
3339 button_state &= ~this;
3340
3341 if (button_state & MMOUSE)
3342 {
3343 /* Only generate event when second button is released. */
3344 if ((button_state & other) == 0)
3345 {
3346 msg = WM_MBUTTONUP;
3347 button_state &= ~MMOUSE;
3348
1088b922 3349 if (button_state) emacs_abort ();
5ac45f98
GV
3350 }
3351 else
3352 return 0;
3353 }
3354 else
3355 {
3356 /* Flush out saved message if necessary. */
84fb1139 3357 if (saved_mouse_button_msg.msg.hwnd)
5ac45f98 3358 {
84fb1139 3359 post_msg (&saved_mouse_button_msg);
5ac45f98
GV
3360 }
3361 }
fbd6baed 3362 wmsg.dwModifiers = w32_get_modifiers ();
5ac45f98 3363 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
f5f69b6b 3364 signal_user_input ();
5ac45f98
GV
3365
3366 /* Always clear message buffer and cancel timer. */
84fb1139
KH
3367 saved_mouse_button_msg.msg.hwnd = 0;
3368 KillTimer (hwnd, mouse_button_timer);
3369 mouse_button_timer = 0;
5ac45f98
GV
3370
3371 if (button_state == 0)
3372 ReleaseCapture ();
3373 }
3374 return 0;
3375
74214547
JR
3376 case WM_XBUTTONDOWN:
3377 case WM_XBUTTONUP:
3378 if (w32_pass_extra_mouse_buttons_to_system)
3379 goto dflt;
3380 /* else fall through and process them. */
ee78dc32
GV
3381 case WM_MBUTTONDOWN:
3382 case WM_MBUTTONUP:
5ac45f98 3383 handle_plain_button:
ee78dc32
GV
3384 {
3385 BOOL up;
1edf84e7 3386 int button;
ee78dc32 3387
b48f9276
EZ
3388 /* Ignore middle and extra buttons as long as the menu is active. */
3389 f = x_window_to_frame (dpyinfo, hwnd);
3390 if (f && f->output_data.w32->menubar_active)
3391 return 0;
3392
74214547 3393 if (parse_button (msg, HIWORD (wParam), &button, &up))
ee78dc32
GV
3394 {
3395 if (up) ReleaseCapture ();
3396 else SetCapture (hwnd);
7d0393cf 3397 button = (button == 0) ? LMOUSE :
1edf84e7
GV
3398 ((button == 1) ? MMOUSE : RMOUSE);
3399 if (up)
3400 button_state &= ~button;
3401 else
3402 button_state |= button;
ee78dc32
GV
3403 }
3404 }
7d0393cf 3405
fbd6baed 3406 wmsg.dwModifiers = w32_get_modifiers ();
ee78dc32 3407 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
f0c947b5 3408 signal_user_input ();
74214547
JR
3409
3410 /* Need to return true for XBUTTON messages, false for others,
3411 to indicate that we processed the message. */
3412 return (msg == WM_XBUTTONDOWN || msg == WM_XBUTTONUP);
5ac45f98 3413
5ac45f98 3414 case WM_MOUSEMOVE:
f93bd8e4
EZ
3415 /* Ignore mouse movements as long as the menu is active. These
3416 movements are processed by the window manager anyway, and
3417 it's wrong to handle them as if they happened on the
3418 underlying frame. */
3419 f = x_window_to_frame (dpyinfo, hwnd);
3420 if (f && f->output_data.w32->menubar_active)
3421 return 0;
3422
9eb16b62
JR
3423 /* If the mouse has just moved into the frame, start tracking
3424 it, so we will be notified when it leaves the frame. Mouse
3425 tracking only works under W98 and NT4 and later. On earlier
3426 versions, there is no way of telling when the mouse leaves the
3427 frame, so we just have to put up with help-echo and mouse
3428 highlighting remaining while the frame is not active. */
ccc83f50
EZ
3429 if (track_mouse_event_fn && !track_mouse_window
3430 /* If the menu bar is active, turning on tracking of mouse
3431 movement events might send these events to the tooltip
3432 frame, if the user happens to move the mouse pointer over
3433 the tooltip. But since we don't process events for
3434 tooltip frames, this causes Windows to present a
3435 hourglass cursor, which is ugly and unexpected. So don't
3436 enable tracking mouse events in this case; they will be
3437 restarted when the menu pops down. (Confusingly, the
3438 menubar_active member of f->output_data.w32, tested
3439 above, is only set when a menu was popped up _not_ from
3440 the frame's menu bar, but via x-popup-menu.) */
3441 && !menubar_in_use)
9eb16b62
JR
3442 {
3443 TRACKMOUSEEVENT tme;
3444 tme.cbSize = sizeof (tme);
3445 tme.dwFlags = TME_LEAVE;
3446 tme.hwndTrack = hwnd;
3447
3448 track_mouse_event_fn (&tme);
3449 track_mouse_window = hwnd;
3450 }
3451 case WM_VSCROLL:
2ba49441 3452 if (w32_mouse_move_interval <= 0
84fb1139
KH
3453 || (msg == WM_MOUSEMOVE && button_state == 0))
3454 {
fbd6baed 3455 wmsg.dwModifiers = w32_get_modifiers ();
84fb1139
KH
3456 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3457 return 0;
3458 }
7d0393cf 3459
84fb1139
KH
3460 /* Hang onto mouse move and scroll messages for a bit, to avoid
3461 sending such events to Emacs faster than it can process them.
3462 If we get more events before the timer from the first message
3463 expires, we just replace the first message. */
3464
3465 if (saved_mouse_move_msg.msg.hwnd == 0)
3466 mouse_move_timer =
adcc3809 3467 SetTimer (hwnd, MOUSE_MOVE_ID,
2ba49441 3468 w32_mouse_move_interval, NULL);
84fb1139
KH
3469
3470 /* Hold onto message for now. */
3471 saved_mouse_move_msg.msg.hwnd = hwnd;
3472 saved_mouse_move_msg.msg.message = msg;
3473 saved_mouse_move_msg.msg.wParam = wParam;
3474 saved_mouse_move_msg.msg.lParam = lParam;
3475 saved_mouse_move_msg.msg.time = GetMessageTime ();
fbd6baed 3476 saved_mouse_move_msg.dwModifiers = w32_get_modifiers ();
7d0393cf 3477
84fb1139
KH
3478 return 0;
3479
1edf84e7 3480 case WM_MOUSEWHEEL:
fd142562 3481 case WM_DROPFILES:
1edf84e7
GV
3482 wmsg.dwModifiers = w32_get_modifiers ();
3483 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
f0c947b5 3484 signal_user_input ();
1edf84e7
GV
3485 return 0;
3486
0b151762
JR
3487 case WM_APPCOMMAND:
3488 if (w32_pass_multimedia_buttons_to_system)
3489 goto dflt;
3490 /* Otherwise, pass to lisp, the same way we do with mousehwheel. */
fd142562 3491 case WM_MOUSEHWHEEL:
cb9e33d4
RS
3492 wmsg.dwModifiers = w32_get_modifiers ();
3493 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
f0c947b5 3494 signal_user_input ();
fd142562
JR
3495 /* Non-zero must be returned when WM_MOUSEHWHEEL messages are
3496 handled, to prevent the system trying to handle it by faking
3497 scroll bar events. */
3498 return 1;
cb9e33d4 3499
84fb1139
KH
3500 case WM_TIMER:
3501 /* Flush out saved messages if necessary. */
3502 if (wParam == mouse_button_timer)
5ac45f98 3503 {
84fb1139
KH
3504 if (saved_mouse_button_msg.msg.hwnd)
3505 {
3506 post_msg (&saved_mouse_button_msg);
f0c947b5 3507 signal_user_input ();
84fb1139
KH
3508 saved_mouse_button_msg.msg.hwnd = 0;
3509 }
3510 KillTimer (hwnd, mouse_button_timer);
3511 mouse_button_timer = 0;
3512 }
3513 else if (wParam == mouse_move_timer)
3514 {
3515 if (saved_mouse_move_msg.msg.hwnd)
3516 {
3517 post_msg (&saved_mouse_move_msg);
3518 saved_mouse_move_msg.msg.hwnd = 0;
3519 }
3520 KillTimer (hwnd, mouse_move_timer);
3521 mouse_move_timer = 0;
5ac45f98 3522 }
48094ace
JR
3523 else if (wParam == menu_free_timer)
3524 {
3525 KillTimer (hwnd, menu_free_timer);
3526 menu_free_timer = 0;
27605fa7 3527 f = x_window_to_frame (dpyinfo, hwnd);
5d22ded9 3528 /* If a popup menu is active, don't wipe its strings. */
58e55497 3529 if (menubar_in_use
5d22ded9 3530 && current_popup_menu == NULL)
48094ace
JR
3531 {
3532 /* Free memory used by owner-drawn and help-echo strings. */
3533 w32_free_menu_strings (hwnd);
5df75e47
JR
3534 if (f)
3535 f->output_data.w32->menubar_active = 0;
58e55497 3536 menubar_in_use = 0;
48094ace
JR
3537 }
3538 }
5ac45f98 3539 return 0;
7d0393cf 3540
84fb1139
KH
3541 case WM_NCACTIVATE:
3542 /* Windows doesn't send us focus messages when putting up and
e9e23e23 3543 taking down a system popup dialog as for Ctrl-Alt-Del on Windows 95.
84fb1139
KH
3544 The only indication we get that something happened is receiving
3545 this message afterwards. So this is a good time to reset our
3546 keyboard modifiers' state. */
3547 reset_modifiers ();
3548 goto dflt;
da36a4d6 3549
1edf84e7 3550 case WM_INITMENU:
487163ac
AI
3551 button_state = 0;
3552 ReleaseCapture ();
1edf84e7
GV
3553 /* We must ensure menu bar is fully constructed and up to date
3554 before allowing user interaction with it. To achieve this
3555 we send this message to the lisp thread and wait for a
3556 reply (whose value is not actually needed) to indicate that
3557 the menu bar is now ready for use, so we can now return.
3558
3559 To remain responsive in the meantime, we enter a nested message
3560 loop that can process all other messages.
3561
3562 However, we skip all this if the message results from calling
3563 TrackPopupMenu - in fact, we must NOT attempt to send the lisp
3564 thread a message because it is blocked on us at this point. We
3565 set menubar_active before calling TrackPopupMenu to indicate
3566 this (there is no possibility of confusion with real menubar
3567 being active). */
3568
3569 f = x_window_to_frame (dpyinfo, hwnd);
3570 if (f
3571 && (f->output_data.w32->menubar_active
3572 /* We can receive this message even in the absence of a
3573 menubar (ie. when the system menu is activated) - in this
3574 case we do NOT want to forward the message, otherwise it
3575 will cause the menubar to suddenly appear when the user
3576 had requested it to be turned off! */
3577 || f->output_data.w32->menubar_widget == NULL))
3578 return 0;
3579
3580 {
3581 deferred_msg msg_buf;
3582
3583 /* Detect if message has already been deferred; in this case
3584 we cannot return any sensible value to ignore this. */
3585 if (find_deferred_msg (hwnd, msg) != NULL)
1088b922 3586 emacs_abort ();
1edf84e7 3587
58e55497 3588 menubar_in_use = 1;
90816b86 3589
1edf84e7
GV
3590 return send_deferred_msg (&msg_buf, hwnd, msg, wParam, lParam);
3591 }
3592
3593 case WM_EXITMENULOOP:
3594 f = x_window_to_frame (dpyinfo, hwnd);
3595
5d22ded9
JR
3596 /* If a menu is still active, check again after a short delay,
3597 since Windows often (always?) sends the WM_EXITMENULOOP
3598 before the corresponding WM_COMMAND message.
3599 Don't do this if a popup menu is active, since it is only
3600 menubar menus that require cleaning up in this way.
3601 */
58e55497 3602 if (f && menubar_in_use && current_popup_menu == NULL)
48094ace 3603 menu_free_timer = SetTimer (hwnd, MENU_FREE_ID, MENU_FREE_DELAY, NULL);
d148e14d
JR
3604
3605 /* If hourglass cursor should be displayed, display it now. */
3606 if (f && f->output_data.w32->hourglass_p)
3607 SetCursor (f->output_data.w32->hourglass_cursor);
3608
1edf84e7
GV
3609 goto dflt;
3610
126f2e35 3611 case WM_MENUSELECT:
4e3a1c61
JR
3612 /* Direct handling of help_echo in menus. Should be safe now
3613 that we generate the help_echo by placing a help event in the
3614 keyboard buffer. */
ca56d953 3615 {
ca56d953
JR
3616 HMENU menu = (HMENU) lParam;
3617 UINT menu_item = (UINT) LOWORD (wParam);
3618 UINT flags = (UINT) HIWORD (wParam);
3619
4e3a1c61 3620 w32_menu_display_help (hwnd, menu, menu_item, flags);
ca56d953 3621 }
126f2e35
JR
3622 return 0;
3623
87996783
GV
3624 case WM_MEASUREITEM:
3625 f = x_window_to_frame (dpyinfo, hwnd);
3626 if (f)
3627 {
3628 MEASUREITEMSTRUCT * pMis = (MEASUREITEMSTRUCT *) lParam;
3629
3630 if (pMis->CtlType == ODT_MENU)
3631 {
3632 /* Work out dimensions for popup menu titles. */
3633 char * title = (char *) pMis->itemData;
3634 HDC hdc = GetDC (hwnd);
3635 HFONT menu_font = GetCurrentObject (hdc, OBJ_FONT);
3636 LOGFONT menu_logfont;
3637 HFONT old_font;
3638 SIZE size;
3639
3640 GetObject (menu_font, sizeof (menu_logfont), &menu_logfont);
3641 menu_logfont.lfWeight = FW_BOLD;
3642 menu_font = CreateFontIndirect (&menu_logfont);
3643 old_font = SelectObject (hdc, menu_font);
3644
dfff8a69
JR
3645 pMis->itemHeight = GetSystemMetrics (SM_CYMENUSIZE);
3646 if (title)
3647 {
b4005349
JR
3648 if (unicode_append_menu)
3649 GetTextExtentPoint32W (hdc, (WCHAR *) title,
3650 wcslen ((WCHAR *) title),
3651 &size);
3652 else
3653 GetTextExtentPoint32 (hdc, title, strlen (title), &size);
3654
dfff8a69
JR
3655 pMis->itemWidth = size.cx;
3656 if (pMis->itemHeight < size.cy)
3657 pMis->itemHeight = size.cy;
3658 }
3659 else
3660 pMis->itemWidth = 0;
87996783
GV
3661
3662 SelectObject (hdc, old_font);
3663 DeleteObject (menu_font);
3664 ReleaseDC (hwnd, hdc);
3665 return TRUE;
3666 }
3667 }
3668 return 0;
3669
3670 case WM_DRAWITEM:
3671 f = x_window_to_frame (dpyinfo, hwnd);
3672 if (f)
3673 {
3674 DRAWITEMSTRUCT * pDis = (DRAWITEMSTRUCT *) lParam;
3675
3676 if (pDis->CtlType == ODT_MENU)
3677 {
3678 /* Draw popup menu title. */
3679 char * title = (char *) pDis->itemData;
212da13b
JR
3680 if (title)
3681 {
3682 HDC hdc = pDis->hDC;
3683 HFONT menu_font = GetCurrentObject (hdc, OBJ_FONT);
3684 LOGFONT menu_logfont;
3685 HFONT old_font;
3686
3687 GetObject (menu_font, sizeof (menu_logfont), &menu_logfont);
3688 menu_logfont.lfWeight = FW_BOLD;
3689 menu_font = CreateFontIndirect (&menu_logfont);
3690 old_font = SelectObject (hdc, menu_font);
3691
b4005349
JR
3692 /* Always draw title as if not selected. */
3693 if (unicode_append_menu)
3694 ExtTextOutW (hdc,
3695 pDis->rcItem.left
3696 + GetSystemMetrics (SM_CXMENUCHECK),
3697 pDis->rcItem.top,
3698 ETO_OPAQUE, &pDis->rcItem,
3699 (WCHAR *) title,
3700 wcslen ((WCHAR *) title), NULL);
3701 else
3702 ExtTextOut (hdc,
3703 pDis->rcItem.left
3704 + GetSystemMetrics (SM_CXMENUCHECK),
3705 pDis->rcItem.top,
3706 ETO_OPAQUE, &pDis->rcItem,
3707 title, strlen (title), NULL);
212da13b
JR
3708
3709 SelectObject (hdc, old_font);
3710 DeleteObject (menu_font);
3711 }
87996783
GV
3712 return TRUE;
3713 }
3714 }
3715 return 0;
3716
1edf84e7
GV
3717#if 0
3718 /* Still not right - can't distinguish between clicks in the
3719 client area of the frame from clicks forwarded from the scroll
3720 bars - may have to hook WM_NCHITTEST to remember the mouse
3721 position and then check if it is in the client area ourselves. */
3722 case WM_MOUSEACTIVATE:
3723 /* Discard the mouse click that activates a frame, allowing the
3724 user to click anywhere without changing point (or worse!).
3725 Don't eat mouse clicks on scrollbars though!! */
3726 if (LOWORD (lParam) == HTCLIENT )
3727 return MA_ACTIVATEANDEAT;
3728 goto dflt;
3729#endif
3730
9eb16b62
JR
3731 case WM_MOUSELEAVE:
3732 /* No longer tracking mouse. */
3733 track_mouse_window = NULL;
3734
1edf84e7 3735 case WM_ACTIVATEAPP:
ccc2d29c 3736 case WM_ACTIVATE:
1edf84e7
GV
3737 case WM_WINDOWPOSCHANGED:
3738 case WM_SHOWWINDOW:
3739 /* Inform lisp thread that a frame might have just been obscured
3740 or exposed, so should recheck visibility of all frames. */
3741 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3742 goto dflt;
3743
da36a4d6 3744 case WM_SETFOCUS:
adcc3809
GV
3745 dpyinfo->faked_key = 0;
3746 reset_modifiers ();
ccc2d29c
GV
3747 register_hot_keys (hwnd);
3748 goto command;
8681157a 3749 case WM_KILLFOCUS:
ccc2d29c 3750 unregister_hot_keys (hwnd);
487163ac
AI
3751 button_state = 0;
3752 ReleaseCapture ();
65906840
JR
3753 /* Relinquish the system caret. */
3754 if (w32_system_caret_hwnd)
3755 {
93f2ca61 3756 w32_visible_system_caret_hwnd = NULL;
d285988b
JR
3757 w32_system_caret_hwnd = NULL;
3758 DestroyCaret ();
65906840 3759 }
48094ace
JR
3760 goto command;
3761 case WM_COMMAND:
58e55497 3762 menubar_in_use = 0;
48094ace
JR
3763 f = x_window_to_frame (dpyinfo, hwnd);
3764 if (f && HIWORD (wParam) == 0)
3765 {
48094ace
JR
3766 if (menu_free_timer)
3767 {
3768 KillTimer (hwnd, menu_free_timer);
7d0393cf 3769 menu_free_timer = 0;
48094ace
JR
3770 }
3771 }
ee78dc32
GV
3772 case WM_MOVE:
3773 case WM_SIZE:
ccc2d29c 3774 command:
fbd6baed 3775 wmsg.dwModifiers = w32_get_modifiers ();
ee78dc32
GV
3776 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3777 goto dflt;
8847d890 3778
d5781bb6
JR
3779 case WM_DESTROY:
3780 CoUninitialize ();
3781 return 0;
3782
8847d890 3783 case WM_CLOSE:
fbd6baed 3784 wmsg.dwModifiers = w32_get_modifiers ();
8847d890
RS
3785 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3786 return 0;
3787
ee78dc32 3788 case WM_WINDOWPOSCHANGING:
bfd6edcc 3789 /* Don't restrict the sizing of tip frames. */
880e6158 3790 if (frame_resize_pixelwise || hwnd == tip_window)
bfd6edcc 3791 return 0;
1f635a07
EC
3792
3793 /* Don't restrict the sizing of fullscreened frames, allowing them to be
3794 flush with the sides of the screen. */
3795 f = x_window_to_frame (dpyinfo, hwnd);
3796 if (f && FRAME_PREV_FSMODE (f) != FULLSCREEN_NONE)
3797 return 0;
3798
ee78dc32
GV
3799 {
3800 WINDOWPLACEMENT wp;
3801 LPWINDOWPOS lppos = (WINDOWPOS *) lParam;
1edf84e7
GV
3802
3803 wp.length = sizeof (WINDOWPLACEMENT);
ee78dc32 3804 GetWindowPlacement (hwnd, &wp);
7d0393cf 3805
1edf84e7 3806 if (wp.showCmd != SW_SHOWMINIMIZED && (lppos->flags & SWP_NOSIZE) == 0)
ee78dc32
GV
3807 {
3808 RECT rect;
3809 int wdiff;
3810 int hdiff;
1edf84e7
GV
3811 DWORD font_width;
3812 DWORD line_height;
3813 DWORD internal_border;
3814 DWORD scrollbar_extra;
ee78dc32 3815 RECT wr;
7d0393cf 3816
74084731 3817 wp.length = sizeof (wp);
ee78dc32 3818 GetWindowRect (hwnd, &wr);
7d0393cf 3819
3c190163 3820 enter_crit ();
7d0393cf 3821
1edf84e7
GV
3822 font_width = GetWindowLong (hwnd, WND_FONTWIDTH_INDEX);
3823 line_height = GetWindowLong (hwnd, WND_LINEHEIGHT_INDEX);
3824 internal_border = GetWindowLong (hwnd, WND_BORDER_INDEX);
3825 scrollbar_extra = GetWindowLong (hwnd, WND_SCROLLBAR_INDEX);
7d0393cf 3826
3c190163 3827 leave_crit ();
7d0393cf 3828
ee78dc32 3829 memset (&rect, 0, sizeof (rect));
7d0393cf 3830 AdjustWindowRect (&rect, GetWindowLong (hwnd, GWL_STYLE),
ee78dc32
GV
3831 GetMenu (hwnd) != NULL);
3832
1edf84e7
GV
3833 /* Force width and height of client area to be exact
3834 multiples of the character cell dimensions. */
3835 wdiff = (lppos->cx - (rect.right - rect.left)
3836 - 2 * internal_border - scrollbar_extra)
3837 % font_width;
3838 hdiff = (lppos->cy - (rect.bottom - rect.top)
3839 - 2 * internal_border)
3840 % line_height;
7d0393cf 3841
ee78dc32
GV
3842 if (wdiff || hdiff)
3843 {
7d0393cf
JB
3844 /* For right/bottom sizing we can just fix the sizes.
3845 However for top/left sizing we will need to fix the X
ee78dc32 3846 and Y positions as well. */
7d0393cf 3847
8a4c4c7f
JB
3848 int cx_mintrack = GetSystemMetrics (SM_CXMINTRACK);
3849 int cy_mintrack = GetSystemMetrics (SM_CYMINTRACK);
3850
3851 lppos->cx = max (lppos->cx - wdiff, cx_mintrack);
3852 lppos->cy = max (lppos->cy - hdiff, cy_mintrack);
7d0393cf
JB
3853
3854 if (wp.showCmd != SW_SHOWMAXIMIZED
1edf84e7 3855 && (lppos->flags & SWP_NOMOVE) == 0)
ee78dc32
GV
3856 {
3857 if (lppos->x != wr.left || lppos->y != wr.top)
3858 {
3859 lppos->x += wdiff;
3860 lppos->y += hdiff;
3861 }
3862 else
3863 {
3864 lppos->flags |= SWP_NOMOVE;
3865 }
3866 }
7d0393cf 3867
1edf84e7 3868 return 0;
ee78dc32
GV
3869 }
3870 }
3871 }
7d0393cf 3872
ee78dc32 3873 goto dflt;
1edf84e7 3874
b1f918f8 3875 case WM_GETMINMAXINFO:
bf853fee
AI
3876 /* Hack to allow resizing the Emacs frame above the screen size.
3877 Note that Windows 9x limits coordinates to 16-bits. */
3878 ((LPMINMAXINFO) lParam)->ptMaxTrackSize.x = 32767;
3879 ((LPMINMAXINFO) lParam)->ptMaxTrackSize.y = 32767;
b1f918f8
GV
3880 return 0;
3881
c9b2104d
JR
3882 case WM_SETCURSOR:
3883 if (LOWORD (lParam) == HTCLIENT)
d148e14d
JR
3884 {
3885 f = x_window_to_frame (dpyinfo, hwnd);
5df75e47
JR
3886 if (f && f->output_data.w32->hourglass_p
3887 && !menubar_in_use && !current_popup_menu)
d148e14d 3888 SetCursor (f->output_data.w32->hourglass_cursor);
5df75e47 3889 else if (f)
d148e14d
JR
3890 SetCursor (f->output_data.w32->current_cursor);
3891 return 0;
3892 }
c9b2104d 3893 goto dflt;
c922a224 3894
c9b2104d
JR
3895 case WM_EMACS_SETCURSOR:
3896 {
3897 Cursor cursor = (Cursor) wParam;
d148e14d
JR
3898 f = x_window_to_frame (dpyinfo, hwnd);
3899 if (f && cursor)
3900 {
3901 f->output_data.w32->current_cursor = cursor;
3902 if (!f->output_data.w32->hourglass_p)
3903 SetCursor (cursor);
3904 }
c9b2104d
JR
3905 return 0;
3906 }
c922a224 3907
1edf84e7
GV
3908 case WM_EMACS_CREATESCROLLBAR:
3909 return (LRESULT) w32_createscrollbar ((struct frame *) wParam,
3910 (struct scroll_bar *) lParam);
3911
5ac45f98 3912 case WM_EMACS_SHOWWINDOW:
1edf84e7
GV
3913 return ShowWindow ((HWND) wParam, (WPARAM) lParam);
3914
85d0efd1 3915 case WM_EMACS_BRINGTOTOP:
dfdb4047 3916 case WM_EMACS_SETFOREGROUND:
ce6059da
AI
3917 {
3918 HWND foreground_window;
3919 DWORD foreground_thread, retval;
3920
3921 /* On NT 5.0, and apparently Windows 98, it is necessary to
3922 attach to the thread that currently has focus in order to
3923 pull the focus away from it. */
3924 foreground_window = GetForegroundWindow ();
3925 foreground_thread = GetWindowThreadProcessId (foreground_window, NULL);
3926 if (!foreground_window
3927 || foreground_thread == GetCurrentThreadId ()
3928 || !AttachThreadInput (GetCurrentThreadId (),
3929 foreground_thread, TRUE))
3930 foreground_thread = 0;
3931
3932 retval = SetForegroundWindow ((HWND) wParam);
85d0efd1
EZ
3933 if (msg == WM_EMACS_BRINGTOTOP)
3934 retval = BringWindowToTop ((HWND) wParam);
ce6059da
AI
3935
3936 /* Detach from the previous foreground thread. */
3937 if (foreground_thread)
3938 AttachThreadInput (GetCurrentThreadId (),
3939 foreground_thread, FALSE);
3940
3941 return retval;
3942 }
dfdb4047 3943
5ac45f98
GV
3944 case WM_EMACS_SETWINDOWPOS:
3945 {
1edf84e7
GV
3946 WINDOWPOS * pos = (WINDOWPOS *) wParam;
3947 return SetWindowPos (hwnd, pos->hwndInsertAfter,
5ac45f98
GV
3948 pos->x, pos->y, pos->cx, pos->cy, pos->flags);
3949 }
1edf84e7 3950
ee78dc32 3951 case WM_EMACS_DESTROYWINDOW:
cb9e33d4 3952 DragAcceptFiles ((HWND) wParam, FALSE);
1edf84e7
GV
3953 return DestroyWindow ((HWND) wParam);
3954
93f2ca61
JR
3955 case WM_EMACS_HIDE_CARET:
3956 return HideCaret (hwnd);
3957
3958 case WM_EMACS_SHOW_CARET:
3959 return ShowCaret (hwnd);
3960
65906840
JR
3961 case WM_EMACS_DESTROY_CARET:
3962 w32_system_caret_hwnd = NULL;
93f2ca61 3963 w32_visible_system_caret_hwnd = NULL;
65906840
JR
3964 return DestroyCaret ();
3965
3966 case WM_EMACS_TRACK_CARET:
3967 /* If there is currently no system caret, create one. */
3968 if (w32_system_caret_hwnd == NULL)
3969 {
93f2ca61 3970 /* Use the default caret width, and avoid changing it
ee7683eb 3971 unnecessarily, as it confuses screen reader software. */
65906840 3972 w32_system_caret_hwnd = hwnd;
93f2ca61 3973 CreateCaret (hwnd, NULL, 0,
65906840
JR
3974 w32_system_caret_height);
3975 }
7d0393cf 3976
93f2ca61
JR
3977 if (!SetCaretPos (w32_system_caret_x, w32_system_caret_y))
3978 return 0;
3979 /* Ensure visible caret gets turned on when requested. */
3980 else if (w32_use_visible_system_caret
3981 && w32_visible_system_caret_hwnd != hwnd)
3982 {
3983 w32_visible_system_caret_hwnd = hwnd;
3984 return ShowCaret (hwnd);
3985 }
3986 /* Ensure visible caret gets turned off when requested. */
3987 else if (!w32_use_visible_system_caret
3988 && w32_visible_system_caret_hwnd)
3989 {
3990 w32_visible_system_caret_hwnd = NULL;
3991 return HideCaret (hwnd);
3992 }
3993 else
3994 return 1;
65906840 3995
1edf84e7
GV
3996 case WM_EMACS_TRACKPOPUPMENU:
3997 {
3998 UINT flags;
3999 POINT *pos;
4000 int retval;
4001 pos = (POINT *)lParam;
4002 flags = TPM_CENTERALIGN;
4003 if (button_state & LMOUSE)
4004 flags |= TPM_LEFTBUTTON;
4005 else if (button_state & RMOUSE)
4006 flags |= TPM_RIGHTBUTTON;
7d0393cf 4007
87996783 4008 /* Remember we did a SetCapture on the initial mouse down event,
c80e3b4a 4009 so for safety, we make sure the capture is canceled now. */
87996783 4010 ReleaseCapture ();
490822ff 4011 button_state = 0;
87996783 4012
1edf84e7
GV
4013 /* Use menubar_active to indicate that WM_INITMENU is from
4014 TrackPopupMenu below, and should be ignored. */
4015 f = x_window_to_frame (dpyinfo, hwnd);
4016 if (f)
4017 f->output_data.w32->menubar_active = 1;
7d0393cf
JB
4018
4019 if (TrackPopupMenu ((HMENU)wParam, flags, pos->x, pos->y,
1edf84e7
GV
4020 0, hwnd, NULL))
4021 {
4022 MSG amsg;
4023 /* Eat any mouse messages during popupmenu */
4024 while (PeekMessage (&amsg, hwnd, WM_MOUSEFIRST, WM_MOUSELAST,
4025 PM_REMOVE));
4026 /* Get the menu selection, if any */
4027 if (PeekMessage (&amsg, hwnd, WM_COMMAND, WM_COMMAND, PM_REMOVE))
4028 {
4029 retval = LOWORD (amsg.wParam);
4030 }
4031 else
4032 {
4033 retval = 0;
4034 }
1edf84e7
GV
4035 }
4036 else
4037 {
4038 retval = -1;
4039 }
4040
4041 return retval;
4042 }
ae756559 4043 case WM_EMACS_FILENOTIFY:
ae756559
EZ
4044 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4045 return 1;
1edf84e7 4046
ee78dc32 4047 default:
93fbe8b7
GV
4048 /* Check for messages registered at runtime. */
4049 if (msg == msh_mousewheel)
4050 {
4051 wmsg.dwModifiers = w32_get_modifiers ();
4052 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
f0c947b5 4053 signal_user_input ();
93fbe8b7
GV
4054 return 0;
4055 }
7d0393cf 4056
ee78dc32 4057 dflt:
9b855fd6 4058 return (w32_unicode_gui ? DefWindowProcW : DefWindowProcA) (hwnd, msg, wParam, lParam);
ee78dc32 4059 }
7d0393cf 4060
1edf84e7
GV
4061 /* The most common default return code for handled messages is 0. */
4062 return 0;
ee78dc32
GV
4063}
4064
0962822d 4065static void
b56ceb92 4066my_create_window (struct frame * f)
ee78dc32
GV
4067{
4068 MSG msg;
4069
1edf84e7 4070 if (!PostThreadMessage (dwWindowsThreadId, WM_EMACS_CREATEWINDOW, (WPARAM)f, 0))
1088b922 4071 emacs_abort ();
ee78dc32
GV
4072 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
4073}
4074
ca56d953
JR
4075
4076/* Create a tooltip window. Unlike my_create_window, we do not do this
4077 indirectly via the Window thread, as we do not need to process Window
4078 messages for the tooltip. Creating tooltips indirectly also creates
4079 deadlocks when tooltips are created for menu items. */
0962822d 4080static void
b56ceb92 4081my_create_tip_window (struct frame *f)
ca56d953 4082{
bfd6edcc 4083 RECT rect;
ca56d953 4084
bfd6edcc 4085 rect.left = rect.top = 0;
be786000
KS
4086 rect.right = FRAME_PIXEL_WIDTH (f);
4087 rect.bottom = FRAME_PIXEL_HEIGHT (f);
bfd6edcc
JR
4088
4089 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
4090 FRAME_EXTERNAL_MENU_BAR (f));
4091
4092 tip_window = FRAME_W32_WINDOW (f)
ca56d953
JR
4093 = CreateWindow (EMACS_CLASS,
4094 f->namebuf,
4095 f->output_data.w32->dwStyle,
be786000
KS
4096 f->left_pos,
4097 f->top_pos,
bfd6edcc
JR
4098 rect.right - rect.left,
4099 rect.bottom - rect.top,
ca56d953
JR
4100 FRAME_W32_WINDOW (SELECTED_FRAME ()), /* owner */
4101 NULL,
4102 hinst,
4103 NULL);
4104
bfd6edcc 4105 if (tip_window)
ca56d953 4106 {
be786000
KS
4107 SetWindowLong (tip_window, WND_FONTWIDTH_INDEX, FRAME_COLUMN_WIDTH (f));
4108 SetWindowLong (tip_window, WND_LINEHEIGHT_INDEX, FRAME_LINE_HEIGHT (f));
4109 SetWindowLong (tip_window, WND_BORDER_INDEX, FRAME_INTERNAL_BORDER_WIDTH (f));
bfd6edcc
JR
4110 SetWindowLong (tip_window, WND_BACKGROUND_INDEX, FRAME_BACKGROUND_PIXEL (f));
4111
4112 /* Tip frames have no scrollbars. */
4113 SetWindowLong (tip_window, WND_SCROLLBAR_INDEX, 0);
ca56d953
JR
4114
4115 /* Do this to discard the default setting specified by our parent. */
bfd6edcc 4116 ShowWindow (tip_window, SW_HIDE);
ca56d953
JR
4117 }
4118}
4119
4120
fbd6baed 4121/* Create and set up the w32 window for frame F. */
ee78dc32
GV
4122
4123static void
b56ceb92 4124w32_window (struct frame *f, long window_prompting, int minibuffer_only)
ee78dc32 4125{
4d7e6e51 4126 block_input ();
ee78dc32
GV
4127
4128 /* Use the resource name as the top-level window name
4129 for looking up resources. Make a non-Lisp copy
4130 for the window manager, so GC relocation won't bother it.
4131
4132 Elsewhere we specify the window name for the window manager. */
309f24d1 4133 f->namebuf = xstrdup (SSDATA (Vx_resource_name));
ee78dc32
GV
4134
4135 my_create_window (f);
4136
4137 validate_x_resource_name ();
4138
4139 /* x_set_name normally ignores requests to set the name if the
4140 requested name is the same as the current name. This is the one
4141 place where that assumption isn't correct; f->name is set, but
4142 the server hasn't been told. */
4143 {
4144 Lisp_Object name;
4145 int explicit = f->explicit_name;
4146
4147 f->explicit_name = 0;
e69b0960 4148 name = f->name;
f00af5b1 4149 fset_name (f, Qnil);
ee78dc32
GV
4150 x_set_name (f, name, explicit);
4151 }
4152
4d7e6e51 4153 unblock_input ();
ee78dc32
GV
4154
4155 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
4156 initialize_frame_menubar (f);
4157
fbd6baed 4158 if (FRAME_W32_WINDOW (f) == 0)
ee78dc32
GV
4159 error ("Unable to create window");
4160}
4161
4162/* Handle the icon stuff for this window. Perhaps later we might
4163 want an x_set_icon_position which can be called interactively as
4164 well. */
4165
4166static void
b56ceb92 4167x_icon (struct frame *f, Lisp_Object parms)
ee78dc32
GV
4168{
4169 Lisp_Object icon_x, icon_y;
3faa984f 4170 struct w32_display_info *dpyinfo = &one_w32_display_info;
ee78dc32 4171
e9e23e23 4172 /* Set the position of the icon. Note that Windows 95 groups all
ee78dc32 4173 icons in the tray. */
3faa984f
JR
4174 icon_x = x_get_arg (dpyinfo, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
4175 icon_y = x_get_arg (dpyinfo, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
ee78dc32
GV
4176 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
4177 {
b7826503
PJ
4178 CHECK_NUMBER (icon_x);
4179 CHECK_NUMBER (icon_y);
ee78dc32
GV
4180 }
4181 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
4182 error ("Both left and top icon corners of icon must be specified");
4183
4d7e6e51 4184 block_input ();
ee78dc32 4185
1edf84e7
GV
4186#if 0 /* TODO */
4187 /* Start up iconic or window? */
4188 x_wm_set_window_state
3faa984f 4189 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL), Qicon)
1edf84e7
GV
4190 ? IconicState
4191 : NormalState));
4192
e69b0960
DA
4193 x_text_icon (f, SSDATA ((!NILP (f->icon_name)
4194 ? f->icon_name
4195 : f->name)));
1edf84e7
GV
4196#endif
4197
4d7e6e51 4198 unblock_input ();
ee78dc32
GV
4199}
4200
6fc2811b
JR
4201
4202static void
b56ceb92 4203x_make_gc (struct frame *f)
6fc2811b
JR
4204{
4205 XGCValues gc_values;
4206
4d7e6e51 4207 block_input ();
6fc2811b
JR
4208
4209 /* Create the GC's of this frame.
4210 Note that many default values are used. */
4211
4212 /* Normal video */
be786000 4213 gc_values.font = FRAME_FONT (f);
6fc2811b
JR
4214
4215 /* Cursor has cursor-color background, background-color foreground. */
4216 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
4217 gc_values.background = f->output_data.w32->cursor_pixel;
4218 f->output_data.w32->cursor_gc
4219 = XCreateGC (NULL, FRAME_W32_WINDOW (f),
4220 (GCFont | GCForeground | GCBackground),
4221 &gc_values);
4222
4223 /* Reliefs. */
4224 f->output_data.w32->white_relief.gc = 0;
4225 f->output_data.w32->black_relief.gc = 0;
4226
4d7e6e51 4227 unblock_input ();
6fc2811b
JR
4228}
4229
4230
937e601e 4231/* Handler for signals raised during x_create_frame and
a06776b2 4232 x_create_tip_frame. FRAME is the frame which is partially
937e601e
AI
4233 constructed. */
4234
4235static Lisp_Object
b56ceb92 4236unwind_create_frame (Lisp_Object frame)
937e601e
AI
4237{
4238 struct frame *f = XFRAME (frame);
4239
4240 /* If frame is ``official'', nothing to do. */
97f18cc8 4241 if (NILP (Fmemq (frame, Vframe_list)))
937e601e 4242 {
e509cfa6 4243#ifdef GLYPH_DEBUG
aad3612f 4244 struct w32_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
937e601e 4245#endif
7d0393cf 4246
937e601e 4247 x_free_frame_resources (f);
84c3edb9 4248 free_glyphs (f);
937e601e 4249
e509cfa6 4250#ifdef GLYPH_DEBUG
937e601e 4251 /* Check that reference counts are indeed correct. */
a54e2c05 4252 eassert (dpyinfo->reference_count == dpyinfo_refcount);
f7551c6c
EZ
4253 eassert ((dpyinfo->terminal->image_cache == NULL
4254 && image_cache_refcount == 0)
4255 || dpyinfo->terminal->image_cache->refcount == image_cache_refcount);
a9b555d3 4256#endif
c844a81a 4257 return Qt;
937e601e 4258 }
7d0393cf 4259
937e601e
AI
4260 return Qnil;
4261}
4262
27e498e6
PE
4263static void
4264do_unwind_create_frame (Lisp_Object frame)
4265{
4266 unwind_create_frame (frame);
4267}
4268
0cbab19e
MR
4269static void
4270unwind_create_frame_1 (Lisp_Object val)
4271{
4272 inhibit_lisp_code = val;
4273}
4274
a1fe5c00 4275static void
b56ceb92 4276x_default_font_parameter (struct frame *f, Lisp_Object parms)
a1fe5c00 4277{
aad3612f 4278 struct w32_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
770e2e6e
SM
4279 Lisp_Object font_param = x_get_arg (dpyinfo, parms, Qfont, NULL, NULL,
4280 RES_TYPE_STRING);
4281 Lisp_Object font;
4282 if (EQ (font_param, Qunbound))
4283 font_param = Qnil;
4284 font = !NILP (font_param) ? font_param
4285 : x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
a1fe5c00
JR
4286
4287 if (!STRINGP (font))
4288 {
4289 int i;
4290 static char *names[]
82523155 4291 = { "Courier New-10",
a1fe5c00
JR
4292 "-*-Courier-normal-r-*-*-13-*-*-*-c-*-iso8859-1",
4293 "-*-Fixedsys-normal-r-*-*-12-*-*-*-c-*-iso8859-1",
4294 "Fixedsys",
4295 NULL };
4296
4297 for (i = 0; names[i]; i++)
4298 {
d7ea76b4 4299 font = font_open_by_name (f, build_unibyte_string (names[i]));
a1fe5c00
JR
4300 if (! NILP (font))
4301 break;
4302 }
4303 if (NILP (font))
4304 error ("No suitable font was found");
4305 }
770e2e6e 4306 else if (!NILP (font_param))
27129af9
SM
4307 {
4308 /* Remember the explicit font parameter, so we can re-apply it after
4309 we've applied the `default' face settings. */
770e2e6e
SM
4310 x_set_frame_parameters (f, Fcons (Fcons (Qfont_param, font_param), Qnil));
4311 }
a1fe5c00
JR
4312 x_default_parameter (f, parms, Qfont, font, "font", "Font", RES_TYPE_STRING);
4313}
937e601e 4314
ee78dc32
GV
4315DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
4316 1, 1, 0,
74e1aeec 4317 doc: /* Make a new window, which is called a \"frame\" in Emacs terms.
36458ebd 4318Return an Emacs frame object.
52deb19f 4319PARAMETERS is an alist of frame parameters.
74e1aeec
JR
4320If the parameters specify that the frame should not have a minibuffer,
4321and do not specify a specific minibuffer window to use,
4322then `default-minibuffer-frame' must be a frame whose minibuffer can
4323be shared by the new frame.
4324
4325This function is an internal primitive--use `make-frame' instead. */)
5842a27b 4326 (Lisp_Object parameters)
ee78dc32
GV
4327{
4328 struct frame *f;
4329 Lisp_Object frame, tem;
4330 Lisp_Object name;
4331 int minibuffer_only = 0;
4332 long window_prompting = 0;
4333 int width, height;
d311d28c 4334 ptrdiff_t count = SPECPDL_INDEX ();
1edf84e7 4335 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
ee78dc32 4336 Lisp_Object display;
6fc2811b 4337 struct w32_display_info *dpyinfo = NULL;
ee78dc32
GV
4338 Lisp_Object parent;
4339 struct kboard *kb;
4340
8962d4b3
EZ
4341 if (!FRAME_W32_P (SELECTED_FRAME ())
4342 && !FRAME_INITIAL_P (SELECTED_FRAME ()))
bf7bea5d
EZ
4343 error ("Cannot create a GUI frame in a -nw session");
4344
1da8a031
MR
4345 /* Make copy of frame parameters because the original is in pure
4346 storage now. */
4347 parameters = Fcopy_alist (parameters);
4348
ee78dc32
GV
4349 /* Use this general default value to start with
4350 until we know if this frame has a specified name. */
4351 Vx_resource_name = Vinvocation_name;
4352
3faa984f
JR
4353 display = x_get_arg (dpyinfo, parameters, Qterminal, 0, 0, RES_TYPE_NUMBER);
4354 if (EQ (display, Qunbound))
4355 display = x_get_arg (dpyinfo, parameters, Qdisplay, 0, 0, RES_TYPE_STRING);
ee78dc32
GV
4356 if (EQ (display, Qunbound))
4357 display = Qnil;
4358 dpyinfo = check_x_display_info (display);
80ca7302 4359 kb = dpyinfo->terminal->kboard;
ee78dc32 4360
3faa984f
JR
4361 if (!dpyinfo->terminal->name)
4362 error ("Terminal is not live, can't create new frames on it");
4363
4364 name = x_get_arg (dpyinfo, parameters, Qname, "name", "Name", RES_TYPE_STRING);
ee78dc32
GV
4365 if (!STRINGP (name)
4366 && ! EQ (name, Qunbound)
4367 && ! NILP (name))
4368 error ("Invalid frame name--not a string or nil");
4369
4370 if (STRINGP (name))
4371 Vx_resource_name = name;
4372
4373 /* See if parent window is specified. */
3faa984f 4374 parent = x_get_arg (dpyinfo, parameters, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
ee78dc32
GV
4375 if (EQ (parent, Qunbound))
4376 parent = Qnil;
4377 if (! NILP (parent))
b7826503 4378 CHECK_NUMBER (parent);
ee78dc32 4379
1edf84e7
GV
4380 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
4381 /* No need to protect DISPLAY because that's not used after passing
4382 it to make_frame_without_minibuffer. */
4383 frame = Qnil;
52deb19f 4384 GCPRO4 (parameters, parent, name, frame);
3faa984f 4385 tem = x_get_arg (dpyinfo, parameters, Qminibuffer, "minibuffer", "Minibuffer",
0cbab19e 4386 RES_TYPE_SYMBOL);
ee78dc32
GV
4387 if (EQ (tem, Qnone) || NILP (tem))
4388 f = make_frame_without_minibuffer (Qnil, kb, display);
4389 else if (EQ (tem, Qonly))
4390 {
4391 f = make_minibuffer_frame ();
4392 minibuffer_only = 1;
4393 }
4394 else if (WINDOWP (tem))
4395 f = make_frame_without_minibuffer (tem, kb, display);
4396 else
4397 f = make_frame (1);
4398
1edf84e7
GV
4399 XSETFRAME (frame, f);
4400
5ac45f98 4401 /* By default, make scrollbars the system standard width. */
44c5e192 4402 x_set_scroll_bar_default_width (f);
ee78dc32 4403
2dc8b986 4404 f->terminal = dpyinfo->terminal;
2dc8b986 4405
fbd6baed 4406 f->output_method = output_w32;
23f86fce 4407 f->output_data.w32 = xzalloc (sizeof (struct w32_output));
4587b026
GV
4408 FRAME_FONTSET (f) = -1;
4409
f00af5b1
PE
4410 fset_icon_name
4411 (f, x_get_arg (dpyinfo, parameters, Qicon_name, "iconName", "Title",
edd74c35 4412 RES_TYPE_STRING));
e69b0960 4413 if (! STRINGP (f->icon_name))
f00af5b1 4414 fset_icon_name (f, Qnil);
1edf84e7 4415
0cbab19e 4416 /* FRAME_DISPLAY_INFO (f) = dpyinfo; */
3faa984f 4417
aad3612f 4418 /* With FRAME_DISPLAY_INFO set up, this unwind-protect is safe. */
27e498e6 4419 record_unwind_protect (do_unwind_create_frame, frame);
0cbab19e 4420
e509cfa6 4421#ifdef GLYPH_DEBUG
a06776b2
EZ
4422 image_cache_refcount =
4423 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
3faa984f
JR
4424 dpyinfo_refcount = dpyinfo->reference_count;
4425#endif /* GLYPH_DEBUG */
ee78dc32
GV
4426
4427 /* Specify the parent under which to make this window. */
4428
4429 if (!NILP (parent))
4430 {
1660f34a 4431 f->output_data.w32->parent_desc = (Window) XFASTINT (parent);
fbd6baed 4432 f->output_data.w32->explicit_parent = 1;
ee78dc32
GV
4433 }
4434 else
4435 {
aad3612f 4436 f->output_data.w32->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
fbd6baed 4437 f->output_data.w32->explicit_parent = 0;
ee78dc32
GV
4438 }
4439
ee78dc32
GV
4440 /* Set the name; the functions to which we pass f expect the name to
4441 be set. */
4442 if (EQ (name, Qunbound) || NILP (name))
4443 {
f00af5b1 4444 fset_name (f, build_string (dpyinfo->w32_id_name));
ee78dc32
GV
4445 f->explicit_name = 0;
4446 }
4447 else
4448 {
f00af5b1 4449 fset_name (f, name);
ee78dc32
GV
4450 f->explicit_name = 1;
4451 /* use the frame's title when getting resources for this frame. */
4452 specbind (Qx_resource_name, name);
4453 }
4454
1cc06b86
KH
4455 if (uniscribe_available)
4456 register_font_driver (&uniscribe_font_driver, f);
4457 register_font_driver (&w32font_driver, f);
a1fe5c00 4458
1cc06b86
KH
4459 x_default_parameter (f, parameters, Qfont_backend, Qnil,
4460 "fontBackend", "FontBackend", RES_TYPE_STRING);
ee78dc32
GV
4461 /* Extract the window parameters from the supplied values
4462 that are needed to determine window geometry. */
1cc06b86 4463 x_default_font_parameter (f, parameters);
52deb19f 4464 x_default_parameter (f, parameters, Qborder_width, make_number (2),
1660f34a 4465 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
3faa984f 4466
601a9cf1 4467 /* We recognize either internalBorderWidth or internalBorder
3faa984f 4468 (which is what xterm calls it). */
52deb19f 4469 if (NILP (Fassq (Qinternal_border_width, parameters)))
ee78dc32
GV
4470 {
4471 Lisp_Object value;
4472
3faa984f 4473 value = x_get_arg (dpyinfo, parameters, Qinternal_border_width,
0cbab19e 4474 "internalBorder", "InternalBorder", RES_TYPE_NUMBER);
ee78dc32 4475 if (! EQ (value, Qunbound))
52deb19f
JB
4476 parameters = Fcons (Fcons (Qinternal_border_width, value),
4477 parameters);
ee78dc32 4478 }
1edf84e7 4479 /* Default internalBorderWidth to 0 on Windows to match other programs. */
52deb19f 4480 x_default_parameter (f, parameters, Qinternal_border_width, make_number (0),
1660f34a 4481 "internalBorderWidth", "InternalBorder", RES_TYPE_NUMBER);
880e6158
MR
4482 x_default_parameter (f, parameters, Qright_divider_width, make_number (0),
4483 NULL, NULL, RES_TYPE_NUMBER);
4484 x_default_parameter (f, parameters, Qbottom_divider_width, make_number (0),
4485 NULL, NULL, RES_TYPE_NUMBER);
52deb19f 4486 x_default_parameter (f, parameters, Qvertical_scroll_bars, Qright,
1660f34a 4487 "verticalScrollBars", "ScrollBars", RES_TYPE_SYMBOL);
ee78dc32
GV
4488
4489 /* Also do the stuff which must be set before the window exists. */
52deb19f 4490 x_default_parameter (f, parameters, Qforeground_color, build_string ("black"),
6fc2811b 4491 "foreground", "Foreground", RES_TYPE_STRING);
52deb19f 4492 x_default_parameter (f, parameters, Qbackground_color, build_string ("white"),
6fc2811b 4493 "background", "Background", RES_TYPE_STRING);
52deb19f 4494 x_default_parameter (f, parameters, Qmouse_color, build_string ("black"),
6fc2811b 4495 "pointerColor", "Foreground", RES_TYPE_STRING);
52deb19f 4496 x_default_parameter (f, parameters, Qborder_color, build_string ("black"),
6fc2811b 4497 "borderColor", "BorderColor", RES_TYPE_STRING);
52deb19f 4498 x_default_parameter (f, parameters, Qscreen_gamma, Qnil,
6fc2811b 4499 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
52deb19f 4500 x_default_parameter (f, parameters, Qline_spacing, Qnil,
dfff8a69 4501 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
52deb19f 4502 x_default_parameter (f, parameters, Qleft_fringe, Qnil,
41c1bdd9 4503 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
52deb19f 4504 x_default_parameter (f, parameters, Qright_fringe, Qnil,
41c1bdd9 4505 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
b4168649
MR
4506 /* Process alpha here (Bug#16619). */
4507 x_default_parameter (f, parameters, Qalpha, Qnil,
4508 "alpha", "Alpha", RES_TYPE_NUMBER);
6fc2811b 4509
6fc2811b
JR
4510 /* Init faces before x_default_parameter is called for scroll-bar
4511 parameters because that function calls x_set_scroll_bar_width,
4512 which calls change_frame_size, which calls Fset_window_buffer,
4513 which runs hooks, which call Fvertical_motion. At the end, we
4514 end up in init_iterator with a null face cache, which should not
4515 happen. */
4516 init_frame_faces (f);
7d0393cf 4517
45ccd909
MR
4518 /* Avoid calling window-configuration-change-hook; otherwise we
4519 could get an infloop in next_frame since the frame is not yet in
4520 Vframe_list. */
4521 {
4522 ptrdiff_t count2 = SPECPDL_INDEX ();
4523
4524 record_unwind_protect (unwind_create_frame_1, inhibit_lisp_code);
4525 inhibit_lisp_code = Qt;
4526
4527 /* PXW: This is a duplicate from below. We have to do it here since
4528 otherwise x_set_tool_bar_lines will work with the character sizes
4529 installed by init_frame_faces while the frame's pixel size is still
4530 calculated from a character size of 1 and we subsequently hit the
4531 eassert (height >= 0) assertion in window_box_height. The
4532 non-pixelwise code apparently worked around this because it had one
4533 frame line vs one toolbar line which left us with a zero root
4534 window height which was obviously wrong as well ... */
4535 change_frame_size (f, FRAME_COLS (f) * FRAME_COLUMN_WIDTH (f),
4536 FRAME_LINES (f) * FRAME_LINE_HEIGHT (f), 1, 0, 0, 1);
4537
4538 /* The X resources controlling the menu-bar and tool-bar are
4539 processed specially at startup, and reflected in the mode
4540 variables; ignore them here. */
4541 x_default_parameter (f, parameters, Qmenu_bar_lines,
4542 NILP (Vmenu_bar_mode)
4543 ? make_number (0) : make_number (1),
4544 NULL, NULL, RES_TYPE_NUMBER);
4545 x_default_parameter (f, parameters, Qtool_bar_lines,
4546 NILP (Vtool_bar_mode)
4547 ? make_number (0) : make_number (1),
4548 NULL, NULL, RES_TYPE_NUMBER);
4549
4550 unbind_to (count2, Qnil);
4551 }
919f1e88 4552
52deb19f 4553 x_default_parameter (f, parameters, Qbuffer_predicate, Qnil,
6fc2811b 4554 "bufferPredicate", "BufferPredicate", RES_TYPE_SYMBOL);
52deb19f 4555 x_default_parameter (f, parameters, Qtitle, Qnil,
6fc2811b 4556 "title", "Title", RES_TYPE_STRING);
52deb19f 4557 x_default_parameter (f, parameters, Qfullscreen, Qnil,
f7b9d4d1 4558 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
ee78dc32 4559
fbd6baed 4560 f->output_data.w32->dwStyle = WS_OVERLAPPEDWINDOW;
aad3612f 4561 f->output_data.w32->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
3cf3436e 4562
c9b2104d
JR
4563 f->output_data.w32->text_cursor = w32_load_cursor (IDC_IBEAM);
4564 f->output_data.w32->nontext_cursor = w32_load_cursor (IDC_ARROW);
4565 f->output_data.w32->modeline_cursor = w32_load_cursor (IDC_ARROW);
7d63e5e3 4566 f->output_data.w32->hand_cursor = w32_load_cursor (IDC_HAND);
c9b2104d
JR
4567 f->output_data.w32->hourglass_cursor = w32_load_cursor (IDC_WAIT);
4568 f->output_data.w32->horizontal_drag_cursor = w32_load_cursor (IDC_SIZEWE);
880e6158 4569 f->output_data.w32->vertical_drag_cursor = w32_load_cursor (IDC_SIZENS);
c9b2104d 4570
d148e14d
JR
4571 f->output_data.w32->current_cursor = f->output_data.w32->nontext_cursor;
4572
52deb19f 4573 window_prompting = x_figure_window_size (f, parameters, 1);
ee78dc32 4574
3faa984f 4575 tem = x_get_arg (dpyinfo, parameters, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
6fc2811b
JR
4576 f->no_split = minibuffer_only || EQ (tem, Qt);
4577
fbd6baed 4578 w32_window (f, window_prompting, minibuffer_only);
52deb19f 4579 x_icon (f, parameters);
6fc2811b
JR
4580
4581 x_make_gc (f);
4582
4583 /* Now consider the frame official. */
a06776b2 4584 f->terminal->reference_count++;
aad3612f 4585 FRAME_DISPLAY_INFO (f)->reference_count++;
6fc2811b 4586 Vframe_list = Fcons (frame, Vframe_list);
ee78dc32
GV
4587
4588 /* We need to do this after creating the window, so that the
4589 icon-creation functions can say whose icon they're describing. */
52deb19f 4590 x_default_parameter (f, parameters, Qicon_type, Qnil,
6fc2811b 4591 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
ee78dc32 4592
52deb19f 4593 x_default_parameter (f, parameters, Qauto_raise, Qnil,
6fc2811b 4594 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
52deb19f 4595 x_default_parameter (f, parameters, Qauto_lower, Qnil,
6fc2811b 4596 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
52deb19f 4597 x_default_parameter (f, parameters, Qcursor_type, Qbox,
6fc2811b 4598 "cursorType", "CursorType", RES_TYPE_SYMBOL);
52deb19f 4599 x_default_parameter (f, parameters, Qscroll_bar_width, Qnil,
6fc2811b 4600 "scrollBarWidth", "ScrollBarWidth", RES_TYPE_NUMBER);
ee78dc32 4601
be786000 4602 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
ee78dc32 4603 Change will not be effected unless different from the current
be786000 4604 FRAME_LINES (f). */
880e6158
MR
4605 width = FRAME_TEXT_WIDTH (f);
4606 height = FRAME_TEXT_HEIGHT (f);
4607 FRAME_TEXT_HEIGHT (f) = 0;
4608 SET_FRAME_WIDTH (f, 0);
4609 change_frame_size (f, width, height, 1, 0, 0, 1);
6fc2811b 4610
6fc2811b
JR
4611 /* Tell the server what size and position, etc, we want, and how
4612 badly we want them. This should be done after we have the menu
4613 bar so that its size can be taken into account. */
4d7e6e51 4614 block_input ();
ee78dc32 4615 x_wm_set_size_hint (f, window_prompting, 0);
4d7e6e51 4616 unblock_input ();
ee78dc32 4617
6fc2811b
JR
4618 /* Make the window appear on the frame and enable display, unless
4619 the caller says not to. However, with explicit parent, Emacs
4620 cannot control visibility, so don't try. */
fbd6baed 4621 if (! f->output_data.w32->explicit_parent)
ee78dc32
GV
4622 {
4623 Lisp_Object visibility;
4624
3faa984f 4625 visibility = x_get_arg (dpyinfo, parameters, Qvisibility, 0, 0, RES_TYPE_SYMBOL);
ee78dc32
GV
4626 if (EQ (visibility, Qunbound))
4627 visibility = Qt;
4628
4629 if (EQ (visibility, Qicon))
4630 x_iconify_frame (f);
4631 else if (! NILP (visibility))
4632 x_make_frame_visible (f);
4633 else
4634 /* Must have been Qnil. */
4635 ;
4636 }
55d5acfa
DN
4637
4638 /* Initialize `default-minibuffer-frame' in case this is the first
4639 frame on this terminal. */
4640 if (FRAME_HAS_MINIBUF_P (f)
05c65251
EZ
4641 && (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
4642 || !FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame)))))
15dbb4d6 4643 kset_default_minibuffer_frame (kb, frame);
55d5acfa
DN
4644
4645 /* All remaining specified parameters, which have not been "used"
4646 by x_get_arg and friends, now go in the misc. alist of the frame. */
99784d63 4647 for (tem = parameters; CONSP (tem); tem = XCDR (tem))
55d5acfa 4648 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
f00af5b1 4649 fset_param_alist (f, Fcons (XCAR (tem), f->param_alist));
55d5acfa 4650
6fc2811b 4651 UNGCPRO;
7d0393cf 4652
9e57df62
GM
4653 /* Make sure windows on this frame appear in calls to next-window
4654 and similar functions. */
4655 Vwindow_list = Qnil;
7d0393cf 4656
ee78dc32
GV
4657 return unbind_to (count, frame);
4658}
4659
4660/* FRAME is used only to get a handle on the X display. We don't pass the
4661 display info directly because we're called from frame.c, which doesn't
4662 know about that structure. */
4663Lisp_Object
b56ceb92 4664x_get_focus_frame (struct frame *frame)
ee78dc32 4665{
aad3612f 4666 struct w32_display_info *dpyinfo = FRAME_DISPLAY_INFO (frame);
ee78dc32 4667 Lisp_Object xfocus;
fbd6baed 4668 if (! dpyinfo->w32_focus_frame)
ee78dc32
GV
4669 return Qnil;
4670
fbd6baed 4671 XSETFRAME (xfocus, dpyinfo->w32_focus_frame);
ee78dc32
GV
4672 return xfocus;
4673}
1edf84e7 4674
6fc2811b 4675DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
4f4f2973
GM
4676 doc: /* Internal function called by `color-defined-p', which see.
4677\(Note that the Nextstep version of this function ignores FRAME.) */)
5842a27b 4678 (Lisp_Object color, Lisp_Object frame)
6fc2811b
JR
4679{
4680 XColor foo;
a10c8269 4681 struct frame *f = decode_window_system_frame (frame);
ee78dc32 4682
b7826503 4683 CHECK_STRING (color);
ee78dc32 4684
d5db4077 4685 if (w32_defined_color (f, SDATA (color), &foo, 0))
6fc2811b
JR
4686 return Qt;
4687 else
4688 return Qnil;
4689}
ee78dc32 4690
2d764c78 4691DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
74e1aeec 4692 doc: /* Internal function called by `color-values', which see. */)
5842a27b 4693 (Lisp_Object color, Lisp_Object frame)
ee78dc32 4694{
6fc2811b 4695 XColor foo;
a10c8269 4696 struct frame *f = decode_window_system_frame (frame);
ee78dc32 4697
b7826503 4698 CHECK_STRING (color);
ee78dc32 4699
d5db4077 4700 if (w32_defined_color (f, SDATA (color), &foo, 0))
3de717bd
DA
4701 return list3i ((GetRValue (foo.pixel) << 8) | GetRValue (foo.pixel),
4702 (GetGValue (foo.pixel) << 8) | GetGValue (foo.pixel),
4703 (GetBValue (foo.pixel) << 8) | GetBValue (foo.pixel));
ee78dc32
GV
4704 else
4705 return Qnil;
4706}
4707
2d764c78 4708DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
74e1aeec 4709 doc: /* Internal function called by `display-color-p', which see. */)
5842a27b 4710 (Lisp_Object display)
ee78dc32 4711{
fbd6baed 4712 struct w32_display_info *dpyinfo = check_x_display_info (display);
ee78dc32
GV
4713
4714 if ((dpyinfo->n_planes * dpyinfo->n_cbits) <= 2)
4715 return Qnil;
4716
4717 return Qt;
4718}
4719
74e1aeec
JR
4720DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p,
4721 Sx_display_grayscale_p, 0, 1, 0,
52deb19f 4722 doc: /* Return t if DISPLAY supports shades of gray.
74e1aeec
JR
4723Note that color displays do support shades of gray.
4724The optional argument DISPLAY specifies which display to ask about.
4725DISPLAY should be either a frame or a display name (a string).
4726If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4727 (Lisp_Object display)
ee78dc32 4728{
fbd6baed 4729 struct w32_display_info *dpyinfo = check_x_display_info (display);
ee78dc32
GV
4730
4731 if ((dpyinfo->n_planes * dpyinfo->n_cbits) <= 1)
4732 return Qnil;
4733
4734 return Qt;
4735}
4736
74e1aeec
JR
4737DEFUN ("x-display-pixel-width", Fx_display_pixel_width,
4738 Sx_display_pixel_width, 0, 1, 0,
36458ebd 4739 doc: /* Return the width in pixels of DISPLAY.
74e1aeec
JR
4740The optional argument DISPLAY specifies which display to ask about.
4741DISPLAY should be either a frame or a display name (a string).
cf13177e
YM
4742If omitted or nil, that stands for the selected frame's display.
4743
4744On \"multi-monitor\" setups this refers to the pixel width for all
4745physical monitors associated with DISPLAY. To get information for
4746each physical monitor, use `display-monitor-attributes-list'. */)
5842a27b 4747 (Lisp_Object display)
ee78dc32 4748{
fbd6baed 4749 struct w32_display_info *dpyinfo = check_x_display_info (display);
ee78dc32 4750
05eb7cdc 4751 return make_number (x_display_pixel_width (dpyinfo));
ee78dc32
GV
4752}
4753
4754DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
74e1aeec 4755 Sx_display_pixel_height, 0, 1, 0,
36458ebd 4756 doc: /* Return the height in pixels of DISPLAY.
74e1aeec
JR
4757The optional argument DISPLAY specifies which display to ask about.
4758DISPLAY should be either a frame or a display name (a string).
cf13177e
YM
4759If omitted or nil, that stands for the selected frame's display.
4760
4761On \"multi-monitor\" setups this refers to the pixel height for all
4762physical monitors associated with DISPLAY. To get information for
4763each physical monitor, use `display-monitor-attributes-list'. */)
5842a27b 4764 (Lisp_Object display)
ee78dc32 4765{
fbd6baed 4766 struct w32_display_info *dpyinfo = check_x_display_info (display);
ee78dc32 4767
05eb7cdc 4768 return make_number (x_display_pixel_height (dpyinfo));
ee78dc32
GV
4769}
4770
4771DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
74e1aeec 4772 0, 1, 0,
36458ebd 4773 doc: /* Return the number of bitplanes of DISPLAY.
74e1aeec
JR
4774The optional argument DISPLAY specifies which display to ask about.
4775DISPLAY should be either a frame or a display name (a string).
4776If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4777 (Lisp_Object display)
ee78dc32 4778{
fbd6baed 4779 struct w32_display_info *dpyinfo = check_x_display_info (display);
ee78dc32
GV
4780
4781 return make_number (dpyinfo->n_planes * dpyinfo->n_cbits);
4782}
4783
4784DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
74e1aeec 4785 0, 1, 0,
36458ebd 4786 doc: /* Return the number of color cells of DISPLAY.
74e1aeec
JR
4787The optional argument DISPLAY specifies which display to ask about.
4788DISPLAY should be either a frame or a display name (a string).
4789If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4790 (Lisp_Object display)
ee78dc32 4791{
fbd6baed 4792 struct w32_display_info *dpyinfo = check_x_display_info (display);
ee78dc32
GV
4793 int cap;
4794
821812e2
DC
4795 /* Don't use NCOLORS: it returns incorrect results under remote
4796 * desktop. We force 24+ bit depths to 24-bit, both to prevent an
4797 * overflow and because probably is more meaningful on Windows
4798 * anyway. */
7d0393cf 4799
821812e2 4800 cap = 1 << min (dpyinfo->n_planes * dpyinfo->n_cbits, 24);
ee78dc32
GV
4801 return make_number (cap);
4802}
4803
4804DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
4805 Sx_server_max_request_size,
74e1aeec 4806 0, 1, 0,
36458ebd 4807 doc: /* Return the maximum request size of the server of DISPLAY.
74e1aeec
JR
4808The optional argument DISPLAY specifies which display to ask about.
4809DISPLAY should be either a frame or a display name (a string).
4810If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4811 (Lisp_Object display)
ee78dc32 4812{
ee78dc32
GV
4813 return make_number (1);
4814}
4815
4816DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
36458ebd 4817 doc: /* Return the "vendor ID" string of the W32 system (Microsoft).
74e1aeec
JR
4818The optional argument DISPLAY specifies which display to ask about.
4819DISPLAY should be either a frame or a display name (a string).
4820If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4821 (Lisp_Object display)
ee78dc32 4822{
dfff8a69 4823 return build_string ("Microsoft Corp.");
ee78dc32
GV
4824}
4825
4826DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
36458ebd 4827 doc: /* Return the version numbers of the server of DISPLAY.
74e1aeec 4828The value is a list of three integers: the major and minor
02b39a28
JB
4829version numbers of the X Protocol in use, and the distributor-specific
4830release number. See also the function `x-server-vendor'.
74e1aeec
JR
4831
4832The optional argument DISPLAY specifies which display to ask about.
4833DISPLAY should be either a frame or a display name (a string).
4834If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4835 (Lisp_Object display)
ee78dc32 4836{
3de717bd 4837 return list3i (w32_major_version, w32_minor_version, w32_build_number);
ee78dc32
GV
4838}
4839
4840DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
36458ebd 4841 doc: /* Return the number of screens on the server of DISPLAY.
74e1aeec
JR
4842The optional argument DISPLAY specifies which display to ask about.
4843DISPLAY should be either a frame or a display name (a string).
4844If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4845 (Lisp_Object display)
ee78dc32 4846{
ee78dc32
GV
4847 return make_number (1);
4848}
4849
74e1aeec
JR
4850DEFUN ("x-display-mm-height", Fx_display_mm_height,
4851 Sx_display_mm_height, 0, 1, 0,
36458ebd 4852 doc: /* Return the height in millimeters of DISPLAY.
74e1aeec
JR
4853The optional argument DISPLAY specifies which display to ask about.
4854DISPLAY should be either a frame or a display name (a string).
cf13177e
YM
4855If omitted or nil, that stands for the selected frame's display.
4856
4857On \"multi-monitor\" setups this refers to the height in millimeters for
4858all physical monitors associated with DISPLAY. To get information
4859for each physical monitor, use `display-monitor-attributes-list'. */)
5842a27b 4860 (Lisp_Object display)
ee78dc32 4861{
fbd6baed 4862 struct w32_display_info *dpyinfo = check_x_display_info (display);
ee78dc32 4863 HDC hdc;
cf13177e 4864 double mm_per_pixel;
7d0393cf 4865
cf13177e
YM
4866 hdc = GetDC (NULL);
4867 mm_per_pixel = ((double) GetDeviceCaps (hdc, VERTSIZE)
4868 / GetDeviceCaps (hdc, VERTRES));
4869 ReleaseDC (NULL, hdc);
7d0393cf 4870
cf13177e 4871 return make_number (x_display_pixel_height (dpyinfo) * mm_per_pixel + 0.5);
ee78dc32
GV
4872}
4873
4874DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
36458ebd 4875 doc: /* Return the width in millimeters of DISPLAY.
74e1aeec
JR
4876The optional argument DISPLAY specifies which display to ask about.
4877DISPLAY should be either a frame or a display name (a string).
cf13177e
YM
4878If omitted or nil, that stands for the selected frame's display.
4879
4880On \"multi-monitor\" setups this refers to the width in millimeters for
4881all physical monitors associated with TERMINAL. To get information
4882for each physical monitor, use `display-monitor-attributes-list'. */)
5842a27b 4883 (Lisp_Object display)
ee78dc32 4884{
fbd6baed 4885 struct w32_display_info *dpyinfo = check_x_display_info (display);
ee78dc32 4886 HDC hdc;
cf13177e 4887 double mm_per_pixel;
ee78dc32 4888
cf13177e
YM
4889 hdc = GetDC (NULL);
4890 mm_per_pixel = ((double) GetDeviceCaps (hdc, HORZSIZE)
4891 / GetDeviceCaps (hdc, HORZRES));
4892 ReleaseDC (NULL, hdc);
7d0393cf 4893
cf13177e 4894 return make_number (x_display_pixel_width (dpyinfo) * mm_per_pixel + 0.5);
ee78dc32
GV
4895}
4896
4897DEFUN ("x-display-backing-store", Fx_display_backing_store,
74e1aeec 4898 Sx_display_backing_store, 0, 1, 0,
36458ebd 4899 doc: /* Return an indication of whether DISPLAY does backing store.
74e1aeec
JR
4900The value may be `always', `when-mapped', or `not-useful'.
4901The optional argument DISPLAY specifies which display to ask about.
4902DISPLAY should be either a frame or a display name (a string).
4903If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4904 (Lisp_Object display)
ee78dc32
GV
4905{
4906 return intern ("not-useful");
4907}
4908
4909DEFUN ("x-display-visual-class", Fx_display_visual_class,
74e1aeec 4910 Sx_display_visual_class, 0, 1, 0,
36458ebd 4911 doc: /* Return the visual class of DISPLAY.
74e1aeec
JR
4912The value is one of the symbols `static-gray', `gray-scale',
4913`static-color', `pseudo-color', `true-color', or `direct-color'.
4914
4915The optional argument DISPLAY specifies which display to ask about.
4916DISPLAY should be either a frame or a display name (a string).
4917If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4918 (Lisp_Object display)
ee78dc32 4919{
fbd6baed 4920 struct w32_display_info *dpyinfo = check_x_display_info (display);
abf8c61b 4921 Lisp_Object result = Qnil;
ee78dc32 4922
abf8c61b
AI
4923 if (dpyinfo->has_palette)
4924 result = intern ("pseudo-color");
4925 else if (dpyinfo->n_planes * dpyinfo->n_cbits == 1)
4926 result = intern ("static-grey");
4927 else if (dpyinfo->n_planes * dpyinfo->n_cbits == 4)
4928 result = intern ("static-color");
4929 else if (dpyinfo->n_planes * dpyinfo->n_cbits > 8)
4930 result = intern ("true-color");
ee78dc32 4931
abf8c61b 4932 return result;
ee78dc32
GV
4933}
4934
4935DEFUN ("x-display-save-under", Fx_display_save_under,
74e1aeec 4936 Sx_display_save_under, 0, 1, 0,
02b39a28 4937 doc: /* Return t if DISPLAY supports the save-under feature.
74e1aeec
JR
4938The optional argument DISPLAY specifies which display to ask about.
4939DISPLAY should be either a frame or a display name (a string).
4940If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4941 (Lisp_Object display)
ee78dc32 4942{
6fc2811b
JR
4943 return Qnil;
4944}
0fda9b75 4945
cf13177e
YM
4946static BOOL CALLBACK
4947w32_monitor_enum (HMONITOR monitor, HDC hdc, RECT *rcMonitor, LPARAM dwData)
4948{
4949 Lisp_Object *monitor_list = (Lisp_Object *) dwData;
4950
1396ac86 4951 *monitor_list = Fcons (make_save_ptr (monitor), *monitor_list);
cf13177e
YM
4952
4953 return TRUE;
4954}
4955
4956static Lisp_Object
4957w32_display_monitor_attributes_list (void)
4958{
4959 Lisp_Object attributes_list = Qnil, primary_monitor_attributes = Qnil;
4960 Lisp_Object monitor_list = Qnil, monitor_frames, rest, frame;
4961 int i, n_monitors;
4962 HMONITOR *monitors;
4963 struct gcpro gcpro1, gcpro2, gcpro3;
4964
4965 if (!(enum_display_monitors_fn && get_monitor_info_fn
4966 && monitor_from_window_fn))
4967 return Qnil;
4968
4969 if (!enum_display_monitors_fn (NULL, NULL, w32_monitor_enum,
4970 (LPARAM) &monitor_list)
4971 || NILP (monitor_list))
4972 return Qnil;
4973
4974 n_monitors = 0;
4975 for (rest = monitor_list; CONSP (rest); rest = XCDR (rest))
4976 n_monitors++;
4977
4978 monitors = xmalloc (n_monitors * sizeof (*monitors));
4979 for (i = 0; i < n_monitors; i++)
4980 {
4981 monitors[i] = XSAVE_POINTER (XCAR (monitor_list), 0);
4982 monitor_list = XCDR (monitor_list);
4983 }
4984
4985 monitor_frames = Fmake_vector (make_number (n_monitors), Qnil);
4986 FOR_EACH_FRAME (rest, frame)
4987 {
4988 struct frame *f = XFRAME (frame);
4989
4990 if (FRAME_W32_P (f) && !EQ (frame, tip_frame))
4991 {
4992 HMONITOR monitor =
4993 monitor_from_window_fn (FRAME_W32_WINDOW (f),
4994 MONITOR_DEFAULT_TO_NEAREST);
4995
4996 for (i = 0; i < n_monitors; i++)
4997 if (monitors[i] == monitor)
4998 break;
4999
5000 if (i < n_monitors)
5001 ASET (monitor_frames, i, Fcons (frame, AREF (monitor_frames, i)));
5002 }
5003 }
5004
5005 GCPRO3 (attributes_list, primary_monitor_attributes, monitor_frames);
5006
5007 for (i = 0; i < n_monitors; i++)
5008 {
5009 Lisp_Object geometry, workarea, name, attributes = Qnil;
5010 HDC hdc;
5011 int width_mm, height_mm;
5012 struct MONITOR_INFO_EX mi;
5013
5014 mi.cbSize = sizeof (mi);
5015 if (!get_monitor_info_fn (monitors[i], (struct MONITOR_INFO *) &mi))
5016 continue;
5017
5018 hdc = CreateDCA ("DISPLAY", mi.szDevice, NULL, NULL);
5019 if (hdc == NULL)
5020 continue;
5021 width_mm = GetDeviceCaps (hdc, HORZSIZE);
5022 height_mm = GetDeviceCaps (hdc, VERTSIZE);
5023 DeleteDC (hdc);
5024
5025 attributes = Fcons (Fcons (Qframes, AREF (monitor_frames, i)),
5026 attributes);
5027
309f24d1
DA
5028 name = DECODE_SYSTEM (build_unibyte_string (mi.szDevice));
5029
cf13177e
YM
5030 attributes = Fcons (Fcons (Qname, name), attributes);
5031
5032 attributes = Fcons (Fcons (Qmm_size, list2i (width_mm, height_mm)),
5033 attributes);
5034
5035 workarea = list4i (mi.rcWork.left, mi.rcWork.top,
5036 mi.rcWork.right - mi.rcWork.left,
5037 mi.rcWork.bottom - mi.rcWork.top);
5038 attributes = Fcons (Fcons (Qworkarea, workarea), attributes);
5039
5040 geometry = list4i (mi.rcMonitor.left, mi.rcMonitor.top,
5041 mi.rcMonitor.right - mi.rcMonitor.left,
5042 mi.rcMonitor.bottom - mi.rcMonitor.top);
5043 attributes = Fcons (Fcons (Qgeometry, geometry), attributes);
5044
5045 if (mi.dwFlags & MONITORINFOF_PRIMARY)
5046 primary_monitor_attributes = attributes;
5047 else
5048 attributes_list = Fcons (attributes, attributes_list);
5049 }
5050
5051 if (!NILP (primary_monitor_attributes))
5052 attributes_list = Fcons (primary_monitor_attributes, attributes_list);
5053
5054 UNGCPRO;
5055
5056 xfree (monitors);
5057
5058 return attributes_list;
5059}
5060
5061static Lisp_Object
5062w32_display_monitor_attributes_list_fallback (struct w32_display_info *dpyinfo)
5063{
5064 Lisp_Object geometry, workarea, frames, rest, frame, attributes = Qnil;
5065 HDC hdc;
5066 double mm_per_pixel;
5067 int pixel_width, pixel_height, width_mm, height_mm;
5068 RECT workarea_rect;
5069
5070 /* Fallback: treat (possibly) multiple physical monitors as if they
5071 formed a single monitor as a whole. This should provide a
5072 consistent result at least on single monitor environments. */
5073 attributes = Fcons (Fcons (Qname, build_string ("combined screen")),
5074 attributes);
5075
5076 frames = Qnil;
5077 FOR_EACH_FRAME (rest, frame)
5078 {
5079 struct frame *f = XFRAME (frame);
5080
5081 if (FRAME_W32_P (f) && !EQ (frame, tip_frame))
5082 frames = Fcons (frame, frames);
5083 }
5084 attributes = Fcons (Fcons (Qframes, frames), attributes);
5085
5086 pixel_width = x_display_pixel_width (dpyinfo);
5087 pixel_height = x_display_pixel_height (dpyinfo);
5088
5089 hdc = GetDC (NULL);
5090 mm_per_pixel = ((double) GetDeviceCaps (hdc, HORZSIZE)
5091 / GetDeviceCaps (hdc, HORZRES));
5092 width_mm = pixel_width * mm_per_pixel + 0.5;
5093 mm_per_pixel = ((double) GetDeviceCaps (hdc, VERTSIZE)
5094 / GetDeviceCaps (hdc, VERTRES));
5095 height_mm = pixel_height * mm_per_pixel + 0.5;
5096 ReleaseDC (NULL, hdc);
5097 attributes = Fcons (Fcons (Qmm_size, list2i (width_mm, height_mm)),
5098 attributes);
5099
5100 /* GetSystemMetrics below may return 0 for Windows 95 or NT 4.0, but
5101 we don't care. */
5102 geometry = list4i (GetSystemMetrics (SM_XVIRTUALSCREEN),
5103 GetSystemMetrics (SM_YVIRTUALSCREEN),
5104 pixel_width, pixel_height);
5105 if (SystemParametersInfo (SPI_GETWORKAREA, 0, &workarea_rect, 0))
5106 workarea = list4i (workarea_rect.left, workarea_rect.top,
5107 workarea_rect.right - workarea_rect.left,
5108 workarea_rect.bottom - workarea_rect.top);
5109 else
5110 workarea = geometry;
5111 attributes = Fcons (Fcons (Qworkarea, workarea), attributes);
5112
5113 attributes = Fcons (Fcons (Qgeometry, geometry), attributes);
5114
5115 return list1 (attributes);
5116}
5117
5118DEFUN ("w32-display-monitor-attributes-list", Fw32_display_monitor_attributes_list,
5119 Sw32_display_monitor_attributes_list,
5120 0, 1, 0,
5121 doc: /* Return a list of physical monitor attributes on the W32 display DISPLAY.
5122
5123The optional argument DISPLAY specifies which display to ask about.
5124DISPLAY should be either a frame or a display name (a string).
5125If omitted or nil, that stands for the selected frame's display.
5126
5127Internal use only, use `display-monitor-attributes-list' instead. */)
5128 (Lisp_Object display)
5129{
5130 struct w32_display_info *dpyinfo = check_x_display_info (display);
5131 Lisp_Object attributes_list;
5132
5133 block_input ();
5134 attributes_list = w32_display_monitor_attributes_list ();
5135 if (NILP (attributes_list))
5136 attributes_list = w32_display_monitor_attributes_list_fallback (dpyinfo);
5137 unblock_input ();
5138
5139 return attributes_list;
5140}
5141
0fda9b75
DC
5142DEFUN ("set-message-beep", Fset_message_beep, Sset_message_beep, 1, 1, 0,
5143 doc: /* Set the sound generated when the bell is rung.
5144SOUND is 'asterisk, 'exclamation, 'hand, 'question, 'ok, or 'silent
5145to use the corresponding system sound for the bell. The 'silent sound
5146prevents Emacs from making any sound at all.
5147SOUND is nil to use the normal beep. */)
5148 (Lisp_Object sound)
5149{
5150 CHECK_SYMBOL (sound);
5151
5152 if (NILP (sound))
5153 sound_type = 0xFFFFFFFF;
5154 else if (EQ (sound, intern ("asterisk")))
5155 sound_type = MB_ICONASTERISK;
5156 else if (EQ (sound, intern ("exclamation")))
5157 sound_type = MB_ICONEXCLAMATION;
5158 else if (EQ (sound, intern ("hand")))
5159 sound_type = MB_ICONHAND;
5160 else if (EQ (sound, intern ("question")))
5161 sound_type = MB_ICONQUESTION;
5162 else if (EQ (sound, intern ("ok")))
5163 sound_type = MB_OK;
5164 else if (EQ (sound, intern ("silent")))
5165 sound_type = MB_EMACS_SILENT;
5166 else
5167 sound_type = 0xFFFFFFFF;
5168
5169 return sound;
5170}
5171
6fc2811b 5172int
b56ceb92 5173x_screen_planes (register struct frame *f)
6fc2811b 5174{
aad3612f 5175 return FRAME_DISPLAY_INFO (f)->n_planes;
6fc2811b
JR
5176}
5177\f
5178/* Return the display structure for the display named NAME.
5179 Open a new connection if necessary. */
5180
5181struct w32_display_info *
b56ceb92 5182x_display_info_for_name (Lisp_Object name)
6fc2811b 5183{
6fc2811b
JR
5184 struct w32_display_info *dpyinfo;
5185
b7826503 5186 CHECK_STRING (name);
6fc2811b 5187
d141d701
DA
5188 for (dpyinfo = &one_w32_display_info; dpyinfo; dpyinfo = dpyinfo->next)
5189 if (!NILP (Fstring_equal (XCAR (dpyinfo->name_list_element), name)))
5190 return dpyinfo;
6fc2811b
JR
5191
5192 /* Use this general default value to start with. */
5193 Vx_resource_name = Vinvocation_name;
5194
5195 validate_x_resource_name ();
5196
5197 dpyinfo = w32_term_init (name, (unsigned char *)0,
51b59d79 5198 SSDATA (Vx_resource_name));
6fc2811b
JR
5199
5200 if (dpyinfo == 0)
d5db4077 5201 error ("Cannot connect to server %s", SDATA (name));
6fc2811b 5202
d5272e33 5203 XSETFASTINT (Vwindow_system_version, w32_major_version);
6fc2811b
JR
5204
5205 return dpyinfo;
5206}
5207
5208DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4f4f2973 5209 1, 3, 0, doc: /* Open a connection to a display server.
74e1aeec
JR
5210DISPLAY is the name of the display to connect to.
5211Optional second arg XRM-STRING is a string of resources in xrdb format.
5212If the optional third arg MUST-SUCCEED is non-nil,
4f4f2973
GM
5213terminate Emacs if we can't open the connection.
5214\(In the Nextstep version, the last two arguments are currently ignored.) */)
5842a27b 5215 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
6fc2811b
JR
5216{
5217 unsigned char *xrm_option;
5218 struct w32_display_info *dpyinfo;
5219
efc3dd3c
DC
5220 CHECK_STRING (display);
5221
5222 /* Signal an error in order to encourage correct use from callers.
5223 * If we ever support multiple window systems in the same Emacs,
5224 * we'll need callers to be precise about what window system they
5225 * want. */
5226
5227 if (strcmp (SSDATA (display), "w32") != 0)
5228 error ("The name of the display in this Emacs must be \"w32\"");
5229
74e1aeec
JR
5230 /* If initialization has already been done, return now to avoid
5231 overwriting critical parts of one_w32_display_info. */
7452b7bd 5232 if (window_system_available (NULL))
74e1aeec
JR
5233 return Qnil;
5234
6fc2811b 5235 if (! NILP (xrm_string))
b7826503 5236 CHECK_STRING (xrm_string);
6fc2811b 5237
6fc2811b
JR
5238 /* Allow color mapping to be defined externally; first look in user's
5239 HOME directory, then in Emacs etc dir for a file called rgb.txt. */
5240 {
5241 Lisp_Object color_file;
5242 struct gcpro gcpro1;
5243
74084731 5244 color_file = build_string ("~/rgb.txt");
6fc2811b
JR
5245
5246 GCPRO1 (color_file);
5247
5248 if (NILP (Ffile_readable_p (color_file)))
5249 color_file =
5250 Fexpand_file_name (build_string ("rgb.txt"),
5251 Fsymbol_value (intern ("data-directory")));
5252
7ded3383 5253 Vw32_color_map = Fx_load_color_file (color_file);
6fc2811b
JR
5254
5255 UNGCPRO;
5256 }
5257 if (NILP (Vw32_color_map))
5430d399 5258 Vw32_color_map = w32_default_color_map ();
6fc2811b 5259
5a8a15ec
JR
5260 /* Merge in system logical colors. */
5261 add_system_logical_colors_to_map (&Vw32_color_map);
5262
6fc2811b 5263 if (! NILP (xrm_string))
51b59d79 5264 xrm_option = SDATA (xrm_string);
6fc2811b
JR
5265 else
5266 xrm_option = (unsigned char *) 0;
5267
5268 /* Use this general default value to start with. */
5269 /* First remove .exe suffix from invocation-name - it looks ugly. */
5270 {
5271 char basename[ MAX_PATH ], *str;
5272
d5db4077 5273 strcpy (basename, SDATA (Vinvocation_name));
6fc2811b
JR
5274 str = strrchr (basename, '.');
5275 if (str) *str = 0;
5276 Vinvocation_name = build_string (basename);
5277 }
5278 Vx_resource_name = Vinvocation_name;
5279
5280 validate_x_resource_name ();
5281
5282 /* This is what opens the connection and sets x_current_display.
5283 This also initializes many symbols, such as those used for input. */
5284 dpyinfo = w32_term_init (display, xrm_option,
51b59d79 5285 SSDATA (Vx_resource_name));
6fc2811b
JR
5286
5287 if (dpyinfo == 0)
5288 {
5289 if (!NILP (must_succeed))
5290 fatal ("Cannot connect to server %s.\n",
d5db4077 5291 SDATA (display));
6fc2811b 5292 else
d5db4077 5293 error ("Cannot connect to server %s", SDATA (display));
6fc2811b
JR
5294 }
5295
d5272e33 5296 XSETFASTINT (Vwindow_system_version, w32_major_version);
6fc2811b
JR
5297 return Qnil;
5298}
5299
5300DEFUN ("x-close-connection", Fx_close_connection,
5301 Sx_close_connection, 1, 1, 0,
74e1aeec
JR
5302 doc: /* Close the connection to DISPLAY's server.
5303For DISPLAY, specify either a frame or a display name (a string).
5304If DISPLAY is nil, that stands for the selected frame's display. */)
5842a27b 5305 (Lisp_Object display)
6fc2811b
JR
5306{
5307 struct w32_display_info *dpyinfo = check_x_display_info (display);
6fc2811b
JR
5308
5309 if (dpyinfo->reference_count > 0)
5310 error ("Display still has frames on it");
5311
4d7e6e51 5312 block_input ();
6fc2811b
JR
5313 x_destroy_all_bitmaps (dpyinfo);
5314
5315 x_delete_display (dpyinfo);
4d7e6e51 5316 unblock_input ();
6fc2811b
JR
5317
5318 return Qnil;
5319}
5320
5321DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
74e1aeec 5322 doc: /* Return the list of display names that Emacs has connections to. */)
5842a27b 5323 (void)
6fc2811b 5324{
d141d701
DA
5325 Lisp_Object result = Qnil;
5326 struct w32_display_info *wdi;
6fc2811b 5327
d141d701
DA
5328 for (wdi = x_display_list; wdi; wdi = wdi->next)
5329 result = Fcons (XCAR (wdi->name_list_element), result);
6fc2811b
JR
5330
5331 return result;
5332}
5333
5334DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
7c051dd8
GM
5335 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
5336This function only has an effect on X Windows. With MS Windows, it is
5337defined but does nothing.
5338
5339If ON is nil, allow buffering of requests.
5340Turning on synchronization prohibits the Xlib routines from buffering
5341requests and seriously degrades performance, but makes debugging much
5342easier.
5343The optional second argument TERMINAL specifies which display to act on.
5344TERMINAL should be a terminal object, a frame or a display name (a string).
5345If TERMINAL is omitted or nil, that stands for the selected frame's display. */)
5842a27b 5346 (Lisp_Object on, Lisp_Object display)
6fc2811b 5347{
6fc2811b
JR
5348 return Qnil;
5349}
5350
6b61353c 5351
6fc2811b 5352\f
6fc2811b 5353/***********************************************************************
6b61353c 5354 Window properties
6fc2811b
JR
5355 ***********************************************************************/
5356
b124fd93
JB
5357#if 0 /* TODO : port window properties to W32 */
5358
6b61353c
KH
5359DEFUN ("x-change-window-property", Fx_change_window_property,
5360 Sx_change_window_property, 2, 6, 0,
5361 doc: /* Change window property PROP to VALUE on the X window of FRAME.
7c051dd8
GM
5362PROP must be a string. VALUE may be a string or a list of conses,
5363numbers and/or strings. If an element in the list is a string, it is
5364converted to an atom and the value of the Atom is used. If an element
5365is a cons, it is converted to a 32 bit number where the car is the 16
5366top bits and the cdr is the lower 16 bits.
5367
6b61353c
KH
5368FRAME nil or omitted means use the selected frame.
5369If TYPE is given and non-nil, it is the name of the type of VALUE.
5370If TYPE is not given or nil, the type is STRING.
5371FORMAT gives the size in bits of each element if VALUE is a list.
5372It must be one of 8, 16 or 32.
5373If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
fca8d6b6 5374If OUTER-P is non-nil, the property is changed for the outer X window of
7c051dd8 5375FRAME. Default is to change on the edit X window. */)
fca8d6b6
AS
5376 (Lisp_Object prop, Lisp_Object value, Lisp_Object frame,
5377 Lisp_Object type, Lisp_Object format, Lisp_Object outer_p)
6b61353c 5378{
7452b7bd 5379 struct frame *f = decode_window_system_frame (frame);
6b61353c 5380 Atom prop_atom;
6fc2811b 5381
6b61353c
KH
5382 CHECK_STRING (prop);
5383 CHECK_STRING (value);
6fc2811b 5384
4d7e6e51 5385 block_input ();
6b61353c
KH
5386 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5387 XChangeProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5388 prop_atom, XA_STRING, 8, PropModeReplace,
5389 SDATA (value), SCHARS (value));
6fc2811b 5390
6b61353c
KH
5391 /* Make sure the property is set when we return. */
5392 XFlush (FRAME_W32_DISPLAY (f));
4d7e6e51 5393 unblock_input ();
6fc2811b 5394
6b61353c
KH
5395 return value;
5396}
dfff8a69 5397
6fc2811b 5398
6b61353c
KH
5399DEFUN ("x-delete-window-property", Fx_delete_window_property,
5400 Sx_delete_window_property, 1, 2, 0,
5401 doc: /* Remove window property PROP from X window of FRAME.
5402FRAME nil or omitted means use the selected frame. Value is PROP. */)
5842a27b 5403 (Lisp_Object prop, Lisp_Object frame)
6fc2811b 5404{
7452b7bd 5405 struct frame *f = decode_window_system_frame (frame);
6b61353c 5406 Atom prop_atom;
6fc2811b 5407
6b61353c 5408 CHECK_STRING (prop);
4d7e6e51 5409 block_input ();
6b61353c
KH
5410 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5411 XDeleteProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f), prop_atom);
6fc2811b 5412
6b61353c
KH
5413 /* Make sure the property is removed when we return. */
5414 XFlush (FRAME_W32_DISPLAY (f));
4d7e6e51 5415 unblock_input ();
6fc2811b 5416
6b61353c 5417 return prop;
6fc2811b
JR
5418}
5419
5420
6b61353c 5421DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
ddadbc0e 5422 1, 6, 0,
6b61353c 5423 doc: /* Value is the value of window property PROP on FRAME.
7c051dd8
GM
5424If FRAME is nil or omitted, use the selected frame.
5425
7c051dd8
GM
5426On X Windows, the following optional arguments are also accepted:
5427If TYPE is nil or omitted, get the property as a string.
5428Otherwise TYPE is the name of the atom that denotes the type expected.
5429If SOURCE is non-nil, get the property on that window instead of from
5430FRAME. The number 0 denotes the root window.
ddadbc0e
AS
5431If DELETE-P is non-nil, delete the property after retrieving it.
5432If VECTOR-RET-P is non-nil, don't return a string but a vector of values.
5433
5434On MS Windows, this function accepts but ignores those optional arguments.
7c051dd8
GM
5435
5436Value is nil if FRAME hasn't a property with name PROP or if PROP has
5437no value of TYPE (always string in the MS Windows case). */)
ddadbc0e
AS
5438 (Lisp_Object prop, Lisp_Object frame, Lisp_Object type,
5439 Lisp_Object source, Lisp_Object delete_p, Lisp_Object vector_ret_p)
6fc2811b 5440{
7452b7bd 5441 struct frame *f = decode_window_system_frame (frame);
6b61353c
KH
5442 Atom prop_atom;
5443 int rc;
5444 Lisp_Object prop_value = Qnil;
5445 char *tmp_data = NULL;
5446 Atom actual_type;
5447 int actual_format;
5448 unsigned long actual_size, bytes_remaining;
7d0393cf 5449
6b61353c 5450 CHECK_STRING (prop);
4d7e6e51 5451 block_input ();
6b61353c
KH
5452 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5453 rc = XGetWindowProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5454 prop_atom, 0, 0, False, XA_STRING,
5455 &actual_type, &actual_format, &actual_size,
5456 &bytes_remaining, (unsigned char **) &tmp_data);
5457 if (rc == Success)
6fc2811b 5458 {
6b61353c 5459 int size = bytes_remaining;
3cf3436e 5460
6b61353c
KH
5461 XFree (tmp_data);
5462 tmp_data = NULL;
3cf3436e 5463
6b61353c
KH
5464 rc = XGetWindowProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5465 prop_atom, 0, bytes_remaining,
5466 False, XA_STRING,
5467 &actual_type, &actual_format,
5468 &actual_size, &bytes_remaining,
5469 (unsigned char **) &tmp_data);
5470 if (rc == Success)
5471 prop_value = make_string (tmp_data, size);
6fc2811b 5472
6b61353c
KH
5473 XFree (tmp_data);
5474 }
6fc2811b 5475
4d7e6e51 5476 unblock_input ();
6fc2811b 5477
6b61353c 5478 return prop_value;
6fc2811b 5479
6b61353c 5480 return Qnil;
6fc2811b
JR
5481}
5482
b124fd93 5483#endif /* TODO */
6fc2811b
JR
5484
5485\f
5486/***********************************************************************
6b61353c 5487 Busy cursor
6fc2811b
JR
5488 ***********************************************************************/
5489
6b61353c 5490void
c06c382a 5491w32_note_current_window (void)
6fc2811b 5492{
d148e14d 5493 struct frame * f = SELECTED_FRAME ();
6fc2811b 5494
30076589
JR
5495 if (!FRAME_W32_P (f))
5496 return;
5497
d148e14d 5498 hourglass_hwnd = FRAME_W32_WINDOW (f);
f79e6790
JR
5499}
5500
f79e6790 5501void
c06c382a 5502show_hourglass (struct atimer *timer)
f79e6790 5503{
c06c382a 5504 struct frame *f;
7d0393cf 5505
c06c382a
EZ
5506 hourglass_atimer = NULL;
5507
5508 block_input ();
5509 f = x_window_to_frame (&one_w32_display_info,
5510 hourglass_hwnd);
5511
5512 if (f)
5513 f->output_data.w32->hourglass_p = 0;
5514 else
5515 f = SELECTED_FRAME ();
5516
5517 if (!FRAME_W32_P (f))
f0177f86
EZ
5518 {
5519 unblock_input ();
5520 return;
5521 }
c06c382a
EZ
5522
5523 w32_show_hourglass (f);
5524 unblock_input ();
f79e6790
JR
5525}
5526
c06c382a
EZ
5527void
5528hide_hourglass (void)
5529{
5530 block_input ();
5531 w32_hide_hourglass ();
5532 unblock_input ();
5533}
f79e6790 5534
f79e6790 5535
c06c382a 5536/* Display an hourglass cursor. Set the hourglass_p flag in display info
d148e14d 5537 to indicate that an hourglass cursor is shown. */
f79e6790
JR
5538
5539static void
b56ceb92 5540w32_show_hourglass (struct frame *f)
6fc2811b 5541{
0af913d7 5542 if (!hourglass_shown_p)
6fc2811b 5543 {
d148e14d
JR
5544 f->output_data.w32->hourglass_p = 1;
5545 if (!menubar_in_use && !current_popup_menu)
5546 SetCursor (f->output_data.w32->hourglass_cursor);
0af913d7 5547 hourglass_shown_p = 1;
f79e6790 5548 }
6fc2811b
JR
5549}
5550
5551
0af913d7 5552/* Hide the hourglass cursor on all frames, if it is currently shown. */
6fc2811b 5553
f79e6790 5554static void
b56ceb92 5555w32_hide_hourglass (void)
f79e6790 5556{
0af913d7 5557 if (hourglass_shown_p)
6fc2811b 5558 {
d148e14d
JR
5559 struct frame *f = x_window_to_frame (&one_w32_display_info,
5560 hourglass_hwnd);
89e09428
JR
5561 if (f)
5562 f->output_data.w32->hourglass_p = 0;
5563 else
5564 /* If frame was deleted, restore to selected frame's cursor. */
5565 f = SELECTED_FRAME ();
5566
5567 if (FRAME_W32_P (f))
5568 SetCursor (f->output_data.w32->current_cursor);
5569 else
5570 /* No cursors on non GUI frames - restore to stock arrow cursor. */
5571 SetCursor (w32_load_cursor (IDC_ARROW));
6fc2811b 5572
0af913d7 5573 hourglass_shown_p = 0;
f79e6790 5574 }
6fc2811b
JR
5575}
5576
5577
5578\f
5579/***********************************************************************
5580 Tool tips
5581 ***********************************************************************/
5582
f57e2426
J
5583static Lisp_Object x_create_tip_frame (struct w32_display_info *,
5584 Lisp_Object, Lisp_Object);
5585static void compute_tip_xy (struct frame *, Lisp_Object, Lisp_Object,
5586 Lisp_Object, int, int, int *, int *);
7d0393cf 5587
3cf3436e 5588/* The frame of a currently visible tooltip. */
6fc2811b 5589
937e601e 5590Lisp_Object tip_frame;
6fc2811b
JR
5591
5592/* If non-nil, a timer started that hides the last tooltip when it
5593 fires. */
5594
5595Lisp_Object tip_timer;
5596Window tip_window;
5597
3cf3436e
JR
5598/* If non-nil, a vector of 3 elements containing the last args
5599 with which x-show-tip was called. See there. */
5600
5601Lisp_Object last_show_tip_args;
5602
3cf3436e 5603
27e498e6 5604static void
b56ceb92 5605unwind_create_tip_frame (Lisp_Object frame)
937e601e 5606{
c844a81a
GM
5607 Lisp_Object deleted;
5608
5609 deleted = unwind_create_frame (frame);
5610 if (EQ (deleted, Qt))
5611 {
5612 tip_window = NULL;
5613 tip_frame = Qnil;
5614 }
937e601e
AI
5615}
5616
5617
6fc2811b 5618/* Create a frame for a tooltip on the display described by DPYINFO.
3cf3436e
JR
5619 PARMS is a list of frame parameters. TEXT is the string to
5620 display in the tip frame. Value is the frame.
937e601e
AI
5621
5622 Note that functions called here, esp. x_default_parameter can
5623 signal errors, for instance when a specified color name is
5624 undefined. We have to make sure that we're in a consistent state
5625 when this happens. */
6fc2811b
JR
5626
5627static Lisp_Object
b56ceb92
JB
5628x_create_tip_frame (struct w32_display_info *dpyinfo,
5629 Lisp_Object parms, Lisp_Object text)
6fc2811b 5630{
6fc2811b 5631 struct frame *f;
0f4a96b5 5632 Lisp_Object frame;
6fc2811b
JR
5633 Lisp_Object name;
5634 long window_prompting = 0;
5635 int width, height;
d311d28c 5636 ptrdiff_t count = SPECPDL_INDEX ();
6fc2811b
JR
5637 struct gcpro gcpro1, gcpro2, gcpro3;
5638 struct kboard *kb;
3cf3436e
JR
5639 int face_change_count_before = face_change_count;
5640 Lisp_Object buffer;
5641 struct buffer *old_buffer;
6fc2811b 5642
6fc2811b
JR
5643 /* Use this general default value to start with until we know if
5644 this frame has a specified name. */
5645 Vx_resource_name = Vinvocation_name;
5646
fd142562 5647 kb = dpyinfo->terminal->kboard;
6fc2811b 5648
4a217bed
EZ
5649 /* The calls to x_get_arg remove elements from PARMS, so copy it to
5650 avoid destructive changes behind our caller's back. */
5651 parms = Fcopy_alist (parms);
5652
6fc2811b 5653 /* Get the name of the frame to use for resource lookup. */
3faa984f 5654 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
6fc2811b
JR
5655 if (!STRINGP (name)
5656 && !EQ (name, Qunbound)
5657 && !NILP (name))
5658 error ("Invalid frame name--not a string or nil");
5659 Vx_resource_name = name;
5660
5661 frame = Qnil;
5662 GCPRO3 (parms, name, frame);
9eb16b62
JR
5663 /* Make a frame without minibuffer nor mode-line. */
5664 f = make_frame (0);
5665 f->wants_modeline = 0;
6fc2811b 5666 XSETFRAME (frame, f);
3cf3436e
JR
5667
5668 buffer = Fget_buffer_create (build_string (" *tip*"));
08908aca
MR
5669 /* Use set_window_buffer instead of Fset_window_buffer (see
5670 discussion of bug#11984, bug#12025, bug#12026). */
5671 set_window_buffer (FRAME_ROOT_WINDOW (f), buffer, 0, 0);
3cf3436e
JR
5672 old_buffer = current_buffer;
5673 set_buffer_internal_1 (XBUFFER (buffer));
39eb03f1 5674 bset_truncate_lines (current_buffer, Qnil);
5c2a995d
KH
5675 specbind (Qinhibit_read_only, Qt);
5676 specbind (Qinhibit_modification_hooks, Qt);
3cf3436e
JR
5677 Ferase_buffer ();
5678 Finsert (1, &text);
5679 set_buffer_internal_1 (old_buffer);
7d0393cf 5680
937e601e 5681 record_unwind_protect (unwind_create_tip_frame, frame);
6fc2811b 5682
3cf3436e
JR
5683 /* By setting the output method, we're essentially saying that
5684 the frame is live, as per FRAME_LIVE_P. If we get a signal
5685 from this point on, x_destroy_window might screw up reference
5686 counts etc. */
ebbb61be 5687 f->terminal = dpyinfo->terminal;
d88c567c 5688 f->output_method = output_w32;
23f86fce 5689 f->output_data.w32 = xzalloc (sizeof (struct w32_output));
ca56d953
JR
5690
5691 FRAME_FONTSET (f) = -1;
f00af5b1 5692 fset_icon_name (f, Qnil);
6fc2811b 5693
e509cfa6 5694#ifdef GLYPH_DEBUG
a06776b2 5695 image_cache_refcount =
784b56e2 5696 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
937e601e
AI
5697 dpyinfo_refcount = dpyinfo->reference_count;
5698#endif /* GLYPH_DEBUG */
6fc2811b 5699 FRAME_KBOARD (f) = kb;
aad3612f 5700 f->output_data.w32->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
6fc2811b
JR
5701 f->output_data.w32->explicit_parent = 0;
5702
5703 /* Set the name; the functions to which we pass f expect the name to
5704 be set. */
5705 if (EQ (name, Qunbound) || NILP (name))
5706 {
f00af5b1 5707 fset_name (f, build_string (dpyinfo->w32_id_name));
6fc2811b
JR
5708 f->explicit_name = 0;
5709 }
5710 else
5711 {
f00af5b1 5712 fset_name (f, name);
6fc2811b
JR
5713 f->explicit_name = 1;
5714 /* use the frame's title when getting resources for this frame. */
5715 specbind (Qx_resource_name, name);
5716 }
5717
fdb55376
JR
5718 if (uniscribe_available)
5719 register_font_driver (&uniscribe_font_driver, f);
1cc06b86 5720 register_font_driver (&w32font_driver, f);
a1fe5c00 5721
1cc06b86
KH
5722 x_default_parameter (f, parms, Qfont_backend, Qnil,
5723 "fontBackend", "FontBackend", RES_TYPE_STRING);
a1fe5c00 5724
6fc2811b
JR
5725 /* Extract the window parameters from the supplied values
5726 that are needed to determine window geometry. */
1cc06b86 5727 x_default_font_parameter (f, parms);
6fc2811b
JR
5728
5729 x_default_parameter (f, parms, Qborder_width, make_number (2),
5730 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
6fc2811b
JR
5731 /* This defaults to 2 in order to match xterm. We recognize either
5732 internalBorderWidth or internalBorder (which is what xterm calls
5733 it). */
5734 if (NILP (Fassq (Qinternal_border_width, parms)))
5735 {
5736 Lisp_Object value;
5737
3faa984f 5738 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
6fc2811b
JR
5739 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
5740 if (! EQ (value, Qunbound))
5741 parms = Fcons (Fcons (Qinternal_border_width, value),
5742 parms);
5743 }
bfd6edcc 5744 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
6fc2811b
JR
5745 "internalBorderWidth", "internalBorderWidth",
5746 RES_TYPE_NUMBER);
880e6158
MR
5747 x_default_parameter (f, parms, Qright_divider_width, make_number (0),
5748 NULL, NULL, RES_TYPE_NUMBER);
5749 x_default_parameter (f, parms, Qbottom_divider_width, make_number (0),
5750 NULL, NULL, RES_TYPE_NUMBER);
6fc2811b
JR
5751
5752 /* Also do the stuff which must be set before the window exists. */
5753 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
5754 "foreground", "Foreground", RES_TYPE_STRING);
5755 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
5756 "background", "Background", RES_TYPE_STRING);
5757 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
5758 "pointerColor", "Foreground", RES_TYPE_STRING);
5759 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
5760 "cursorColor", "Foreground", RES_TYPE_STRING);
5761 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
5762 "borderColor", "BorderColor", RES_TYPE_STRING);
5763
5764 /* Init faces before x_default_parameter is called for scroll-bar
5765 parameters because that function calls x_set_scroll_bar_width,
5766 which calls change_frame_size, which calls Fset_window_buffer,
5767 which runs hooks, which call Fvertical_motion. At the end, we
5768 end up in init_iterator with a null face cache, which should not
5769 happen. */
5770 init_frame_faces (f);
ca56d953
JR
5771
5772 f->output_data.w32->dwStyle = WS_BORDER | WS_POPUP | WS_DISABLED;
aad3612f 5773 f->output_data.w32->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
9eb16b62 5774
6d906347 5775 window_prompting = x_figure_window_size (f, parms, 0);
6fc2811b 5776
9eb16b62 5777 /* No fringes on tip frame. */
be786000
KS
5778 f->fringe_cols = 0;
5779 f->left_fringe_width = 0;
5780 f->right_fringe_width = 0;
9eb16b62 5781
4d7e6e51 5782 block_input ();
ca56d953 5783 my_create_tip_window (f);
4d7e6e51 5784 unblock_input ();
6fc2811b
JR
5785
5786 x_make_gc (f);
5787
5788 x_default_parameter (f, parms, Qauto_raise, Qnil,
5789 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5790 x_default_parameter (f, parms, Qauto_lower, Qnil,
5791 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5792 x_default_parameter (f, parms, Qcursor_type, Qbox,
5793 "cursorType", "CursorType", RES_TYPE_SYMBOL);
5794
880e6158
MR
5795 /* Dimensions, especially FRAME_LINES (f), must be done via
5796 change_frame_size. Change will not be effected unless different
5797 from the current FRAME_LINES (f). */
be786000
KS
5798 width = FRAME_COLS (f);
5799 height = FRAME_LINES (f);
5800 FRAME_LINES (f) = 0;
5801 SET_FRAME_COLS (f, 0);
880e6158 5802 change_frame_size (f, width, height, 1, 0, 0, 0);
6fc2811b 5803
cd1d850f 5804 /* Add `tooltip' frame parameter's default value. */
54ee7410
CY
5805 if (NILP (Fframe_parameter (frame, Qtooltip)))
5806 Fmodify_frame_parameters (frame, Fcons (Fcons (Qtooltip, Qt), Qnil));
7d0393cf 5807
3cf3436e
JR
5808 /* Set up faces after all frame parameters are known. This call
5809 also merges in face attributes specified for new frames.
5810
5811 Frame parameters may be changed if .Xdefaults contains
5812 specifications for the default font. For example, if there is an
5813 `Emacs.default.attributeBackground: pink', the `background-color'
5814 attribute of the frame get's set, which let's the internal border
5815 of the tooltip frame appear in pink. Prevent this. */
5816 {
5817 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
601a9cf1
JB
5818 Lisp_Object fg = Fframe_parameter (frame, Qforeground_color);
5819 Lisp_Object colors = Qnil;
3cf3436e
JR
5820
5821 /* Set tip_frame here, so that */
5822 tip_frame = frame;
45cebfd9 5823 call2 (Qface_set_after_frame_default, frame, Qnil);
7d0393cf 5824
3cf3436e 5825 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
601a9cf1
JB
5826 colors = Fcons (Fcons (Qbackground_color, bg), colors);
5827 if (!EQ (fg, Fframe_parameter (frame, Qforeground_color)))
5828 colors = Fcons (Fcons (Qforeground_color, fg), colors);
5829
5830 if (!NILP (colors))
5831 Fmodify_frame_parameters (frame, colors);
3cf3436e 5832 }
7d0393cf 5833
6fc2811b
JR
5834 f->no_split = 1;
5835
5836 UNGCPRO;
5837
a06776b2
EZ
5838 /* Now that the frame is official, it counts as a reference to
5839 its display. */
aad3612f 5840 FRAME_DISPLAY_INFO (f)->reference_count++;
a06776b2
EZ
5841 f->terminal->reference_count++;
5842
6fc2811b
JR
5843 /* It is now ok to make the frame official even if we get an error
5844 below. And the frame needs to be on Vframe_list or making it
5845 visible won't work. */
5846 Vframe_list = Fcons (frame, Vframe_list);
5847
3cf3436e
JR
5848 /* Setting attributes of faces of the tooltip frame from resources
5849 and similar will increment face_change_count, which leads to the
5850 clearing of all current matrices. Since this isn't necessary
5851 here, avoid it by resetting face_change_count to the value it
5852 had before we created the tip frame. */
5853 face_change_count = face_change_count_before;
5854
5855 /* Discard the unwind_protect. */
6fc2811b 5856 return unbind_to (count, frame);
ee78dc32
GV
5857}
5858
3cf3436e
JR
5859
5860/* Compute where to display tip frame F. PARMS is the list of frame
5861 parameters for F. DX and DY are specified offsets from the current
5862 location of the mouse. WIDTH and HEIGHT are the width and height
5863 of the tooltip. Return coordinates relative to the root window of
5864 the display in *ROOT_X, and *ROOT_Y. */
5865
5866static void
b56ceb92
JB
5867compute_tip_xy (struct frame *f,
5868 Lisp_Object parms, Lisp_Object dx, Lisp_Object dy,
5869 int width, int height, int *root_x, int *root_y)
3cf3436e 5870{
3cf3436e 5871 Lisp_Object left, top;
64f0809d 5872 int min_x, min_y, max_x, max_y;
7d0393cf 5873
3cf3436e
JR
5874 /* User-specified position? */
5875 left = Fcdr (Fassq (Qleft, parms));
5876 top = Fcdr (Fassq (Qtop, parms));
7d0393cf 5877
3cf3436e
JR
5878 /* Move the tooltip window where the mouse pointer is. Resize and
5879 show it. */
ca56d953 5880 if (!INTEGERP (left) || !INTEGERP (top))
3cf3436e 5881 {
ca56d953
JR
5882 POINT pt;
5883
64f0809d
JR
5884 /* Default min and max values. */
5885 min_x = 0;
5886 min_y = 0;
aad3612f
DA
5887 max_x = x_display_pixel_width (FRAME_DISPLAY_INFO (f));
5888 max_y = x_display_pixel_height (FRAME_DISPLAY_INFO (f));
64f0809d 5889
4d7e6e51 5890 block_input ();
ca56d953
JR
5891 GetCursorPos (&pt);
5892 *root_x = pt.x;
5893 *root_y = pt.y;
4d7e6e51 5894 unblock_input ();
64f0809d
JR
5895
5896 /* If multiple monitor support is available, constrain the tip onto
5897 the current monitor. This improves the above by allowing negative
5898 co-ordinates if monitor positions are such that they are valid, and
5899 snaps a tooltip onto a single monitor if we are close to the edge
5900 where it would otherwise flow onto the other monitor (or into
5901 nothingness if there is a gap in the overlap). */
5902 if (monitor_from_point_fn && get_monitor_info_fn)
5903 {
5904 struct MONITOR_INFO info;
5905 HMONITOR monitor
5906 = monitor_from_point_fn (pt, MONITOR_DEFAULT_TO_NEAREST);
5907 info.cbSize = sizeof (info);
5908
5909 if (get_monitor_info_fn (monitor, &info))
5910 {
5911 min_x = info.rcWork.left;
5912 min_y = info.rcWork.top;
5913 max_x = info.rcWork.right;
5914 max_y = info.rcWork.bottom;
5915 }
5916 }
3cf3436e
JR
5917 }
5918
5919 if (INTEGERP (top))
5920 *root_y = XINT (top);
64f0809d
JR
5921 else if (*root_y + XINT (dy) <= min_y)
5922 *root_y = min_y; /* Can happen for negative dy */
5923 else if (*root_y + XINT (dy) + height <= max_y)
7e8410d1 5924 /* It fits below the pointer */
3cf3436e 5925 *root_y += XINT (dy);
64f0809d 5926 else if (height + XINT (dy) + min_y <= *root_y)
7e8410d1
JD
5927 /* It fits above the pointer. */
5928 *root_y -= height + XINT (dy);
5929 else
5930 /* Put it on the top. */
64f0809d 5931 *root_y = min_y;
3cf3436e
JR
5932
5933 if (INTEGERP (left))
5934 *root_x = XINT (left);
64f0809d 5935 else if (*root_x + XINT (dx) <= min_x)
bf63eb69 5936 *root_x = 0; /* Can happen for negative dx */
64f0809d 5937 else if (*root_x + XINT (dx) + width <= max_x)
72e4adef
JR
5938 /* It fits to the right of the pointer. */
5939 *root_x += XINT (dx);
64f0809d 5940 else if (width + XINT (dx) + min_x <= *root_x)
72e4adef 5941 /* It fits to the left of the pointer. */
3cf3436e
JR
5942 *root_x -= width + XINT (dx);
5943 else
72e4adef 5944 /* Put it left justified on the screen -- it ought to fit that way. */
64f0809d 5945 *root_x = min_x;
3cf3436e
JR
5946}
5947
5948
71eab8d1 5949DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
74e1aeec
JR
5950 doc: /* Show STRING in a \"tooltip\" window on frame FRAME.
5951A tooltip window is a small window displaying a string.
5952
87c891c7
EZ
5953This is an internal function; Lisp code should call `tooltip-show'.
5954
74e1aeec
JR
5955FRAME nil or omitted means use the selected frame.
5956
5957PARMS is an optional list of frame parameters which can be
5958used to change the tooltip's appearance.
5959
ca56d953
JR
5960Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
5961means use the default timeout of 5 seconds.
74e1aeec 5962
52deb19f 5963If the list of frame parameters PARMS contains a `left' parameter,
74e1aeec
JR
5964the tooltip is displayed at that x-position. Otherwise it is
5965displayed at the mouse position, with offset DX added (default is 5 if
5966DX isn't specified). Likewise for the y-position; if a `top' frame
5967parameter is specified, it determines the y-position of the tooltip
5968window, otherwise it is displayed at the mouse position, with offset
5969DY added (default is -10).
5970
5971A tooltip's maximum size is specified by `x-max-tooltip-size'.
5972Text larger than the specified size is clipped. */)
5842a27b 5973 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
ee78dc32 5974{
6fc2811b
JR
5975 struct frame *f;
5976 struct window *w;
3cf3436e 5977 int root_x, root_y;
6fc2811b
JR
5978 struct buffer *old_buffer;
5979 struct text_pos pos;
a971c0a7 5980 int i, width, height, seen_reversed_p;
6fc2811b
JR
5981 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
5982 int old_windows_or_buffers_changed = windows_or_buffers_changed;
d311d28c 5983 ptrdiff_t count = SPECPDL_INDEX ();
7d0393cf 5984
6fc2811b 5985 specbind (Qinhibit_redisplay, Qt);
ee78dc32 5986
dfff8a69 5987 GCPRO4 (string, parms, frame, timeout);
ee78dc32 5988
b7826503 5989 CHECK_STRING (string);
7452b7bd 5990 f = decode_window_system_frame (frame);
6fc2811b
JR
5991 if (NILP (timeout))
5992 timeout = make_number (5);
5993 else
b7826503 5994 CHECK_NATNUM (timeout);
ee78dc32 5995
71eab8d1
AI
5996 if (NILP (dx))
5997 dx = make_number (5);
5998 else
b7826503 5999 CHECK_NUMBER (dx);
7d0393cf 6000
71eab8d1 6001 if (NILP (dy))
dc220243 6002 dy = make_number (-10);
71eab8d1 6003 else
b7826503 6004 CHECK_NUMBER (dy);
71eab8d1 6005
dc220243
JR
6006 if (NILP (last_show_tip_args))
6007 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
6008
6009 if (!NILP (tip_frame))
6010 {
6011 Lisp_Object last_string = AREF (last_show_tip_args, 0);
6012 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
6013 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
6014
6015 if (EQ (frame, last_frame)
6016 && !NILP (Fequal (last_string, string))
6017 && !NILP (Fequal (last_parms, parms)))
6018 {
6019 struct frame *f = XFRAME (tip_frame);
7d0393cf 6020
dc220243
JR
6021 /* Only DX and DY have changed. */
6022 if (!NILP (tip_timer))
6023 {
6024 Lisp_Object timer = tip_timer;
6025 tip_timer = Qnil;
6026 call1 (Qcancel_timer, timer);
6027 }
6028
4d7e6e51 6029 block_input ();
be786000
KS
6030 compute_tip_xy (f, parms, dx, dy, FRAME_PIXEL_WIDTH (f),
6031 FRAME_PIXEL_HEIGHT (f), &root_x, &root_y);
d65a9cdc
JR
6032
6033 /* Put tooltip in topmost group and in position. */
ca56d953
JR
6034 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOPMOST,
6035 root_x, root_y, 0, 0,
6036 SWP_NOSIZE | SWP_NOACTIVATE);
d65a9cdc
JR
6037
6038 /* Ensure tooltip is on top of other topmost windows (eg menus). */
6039 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOP,
6040 0, 0, 0, 0,
6041 SWP_NOMOVE | SWP_NOSIZE | SWP_NOACTIVATE);
6042
4d7e6e51 6043 unblock_input ();
dc220243
JR
6044 goto start_timer;
6045 }
6046 }
6047
6fc2811b
JR
6048 /* Hide a previous tip, if any. */
6049 Fx_hide_tip ();
ee78dc32 6050
dc220243
JR
6051 ASET (last_show_tip_args, 0, string);
6052 ASET (last_show_tip_args, 1, frame);
6053 ASET (last_show_tip_args, 2, parms);
6054
6fc2811b
JR
6055 /* Add default values to frame parameters. */
6056 if (NILP (Fassq (Qname, parms)))
6057 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
6058 if (NILP (Fassq (Qinternal_border_width, parms)))
6059 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
880e6158
MR
6060 if (NILP (Fassq (Qright_divider_width, parms)))
6061 parms = Fcons (Fcons (Qright_divider_width, make_number (0)), parms);
6062 if (NILP (Fassq (Qbottom_divider_width, parms)))
6063 parms = Fcons (Fcons (Qbottom_divider_width, make_number (0)), parms);
6fc2811b
JR
6064 if (NILP (Fassq (Qborder_width, parms)))
6065 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
6066 if (NILP (Fassq (Qborder_color, parms)))
6067 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
6068 if (NILP (Fassq (Qbackground_color, parms)))
6069 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
6070 parms);
6071
0e3fcdef
JR
6072 /* Block input until the tip has been fully drawn, to avoid crashes
6073 when drawing tips in menus. */
4d7e6e51 6074 block_input ();
0e3fcdef 6075
6fc2811b
JR
6076 /* Create a frame for the tooltip, and record it in the global
6077 variable tip_frame. */
aad3612f 6078 frame = x_create_tip_frame (FRAME_DISPLAY_INFO (f), parms, string);
937e601e 6079 f = XFRAME (frame);
6fc2811b 6080
3cf3436e 6081 /* Set up the frame's root window. */
6fc2811b 6082 w = XWINDOW (FRAME_ROOT_WINDOW (f));
5f24fa51
DA
6083 w->left_col = 0;
6084 w->top_line = 0;
880e6158
MR
6085 w->pixel_left = 0;
6086 w->pixel_top = 0;
3cf3436e
JR
6087
6088 if (CONSP (Vx_max_tooltip_size)
6089 && INTEGERP (XCAR (Vx_max_tooltip_size))
6090 && XINT (XCAR (Vx_max_tooltip_size)) > 0
6091 && INTEGERP (XCDR (Vx_max_tooltip_size))
6092 && XINT (XCDR (Vx_max_tooltip_size)) > 0)
6093 {
5f24fa51
DA
6094 w->total_cols = XFASTINT (XCAR (Vx_max_tooltip_size));
6095 w->total_lines = XFASTINT (XCDR (Vx_max_tooltip_size));
3cf3436e
JR
6096 }
6097 else
6098 {
5f24fa51
DA
6099 w->total_cols = 80;
6100 w->total_lines = 40;
3cf3436e 6101 }
7d0393cf 6102
880e6158
MR
6103 w->pixel_width = w->total_cols * FRAME_COLUMN_WIDTH (f);
6104 w->pixel_height = w->total_lines * FRAME_LINE_HEIGHT (f);
6105
21e930f8 6106 FRAME_TOTAL_COLS (f) = WINDOW_TOTAL_COLS (w);
bd0443bb 6107 adjust_frame_glyphs (f);
6fc2811b
JR
6108 w->pseudo_window_p = 1;
6109
6110 /* Display the tooltip text in a temporary buffer. */
6fc2811b 6111 old_buffer = current_buffer;
e74aeda8 6112 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->contents));
39eb03f1 6113 bset_truncate_lines (current_buffer, Qnil);
6fc2811b
JR
6114 clear_glyph_matrix (w->desired_matrix);
6115 clear_glyph_matrix (w->current_matrix);
6116 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
39321b94 6117 try_window (FRAME_ROOT_WINDOW (f), pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
6fc2811b
JR
6118
6119 /* Compute width and height of the tooltip. */
a971c0a7 6120 width = height = seen_reversed_p = 0;
6fc2811b 6121 for (i = 0; i < w->desired_matrix->nrows; ++i)
ee78dc32 6122 {
6fc2811b
JR
6123 struct glyph_row *row = &w->desired_matrix->rows[i];
6124 struct glyph *last;
6125 int row_width;
6126
6127 /* Stop at the first empty row at the end. */
138c0ae8 6128 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
6fc2811b
JR
6129 break;
6130
6131 /* Let the row go over the full width of the frame. */
6132 row->full_width_p = 1;
6133
a971c0a7 6134 row_width = row->pixel_width;
6fc2811b
JR
6135 if (row->used[TEXT_AREA])
6136 {
a971c0a7
EZ
6137 if (!row->reversed_p)
6138 {
a971c0a7
EZ
6139 /* There's a glyph at the end of rows that is used to
6140 place the cursor there. Don't include the width of
6141 this glyph. */
6142 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
6143 if (INTEGERP (last->object))
6144 row_width -= last->pixel_width;
a971c0a7
EZ
6145 }
6146 else
6147 {
6148 /* There could be a stretch glyph at the beginning of R2L
6149 rows that is produced by extend_face_to_end_of_line.
6150 Don't count that glyph. */
6151 struct glyph *g = row->glyphs[TEXT_AREA];
6152
6153 if (g->type == STRETCH_GLYPH && INTEGERP (g->object))
6154 {
6155 row_width -= g->pixel_width;
6156 seen_reversed_p = 1;
6157 }
6158 }
6159 }
7d0393cf 6160
bfd6edcc 6161 height += row->height;
6fc2811b 6162 width = max (width, row_width);
ee78dc32
GV
6163 }
6164
a971c0a7
EZ
6165 /* If we've seen partial-length R2L rows, we need to re-adjust the
6166 tool-tip frame width and redisplay it again, to avoid over-wide
6167 tips due to the stretch glyph that extends R2L lines to full
6168 width of the frame. */
6169 if (seen_reversed_p)
6170 {
880e6158
MR
6171 /* PXW: Why do we do the pixel-to-cols conversion only if
6172 seen_reversed_p holds? Don't we have to set other fields of
f224e500 6173 the window/frame structure?
880e6158
MR
6174
6175 w->total_cols and FRAME_TOTAL_COLS want the width in columns,
a971c0a7 6176 not in pixels. */
880e6158 6177 w->pixel_width = width;
a971c0a7 6178 width /= WINDOW_FRAME_COLUMN_WIDTH (w);
5f24fa51 6179 w->total_cols = width;
a971c0a7 6180 FRAME_TOTAL_COLS (f) = width;
880e6158 6181 SET_FRAME_WIDTH (f, width);
bd0443bb 6182 adjust_frame_glyphs (f);
39321b94 6183 w->pseudo_window_p = 1;
a971c0a7
EZ
6184 clear_glyph_matrix (w->desired_matrix);
6185 clear_glyph_matrix (w->current_matrix);
39321b94 6186 try_window (FRAME_ROOT_WINDOW (f), pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
a971c0a7
EZ
6187 width = height = 0;
6188 /* Recompute width and height of the tooltip. */
6189 for (i = 0; i < w->desired_matrix->nrows; ++i)
6190 {
6191 struct glyph_row *row = &w->desired_matrix->rows[i];
6192 struct glyph *last;
6193 int row_width;
6194
138c0ae8 6195 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
a971c0a7
EZ
6196 break;
6197 row->full_width_p = 1;
6198 row_width = row->pixel_width;
a971c0a7
EZ
6199 if (row->used[TEXT_AREA] && !row->reversed_p)
6200 {
6201 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
6202 if (INTEGERP (last->object))
6203 row_width -= last->pixel_width;
6204 }
a971c0a7
EZ
6205
6206 height += row->height;
6207 width = max (width, row_width);
6208 }
6209 }
6210
39321b94 6211 /* Add the frame's internal border to the width and height the w32
6fc2811b
JR
6212 window should have. */
6213 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
6214 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
ee78dc32 6215
6fc2811b 6216 /* Move the tooltip window where the mouse pointer is. Resize and
880e6158
MR
6217 show it.
6218
6219 PXW: This should use the frame's pixel coordinates. */
3cf3436e 6220 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
71eab8d1 6221
bfd6edcc
JR
6222 {
6223 /* Adjust Window size to take border into account. */
6224 RECT rect;
6225 rect.left = rect.top = 0;
6226 rect.right = width;
6227 rect.bottom = height;
6228 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
6229 FRAME_EXTERNAL_MENU_BAR (f));
6230
1d79e521 6231 /* Position and size tooltip, and put it in the topmost group.
39321b94
EZ
6232 The add-on of FRAME_COLUMN_WIDTH to the 5th argument is a
6233 peculiarity of w32 display: without it, some fonts cause the
6234 last character of the tip to be truncated or wrapped around to
6235 the next line. */
bfd6edcc 6236 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOPMOST,
39321b94
EZ
6237 root_x, root_y,
6238 rect.right - rect.left + FRAME_COLUMN_WIDTH (f),
bfd6edcc
JR
6239 rect.bottom - rect.top, SWP_NOACTIVATE);
6240
d65a9cdc
JR
6241 /* Ensure tooltip is on top of other topmost windows (eg menus). */
6242 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOP,
6243 0, 0, 0, 0,
6244 SWP_NOMOVE | SWP_NOSIZE | SWP_NOACTIVATE);
6245
bfd6edcc 6246 /* Let redisplay know that we have made the frame visible already. */
edfa7fa0 6247 SET_FRAME_VISIBLE (f, 1);
bfd6edcc
JR
6248
6249 ShowWindow (FRAME_W32_WINDOW (f), SW_SHOWNOACTIVATE);
6250 }
ee78dc32 6251
6fc2811b
JR
6252 /* Draw into the window. */
6253 w->must_be_updated_p = 1;
6254 update_single_window (w, 1);
ee78dc32 6255
4d7e6e51 6256 unblock_input ();
0e3fcdef 6257
6fc2811b
JR
6258 /* Restore original current buffer. */
6259 set_buffer_internal_1 (old_buffer);
6260 windows_or_buffers_changed = old_windows_or_buffers_changed;
ee78dc32 6261
dc220243 6262 start_timer:
6fc2811b
JR
6263 /* Let the tip disappear after timeout seconds. */
6264 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
6265 intern ("x-hide-tip"));
ee78dc32 6266
dfff8a69 6267 UNGCPRO;
6fc2811b 6268 return unbind_to (count, Qnil);
ee78dc32
GV
6269}
6270
ee78dc32 6271
6fc2811b 6272DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
74e1aeec
JR
6273 doc: /* Hide the current tooltip window, if there is any.
6274Value is t if tooltip was open, nil otherwise. */)
5842a27b 6275 (void)
6fc2811b 6276{
d311d28c 6277 ptrdiff_t count;
937e601e
AI
6278 Lisp_Object deleted, frame, timer;
6279 struct gcpro gcpro1, gcpro2;
6280
6281 /* Return quickly if nothing to do. */
6282 if (NILP (tip_timer) && NILP (tip_frame))
6283 return Qnil;
7d0393cf 6284
937e601e
AI
6285 frame = tip_frame;
6286 timer = tip_timer;
6287 GCPRO2 (frame, timer);
6288 tip_frame = tip_timer = deleted = Qnil;
7d0393cf 6289
331379bf 6290 count = SPECPDL_INDEX ();
6fc2811b 6291 specbind (Qinhibit_redisplay, Qt);
937e601e 6292 specbind (Qinhibit_quit, Qt);
7d0393cf 6293
937e601e 6294 if (!NILP (timer))
dc220243 6295 call1 (Qcancel_timer, timer);
ee78dc32 6296
937e601e 6297 if (FRAMEP (frame))
6fc2811b 6298 {
56f2de10 6299 delete_frame (frame, Qnil);
937e601e 6300 deleted = Qt;
6fc2811b 6301 }
1edf84e7 6302
937e601e
AI
6303 UNGCPRO;
6304 return unbind_to (count, deleted);
6fc2811b 6305}
6fc2811b
JR
6306\f
6307/***********************************************************************
6308 File selection dialog
6309 ***********************************************************************/
6fc2811b 6310
0fda9b75
DC
6311#define FILE_NAME_TEXT_FIELD edt1
6312#define FILE_NAME_COMBO_BOX cmb13
6313#define FILE_NAME_LIST lst1
6314
fffa137c 6315/* Callback for altering the behavior of the Open File dialog.
1030b26b
JR
6316 Makes the Filename text field contain "Current Directory" and be
6317 read-only when "Directories" is selected in the filter. This
6318 allows us to work around the fact that the standard Open File
6319 dialog does not support directories. */
c7b36b95 6320static UINT_PTR CALLBACK
b56ceb92 6321file_dialog_callback (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
1030b26b
JR
6322{
6323 if (msg == WM_NOTIFY)
6324 {
2d716d75
EZ
6325 OFNOTIFYW * notify_w = (OFNOTIFYW *)lParam;
6326 OFNOTIFYA * notify_a = (OFNOTIFYA *)lParam;
6327 int dropdown_changed;
6328 int dir_index;
0fda9b75 6329#ifdef NTGUI_UNICODE
eac30cd4 6330 const int use_unicode = 1;
0fda9b75 6331#else /* !NTGUI_UNICODE */
2d716d75 6332 int use_unicode = w32_unicode_filenames;
0fda9b75 6333#endif /* NTGUI_UNICODE */
2d716d75 6334
1030b26b 6335 /* Detect when the Filter dropdown is changed. */
2d716d75
EZ
6336 if (use_unicode)
6337 dropdown_changed =
6338 notify_w->hdr.code == CDN_TYPECHANGE
6339 || notify_w->hdr.code == CDN_INITDONE;
6340 else
6341 dropdown_changed =
6342 notify_a->hdr.code == CDN_TYPECHANGE
6343 || notify_a->hdr.code == CDN_INITDONE;
6344 if (dropdown_changed)
1030b26b
JR
6345 {
6346 HWND dialog = GetParent (hwnd);
6347 HWND edit_control = GetDlgItem (dialog, FILE_NAME_TEXT_FIELD);
7faeca66 6348 HWND list = GetDlgItem (dialog, FILE_NAME_LIST);
2d716d75 6349 int hdr_code;
1030b26b 6350
7faeca66
BK
6351 /* At least on Windows 7, the above attempt to get the window handle
6352 to the File Name Text Field fails. The following code does the
6353 job though. Note that this code is based on my examination of the
6354 window hierarchy using Microsoft Spy++. bk */
6355 if (edit_control == NULL)
6356 {
6357 HWND tmp = GetDlgItem (dialog, FILE_NAME_COMBO_BOX);
6358 if (tmp)
6359 {
6360 tmp = GetWindow (tmp, GW_CHILD);
6361 if (tmp)
6362 edit_control = GetWindow (tmp, GW_CHILD);
6363 }
6364 }
6365
6366 /* Directories is in index 2. */
2d716d75
EZ
6367 if (use_unicode)
6368 {
6369 dir_index = notify_w->lpOFN->nFilterIndex;
6370 hdr_code = notify_w->hdr.code;
6371 }
6372 else
6373 {
6374 dir_index = notify_a->lpOFN->nFilterIndex;
6375 hdr_code = notify_a->hdr.code;
6376 }
6377 if (dir_index == 2)
1030b26b 6378 {
2d716d75
EZ
6379 if (use_unicode)
6380 SendMessageW (dialog, CDM_SETCONTROLTEXT, FILE_NAME_TEXT_FIELD,
6381 (LPARAM)L"Current Directory");
6382 else
6383 SendMessageA (dialog, CDM_SETCONTROLTEXT, FILE_NAME_TEXT_FIELD,
6384 (LPARAM)"Current Directory");
1030b26b 6385 EnableWindow (edit_control, FALSE);
7faeca66
BK
6386 /* Note that at least on Windows 7, the above call to EnableWindow
6387 disables the window that would ordinarily have focus. If we
6388 do not set focus to some other window here, focus will land in
6389 no man's land and the user will be unable to tab through the
6390 dialog box (pressing tab will only result in a beep).
6391 Avoid that problem by setting focus to the list here. */
2d716d75 6392 if (hdr_code == CDN_INITDONE)
7faeca66 6393 SetFocus (list);
1030b26b
JR
6394 }
6395 else
6396 {
ef544dc8 6397 /* Don't override default filename on init done. */
2d716d75
EZ
6398 if (hdr_code == CDN_TYPECHANGE)
6399 {
6400 if (use_unicode)
6401 SendMessageW (dialog, CDM_SETCONTROLTEXT,
6402 FILE_NAME_TEXT_FIELD, (LPARAM)L"");
6403 else
6404 SendMessageA (dialog, CDM_SETCONTROLTEXT,
6405 FILE_NAME_TEXT_FIELD, (LPARAM)"");
6406 }
1030b26b
JR
6407 EnableWindow (edit_control, TRUE);
6408 }
6409 }
6410 }
6411 return 0;
6412}
6413
f9d64bb3 6414DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
74e1aeec 6415 doc: /* Read file name, prompting with PROMPT in directory DIR.
7c051dd8
GM
6416Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
6417selection box, if specified. If MUSTMATCH is non-nil, the returned file
6418or directory must exist.
6419
d7e642cc 6420This function is only defined on NS, MS Windows, and X Windows with the
7c051dd8
GM
6421Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
6422Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
5842a27b 6423 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
6fc2811b 6424{
0fda9b75 6425 /* Filter index: 1: All Files, 2: Directories only */
2d716d75
EZ
6426 static const wchar_t filter_w[] = L"All Files (*.*)\0*.*\0Directories\0*|*\0";
6427 static const char filter_a[] = "All Files (*.*)\0*.*\0Directories\0*|*\0";
0fda9b75
DC
6428
6429 Lisp_Object filename = default_filename;
6fc2811b 6430 struct frame *f = SELECTED_FRAME ();
0fda9b75
DC
6431 BOOL file_opened = FALSE;
6432 Lisp_Object orig_dir = dir;
6433 Lisp_Object orig_prompt = prompt;
6434
6435 /* If we compile with _WIN32_WINNT set to 0x0400 (for NT4
6436 compatibility) we end up with the old file dialogs. Define a big
6437 enough struct for the new dialog to trick GetOpenFileName into
6438 giving us the new dialogs on newer versions of Windows. */
6439 struct {
0fda9b75 6440 OPENFILENAMEW details;
0fda9b75
DC
6441#if _WIN32_WINNT < 0x500 /* < win2k */
6442 PVOID pvReserved;
6443 DWORD dwReserved;
6444 DWORD FlagsEx;
6445#endif /* < win2k */
2d716d75 6446 } new_file_details_w;
0fda9b75
DC
6447
6448#ifdef NTGUI_UNICODE
2d716d75
EZ
6449 wchar_t filename_buf_w[32*1024 + 1]; // NT kernel maximum
6450 OPENFILENAMEW * file_details_w = &new_file_details_w.details;
eac30cd4 6451 const int use_unicode = 1;
0fda9b75 6452#else /* not NTGUI_UNICODE */
2d716d75
EZ
6453 struct {
6454 OPENFILENAMEA details;
6455#if _WIN32_WINNT < 0x500 /* < win2k */
6456 PVOID pvReserved;
6457 DWORD dwReserved;
6458 DWORD FlagsEx;
6459#endif /* < win2k */
6460 } new_file_details_a;
6461 wchar_t filename_buf_w[MAX_PATH + 1], dir_w[MAX_PATH];
6462 char filename_buf_a[MAX_PATH + 1], dir_a[MAX_PATH];
6463 OPENFILENAMEW * file_details_w = &new_file_details_w.details;
6464 OPENFILENAMEA * file_details_a = &new_file_details_a.details;
6465 int use_unicode = w32_unicode_filenames;
6466 wchar_t *prompt_w;
6467 char *prompt_a;
6468 int len;
6469 char fname_ret[MAX_UTF8_PATH];
0fda9b75
DC
6470#endif /* NTGUI_UNICODE */
6471
f9d64bb3 6472 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
0fda9b75 6473 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, filename);
5ac45f98 6474
0fda9b75
DC
6475 {
6476 struct gcpro gcpro1, gcpro2;
6477 GCPRO2 (orig_dir, orig_prompt); /* There is no GCPRON, N>6. */
5ac45f98 6478
0fda9b75
DC
6479 /* Note: under NTGUI_UNICODE, we do _NOT_ use ENCODE_FILE: the
6480 system file encoding expected by the platform APIs (e.g. Cygwin's
303cc1d1
EZ
6481 POSIX implementation) may not be the same as the encoding expected
6482 by the Windows "ANSI" APIs! */
ee78dc32 6483
0fda9b75
DC
6484 CHECK_STRING (prompt);
6485 CHECK_STRING (dir);
ee78dc32 6486
0fda9b75 6487 dir = Fexpand_file_name (dir, Qnil);
7faeca66 6488
0fda9b75
DC
6489 if (STRINGP (filename))
6490 filename = Ffile_name_nondirectory (filename);
6491 else
6492 filename = empty_unibyte_string;
21517c3d 6493
0fda9b75 6494#ifdef CYGWIN
6e9f7997 6495 dir = Fcygwin_convert_file_name_to_windows (dir, Qt);
0fda9b75 6496 if (SCHARS (filename) > 0)
6e9f7997 6497 filename = Fcygwin_convert_file_name_to_windows (filename, Qnil);
0fda9b75 6498#endif
ee78dc32 6499
0fda9b75
DC
6500 CHECK_STRING (dir);
6501 CHECK_STRING (filename);
6502
6503 /* The code in file_dialog_callback that attempts to set the text
6504 of the file name edit window when handling the CDN_INITDONE
6505 WM_NOTIFY message does not work. Setting filename to "Current
6506 Directory" in the only_dir_p case here does work however. */
6507 if (SCHARS (filename) == 0 && ! NILP (only_dir_p))
6508 filename = build_string ("Current Directory");
6509
6510 /* Convert the values we've computed so far to system form. */
6511#ifdef NTGUI_UNICODE
6512 to_unicode (prompt, &prompt);
6513 to_unicode (dir, &dir);
6514 to_unicode (filename, &filename);
2d716d75
EZ
6515 if (SBYTES (filename) + 1 > sizeof (filename_buf_w))
6516 report_file_error ("filename too long", default_filename);
6517
6518 memcpy (filename_buf_w, SDATA (filename), SBYTES (filename) + 1);
0fda9b75
DC
6519#else /* !NTGUI_UNICODE */
6520 prompt = ENCODE_FILE (prompt);
6521 dir = ENCODE_FILE (dir);
6522 filename = ENCODE_FILE (filename);
6523
6524 /* We modify these in-place, so make copies for safety. */
6525 dir = Fcopy_sequence (dir);
6526 unixtodos_filename (SDATA (dir));
6527 filename = Fcopy_sequence (filename);
6528 unixtodos_filename (SDATA (filename));
2d716d75
EZ
6529 if (SBYTES (filename) >= MAX_UTF8_PATH)
6530 report_file_error ("filename too long", default_filename);
6531 if (w32_unicode_filenames)
6532 {
6533 filename_to_utf16 (SSDATA (dir), dir_w);
6534 if (filename_to_utf16 (SSDATA (filename), filename_buf_w) != 0)
6535 {
6536 /* filename_to_utf16 sets errno to ENOENT when the file
6537 name is too long or cannot be converted to UTF-16. */
6538 if (errno == ENOENT && filename_buf_w[MAX_PATH - 1] != 0)
6539 report_file_error ("filename too long", default_filename);
6540 }
829f4f22
EZ
6541 len = pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS,
6542 SSDATA (prompt), -1, NULL, 0);
ff0c63f2
EZ
6543 if (len > 32768)
6544 len = 32768;
2d716d75 6545 prompt_w = alloca (len * sizeof (wchar_t));
829f4f22
EZ
6546 pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS,
6547 SSDATA (prompt), -1, prompt_w, len);
2d716d75
EZ
6548 }
6549 else
6550 {
6551 filename_to_ansi (SSDATA (dir), dir_a);
6552 if (filename_to_ansi (SSDATA (filename), filename_buf_a) != '\0')
6553 {
6554 /* filename_to_ansi sets errno to ENOENT when the file
6555 name is too long or cannot be converted to UTF-16. */
6556 if (errno == ENOENT && filename_buf_a[MAX_PATH - 1] != 0)
6557 report_file_error ("filename too long", default_filename);
6558 }
829f4f22
EZ
6559 len = pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS,
6560 SSDATA (prompt), -1, NULL, 0);
ff0c63f2
EZ
6561 if (len > 32768)
6562 len = 32768;
2d716d75 6563 prompt_w = alloca (len * sizeof (wchar_t));
829f4f22
EZ
6564 pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS,
6565 SSDATA (prompt), -1, prompt_w, len);
6566 len = pWideCharToMultiByte (CP_ACP, 0, prompt_w, -1, NULL, 0, NULL, NULL);
ff0c63f2
EZ
6567 if (len > 32768)
6568 len = 32768;
2d716d75 6569 prompt_a = alloca (len);
829f4f22 6570 pWideCharToMultiByte (CP_ACP, 0, prompt_w, -1, prompt_a, len, NULL, NULL);
2d716d75 6571 }
0fda9b75
DC
6572#endif /* NTGUI_UNICODE */
6573
501199a3
DC
6574 /* Fill in the structure for the call to GetOpenFileName below.
6575 For NTGUI_UNICODE builds (which run only on NT), we just use
6576 the actual size of the structure. For non-NTGUI_UNICODE
6577 builds, we tell the OS we're using an old version of the
6578 structure if the OS isn't new enough to support the newer
6579 version. */
2d716d75
EZ
6580 if (use_unicode)
6581 {
6582 memset (&new_file_details_w, 0, sizeof (new_file_details_w));
6583 if (w32_major_version > 4 && w32_major_version < 95)
6584 file_details_w->lStructSize = sizeof (new_file_details_w);
6585 else
6586 file_details_w->lStructSize = sizeof (*file_details_w);
6587 /* Set up the inout parameter for the selected file name. */
6588 file_details_w->lpstrFile = filename_buf_w;
6589 file_details_w->nMaxFile =
6590 sizeof (filename_buf_w) / sizeof (*filename_buf_w);
6591 file_details_w->hwndOwner = FRAME_W32_WINDOW (f);
6592 /* Undocumented Bug in Common File Dialog:
6593 If a filter is not specified, shell links are not resolved. */
6594 file_details_w->lpstrFilter = filter_w;
6595#ifdef NTGUI_UNICODE
6596 file_details_w->lpstrInitialDir = (wchar_t*) SDATA (dir);
a5c9bbb3 6597 file_details_w->lpstrTitle = (guichar_t*) SDATA (prompt);
2d716d75
EZ
6598#else
6599 file_details_w->lpstrInitialDir = dir_w;
6600 file_details_w->lpstrTitle = prompt_w;
6601#endif
6602 file_details_w->nFilterIndex = NILP (only_dir_p) ? 1 : 2;
6603 file_details_w->Flags = (OFN_HIDEREADONLY | OFN_NOCHANGEDIR
6604 | OFN_EXPLORER | OFN_ENABLEHOOK);
6605 if (!NILP (mustmatch))
6606 {
6607 /* Require that the path to the parent directory exists. */
6608 file_details_w->Flags |= OFN_PATHMUSTEXIST;
6609 /* If we are looking for a file, require that it exists. */
6610 if (NILP (only_dir_p))
6611 file_details_w->Flags |= OFN_FILEMUSTEXIST;
6612 }
6613 }
a5c9bbb3 6614#ifndef NTGUI_UNICODE
7f2b4738 6615 else
7f2b4738 6616 {
2d716d75
EZ
6617 memset (&new_file_details_a, 0, sizeof (new_file_details_a));
6618 if (w32_major_version > 4 && w32_major_version < 95)
6619 file_details_a->lStructSize = sizeof (new_file_details_a);
6620 else
6621 file_details_a->lStructSize = sizeof (*file_details_a);
6622 file_details_a->lpstrFile = filename_buf_a;
6623 file_details_a->nMaxFile =
6624 sizeof (filename_buf_a) / sizeof (*filename_buf_a);
6625 file_details_a->hwndOwner = FRAME_W32_WINDOW (f);
6626 file_details_a->lpstrFilter = filter_a;
6627 file_details_a->lpstrInitialDir = dir_a;
6628 file_details_a->lpstrTitle = prompt_a;
6629 file_details_a->nFilterIndex = NILP (only_dir_p) ? 1 : 2;
6630 file_details_a->Flags = (OFN_HIDEREADONLY | OFN_NOCHANGEDIR
6631 | OFN_EXPLORER | OFN_ENABLEHOOK);
6632 if (!NILP (mustmatch))
6633 {
6634 /* Require that the path to the parent directory exists. */
6635 file_details_a->Flags |= OFN_PATHMUSTEXIST;
6636 /* If we are looking for a file, require that it exists. */
6637 if (NILP (only_dir_p))
6638 file_details_a->Flags |= OFN_FILEMUSTEXIST;
6639 }
7f2b4738 6640 }
a5c9bbb3 6641#endif /* !NTGUI_UNICODE */
1030b26b 6642
0fda9b75
DC
6643 {
6644 int count = SPECPDL_INDEX ();
303cc1d1 6645 /* Prevent redisplay. */
0fda9b75 6646 specbind (Qinhibit_redisplay, Qt);
36a305a7 6647 block_input ();
2d716d75
EZ
6648 if (use_unicode)
6649 {
6650 file_details_w->lpfnHook = file_dialog_callback;
6651
6652 file_opened = GetOpenFileNameW (file_details_w);
6653 }
8b55eeeb 6654#ifndef NTGUI_UNICODE
2d716d75
EZ
6655 else
6656 {
6657 file_details_a->lpfnHook = file_dialog_callback;
1030b26b 6658
2d716d75
EZ
6659 file_opened = GetOpenFileNameA (file_details_a);
6660 }
8b55eeeb 6661#endif /* !NTGUI_UNICODE */
36a305a7 6662 unblock_input ();
0fda9b75
DC
6663 unbind_to (count, Qnil);
6664 }
ba6f3859
JR
6665
6666 if (file_opened)
1030b26b 6667 {
0fda9b75
DC
6668 /* Get an Emacs string from the value Windows gave us. */
6669#ifdef NTGUI_UNICODE
2d716d75 6670 filename = from_unicode_buffer (filename_buf_w);
0fda9b75 6671#else /* !NTGUI_UNICODE */
2d716d75
EZ
6672 if (use_unicode)
6673 filename_from_utf16 (filename_buf_w, fname_ret);
6674 else
6675 filename_from_ansi (filename_buf_a, fname_ret);
6676 dostounix_filename (fname_ret);
6677 filename = DECODE_FILE (build_unibyte_string (fname_ret));
0fda9b75
DC
6678#endif /* NTGUI_UNICODE */
6679
6680#ifdef CYGWIN
6e9f7997 6681 filename = Fcygwin_convert_file_name_from_windows (filename, Qt);
0fda9b75
DC
6682#endif /* CYGWIN */
6683
6684 /* Strip the dummy filename off the end of the string if we
6685 added it to select a directory. */
119f64db 6686 if ((use_unicode && file_details_w->nFilterIndex == 2)
893fcd38 6687#ifndef NTGUI_UNICODE
119f64db 6688 || (!use_unicode && file_details_a->nFilterIndex == 2)
893fcd38
EZ
6689#endif
6690 )
2d716d75 6691 filename = Ffile_name_directory (filename);
1030b26b 6692 }
c80e3b4a 6693 /* User canceled the dialog without making a selection. */
1030b26b 6694 else if (!CommDlgExtendedError ())
0fda9b75 6695 filename = Qnil;
1030b26b
JR
6696 /* An error occurred, fallback on reading from the mini-buffer. */
6697 else
0fda9b75
DC
6698 filename = Fcompleting_read (
6699 orig_prompt,
6700 intern ("read-file-name-internal"),
6701 orig_dir,
6702 mustmatch,
6703 orig_dir,
6704 Qfile_name_history,
6705 default_filename,
6706 Qnil);
1030b26b 6707
0fda9b75 6708 UNGCPRO;
1030b26b 6709 }
ee78dc32 6710
6fc2811b 6711 /* Make "Cancel" equivalent to C-g. */
0fda9b75 6712 if (NILP (filename))
6fc2811b 6713 Fsignal (Qquit, Qnil);
ee78dc32 6714
0fda9b75 6715 RETURN_UNGCPRO (filename);
6fc2811b 6716}
ee78dc32 6717
0fda9b75
DC
6718\f
6719#ifdef WINDOWSNT
6cf29fe8
JR
6720/* Moving files to the system recycle bin.
6721 Used by `move-file-to-trash' instead of the default moving to ~/.Trash */
6722DEFUN ("system-move-file-to-trash", Fsystem_move_file_to_trash,
6723 Ssystem_move_file_to_trash, 1, 1, 0,
6724 doc: /* Move file or directory named FILENAME to the recycle bin. */)
5842a27b 6725 (Lisp_Object filename)
6cf29fe8
JR
6726{
6727 Lisp_Object handler;
6728 Lisp_Object encoded_file;
6729 Lisp_Object operation;
6730
6731 operation = Qdelete_file;
6732 if (!NILP (Ffile_directory_p (filename))
6733 && NILP (Ffile_symlink_p (filename)))
6734 {
e9a0aef8 6735 operation = intern ("delete-directory");
6cf29fe8
JR
6736 filename = Fdirectory_file_name (filename);
6737 }
2c47be65
EZ
6738
6739 /* Must have fully qualified file names for moving files to Recycle
6740 Bin. */
6cf29fe8
JR
6741 filename = Fexpand_file_name (filename, Qnil);
6742
6743 handler = Ffind_file_name_handler (filename, operation);
6744 if (!NILP (handler))
6745 return call2 (handler, operation, filename);
2c47be65
EZ
6746 else
6747 {
6748 const char * path;
6749 int result;
6cf29fe8 6750
2c47be65 6751 encoded_file = ENCODE_FILE (filename);
6cf29fe8 6752
2c47be65 6753 path = map_w32_filename (SDATA (encoded_file), NULL);
6cf29fe8 6754
2c47be65
EZ
6755 /* The Unicode version of SHFileOperation is not supported on
6756 Windows 9X. */
6757 if (w32_unicode_filenames && os_subtype != OS_9X)
6758 {
6759 SHFILEOPSTRUCTW file_op_w;
6760 /* We need one more element beyond MAX_PATH because this is
6761 a list of file names, with the last element double-null
6762 terminated. */
6763 wchar_t tmp_path_w[MAX_PATH + 1];
6764
6765 memset (tmp_path_w, 0, sizeof (tmp_path_w));
6766 filename_to_utf16 (path, tmp_path_w);
6767
6768 /* On Windows, write permission is required to delete/move files. */
6769 _wchmod (tmp_path_w, 0666);
6770
6771 memset (&file_op_w, 0, sizeof (file_op_w));
6772 file_op_w.hwnd = HWND_DESKTOP;
6773 file_op_w.wFunc = FO_DELETE;
6774 file_op_w.pFrom = tmp_path_w;
6775 file_op_w.fFlags = FOF_SILENT | FOF_NOCONFIRMATION | FOF_ALLOWUNDO
6776 | FOF_NOERRORUI | FOF_NO_CONNECTED_ELEMENTS;
6777 file_op_w.fAnyOperationsAborted = FALSE;
6778
6779 result = SHFileOperationW (&file_op_w);
6780 }
6781 else
6782 {
6783 SHFILEOPSTRUCTA file_op_a;
6784 char tmp_path_a[MAX_PATH + 1];
6cf29fe8 6785
2c47be65
EZ
6786 memset (tmp_path_a, 0, sizeof (tmp_path_a));
6787 filename_to_ansi (path, tmp_path_a);
6cf29fe8 6788
2c47be65
EZ
6789 /* If a file cannot be represented in ANSI codepage, don't
6790 let them inadvertently delete other files because some
6791 characters are interpreted as a wildcards. */
6792 if (_mbspbrk (tmp_path_a, "?*"))
6793 result = ERROR_FILE_NOT_FOUND;
6794 else
6795 {
6796 _chmod (tmp_path_a, 0666);
6cf29fe8 6797
2c47be65
EZ
6798 memset (&file_op_a, 0, sizeof (file_op_a));
6799 file_op_a.hwnd = HWND_DESKTOP;
6800 file_op_a.wFunc = FO_DELETE;
6801 file_op_a.pFrom = tmp_path_a;
6802 file_op_a.fFlags = FOF_SILENT | FOF_NOCONFIRMATION | FOF_ALLOWUNDO
6803 | FOF_NOERRORUI | FOF_NO_CONNECTED_ELEMENTS;
6804 file_op_a.fAnyOperationsAborted = FALSE;
6cf29fe8 6805
2c47be65
EZ
6806 result = SHFileOperationA (&file_op_a);
6807 }
6808 }
6809 if (result != 0)
6810 report_file_error ("Removing old name", list1 (filename));
6811 }
6cf29fe8
JR
6812 return Qnil;
6813}
6814
0fda9b75
DC
6815#endif /* WINDOWSNT */
6816
6fc2811b 6817\f
6fc2811b
JR
6818/***********************************************************************
6819 w32 specialized functions
6820 ***********************************************************************/
ee78dc32 6821
74e1aeec
JR
6822DEFUN ("w32-send-sys-command", Fw32_send_sys_command,
6823 Sw32_send_sys_command, 1, 2, 0,
6824 doc: /* Send frame a Windows WM_SYSCOMMAND message of type COMMAND.
52deb19f 6825Some useful values for COMMAND are #xf030 to maximize frame (#xf020
d84b082d
JR
6826to minimize), #xf120 to restore frame to original size, and #xf100
6827to activate the menubar for keyboard access. #xf140 activates the
74e1aeec
JR
6828screen saver if defined.
6829
6830If optional parameter FRAME is not specified, use selected frame. */)
5842a27b 6831 (Lisp_Object command, Lisp_Object frame)
1edf84e7 6832{
a10c8269 6833 struct frame *f = decode_window_system_frame (frame);
1edf84e7 6834
b7826503 6835 CHECK_NUMBER (command);
1edf84e7 6836
ce6059da 6837 PostMessage (FRAME_W32_WINDOW (f), WM_SYSCOMMAND, XINT (command), 0);
1edf84e7
GV
6838
6839 return Qnil;
6840}
6841
55dcfc15 6842DEFUN ("w32-shell-execute", Fw32_shell_execute, Sw32_shell_execute, 2, 4, 0,
74e1aeec
JR
6843 doc: /* Get Windows to perform OPERATION on DOCUMENT.
6844This is a wrapper around the ShellExecute system function, which
6845invokes the application registered to handle OPERATION for DOCUMENT.
74e1aeec 6846
1dccd454
EZ
6847OPERATION is either nil or a string that names a supported operation.
6848What operations can be used depends on the particular DOCUMENT and its
6849handler application, but typically it is one of the following common
6850operations:
6851
6852 \"open\" - open DOCUMENT, which could be a file, a directory, or an
6d48053b
EZ
6853 executable program (application). If it is an application,
6854 that application is launched in the current buffer's default
1dccd454
EZ
6855 directory. Otherwise, the application associated with
6856 DOCUMENT is launched in the buffer's default directory.
6d48053b
EZ
6857 \"opennew\" - like \"open\", but instruct the application to open
6858 DOCUMENT in a new window.
6859 \"openas\" - open the \"Open With\" dialog for DOCUMENT.
6860 \"print\" - print DOCUMENT, which must be a file.
6861 \"printto\" - print DOCUMENT, which must be a file, to a specified printer.
6862 The printer should be provided in PARAMETERS, see below.
6863 \"explore\" - start the Windows Explorer on DOCUMENT.
1dccd454
EZ
6864 \"edit\" - launch an editor and open DOCUMENT for editing; which
6865 editor is launched depends on the association for the
6d48053b
EZ
6866 specified DOCUMENT.
6867 \"find\" - initiate search starting from DOCUMENT, which must specify
6868 a directory.
ec6e26b8
EZ
6869 \"runas\" - run DOCUMENT, which must be an excutable file, with
6870 elevated privileges (a.k.a. \"as Administrator\").
6d48053b
EZ
6871 \"properties\"
6872 - open the the property sheet dialog for DOCUMENT; works
6873 for *.lnk desktop shortcuts, and little or nothing else.
1dccd454 6874 nil - invoke the default OPERATION, or \"open\" if default is
6d48053b 6875 not defined or unavailable.
1dccd454
EZ
6876
6877DOCUMENT is typically the name of a document file or a URL, but can
6d48053b 6878also be an executable program to run, or a directory to open in the
9ab3ce4d
EZ
6879Windows Explorer. If it is a file, it must be a local one; this
6880function does not support remote file names.
1dccd454 6881
6d48053b 6882If DOCUMENT is an executable program, the optional third arg PARAMETERS
02b39a28 6883can be a string containing command line parameters that will be passed
6d48053b
EZ
6884to the program. Some values of OPERATION also require parameters (e.g.,
6885\"printto\" requires the printer address). Otherwise, PARAMETERS should
6886be nil or unspecified.
1dccd454 6887
02b39a28 6888Optional fourth argument SHOW-FLAG can be used to control how the
1dccd454 6889application will be displayed when it is invoked. If SHOW-FLAG is nil
6d48053b
EZ
6890or unspecified, the application is displayed as if SHOW-FLAG of 10 was
6891specified, otherwise it is an integer between 0 and 11 representing
6892a ShowWindow flag:
74e1aeec
JR
6893
6894 0 - start hidden
6d48053b
EZ
6895 1 - start as normal-size window
6896 3 - start in a maximized window
6897 6 - start in a minimized window
6898 10 - start as the application itself specifies; this is the default. */)
5842a27b 6899 (Lisp_Object operation, Lisp_Object document, Lisp_Object parameters, Lisp_Object show_flag)
55dcfc15 6900{
5cba3209 6901 char *errstr;
ff0c63f2
EZ
6902 Lisp_Object current_dir = BVAR (current_buffer, directory);;
6903 wchar_t *doc_w = NULL, *params_w = NULL, *ops_w = NULL;
a5c9bbb3 6904 intptr_t result;
ff0c63f2
EZ
6905#ifndef CYGWIN
6906 int use_unicode = w32_unicode_filenames;
6907 char *doc_a = NULL, *params_a = NULL, *ops_a = NULL;
cb13e9a8
EZ
6908 Lisp_Object absdoc, handler;
6909 struct gcpro gcpro1;
ff0c63f2 6910#endif
55dcfc15 6911
b7826503 6912 CHECK_STRING (document);
55dcfc15 6913
819e2da9
DC
6914#ifdef CYGWIN
6915 current_dir = Fcygwin_convert_file_name_to_windows (current_dir, Qt);
ec6e26b8 6916 document = Fcygwin_convert_file_name_to_windows (document, Qt);
819e2da9 6917
ff0c63f2 6918 /* Encode filename, current directory and parameters. */
819e2da9 6919 current_dir = GUI_ENCODE_FILE (current_dir);
ec6e26b8
EZ
6920 document = GUI_ENCODE_FILE (document);
6921 doc_w = GUI_SDATA (document);
3bc143eb 6922 if (STRINGP (parameters))
ff0c63f2
EZ
6923 {
6924 parameters = GUI_ENCODE_SYSTEM (parameters);
6925 params_w = GUI_SDATA (parameters);
6926 }
6927 if (STRINGP (operation))
6928 {
6929 operation = GUI_ENCODE_SYSTEM (operation);
6930 ops_w = GUI_SDATA (operation);
6931 }
a5c9bbb3
EZ
6932 result = (intptr_t) ShellExecuteW (NULL, ops_w, doc_w, params_w,
6933 GUI_SDATA (current_dir),
6934 (INTEGERP (show_flag)
6935 ? XINT (show_flag) : SW_SHOWDEFAULT));
ff0c63f2 6936#else /* !CYGWIN */
ec6e26b8 6937 current_dir = ENCODE_FILE (current_dir);
9ab3ce4d 6938 /* We have a situation here. If DOCUMENT is a relative file name,
8101203a
EZ
6939 but its name includes leading directories, i.e. it lives not in
6940 CURRENT_DIR, but in its subdirectory, then ShellExecute below
6941 will fail to find it. So we need to make the file name is
6942 absolute. But DOCUMENT does not have to be a file, it can be a
6943 URL, for example. So we make it absolute only if it is an
6944 existing file; if it is a file that does not exist, tough. */
cb13e9a8 6945 GCPRO1 (absdoc);
9ab3ce4d 6946 absdoc = Fexpand_file_name (document, Qnil);
cb13e9a8
EZ
6947 /* Don't call file handlers for file-exists-p, since they might
6948 attempt to access the file, which could fail or produce undesired
6949 consequences, see bug#16558 for an example. */
6950 handler = Ffind_file_name_handler (absdoc, Qfile_exists_p);
6951 if (NILP (handler))
6952 {
6953 Lisp_Object absdoc_encoded = ENCODE_FILE (absdoc);
6954
6955 if (faccessat (AT_FDCWD, SSDATA (absdoc_encoded), F_OK, AT_EACCESS) == 0)
6956 document = absdoc_encoded;
6957 else
6958 document = ENCODE_FILE (document);
6959 }
6960 else
6961 document = ENCODE_FILE (document);
6962 UNGCPRO;
ff0c63f2
EZ
6963 if (use_unicode)
6964 {
6965 wchar_t document_w[MAX_PATH], current_dir_w[MAX_PATH];
6966
6967 /* Encode filename, current directory and parameters, and
6968 convert operation to UTF-16. */
ff0c63f2 6969 filename_to_utf16 (SSDATA (current_dir), current_dir_w);
ec6e26b8
EZ
6970 filename_to_utf16 (SSDATA (document), document_w);
6971 doc_w = document_w;
ff0c63f2
EZ
6972 if (STRINGP (parameters))
6973 {
9f9974b4
EZ
6974 int len;
6975
6976 parameters = ENCODE_SYSTEM (parameters);
829f4f22
EZ
6977 len = pMultiByteToWideChar (CP_ACP, MB_ERR_INVALID_CHARS,
6978 SSDATA (parameters), -1, NULL, 0);
ff0c63f2
EZ
6979 if (len > 32768)
6980 len = 32768;
6981 params_w = alloca (len * sizeof (wchar_t));
829f4f22
EZ
6982 pMultiByteToWideChar (CP_ACP, MB_ERR_INVALID_CHARS,
6983 SSDATA (parameters), -1, params_w, len);
ff0c63f2
EZ
6984 }
6985 if (STRINGP (operation))
6986 {
6987 /* Assume OPERATION is pure ASCII. */
6988 const char *s = SSDATA (operation);
6989 wchar_t *d;
9f9974b4 6990 int len = SBYTES (operation) + 1;
ff0c63f2
EZ
6991
6992 if (len > 32768)
6993 len = 32768;
6994 d = ops_w = alloca (len * sizeof (wchar_t));
6995 while (d < ops_w + len - 1)
6996 *d++ = *s++;
6997 *d = 0;
6998 }
a5c9bbb3
EZ
6999 result = (intptr_t) ShellExecuteW (NULL, ops_w, doc_w, params_w,
7000 current_dir_w,
7001 (INTEGERP (show_flag)
7002 ? XINT (show_flag) : SW_SHOWDEFAULT));
ff0c63f2
EZ
7003 }
7004 else
7005 {
7006 char document_a[MAX_PATH], current_dir_a[MAX_PATH];
7007
ff0c63f2 7008 filename_to_ansi (SSDATA (current_dir), current_dir_a);
ec6e26b8
EZ
7009 filename_to_ansi (SSDATA (document), document_a);
7010 doc_a = document_a;
ff0c63f2
EZ
7011 if (STRINGP (parameters))
7012 {
9f9974b4
EZ
7013 parameters = ENCODE_SYSTEM (parameters);
7014 params_a = SSDATA (parameters);
ff0c63f2
EZ
7015 }
7016 if (STRINGP (operation))
7017 {
7018 /* Assume OPERATION is pure ASCII. */
7019 ops_a = SSDATA (operation);
7020 }
a5c9bbb3
EZ
7021 result = (intptr_t) ShellExecuteA (NULL, ops_a, doc_a, params_a,
7022 current_dir_a,
7023 (INTEGERP (show_flag)
7024 ? XINT (show_flag) : SW_SHOWDEFAULT));
ff0c63f2
EZ
7025 }
7026#endif /* !CYGWIN */
7027
7028 if (result > 32)
55dcfc15 7029 return Qt;
ff0c63f2
EZ
7030
7031 switch (result)
7032 {
7033 case SE_ERR_ACCESSDENIED:
7034 errstr = w32_strerror (ERROR_ACCESS_DENIED);
7035 break;
7036 case SE_ERR_ASSOCINCOMPLETE:
7037 case SE_ERR_NOASSOC:
7038 errstr = w32_strerror (ERROR_NO_ASSOCIATION);
7039 break;
7040 case SE_ERR_DDEBUSY:
7041 case SE_ERR_DDEFAIL:
7042 errstr = w32_strerror (ERROR_DDE_FAIL);
7043 break;
7044 case SE_ERR_DDETIMEOUT:
7045 errstr = w32_strerror (ERROR_TIMEOUT);
7046 break;
7047 case SE_ERR_DLLNOTFOUND:
7048 errstr = w32_strerror (ERROR_DLL_NOT_FOUND);
7049 break;
7050 case SE_ERR_FNF:
7051 errstr = w32_strerror (ERROR_FILE_NOT_FOUND);
7052 break;
7053 case SE_ERR_OOM:
7054 errstr = w32_strerror (ERROR_NOT_ENOUGH_MEMORY);
7055 break;
7056 case SE_ERR_PNF:
7057 errstr = w32_strerror (ERROR_PATH_NOT_FOUND);
7058 break;
7059 case SE_ERR_SHARE:
7060 errstr = w32_strerror (ERROR_SHARING_VIOLATION);
7061 break;
7062 default:
7063 errstr = w32_strerror (0);
7064 break;
7065 }
5cba3209
EZ
7066 /* The error string might be encoded in the locale's encoding. */
7067 if (!NILP (Vlocale_coding_system))
7068 {
7069 Lisp_Object decoded =
d7ea76b4 7070 code_convert_string_norecord (build_unibyte_string (errstr),
5cba3209 7071 Vlocale_coding_system, 0);
51b59d79 7072 errstr = SSDATA (decoded);
5cba3209
EZ
7073 }
7074 error ("ShellExecute failed: %s", errstr);
55dcfc15
AI
7075}
7076
ccc2d29c
GV
7077/* Lookup virtual keycode from string representing the name of a
7078 non-ascii keystroke into the corresponding virtual key, using
7079 lispy_function_keys. */
7080static int
7081lookup_vk_code (char *key)
7082{
7083 int i;
7084
7085 for (i = 0; i < 256; i++)
bf254037 7086 if (lispy_function_keys[i]
ccc2d29c
GV
7087 && strcmp (lispy_function_keys[i], key) == 0)
7088 return i;
7089
7090 return -1;
7091}
7092
7093/* Convert a one-element vector style key sequence to a hot key
7094 definition. */
2ba49441 7095static Lisp_Object
b56ceb92 7096w32_parse_hot_key (Lisp_Object key)
ccc2d29c
GV
7097{
7098 /* Copied from Fdefine_key and store_in_keymap. */
7099 register Lisp_Object c;
7100 int vk_code;
7101 int lisp_modifiers;
7102 int w32_modifiers;
7103 struct gcpro gcpro1;
7104
b7826503 7105 CHECK_VECTOR (key);
ccc2d29c 7106
9a9d91d9 7107 if (ASIZE (key) != 1)
ccc2d29c
GV
7108 return Qnil;
7109
7110 GCPRO1 (key);
7111
9a9d91d9 7112 c = AREF (key, 0);
ccc2d29c
GV
7113
7114 if (CONSP (c) && lucid_event_type_list_p (c))
7115 c = Fevent_convert_list (c);
7116
7117 UNGCPRO;
7118
7119 if (! INTEGERP (c) && ! SYMBOLP (c))
7120 error ("Key definition is invalid");
7121
7122 /* Work out the base key and the modifiers. */
7123 if (SYMBOLP (c))
7124 {
7125 c = parse_modifiers (c);
2ba49441 7126 lisp_modifiers = XINT (Fcar (Fcdr (c)));
ccc2d29c
GV
7127 c = Fcar (c);
7128 if (!SYMBOLP (c))
1088b922 7129 emacs_abort ();
d5db4077 7130 vk_code = lookup_vk_code (SDATA (SYMBOL_NAME (c)));
ccc2d29c
GV
7131 }
7132 else if (INTEGERP (c))
7133 {
7134 lisp_modifiers = XINT (c) & ~CHARACTERBITS;
7135 /* Many ascii characters are their own virtual key code. */
7136 vk_code = XINT (c) & CHARACTERBITS;
7137 }
7138
7139 if (vk_code < 0 || vk_code > 255)
7140 return Qnil;
7141
7142 if ((lisp_modifiers & meta_modifier) != 0
7143 && !NILP (Vw32_alt_is_meta))
7144 lisp_modifiers |= alt_modifier;
7145
71eab8d1
AI
7146 /* Supply defs missing from mingw32. */
7147#ifndef MOD_ALT
7148#define MOD_ALT 0x0001
7149#define MOD_CONTROL 0x0002
7150#define MOD_SHIFT 0x0004
7151#define MOD_WIN 0x0008
7152#endif
7153
ccc2d29c
GV
7154 /* Convert lisp modifiers to Windows hot-key form. */
7155 w32_modifiers = (lisp_modifiers & hyper_modifier) ? MOD_WIN : 0;
7156 w32_modifiers |= (lisp_modifiers & alt_modifier) ? MOD_ALT : 0;
7157 w32_modifiers |= (lisp_modifiers & ctrl_modifier) ? MOD_CONTROL : 0;
7158 w32_modifiers |= (lisp_modifiers & shift_modifier) ? MOD_SHIFT : 0;
7159
7160 return HOTKEY (vk_code, w32_modifiers);
7161}
7162
74e1aeec
JR
7163DEFUN ("w32-register-hot-key", Fw32_register_hot_key,
7164 Sw32_register_hot_key, 1, 1, 0,
7165 doc: /* Register KEY as a hot-key combination.
7166Certain key combinations like Alt-Tab are reserved for system use on
7167Windows, and therefore are normally intercepted by the system. However,
7168most of these key combinations can be received by registering them as
7169hot-keys, overriding their special meaning.
7170
7171KEY must be a one element key definition in vector form that would be
7172acceptable to `define-key' (e.g. [A-tab] for Alt-Tab). The meta
7173modifier is interpreted as Alt if `w32-alt-is-meta' is t, and hyper
7174is always interpreted as the Windows modifier keys.
7175
7176The return value is the hotkey-id if registered, otherwise nil. */)
5842a27b 7177 (Lisp_Object key)
ccc2d29c
GV
7178{
7179 key = w32_parse_hot_key (key);
7180
fb053a1f 7181 if (!NILP (key) && NILP (Fmemq (key, w32_grabbed_keys)))
ccc2d29c
GV
7182 {
7183 /* Reuse an empty slot if possible. */
7184 Lisp_Object item = Fmemq (Qnil, w32_grabbed_keys);
7185
7186 /* Safe to add new key to list, even if we have focus. */
7187 if (NILP (item))
7188 w32_grabbed_keys = Fcons (key, w32_grabbed_keys);
7189 else
f3fbd155 7190 XSETCAR (item, key);
ccc2d29c
GV
7191
7192 /* Notify input thread about new hot-key definition, so that it
7193 takes effect without needing to switch focus. */
2ba49441 7194 PostThreadMessage (dwWindowsThreadId, WM_EMACS_REGISTER_HOT_KEY,
646b5f55 7195 (WPARAM) XLI (key), 0);
ccc2d29c
GV
7196 }
7197
7198 return key;
7199}
7200
74e1aeec
JR
7201DEFUN ("w32-unregister-hot-key", Fw32_unregister_hot_key,
7202 Sw32_unregister_hot_key, 1, 1, 0,
52deb19f 7203 doc: /* Unregister KEY as a hot-key combination. */)
5842a27b 7204 (Lisp_Object key)
ccc2d29c
GV
7205{
7206 Lisp_Object item;
7207
7208 if (!INTEGERP (key))
7209 key = w32_parse_hot_key (key);
7210
7211 item = Fmemq (key, w32_grabbed_keys);
7212
7213 if (!NILP (item))
7214 {
7215 /* Notify input thread about hot-key definition being removed, so
7216 that it takes effect without needing focus switch. */
7217 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_UNREGISTER_HOT_KEY,
646b5f55 7218 (WPARAM) XINT (XCAR (item)), (LPARAM) XLI (item)))
ccc2d29c
GV
7219 {
7220 MSG msg;
7221 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
7222 }
7223 return Qt;
7224 }
7225 return Qnil;
7226}
7227
74e1aeec
JR
7228DEFUN ("w32-registered-hot-keys", Fw32_registered_hot_keys,
7229 Sw32_registered_hot_keys, 0, 0, 0,
7230 doc: /* Return list of registered hot-key IDs. */)
5842a27b 7231 (void)
ccc2d29c 7232{
74084731 7233 return Fdelq (Qnil, Fcopy_sequence (w32_grabbed_keys));
ccc2d29c
GV
7234}
7235
74e1aeec
JR
7236DEFUN ("w32-reconstruct-hot-key", Fw32_reconstruct_hot_key,
7237 Sw32_reconstruct_hot_key, 1, 1, 0,
52deb19f
JB
7238 doc: /* Convert hot-key ID to a lisp key combination.
7239usage: (w32-reconstruct-hot-key ID) */)
5842a27b 7240 (Lisp_Object hotkeyid)
ccc2d29c
GV
7241{
7242 int vk_code, w32_modifiers;
7243 Lisp_Object key;
7244
b7826503 7245 CHECK_NUMBER (hotkeyid);
ccc2d29c
GV
7246
7247 vk_code = HOTKEY_VK_CODE (hotkeyid);
7248 w32_modifiers = HOTKEY_MODIFIERS (hotkeyid);
7249
bf254037 7250 if (vk_code < 256 && lispy_function_keys[vk_code])
ccc2d29c
GV
7251 key = intern (lispy_function_keys[vk_code]);
7252 else
7253 key = make_number (vk_code);
7254
7255 key = Fcons (key, Qnil);
7256 if (w32_modifiers & MOD_SHIFT)
3ef68e6b 7257 key = Fcons (Qshift, key);
ccc2d29c 7258 if (w32_modifiers & MOD_CONTROL)
3ef68e6b 7259 key = Fcons (Qctrl, key);
ccc2d29c 7260 if (w32_modifiers & MOD_ALT)
3ef68e6b 7261 key = Fcons (NILP (Vw32_alt_is_meta) ? Qalt : Qmeta, key);
ccc2d29c 7262 if (w32_modifiers & MOD_WIN)
3ef68e6b 7263 key = Fcons (Qhyper, key);
ccc2d29c
GV
7264
7265 return key;
7266}
adcc3809 7267
74e1aeec
JR
7268DEFUN ("w32-toggle-lock-key", Fw32_toggle_lock_key,
7269 Sw32_toggle_lock_key, 1, 2, 0,
7270 doc: /* Toggle the state of the lock key KEY.
7271KEY can be `capslock', `kp-numlock', or `scroll'.
7272If the optional parameter NEW-STATE is a number, then the state of KEY
7273is set to off if the low bit of NEW-STATE is zero, otherwise on. */)
5842a27b 7274 (Lisp_Object key, Lisp_Object new_state)
adcc3809
GV
7275{
7276 int vk_code;
adcc3809
GV
7277
7278 if (EQ (key, intern ("capslock")))
7279 vk_code = VK_CAPITAL;
7280 else if (EQ (key, intern ("kp-numlock")))
7281 vk_code = VK_NUMLOCK;
7282 else if (EQ (key, intern ("scroll")))
7283 vk_code = VK_SCROLL;
7284 else
7285 return Qnil;
7286
7287 if (!dwWindowsThreadId)
7288 return make_number (w32_console_toggle_lock_key (vk_code, new_state));
7289
7290 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_TOGGLE_LOCK_KEY,
646b5f55 7291 (WPARAM) vk_code, (LPARAM) XLI (new_state)))
adcc3809
GV
7292 {
7293 MSG msg;
7294 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
7295 return make_number (msg.wParam);
7296 }
7297 return Qnil;
7298}
a01763cb
EZ
7299
7300DEFUN ("w32-window-exists-p", Fw32_window_exists_p, Sw32_window_exists_p,
7301 2, 2, 0,
7302 doc: /* Return non-nil if a window exists with the specified CLASS and NAME.
7303
7304This is a direct interface to the Windows API FindWindow function. */)
5842a27b 7305 (Lisp_Object class, Lisp_Object name)
a01763cb
EZ
7306{
7307 HWND hnd;
7308
7309 if (!NILP (class))
7310 CHECK_STRING (class);
7311 if (!NILP (name))
7312 CHECK_STRING (name);
7313
7314 hnd = FindWindow (STRINGP (class) ? ((LPCTSTR) SDATA (class)) : NULL,
7315 STRINGP (name) ? ((LPCTSTR) SDATA (name)) : NULL);
7316 if (!hnd)
7317 return Qnil;
7318 return Qt;
7319}
7320
880e6158
MR
7321DEFUN ("w32-frame-rect", Fw32_frame_rect, Sw32_frame_rect, 0, 2, 0,
7322 doc: /* Return boundary rectangle of FRAME in screen coordinates.
7323FRAME must be a live frame and defaults to the selected one.
7324
7325The boundary rectangle is a list of four elements, specifying the left,
7326top, right and bottom screen coordinates of FRAME including menu and
7327title bar and decorations. Optional argument CLIENT non-nil means to
7328return the boundaries of the client rectangle which excludes menu and
7329title bar and decorations. */)
7330 (Lisp_Object frame, Lisp_Object client)
7331{
7332 struct frame *f = decode_live_frame (frame);
7333 RECT rect;
7334
7335 if (!NILP (client))
7336 GetClientRect (FRAME_W32_WINDOW (f), &rect);
7337 else
7338 GetWindowRect (FRAME_W32_WINDOW (f), &rect);
7339
7340 return list4 (make_number (rect.left), make_number (rect.top),
7341 make_number (rect.right), make_number (rect.bottom));
7342}
7343
2c2279c6
JR
7344DEFUN ("w32-battery-status", Fw32_battery_status, Sw32_battery_status, 0, 0, 0,
7345 doc: /* Get power status information from Windows system.
7346
7347The following %-sequences are provided:
7348%L AC line status (verbose)
7349%B Battery status (verbose)
7350%b Battery status, empty means high, `-' means low,
7351 `!' means critical, and `+' means charging
7352%p Battery load percentage
7353%s Remaining time (to charge or discharge) in seconds
7354%m Remaining time (to charge or discharge) in minutes
7355%h Remaining time (to charge or discharge) in hours
7356%t Remaining time (to charge or discharge) in the form `h:min' */)
5842a27b 7357 (void)
2c2279c6
JR
7358{
7359 Lisp_Object status = Qnil;
7360
7361 SYSTEM_POWER_STATUS system_status;
7362 if (GetSystemPowerStatus (&system_status))
7363 {
7364 Lisp_Object line_status, battery_status, battery_status_symbol;
7365 Lisp_Object load_percentage, seconds, minutes, hours, remain;
2c2279c6
JR
7366
7367 long seconds_left = (long) system_status.BatteryLifeTime;
7368
7369 if (system_status.ACLineStatus == 0)
7370 line_status = build_string ("off-line");
7371 else if (system_status.ACLineStatus == 1)
7372 line_status = build_string ("on-line");
7373 else
7374 line_status = build_string ("N/A");
7375
7376 if (system_status.BatteryFlag & 128)
7377 {
7378 battery_status = build_string ("N/A");
fff4e459 7379 battery_status_symbol = empty_unibyte_string;
2c2279c6
JR
7380 }
7381 else if (system_status.BatteryFlag & 8)
7382 {
7383 battery_status = build_string ("charging");
7384 battery_status_symbol = build_string ("+");
7385 if (system_status.BatteryFullLifeTime != -1L)
7386 seconds_left = system_status.BatteryFullLifeTime - seconds_left;
7387 }
7388 else if (system_status.BatteryFlag & 4)
7389 {
7390 battery_status = build_string ("critical");
7391 battery_status_symbol = build_string ("!");
7392 }
7393 else if (system_status.BatteryFlag & 2)
7394 {
7395 battery_status = build_string ("low");
7396 battery_status_symbol = build_string ("-");
7397 }
7398 else if (system_status.BatteryFlag & 1)
7399 {
7400 battery_status = build_string ("high");
fff4e459 7401 battery_status_symbol = empty_unibyte_string;
2c2279c6
JR
7402 }
7403 else
7404 {
7405 battery_status = build_string ("medium");
fff4e459 7406 battery_status_symbol = empty_unibyte_string;
2c2279c6
JR
7407 }
7408
7409 if (system_status.BatteryLifePercent > 100)
7410 load_percentage = build_string ("N/A");
7411 else
7412 {
7413 char buffer[16];
0fda9b75 7414 snprintf (buffer, 16, "%d", system_status.BatteryLifePercent);
2c2279c6
JR
7415 load_percentage = build_string (buffer);
7416 }
7417
7418 if (seconds_left < 0)
7419 seconds = minutes = hours = remain = build_string ("N/A");
7420 else
7421 {
7422 long m;
7423 float h;
7424 char buffer[16];
0fda9b75 7425 snprintf (buffer, 16, "%ld", seconds_left);
2c2279c6
JR
7426 seconds = build_string (buffer);
7427
7428 m = seconds_left / 60;
0fda9b75 7429 snprintf (buffer, 16, "%ld", m);
2c2279c6
JR
7430 minutes = build_string (buffer);
7431
7432 h = seconds_left / 3600.0;
0fda9b75 7433 snprintf (buffer, 16, "%3.1f", h);
2c2279c6
JR
7434 hours = build_string (buffer);
7435
0fda9b75 7436 snprintf (buffer, 16, "%ld:%02ld", m / 60, m % 60);
2c2279c6
JR
7437 remain = build_string (buffer);
7438 }
694b6c97 7439
3438fe21 7440 status = listn (CONSTYPE_HEAP, 8,
694b6c97
DA
7441 Fcons (make_number ('L'), line_status),
7442 Fcons (make_number ('B'), battery_status),
7443 Fcons (make_number ('b'), battery_status_symbol),
7444 Fcons (make_number ('p'), load_percentage),
7445 Fcons (make_number ('s'), seconds),
7446 Fcons (make_number ('m'), minutes),
7447 Fcons (make_number ('h'), hours),
7448 Fcons (make_number ('t'), remain));
2c2279c6
JR
7449 }
7450 return status;
7451}
a01763cb 7452
ee78dc32 7453\f
819e2da9 7454#ifdef WINDOWSNT
2254bcde 7455DEFUN ("file-system-info", Ffile_system_info, Sfile_system_info, 1, 1, 0,
74e1aeec
JR
7456 doc: /* Return storage information about the file system FILENAME is on.
7457Value is a list of floats (TOTAL FREE AVAIL), where TOTAL is the total
7458storage of the file system, FREE is the free storage, and AVAIL is the
7459storage available to a non-superuser. All 3 numbers are in bytes.
7460If the underlying system call fails, value is nil. */)
5842a27b 7461 (Lisp_Object filename)
2254bcde
AI
7462{
7463 Lisp_Object encoded, value;
7464
b7826503 7465 CHECK_STRING (filename);
2254bcde
AI
7466 filename = Fexpand_file_name (filename, Qnil);
7467 encoded = ENCODE_FILE (filename);
7468
7469 value = Qnil;
7470
7471 /* Determining the required information on Windows turns out, sadly,
b46a6a83 7472 to be more involved than one would hope. The original Windows API
2254bcde
AI
7473 call for this will return bogus information on some systems, but we
7474 must dynamically probe for the replacement api, since that was
7475 added rather late on. */
7476 {
7477 HMODULE hKernel = GetModuleHandle ("kernel32");
28e6cee8 7478 BOOL (WINAPI *pfn_GetDiskFreeSpaceExW)
577c8624 7479 (wchar_t *, PULARGE_INTEGER, PULARGE_INTEGER, PULARGE_INTEGER)
28e6cee8
EZ
7480 = GetProcAddress (hKernel, "GetDiskFreeSpaceExW");
7481 BOOL (WINAPI *pfn_GetDiskFreeSpaceExA)
2254bcde 7482 (char *, PULARGE_INTEGER, PULARGE_INTEGER, PULARGE_INTEGER)
28e6cee8 7483 = GetProcAddress (hKernel, "GetDiskFreeSpaceExA");
577c8624
EZ
7484 bool have_pfn_GetDiskFreeSpaceEx =
7485 (w32_unicode_filenames && pfn_GetDiskFreeSpaceExW
7486 || !w32_unicode_filenames && pfn_GetDiskFreeSpaceExA);
2254bcde
AI
7487
7488 /* On Windows, we may need to specify the root directory of the
7489 volume holding FILENAME. */
577c8624
EZ
7490 char rootname[MAX_UTF8_PATH];
7491 wchar_t rootname_w[MAX_PATH];
7492 char rootname_a[MAX_PATH];
d5db4077 7493 char *name = SDATA (encoded);
577c8624 7494 BOOL result;
2254bcde
AI
7495
7496 /* find the root name of the volume if given */
7497 if (isalpha (name[0]) && name[1] == ':')
7498 {
7499 rootname[0] = name[0];
7500 rootname[1] = name[1];
7501 rootname[2] = '\\';
7502 rootname[3] = 0;
7503 }
7504 else if (IS_DIRECTORY_SEP (name[0]) && IS_DIRECTORY_SEP (name[1]))
7505 {
7506 char *str = rootname;
7507 int slashes = 4;
7508 do
7509 {
7510 if (IS_DIRECTORY_SEP (*name) && --slashes == 0)
7511 break;
7512 *str++ = *name++;
7513 }
7514 while ( *name );
7515
7516 *str++ = '\\';
7517 *str = 0;
7518 }
7519
577c8624
EZ
7520 if (w32_unicode_filenames)
7521 filename_to_utf16 (rootname, rootname_w);
7522 else
7523 filename_to_ansi (rootname, rootname_a);
7524
7525 if (have_pfn_GetDiskFreeSpaceEx)
2254bcde 7526 {
ac849ba4
JR
7527 /* Unsigned large integers cannot be cast to double, so
7528 use signed ones instead. */
2254bcde
AI
7529 LARGE_INTEGER availbytes;
7530 LARGE_INTEGER freebytes;
7531 LARGE_INTEGER totalbytes;
7532
577c8624
EZ
7533 if (w32_unicode_filenames)
7534 result = pfn_GetDiskFreeSpaceExW (rootname_w,
7535 (ULARGE_INTEGER *)&availbytes,
7536 (ULARGE_INTEGER *)&totalbytes,
7537 (ULARGE_INTEGER *)&freebytes);
7538 else
7539 result = pfn_GetDiskFreeSpaceExA (rootname_a,
7540 (ULARGE_INTEGER *)&availbytes,
7541 (ULARGE_INTEGER *)&totalbytes,
7542 (ULARGE_INTEGER *)&freebytes);
7543 if (result)
2254bcde
AI
7544 value = list3 (make_float ((double) totalbytes.QuadPart),
7545 make_float ((double) freebytes.QuadPart),
7546 make_float ((double) availbytes.QuadPart));
7547 }
7548 else
7549 {
7550 DWORD sectors_per_cluster;
7551 DWORD bytes_per_sector;
7552 DWORD free_clusters;
7553 DWORD total_clusters;
7554
577c8624
EZ
7555 if (w32_unicode_filenames)
7556 result = GetDiskFreeSpaceW (rootname_w,
7557 &sectors_per_cluster,
7558 &bytes_per_sector,
7559 &free_clusters,
7560 &total_clusters);
7561 else
7562 result = GetDiskFreeSpaceA (rootname_a,
7563 &sectors_per_cluster,
7564 &bytes_per_sector,
7565 &free_clusters,
7566 &total_clusters);
7567 if (result)
2254bcde
AI
7568 value = list3 (make_float ((double) total_clusters
7569 * sectors_per_cluster * bytes_per_sector),
7570 make_float ((double) free_clusters
7571 * sectors_per_cluster * bytes_per_sector),
7572 make_float ((double) free_clusters
7573 * sectors_per_cluster * bytes_per_sector));
7574 }
7575 }
7576
7577 return value;
7578}
819e2da9
DC
7579#endif /* WINDOWSNT */
7580
2254bcde 7581\f
a5c9bbb3 7582#ifdef WINDOWSNT
6b61353c
KH
7583DEFUN ("default-printer-name", Fdefault_printer_name, Sdefault_printer_name,
7584 0, 0, 0, doc: /* Return the name of Windows default printer device. */)
5842a27b 7585 (void)
6b61353c
KH
7586{
7587 static char pname_buf[256];
7588 int err;
7589 HANDLE hPrn;
080fd649
EZ
7590 PRINTER_INFO_2W *ppi2w = NULL;
7591 PRINTER_INFO_2A *ppi2a = NULL;
6b61353c 7592 DWORD dwNeeded = 0, dwReturned = 0;
080fd649
EZ
7593 char server_name[MAX_UTF8_PATH], share_name[MAX_UTF8_PATH];
7594 char port_name[MAX_UTF8_PATH];
6b61353c
KH
7595
7596 /* Retrieve the default string from Win.ini (the registry).
7597 * String will be in form "printername,drivername,portname".
7598 * This is the most portable way to get the default printer. */
7599 if (GetProfileString ("windows", "device", ",,", pname_buf, sizeof (pname_buf)) <= 0)
7600 return Qnil;
7601 /* printername precedes first "," character */
7602 strtok (pname_buf, ",");
7603 /* We want to know more than the printer name */
7604 if (!OpenPrinter (pname_buf, &hPrn, NULL))
7605 return Qnil;
080fd649
EZ
7606 /* GetPrinterW is not supported by unicows.dll. */
7607 if (w32_unicode_filenames && os_subtype != OS_9X)
7608 GetPrinterW (hPrn, 2, NULL, 0, &dwNeeded);
7609 else
7610 GetPrinterA (hPrn, 2, NULL, 0, &dwNeeded);
6b61353c
KH
7611 if (dwNeeded == 0)
7612 {
7613 ClosePrinter (hPrn);
7614 return Qnil;
7615 }
080fd649
EZ
7616 /* Call GetPrinter again with big enough memory block. */
7617 if (w32_unicode_filenames && os_subtype != OS_9X)
6b61353c 7618 {
080fd649
EZ
7619 /* Allocate memory for the PRINTER_INFO_2 struct. */
7620 ppi2w = xmalloc (dwNeeded);
7621 err = GetPrinterW (hPrn, 2, (LPBYTE)ppi2w, dwNeeded, &dwReturned);
6b61353c 7622 ClosePrinter (hPrn);
080fd649
EZ
7623 if (!err)
7624 {
7625 xfree (ppi2w);
7626 return Qnil;
7627 }
7628
7629 if ((ppi2w->Attributes & PRINTER_ATTRIBUTE_SHARED)
7630 && ppi2w->pServerName)
7631 {
7632 filename_from_utf16 (ppi2w->pServerName, server_name);
7633 filename_from_utf16 (ppi2w->pShareName, share_name);
7634 }
7635 else
7636 {
7637 server_name[0] = '\0';
7638 filename_from_utf16 (ppi2w->pPortName, port_name);
7639 }
6b61353c 7640 }
080fd649 7641 else
6b61353c 7642 {
080fd649
EZ
7643 ppi2a = xmalloc (dwNeeded);
7644 err = GetPrinterA (hPrn, 2, (LPBYTE)ppi2a, dwNeeded, &dwReturned);
7645 ClosePrinter (hPrn);
7646 if (!err)
7647 {
7648 xfree (ppi2a);
7649 return Qnil;
7650 }
6b61353c 7651
080fd649
EZ
7652 if ((ppi2a->Attributes & PRINTER_ATTRIBUTE_SHARED)
7653 && ppi2a->pServerName)
7654 {
7655 filename_from_ansi (ppi2a->pServerName, server_name);
7656 filename_from_ansi (ppi2a->pShareName, share_name);
6b61353c
KH
7657 }
7658 else
080fd649
EZ
7659 {
7660 server_name[0] = '\0';
7661 filename_from_ansi (ppi2a->pPortName, port_name);
6b61353c 7662 }
6b61353c
KH
7663 }
7664
080fd649
EZ
7665 if (server_name[0])
7666 {
7667 /* a remote printer */
7668 if (server_name[0] == '\\')
7669 snprintf (pname_buf, sizeof (pname_buf), "%s\\%s", server_name,
7670 share_name);
7671 else
7672 snprintf (pname_buf, sizeof (pname_buf), "\\\\%s\\%s", server_name,
7673 share_name);
7674 pname_buf[sizeof (pname_buf) - 1] = '\0';
7675 }
7676 else
7677 {
7678 /* a local printer */
7679 strncpy (pname_buf, port_name, sizeof (pname_buf));
7680 pname_buf[sizeof (pname_buf) - 1] = '\0';
7681 /* `pPortName' can include several ports, delimited by ','.
7682 * we only use the first one. */
7683 strtok (pname_buf, ",");
7684 }
7685
7686 return DECODE_FILE (build_unibyte_string (pname_buf));
6b61353c 7687}
a5c9bbb3 7688#endif /* WINDOWSNT */
6b61353c 7689\f
0fda9b75
DC
7690
7691/* Equivalent of strerror for W32 error codes. */
7692char *
7693w32_strerror (int error_no)
7694{
7695 static char buf[500];
7696 DWORD ret;
7697
7698 if (error_no == 0)
7699 error_no = GetLastError ();
7700
7701 ret = FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM |
7702 FORMAT_MESSAGE_IGNORE_INSERTS,
7703 NULL,
7704 error_no,
7705 0, /* choose most suitable language */
7706 buf, sizeof (buf), NULL);
7707
7708 while (ret > 0 && (buf[ret - 1] == '\n' ||
7709 buf[ret - 1] == '\r' ))
7710 --ret;
7711 buf[ret] = '\0';
7712 if (!ret)
7713 sprintf (buf, "w32 error %u", error_no);
7714
7715 return buf;
7716}
7717
b15736e6
EZ
7718/* For convenience when debugging. (You cannot call GetLastError
7719 directly from GDB: it will crash, because it uses the __stdcall
7720 calling convention, not the _cdecl convention assumed by GDB.) */
7721DWORD
0fda9b75
DC
7722w32_last_error (void)
7723{
7724 return GetLastError ();
7725}
7726
7727/* Cache information describing the NT system for later use. */
7728void
7729cache_system_info (void)
7730{
7731 union
7732 {
7733 struct info
7734 {
7735 char major;
7736 char minor;
7737 short platform;
7738 } info;
7739 DWORD data;
7740 } version;
7741
1cf1bbd5
DC
7742 /* Cache the module handle of Emacs itself. */
7743 hinst = GetModuleHandle (NULL);
7744
0fda9b75
DC
7745 /* Cache the version of the operating system. */
7746 version.data = GetVersion ();
7747 w32_major_version = version.info.major;
7748 w32_minor_version = version.info.minor;
7749
7750 if (version.info.platform & 0x8000)
7751 os_subtype = OS_9X;
7752 else
7753 os_subtype = OS_NT;
7754
7755 /* Cache page size, allocation unit, processor type, etc. */
7756 GetSystemInfo (&sysinfo_cache);
cb576b5c 7757 syspage_mask = (DWORD_PTR)sysinfo_cache.dwPageSize - 1;
0fda9b75
DC
7758
7759 /* Cache os info. */
7760 osinfo_cache.dwOSVersionInfoSize = sizeof (OSVERSIONINFO);
7761 GetVersionEx (&osinfo_cache);
7762
7763 w32_build_number = osinfo_cache.dwBuildNumber;
7764 if (os_subtype == OS_9X)
7765 w32_build_number &= 0xffff;
7766
7767 w32_num_mouse_buttons = GetSystemMetrics (SM_CMOUSEBUTTONS);
7768}
7769
7770#ifdef EMACSDEBUG
7771void
7772_DebPrint (const char *fmt, ...)
7773{
7774 char buf[1024];
7775 va_list args;
7776
7777 va_start (args, fmt);
7778 vsprintf (buf, fmt, args);
7779 va_end (args);
7780#if CYGWIN
7781 fprintf (stderr, "%s", buf);
7782#endif
7783 OutputDebugString (buf);
7784}
7785#endif
7786
7787int
7788w32_console_toggle_lock_key (int vk_code, Lisp_Object new_state)
7789{
7790 int cur_state = (GetKeyState (vk_code) & 1);
7791
7792 if (NILP (new_state)
7793 || (NUMBERP (new_state)
7794 && ((XUINT (new_state)) & 1) != cur_state))
7795 {
7796#ifdef WINDOWSNT
7797 faked_key = vk_code;
7798#endif /* WINDOWSNT */
7799
7800 keybd_event ((BYTE) vk_code,
7801 (BYTE) MapVirtualKey (vk_code, 0),
7802 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
7803 keybd_event ((BYTE) vk_code,
7804 (BYTE) MapVirtualKey (vk_code, 0),
7805 KEYEVENTF_EXTENDEDKEY | 0, 0);
7806 keybd_event ((BYTE) vk_code,
7807 (BYTE) MapVirtualKey (vk_code, 0),
7808 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
7809 cur_state = !cur_state;
7810 }
7811
7812 return cur_state;
7813}
7814
7815/* Translate console modifiers to emacs modifiers.
7816 German keyboard support (Kai Morgan Zeise 2/18/95). */
7817int
7818w32_kbd_mods_to_emacs (DWORD mods, WORD key)
7819{
7820 int retval = 0;
7821
7822 /* If we recognize right-alt and left-ctrl as AltGr, and it has been
7823 pressed, first remove those modifiers. */
7824 if (!NILP (Vw32_recognize_altgr)
7825 && (mods & (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED))
7826 == (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED))
7827 mods &= ~ (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED);
7828
7829 if (mods & (RIGHT_ALT_PRESSED | LEFT_ALT_PRESSED))
7830 retval = ((NILP (Vw32_alt_is_meta)) ? alt_modifier : meta_modifier);
7831
7832 if (mods & (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
7833 {
7834 retval |= ctrl_modifier;
7835 if ((mods & (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
7836 == (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
7837 retval |= meta_modifier;
7838 }
7839
7840 if (mods & LEFT_WIN_PRESSED)
7841 retval |= w32_key_to_modifier (VK_LWIN);
7842 if (mods & RIGHT_WIN_PRESSED)
7843 retval |= w32_key_to_modifier (VK_RWIN);
7844 if (mods & APPS_PRESSED)
7845 retval |= w32_key_to_modifier (VK_APPS);
7846 if (mods & SCROLLLOCK_ON)
7847 retval |= w32_key_to_modifier (VK_SCROLL);
7848
7849 /* Just in case someone wanted the original behavior, make it
7850 optional by setting w32-capslock-is-shiftlock to t. */
7851 if (NILP (Vw32_capslock_is_shiftlock)
7852 /* Keys that should _not_ be affected by CapsLock. */
7853 && ( (key == VK_BACK)
7854 || (key == VK_TAB)
7855 || (key == VK_CLEAR)
7856 || (key == VK_RETURN)
7857 || (key == VK_ESCAPE)
7858 || ((key >= VK_SPACE) && (key <= VK_HELP))
7859 || ((key >= VK_NUMPAD0) && (key <= VK_F24))
7860 || ((key >= VK_NUMPAD_CLEAR) && (key <= VK_NUMPAD_DELETE))
7861 ))
7862 {
7863 /* Only consider shift state. */
7864 if ((mods & SHIFT_PRESSED) != 0)
7865 retval |= shift_modifier;
7866 }
7867 else
7868 {
7869 /* Ignore CapsLock state if not enabled. */
7870 if (NILP (Vw32_enable_caps_lock))
7871 mods &= ~CAPSLOCK_ON;
7872 if ((mods & (SHIFT_PRESSED | CAPSLOCK_ON)) != 0)
7873 retval |= shift_modifier;
7874 }
7875
7876 return retval;
7877}
7878
7879/* The return code indicates key code size. cpID is the codepage to
7880 use for translation to Unicode; -1 means use the current console
7881 input codepage. */
7882int
7883w32_kbd_patch_key (KEY_EVENT_RECORD *event, int cpId)
7884{
7885 unsigned int key_code = event->wVirtualKeyCode;
7886 unsigned int mods = event->dwControlKeyState;
7887 BYTE keystate[256];
7888 static BYTE ansi_code[4];
7889 static int isdead = 0;
7890
7891 if (isdead == 2)
7892 {
7893 event->uChar.AsciiChar = ansi_code[2];
7894 isdead = 0;
7895 return 1;
7896 }
7897 if (event->uChar.AsciiChar != 0)
7898 return 1;
7899
7900 memset (keystate, 0, sizeof (keystate));
7901 keystate[key_code] = 0x80;
7902 if (mods & SHIFT_PRESSED)
7903 keystate[VK_SHIFT] = 0x80;
7904 if (mods & CAPSLOCK_ON)
7905 keystate[VK_CAPITAL] = 1;
7906 /* If we recognize right-alt and left-ctrl as AltGr, set the key
7907 states accordingly before invoking ToAscii. */
7908 if (!NILP (Vw32_recognize_altgr)
7909 && (mods & LEFT_CTRL_PRESSED) && (mods & RIGHT_ALT_PRESSED))
7910 {
7911 keystate[VK_CONTROL] = 0x80;
7912 keystate[VK_LCONTROL] = 0x80;
7913 keystate[VK_MENU] = 0x80;
7914 keystate[VK_RMENU] = 0x80;
7915 }
7916
7917#if 0
7918 /* Because of an OS bug, ToAscii corrupts the stack when called to
7919 convert a dead key in console mode on NT4. Unfortunately, trying
7920 to check for dead keys using MapVirtualKey doesn't work either -
7921 these functions apparently use internal information about keyboard
7922 layout which doesn't get properly updated in console programs when
7923 changing layout (though apparently it gets partly updated,
7924 otherwise ToAscii wouldn't crash). */
7925 if (is_dead_key (event->wVirtualKeyCode))
7926 return 0;
7927#endif
7928
7929 /* On NT, call ToUnicode instead and then convert to the current
7930 console input codepage. */
7931 if (os_subtype == OS_NT)
7932 {
7933 WCHAR buf[128];
7934
7935 isdead = ToUnicode (event->wVirtualKeyCode, event->wVirtualScanCode,
7936 keystate, buf, 128, 0);
7937 if (isdead > 0)
7938 {
7939 /* When we are called from the GUI message processing code,
7940 we are passed the current keyboard codepage, a positive
7941 number, to use below. */
7942 if (cpId == -1)
7943 cpId = GetConsoleCP ();
7944
7945 event->uChar.UnicodeChar = buf[isdead - 1];
7946 isdead = WideCharToMultiByte (cpId, 0, buf, isdead,
7947 ansi_code, 4, NULL, NULL);
7948 }
7949 else
7950 isdead = 0;
7951 }
7952 else
7953 {
7954 isdead = ToAscii (event->wVirtualKeyCode, event->wVirtualScanCode,
7955 keystate, (LPWORD) ansi_code, 0);
7956 }
7957
7958 if (isdead == 0)
7959 return 0;
7960 event->uChar.AsciiChar = ansi_code[0];
7961 return isdead;
7962}
7963
7964
7965void
7966w32_sys_ring_bell (struct frame *f)
7967{
7968 if (sound_type == 0xFFFFFFFF)
7969 {
7970 Beep (666, 100);
7971 }
7972 else if (sound_type == MB_EMACS_SILENT)
7973 {
7974 /* Do nothing. */
7975 }
7976 else
7977 MessageBeep (sound_type);
7978}
7979
7980\f
0e3fcdef
JR
7981/***********************************************************************
7982 Initialization
7983 ***********************************************************************/
7984
52deb19f 7985/* Keep this list in the same order as frame_parms in frame.c.
6d906347
KS
7986 Use 0 for unsupported frame parameters. */
7987
7988frame_parm_handler w32_frame_parm_handlers[] =
7989{
7990 x_set_autoraise,
7991 x_set_autolower,
7992 x_set_background_color,
7993 x_set_border_color,
7994 x_set_border_width,
7995 x_set_cursor_color,
7996 x_set_cursor_type,
7997 x_set_font,
7998 x_set_foreground_color,
7999 x_set_icon_name,
8000 x_set_icon_type,
8001 x_set_internal_border_width,
880e6158
MR
8002 x_set_right_divider_width,
8003 x_set_bottom_divider_width,
6d906347
KS
8004 x_set_menu_bar_lines,
8005 x_set_mouse_color,
8006 x_explicitly_set_name,
8007 x_set_scroll_bar_width,
8008 x_set_title,
8009 x_set_unsplittable,
8010 x_set_vertical_scroll_bars,
8011 x_set_visibility,
8012 x_set_tool_bar_lines,
8013 0, /* x_set_scroll_bar_foreground, */
8014 0, /* x_set_scroll_bar_background, */
8015 x_set_screen_gamma,
8016 x_set_line_spacing,
8017 x_set_fringe_width,
8018 x_set_fringe_width,
8019 0, /* x_set_wait_for_wm, */
8020 x_set_fullscreen,
a2979e8e 8021 x_set_font_backend,
cad9ef74
JD
8022 x_set_alpha,
8023 0, /* x_set_sticky */
0cc56427 8024 0, /* x_set_tool_bar_position */
6d906347
KS
8025};
8026
0e3fcdef 8027void
b56ceb92 8028syms_of_w32fns (void)
ee78dc32 8029{
afc390dc 8030 globals_of_w32fns ();
9eb16b62
JR
8031 track_mouse_window = NULL;
8032
d285988b
JR
8033 w32_visible_system_caret_hwnd = NULL;
8034
4f5b288c
JR
8035 DEFSYM (Qsuppress_icon, "suppress-icon");
8036 DEFSYM (Qundefined_color, "undefined-color");
8037 DEFSYM (Qcancel_timer, "cancel-timer");
8038 DEFSYM (Qhyper, "hyper");
8039 DEFSYM (Qsuper, "super");
8040 DEFSYM (Qmeta, "meta");
8041 DEFSYM (Qalt, "alt");
8042 DEFSYM (Qctrl, "ctrl");
8043 DEFSYM (Qcontrol, "control");
8044 DEFSYM (Qshift, "shift");
27129af9 8045 DEFSYM (Qfont_param, "font-parameter");
cf13177e
YM
8046 DEFSYM (Qgeometry, "geometry");
8047 DEFSYM (Qworkarea, "workarea");
8048 DEFSYM (Qmm_size, "mm-size");
8049 DEFSYM (Qframes, "frames");
f7b9d4d1 8050 /* This is the end of symbol initialization. */
adcc3809 8051
6fc2811b 8052
ee78dc32 8053 Fput (Qundefined_color, Qerror_conditions,
3438fe21 8054 listn (CONSTYPE_PURE, 2, Qundefined_color, Qerror));
ee78dc32 8055 Fput (Qundefined_color, Qerror_message,
2a0213a6 8056 build_pure_c_string ("Undefined color"));
ee78dc32 8057
ccc2d29c
GV
8058 staticpro (&w32_grabbed_keys);
8059 w32_grabbed_keys = Qnil;
8060
29208e82 8061 DEFVAR_LISP ("w32-color-map", Vw32_color_map,
52deb19f 8062 doc: /* An array of color name mappings for Windows. */);
fbd6baed 8063 Vw32_color_map = Qnil;
ee78dc32 8064
29208e82 8065 DEFVAR_LISP ("w32-pass-alt-to-system", Vw32_pass_alt_to_system,
1133f8e7
EZ
8066 doc: /* Non-nil if Alt key presses are passed on to Windows.
8067When non-nil, for example, Alt pressed and released and then space will
8068open the System menu. When nil, Emacs processes the Alt key events, and
8069then silently swallows them. */);
fbd6baed 8070 Vw32_pass_alt_to_system = Qnil;
da36a4d6 8071
29208e82 8072 DEFVAR_LISP ("w32-alt-is-meta", Vw32_alt_is_meta,
1133f8e7
EZ
8073 doc: /* Non-nil if the Alt key is to be considered the same as the META key.
8074When nil, Emacs will translate the Alt key to the ALT modifier, not to META. */);
fbd6baed 8075 Vw32_alt_is_meta = Qt;
8c205c63 8076
29208e82 8077 DEFVAR_INT ("w32-quit-key", w32_quit_key,
2ba49441
JR
8078 doc: /* If non-zero, the virtual key code for an alternative quit key. */);
8079 w32_quit_key = 0;
7d081355 8080
7d0393cf 8081 DEFVAR_LISP ("w32-pass-lwindow-to-system",
29208e82 8082 Vw32_pass_lwindow_to_system,
1133f8e7
EZ
8083 doc: /* If non-nil, the left \"Windows\" key is passed on to Windows.
8084
8085When non-nil, the Start menu is opened by tapping the key.
8086If you set this to nil, the left \"Windows\" key is processed by Emacs
8087according to the value of `w32-lwindow-modifier', which see.
8088
8089Note that some combinations of the left \"Windows\" key with other keys are
8090caught by Windows at low level, and so binding them in Emacs will have no
8091effect. For example, <lwindow>-r always pops up the Windows Run dialog,
8092<lwindow>-<Pause> pops up the "System Properties" dialog, etc. However, see
8093the doc string of `w32-phantom-key-code'. */);
ccc2d29c
GV
8094 Vw32_pass_lwindow_to_system = Qt;
8095
7d0393cf 8096 DEFVAR_LISP ("w32-pass-rwindow-to-system",
29208e82 8097 Vw32_pass_rwindow_to_system,
1133f8e7
EZ
8098 doc: /* If non-nil, the right \"Windows\" key is passed on to Windows.
8099
8100When non-nil, the Start menu is opened by tapping the key.
8101If you set this to nil, the right \"Windows\" key is processed by Emacs
8102according to the value of `w32-rwindow-modifier', which see.
8103
8104Note that some combinations of the right \"Windows\" key with other keys are
8105caught by Windows at low level, and so binding them in Emacs will have no
8106effect. For example, <rwindow>-r always pops up the Windows Run dialog,
8107<rwindow>-<Pause> pops up the "System Properties" dialog, etc. However, see
8108the doc string of `w32-phantom-key-code'. */);
ccc2d29c
GV
8109 Vw32_pass_rwindow_to_system = Qt;
8110
2ba49441 8111 DEFVAR_LISP ("w32-phantom-key-code",
29208e82 8112 Vw32_phantom_key_code,
2ba49441 8113 doc: /* Virtual key code used to generate \"phantom\" key presses.
74e1aeec
JR
8114Value is a number between 0 and 255.
8115
8116Phantom key presses are generated in order to stop the system from
8117acting on \"Windows\" key events when `w32-pass-lwindow-to-system' or
8118`w32-pass-rwindow-to-system' is nil. */);
ce6059da
AI
8119 /* Although 255 is technically not a valid key code, it works and
8120 means that this hack won't interfere with any real key code. */
2ba49441 8121 XSETINT (Vw32_phantom_key_code, 255);
adcc3809 8122
7d0393cf 8123 DEFVAR_LISP ("w32-enable-num-lock",
29208e82 8124 Vw32_enable_num_lock,
1133f8e7
EZ
8125 doc: /* If non-nil, the Num Lock key acts normally.
8126Set to nil to handle Num Lock as the `kp-numlock' key. */);
ccc2d29c
GV
8127 Vw32_enable_num_lock = Qt;
8128
7d0393cf 8129 DEFVAR_LISP ("w32-enable-caps-lock",
29208e82 8130 Vw32_enable_caps_lock,
1133f8e7
EZ
8131 doc: /* If non-nil, the Caps Lock key acts normally.
8132Set to nil to handle Caps Lock as the `capslock' key. */);
ccc2d29c
GV
8133 Vw32_enable_caps_lock = Qt;
8134
8135 DEFVAR_LISP ("w32-scroll-lock-modifier",
29208e82 8136 Vw32_scroll_lock_modifier,
1133f8e7 8137 doc: /* Modifier to use for the Scroll Lock ON state.
74e1aeec 8138The value can be hyper, super, meta, alt, control or shift for the
1133f8e7
EZ
8139respective modifier, or nil to handle Scroll Lock as the `scroll' key.
8140Any other value will cause the Scroll Lock key to be ignored. */);
47e0e0e4 8141 Vw32_scroll_lock_modifier = Qnil;
ccc2d29c
GV
8142
8143 DEFVAR_LISP ("w32-lwindow-modifier",
29208e82 8144 Vw32_lwindow_modifier,
74e1aeec
JR
8145 doc: /* Modifier to use for the left \"Windows\" key.
8146The value can be hyper, super, meta, alt, control or shift for the
1133f8e7 8147respective modifier, or nil to appear as the `lwindow' key.
74e1aeec 8148Any other value will cause the key to be ignored. */);
ccc2d29c
GV
8149 Vw32_lwindow_modifier = Qnil;
8150
8151 DEFVAR_LISP ("w32-rwindow-modifier",
29208e82 8152 Vw32_rwindow_modifier,
74e1aeec
JR
8153 doc: /* Modifier to use for the right \"Windows\" key.
8154The value can be hyper, super, meta, alt, control or shift for the
1133f8e7 8155respective modifier, or nil to appear as the `rwindow' key.
74e1aeec 8156Any other value will cause the key to be ignored. */);
ccc2d29c
GV
8157 Vw32_rwindow_modifier = Qnil;
8158
8159 DEFVAR_LISP ("w32-apps-modifier",
29208e82 8160 Vw32_apps_modifier,
74e1aeec
JR
8161 doc: /* Modifier to use for the \"Apps\" key.
8162The value can be hyper, super, meta, alt, control or shift for the
1133f8e7 8163respective modifier, or nil to appear as the `apps' key.
74e1aeec 8164Any other value will cause the key to be ignored. */);
ccc2d29c 8165 Vw32_apps_modifier = Qnil;
da36a4d6 8166
29208e82 8167 DEFVAR_BOOL ("w32-enable-synthesized-fonts", w32_enable_synthesized_fonts,
74e1aeec 8168 doc: /* Non-nil enables selection of artificially italicized and bold fonts. */);
d84b082d 8169 w32_enable_synthesized_fonts = 0;
5ac45f98 8170
29208e82 8171 DEFVAR_LISP ("w32-enable-palette", Vw32_enable_palette,
74e1aeec 8172 doc: /* Non-nil enables Windows palette management to map colors exactly. */);
fbd6baed 8173 Vw32_enable_palette = Qt;
5ac45f98 8174
fbd6baed 8175 DEFVAR_INT ("w32-mouse-button-tolerance",
29208e82 8176 w32_mouse_button_tolerance,
74e1aeec
JR
8177 doc: /* Analogue of double click interval for faking middle mouse events.
8178The value is the minimum time in milliseconds that must elapse between
1133f8e7 8179left and right button down events before they are considered distinct events.
74e1aeec
JR
8180If both mouse buttons are depressed within this interval, a middle mouse
8181button down event is generated instead. */);
2ba49441 8182 w32_mouse_button_tolerance = GetDoubleClickTime () / 2;
5ac45f98 8183
fbd6baed 8184 DEFVAR_INT ("w32-mouse-move-interval",
29208e82 8185 w32_mouse_move_interval,
74e1aeec
JR
8186 doc: /* Minimum interval between mouse move events.
8187The value is the minimum time in milliseconds that must elapse between
8188successive mouse move (or scroll bar drag) events before they are
8189reported as lisp events. */);
2ba49441 8190 w32_mouse_move_interval = 0;
84fb1139 8191
74214547 8192 DEFVAR_BOOL ("w32-pass-extra-mouse-buttons-to-system",
29208e82 8193 w32_pass_extra_mouse_buttons_to_system,
1133f8e7 8194 doc: /* If non-nil, the fourth and fifth mouse buttons are passed to Windows.
74214547
JR
8195Recent versions of Windows support mice with up to five buttons.
8196Since most applications don't support these extra buttons, most mouse
8197drivers will allow you to map them to functions at the system level.
8198If this variable is non-nil, Emacs will pass them on, allowing the
8199system to handle them. */);
8200 w32_pass_extra_mouse_buttons_to_system = 0;
8201
0b151762 8202 DEFVAR_BOOL ("w32-pass-multimedia-buttons-to-system",
29208e82 8203 w32_pass_multimedia_buttons_to_system,
0b151762
JR
8204 doc: /* If non-nil, media buttons are passed to Windows.
8205Some modern keyboards contain buttons for controlling media players, web
74084731 8206browsers and other applications. Generally these buttons are handled on a
0b151762
JR
8207system wide basis, but by setting this to nil they are made available
8208to Emacs for binding. Depending on your keyboard, additional keys that
8209may be available are:
8210
8211browser-back, browser-forward, browser-refresh, browser-stop,
8212browser-search, browser-favorites, browser-home,
8213mail, mail-reply, mail-forward, mail-send,
8214app-1, app-2,
8215help, find, new, open, close, save, print, undo, redo, copy, cut, paste,
8216spell-check, correction-list, toggle-dictate-command,
8217media-next, media-previous, media-stop, media-play-pause, media-select,
8218media-play, media-pause, media-record, media-fast-forward, media-rewind,
8219media-channel-up, media-channel-down,
8220volume-mute, volume-up, volume-down,
8221mic-volume-mute, mic-volume-down, mic-volume-up, mic-toggle,
74084731 8222bass-down, bass-boost, bass-up, treble-down, treble-up */);
0b151762
JR
8223 w32_pass_multimedia_buttons_to_system = 1;
8224
5f004711 8225#if 0 /* TODO: Mouse cursor customization. */
29208e82 8226 DEFVAR_LISP ("x-pointer-shape", Vx_pointer_shape,
74e1aeec
JR
8227 doc: /* The shape of the pointer when over text.
8228Changing the value does not affect existing frames
8229unless you set the mouse color. */);
ee78dc32
GV
8230 Vx_pointer_shape = Qnil;
8231
ee78dc32
GV
8232 Vx_nontext_pointer_shape = Qnil;
8233
8234 Vx_mode_pointer_shape = Qnil;
8235
29208e82 8236 DEFVAR_LISP ("x-hourglass-pointer-shape", Vx_hourglass_pointer_shape,
74e1aeec
JR
8237 doc: /* The shape of the pointer when Emacs is busy.
8238This variable takes effect when you create a new frame
8239or when you set the mouse color. */);
0af913d7 8240 Vx_hourglass_pointer_shape = Qnil;
6fc2811b 8241
6fc2811b 8242 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
29208e82 8243 Vx_sensitive_text_pointer_shape,
74e1aeec
JR
8244 doc: /* The shape of the pointer when over mouse-sensitive text.
8245This variable takes effect when you create a new frame
8246or when you set the mouse color. */);
ee78dc32
GV
8247 Vx_sensitive_text_pointer_shape = Qnil;
8248
4694d762 8249 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
29208e82 8250 Vx_window_horizontal_drag_shape,
74e1aeec
JR
8251 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
8252This variable takes effect when you create a new frame
8253or when you set the mouse color. */);
4694d762 8254 Vx_window_horizontal_drag_shape = Qnil;
880e6158
MR
8255
8256 DEFVAR_LISP ("x-window-vertical-drag-cursor",
8257 Vx_window_vertical_drag_shape,
8258 doc: /* Pointer shape to use for indicating a window can be dragged vertically.
8259This variable takes effect when you create a new frame
8260or when you set the mouse color. */);
8261 Vx_window_vertical_drag_shape = Qnil;
5f004711 8262#endif
4694d762 8263
29208e82 8264 DEFVAR_LISP ("x-cursor-fore-pixel", Vx_cursor_fore_pixel,
74e1aeec 8265 doc: /* A string indicating the foreground color of the cursor box. */);
ee78dc32
GV
8266 Vx_cursor_fore_pixel = Qnil;
8267
29208e82 8268 DEFVAR_LISP ("x-max-tooltip-size", Vx_max_tooltip_size,
b3700ae7 8269 doc: /* Maximum size for tooltips.
f5f6c0e0 8270Value is a pair (COLUMNS . ROWS). Text larger than this is clipped. */);
3cf3436e 8271 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
7d0393cf 8272
29208e82 8273 DEFVAR_LISP ("x-no-window-manager", Vx_no_window_manager,
74e1aeec
JR
8274 doc: /* Non-nil if no window manager is in use.
8275Emacs doesn't try to figure this out; this is always nil
8276unless you set it to something else. */);
ee78dc32
GV
8277 /* We don't have any way to find this out, so set it to nil
8278 and maybe the user would like to set it to t. */
8279 Vx_no_window_manager = Qnil;
8280
4587b026 8281 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
29208e82 8282 Vx_pixel_size_width_font_regexp,
74e1aeec
JR
8283 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
8284
8285Since Emacs gets width of a font matching with this regexp from
8286PIXEL_SIZE field of the name, font finding mechanism gets faster for
8287such a font. This is especially effective for such large fonts as
8288Chinese, Japanese, and Korean. */);
4587b026
GV
8289 Vx_pixel_size_width_font_regexp = Qnil;
8290
33d52f9c 8291 DEFVAR_LISP ("w32-bdf-filename-alist",
29208e82 8292 Vw32_bdf_filename_alist,
74e1aeec 8293 doc: /* List of bdf fonts and their corresponding filenames. */);
33d52f9c
GV
8294 Vw32_bdf_filename_alist = Qnil;
8295
1075afa9 8296 DEFVAR_BOOL ("w32-strict-fontnames",
29208e82 8297 w32_strict_fontnames,
74e1aeec
JR
8298 doc: /* Non-nil means only use fonts that are exact matches for those requested.
8299Default is nil, which allows old fontnames that are not XLFD compliant,
8300and allows third-party CJK display to work by specifying false charset
8301fields to trick Emacs into translating to Big5, SJIS etc.
8302Setting this to t will prevent wrong fonts being selected when
8303fontsets are automatically created. */);
1075afa9
GV
8304 w32_strict_fontnames = 0;
8305
c0611964 8306 DEFVAR_BOOL ("w32-strict-painting",
29208e82 8307 w32_strict_painting,
74e1aeec 8308 doc: /* Non-nil means use strict rules for repainting frames.
a8ab3e96 8309Set this to nil to get the old behavior for repainting; this should
74e1aeec 8310only be necessary if the default setting causes problems. */);
c0611964
AI
8311 w32_strict_painting = 1;
8312
767b1ff0 8313#if 0 /* TODO: Port to W32 */
6fc2811b
JR
8314 defsubr (&Sx_change_window_property);
8315 defsubr (&Sx_delete_window_property);
8316 defsubr (&Sx_window_property);
8317#endif
2d764c78 8318 defsubr (&Sxw_display_color_p);
ee78dc32 8319 defsubr (&Sx_display_grayscale_p);
2d764c78
EZ
8320 defsubr (&Sxw_color_defined_p);
8321 defsubr (&Sxw_color_values);
ee78dc32
GV
8322 defsubr (&Sx_server_max_request_size);
8323 defsubr (&Sx_server_vendor);
8324 defsubr (&Sx_server_version);
8325 defsubr (&Sx_display_pixel_width);
8326 defsubr (&Sx_display_pixel_height);
8327 defsubr (&Sx_display_mm_width);
8328 defsubr (&Sx_display_mm_height);
8329 defsubr (&Sx_display_screens);
8330 defsubr (&Sx_display_planes);
8331 defsubr (&Sx_display_color_cells);
8332 defsubr (&Sx_display_visual_class);
8333 defsubr (&Sx_display_backing_store);
8334 defsubr (&Sx_display_save_under);
ee78dc32 8335 defsubr (&Sx_create_frame);
ee78dc32
GV
8336 defsubr (&Sx_open_connection);
8337 defsubr (&Sx_close_connection);
8338 defsubr (&Sx_display_list);
8339 defsubr (&Sx_synchronize);
8340
fbd6baed 8341 /* W32 specific functions */
ee78dc32 8342
fbd6baed
GV
8343 defsubr (&Sw32_define_rgb_color);
8344 defsubr (&Sw32_default_color_map);
cf13177e 8345 defsubr (&Sw32_display_monitor_attributes_list);
1edf84e7 8346 defsubr (&Sw32_send_sys_command);
55dcfc15 8347 defsubr (&Sw32_shell_execute);
ccc2d29c
GV
8348 defsubr (&Sw32_register_hot_key);
8349 defsubr (&Sw32_unregister_hot_key);
8350 defsubr (&Sw32_registered_hot_keys);
8351 defsubr (&Sw32_reconstruct_hot_key);
adcc3809 8352 defsubr (&Sw32_toggle_lock_key);
a01763cb 8353 defsubr (&Sw32_window_exists_p);
880e6158 8354 defsubr (&Sw32_frame_rect);
2c2279c6 8355 defsubr (&Sw32_battery_status);
4587b026 8356
819e2da9 8357#ifdef WINDOWSNT
2254bcde 8358 defsubr (&Sfile_system_info);
a5c9bbb3 8359 defsubr (&Sdefault_printer_name);
819e2da9
DC
8360#endif
8361
0fda9b75 8362 defsubr (&Sset_message_beep);
2254bcde 8363
d148e14d 8364 hourglass_hwnd = NULL;
1885ab29 8365
6fc2811b
JR
8366 defsubr (&Sx_show_tip);
8367 defsubr (&Sx_hide_tip);
6fc2811b 8368 tip_timer = Qnil;
57fa2774
JR
8369 staticpro (&tip_timer);
8370 tip_frame = Qnil;
8371 staticpro (&tip_frame);
6fc2811b 8372
ca56d953
JR
8373 last_show_tip_args = Qnil;
8374 staticpro (&last_show_tip_args);
8375
6fc2811b 8376 defsubr (&Sx_file_dialog);
0fda9b75 8377#ifdef WINDOWSNT
6cf29fe8 8378 defsubr (&Ssystem_move_file_to_trash);
0fda9b75 8379#endif
6fc2811b
JR
8380}
8381
21bf394d 8382\f
c922a224 8383
21bf394d 8384/* Crashing and reporting backtrace. */
60860eb3 8385
21bf394d
EZ
8386#ifndef CYGWIN
8387static LONG CALLBACK my_exception_handler (EXCEPTION_POINTERS *);
8388static LPTOP_LEVEL_EXCEPTION_FILTER prev_exception_handler;
8389#endif
8390static DWORD except_code;
8391static PVOID except_addr;
cbfedb1c 8392
21bf394d
EZ
8393#ifndef CYGWIN
8394/* This handler records the exception code and the address where it
8395 was triggered so that this info could be included in the backtrace.
8396 Without that, the backtrace in some cases has no information
8397 whatsoever about the offending code, and looks as if the top-level
8398 exception handler in the MinGW startup code di the one that
8399 crashed. */
8400static LONG CALLBACK
8401my_exception_handler (EXCEPTION_POINTERS * exception_data)
8402{
8403 except_code = exception_data->ExceptionRecord->ExceptionCode;
8404 except_addr = exception_data->ExceptionRecord->ExceptionAddress;
8405
8406 if (prev_exception_handler)
8407 return prev_exception_handler (exception_data);
8408 return EXCEPTION_EXECUTE_HANDLER;
9785d95b 8409}
21bf394d 8410#endif
6fc2811b 8411
1005b4b9
EZ
8412typedef USHORT (WINAPI * CaptureStackBackTrace_proc) (ULONG, ULONG, PVOID *,
8413 PULONG);
8414
8415#define BACKTRACE_LIMIT_MAX 62
8416
8417int
8418w32_backtrace (void **buffer, int limit)
8419{
8420 static CaptureStackBackTrace_proc s_pfn_CaptureStackBackTrace = NULL;
8421 HMODULE hm_kernel32 = NULL;
8422
8423 if (!s_pfn_CaptureStackBackTrace)
8424 {
8425 hm_kernel32 = LoadLibrary ("Kernel32.dll");
8426 s_pfn_CaptureStackBackTrace =
8427 (CaptureStackBackTrace_proc) GetProcAddress (hm_kernel32,
8428 "RtlCaptureStackBackTrace");
8429 }
8430 if (s_pfn_CaptureStackBackTrace)
8431 return s_pfn_CaptureStackBackTrace (0, min (BACKTRACE_LIMIT_MAX, limit),
8432 buffer, NULL);
8433 return 0;
8434}
8435
7d0393cf 8436void
1088b922 8437emacs_abort (void)
ee78dc32 8438{
5ac45f98
GV
8439 int button;
8440 button = MessageBox (NULL,
8441 "A fatal error has occurred!\n\n"
c52e1638 8442 "Would you like to attach a debugger?\n\n"
1005b4b9
EZ
8443 "Select:\n"
8444 "YES -- to debug Emacs, or\n"
8445 "NO -- to abort Emacs and produce a backtrace\n"
8446 " (emacs_backtrace.txt in current directory)."
cb91d111
EZ
8447#if __GNUC__
8448 "\n\n(type \"gdb -p <emacs-PID>\" and\n"
8449 "\"continue\" inside GDB before clicking YES.)"
8450#endif
8451 , "Emacs Abort Dialog",
5ac45f98 8452 MB_ICONEXCLAMATION | MB_TASKMODAL
c52e1638 8453 | MB_SETFOREGROUND | MB_YESNO);
5ac45f98
GV
8454 switch (button)
8455 {
c52e1638 8456 case IDYES:
5ac45f98 8457 DebugBreak ();
c52e1638
EZ
8458 exit (2); /* tell the compiler we will never return */
8459 case IDNO:
5ac45f98 8460 default:
1005b4b9
EZ
8461 {
8462 void *stack[BACKTRACE_LIMIT_MAX + 1];
8463 int i = w32_backtrace (stack, BACKTRACE_LIMIT_MAX + 1);
8464
8465 if (i)
8466 {
21bf394d
EZ
8467 int errfile_fd = -1;
8468 int j;
8469 char buf[sizeof ("\r\nException at this address:\r\n\r\n")
39e896c1
EZ
8470 /* The type below should really be 'void *', but
8471 INT_BUFSIZE_BOUND cannot handle that without
8472 triggering compiler warnings (under certain
8473 pedantic warning switches), it wants an
8474 integer type. */
8475 + 2 * INT_BUFSIZE_BOUND (intptr_t)];
c8e3a9c3
EZ
8476#ifdef CYGWIN
8477 int stderr_fd = 2;
8478#else
1005b4b9 8479 HANDLE errout = GetStdHandle (STD_ERROR_HANDLE);
c8e3a9c3 8480 int stderr_fd = -1;
1005b4b9
EZ
8481
8482 if (errout && errout != INVALID_HANDLE_VALUE)
8483 stderr_fd = _open_osfhandle ((intptr_t)errout, O_APPEND | O_BINARY);
c8e3a9c3 8484#endif
21bf394d
EZ
8485
8486 /* We use %p, not 0x%p, as %p produces a leading "0x" on XP,
8487 but not on Windows 7. addr2line doesn't mind a missing
8488 "0x", but will be confused by an extra one. */
8489 if (except_addr)
8490 sprintf (buf, "\r\nException 0x%lx at this address:\r\n%p\r\n",
8491 except_code, except_addr);
1005b4b9 8492 if (stderr_fd >= 0)
21bf394d
EZ
8493 {
8494 if (except_addr)
8495 write (stderr_fd, buf, strlen (buf));
8496 write (stderr_fd, "\r\nBacktrace:\r\n", 14);
8497 }
789b5e9a
KB
8498#ifdef CYGWIN
8499#define _open open
8500#endif
1005b4b9
EZ
8501 errfile_fd = _open ("emacs_backtrace.txt", O_RDWR | O_CREAT | O_BINARY, S_IREAD | S_IWRITE);
8502 if (errfile_fd >= 0)
8503 {
8504 lseek (errfile_fd, 0L, SEEK_END);
21bf394d
EZ
8505 if (except_addr)
8506 write (errfile_fd, buf, strlen (buf));
1005b4b9
EZ
8507 write (errfile_fd, "\r\nBacktrace:\r\n", 14);
8508 }
8509
8510 for (j = 0; j < i; j++)
8511 {
1005b4b9
EZ
8512 /* stack[] gives the return addresses, whereas we want
8513 the address of the call, so decrease each address
8514 by approximate size of 1 CALL instruction. */
21bf394d 8515 sprintf (buf, "%p\r\n", (char *)stack[j] - sizeof(void *));
1005b4b9
EZ
8516 if (stderr_fd >= 0)
8517 write (stderr_fd, buf, strlen (buf));
8518 if (errfile_fd >= 0)
8519 write (errfile_fd, buf, strlen (buf));
8520 }
8521 if (i == BACKTRACE_LIMIT_MAX)
8522 {
8523 if (stderr_fd >= 0)
8524 write (stderr_fd, "...\r\n", 5);
8525 if (errfile_fd >= 0)
8526 write (errfile_fd, "...\r\n", 5);
8527 }
8528 if (errfile_fd >= 0)
8529 close (errfile_fd);
8530 }
8531 abort ();
8532 break;
8533 }
5ac45f98 8534 }
ee78dc32 8535}
819e2da9 8536
21bf394d
EZ
8537\f
8538
8539/* Initialization. */
8540
8541/*
8542 globals_of_w32fns is used to initialize those global variables that
8543 must always be initialized on startup even when the global variable
8544 initialized is non zero (see the function main in emacs.c).
8545 globals_of_w32fns is called from syms_of_w32fns when the global
8546 variable initialized is 0 and directly from main when initialized
8547 is non zero.
8548 */
8549void
8550globals_of_w32fns (void)
8551{
8552 HMODULE user32_lib = GetModuleHandle ("user32.dll");
8553 /*
8554 TrackMouseEvent not available in all versions of Windows, so must load
8555 it dynamically. Do it once, here, instead of every time it is used.
8556 */
8557 track_mouse_event_fn = (TrackMouseEvent_Proc)
8558 GetProcAddress (user32_lib, "TrackMouseEvent");
8559
8560 monitor_from_point_fn = (MonitorFromPoint_Proc)
8561 GetProcAddress (user32_lib, "MonitorFromPoint");
8562 get_monitor_info_fn = (GetMonitorInfo_Proc)
8563 GetProcAddress (user32_lib, "GetMonitorInfoA");
8564 monitor_from_window_fn = (MonitorFromWindow_Proc)
8565 GetProcAddress (user32_lib, "MonitorFromWindow");
8566 enum_display_monitors_fn = (EnumDisplayMonitors_Proc)
8567 GetProcAddress (user32_lib, "EnumDisplayMonitors");
8568
8569 {
8570 HMODULE imm32_lib = GetModuleHandle ("imm32.dll");
8571 get_composition_string_fn = (ImmGetCompositionString_Proc)
8572 GetProcAddress (imm32_lib, "ImmGetCompositionStringW");
8573 get_ime_context_fn = (ImmGetContext_Proc)
8574 GetProcAddress (imm32_lib, "ImmGetContext");
8575 release_ime_context_fn = (ImmReleaseContext_Proc)
8576 GetProcAddress (imm32_lib, "ImmReleaseContext");
8577 set_ime_composition_window_fn = (ImmSetCompositionWindow_Proc)
8578 GetProcAddress (imm32_lib, "ImmSetCompositionWindow");
8579 }
8580
8581 except_code = 0;
8582 except_addr = 0;
8583#ifndef CYGWIN
8584 prev_exception_handler = SetUnhandledExceptionFilter (my_exception_handler);
8585#endif
8586
8587 DEFVAR_INT ("w32-ansi-code-page",
8588 w32_ansi_code_page,
8589 doc: /* The ANSI code page used by the system. */);
8590 w32_ansi_code_page = GetACP ();
8591
8592 if (os_subtype == OS_NT)
8593 w32_unicode_gui = 1;
8594 else
8595 w32_unicode_gui = 0;
8596
8597 /* MessageBox does not work without this when linked to comctl32.dll 6.0. */
8598 InitCommonControls ();
8599
8600 syms_of_w32uniscribe ();
8601}
8602
819e2da9
DC
8603#ifdef NTGUI_UNICODE
8604
8605Lisp_Object
8606ntgui_encode_system (Lisp_Object str)
8607{
8608 Lisp_Object encoded;
8609 to_unicode (str, &encoded);
8610 return encoded;
8611}
8612
8613#endif /* NTGUI_UNICODE */