Truly maximize w32 frames with odd fonts and some texi fixes.
[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
722493d7 2102 memset (keystate, 0, sizeof (keystate));
adcc3809
GV
2103 GetKeyboardState (keystate);
2104 keystate[VK_SHIFT] = CURRENT_STATE (VK_SHIFT);
2105 keystate[VK_CONTROL] = CURRENT_STATE (VK_CONTROL);
2106 keystate[VK_LCONTROL] = CURRENT_STATE (VK_LCONTROL);
2107 keystate[VK_RCONTROL] = CURRENT_STATE (VK_RCONTROL);
2108 keystate[VK_MENU] = CURRENT_STATE (VK_MENU);
2109 keystate[VK_LMENU] = CURRENT_STATE (VK_LMENU);
2110 keystate[VK_RMENU] = CURRENT_STATE (VK_RMENU);
2111 keystate[VK_LWIN] = CURRENT_STATE (VK_LWIN);
2112 keystate[VK_RWIN] = CURRENT_STATE (VK_RWIN);
2113 keystate[VK_APPS] = CURRENT_STATE (VK_APPS);
2114 SetKeyboardState (keystate);
2115 }
da36a4d6
GV
2116}
2117
7830e24b
RS
2118/* Synchronize modifier state with what is reported with the current
2119 keystroke. Even if we cannot distinguish between left and right
2120 modifier keys, we know that, if no modifiers are set, then neither
2121 the left or right modifier should be set. */
2122static void
b56ceb92 2123sync_modifiers (void)
7830e24b
RS
2124{
2125 if (!modifiers_recorded)
2126 return;
2127
7d0393cf 2128 if (!(GetKeyState (VK_CONTROL) & 0x8000))
7830e24b
RS
2129 modifiers[EMACS_RCONTROL] = modifiers[EMACS_LCONTROL] = 0;
2130
7d0393cf 2131 if (!(GetKeyState (VK_MENU) & 0x8000))
7830e24b
RS
2132 modifiers[EMACS_RMENU] = modifiers[EMACS_LMENU] = 0;
2133}
2134
a1a80b40
GV
2135static int
2136modifier_set (int vkey)
2137{
88002743
EZ
2138 /* Warning: The fact that VK_NUMLOCK is not treated as the other 2
2139 toggle keys is not an omission! If you want to add it, you will
2140 have to make changes in the default sub-case of the WM_KEYDOWN
2141 switch, because if the NUMLOCK modifier is set, the code there
2142 will directly convert any key that looks like an ASCII letter,
2143 and also downcase those that look like upper-case ASCII. */
dab72075
EZ
2144 if (vkey == VK_CAPITAL)
2145 {
2146 if (NILP (Vw32_enable_caps_lock))
2147 return 0;
2148 else
2149 return (GetKeyState (vkey) & 0x1);
2150 }
2151 if (vkey == VK_SCROLL)
2152 {
88002743
EZ
2153 if (NILP (Vw32_scroll_lock_modifier)
2154 /* w32-scroll-lock-modifier can be any non-nil value that is
2155 not one of the modifiers, in which case it shall be ignored. */
2156 || !( EQ (Vw32_scroll_lock_modifier, Qhyper)
2157 || EQ (Vw32_scroll_lock_modifier, Qsuper)
2158 || EQ (Vw32_scroll_lock_modifier, Qmeta)
2159 || EQ (Vw32_scroll_lock_modifier, Qalt)
2160 || EQ (Vw32_scroll_lock_modifier, Qcontrol)
2161 || EQ (Vw32_scroll_lock_modifier, Qshift)))
dab72075
EZ
2162 return 0;
2163 else
2164 return (GetKeyState (vkey) & 0x1);
2165 }
dab72075 2166
a1a80b40
GV
2167 if (!modifiers_recorded)
2168 return (GetKeyState (vkey) & 0x8000);
2169
2170 switch (vkey)
2171 {
2172 case VK_LCONTROL:
2173 return modifiers[EMACS_LCONTROL];
2174 case VK_RCONTROL:
2175 return modifiers[EMACS_RCONTROL];
2176 case VK_LMENU:
2177 return modifiers[EMACS_LMENU];
2178 case VK_RMENU:
2179 return modifiers[EMACS_RMENU];
a1a80b40
GV
2180 }
2181 return (GetKeyState (vkey) & 0x8000);
2182}
2183
ccc2d29c
GV
2184/* Convert between the modifier bits W32 uses and the modifier bits
2185 Emacs uses. */
2186
2187unsigned int
2188w32_key_to_modifier (int key)
2189{
2190 Lisp_Object key_mapping;
2191
2192 switch (key)
2193 {
2194 case VK_LWIN:
2195 key_mapping = Vw32_lwindow_modifier;
2196 break;
2197 case VK_RWIN:
2198 key_mapping = Vw32_rwindow_modifier;
2199 break;
2200 case VK_APPS:
2201 key_mapping = Vw32_apps_modifier;
2202 break;
2203 case VK_SCROLL:
2204 key_mapping = Vw32_scroll_lock_modifier;
2205 break;
2206 default:
2207 key_mapping = Qnil;
2208 }
2209
91af3942 2210 /* NB. This code runs in the input thread, asynchronously to the lisp
adcc3809
GV
2211 thread, so we must be careful to ensure access to lisp data is
2212 thread-safe. The following code is safe because the modifier
2213 variable values are updated atomically from lisp and symbols are
2214 not relocated by GC. Also, we don't have to worry about seeing GC
2215 markbits here. */
2216 if (EQ (key_mapping, Qhyper))
ccc2d29c 2217 return hyper_modifier;
adcc3809 2218 if (EQ (key_mapping, Qsuper))
ccc2d29c 2219 return super_modifier;
adcc3809 2220 if (EQ (key_mapping, Qmeta))
ccc2d29c 2221 return meta_modifier;
adcc3809 2222 if (EQ (key_mapping, Qalt))
ccc2d29c 2223 return alt_modifier;
adcc3809 2224 if (EQ (key_mapping, Qctrl))
ccc2d29c 2225 return ctrl_modifier;
adcc3809 2226 if (EQ (key_mapping, Qcontrol)) /* synonym for ctrl */
ccc2d29c 2227 return ctrl_modifier;
adcc3809 2228 if (EQ (key_mapping, Qshift))
ccc2d29c
GV
2229 return shift_modifier;
2230
2231 /* Don't generate any modifier if not explicitly requested. */
2232 return 0;
2233}
2234
74084731 2235static unsigned int
b56ceb92 2236w32_get_modifiers (void)
ccc2d29c
GV
2237{
2238 return ((modifier_set (VK_SHIFT) ? shift_modifier : 0) |
2239 (modifier_set (VK_CONTROL) ? ctrl_modifier : 0) |
2240 (modifier_set (VK_LWIN) ? w32_key_to_modifier (VK_LWIN) : 0) |
2241 (modifier_set (VK_RWIN) ? w32_key_to_modifier (VK_RWIN) : 0) |
2242 (modifier_set (VK_APPS) ? w32_key_to_modifier (VK_APPS) : 0) |
2243 (modifier_set (VK_SCROLL) ? w32_key_to_modifier (VK_SCROLL) : 0) |
2244 (modifier_set (VK_MENU) ?
2245 ((NILP (Vw32_alt_is_meta)) ? alt_modifier : meta_modifier) : 0));
2246}
2247
a1a80b40
GV
2248/* We map the VK_* modifiers into console modifier constants
2249 so that we can use the same routines to handle both console
2250 and window input. */
2251
2252static int
b56ceb92 2253construct_console_modifiers (void)
a1a80b40
GV
2254{
2255 int mods;
2256
a1a80b40
GV
2257 mods = 0;
2258 mods |= (modifier_set (VK_SHIFT)) ? SHIFT_PRESSED : 0;
2259 mods |= (modifier_set (VK_CAPITAL)) ? CAPSLOCK_ON : 0;
ccc2d29c
GV
2260 mods |= (modifier_set (VK_SCROLL)) ? SCROLLLOCK_ON : 0;
2261 mods |= (modifier_set (VK_NUMLOCK)) ? NUMLOCK_ON : 0;
a1a80b40
GV
2262 mods |= (modifier_set (VK_LCONTROL)) ? LEFT_CTRL_PRESSED : 0;
2263 mods |= (modifier_set (VK_RCONTROL)) ? RIGHT_CTRL_PRESSED : 0;
2264 mods |= (modifier_set (VK_LMENU)) ? LEFT_ALT_PRESSED : 0;
2265 mods |= (modifier_set (VK_RMENU)) ? RIGHT_ALT_PRESSED : 0;
ccc2d29c
GV
2266 mods |= (modifier_set (VK_LWIN)) ? LEFT_WIN_PRESSED : 0;
2267 mods |= (modifier_set (VK_RWIN)) ? RIGHT_WIN_PRESSED : 0;
2268 mods |= (modifier_set (VK_APPS)) ? APPS_PRESSED : 0;
a1a80b40
GV
2269
2270 return mods;
2271}
2272
ccc2d29c
GV
2273static int
2274w32_get_key_modifiers (unsigned int wparam, unsigned int lparam)
da36a4d6 2275{
ccc2d29c
GV
2276 int mods;
2277
2278 /* Convert to emacs modifiers. */
2279 mods = w32_kbd_mods_to_emacs (construct_console_modifiers (), wparam);
2280
2281 return mods;
2282}
da36a4d6 2283
ccc2d29c
GV
2284unsigned int
2285map_keypad_keys (unsigned int virt_key, unsigned int extended)
2286{
2287 if (virt_key < VK_CLEAR || virt_key > VK_DELETE)
2288 return virt_key;
da36a4d6 2289
ccc2d29c 2290 if (virt_key == VK_RETURN)
da36a4d6
GV
2291 return (extended ? VK_NUMPAD_ENTER : VK_RETURN);
2292
ccc2d29c
GV
2293 if (virt_key >= VK_PRIOR && virt_key <= VK_DOWN)
2294 return (!extended ? (VK_NUMPAD_PRIOR + (virt_key - VK_PRIOR)) : virt_key);
2295
2296 if (virt_key == VK_INSERT || virt_key == VK_DELETE)
2297 return (!extended ? (VK_NUMPAD_INSERT + (virt_key - VK_INSERT)) : virt_key);
2298
2299 if (virt_key == VK_CLEAR)
2300 return (!extended ? VK_NUMPAD_CLEAR : virt_key);
2301
2302 return virt_key;
2303}
2304
2305/* List of special key combinations which w32 would normally capture,
74084731 2306 but Emacs should grab instead. Not directly visible to lisp, to
ccc2d29c
GV
2307 simplify synchronization. Each item is an integer encoding a virtual
2308 key code and modifier combination to capture. */
74084731 2309static Lisp_Object w32_grabbed_keys;
ccc2d29c 2310
74084731 2311#define HOTKEY(vk, mods) make_number (((vk) & 255) | ((mods) << 8))
ccc2d29c
GV
2312#define HOTKEY_ID(k) (XFASTINT (k) & 0xbfff)
2313#define HOTKEY_VK_CODE(k) (XFASTINT (k) & 255)
2314#define HOTKEY_MODIFIERS(k) (XFASTINT (k) >> 8)
2315
2ba49441
JR
2316#define RAW_HOTKEY_ID(k) ((k) & 0xbfff)
2317#define RAW_HOTKEY_VK_CODE(k) ((k) & 255)
2318#define RAW_HOTKEY_MODIFIERS(k) ((k) >> 8)
2319
ccc2d29c
GV
2320/* Register hot-keys for reserved key combinations when Emacs has
2321 keyboard focus, since this is the only way Emacs can receive key
2322 combinations like Alt-Tab which are used by the system. */
2323
2324static void
b56ceb92 2325register_hot_keys (HWND hwnd)
ccc2d29c
GV
2326{
2327 Lisp_Object keylist;
2328
8e50cc2d
SM
2329 /* Use CONSP, since we are called asynchronously. */
2330 for (keylist = w32_grabbed_keys; CONSP (keylist); keylist = XCDR (keylist))
ccc2d29c
GV
2331 {
2332 Lisp_Object key = XCAR (keylist);
2333
2334 /* Deleted entries get set to nil. */
2335 if (!INTEGERP (key))
2336 continue;
2337
2338 RegisterHotKey (hwnd, HOTKEY_ID (key),
2339 HOTKEY_MODIFIERS (key), HOTKEY_VK_CODE (key));
2340 }
2341}
2342
2343static void
b56ceb92 2344unregister_hot_keys (HWND hwnd)
ccc2d29c
GV
2345{
2346 Lisp_Object keylist;
2347
8e50cc2d 2348 for (keylist = w32_grabbed_keys; CONSP (keylist); keylist = XCDR (keylist))
ccc2d29c
GV
2349 {
2350 Lisp_Object key = XCAR (keylist);
2351
2352 if (!INTEGERP (key))
2353 continue;
2354
2355 UnregisterHotKey (hwnd, HOTKEY_ID (key));
2356 }
2357}
2358
0fda9b75
DC
2359#if EMACSDEBUG
2360const char*
2361w32_name_of_message (UINT msg)
2362{
2363 unsigned i;
2364 static char buf[64];
2365 static const struct {
2366 UINT msg;
2367 const char* name;
2368 } msgnames[] = {
2369#define M(msg) { msg, # msg }
2370 M (WM_PAINT),
2371 M (WM_TIMER),
2372 M (WM_USER),
2373 M (WM_MOUSEMOVE),
2374 M (WM_LBUTTONUP),
2375 M (WM_KEYDOWN),
2376 M (WM_EMACS_KILL),
2377 M (WM_EMACS_CREATEWINDOW),
2378 M (WM_EMACS_DONE),
2379 M (WM_EMACS_CREATESCROLLBAR),
2380 M (WM_EMACS_SHOWWINDOW),
2381 M (WM_EMACS_SETWINDOWPOS),
2382 M (WM_EMACS_DESTROYWINDOW),
2383 M (WM_EMACS_TRACKPOPUPMENU),
2384 M (WM_EMACS_SETFOCUS),
2385 M (WM_EMACS_SETFOREGROUND),
2386 M (WM_EMACS_SETLOCALE),
2387 M (WM_EMACS_SETKEYBOARDLAYOUT),
2388 M (WM_EMACS_REGISTER_HOT_KEY),
2389 M (WM_EMACS_UNREGISTER_HOT_KEY),
2390 M (WM_EMACS_TOGGLE_LOCK_KEY),
2391 M (WM_EMACS_TRACK_CARET),
2392 M (WM_EMACS_DESTROY_CARET),
2393 M (WM_EMACS_SHOW_CARET),
2394 M (WM_EMACS_HIDE_CARET),
2395 M (WM_EMACS_SETCURSOR),
2396 M (WM_EMACS_PAINT),
2397 M (WM_CHAR),
2398#undef M
2399 { 0, 0 }
2400 };
2401
2402 for (i = 0; msgnames[i].name; ++i)
2403 if (msgnames[i].msg == msg)
2404 return msgnames[i].name;
2405
2406 sprintf (buf, "message 0x%04x", (unsigned)msg);
2407 return buf;
2408}
2409#endif /* EMACSDEBUG */
2410
605a3df6
EZ
2411/* Here's an overview of how Emacs input works in GUI sessions on
2412 MS-Windows. (For description of non-GUI input, see the commentary
2413 before w32_console_read_socket in w32inevt.c.)
d263a633
EZ
2414
2415 System messages are read and processed by w32_msg_pump below. This
2416 function runs in a separate thread. It handles a small number of
2417 custom WM_EMACS_* messages (posted by the main thread, look for
2418 PostMessage calls), and dispatches the rest to w32_wnd_proc, which
2419 is the main window procedure for the entire Emacs application.
2420
2421 w32_wnd_proc also runs in the same separate input thread. It
2422 handles some messages, mostly those that need GDI calls, by itself.
2423 For the others, it calls my_post_msg, which inserts the messages
2424 into the input queue serviced by w32_read_socket.
2425
2426 w32_read_socket runs in the main (a.k.a. "Lisp") thread, and is
2427 called synchronously from keyboard.c when it is known or suspected
2428 that some input is available. w32_read_socket either handles
17917e74
EZ
2429 messages immediately, or converts them into Emacs input events and
2430 stuffs them into kbd_buffer, where kbd_buffer_get_event can get at
2431 them and process them when read_char and its callers require
36a305a7
DC
2432 input.
2433
2434 Under Cygwin with the W32 toolkit, the use of /dev/windows with
2435 select(2) takes the place of w32_read_socket.
2436
2437 */
d263a633 2438
5ac45f98
GV
2439/* Main message dispatch loop. */
2440
1edf84e7
GV
2441static void
2442w32_msg_pump (deferred_msg * msg_buf)
5ac45f98
GV
2443{
2444 MSG msg;
62aba0d4 2445 WPARAM result;
ccc2d29c 2446 HWND focus_window;
93fbe8b7
GV
2447
2448 msh_mousewheel = RegisterWindowMessage (MSH_MOUSEWHEEL);
7d0393cf 2449
9b855fd6 2450 while ((w32_unicode_gui ? GetMessageW : GetMessageA) (&msg, NULL, 0, 0))
5ac45f98 2451 {
0fda9b75
DC
2452
2453 /* DebPrint (("w32_msg_pump: %s time:%u\n", */
2454 /* w32_name_of_message (msg.message), msg.time)); */
2455
5ac45f98
GV
2456 if (msg.hwnd == NULL)
2457 {
2458 switch (msg.message)
2459 {
3ef68e6b
AI
2460 case WM_NULL:
2461 /* Produced by complete_deferred_msg; just ignore. */
2462 break;
5ac45f98 2463 case WM_EMACS_CREATEWINDOW:
d5781bb6
JR
2464 /* Initialize COM for this window. Even though we don't use it,
2465 some third party shell extensions can cause it to be used in
2466 system dialogs, which causes a crash if it is not initialized.
2467 This is a known bug in Windows, which was fixed long ago, but
e1dbe924 2468 the patch for XP is not publicly available until XP SP3,
d5781bb6
JR
2469 and older versions will never be patched. */
2470 CoInitialize (NULL);
fbd6baed 2471 w32_createwindow ((struct frame *) msg.wParam);
1edf84e7 2472 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
1088b922 2473 emacs_abort ();
5ac45f98 2474 break;
dfdb4047
GV
2475 case WM_EMACS_SETLOCALE:
2476 SetThreadLocale (msg.wParam);
2477 /* Reply is not expected. */
2478 break;
ccc2d29c 2479 case WM_EMACS_SETKEYBOARDLAYOUT:
62aba0d4 2480 result = (WPARAM) ActivateKeyboardLayout ((HKL) msg.wParam, 0);
ccc2d29c
GV
2481 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE,
2482 result, 0))
1088b922 2483 emacs_abort ();
ccc2d29c
GV
2484 break;
2485 case WM_EMACS_REGISTER_HOT_KEY:
2486 focus_window = GetFocus ();
2487 if (focus_window != NULL)
2488 RegisterHotKey (focus_window,
2ba49441
JR
2489 RAW_HOTKEY_ID (msg.wParam),
2490 RAW_HOTKEY_MODIFIERS (msg.wParam),
2491 RAW_HOTKEY_VK_CODE (msg.wParam));
ccc2d29c
GV
2492 /* Reply is not expected. */
2493 break;
2494 case WM_EMACS_UNREGISTER_HOT_KEY:
2495 focus_window = GetFocus ();
2496 if (focus_window != NULL)
2ba49441 2497 UnregisterHotKey (focus_window, RAW_HOTKEY_ID (msg.wParam));
adcc3809
GV
2498 /* Mark item as erased. NB: this code must be
2499 thread-safe. The next line is okay because the cons
2500 cell is never made into garbage and is not relocated by
2501 GC. */
fcf14875 2502 XSETCAR (XIL ((EMACS_INT) msg.lParam), Qnil);
ccc2d29c 2503 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
1088b922 2504 emacs_abort ();
ccc2d29c 2505 break;
adcc3809
GV
2506 case WM_EMACS_TOGGLE_LOCK_KEY:
2507 {
2508 int vk_code = (int) msg.wParam;
2509 int cur_state = (GetKeyState (vk_code) & 1);
fcf14875 2510 Lisp_Object new_state = XIL ((EMACS_INT) msg.lParam);
adcc3809
GV
2511
2512 /* NB: This code must be thread-safe. It is safe to
2513 call NILP because symbols are not relocated by GC,
2514 and pointer here is not touched by GC (so the markbit
2515 can't be set). Numbers are safe because they are
2516 immediate values. */
2517 if (NILP (new_state)
2518 || (NUMBERP (new_state)
8edb0a6f 2519 && ((XUINT (new_state)) & 1) != cur_state))
adcc3809
GV
2520 {
2521 one_w32_display_info.faked_key = vk_code;
2522
2523 keybd_event ((BYTE) vk_code,
2524 (BYTE) MapVirtualKey (vk_code, 0),
2525 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
2526 keybd_event ((BYTE) vk_code,
2527 (BYTE) MapVirtualKey (vk_code, 0),
2528 KEYEVENTF_EXTENDEDKEY | 0, 0);
2529 keybd_event ((BYTE) vk_code,
2530 (BYTE) MapVirtualKey (vk_code, 0),
2531 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
2532 cur_state = !cur_state;
2533 }
2534 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE,
2535 cur_state, 0))
1088b922 2536 emacs_abort ();
adcc3809
GV
2537 }
2538 break;
5dff811e
JR
2539#ifdef MSG_DEBUG
2540 /* Broadcast messages make it here, so you need to be looking
2541 for something in particular for this to be useful. */
1edf84e7 2542 default:
0fda9b75 2543 DebPrint (("msg %x not expected by w32_msg_pump\n", msg.message));
5dff811e 2544#endif
5ac45f98
GV
2545 }
2546 }
2547 else
2548 {
9b855fd6 2549 if (w32_unicode_gui)
d30be705
EZ
2550 DispatchMessageW (&msg);
2551 else
2552 DispatchMessageA (&msg);
5ac45f98 2553 }
1edf84e7
GV
2554
2555 /* Exit nested loop when our deferred message has completed. */
2556 if (msg_buf->completed)
2557 break;
5ac45f98 2558 }
1edf84e7
GV
2559}
2560
2561deferred_msg * deferred_msg_head;
2562
2563static deferred_msg *
2564find_deferred_msg (HWND hwnd, UINT msg)
2565{
2566 deferred_msg * item;
2567
2568 /* Don't actually need synchronization for read access, since
2569 modification of single pointer is always atomic. */
2570 /* enter_crit (); */
2571
2572 for (item = deferred_msg_head; item != NULL; item = item->next)
2573 if (item->w32msg.msg.hwnd == hwnd
2574 && item->w32msg.msg.message == msg)
2575 break;
2576
2577 /* leave_crit (); */
2578
2579 return item;
2580}
2581
2582static LRESULT
2583send_deferred_msg (deferred_msg * msg_buf,
2584 HWND hwnd,
2585 UINT msg,
2586 WPARAM wParam,
2587 LPARAM lParam)
2588{
2589 /* Only input thread can send deferred messages. */
2590 if (GetCurrentThreadId () != dwWindowsThreadId)
1088b922 2591 emacs_abort ();
1edf84e7
GV
2592
2593 /* It is an error to send a message that is already deferred. */
2594 if (find_deferred_msg (hwnd, msg) != NULL)
1088b922 2595 emacs_abort ();
1edf84e7
GV
2596
2597 /* Enforced synchronization is not needed because this is the only
2598 function that alters deferred_msg_head, and the following critical
2599 section is guaranteed to only be serially reentered (since only the
2600 input thread can call us). */
2601
2602 /* enter_crit (); */
2603
2604 msg_buf->completed = 0;
2605 msg_buf->next = deferred_msg_head;
2606 deferred_msg_head = msg_buf;
2607 my_post_msg (&msg_buf->w32msg, hwnd, msg, wParam, lParam);
2608
2609 /* leave_crit (); */
2610
2611 /* Start a new nested message loop to process other messages until
2612 this one is completed. */
2613 w32_msg_pump (msg_buf);
2614
2615 deferred_msg_head = msg_buf->next;
2616
2617 return msg_buf->result;
2618}
2619
2620void
2621complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result)
2622{
2623 deferred_msg * msg_buf = find_deferred_msg (hwnd, msg);
2624
2625 if (msg_buf == NULL)
c80e3b4a 2626 /* Message may have been canceled, so don't abort. */
3ef68e6b 2627 return;
1edf84e7
GV
2628
2629 msg_buf->result = result;
2630 msg_buf->completed = 1;
2631
2632 /* Ensure input thread is woken so it notices the completion. */
2633 PostThreadMessage (dwWindowsThreadId, WM_NULL, 0, 0);
2634}
2635
74084731 2636static void
b56ceb92 2637cancel_all_deferred_msgs (void)
3ef68e6b
AI
2638{
2639 deferred_msg * item;
2640
2641 /* Don't actually need synchronization for read access, since
2642 modification of single pointer is always atomic. */
2643 /* enter_crit (); */
2644
2645 for (item = deferred_msg_head; item != NULL; item = item->next)
2646 {
2647 item->result = 0;
2648 item->completed = 1;
2649 }
2650
2651 /* leave_crit (); */
2652
2653 /* Ensure input thread is woken so it notices the completion. */
2654 PostThreadMessage (dwWindowsThreadId, WM_NULL, 0, 0);
2655}
1edf84e7 2656
992dfd90
JR
2657DWORD WINAPI
2658w32_msg_worker (void *arg)
1edf84e7
GV
2659{
2660 MSG msg;
2661 deferred_msg dummy_buf;
2662
2663 /* Ensure our message queue is created */
7d0393cf 2664
1edf84e7 2665 PeekMessage (&msg, NULL, 0, 0, PM_NOREMOVE);
7d0393cf 2666
1edf84e7 2667 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
1088b922 2668 emacs_abort ();
1edf84e7
GV
2669
2670 memset (&dummy_buf, 0, sizeof (dummy_buf));
2671 dummy_buf.w32msg.msg.hwnd = NULL;
2672 dummy_buf.w32msg.msg.message = WM_NULL;
2673
23f250f4 2674 /* This is the initial message loop which should only exit when the
1edf84e7
GV
2675 application quits. */
2676 w32_msg_pump (&dummy_buf);
2677
2678 return 0;
5ac45f98
GV
2679}
2680
f0c947b5 2681static void
b56ceb92 2682signal_user_input (void)
f0c947b5
JR
2683{
2684 /* Interrupt any lisp that wants to be interrupted by input. */
2685 if (!NILP (Vthrow_on_input))
2686 {
2687 Vquit_flag = Vthrow_on_input;
c85efaf7
EZ
2688 /* Doing a QUIT from this thread is a bad idea, since this
2689 unwinds the stack of the Lisp thread, and the Windows runtime
2690 rightfully barfs. Disabled. */
2691#if 0
f0c947b5
JR
2692 /* If we're inside a function that wants immediate quits,
2693 do it now. */
2694 if (immediate_quit && NILP (Vinhibit_quit))
2695 {
2696 immediate_quit = 0;
2697 QUIT;
2698 }
c85efaf7 2699#endif
f0c947b5
JR
2700 }
2701}
2702
2703
3ef68e6b 2704static void
b56ceb92
JB
2705post_character_message (HWND hwnd, UINT msg,
2706 WPARAM wParam, LPARAM lParam,
2707 DWORD modifiers)
3ef68e6b
AI
2708{
2709 W32Msg wmsg;
2710
2711 wmsg.dwModifiers = modifiers;
2712
2713 /* Detect quit_char and set quit-flag directly. Note that we
2714 still need to post a message to ensure the main thread will be
74084731 2715 woken up if blocked in sys_select, but we do NOT want to post
3ef68e6b
AI
2716 the quit_char message itself (because it will usually be as if
2717 the user had typed quit_char twice). Instead, we post a dummy
7d7e0027 2718 message that has no particular effect. */
3ef68e6b
AI
2719 {
2720 int c = wParam;
2721 if (isalpha (c) && wmsg.dwModifiers == ctrl_modifier)
2722 c = make_ctrl_char (c) & 0377;
7d081355 2723 if (c == quit_char
7d7e0027
SM
2724 || (wmsg.dwModifiers == 0
2725 && w32_quit_key && wParam == w32_quit_key))
3ef68e6b
AI
2726 {
2727 Vquit_flag = Qt;
2728
2729 /* The choice of message is somewhat arbitrary, as long as
7d7e0027 2730 the main thread handler just ignores it. */
3ef68e6b
AI
2731 msg = WM_NULL;
2732
2733 /* Interrupt any blocking system calls. */
2734 signal_quit ();
2735
2736 /* As a safety precaution, forcibly complete any deferred
2737 messages. This is a kludge, but I don't see any particularly
2738 clean way to handle the situation where a deferred message is
2739 "dropped" in the lisp thread, and will thus never be
2740 completed, eg. by the user trying to activate the menubar
2741 when the lisp thread is busy, and then typing C-g when the
2742 menubar doesn't open promptly (with the result that the
2743 menubar never responds at all because the deferred
2744 WM_INITMENU message is never completed). Another problem
2745 situation is when the lisp thread calls SendMessage (to send
2746 a window manager command) when a message has been deferred;
2747 the lisp thread gets blocked indefinitely waiting for the
2748 deferred message to be completed, which itself is waiting for
2749 the lisp thread to respond.
2750
2751 Note that we don't want to block the input thread waiting for
c80e3b4a 2752 a response from the lisp thread (although that would at least
3ef68e6b
AI
2753 solve the deadlock problem above), because we want to be able
2754 to receive C-g to interrupt the lisp thread. */
2755 cancel_all_deferred_msgs ();
2756 }
f0c947b5
JR
2757 else
2758 signal_user_input ();
3ef68e6b
AI
2759 }
2760
2761 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2762}
2763
ee78dc32
GV
2764/* Main window procedure */
2765
24f981c9 2766static LRESULT CALLBACK
b56ceb92 2767w32_wnd_proc (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
ee78dc32
GV
2768{
2769 struct frame *f;
fbd6baed
GV
2770 struct w32_display_info *dpyinfo = &one_w32_display_info;
2771 W32Msg wmsg;
84fb1139 2772 int windows_translate;
576ba81c 2773 int key;
84fb1139 2774
a6085637
KH
2775 /* Note that it is okay to call x_window_to_frame, even though we are
2776 not running in the main lisp thread, because frame deletion
2777 requires the lisp thread to synchronize with this thread. Thus, if
2778 a frame struct is returned, it can be used without concern that the
2779 lisp thread might make it disappear while we are using it.
2780
2781 NB. Walking the frame list in this thread is safe (as long as
2782 writes of Lisp_Object slots are atomic, which they are on Windows).
2783 Although delete-frame can destructively modify the frame list while
2784 we are walking it, a garbage collection cannot occur until after
2785 delete-frame has synchronized with this thread.
2786
2787 It is also safe to use functions that make GDI calls, such as
fbd6baed 2788 w32_clear_rect, because these functions must obtain a DC handle
a6085637
KH
2789 from the frame struct using get_frame_dc which is thread-aware. */
2790
7d0393cf 2791 switch (msg)
ee78dc32
GV
2792 {
2793 case WM_ERASEBKGND:
a6085637
KH
2794 f = x_window_to_frame (dpyinfo, hwnd);
2795 if (f)
2796 {
9badad41 2797 HDC hdc = get_frame_dc (f);
a6085637 2798 GetUpdateRect (hwnd, &wmsg.rect, FALSE);
9badad41
JR
2799 w32_clear_rect (f, hdc, &wmsg.rect);
2800 release_frame_dc (f, hdc);
ce6059da
AI
2801
2802#if defined (W32_DEBUG_DISPLAY)
18f0b342
AI
2803 DebPrint (("WM_ERASEBKGND (frame %p): erasing %d,%d-%d,%d\n",
2804 f,
2805 wmsg.rect.left, wmsg.rect.top,
2806 wmsg.rect.right, wmsg.rect.bottom));
ce6059da 2807#endif /* W32_DEBUG_DISPLAY */
a6085637 2808 }
5ac45f98
GV
2809 return 1;
2810 case WM_PALETTECHANGED:
2811 /* ignore our own changes */
2812 if ((HWND)wParam != hwnd)
2813 {
a6085637
KH
2814 f = x_window_to_frame (dpyinfo, hwnd);
2815 if (f)
2816 /* get_frame_dc will realize our palette and force all
2817 frames to be redrawn if needed. */
2818 release_frame_dc (f, get_frame_dc (f));
5ac45f98
GV
2819 }
2820 return 0;
ee78dc32 2821 case WM_PAINT:
ce6059da 2822 {
55dcfc15
AI
2823 PAINTSTRUCT paintStruct;
2824 RECT update_rect;
72af86bd 2825 memset (&update_rect, 0, sizeof (update_rect));
55dcfc15 2826
18f0b342
AI
2827 f = x_window_to_frame (dpyinfo, hwnd);
2828 if (f == 0)
2829 {
2830 DebPrint (("WM_PAINT received for unknown window %p\n", hwnd));
2831 return 0;
2832 }
2833
55dcfc15
AI
2834 /* MSDN Docs say not to call BeginPaint if GetUpdateRect
2835 fails. Apparently this can happen under some
2836 circumstances. */
aa35b6ad 2837 if (GetUpdateRect (hwnd, &update_rect, FALSE) || !w32_strict_painting)
55dcfc15
AI
2838 {
2839 enter_crit ();
2840 BeginPaint (hwnd, &paintStruct);
2841
aa35b6ad
JR
2842 /* The rectangles returned by GetUpdateRect and BeginPaint
2843 do not always match. Play it safe by assuming both areas
2844 are invalid. */
2845 UnionRect (&(wmsg.rect), &update_rect, &(paintStruct.rcPaint));
55dcfc15
AI
2846
2847#if defined (W32_DEBUG_DISPLAY)
18f0b342
AI
2848 DebPrint (("WM_PAINT (frame %p): painting %d,%d-%d,%d\n",
2849 f,
2850 wmsg.rect.left, wmsg.rect.top,
2851 wmsg.rect.right, wmsg.rect.bottom));
2852 DebPrint ((" [update region is %d,%d-%d,%d]\n",
55dcfc15
AI
2853 update_rect.left, update_rect.top,
2854 update_rect.right, update_rect.bottom));
2855#endif
2856 EndPaint (hwnd, &paintStruct);
2857 leave_crit ();
2858
f7b146dc
JR
2859 /* Change the message type to prevent Windows from
2860 combining WM_PAINT messages in the Lisp thread's queue,
2861 since Windows assumes that each message queue is
2862 dedicated to one frame and does not bother checking
2863 that hwnd matches before combining them. */
2864 my_post_msg (&wmsg, hwnd, WM_EMACS_PAINT, wParam, lParam);
7d0393cf 2865
55dcfc15
AI
2866 return 0;
2867 }
c0611964
AI
2868
2869 /* If GetUpdateRect returns 0 (meaning there is no update
2870 region), assume the whole window needs to be repainted. */
74084731 2871 GetClientRect (hwnd, &wmsg.rect);
c0611964
AI
2872 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2873 return 0;
ee78dc32 2874 }
a1a80b40 2875
ccc2d29c
GV
2876 case WM_INPUTLANGCHANGE:
2877 /* Inform lisp thread of keyboard layout changes. */
2878 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2879
2880 /* Clear dead keys in the keyboard state; for simplicity only
2881 preserve modifier key states. */
2882 {
2883 int i;
2884 BYTE keystate[256];
2885
2886 GetKeyboardState (keystate);
2887 for (i = 0; i < 256; i++)
2888 if (1
2889 && i != VK_SHIFT
2890 && i != VK_LSHIFT
2891 && i != VK_RSHIFT
2892 && i != VK_CAPITAL
2893 && i != VK_NUMLOCK
2894 && i != VK_SCROLL
2895 && i != VK_CONTROL
2896 && i != VK_LCONTROL
2897 && i != VK_RCONTROL
2898 && i != VK_MENU
2899 && i != VK_LMENU
2900 && i != VK_RMENU
2901 && i != VK_LWIN
2902 && i != VK_RWIN)
2903 keystate[i] = 0;
2904 SetKeyboardState (keystate);
2905 }
2906 goto dflt;
2907
2908 case WM_HOTKEY:
2909 /* Synchronize hot keys with normal input. */
2910 PostMessage (hwnd, WM_KEYDOWN, HIWORD (lParam), 0);
2911 return (0);
2912
a1a80b40
GV
2913 case WM_KEYUP:
2914 case WM_SYSKEYUP:
2915 record_keyup (wParam, lParam);
2916 goto dflt;
2917
ee78dc32
GV
2918 case WM_KEYDOWN:
2919 case WM_SYSKEYDOWN:
ccc2d29c
GV
2920 /* Ignore keystrokes we fake ourself; see below. */
2921 if (dpyinfo->faked_key == wParam)
2922 {
2923 dpyinfo->faked_key = 0;
576ba81c
AI
2924 /* Make sure TranslateMessage sees them though (as long as
2925 they don't produce WM_CHAR messages). This ensures that
2926 indicator lights are toggled promptly on Windows 9x, for
2927 example. */
bf254037 2928 if (wParam < 256 && lispy_function_keys[wParam])
576ba81c
AI
2929 {
2930 windows_translate = 1;
2931 goto translate;
2932 }
2933 return 0;
ccc2d29c
GV
2934 }
2935
7830e24b
RS
2936 /* Synchronize modifiers with current keystroke. */
2937 sync_modifiers ();
a1a80b40 2938 record_keydown (wParam, lParam);
ccc2d29c 2939 wParam = map_keypad_keys (wParam, (lParam & 0x1000000L) != 0);
84fb1139
KH
2940
2941 windows_translate = 0;
ccc2d29c
GV
2942
2943 switch (wParam)
2944 {
2945 case VK_LWIN:
2946 if (NILP (Vw32_pass_lwindow_to_system))
2947 {
2948 /* Prevent system from acting on keyup (which opens the
2949 Start menu if no other key was pressed) by simulating a
2950 press of Space which we will ignore. */
2951 if (GetAsyncKeyState (wParam) & 1)
2952 {
adcc3809 2953 if (NUMBERP (Vw32_phantom_key_code))
576ba81c 2954 key = XUINT (Vw32_phantom_key_code) & 255;
adcc3809 2955 else
576ba81c
AI
2956 key = VK_SPACE;
2957 dpyinfo->faked_key = key;
2958 keybd_event (key, (BYTE) MapVirtualKey (key, 0), 0, 0);
ccc2d29c
GV
2959 }
2960 }
2961 if (!NILP (Vw32_lwindow_modifier))
2962 return 0;
2963 break;
2964 case VK_RWIN:
2965 if (NILP (Vw32_pass_rwindow_to_system))
2966 {
2967 if (GetAsyncKeyState (wParam) & 1)
2968 {
adcc3809 2969 if (NUMBERP (Vw32_phantom_key_code))
576ba81c 2970 key = XUINT (Vw32_phantom_key_code) & 255;
adcc3809 2971 else
576ba81c
AI
2972 key = VK_SPACE;
2973 dpyinfo->faked_key = key;
2974 keybd_event (key, (BYTE) MapVirtualKey (key, 0), 0, 0);
ccc2d29c
GV
2975 }
2976 }
2977 if (!NILP (Vw32_rwindow_modifier))
2978 return 0;
2979 break;
576ba81c 2980 case VK_APPS:
ccc2d29c
GV
2981 if (!NILP (Vw32_apps_modifier))
2982 return 0;
2983 break;
2984 case VK_MENU:
7d0393cf 2985 if (NILP (Vw32_pass_alt_to_system))
adcc3809
GV
2986 /* Prevent DefWindowProc from activating the menu bar if an
2987 Alt key is pressed and released by itself. */
ccc2d29c 2988 return 0;
84fb1139 2989 windows_translate = 1;
ccc2d29c 2990 break;
7d0393cf 2991 case VK_CAPITAL:
ccc2d29c
GV
2992 /* Decide whether to treat as modifier or function key. */
2993 if (NILP (Vw32_enable_caps_lock))
2994 goto disable_lock_key;
adcc3809
GV
2995 windows_translate = 1;
2996 break;
ccc2d29c
GV
2997 case VK_NUMLOCK:
2998 /* Decide whether to treat as modifier or function key. */
2999 if (NILP (Vw32_enable_num_lock))
3000 goto disable_lock_key;
adcc3809
GV
3001 windows_translate = 1;
3002 break;
ccc2d29c
GV
3003 case VK_SCROLL:
3004 /* Decide whether to treat as modifier or function key. */
3005 if (NILP (Vw32_scroll_lock_modifier))
3006 goto disable_lock_key;
adcc3809
GV
3007 windows_translate = 1;
3008 break;
ccc2d29c 3009 disable_lock_key:
adcc3809
GV
3010 /* Ensure the appropriate lock key state (and indicator light)
3011 remains in the same state. We do this by faking another
3012 press of the relevant key. Apparently, this really is the
3013 only way to toggle the state of the indicator lights. */
3014 dpyinfo->faked_key = wParam;
3015 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3016 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
3017 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3018 KEYEVENTF_EXTENDEDKEY | 0, 0);
3019 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3020 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
3021 /* Ensure indicator lights are updated promptly on Windows 9x
3022 (TranslateMessage apparently does this), after forwarding
3023 input event. */
3024 post_character_message (hwnd, msg, wParam, lParam,
3025 w32_get_key_modifiers (wParam, lParam));
3026 windows_translate = 1;
ccc2d29c 3027 break;
7d0393cf 3028 case VK_CONTROL:
ccc2d29c
GV
3029 case VK_SHIFT:
3030 case VK_PROCESSKEY: /* Generated by IME. */
3031 windows_translate = 1;
3032 break;
adcc3809
GV
3033 case VK_CANCEL:
3034 /* Windows maps Ctrl-Pause (aka Ctrl-Break) into VK_CANCEL,
3035 which is confusing for purposes of key binding; convert
3036 VK_CANCEL events into VK_PAUSE events. */
3037 wParam = VK_PAUSE;
3038 break;
3039 case VK_PAUSE:
3040 /* Windows maps Ctrl-NumLock into VK_PAUSE, which is confusing
3041 for purposes of key binding; convert these back into
3042 VK_NUMLOCK events, at least when we want to see NumLock key
3043 presses. (Note that there is never any possibility that
3044 VK_PAUSE with Ctrl really is C-Pause as per above.) */
3045 if (NILP (Vw32_enable_num_lock) && modifier_set (VK_CONTROL))
3046 wParam = VK_NUMLOCK;
3047 break;
ccc2d29c
GV
3048 default:
3049 /* If not defined as a function key, change it to a WM_CHAR message. */
bf254037 3050 if (wParam > 255 || !lispy_function_keys[wParam])
ccc2d29c 3051 {
adcc3809
GV
3052 DWORD modifiers = construct_console_modifiers ();
3053
ccc2d29c
GV
3054 if (!NILP (Vw32_recognize_altgr)
3055 && modifier_set (VK_LCONTROL) && modifier_set (VK_RMENU))
3056 {
3057 /* Always let TranslateMessage handle AltGr key chords;
3058 for some reason, ToAscii doesn't always process AltGr
3059 chords correctly. */
3060 windows_translate = 1;
3061 }
adcc3809 3062 else if ((modifiers & (~SHIFT_PRESSED & ~CAPSLOCK_ON)) != 0)
ccc2d29c 3063 {
adcc3809
GV
3064 /* Handle key chords including any modifiers other
3065 than shift directly, in order to preserve as much
3066 modifier information as possible. */
ccc2d29c
GV
3067 if ('A' <= wParam && wParam <= 'Z')
3068 {
3069 /* Don't translate modified alphabetic keystrokes,
3070 so the user doesn't need to constantly switch
3071 layout to type control or meta keystrokes when
3072 the normal layout translates alphabetic
3073 characters to non-ascii characters. */
3074 if (!modifier_set (VK_SHIFT))
3075 wParam += ('a' - 'A');
3076 msg = WM_CHAR;
3077 }
3078 else
3079 {
3080 /* Try to handle other keystrokes by determining the
3081 base character (ie. translating the base key plus
3082 shift modifier). */
3083 int add;
ccc2d29c 3084 KEY_EVENT_RECORD key;
7d0393cf 3085
ccc2d29c
GV
3086 key.bKeyDown = TRUE;
3087 key.wRepeatCount = 1;
3088 key.wVirtualKeyCode = wParam;
3089 key.wVirtualScanCode = (lParam & 0xFF0000) >> 16;
3090 key.uChar.AsciiChar = 0;
adcc3809 3091 key.dwControlKeyState = modifiers;
ccc2d29c 3092
302fc036 3093 add = w32_kbd_patch_key (&key, w32_keyboard_codepage);
e1dbe924 3094 /* 0 means an unrecognized keycode, negative means
ccc2d29c
GV
3095 dead key. Ignore both. */
3096 while (--add >= 0)
3097 {
3098 /* Forward asciified character sequence. */
3099 post_character_message
a313b291
JR
3100 (hwnd, WM_CHAR,
3101 (unsigned char) key.uChar.AsciiChar, lParam,
ccc2d29c 3102 w32_get_key_modifiers (wParam, lParam));
302fc036 3103 w32_kbd_patch_key (&key, w32_keyboard_codepage);
ccc2d29c
GV
3104 }
3105 return 0;
3106 }
3107 }
3108 else
3109 {
3110 /* Let TranslateMessage handle everything else. */
3111 windows_translate = 1;
3112 }
3113 }
3114 }
a1a80b40 3115
adcc3809 3116 translate:
84fb1139
KH
3117 if (windows_translate)
3118 {
e9e23e23 3119 MSG windows_msg = { hwnd, msg, wParam, lParam, 0, {0,0} };
e9e23e23
GV
3120 windows_msg.time = GetMessageTime ();
3121 TranslateMessage (&windows_msg);
84fb1139
KH
3122 goto dflt;
3123 }
3124
ee78dc32 3125 /* Fall through */
7d0393cf 3126
ee78dc32
GV
3127 case WM_SYSCHAR:
3128 case WM_CHAR:
d30be705
EZ
3129 if (wParam > 255 )
3130 {
3131 W32Msg wmsg;
3132
3133 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3134 signal_user_input ();
3135 my_post_msg (&wmsg, hwnd, WM_UNICHAR, wParam, lParam);
3136
3137 }
3138 else
3139 post_character_message (hwnd, msg, wParam, lParam,
3140 w32_get_key_modifiers (wParam, lParam));
ee78dc32 3141 break;
da36a4d6 3142
820eff5a
JR
3143 case WM_UNICHAR:
3144 /* WM_UNICHAR looks promising from the docs, but the exact
3145 circumstances in which TranslateMessage sends it is one of those
3146 Microsoft secret API things that EU and US courts are supposed
3147 to have put a stop to already. Spy++ shows it being sent to Notepad
3148 and other MS apps, but never to Emacs.
3149
3150 Some third party IMEs send it in accordance with the official
3151 documentation though, so handle it here.
3152
3153 UNICODE_NOCHAR is used to test for support for this message.
3154 TRUE indicates that the message is supported. */
3155 if (wParam == UNICODE_NOCHAR)
3156 return TRUE;
3157
3158 {
3159 W32Msg wmsg;
3160 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3161 signal_user_input ();
3162 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3163 }
3164 break;
3165
3166 case WM_IME_CHAR:
fe7a3057 3167 /* If we can't get the IME result as Unicode, use default processing,
820eff5a
JR
3168 which will at least allow characters decodable in the system locale
3169 get through. */
3170 if (!get_composition_string_fn)
3171 goto dflt;
3172
3173 else if (!ignore_ime_char)
3174 {
3175 wchar_t * buffer;
3176 int size, i;
3177 W32Msg wmsg;
3178 HIMC context = get_ime_context_fn (hwnd);
3179 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3180 /* Get buffer size. */
9c88f339 3181 size = get_composition_string_fn (context, GCS_RESULTSTR, NULL, 0);
ed3751c8 3182 buffer = alloca (size);
820eff5a
JR
3183 size = get_composition_string_fn (context, GCS_RESULTSTR,
3184 buffer, size);
c902b920
JR
3185 release_ime_context_fn (hwnd, context);
3186
820eff5a
JR
3187 signal_user_input ();
3188 for (i = 0; i < size / sizeof (wchar_t); i++)
3189 {
3190 my_post_msg (&wmsg, hwnd, WM_UNICHAR, (WPARAM) buffer[i],
3191 lParam);
3192 }
2c93b248
JR
3193 /* Ignore the messages for the rest of the
3194 characters in the string that was output above. */
3195 ignore_ime_char = (size / sizeof (wchar_t)) - 1;
820eff5a 3196 }
2c93b248
JR
3197 else
3198 ignore_ime_char--;
3199
820eff5a
JR
3200 break;
3201
c902b920
JR
3202 case WM_IME_STARTCOMPOSITION:
3203 if (!set_ime_composition_window_fn)
3204 goto dflt;
3205 else
3206 {
3207 COMPOSITIONFORM form;
3208 HIMC context;
3209 struct window *w;
3210
b932cad7
EZ
3211 /* Implementation note: The code below does something that
3212 one shouldn't do: it accesses the window object from a
3213 separate thread, while the main (a.k.a. "Lisp") thread
3214 runs and can legitimately delete and even GC it. That is
3215 why we are extra careful not to futz with a window that
3216 is different from the one recorded when the system caret
3217 coordinates were last modified. That is also why we are
3218 careful not to move the IME window if the window
3219 described by W was deleted, as indicated by its buffer
3220 field being reset to nil. */
c902b920 3221 f = x_window_to_frame (dpyinfo, hwnd);
2e5ce5de
EZ
3222 if (!(f && FRAME_LIVE_P (f)))
3223 break;
c902b920 3224 w = XWINDOW (FRAME_SELECTED_WINDOW (f));
b932cad7
EZ
3225 /* Punt if someone changed the frame's selected window
3226 behind our back. */
3227 if (w != w32_system_caret_window)
3228 break;
c902b920
JR
3229
3230 form.dwStyle = CFS_RECT;
3231 form.ptCurrentPos.x = w32_system_caret_x;
3232 form.ptCurrentPos.y = w32_system_caret_y;
3233
3234 form.rcArea.left = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, 0);
b932cad7
EZ
3235 form.rcArea.top = (WINDOW_TOP_EDGE_Y (w)
3236 + w32_system_caret_hdr_height);
c902b920
JR
3237 form.rcArea.right = (WINDOW_BOX_RIGHT_EDGE_X (w)
3238 - WINDOW_RIGHT_MARGIN_WIDTH (w)
3239 - WINDOW_RIGHT_FRINGE_WIDTH (w));
3240 form.rcArea.bottom = (WINDOW_BOTTOM_EDGE_Y (w)
880e6158 3241 - WINDOW_BOTTOM_DIVIDER_WIDTH (w)
b932cad7
EZ
3242 - w32_system_caret_mode_height);
3243
3244 /* Punt if the window was deleted behind our back. */
3245 if (!BUFFERP (w->contents))
3246 break;
c902b920
JR
3247
3248 context = get_ime_context_fn (hwnd);
20d60baf
JR
3249
3250 if (!context)
3251 break;
3252
c902b920
JR
3253 set_ime_composition_window_fn (context, &form);
3254 release_ime_context_fn (hwnd, context);
3255 }
3256 break;
3257
820eff5a
JR
3258 case WM_IME_ENDCOMPOSITION:
3259 ignore_ime_char = 0;
3260 goto dflt;
3261
5ac45f98
GV
3262 /* Simulate middle mouse button events when left and right buttons
3263 are used together, but only if user has two button mouse. */
ee78dc32 3264 case WM_LBUTTONDOWN:
5ac45f98 3265 case WM_RBUTTONDOWN:
2ba49441 3266 if (w32_num_mouse_buttons > 2)
5ac45f98
GV
3267 goto handle_plain_button;
3268
3269 {
3270 int this = (msg == WM_LBUTTONDOWN) ? LMOUSE : RMOUSE;
3271 int other = (msg == WM_LBUTTONDOWN) ? RMOUSE : LMOUSE;
3272
3cb20f4a
RS
3273 if (button_state & this)
3274 return 0;
5ac45f98
GV
3275
3276 if (button_state == 0)
3277 SetCapture (hwnd);
3278
3279 button_state |= this;
3280
3281 if (button_state & other)
3282 {
84fb1139 3283 if (mouse_button_timer)
5ac45f98 3284 {
84fb1139
KH
3285 KillTimer (hwnd, mouse_button_timer);
3286 mouse_button_timer = 0;
5ac45f98
GV
3287
3288 /* Generate middle mouse event instead. */
3289 msg = WM_MBUTTONDOWN;
3290 button_state |= MMOUSE;
3291 }
3292 else if (button_state & MMOUSE)
3293 {
3294 /* Ignore button event if we've already generated a
3295 middle mouse down event. This happens if the
3296 user releases and press one of the two buttons
3297 after we've faked a middle mouse event. */
3298 return 0;
3299 }
3300 else
3301 {
3302 /* Flush out saved message. */
84fb1139 3303 post_msg (&saved_mouse_button_msg);
5ac45f98 3304 }
fbd6baed 3305 wmsg.dwModifiers = w32_get_modifiers ();
5ac45f98 3306 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
f5f69b6b 3307 signal_user_input ();
5ac45f98
GV
3308
3309 /* Clear message buffer. */
84fb1139 3310 saved_mouse_button_msg.msg.hwnd = 0;
5ac45f98
GV
3311 }
3312 else
3313 {
3314 /* Hold onto message for now. */
84fb1139 3315 mouse_button_timer =
adcc3809 3316 SetTimer (hwnd, MOUSE_BUTTON_ID,
2ba49441 3317 w32_mouse_button_tolerance, NULL);
84fb1139
KH
3318 saved_mouse_button_msg.msg.hwnd = hwnd;
3319 saved_mouse_button_msg.msg.message = msg;
3320 saved_mouse_button_msg.msg.wParam = wParam;
3321 saved_mouse_button_msg.msg.lParam = lParam;
3322 saved_mouse_button_msg.msg.time = GetMessageTime ();
fbd6baed 3323 saved_mouse_button_msg.dwModifiers = w32_get_modifiers ();
5ac45f98
GV
3324 }
3325 }
3326 return 0;
3327
ee78dc32 3328 case WM_LBUTTONUP:
5ac45f98 3329 case WM_RBUTTONUP:
2ba49441 3330 if (w32_num_mouse_buttons > 2)
5ac45f98
GV
3331 goto handle_plain_button;
3332
3333 {
3334 int this = (msg == WM_LBUTTONUP) ? LMOUSE : RMOUSE;
3335 int other = (msg == WM_LBUTTONUP) ? RMOUSE : LMOUSE;
3336
3cb20f4a
RS
3337 if ((button_state & this) == 0)
3338 return 0;
5ac45f98
GV
3339
3340 button_state &= ~this;
3341
3342 if (button_state & MMOUSE)
3343 {
3344 /* Only generate event when second button is released. */
3345 if ((button_state & other) == 0)
3346 {
3347 msg = WM_MBUTTONUP;
3348 button_state &= ~MMOUSE;
3349
1088b922 3350 if (button_state) emacs_abort ();
5ac45f98
GV
3351 }
3352 else
3353 return 0;
3354 }
3355 else
3356 {
3357 /* Flush out saved message if necessary. */
84fb1139 3358 if (saved_mouse_button_msg.msg.hwnd)
5ac45f98 3359 {
84fb1139 3360 post_msg (&saved_mouse_button_msg);
5ac45f98
GV
3361 }
3362 }
fbd6baed 3363 wmsg.dwModifiers = w32_get_modifiers ();
5ac45f98 3364 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
f5f69b6b 3365 signal_user_input ();
5ac45f98
GV
3366
3367 /* Always clear message buffer and cancel timer. */
84fb1139
KH
3368 saved_mouse_button_msg.msg.hwnd = 0;
3369 KillTimer (hwnd, mouse_button_timer);
3370 mouse_button_timer = 0;
5ac45f98
GV
3371
3372 if (button_state == 0)
3373 ReleaseCapture ();
3374 }
3375 return 0;
3376
74214547
JR
3377 case WM_XBUTTONDOWN:
3378 case WM_XBUTTONUP:
3379 if (w32_pass_extra_mouse_buttons_to_system)
3380 goto dflt;
3381 /* else fall through and process them. */
ee78dc32
GV
3382 case WM_MBUTTONDOWN:
3383 case WM_MBUTTONUP:
5ac45f98 3384 handle_plain_button:
ee78dc32
GV
3385 {
3386 BOOL up;
1edf84e7 3387 int button;
ee78dc32 3388
b48f9276
EZ
3389 /* Ignore middle and extra buttons as long as the menu is active. */
3390 f = x_window_to_frame (dpyinfo, hwnd);
3391 if (f && f->output_data.w32->menubar_active)
3392 return 0;
3393
74214547 3394 if (parse_button (msg, HIWORD (wParam), &button, &up))
ee78dc32
GV
3395 {
3396 if (up) ReleaseCapture ();
3397 else SetCapture (hwnd);
7d0393cf 3398 button = (button == 0) ? LMOUSE :
1edf84e7
GV
3399 ((button == 1) ? MMOUSE : RMOUSE);
3400 if (up)
3401 button_state &= ~button;
3402 else
3403 button_state |= button;
ee78dc32
GV
3404 }
3405 }
7d0393cf 3406
fbd6baed 3407 wmsg.dwModifiers = w32_get_modifiers ();
ee78dc32 3408 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
f0c947b5 3409 signal_user_input ();
74214547
JR
3410
3411 /* Need to return true for XBUTTON messages, false for others,
3412 to indicate that we processed the message. */
3413 return (msg == WM_XBUTTONDOWN || msg == WM_XBUTTONUP);
5ac45f98 3414
5ac45f98 3415 case WM_MOUSEMOVE:
f93bd8e4
EZ
3416 /* Ignore mouse movements as long as the menu is active. These
3417 movements are processed by the window manager anyway, and
3418 it's wrong to handle them as if they happened on the
3419 underlying frame. */
3420 f = x_window_to_frame (dpyinfo, hwnd);
3421 if (f && f->output_data.w32->menubar_active)
3422 return 0;
3423
9eb16b62
JR
3424 /* If the mouse has just moved into the frame, start tracking
3425 it, so we will be notified when it leaves the frame. Mouse
3426 tracking only works under W98 and NT4 and later. On earlier
3427 versions, there is no way of telling when the mouse leaves the
3428 frame, so we just have to put up with help-echo and mouse
3429 highlighting remaining while the frame is not active. */
ccc83f50
EZ
3430 if (track_mouse_event_fn && !track_mouse_window
3431 /* If the menu bar is active, turning on tracking of mouse
3432 movement events might send these events to the tooltip
3433 frame, if the user happens to move the mouse pointer over
3434 the tooltip. But since we don't process events for
3435 tooltip frames, this causes Windows to present a
3436 hourglass cursor, which is ugly and unexpected. So don't
3437 enable tracking mouse events in this case; they will be
3438 restarted when the menu pops down. (Confusingly, the
3439 menubar_active member of f->output_data.w32, tested
3440 above, is only set when a menu was popped up _not_ from
3441 the frame's menu bar, but via x-popup-menu.) */
3442 && !menubar_in_use)
9eb16b62
JR
3443 {
3444 TRACKMOUSEEVENT tme;
3445 tme.cbSize = sizeof (tme);
3446 tme.dwFlags = TME_LEAVE;
3447 tme.hwndTrack = hwnd;
722493d7 3448 tme.dwHoverTime = HOVER_DEFAULT;
9eb16b62
JR
3449
3450 track_mouse_event_fn (&tme);
3451 track_mouse_window = hwnd;
3452 }
3453 case WM_VSCROLL:
2ba49441 3454 if (w32_mouse_move_interval <= 0
84fb1139
KH
3455 || (msg == WM_MOUSEMOVE && button_state == 0))
3456 {
fbd6baed 3457 wmsg.dwModifiers = w32_get_modifiers ();
84fb1139
KH
3458 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3459 return 0;
3460 }
7d0393cf 3461
84fb1139
KH
3462 /* Hang onto mouse move and scroll messages for a bit, to avoid
3463 sending such events to Emacs faster than it can process them.
3464 If we get more events before the timer from the first message
3465 expires, we just replace the first message. */
3466
3467 if (saved_mouse_move_msg.msg.hwnd == 0)
3468 mouse_move_timer =
adcc3809 3469 SetTimer (hwnd, MOUSE_MOVE_ID,
2ba49441 3470 w32_mouse_move_interval, NULL);
84fb1139
KH
3471
3472 /* Hold onto message for now. */
3473 saved_mouse_move_msg.msg.hwnd = hwnd;
3474 saved_mouse_move_msg.msg.message = msg;
3475 saved_mouse_move_msg.msg.wParam = wParam;
3476 saved_mouse_move_msg.msg.lParam = lParam;
3477 saved_mouse_move_msg.msg.time = GetMessageTime ();
fbd6baed 3478 saved_mouse_move_msg.dwModifiers = w32_get_modifiers ();
7d0393cf 3479
84fb1139
KH
3480 return 0;
3481
1edf84e7 3482 case WM_MOUSEWHEEL:
fd142562 3483 case WM_DROPFILES:
1edf84e7
GV
3484 wmsg.dwModifiers = w32_get_modifiers ();
3485 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
f0c947b5 3486 signal_user_input ();
1edf84e7
GV
3487 return 0;
3488
0b151762
JR
3489 case WM_APPCOMMAND:
3490 if (w32_pass_multimedia_buttons_to_system)
3491 goto dflt;
3492 /* Otherwise, pass to lisp, the same way we do with mousehwheel. */
fd142562 3493 case WM_MOUSEHWHEEL:
cb9e33d4
RS
3494 wmsg.dwModifiers = w32_get_modifiers ();
3495 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
f0c947b5 3496 signal_user_input ();
fd142562
JR
3497 /* Non-zero must be returned when WM_MOUSEHWHEEL messages are
3498 handled, to prevent the system trying to handle it by faking
3499 scroll bar events. */
3500 return 1;
cb9e33d4 3501
84fb1139
KH
3502 case WM_TIMER:
3503 /* Flush out saved messages if necessary. */
3504 if (wParam == mouse_button_timer)
5ac45f98 3505 {
84fb1139
KH
3506 if (saved_mouse_button_msg.msg.hwnd)
3507 {
3508 post_msg (&saved_mouse_button_msg);
f0c947b5 3509 signal_user_input ();
84fb1139
KH
3510 saved_mouse_button_msg.msg.hwnd = 0;
3511 }
3512 KillTimer (hwnd, mouse_button_timer);
3513 mouse_button_timer = 0;
3514 }
3515 else if (wParam == mouse_move_timer)
3516 {
3517 if (saved_mouse_move_msg.msg.hwnd)
3518 {
3519 post_msg (&saved_mouse_move_msg);
3520 saved_mouse_move_msg.msg.hwnd = 0;
3521 }
3522 KillTimer (hwnd, mouse_move_timer);
3523 mouse_move_timer = 0;
5ac45f98 3524 }
48094ace
JR
3525 else if (wParam == menu_free_timer)
3526 {
3527 KillTimer (hwnd, menu_free_timer);
3528 menu_free_timer = 0;
27605fa7 3529 f = x_window_to_frame (dpyinfo, hwnd);
5d22ded9 3530 /* If a popup menu is active, don't wipe its strings. */
58e55497 3531 if (menubar_in_use
5d22ded9 3532 && current_popup_menu == NULL)
48094ace
JR
3533 {
3534 /* Free memory used by owner-drawn and help-echo strings. */
3535 w32_free_menu_strings (hwnd);
5df75e47
JR
3536 if (f)
3537 f->output_data.w32->menubar_active = 0;
58e55497 3538 menubar_in_use = 0;
48094ace
JR
3539 }
3540 }
5ac45f98 3541 return 0;
7d0393cf 3542
84fb1139
KH
3543 case WM_NCACTIVATE:
3544 /* Windows doesn't send us focus messages when putting up and
e9e23e23 3545 taking down a system popup dialog as for Ctrl-Alt-Del on Windows 95.
84fb1139
KH
3546 The only indication we get that something happened is receiving
3547 this message afterwards. So this is a good time to reset our
3548 keyboard modifiers' state. */
3549 reset_modifiers ();
3550 goto dflt;
da36a4d6 3551
1edf84e7 3552 case WM_INITMENU:
487163ac
AI
3553 button_state = 0;
3554 ReleaseCapture ();
1edf84e7
GV
3555 /* We must ensure menu bar is fully constructed and up to date
3556 before allowing user interaction with it. To achieve this
3557 we send this message to the lisp thread and wait for a
3558 reply (whose value is not actually needed) to indicate that
3559 the menu bar is now ready for use, so we can now return.
3560
3561 To remain responsive in the meantime, we enter a nested message
3562 loop that can process all other messages.
3563
3564 However, we skip all this if the message results from calling
3565 TrackPopupMenu - in fact, we must NOT attempt to send the lisp
3566 thread a message because it is blocked on us at this point. We
3567 set menubar_active before calling TrackPopupMenu to indicate
3568 this (there is no possibility of confusion with real menubar
3569 being active). */
3570
3571 f = x_window_to_frame (dpyinfo, hwnd);
3572 if (f
3573 && (f->output_data.w32->menubar_active
3574 /* We can receive this message even in the absence of a
3575 menubar (ie. when the system menu is activated) - in this
3576 case we do NOT want to forward the message, otherwise it
3577 will cause the menubar to suddenly appear when the user
3578 had requested it to be turned off! */
3579 || f->output_data.w32->menubar_widget == NULL))
3580 return 0;
3581
3582 {
3583 deferred_msg msg_buf;
3584
3585 /* Detect if message has already been deferred; in this case
3586 we cannot return any sensible value to ignore this. */
3587 if (find_deferred_msg (hwnd, msg) != NULL)
1088b922 3588 emacs_abort ();
1edf84e7 3589
58e55497 3590 menubar_in_use = 1;
90816b86 3591
1edf84e7
GV
3592 return send_deferred_msg (&msg_buf, hwnd, msg, wParam, lParam);
3593 }
3594
3595 case WM_EXITMENULOOP:
3596 f = x_window_to_frame (dpyinfo, hwnd);
3597
5d22ded9
JR
3598 /* If a menu is still active, check again after a short delay,
3599 since Windows often (always?) sends the WM_EXITMENULOOP
3600 before the corresponding WM_COMMAND message.
3601 Don't do this if a popup menu is active, since it is only
3602 menubar menus that require cleaning up in this way.
3603 */
58e55497 3604 if (f && menubar_in_use && current_popup_menu == NULL)
48094ace 3605 menu_free_timer = SetTimer (hwnd, MENU_FREE_ID, MENU_FREE_DELAY, NULL);
d148e14d
JR
3606
3607 /* If hourglass cursor should be displayed, display it now. */
3608 if (f && f->output_data.w32->hourglass_p)
3609 SetCursor (f->output_data.w32->hourglass_cursor);
3610
1edf84e7
GV
3611 goto dflt;
3612
126f2e35 3613 case WM_MENUSELECT:
4e3a1c61
JR
3614 /* Direct handling of help_echo in menus. Should be safe now
3615 that we generate the help_echo by placing a help event in the
3616 keyboard buffer. */
ca56d953 3617 {
ca56d953
JR
3618 HMENU menu = (HMENU) lParam;
3619 UINT menu_item = (UINT) LOWORD (wParam);
3620 UINT flags = (UINT) HIWORD (wParam);
3621
4e3a1c61 3622 w32_menu_display_help (hwnd, menu, menu_item, flags);
ca56d953 3623 }
126f2e35
JR
3624 return 0;
3625
87996783
GV
3626 case WM_MEASUREITEM:
3627 f = x_window_to_frame (dpyinfo, hwnd);
3628 if (f)
3629 {
3630 MEASUREITEMSTRUCT * pMis = (MEASUREITEMSTRUCT *) lParam;
3631
3632 if (pMis->CtlType == ODT_MENU)
3633 {
3634 /* Work out dimensions for popup menu titles. */
3635 char * title = (char *) pMis->itemData;
3636 HDC hdc = GetDC (hwnd);
3637 HFONT menu_font = GetCurrentObject (hdc, OBJ_FONT);
3638 LOGFONT menu_logfont;
3639 HFONT old_font;
3640 SIZE size;
3641
3642 GetObject (menu_font, sizeof (menu_logfont), &menu_logfont);
3643 menu_logfont.lfWeight = FW_BOLD;
3644 menu_font = CreateFontIndirect (&menu_logfont);
3645 old_font = SelectObject (hdc, menu_font);
3646
dfff8a69
JR
3647 pMis->itemHeight = GetSystemMetrics (SM_CYMENUSIZE);
3648 if (title)
3649 {
b4005349
JR
3650 if (unicode_append_menu)
3651 GetTextExtentPoint32W (hdc, (WCHAR *) title,
3652 wcslen ((WCHAR *) title),
3653 &size);
3654 else
3655 GetTextExtentPoint32 (hdc, title, strlen (title), &size);
3656
dfff8a69
JR
3657 pMis->itemWidth = size.cx;
3658 if (pMis->itemHeight < size.cy)
3659 pMis->itemHeight = size.cy;
3660 }
3661 else
3662 pMis->itemWidth = 0;
87996783
GV
3663
3664 SelectObject (hdc, old_font);
3665 DeleteObject (menu_font);
3666 ReleaseDC (hwnd, hdc);
3667 return TRUE;
3668 }
3669 }
3670 return 0;
3671
3672 case WM_DRAWITEM:
3673 f = x_window_to_frame (dpyinfo, hwnd);
3674 if (f)
3675 {
3676 DRAWITEMSTRUCT * pDis = (DRAWITEMSTRUCT *) lParam;
3677
3678 if (pDis->CtlType == ODT_MENU)
3679 {
3680 /* Draw popup menu title. */
3681 char * title = (char *) pDis->itemData;
212da13b
JR
3682 if (title)
3683 {
3684 HDC hdc = pDis->hDC;
3685 HFONT menu_font = GetCurrentObject (hdc, OBJ_FONT);
3686 LOGFONT menu_logfont;
3687 HFONT old_font;
3688
3689 GetObject (menu_font, sizeof (menu_logfont), &menu_logfont);
3690 menu_logfont.lfWeight = FW_BOLD;
3691 menu_font = CreateFontIndirect (&menu_logfont);
3692 old_font = SelectObject (hdc, menu_font);
3693
b4005349
JR
3694 /* Always draw title as if not selected. */
3695 if (unicode_append_menu)
3696 ExtTextOutW (hdc,
3697 pDis->rcItem.left
3698 + GetSystemMetrics (SM_CXMENUCHECK),
3699 pDis->rcItem.top,
3700 ETO_OPAQUE, &pDis->rcItem,
3701 (WCHAR *) title,
3702 wcslen ((WCHAR *) title), NULL);
3703 else
3704 ExtTextOut (hdc,
3705 pDis->rcItem.left
3706 + GetSystemMetrics (SM_CXMENUCHECK),
3707 pDis->rcItem.top,
3708 ETO_OPAQUE, &pDis->rcItem,
3709 title, strlen (title), NULL);
212da13b
JR
3710
3711 SelectObject (hdc, old_font);
3712 DeleteObject (menu_font);
3713 }
87996783
GV
3714 return TRUE;
3715 }
3716 }
3717 return 0;
3718
1edf84e7
GV
3719#if 0
3720 /* Still not right - can't distinguish between clicks in the
3721 client area of the frame from clicks forwarded from the scroll
3722 bars - may have to hook WM_NCHITTEST to remember the mouse
3723 position and then check if it is in the client area ourselves. */
3724 case WM_MOUSEACTIVATE:
3725 /* Discard the mouse click that activates a frame, allowing the
3726 user to click anywhere without changing point (or worse!).
3727 Don't eat mouse clicks on scrollbars though!! */
3728 if (LOWORD (lParam) == HTCLIENT )
3729 return MA_ACTIVATEANDEAT;
3730 goto dflt;
3731#endif
3732
9eb16b62
JR
3733 case WM_MOUSELEAVE:
3734 /* No longer tracking mouse. */
3735 track_mouse_window = NULL;
3736
1edf84e7 3737 case WM_ACTIVATEAPP:
ccc2d29c 3738 case WM_ACTIVATE:
1edf84e7
GV
3739 case WM_WINDOWPOSCHANGED:
3740 case WM_SHOWWINDOW:
3741 /* Inform lisp thread that a frame might have just been obscured
3742 or exposed, so should recheck visibility of all frames. */
3743 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3744 goto dflt;
3745
da36a4d6 3746 case WM_SETFOCUS:
adcc3809
GV
3747 dpyinfo->faked_key = 0;
3748 reset_modifiers ();
ccc2d29c
GV
3749 register_hot_keys (hwnd);
3750 goto command;
8681157a 3751 case WM_KILLFOCUS:
ccc2d29c 3752 unregister_hot_keys (hwnd);
487163ac
AI
3753 button_state = 0;
3754 ReleaseCapture ();
65906840
JR
3755 /* Relinquish the system caret. */
3756 if (w32_system_caret_hwnd)
3757 {
93f2ca61 3758 w32_visible_system_caret_hwnd = NULL;
d285988b
JR
3759 w32_system_caret_hwnd = NULL;
3760 DestroyCaret ();
65906840 3761 }
48094ace
JR
3762 goto command;
3763 case WM_COMMAND:
58e55497 3764 menubar_in_use = 0;
48094ace
JR
3765 f = x_window_to_frame (dpyinfo, hwnd);
3766 if (f && HIWORD (wParam) == 0)
3767 {
48094ace
JR
3768 if (menu_free_timer)
3769 {
3770 KillTimer (hwnd, menu_free_timer);
7d0393cf 3771 menu_free_timer = 0;
48094ace
JR
3772 }
3773 }
ee78dc32
GV
3774 case WM_MOVE:
3775 case WM_SIZE:
ccc2d29c 3776 command:
fbd6baed 3777 wmsg.dwModifiers = w32_get_modifiers ();
ee78dc32
GV
3778 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3779 goto dflt;
8847d890 3780
d5781bb6
JR
3781 case WM_DESTROY:
3782 CoUninitialize ();
3783 return 0;
3784
8847d890 3785 case WM_CLOSE:
fbd6baed 3786 wmsg.dwModifiers = w32_get_modifiers ();
8847d890
RS
3787 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3788 return 0;
3789
ee78dc32 3790 case WM_WINDOWPOSCHANGING:
bfd6edcc 3791 /* Don't restrict the sizing of tip frames. */
880e6158 3792 if (frame_resize_pixelwise || hwnd == tip_window)
bfd6edcc 3793 return 0;
1f635a07
EC
3794
3795 /* Don't restrict the sizing of fullscreened frames, allowing them to be
3796 flush with the sides of the screen. */
3797 f = x_window_to_frame (dpyinfo, hwnd);
3798 if (f && FRAME_PREV_FSMODE (f) != FULLSCREEN_NONE)
3799 return 0;
3800
ee78dc32
GV
3801 {
3802 WINDOWPLACEMENT wp;
3803 LPWINDOWPOS lppos = (WINDOWPOS *) lParam;
1edf84e7
GV
3804
3805 wp.length = sizeof (WINDOWPLACEMENT);
ee78dc32 3806 GetWindowPlacement (hwnd, &wp);
7d0393cf 3807
21e18b30
MR
3808 if (wp.showCmd != SW_SHOWMAXIMIZED && wp.showCmd != SW_SHOWMINIMIZED
3809 && (lppos->flags & SWP_NOSIZE) == 0)
ee78dc32
GV
3810 {
3811 RECT rect;
3812 int wdiff;
3813 int hdiff;
1edf84e7
GV
3814 DWORD font_width;
3815 DWORD line_height;
3816 DWORD internal_border;
3817 DWORD scrollbar_extra;
ee78dc32 3818 RECT wr;
7d0393cf 3819
74084731 3820 wp.length = sizeof (wp);
ee78dc32 3821 GetWindowRect (hwnd, &wr);
7d0393cf 3822
3c190163 3823 enter_crit ();
7d0393cf 3824
1edf84e7
GV
3825 font_width = GetWindowLong (hwnd, WND_FONTWIDTH_INDEX);
3826 line_height = GetWindowLong (hwnd, WND_LINEHEIGHT_INDEX);
3827 internal_border = GetWindowLong (hwnd, WND_BORDER_INDEX);
3828 scrollbar_extra = GetWindowLong (hwnd, WND_SCROLLBAR_INDEX);
7d0393cf 3829
3c190163 3830 leave_crit ();
7d0393cf 3831
ee78dc32 3832 memset (&rect, 0, sizeof (rect));
7d0393cf 3833 AdjustWindowRect (&rect, GetWindowLong (hwnd, GWL_STYLE),
ee78dc32
GV
3834 GetMenu (hwnd) != NULL);
3835
1edf84e7
GV
3836 /* Force width and height of client area to be exact
3837 multiples of the character cell dimensions. */
3838 wdiff = (lppos->cx - (rect.right - rect.left)
3839 - 2 * internal_border - scrollbar_extra)
3840 % font_width;
3841 hdiff = (lppos->cy - (rect.bottom - rect.top)
3842 - 2 * internal_border)
3843 % line_height;
7d0393cf 3844
ee78dc32
GV
3845 if (wdiff || hdiff)
3846 {
7d0393cf
JB
3847 /* For right/bottom sizing we can just fix the sizes.
3848 However for top/left sizing we will need to fix the X
ee78dc32 3849 and Y positions as well. */
7d0393cf 3850
8a4c4c7f
JB
3851 int cx_mintrack = GetSystemMetrics (SM_CXMINTRACK);
3852 int cy_mintrack = GetSystemMetrics (SM_CYMINTRACK);
3853
3854 lppos->cx = max (lppos->cx - wdiff, cx_mintrack);
3855 lppos->cy = max (lppos->cy - hdiff, cy_mintrack);
7d0393cf
JB
3856
3857 if (wp.showCmd != SW_SHOWMAXIMIZED
1edf84e7 3858 && (lppos->flags & SWP_NOMOVE) == 0)
ee78dc32
GV
3859 {
3860 if (lppos->x != wr.left || lppos->y != wr.top)
3861 {
3862 lppos->x += wdiff;
3863 lppos->y += hdiff;
3864 }
3865 else
3866 {
3867 lppos->flags |= SWP_NOMOVE;
3868 }
3869 }
7d0393cf 3870
1edf84e7 3871 return 0;
ee78dc32
GV
3872 }
3873 }
3874 }
7d0393cf 3875
ee78dc32 3876 goto dflt;
1edf84e7 3877
b1f918f8 3878 case WM_GETMINMAXINFO:
bf853fee
AI
3879 /* Hack to allow resizing the Emacs frame above the screen size.
3880 Note that Windows 9x limits coordinates to 16-bits. */
3881 ((LPMINMAXINFO) lParam)->ptMaxTrackSize.x = 32767;
3882 ((LPMINMAXINFO) lParam)->ptMaxTrackSize.y = 32767;
b1f918f8
GV
3883 return 0;
3884
c9b2104d
JR
3885 case WM_SETCURSOR:
3886 if (LOWORD (lParam) == HTCLIENT)
d148e14d
JR
3887 {
3888 f = x_window_to_frame (dpyinfo, hwnd);
5df75e47
JR
3889 if (f && f->output_data.w32->hourglass_p
3890 && !menubar_in_use && !current_popup_menu)
d148e14d 3891 SetCursor (f->output_data.w32->hourglass_cursor);
5df75e47 3892 else if (f)
d148e14d
JR
3893 SetCursor (f->output_data.w32->current_cursor);
3894 return 0;
3895 }
c9b2104d 3896 goto dflt;
c922a224 3897
c9b2104d
JR
3898 case WM_EMACS_SETCURSOR:
3899 {
3900 Cursor cursor = (Cursor) wParam;
d148e14d
JR
3901 f = x_window_to_frame (dpyinfo, hwnd);
3902 if (f && cursor)
3903 {
3904 f->output_data.w32->current_cursor = cursor;
3905 if (!f->output_data.w32->hourglass_p)
3906 SetCursor (cursor);
3907 }
c9b2104d
JR
3908 return 0;
3909 }
c922a224 3910
1edf84e7
GV
3911 case WM_EMACS_CREATESCROLLBAR:
3912 return (LRESULT) w32_createscrollbar ((struct frame *) wParam,
3913 (struct scroll_bar *) lParam);
3914
5ac45f98 3915 case WM_EMACS_SHOWWINDOW:
1edf84e7
GV
3916 return ShowWindow ((HWND) wParam, (WPARAM) lParam);
3917
85d0efd1 3918 case WM_EMACS_BRINGTOTOP:
dfdb4047 3919 case WM_EMACS_SETFOREGROUND:
ce6059da
AI
3920 {
3921 HWND foreground_window;
3922 DWORD foreground_thread, retval;
3923
3924 /* On NT 5.0, and apparently Windows 98, it is necessary to
3925 attach to the thread that currently has focus in order to
3926 pull the focus away from it. */
3927 foreground_window = GetForegroundWindow ();
3928 foreground_thread = GetWindowThreadProcessId (foreground_window, NULL);
3929 if (!foreground_window
3930 || foreground_thread == GetCurrentThreadId ()
3931 || !AttachThreadInput (GetCurrentThreadId (),
3932 foreground_thread, TRUE))
3933 foreground_thread = 0;
3934
3935 retval = SetForegroundWindow ((HWND) wParam);
85d0efd1
EZ
3936 if (msg == WM_EMACS_BRINGTOTOP)
3937 retval = BringWindowToTop ((HWND) wParam);
ce6059da
AI
3938
3939 /* Detach from the previous foreground thread. */
3940 if (foreground_thread)
3941 AttachThreadInput (GetCurrentThreadId (),
3942 foreground_thread, FALSE);
3943
3944 return retval;
3945 }
dfdb4047 3946
5ac45f98
GV
3947 case WM_EMACS_SETWINDOWPOS:
3948 {
1edf84e7
GV
3949 WINDOWPOS * pos = (WINDOWPOS *) wParam;
3950 return SetWindowPos (hwnd, pos->hwndInsertAfter,
5ac45f98
GV
3951 pos->x, pos->y, pos->cx, pos->cy, pos->flags);
3952 }
1edf84e7 3953
ee78dc32 3954 case WM_EMACS_DESTROYWINDOW:
cb9e33d4 3955 DragAcceptFiles ((HWND) wParam, FALSE);
1edf84e7
GV
3956 return DestroyWindow ((HWND) wParam);
3957
93f2ca61
JR
3958 case WM_EMACS_HIDE_CARET:
3959 return HideCaret (hwnd);
3960
3961 case WM_EMACS_SHOW_CARET:
3962 return ShowCaret (hwnd);
3963
65906840
JR
3964 case WM_EMACS_DESTROY_CARET:
3965 w32_system_caret_hwnd = NULL;
93f2ca61 3966 w32_visible_system_caret_hwnd = NULL;
65906840
JR
3967 return DestroyCaret ();
3968
3969 case WM_EMACS_TRACK_CARET:
3970 /* If there is currently no system caret, create one. */
3971 if (w32_system_caret_hwnd == NULL)
3972 {
93f2ca61 3973 /* Use the default caret width, and avoid changing it
ee7683eb 3974 unnecessarily, as it confuses screen reader software. */
65906840 3975 w32_system_caret_hwnd = hwnd;
93f2ca61 3976 CreateCaret (hwnd, NULL, 0,
65906840
JR
3977 w32_system_caret_height);
3978 }
7d0393cf 3979
93f2ca61
JR
3980 if (!SetCaretPos (w32_system_caret_x, w32_system_caret_y))
3981 return 0;
3982 /* Ensure visible caret gets turned on when requested. */
3983 else if (w32_use_visible_system_caret
3984 && w32_visible_system_caret_hwnd != hwnd)
3985 {
3986 w32_visible_system_caret_hwnd = hwnd;
3987 return ShowCaret (hwnd);
3988 }
3989 /* Ensure visible caret gets turned off when requested. */
3990 else if (!w32_use_visible_system_caret
3991 && w32_visible_system_caret_hwnd)
3992 {
3993 w32_visible_system_caret_hwnd = NULL;
3994 return HideCaret (hwnd);
3995 }
3996 else
3997 return 1;
65906840 3998
1edf84e7
GV
3999 case WM_EMACS_TRACKPOPUPMENU:
4000 {
4001 UINT flags;
4002 POINT *pos;
4003 int retval;
4004 pos = (POINT *)lParam;
4005 flags = TPM_CENTERALIGN;
4006 if (button_state & LMOUSE)
4007 flags |= TPM_LEFTBUTTON;
4008 else if (button_state & RMOUSE)
4009 flags |= TPM_RIGHTBUTTON;
7d0393cf 4010
87996783 4011 /* Remember we did a SetCapture on the initial mouse down event,
c80e3b4a 4012 so for safety, we make sure the capture is canceled now. */
87996783 4013 ReleaseCapture ();
490822ff 4014 button_state = 0;
87996783 4015
1edf84e7
GV
4016 /* Use menubar_active to indicate that WM_INITMENU is from
4017 TrackPopupMenu below, and should be ignored. */
4018 f = x_window_to_frame (dpyinfo, hwnd);
4019 if (f)
4020 f->output_data.w32->menubar_active = 1;
7d0393cf
JB
4021
4022 if (TrackPopupMenu ((HMENU)wParam, flags, pos->x, pos->y,
1edf84e7
GV
4023 0, hwnd, NULL))
4024 {
4025 MSG amsg;
4026 /* Eat any mouse messages during popupmenu */
4027 while (PeekMessage (&amsg, hwnd, WM_MOUSEFIRST, WM_MOUSELAST,
4028 PM_REMOVE));
4029 /* Get the menu selection, if any */
4030 if (PeekMessage (&amsg, hwnd, WM_COMMAND, WM_COMMAND, PM_REMOVE))
4031 {
4032 retval = LOWORD (amsg.wParam);
4033 }
4034 else
4035 {
4036 retval = 0;
4037 }
1edf84e7
GV
4038 }
4039 else
4040 {
4041 retval = -1;
4042 }
4043
4044 return retval;
4045 }
ae756559 4046 case WM_EMACS_FILENOTIFY:
ae756559
EZ
4047 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4048 return 1;
1edf84e7 4049
ee78dc32 4050 default:
93fbe8b7
GV
4051 /* Check for messages registered at runtime. */
4052 if (msg == msh_mousewheel)
4053 {
4054 wmsg.dwModifiers = w32_get_modifiers ();
4055 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
f0c947b5 4056 signal_user_input ();
93fbe8b7
GV
4057 return 0;
4058 }
7d0393cf 4059
ee78dc32 4060 dflt:
9b855fd6 4061 return (w32_unicode_gui ? DefWindowProcW : DefWindowProcA) (hwnd, msg, wParam, lParam);
ee78dc32 4062 }
7d0393cf 4063
1edf84e7
GV
4064 /* The most common default return code for handled messages is 0. */
4065 return 0;
ee78dc32
GV
4066}
4067
0962822d 4068static void
b56ceb92 4069my_create_window (struct frame * f)
ee78dc32
GV
4070{
4071 MSG msg;
4072
1edf84e7 4073 if (!PostThreadMessage (dwWindowsThreadId, WM_EMACS_CREATEWINDOW, (WPARAM)f, 0))
1088b922 4074 emacs_abort ();
ee78dc32
GV
4075 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
4076}
4077
ca56d953
JR
4078
4079/* Create a tooltip window. Unlike my_create_window, we do not do this
4080 indirectly via the Window thread, as we do not need to process Window
4081 messages for the tooltip. Creating tooltips indirectly also creates
4082 deadlocks when tooltips are created for menu items. */
0962822d 4083static void
b56ceb92 4084my_create_tip_window (struct frame *f)
ca56d953 4085{
bfd6edcc 4086 RECT rect;
ca56d953 4087
bfd6edcc 4088 rect.left = rect.top = 0;
be786000
KS
4089 rect.right = FRAME_PIXEL_WIDTH (f);
4090 rect.bottom = FRAME_PIXEL_HEIGHT (f);
bfd6edcc
JR
4091
4092 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
4093 FRAME_EXTERNAL_MENU_BAR (f));
4094
4095 tip_window = FRAME_W32_WINDOW (f)
ca56d953
JR
4096 = CreateWindow (EMACS_CLASS,
4097 f->namebuf,
4098 f->output_data.w32->dwStyle,
be786000
KS
4099 f->left_pos,
4100 f->top_pos,
bfd6edcc
JR
4101 rect.right - rect.left,
4102 rect.bottom - rect.top,
ca56d953
JR
4103 FRAME_W32_WINDOW (SELECTED_FRAME ()), /* owner */
4104 NULL,
4105 hinst,
4106 NULL);
4107
bfd6edcc 4108 if (tip_window)
ca56d953 4109 {
be786000
KS
4110 SetWindowLong (tip_window, WND_FONTWIDTH_INDEX, FRAME_COLUMN_WIDTH (f));
4111 SetWindowLong (tip_window, WND_LINEHEIGHT_INDEX, FRAME_LINE_HEIGHT (f));
4112 SetWindowLong (tip_window, WND_BORDER_INDEX, FRAME_INTERNAL_BORDER_WIDTH (f));
bfd6edcc
JR
4113 SetWindowLong (tip_window, WND_BACKGROUND_INDEX, FRAME_BACKGROUND_PIXEL (f));
4114
4115 /* Tip frames have no scrollbars. */
4116 SetWindowLong (tip_window, WND_SCROLLBAR_INDEX, 0);
ca56d953
JR
4117
4118 /* Do this to discard the default setting specified by our parent. */
bfd6edcc 4119 ShowWindow (tip_window, SW_HIDE);
ca56d953
JR
4120 }
4121}
4122
4123
fbd6baed 4124/* Create and set up the w32 window for frame F. */
ee78dc32
GV
4125
4126static void
b56ceb92 4127w32_window (struct frame *f, long window_prompting, int minibuffer_only)
ee78dc32 4128{
4d7e6e51 4129 block_input ();
ee78dc32
GV
4130
4131 /* Use the resource name as the top-level window name
4132 for looking up resources. Make a non-Lisp copy
4133 for the window manager, so GC relocation won't bother it.
4134
4135 Elsewhere we specify the window name for the window manager. */
309f24d1 4136 f->namebuf = xstrdup (SSDATA (Vx_resource_name));
ee78dc32
GV
4137
4138 my_create_window (f);
4139
4140 validate_x_resource_name ();
4141
4142 /* x_set_name normally ignores requests to set the name if the
4143 requested name is the same as the current name. This is the one
4144 place where that assumption isn't correct; f->name is set, but
4145 the server hasn't been told. */
4146 {
4147 Lisp_Object name;
4148 int explicit = f->explicit_name;
4149
4150 f->explicit_name = 0;
e69b0960 4151 name = f->name;
f00af5b1 4152 fset_name (f, Qnil);
ee78dc32
GV
4153 x_set_name (f, name, explicit);
4154 }
4155
4d7e6e51 4156 unblock_input ();
ee78dc32
GV
4157
4158 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
4159 initialize_frame_menubar (f);
4160
fbd6baed 4161 if (FRAME_W32_WINDOW (f) == 0)
ee78dc32
GV
4162 error ("Unable to create window");
4163}
4164
4165/* Handle the icon stuff for this window. Perhaps later we might
4166 want an x_set_icon_position which can be called interactively as
4167 well. */
4168
4169static void
b56ceb92 4170x_icon (struct frame *f, Lisp_Object parms)
ee78dc32
GV
4171{
4172 Lisp_Object icon_x, icon_y;
3faa984f 4173 struct w32_display_info *dpyinfo = &one_w32_display_info;
ee78dc32 4174
e9e23e23 4175 /* Set the position of the icon. Note that Windows 95 groups all
ee78dc32 4176 icons in the tray. */
3faa984f
JR
4177 icon_x = x_get_arg (dpyinfo, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
4178 icon_y = x_get_arg (dpyinfo, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
ee78dc32
GV
4179 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
4180 {
b7826503
PJ
4181 CHECK_NUMBER (icon_x);
4182 CHECK_NUMBER (icon_y);
ee78dc32
GV
4183 }
4184 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
4185 error ("Both left and top icon corners of icon must be specified");
4186
4d7e6e51 4187 block_input ();
ee78dc32 4188
1edf84e7
GV
4189#if 0 /* TODO */
4190 /* Start up iconic or window? */
4191 x_wm_set_window_state
3faa984f 4192 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL), Qicon)
1edf84e7
GV
4193 ? IconicState
4194 : NormalState));
4195
e69b0960
DA
4196 x_text_icon (f, SSDATA ((!NILP (f->icon_name)
4197 ? f->icon_name
4198 : f->name)));
1edf84e7
GV
4199#endif
4200
4d7e6e51 4201 unblock_input ();
ee78dc32
GV
4202}
4203
6fc2811b
JR
4204
4205static void
b56ceb92 4206x_make_gc (struct frame *f)
6fc2811b
JR
4207{
4208 XGCValues gc_values;
4209
4d7e6e51 4210 block_input ();
6fc2811b
JR
4211
4212 /* Create the GC's of this frame.
4213 Note that many default values are used. */
4214
4215 /* Normal video */
be786000 4216 gc_values.font = FRAME_FONT (f);
6fc2811b
JR
4217
4218 /* Cursor has cursor-color background, background-color foreground. */
4219 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
4220 gc_values.background = f->output_data.w32->cursor_pixel;
4221 f->output_data.w32->cursor_gc
4222 = XCreateGC (NULL, FRAME_W32_WINDOW (f),
4223 (GCFont | GCForeground | GCBackground),
4224 &gc_values);
4225
4226 /* Reliefs. */
4227 f->output_data.w32->white_relief.gc = 0;
4228 f->output_data.w32->black_relief.gc = 0;
4229
4d7e6e51 4230 unblock_input ();
6fc2811b
JR
4231}
4232
4233
937e601e 4234/* Handler for signals raised during x_create_frame and
a06776b2 4235 x_create_tip_frame. FRAME is the frame which is partially
937e601e
AI
4236 constructed. */
4237
4238static Lisp_Object
b56ceb92 4239unwind_create_frame (Lisp_Object frame)
937e601e
AI
4240{
4241 struct frame *f = XFRAME (frame);
4242
4243 /* If frame is ``official'', nothing to do. */
97f18cc8 4244 if (NILP (Fmemq (frame, Vframe_list)))
937e601e 4245 {
e509cfa6 4246#ifdef GLYPH_DEBUG
aad3612f 4247 struct w32_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
937e601e 4248#endif
7d0393cf 4249
937e601e 4250 x_free_frame_resources (f);
84c3edb9 4251 free_glyphs (f);
937e601e 4252
e509cfa6 4253#ifdef GLYPH_DEBUG
937e601e 4254 /* Check that reference counts are indeed correct. */
a54e2c05 4255 eassert (dpyinfo->reference_count == dpyinfo_refcount);
f7551c6c
EZ
4256 eassert ((dpyinfo->terminal->image_cache == NULL
4257 && image_cache_refcount == 0)
4258 || dpyinfo->terminal->image_cache->refcount == image_cache_refcount);
a9b555d3 4259#endif
c844a81a 4260 return Qt;
937e601e 4261 }
7d0393cf 4262
937e601e
AI
4263 return Qnil;
4264}
4265
27e498e6
PE
4266static void
4267do_unwind_create_frame (Lisp_Object frame)
4268{
4269 unwind_create_frame (frame);
4270}
4271
0cbab19e
MR
4272static void
4273unwind_create_frame_1 (Lisp_Object val)
4274{
4275 inhibit_lisp_code = val;
4276}
4277
a1fe5c00 4278static void
b56ceb92 4279x_default_font_parameter (struct frame *f, Lisp_Object parms)
a1fe5c00 4280{
aad3612f 4281 struct w32_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
770e2e6e
SM
4282 Lisp_Object font_param = x_get_arg (dpyinfo, parms, Qfont, NULL, NULL,
4283 RES_TYPE_STRING);
4284 Lisp_Object font;
4285 if (EQ (font_param, Qunbound))
4286 font_param = Qnil;
4287 font = !NILP (font_param) ? font_param
4288 : x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
a1fe5c00
JR
4289
4290 if (!STRINGP (font))
4291 {
4292 int i;
4293 static char *names[]
82523155 4294 = { "Courier New-10",
a1fe5c00
JR
4295 "-*-Courier-normal-r-*-*-13-*-*-*-c-*-iso8859-1",
4296 "-*-Fixedsys-normal-r-*-*-12-*-*-*-c-*-iso8859-1",
4297 "Fixedsys",
4298 NULL };
4299
4300 for (i = 0; names[i]; i++)
4301 {
d7ea76b4 4302 font = font_open_by_name (f, build_unibyte_string (names[i]));
a1fe5c00
JR
4303 if (! NILP (font))
4304 break;
4305 }
4306 if (NILP (font))
4307 error ("No suitable font was found");
4308 }
770e2e6e 4309 else if (!NILP (font_param))
27129af9
SM
4310 {
4311 /* Remember the explicit font parameter, so we can re-apply it after
4312 we've applied the `default' face settings. */
770e2e6e
SM
4313 x_set_frame_parameters (f, Fcons (Fcons (Qfont_param, font_param), Qnil));
4314 }
a1fe5c00
JR
4315 x_default_parameter (f, parms, Qfont, font, "font", "Font", RES_TYPE_STRING);
4316}
937e601e 4317
ee78dc32
GV
4318DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
4319 1, 1, 0,
74e1aeec 4320 doc: /* Make a new window, which is called a \"frame\" in Emacs terms.
36458ebd 4321Return an Emacs frame object.
52deb19f 4322PARAMETERS is an alist of frame parameters.
74e1aeec
JR
4323If the parameters specify that the frame should not have a minibuffer,
4324and do not specify a specific minibuffer window to use,
4325then `default-minibuffer-frame' must be a frame whose minibuffer can
4326be shared by the new frame.
4327
4328This function is an internal primitive--use `make-frame' instead. */)
5842a27b 4329 (Lisp_Object parameters)
ee78dc32
GV
4330{
4331 struct frame *f;
4332 Lisp_Object frame, tem;
4333 Lisp_Object name;
4334 int minibuffer_only = 0;
4335 long window_prompting = 0;
4336 int width, height;
d311d28c 4337 ptrdiff_t count = SPECPDL_INDEX ();
1edf84e7 4338 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
ee78dc32 4339 Lisp_Object display;
6fc2811b 4340 struct w32_display_info *dpyinfo = NULL;
ee78dc32
GV
4341 Lisp_Object parent;
4342 struct kboard *kb;
4343
8962d4b3
EZ
4344 if (!FRAME_W32_P (SELECTED_FRAME ())
4345 && !FRAME_INITIAL_P (SELECTED_FRAME ()))
bf7bea5d
EZ
4346 error ("Cannot create a GUI frame in a -nw session");
4347
1da8a031
MR
4348 /* Make copy of frame parameters because the original is in pure
4349 storage now. */
4350 parameters = Fcopy_alist (parameters);
4351
ee78dc32
GV
4352 /* Use this general default value to start with
4353 until we know if this frame has a specified name. */
4354 Vx_resource_name = Vinvocation_name;
4355
3faa984f
JR
4356 display = x_get_arg (dpyinfo, parameters, Qterminal, 0, 0, RES_TYPE_NUMBER);
4357 if (EQ (display, Qunbound))
4358 display = x_get_arg (dpyinfo, parameters, Qdisplay, 0, 0, RES_TYPE_STRING);
ee78dc32
GV
4359 if (EQ (display, Qunbound))
4360 display = Qnil;
4361 dpyinfo = check_x_display_info (display);
80ca7302 4362 kb = dpyinfo->terminal->kboard;
ee78dc32 4363
3faa984f
JR
4364 if (!dpyinfo->terminal->name)
4365 error ("Terminal is not live, can't create new frames on it");
4366
4367 name = x_get_arg (dpyinfo, parameters, Qname, "name", "Name", RES_TYPE_STRING);
ee78dc32
GV
4368 if (!STRINGP (name)
4369 && ! EQ (name, Qunbound)
4370 && ! NILP (name))
4371 error ("Invalid frame name--not a string or nil");
4372
4373 if (STRINGP (name))
4374 Vx_resource_name = name;
4375
4376 /* See if parent window is specified. */
3faa984f 4377 parent = x_get_arg (dpyinfo, parameters, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
ee78dc32
GV
4378 if (EQ (parent, Qunbound))
4379 parent = Qnil;
4380 if (! NILP (parent))
b7826503 4381 CHECK_NUMBER (parent);
ee78dc32 4382
1edf84e7
GV
4383 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
4384 /* No need to protect DISPLAY because that's not used after passing
4385 it to make_frame_without_minibuffer. */
4386 frame = Qnil;
52deb19f 4387 GCPRO4 (parameters, parent, name, frame);
3faa984f 4388 tem = x_get_arg (dpyinfo, parameters, Qminibuffer, "minibuffer", "Minibuffer",
0cbab19e 4389 RES_TYPE_SYMBOL);
ee78dc32
GV
4390 if (EQ (tem, Qnone) || NILP (tem))
4391 f = make_frame_without_minibuffer (Qnil, kb, display);
4392 else if (EQ (tem, Qonly))
4393 {
4394 f = make_minibuffer_frame ();
4395 minibuffer_only = 1;
4396 }
4397 else if (WINDOWP (tem))
4398 f = make_frame_without_minibuffer (tem, kb, display);
4399 else
4400 f = make_frame (1);
4401
1edf84e7
GV
4402 XSETFRAME (frame, f);
4403
5ac45f98 4404 /* By default, make scrollbars the system standard width. */
44c5e192 4405 x_set_scroll_bar_default_width (f);
ee78dc32 4406
2dc8b986 4407 f->terminal = dpyinfo->terminal;
2dc8b986 4408
fbd6baed 4409 f->output_method = output_w32;
23f86fce 4410 f->output_data.w32 = xzalloc (sizeof (struct w32_output));
4587b026
GV
4411 FRAME_FONTSET (f) = -1;
4412
f00af5b1
PE
4413 fset_icon_name
4414 (f, x_get_arg (dpyinfo, parameters, Qicon_name, "iconName", "Title",
edd74c35 4415 RES_TYPE_STRING));
e69b0960 4416 if (! STRINGP (f->icon_name))
f00af5b1 4417 fset_icon_name (f, Qnil);
1edf84e7 4418
0cbab19e 4419 /* FRAME_DISPLAY_INFO (f) = dpyinfo; */
3faa984f 4420
aad3612f 4421 /* With FRAME_DISPLAY_INFO set up, this unwind-protect is safe. */
27e498e6 4422 record_unwind_protect (do_unwind_create_frame, frame);
0cbab19e 4423
e509cfa6 4424#ifdef GLYPH_DEBUG
a06776b2
EZ
4425 image_cache_refcount =
4426 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
3faa984f
JR
4427 dpyinfo_refcount = dpyinfo->reference_count;
4428#endif /* GLYPH_DEBUG */
ee78dc32
GV
4429
4430 /* Specify the parent under which to make this window. */
4431
4432 if (!NILP (parent))
4433 {
1660f34a 4434 f->output_data.w32->parent_desc = (Window) XFASTINT (parent);
fbd6baed 4435 f->output_data.w32->explicit_parent = 1;
ee78dc32
GV
4436 }
4437 else
4438 {
aad3612f 4439 f->output_data.w32->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
fbd6baed 4440 f->output_data.w32->explicit_parent = 0;
ee78dc32
GV
4441 }
4442
ee78dc32
GV
4443 /* Set the name; the functions to which we pass f expect the name to
4444 be set. */
4445 if (EQ (name, Qunbound) || NILP (name))
4446 {
f00af5b1 4447 fset_name (f, build_string (dpyinfo->w32_id_name));
ee78dc32
GV
4448 f->explicit_name = 0;
4449 }
4450 else
4451 {
f00af5b1 4452 fset_name (f, name);
ee78dc32
GV
4453 f->explicit_name = 1;
4454 /* use the frame's title when getting resources for this frame. */
4455 specbind (Qx_resource_name, name);
4456 }
4457
1cc06b86
KH
4458 if (uniscribe_available)
4459 register_font_driver (&uniscribe_font_driver, f);
4460 register_font_driver (&w32font_driver, f);
a1fe5c00 4461
1cc06b86
KH
4462 x_default_parameter (f, parameters, Qfont_backend, Qnil,
4463 "fontBackend", "FontBackend", RES_TYPE_STRING);
ee78dc32
GV
4464 /* Extract the window parameters from the supplied values
4465 that are needed to determine window geometry. */
1cc06b86 4466 x_default_font_parameter (f, parameters);
52deb19f 4467 x_default_parameter (f, parameters, Qborder_width, make_number (2),
1660f34a 4468 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
3faa984f 4469
601a9cf1 4470 /* We recognize either internalBorderWidth or internalBorder
3faa984f 4471 (which is what xterm calls it). */
52deb19f 4472 if (NILP (Fassq (Qinternal_border_width, parameters)))
ee78dc32
GV
4473 {
4474 Lisp_Object value;
4475
3faa984f 4476 value = x_get_arg (dpyinfo, parameters, Qinternal_border_width,
0cbab19e 4477 "internalBorder", "InternalBorder", RES_TYPE_NUMBER);
ee78dc32 4478 if (! EQ (value, Qunbound))
52deb19f
JB
4479 parameters = Fcons (Fcons (Qinternal_border_width, value),
4480 parameters);
ee78dc32 4481 }
1edf84e7 4482 /* Default internalBorderWidth to 0 on Windows to match other programs. */
52deb19f 4483 x_default_parameter (f, parameters, Qinternal_border_width, make_number (0),
1660f34a 4484 "internalBorderWidth", "InternalBorder", RES_TYPE_NUMBER);
880e6158
MR
4485 x_default_parameter (f, parameters, Qright_divider_width, make_number (0),
4486 NULL, NULL, RES_TYPE_NUMBER);
4487 x_default_parameter (f, parameters, Qbottom_divider_width, make_number (0),
4488 NULL, NULL, RES_TYPE_NUMBER);
52deb19f 4489 x_default_parameter (f, parameters, Qvertical_scroll_bars, Qright,
1660f34a 4490 "verticalScrollBars", "ScrollBars", RES_TYPE_SYMBOL);
ee78dc32
GV
4491
4492 /* Also do the stuff which must be set before the window exists. */
52deb19f 4493 x_default_parameter (f, parameters, Qforeground_color, build_string ("black"),
6fc2811b 4494 "foreground", "Foreground", RES_TYPE_STRING);
52deb19f 4495 x_default_parameter (f, parameters, Qbackground_color, build_string ("white"),
6fc2811b 4496 "background", "Background", RES_TYPE_STRING);
52deb19f 4497 x_default_parameter (f, parameters, Qmouse_color, build_string ("black"),
6fc2811b 4498 "pointerColor", "Foreground", RES_TYPE_STRING);
52deb19f 4499 x_default_parameter (f, parameters, Qborder_color, build_string ("black"),
6fc2811b 4500 "borderColor", "BorderColor", RES_TYPE_STRING);
52deb19f 4501 x_default_parameter (f, parameters, Qscreen_gamma, Qnil,
6fc2811b 4502 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
52deb19f 4503 x_default_parameter (f, parameters, Qline_spacing, Qnil,
dfff8a69 4504 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
52deb19f 4505 x_default_parameter (f, parameters, Qleft_fringe, Qnil,
41c1bdd9 4506 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
52deb19f 4507 x_default_parameter (f, parameters, Qright_fringe, Qnil,
41c1bdd9 4508 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
b4168649
MR
4509 /* Process alpha here (Bug#16619). */
4510 x_default_parameter (f, parameters, Qalpha, Qnil,
4511 "alpha", "Alpha", RES_TYPE_NUMBER);
6fc2811b 4512
6fc2811b
JR
4513 /* Init faces before x_default_parameter is called for scroll-bar
4514 parameters because that function calls x_set_scroll_bar_width,
4515 which calls change_frame_size, which calls Fset_window_buffer,
4516 which runs hooks, which call Fvertical_motion. At the end, we
4517 end up in init_iterator with a null face cache, which should not
4518 happen. */
4519 init_frame_faces (f);
7d0393cf 4520
45ccd909
MR
4521 /* Avoid calling window-configuration-change-hook; otherwise we
4522 could get an infloop in next_frame since the frame is not yet in
4523 Vframe_list. */
4524 {
4525 ptrdiff_t count2 = SPECPDL_INDEX ();
4526
4527 record_unwind_protect (unwind_create_frame_1, inhibit_lisp_code);
4528 inhibit_lisp_code = Qt;
4529
4530 /* PXW: This is a duplicate from below. We have to do it here since
4531 otherwise x_set_tool_bar_lines will work with the character sizes
4532 installed by init_frame_faces while the frame's pixel size is still
4533 calculated from a character size of 1 and we subsequently hit the
4534 eassert (height >= 0) assertion in window_box_height. The
4535 non-pixelwise code apparently worked around this because it had one
4536 frame line vs one toolbar line which left us with a zero root
4537 window height which was obviously wrong as well ... */
4538 change_frame_size (f, FRAME_COLS (f) * FRAME_COLUMN_WIDTH (f),
4539 FRAME_LINES (f) * FRAME_LINE_HEIGHT (f), 1, 0, 0, 1);
4540
4541 /* The X resources controlling the menu-bar and tool-bar are
4542 processed specially at startup, and reflected in the mode
4543 variables; ignore them here. */
4544 x_default_parameter (f, parameters, Qmenu_bar_lines,
4545 NILP (Vmenu_bar_mode)
4546 ? make_number (0) : make_number (1),
4547 NULL, NULL, RES_TYPE_NUMBER);
4548 x_default_parameter (f, parameters, Qtool_bar_lines,
4549 NILP (Vtool_bar_mode)
4550 ? make_number (0) : make_number (1),
4551 NULL, NULL, RES_TYPE_NUMBER);
4552
4553 unbind_to (count2, Qnil);
4554 }
919f1e88 4555
52deb19f 4556 x_default_parameter (f, parameters, Qbuffer_predicate, Qnil,
6fc2811b 4557 "bufferPredicate", "BufferPredicate", RES_TYPE_SYMBOL);
52deb19f 4558 x_default_parameter (f, parameters, Qtitle, Qnil,
6fc2811b 4559 "title", "Title", RES_TYPE_STRING);
52deb19f 4560 x_default_parameter (f, parameters, Qfullscreen, Qnil,
f7b9d4d1 4561 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
ee78dc32 4562
fbd6baed 4563 f->output_data.w32->dwStyle = WS_OVERLAPPEDWINDOW;
aad3612f 4564 f->output_data.w32->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
3cf3436e 4565
c9b2104d
JR
4566 f->output_data.w32->text_cursor = w32_load_cursor (IDC_IBEAM);
4567 f->output_data.w32->nontext_cursor = w32_load_cursor (IDC_ARROW);
4568 f->output_data.w32->modeline_cursor = w32_load_cursor (IDC_ARROW);
7d63e5e3 4569 f->output_data.w32->hand_cursor = w32_load_cursor (IDC_HAND);
c9b2104d
JR
4570 f->output_data.w32->hourglass_cursor = w32_load_cursor (IDC_WAIT);
4571 f->output_data.w32->horizontal_drag_cursor = w32_load_cursor (IDC_SIZEWE);
880e6158 4572 f->output_data.w32->vertical_drag_cursor = w32_load_cursor (IDC_SIZENS);
c9b2104d 4573
d148e14d
JR
4574 f->output_data.w32->current_cursor = f->output_data.w32->nontext_cursor;
4575
52deb19f 4576 window_prompting = x_figure_window_size (f, parameters, 1);
ee78dc32 4577
3faa984f 4578 tem = x_get_arg (dpyinfo, parameters, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
6fc2811b
JR
4579 f->no_split = minibuffer_only || EQ (tem, Qt);
4580
fbd6baed 4581 w32_window (f, window_prompting, minibuffer_only);
52deb19f 4582 x_icon (f, parameters);
6fc2811b
JR
4583
4584 x_make_gc (f);
4585
4586 /* Now consider the frame official. */
a06776b2 4587 f->terminal->reference_count++;
aad3612f 4588 FRAME_DISPLAY_INFO (f)->reference_count++;
6fc2811b 4589 Vframe_list = Fcons (frame, Vframe_list);
ee78dc32
GV
4590
4591 /* We need to do this after creating the window, so that the
4592 icon-creation functions can say whose icon they're describing. */
52deb19f 4593 x_default_parameter (f, parameters, Qicon_type, Qnil,
6fc2811b 4594 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
ee78dc32 4595
52deb19f 4596 x_default_parameter (f, parameters, Qauto_raise, Qnil,
6fc2811b 4597 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
52deb19f 4598 x_default_parameter (f, parameters, Qauto_lower, Qnil,
6fc2811b 4599 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
52deb19f 4600 x_default_parameter (f, parameters, Qcursor_type, Qbox,
6fc2811b 4601 "cursorType", "CursorType", RES_TYPE_SYMBOL);
52deb19f 4602 x_default_parameter (f, parameters, Qscroll_bar_width, Qnil,
6fc2811b 4603 "scrollBarWidth", "ScrollBarWidth", RES_TYPE_NUMBER);
ee78dc32 4604
be786000 4605 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
ee78dc32 4606 Change will not be effected unless different from the current
be786000 4607 FRAME_LINES (f). */
880e6158
MR
4608 width = FRAME_TEXT_WIDTH (f);
4609 height = FRAME_TEXT_HEIGHT (f);
4610 FRAME_TEXT_HEIGHT (f) = 0;
4611 SET_FRAME_WIDTH (f, 0);
4612 change_frame_size (f, width, height, 1, 0, 0, 1);
6fc2811b 4613
6fc2811b
JR
4614 /* Tell the server what size and position, etc, we want, and how
4615 badly we want them. This should be done after we have the menu
4616 bar so that its size can be taken into account. */
4d7e6e51 4617 block_input ();
ee78dc32 4618 x_wm_set_size_hint (f, window_prompting, 0);
4d7e6e51 4619 unblock_input ();
ee78dc32 4620
6fc2811b
JR
4621 /* Make the window appear on the frame and enable display, unless
4622 the caller says not to. However, with explicit parent, Emacs
4623 cannot control visibility, so don't try. */
fbd6baed 4624 if (! f->output_data.w32->explicit_parent)
ee78dc32
GV
4625 {
4626 Lisp_Object visibility;
4627
3faa984f 4628 visibility = x_get_arg (dpyinfo, parameters, Qvisibility, 0, 0, RES_TYPE_SYMBOL);
ee78dc32
GV
4629 if (EQ (visibility, Qunbound))
4630 visibility = Qt;
4631
4632 if (EQ (visibility, Qicon))
4633 x_iconify_frame (f);
4634 else if (! NILP (visibility))
4635 x_make_frame_visible (f);
4636 else
4637 /* Must have been Qnil. */
4638 ;
4639 }
55d5acfa
DN
4640
4641 /* Initialize `default-minibuffer-frame' in case this is the first
4642 frame on this terminal. */
4643 if (FRAME_HAS_MINIBUF_P (f)
05c65251
EZ
4644 && (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
4645 || !FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame)))))
15dbb4d6 4646 kset_default_minibuffer_frame (kb, frame);
55d5acfa
DN
4647
4648 /* All remaining specified parameters, which have not been "used"
4649 by x_get_arg and friends, now go in the misc. alist of the frame. */
99784d63 4650 for (tem = parameters; CONSP (tem); tem = XCDR (tem))
55d5acfa 4651 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
f00af5b1 4652 fset_param_alist (f, Fcons (XCAR (tem), f->param_alist));
55d5acfa 4653
6fc2811b 4654 UNGCPRO;
7d0393cf 4655
9e57df62
GM
4656 /* Make sure windows on this frame appear in calls to next-window
4657 and similar functions. */
4658 Vwindow_list = Qnil;
7d0393cf 4659
ee78dc32
GV
4660 return unbind_to (count, frame);
4661}
4662
4663/* FRAME is used only to get a handle on the X display. We don't pass the
4664 display info directly because we're called from frame.c, which doesn't
4665 know about that structure. */
4666Lisp_Object
b56ceb92 4667x_get_focus_frame (struct frame *frame)
ee78dc32 4668{
aad3612f 4669 struct w32_display_info *dpyinfo = FRAME_DISPLAY_INFO (frame);
ee78dc32 4670 Lisp_Object xfocus;
fbd6baed 4671 if (! dpyinfo->w32_focus_frame)
ee78dc32
GV
4672 return Qnil;
4673
fbd6baed 4674 XSETFRAME (xfocus, dpyinfo->w32_focus_frame);
ee78dc32
GV
4675 return xfocus;
4676}
1edf84e7 4677
6fc2811b 4678DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
4f4f2973
GM
4679 doc: /* Internal function called by `color-defined-p', which see.
4680\(Note that the Nextstep version of this function ignores FRAME.) */)
5842a27b 4681 (Lisp_Object color, Lisp_Object frame)
6fc2811b
JR
4682{
4683 XColor foo;
a10c8269 4684 struct frame *f = decode_window_system_frame (frame);
ee78dc32 4685
b7826503 4686 CHECK_STRING (color);
ee78dc32 4687
d5db4077 4688 if (w32_defined_color (f, SDATA (color), &foo, 0))
6fc2811b
JR
4689 return Qt;
4690 else
4691 return Qnil;
4692}
ee78dc32 4693
2d764c78 4694DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
74e1aeec 4695 doc: /* Internal function called by `color-values', which see. */)
5842a27b 4696 (Lisp_Object color, Lisp_Object frame)
ee78dc32 4697{
6fc2811b 4698 XColor foo;
a10c8269 4699 struct frame *f = decode_window_system_frame (frame);
ee78dc32 4700
b7826503 4701 CHECK_STRING (color);
ee78dc32 4702
d5db4077 4703 if (w32_defined_color (f, SDATA (color), &foo, 0))
3de717bd
DA
4704 return list3i ((GetRValue (foo.pixel) << 8) | GetRValue (foo.pixel),
4705 (GetGValue (foo.pixel) << 8) | GetGValue (foo.pixel),
4706 (GetBValue (foo.pixel) << 8) | GetBValue (foo.pixel));
ee78dc32
GV
4707 else
4708 return Qnil;
4709}
4710
2d764c78 4711DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
74e1aeec 4712 doc: /* Internal function called by `display-color-p', which see. */)
5842a27b 4713 (Lisp_Object display)
ee78dc32 4714{
fbd6baed 4715 struct w32_display_info *dpyinfo = check_x_display_info (display);
ee78dc32
GV
4716
4717 if ((dpyinfo->n_planes * dpyinfo->n_cbits) <= 2)
4718 return Qnil;
4719
4720 return Qt;
4721}
4722
74e1aeec
JR
4723DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p,
4724 Sx_display_grayscale_p, 0, 1, 0,
52deb19f 4725 doc: /* Return t if DISPLAY supports shades of gray.
74e1aeec
JR
4726Note that color displays do support shades of gray.
4727The optional argument DISPLAY specifies which display to ask about.
4728DISPLAY should be either a frame or a display name (a string).
4729If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4730 (Lisp_Object display)
ee78dc32 4731{
fbd6baed 4732 struct w32_display_info *dpyinfo = check_x_display_info (display);
ee78dc32
GV
4733
4734 if ((dpyinfo->n_planes * dpyinfo->n_cbits) <= 1)
4735 return Qnil;
4736
4737 return Qt;
4738}
4739
74e1aeec
JR
4740DEFUN ("x-display-pixel-width", Fx_display_pixel_width,
4741 Sx_display_pixel_width, 0, 1, 0,
36458ebd 4742 doc: /* Return the width in pixels of DISPLAY.
74e1aeec
JR
4743The optional argument DISPLAY specifies which display to ask about.
4744DISPLAY should be either a frame or a display name (a string).
cf13177e
YM
4745If omitted or nil, that stands for the selected frame's display.
4746
4747On \"multi-monitor\" setups this refers to the pixel width for all
4748physical monitors associated with DISPLAY. To get information for
4749each physical monitor, use `display-monitor-attributes-list'. */)
5842a27b 4750 (Lisp_Object display)
ee78dc32 4751{
fbd6baed 4752 struct w32_display_info *dpyinfo = check_x_display_info (display);
ee78dc32 4753
05eb7cdc 4754 return make_number (x_display_pixel_width (dpyinfo));
ee78dc32
GV
4755}
4756
4757DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
74e1aeec 4758 Sx_display_pixel_height, 0, 1, 0,
36458ebd 4759 doc: /* Return the height in pixels of DISPLAY.
74e1aeec
JR
4760The optional argument DISPLAY specifies which display to ask about.
4761DISPLAY should be either a frame or a display name (a string).
cf13177e
YM
4762If omitted or nil, that stands for the selected frame's display.
4763
4764On \"multi-monitor\" setups this refers to the pixel height for all
4765physical monitors associated with DISPLAY. To get information for
4766each physical monitor, use `display-monitor-attributes-list'. */)
5842a27b 4767 (Lisp_Object display)
ee78dc32 4768{
fbd6baed 4769 struct w32_display_info *dpyinfo = check_x_display_info (display);
ee78dc32 4770
05eb7cdc 4771 return make_number (x_display_pixel_height (dpyinfo));
ee78dc32
GV
4772}
4773
4774DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
74e1aeec 4775 0, 1, 0,
36458ebd 4776 doc: /* Return the number of bitplanes of DISPLAY.
74e1aeec
JR
4777The optional argument DISPLAY specifies which display to ask about.
4778DISPLAY should be either a frame or a display name (a string).
4779If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4780 (Lisp_Object display)
ee78dc32 4781{
fbd6baed 4782 struct w32_display_info *dpyinfo = check_x_display_info (display);
ee78dc32
GV
4783
4784 return make_number (dpyinfo->n_planes * dpyinfo->n_cbits);
4785}
4786
4787DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
74e1aeec 4788 0, 1, 0,
36458ebd 4789 doc: /* Return the number of color cells of DISPLAY.
74e1aeec
JR
4790The optional argument DISPLAY specifies which display to ask about.
4791DISPLAY should be either a frame or a display name (a string).
4792If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4793 (Lisp_Object display)
ee78dc32 4794{
fbd6baed 4795 struct w32_display_info *dpyinfo = check_x_display_info (display);
ee78dc32
GV
4796 int cap;
4797
821812e2
DC
4798 /* Don't use NCOLORS: it returns incorrect results under remote
4799 * desktop. We force 24+ bit depths to 24-bit, both to prevent an
4800 * overflow and because probably is more meaningful on Windows
4801 * anyway. */
7d0393cf 4802
821812e2 4803 cap = 1 << min (dpyinfo->n_planes * dpyinfo->n_cbits, 24);
ee78dc32
GV
4804 return make_number (cap);
4805}
4806
4807DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
4808 Sx_server_max_request_size,
74e1aeec 4809 0, 1, 0,
36458ebd 4810 doc: /* Return the maximum request size of the server of DISPLAY.
74e1aeec
JR
4811The optional argument DISPLAY specifies which display to ask about.
4812DISPLAY should be either a frame or a display name (a string).
4813If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4814 (Lisp_Object display)
ee78dc32 4815{
ee78dc32
GV
4816 return make_number (1);
4817}
4818
4819DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
36458ebd 4820 doc: /* Return the "vendor ID" string of the W32 system (Microsoft).
74e1aeec
JR
4821The optional argument DISPLAY specifies which display to ask about.
4822DISPLAY should be either a frame or a display name (a string).
4823If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4824 (Lisp_Object display)
ee78dc32 4825{
dfff8a69 4826 return build_string ("Microsoft Corp.");
ee78dc32
GV
4827}
4828
4829DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
36458ebd 4830 doc: /* Return the version numbers of the server of DISPLAY.
74e1aeec 4831The value is a list of three integers: the major and minor
02b39a28
JB
4832version numbers of the X Protocol in use, and the distributor-specific
4833release number. See also the function `x-server-vendor'.
74e1aeec
JR
4834
4835The optional argument DISPLAY specifies which display to ask about.
4836DISPLAY should be either a frame or a display name (a string).
4837If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4838 (Lisp_Object display)
ee78dc32 4839{
3de717bd 4840 return list3i (w32_major_version, w32_minor_version, w32_build_number);
ee78dc32
GV
4841}
4842
4843DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
36458ebd 4844 doc: /* Return the number of screens on the server of DISPLAY.
74e1aeec
JR
4845The optional argument DISPLAY specifies which display to ask about.
4846DISPLAY should be either a frame or a display name (a string).
4847If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4848 (Lisp_Object display)
ee78dc32 4849{
ee78dc32
GV
4850 return make_number (1);
4851}
4852
74e1aeec
JR
4853DEFUN ("x-display-mm-height", Fx_display_mm_height,
4854 Sx_display_mm_height, 0, 1, 0,
36458ebd 4855 doc: /* Return the height in millimeters of DISPLAY.
74e1aeec
JR
4856The optional argument DISPLAY specifies which display to ask about.
4857DISPLAY should be either a frame or a display name (a string).
cf13177e
YM
4858If omitted or nil, that stands for the selected frame's display.
4859
4860On \"multi-monitor\" setups this refers to the height in millimeters for
4861all physical monitors associated with DISPLAY. To get information
4862for each physical monitor, use `display-monitor-attributes-list'. */)
5842a27b 4863 (Lisp_Object display)
ee78dc32 4864{
fbd6baed 4865 struct w32_display_info *dpyinfo = check_x_display_info (display);
ee78dc32 4866 HDC hdc;
cf13177e 4867 double mm_per_pixel;
7d0393cf 4868
cf13177e
YM
4869 hdc = GetDC (NULL);
4870 mm_per_pixel = ((double) GetDeviceCaps (hdc, VERTSIZE)
4871 / GetDeviceCaps (hdc, VERTRES));
4872 ReleaseDC (NULL, hdc);
7d0393cf 4873
cf13177e 4874 return make_number (x_display_pixel_height (dpyinfo) * mm_per_pixel + 0.5);
ee78dc32
GV
4875}
4876
4877DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
36458ebd 4878 doc: /* Return the width in millimeters of DISPLAY.
74e1aeec
JR
4879The optional argument DISPLAY specifies which display to ask about.
4880DISPLAY should be either a frame or a display name (a string).
cf13177e
YM
4881If omitted or nil, that stands for the selected frame's display.
4882
4883On \"multi-monitor\" setups this refers to the width in millimeters for
4884all physical monitors associated with TERMINAL. To get information
4885for each physical monitor, use `display-monitor-attributes-list'. */)
5842a27b 4886 (Lisp_Object display)
ee78dc32 4887{
fbd6baed 4888 struct w32_display_info *dpyinfo = check_x_display_info (display);
ee78dc32 4889 HDC hdc;
cf13177e 4890 double mm_per_pixel;
ee78dc32 4891
cf13177e
YM
4892 hdc = GetDC (NULL);
4893 mm_per_pixel = ((double) GetDeviceCaps (hdc, HORZSIZE)
4894 / GetDeviceCaps (hdc, HORZRES));
4895 ReleaseDC (NULL, hdc);
7d0393cf 4896
cf13177e 4897 return make_number (x_display_pixel_width (dpyinfo) * mm_per_pixel + 0.5);
ee78dc32
GV
4898}
4899
4900DEFUN ("x-display-backing-store", Fx_display_backing_store,
74e1aeec 4901 Sx_display_backing_store, 0, 1, 0,
36458ebd 4902 doc: /* Return an indication of whether DISPLAY does backing store.
74e1aeec
JR
4903The value may be `always', `when-mapped', or `not-useful'.
4904The optional argument DISPLAY specifies which display to ask about.
4905DISPLAY should be either a frame or a display name (a string).
4906If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4907 (Lisp_Object display)
ee78dc32
GV
4908{
4909 return intern ("not-useful");
4910}
4911
4912DEFUN ("x-display-visual-class", Fx_display_visual_class,
74e1aeec 4913 Sx_display_visual_class, 0, 1, 0,
36458ebd 4914 doc: /* Return the visual class of DISPLAY.
74e1aeec
JR
4915The value is one of the symbols `static-gray', `gray-scale',
4916`static-color', `pseudo-color', `true-color', or `direct-color'.
4917
4918The optional argument DISPLAY specifies which display to ask about.
4919DISPLAY should be either a frame or a display name (a string).
4920If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4921 (Lisp_Object display)
ee78dc32 4922{
fbd6baed 4923 struct w32_display_info *dpyinfo = check_x_display_info (display);
abf8c61b 4924 Lisp_Object result = Qnil;
ee78dc32 4925
abf8c61b
AI
4926 if (dpyinfo->has_palette)
4927 result = intern ("pseudo-color");
4928 else if (dpyinfo->n_planes * dpyinfo->n_cbits == 1)
4929 result = intern ("static-grey");
4930 else if (dpyinfo->n_planes * dpyinfo->n_cbits == 4)
4931 result = intern ("static-color");
4932 else if (dpyinfo->n_planes * dpyinfo->n_cbits > 8)
4933 result = intern ("true-color");
ee78dc32 4934
abf8c61b 4935 return result;
ee78dc32
GV
4936}
4937
4938DEFUN ("x-display-save-under", Fx_display_save_under,
74e1aeec 4939 Sx_display_save_under, 0, 1, 0,
02b39a28 4940 doc: /* Return t if DISPLAY supports the save-under feature.
74e1aeec
JR
4941The optional argument DISPLAY specifies which display to ask about.
4942DISPLAY should be either a frame or a display name (a string).
4943If omitted or nil, that stands for the selected frame's display. */)
5842a27b 4944 (Lisp_Object display)
ee78dc32 4945{
6fc2811b
JR
4946 return Qnil;
4947}
0fda9b75 4948
cf13177e
YM
4949static BOOL CALLBACK
4950w32_monitor_enum (HMONITOR monitor, HDC hdc, RECT *rcMonitor, LPARAM dwData)
4951{
4952 Lisp_Object *monitor_list = (Lisp_Object *) dwData;
4953
1396ac86 4954 *monitor_list = Fcons (make_save_ptr (monitor), *monitor_list);
cf13177e
YM
4955
4956 return TRUE;
4957}
4958
4959static Lisp_Object
4960w32_display_monitor_attributes_list (void)
4961{
4962 Lisp_Object attributes_list = Qnil, primary_monitor_attributes = Qnil;
4963 Lisp_Object monitor_list = Qnil, monitor_frames, rest, frame;
4964 int i, n_monitors;
4965 HMONITOR *monitors;
4966 struct gcpro gcpro1, gcpro2, gcpro3;
4967
4968 if (!(enum_display_monitors_fn && get_monitor_info_fn
4969 && monitor_from_window_fn))
4970 return Qnil;
4971
4972 if (!enum_display_monitors_fn (NULL, NULL, w32_monitor_enum,
4973 (LPARAM) &monitor_list)
4974 || NILP (monitor_list))
4975 return Qnil;
4976
4977 n_monitors = 0;
4978 for (rest = monitor_list; CONSP (rest); rest = XCDR (rest))
4979 n_monitors++;
4980
4981 monitors = xmalloc (n_monitors * sizeof (*monitors));
4982 for (i = 0; i < n_monitors; i++)
4983 {
4984 monitors[i] = XSAVE_POINTER (XCAR (monitor_list), 0);
4985 monitor_list = XCDR (monitor_list);
4986 }
4987
4988 monitor_frames = Fmake_vector (make_number (n_monitors), Qnil);
4989 FOR_EACH_FRAME (rest, frame)
4990 {
4991 struct frame *f = XFRAME (frame);
4992
4993 if (FRAME_W32_P (f) && !EQ (frame, tip_frame))
4994 {
4995 HMONITOR monitor =
4996 monitor_from_window_fn (FRAME_W32_WINDOW (f),
4997 MONITOR_DEFAULT_TO_NEAREST);
4998
4999 for (i = 0; i < n_monitors; i++)
5000 if (monitors[i] == monitor)
5001 break;
5002
5003 if (i < n_monitors)
5004 ASET (monitor_frames, i, Fcons (frame, AREF (monitor_frames, i)));
5005 }
5006 }
5007
5008 GCPRO3 (attributes_list, primary_monitor_attributes, monitor_frames);
5009
5010 for (i = 0; i < n_monitors; i++)
5011 {
5012 Lisp_Object geometry, workarea, name, attributes = Qnil;
5013 HDC hdc;
5014 int width_mm, height_mm;
5015 struct MONITOR_INFO_EX mi;
5016
5017 mi.cbSize = sizeof (mi);
5018 if (!get_monitor_info_fn (monitors[i], (struct MONITOR_INFO *) &mi))
5019 continue;
5020
5021 hdc = CreateDCA ("DISPLAY", mi.szDevice, NULL, NULL);
5022 if (hdc == NULL)
5023 continue;
5024 width_mm = GetDeviceCaps (hdc, HORZSIZE);
5025 height_mm = GetDeviceCaps (hdc, VERTSIZE);
5026 DeleteDC (hdc);
5027
5028 attributes = Fcons (Fcons (Qframes, AREF (monitor_frames, i)),
5029 attributes);
5030
309f24d1
DA
5031 name = DECODE_SYSTEM (build_unibyte_string (mi.szDevice));
5032
cf13177e
YM
5033 attributes = Fcons (Fcons (Qname, name), attributes);
5034
5035 attributes = Fcons (Fcons (Qmm_size, list2i (width_mm, height_mm)),
5036 attributes);
5037
5038 workarea = list4i (mi.rcWork.left, mi.rcWork.top,
5039 mi.rcWork.right - mi.rcWork.left,
5040 mi.rcWork.bottom - mi.rcWork.top);
5041 attributes = Fcons (Fcons (Qworkarea, workarea), attributes);
5042
5043 geometry = list4i (mi.rcMonitor.left, mi.rcMonitor.top,
5044 mi.rcMonitor.right - mi.rcMonitor.left,
5045 mi.rcMonitor.bottom - mi.rcMonitor.top);
5046 attributes = Fcons (Fcons (Qgeometry, geometry), attributes);
5047
5048 if (mi.dwFlags & MONITORINFOF_PRIMARY)
5049 primary_monitor_attributes = attributes;
5050 else
5051 attributes_list = Fcons (attributes, attributes_list);
5052 }
5053
5054 if (!NILP (primary_monitor_attributes))
5055 attributes_list = Fcons (primary_monitor_attributes, attributes_list);
5056
5057 UNGCPRO;
5058
5059 xfree (monitors);
5060
5061 return attributes_list;
5062}
5063
5064static Lisp_Object
5065w32_display_monitor_attributes_list_fallback (struct w32_display_info *dpyinfo)
5066{
5067 Lisp_Object geometry, workarea, frames, rest, frame, attributes = Qnil;
5068 HDC hdc;
5069 double mm_per_pixel;
5070 int pixel_width, pixel_height, width_mm, height_mm;
5071 RECT workarea_rect;
5072
5073 /* Fallback: treat (possibly) multiple physical monitors as if they
5074 formed a single monitor as a whole. This should provide a
5075 consistent result at least on single monitor environments. */
5076 attributes = Fcons (Fcons (Qname, build_string ("combined screen")),
5077 attributes);
5078
5079 frames = Qnil;
5080 FOR_EACH_FRAME (rest, frame)
5081 {
5082 struct frame *f = XFRAME (frame);
5083
5084 if (FRAME_W32_P (f) && !EQ (frame, tip_frame))
5085 frames = Fcons (frame, frames);
5086 }
5087 attributes = Fcons (Fcons (Qframes, frames), attributes);
5088
5089 pixel_width = x_display_pixel_width (dpyinfo);
5090 pixel_height = x_display_pixel_height (dpyinfo);
5091
5092 hdc = GetDC (NULL);
5093 mm_per_pixel = ((double) GetDeviceCaps (hdc, HORZSIZE)
5094 / GetDeviceCaps (hdc, HORZRES));
5095 width_mm = pixel_width * mm_per_pixel + 0.5;
5096 mm_per_pixel = ((double) GetDeviceCaps (hdc, VERTSIZE)
5097 / GetDeviceCaps (hdc, VERTRES));
5098 height_mm = pixel_height * mm_per_pixel + 0.5;
5099 ReleaseDC (NULL, hdc);
5100 attributes = Fcons (Fcons (Qmm_size, list2i (width_mm, height_mm)),
5101 attributes);
5102
5103 /* GetSystemMetrics below may return 0 for Windows 95 or NT 4.0, but
5104 we don't care. */
5105 geometry = list4i (GetSystemMetrics (SM_XVIRTUALSCREEN),
5106 GetSystemMetrics (SM_YVIRTUALSCREEN),
5107 pixel_width, pixel_height);
5108 if (SystemParametersInfo (SPI_GETWORKAREA, 0, &workarea_rect, 0))
5109 workarea = list4i (workarea_rect.left, workarea_rect.top,
5110 workarea_rect.right - workarea_rect.left,
5111 workarea_rect.bottom - workarea_rect.top);
5112 else
5113 workarea = geometry;
5114 attributes = Fcons (Fcons (Qworkarea, workarea), attributes);
5115
5116 attributes = Fcons (Fcons (Qgeometry, geometry), attributes);
5117
5118 return list1 (attributes);
5119}
5120
5121DEFUN ("w32-display-monitor-attributes-list", Fw32_display_monitor_attributes_list,
5122 Sw32_display_monitor_attributes_list,
5123 0, 1, 0,
5124 doc: /* Return a list of physical monitor attributes on the W32 display DISPLAY.
5125
5126The optional argument DISPLAY specifies which display to ask about.
5127DISPLAY should be either a frame or a display name (a string).
5128If omitted or nil, that stands for the selected frame's display.
5129
5130Internal use only, use `display-monitor-attributes-list' instead. */)
5131 (Lisp_Object display)
5132{
5133 struct w32_display_info *dpyinfo = check_x_display_info (display);
5134 Lisp_Object attributes_list;
5135
5136 block_input ();
5137 attributes_list = w32_display_monitor_attributes_list ();
5138 if (NILP (attributes_list))
5139 attributes_list = w32_display_monitor_attributes_list_fallback (dpyinfo);
5140 unblock_input ();
5141
5142 return attributes_list;
5143}
5144
0fda9b75
DC
5145DEFUN ("set-message-beep", Fset_message_beep, Sset_message_beep, 1, 1, 0,
5146 doc: /* Set the sound generated when the bell is rung.
5147SOUND is 'asterisk, 'exclamation, 'hand, 'question, 'ok, or 'silent
5148to use the corresponding system sound for the bell. The 'silent sound
5149prevents Emacs from making any sound at all.
5150SOUND is nil to use the normal beep. */)
5151 (Lisp_Object sound)
5152{
5153 CHECK_SYMBOL (sound);
5154
5155 if (NILP (sound))
5156 sound_type = 0xFFFFFFFF;
5157 else if (EQ (sound, intern ("asterisk")))
5158 sound_type = MB_ICONASTERISK;
5159 else if (EQ (sound, intern ("exclamation")))
5160 sound_type = MB_ICONEXCLAMATION;
5161 else if (EQ (sound, intern ("hand")))
5162 sound_type = MB_ICONHAND;
5163 else if (EQ (sound, intern ("question")))
5164 sound_type = MB_ICONQUESTION;
5165 else if (EQ (sound, intern ("ok")))
5166 sound_type = MB_OK;
5167 else if (EQ (sound, intern ("silent")))
5168 sound_type = MB_EMACS_SILENT;
5169 else
5170 sound_type = 0xFFFFFFFF;
5171
5172 return sound;
5173}
5174
6fc2811b 5175int
b56ceb92 5176x_screen_planes (register struct frame *f)
6fc2811b 5177{
aad3612f 5178 return FRAME_DISPLAY_INFO (f)->n_planes;
6fc2811b
JR
5179}
5180\f
5181/* Return the display structure for the display named NAME.
5182 Open a new connection if necessary. */
5183
5184struct w32_display_info *
b56ceb92 5185x_display_info_for_name (Lisp_Object name)
6fc2811b 5186{
6fc2811b
JR
5187 struct w32_display_info *dpyinfo;
5188
b7826503 5189 CHECK_STRING (name);
6fc2811b 5190
d141d701
DA
5191 for (dpyinfo = &one_w32_display_info; dpyinfo; dpyinfo = dpyinfo->next)
5192 if (!NILP (Fstring_equal (XCAR (dpyinfo->name_list_element), name)))
5193 return dpyinfo;
6fc2811b
JR
5194
5195 /* Use this general default value to start with. */
5196 Vx_resource_name = Vinvocation_name;
5197
5198 validate_x_resource_name ();
5199
5200 dpyinfo = w32_term_init (name, (unsigned char *)0,
51b59d79 5201 SSDATA (Vx_resource_name));
6fc2811b
JR
5202
5203 if (dpyinfo == 0)
d5db4077 5204 error ("Cannot connect to server %s", SDATA (name));
6fc2811b 5205
d5272e33 5206 XSETFASTINT (Vwindow_system_version, w32_major_version);
6fc2811b
JR
5207
5208 return dpyinfo;
5209}
5210
5211DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4f4f2973 5212 1, 3, 0, doc: /* Open a connection to a display server.
74e1aeec
JR
5213DISPLAY is the name of the display to connect to.
5214Optional second arg XRM-STRING is a string of resources in xrdb format.
5215If the optional third arg MUST-SUCCEED is non-nil,
4f4f2973
GM
5216terminate Emacs if we can't open the connection.
5217\(In the Nextstep version, the last two arguments are currently ignored.) */)
5842a27b 5218 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
6fc2811b
JR
5219{
5220 unsigned char *xrm_option;
5221 struct w32_display_info *dpyinfo;
5222
efc3dd3c
DC
5223 CHECK_STRING (display);
5224
5225 /* Signal an error in order to encourage correct use from callers.
5226 * If we ever support multiple window systems in the same Emacs,
5227 * we'll need callers to be precise about what window system they
5228 * want. */
5229
5230 if (strcmp (SSDATA (display), "w32") != 0)
5231 error ("The name of the display in this Emacs must be \"w32\"");
5232
74e1aeec
JR
5233 /* If initialization has already been done, return now to avoid
5234 overwriting critical parts of one_w32_display_info. */
7452b7bd 5235 if (window_system_available (NULL))
74e1aeec
JR
5236 return Qnil;
5237
6fc2811b 5238 if (! NILP (xrm_string))
b7826503 5239 CHECK_STRING (xrm_string);
6fc2811b 5240
6fc2811b
JR
5241 /* Allow color mapping to be defined externally; first look in user's
5242 HOME directory, then in Emacs etc dir for a file called rgb.txt. */
5243 {
5244 Lisp_Object color_file;
5245 struct gcpro gcpro1;
5246
74084731 5247 color_file = build_string ("~/rgb.txt");
6fc2811b
JR
5248
5249 GCPRO1 (color_file);
5250
5251 if (NILP (Ffile_readable_p (color_file)))
5252 color_file =
5253 Fexpand_file_name (build_string ("rgb.txt"),
5254 Fsymbol_value (intern ("data-directory")));
5255
7ded3383 5256 Vw32_color_map = Fx_load_color_file (color_file);
6fc2811b
JR
5257
5258 UNGCPRO;
5259 }
5260 if (NILP (Vw32_color_map))
5430d399 5261 Vw32_color_map = w32_default_color_map ();
6fc2811b 5262
5a8a15ec
JR
5263 /* Merge in system logical colors. */
5264 add_system_logical_colors_to_map (&Vw32_color_map);
5265
6fc2811b 5266 if (! NILP (xrm_string))
51b59d79 5267 xrm_option = SDATA (xrm_string);
6fc2811b
JR
5268 else
5269 xrm_option = (unsigned char *) 0;
5270
5271 /* Use this general default value to start with. */
5272 /* First remove .exe suffix from invocation-name - it looks ugly. */
5273 {
5274 char basename[ MAX_PATH ], *str;
5275
d5db4077 5276 strcpy (basename, SDATA (Vinvocation_name));
6fc2811b
JR
5277 str = strrchr (basename, '.');
5278 if (str) *str = 0;
5279 Vinvocation_name = build_string (basename);
5280 }
5281 Vx_resource_name = Vinvocation_name;
5282
5283 validate_x_resource_name ();
5284
5285 /* This is what opens the connection and sets x_current_display.
5286 This also initializes many symbols, such as those used for input. */
5287 dpyinfo = w32_term_init (display, xrm_option,
51b59d79 5288 SSDATA (Vx_resource_name));
6fc2811b
JR
5289
5290 if (dpyinfo == 0)
5291 {
5292 if (!NILP (must_succeed))
5293 fatal ("Cannot connect to server %s.\n",
d5db4077 5294 SDATA (display));
6fc2811b 5295 else
d5db4077 5296 error ("Cannot connect to server %s", SDATA (display));
6fc2811b
JR
5297 }
5298
d5272e33 5299 XSETFASTINT (Vwindow_system_version, w32_major_version);
6fc2811b
JR
5300 return Qnil;
5301}
5302
5303DEFUN ("x-close-connection", Fx_close_connection,
5304 Sx_close_connection, 1, 1, 0,
74e1aeec
JR
5305 doc: /* Close the connection to DISPLAY's server.
5306For DISPLAY, specify either a frame or a display name (a string).
5307If DISPLAY is nil, that stands for the selected frame's display. */)
5842a27b 5308 (Lisp_Object display)
6fc2811b
JR
5309{
5310 struct w32_display_info *dpyinfo = check_x_display_info (display);
6fc2811b
JR
5311
5312 if (dpyinfo->reference_count > 0)
5313 error ("Display still has frames on it");
5314
4d7e6e51 5315 block_input ();
6fc2811b
JR
5316 x_destroy_all_bitmaps (dpyinfo);
5317
5318 x_delete_display (dpyinfo);
4d7e6e51 5319 unblock_input ();
6fc2811b
JR
5320
5321 return Qnil;
5322}
5323
5324DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
74e1aeec 5325 doc: /* Return the list of display names that Emacs has connections to. */)
5842a27b 5326 (void)
6fc2811b 5327{
d141d701
DA
5328 Lisp_Object result = Qnil;
5329 struct w32_display_info *wdi;
6fc2811b 5330
d141d701
DA
5331 for (wdi = x_display_list; wdi; wdi = wdi->next)
5332 result = Fcons (XCAR (wdi->name_list_element), result);
6fc2811b
JR
5333
5334 return result;
5335}
5336
5337DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
7c051dd8
GM
5338 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
5339This function only has an effect on X Windows. With MS Windows, it is
5340defined but does nothing.
5341
5342If ON is nil, allow buffering of requests.
5343Turning on synchronization prohibits the Xlib routines from buffering
5344requests and seriously degrades performance, but makes debugging much
5345easier.
5346The optional second argument TERMINAL specifies which display to act on.
5347TERMINAL should be a terminal object, a frame or a display name (a string).
5348If TERMINAL is omitted or nil, that stands for the selected frame's display. */)
5842a27b 5349 (Lisp_Object on, Lisp_Object display)
6fc2811b 5350{
6fc2811b
JR
5351 return Qnil;
5352}
5353
6b61353c 5354
6fc2811b 5355\f
6fc2811b 5356/***********************************************************************
6b61353c 5357 Window properties
6fc2811b
JR
5358 ***********************************************************************/
5359
b124fd93
JB
5360#if 0 /* TODO : port window properties to W32 */
5361
6b61353c
KH
5362DEFUN ("x-change-window-property", Fx_change_window_property,
5363 Sx_change_window_property, 2, 6, 0,
5364 doc: /* Change window property PROP to VALUE on the X window of FRAME.
7c051dd8
GM
5365PROP must be a string. VALUE may be a string or a list of conses,
5366numbers and/or strings. If an element in the list is a string, it is
5367converted to an atom and the value of the Atom is used. If an element
5368is a cons, it is converted to a 32 bit number where the car is the 16
5369top bits and the cdr is the lower 16 bits.
5370
6b61353c
KH
5371FRAME nil or omitted means use the selected frame.
5372If TYPE is given and non-nil, it is the name of the type of VALUE.
5373If TYPE is not given or nil, the type is STRING.
5374FORMAT gives the size in bits of each element if VALUE is a list.
5375It must be one of 8, 16 or 32.
5376If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
fca8d6b6 5377If OUTER-P is non-nil, the property is changed for the outer X window of
7c051dd8 5378FRAME. Default is to change on the edit X window. */)
fca8d6b6
AS
5379 (Lisp_Object prop, Lisp_Object value, Lisp_Object frame,
5380 Lisp_Object type, Lisp_Object format, Lisp_Object outer_p)
6b61353c 5381{
7452b7bd 5382 struct frame *f = decode_window_system_frame (frame);
6b61353c 5383 Atom prop_atom;
6fc2811b 5384
6b61353c
KH
5385 CHECK_STRING (prop);
5386 CHECK_STRING (value);
6fc2811b 5387
4d7e6e51 5388 block_input ();
6b61353c
KH
5389 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5390 XChangeProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5391 prop_atom, XA_STRING, 8, PropModeReplace,
5392 SDATA (value), SCHARS (value));
6fc2811b 5393
6b61353c
KH
5394 /* Make sure the property is set when we return. */
5395 XFlush (FRAME_W32_DISPLAY (f));
4d7e6e51 5396 unblock_input ();
6fc2811b 5397
6b61353c
KH
5398 return value;
5399}
dfff8a69 5400
6fc2811b 5401
6b61353c
KH
5402DEFUN ("x-delete-window-property", Fx_delete_window_property,
5403 Sx_delete_window_property, 1, 2, 0,
5404 doc: /* Remove window property PROP from X window of FRAME.
5405FRAME nil or omitted means use the selected frame. Value is PROP. */)
5842a27b 5406 (Lisp_Object prop, Lisp_Object frame)
6fc2811b 5407{
7452b7bd 5408 struct frame *f = decode_window_system_frame (frame);
6b61353c 5409 Atom prop_atom;
6fc2811b 5410
6b61353c 5411 CHECK_STRING (prop);
4d7e6e51 5412 block_input ();
6b61353c
KH
5413 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5414 XDeleteProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f), prop_atom);
6fc2811b 5415
6b61353c
KH
5416 /* Make sure the property is removed when we return. */
5417 XFlush (FRAME_W32_DISPLAY (f));
4d7e6e51 5418 unblock_input ();
6fc2811b 5419
6b61353c 5420 return prop;
6fc2811b
JR
5421}
5422
5423
6b61353c 5424DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
ddadbc0e 5425 1, 6, 0,
6b61353c 5426 doc: /* Value is the value of window property PROP on FRAME.
7c051dd8
GM
5427If FRAME is nil or omitted, use the selected frame.
5428
7c051dd8
GM
5429On X Windows, the following optional arguments are also accepted:
5430If TYPE is nil or omitted, get the property as a string.
5431Otherwise TYPE is the name of the atom that denotes the type expected.
5432If SOURCE is non-nil, get the property on that window instead of from
5433FRAME. The number 0 denotes the root window.
ddadbc0e
AS
5434If DELETE-P is non-nil, delete the property after retrieving it.
5435If VECTOR-RET-P is non-nil, don't return a string but a vector of values.
5436
5437On MS Windows, this function accepts but ignores those optional arguments.
7c051dd8
GM
5438
5439Value is nil if FRAME hasn't a property with name PROP or if PROP has
5440no value of TYPE (always string in the MS Windows case). */)
ddadbc0e
AS
5441 (Lisp_Object prop, Lisp_Object frame, Lisp_Object type,
5442 Lisp_Object source, Lisp_Object delete_p, Lisp_Object vector_ret_p)
6fc2811b 5443{
7452b7bd 5444 struct frame *f = decode_window_system_frame (frame);
6b61353c
KH
5445 Atom prop_atom;
5446 int rc;
5447 Lisp_Object prop_value = Qnil;
5448 char *tmp_data = NULL;
5449 Atom actual_type;
5450 int actual_format;
5451 unsigned long actual_size, bytes_remaining;
7d0393cf 5452
6b61353c 5453 CHECK_STRING (prop);
4d7e6e51 5454 block_input ();
6b61353c
KH
5455 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5456 rc = XGetWindowProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5457 prop_atom, 0, 0, False, XA_STRING,
5458 &actual_type, &actual_format, &actual_size,
5459 &bytes_remaining, (unsigned char **) &tmp_data);
5460 if (rc == Success)
6fc2811b 5461 {
6b61353c 5462 int size = bytes_remaining;
3cf3436e 5463
6b61353c
KH
5464 XFree (tmp_data);
5465 tmp_data = NULL;
3cf3436e 5466
6b61353c
KH
5467 rc = XGetWindowProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5468 prop_atom, 0, bytes_remaining,
5469 False, XA_STRING,
5470 &actual_type, &actual_format,
5471 &actual_size, &bytes_remaining,
5472 (unsigned char **) &tmp_data);
5473 if (rc == Success)
5474 prop_value = make_string (tmp_data, size);
6fc2811b 5475
6b61353c
KH
5476 XFree (tmp_data);
5477 }
6fc2811b 5478
4d7e6e51 5479 unblock_input ();
6fc2811b 5480
6b61353c 5481 return prop_value;
6fc2811b 5482
6b61353c 5483 return Qnil;
6fc2811b
JR
5484}
5485
b124fd93 5486#endif /* TODO */
6fc2811b
JR
5487
5488\f
5489/***********************************************************************
6b61353c 5490 Busy cursor
6fc2811b
JR
5491 ***********************************************************************/
5492
6b61353c 5493void
c06c382a 5494w32_note_current_window (void)
6fc2811b 5495{
d148e14d 5496 struct frame * f = SELECTED_FRAME ();
6fc2811b 5497
30076589
JR
5498 if (!FRAME_W32_P (f))
5499 return;
5500
d148e14d 5501 hourglass_hwnd = FRAME_W32_WINDOW (f);
f79e6790
JR
5502}
5503
f79e6790 5504void
c06c382a 5505show_hourglass (struct atimer *timer)
f79e6790 5506{
c06c382a 5507 struct frame *f;
7d0393cf 5508
c06c382a
EZ
5509 hourglass_atimer = NULL;
5510
5511 block_input ();
5512 f = x_window_to_frame (&one_w32_display_info,
5513 hourglass_hwnd);
5514
5515 if (f)
5516 f->output_data.w32->hourglass_p = 0;
5517 else
5518 f = SELECTED_FRAME ();
5519
5520 if (!FRAME_W32_P (f))
f0177f86
EZ
5521 {
5522 unblock_input ();
5523 return;
5524 }
c06c382a
EZ
5525
5526 w32_show_hourglass (f);
5527 unblock_input ();
f79e6790
JR
5528}
5529
c06c382a
EZ
5530void
5531hide_hourglass (void)
5532{
5533 block_input ();
5534 w32_hide_hourglass ();
5535 unblock_input ();
5536}
f79e6790 5537
f79e6790 5538
c06c382a 5539/* Display an hourglass cursor. Set the hourglass_p flag in display info
d148e14d 5540 to indicate that an hourglass cursor is shown. */
f79e6790
JR
5541
5542static void
b56ceb92 5543w32_show_hourglass (struct frame *f)
6fc2811b 5544{
0af913d7 5545 if (!hourglass_shown_p)
6fc2811b 5546 {
d148e14d
JR
5547 f->output_data.w32->hourglass_p = 1;
5548 if (!menubar_in_use && !current_popup_menu)
5549 SetCursor (f->output_data.w32->hourglass_cursor);
0af913d7 5550 hourglass_shown_p = 1;
f79e6790 5551 }
6fc2811b
JR
5552}
5553
5554
0af913d7 5555/* Hide the hourglass cursor on all frames, if it is currently shown. */
6fc2811b 5556
f79e6790 5557static void
b56ceb92 5558w32_hide_hourglass (void)
f79e6790 5559{
0af913d7 5560 if (hourglass_shown_p)
6fc2811b 5561 {
d148e14d
JR
5562 struct frame *f = x_window_to_frame (&one_w32_display_info,
5563 hourglass_hwnd);
89e09428
JR
5564 if (f)
5565 f->output_data.w32->hourglass_p = 0;
5566 else
5567 /* If frame was deleted, restore to selected frame's cursor. */
5568 f = SELECTED_FRAME ();
5569
5570 if (FRAME_W32_P (f))
5571 SetCursor (f->output_data.w32->current_cursor);
5572 else
5573 /* No cursors on non GUI frames - restore to stock arrow cursor. */
5574 SetCursor (w32_load_cursor (IDC_ARROW));
6fc2811b 5575
0af913d7 5576 hourglass_shown_p = 0;
f79e6790 5577 }
6fc2811b
JR
5578}
5579
5580
5581\f
5582/***********************************************************************
5583 Tool tips
5584 ***********************************************************************/
5585
f57e2426
J
5586static Lisp_Object x_create_tip_frame (struct w32_display_info *,
5587 Lisp_Object, Lisp_Object);
5588static void compute_tip_xy (struct frame *, Lisp_Object, Lisp_Object,
5589 Lisp_Object, int, int, int *, int *);
7d0393cf 5590
3cf3436e 5591/* The frame of a currently visible tooltip. */
6fc2811b 5592
937e601e 5593Lisp_Object tip_frame;
6fc2811b
JR
5594
5595/* If non-nil, a timer started that hides the last tooltip when it
5596 fires. */
5597
5598Lisp_Object tip_timer;
5599Window tip_window;
5600
3cf3436e
JR
5601/* If non-nil, a vector of 3 elements containing the last args
5602 with which x-show-tip was called. See there. */
5603
5604Lisp_Object last_show_tip_args;
5605
3cf3436e 5606
27e498e6 5607static void
b56ceb92 5608unwind_create_tip_frame (Lisp_Object frame)
937e601e 5609{
c844a81a
GM
5610 Lisp_Object deleted;
5611
5612 deleted = unwind_create_frame (frame);
5613 if (EQ (deleted, Qt))
5614 {
5615 tip_window = NULL;
5616 tip_frame = Qnil;
5617 }
937e601e
AI
5618}
5619
5620
6fc2811b 5621/* Create a frame for a tooltip on the display described by DPYINFO.
3cf3436e
JR
5622 PARMS is a list of frame parameters. TEXT is the string to
5623 display in the tip frame. Value is the frame.
937e601e
AI
5624
5625 Note that functions called here, esp. x_default_parameter can
5626 signal errors, for instance when a specified color name is
5627 undefined. We have to make sure that we're in a consistent state
5628 when this happens. */
6fc2811b
JR
5629
5630static Lisp_Object
b56ceb92
JB
5631x_create_tip_frame (struct w32_display_info *dpyinfo,
5632 Lisp_Object parms, Lisp_Object text)
6fc2811b 5633{
6fc2811b 5634 struct frame *f;
0f4a96b5 5635 Lisp_Object frame;
6fc2811b
JR
5636 Lisp_Object name;
5637 long window_prompting = 0;
5638 int width, height;
d311d28c 5639 ptrdiff_t count = SPECPDL_INDEX ();
6fc2811b
JR
5640 struct gcpro gcpro1, gcpro2, gcpro3;
5641 struct kboard *kb;
3cf3436e
JR
5642 int face_change_count_before = face_change_count;
5643 Lisp_Object buffer;
5644 struct buffer *old_buffer;
6fc2811b 5645
6fc2811b
JR
5646 /* Use this general default value to start with until we know if
5647 this frame has a specified name. */
5648 Vx_resource_name = Vinvocation_name;
5649
fd142562 5650 kb = dpyinfo->terminal->kboard;
6fc2811b 5651
4a217bed
EZ
5652 /* The calls to x_get_arg remove elements from PARMS, so copy it to
5653 avoid destructive changes behind our caller's back. */
5654 parms = Fcopy_alist (parms);
5655
6fc2811b 5656 /* Get the name of the frame to use for resource lookup. */
3faa984f 5657 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
6fc2811b
JR
5658 if (!STRINGP (name)
5659 && !EQ (name, Qunbound)
5660 && !NILP (name))
5661 error ("Invalid frame name--not a string or nil");
5662 Vx_resource_name = name;
5663
5664 frame = Qnil;
5665 GCPRO3 (parms, name, frame);
9eb16b62
JR
5666 /* Make a frame without minibuffer nor mode-line. */
5667 f = make_frame (0);
5668 f->wants_modeline = 0;
6fc2811b 5669 XSETFRAME (frame, f);
3cf3436e
JR
5670
5671 buffer = Fget_buffer_create (build_string (" *tip*"));
08908aca
MR
5672 /* Use set_window_buffer instead of Fset_window_buffer (see
5673 discussion of bug#11984, bug#12025, bug#12026). */
5674 set_window_buffer (FRAME_ROOT_WINDOW (f), buffer, 0, 0);
3cf3436e
JR
5675 old_buffer = current_buffer;
5676 set_buffer_internal_1 (XBUFFER (buffer));
39eb03f1 5677 bset_truncate_lines (current_buffer, Qnil);
5c2a995d
KH
5678 specbind (Qinhibit_read_only, Qt);
5679 specbind (Qinhibit_modification_hooks, Qt);
3cf3436e
JR
5680 Ferase_buffer ();
5681 Finsert (1, &text);
5682 set_buffer_internal_1 (old_buffer);
7d0393cf 5683
937e601e 5684 record_unwind_protect (unwind_create_tip_frame, frame);
6fc2811b 5685
3cf3436e
JR
5686 /* By setting the output method, we're essentially saying that
5687 the frame is live, as per FRAME_LIVE_P. If we get a signal
5688 from this point on, x_destroy_window might screw up reference
5689 counts etc. */
ebbb61be 5690 f->terminal = dpyinfo->terminal;
d88c567c 5691 f->output_method = output_w32;
23f86fce 5692 f->output_data.w32 = xzalloc (sizeof (struct w32_output));
ca56d953
JR
5693
5694 FRAME_FONTSET (f) = -1;
f00af5b1 5695 fset_icon_name (f, Qnil);
6fc2811b 5696
e509cfa6 5697#ifdef GLYPH_DEBUG
a06776b2 5698 image_cache_refcount =
784b56e2 5699 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
937e601e
AI
5700 dpyinfo_refcount = dpyinfo->reference_count;
5701#endif /* GLYPH_DEBUG */
6fc2811b 5702 FRAME_KBOARD (f) = kb;
aad3612f 5703 f->output_data.w32->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
6fc2811b
JR
5704 f->output_data.w32->explicit_parent = 0;
5705
5706 /* Set the name; the functions to which we pass f expect the name to
5707 be set. */
5708 if (EQ (name, Qunbound) || NILP (name))
5709 {
f00af5b1 5710 fset_name (f, build_string (dpyinfo->w32_id_name));
6fc2811b
JR
5711 f->explicit_name = 0;
5712 }
5713 else
5714 {
f00af5b1 5715 fset_name (f, name);
6fc2811b
JR
5716 f->explicit_name = 1;
5717 /* use the frame's title when getting resources for this frame. */
5718 specbind (Qx_resource_name, name);
5719 }
5720
fdb55376
JR
5721 if (uniscribe_available)
5722 register_font_driver (&uniscribe_font_driver, f);
1cc06b86 5723 register_font_driver (&w32font_driver, f);
a1fe5c00 5724
1cc06b86
KH
5725 x_default_parameter (f, parms, Qfont_backend, Qnil,
5726 "fontBackend", "FontBackend", RES_TYPE_STRING);
a1fe5c00 5727
6fc2811b
JR
5728 /* Extract the window parameters from the supplied values
5729 that are needed to determine window geometry. */
1cc06b86 5730 x_default_font_parameter (f, parms);
6fc2811b
JR
5731
5732 x_default_parameter (f, parms, Qborder_width, make_number (2),
5733 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
6fc2811b
JR
5734 /* This defaults to 2 in order to match xterm. We recognize either
5735 internalBorderWidth or internalBorder (which is what xterm calls
5736 it). */
5737 if (NILP (Fassq (Qinternal_border_width, parms)))
5738 {
5739 Lisp_Object value;
5740
3faa984f 5741 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
6fc2811b
JR
5742 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
5743 if (! EQ (value, Qunbound))
5744 parms = Fcons (Fcons (Qinternal_border_width, value),
5745 parms);
5746 }
bfd6edcc 5747 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
6fc2811b
JR
5748 "internalBorderWidth", "internalBorderWidth",
5749 RES_TYPE_NUMBER);
880e6158
MR
5750 x_default_parameter (f, parms, Qright_divider_width, make_number (0),
5751 NULL, NULL, RES_TYPE_NUMBER);
5752 x_default_parameter (f, parms, Qbottom_divider_width, make_number (0),
5753 NULL, NULL, RES_TYPE_NUMBER);
6fc2811b
JR
5754
5755 /* Also do the stuff which must be set before the window exists. */
5756 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
5757 "foreground", "Foreground", RES_TYPE_STRING);
5758 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
5759 "background", "Background", RES_TYPE_STRING);
5760 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
5761 "pointerColor", "Foreground", RES_TYPE_STRING);
5762 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
5763 "cursorColor", "Foreground", RES_TYPE_STRING);
5764 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
5765 "borderColor", "BorderColor", RES_TYPE_STRING);
5766
5767 /* Init faces before x_default_parameter is called for scroll-bar
5768 parameters because that function calls x_set_scroll_bar_width,
5769 which calls change_frame_size, which calls Fset_window_buffer,
5770 which runs hooks, which call Fvertical_motion. At the end, we
5771 end up in init_iterator with a null face cache, which should not
5772 happen. */
5773 init_frame_faces (f);
ca56d953
JR
5774
5775 f->output_data.w32->dwStyle = WS_BORDER | WS_POPUP | WS_DISABLED;
aad3612f 5776 f->output_data.w32->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
9eb16b62 5777
6d906347 5778 window_prompting = x_figure_window_size (f, parms, 0);
6fc2811b 5779
9eb16b62 5780 /* No fringes on tip frame. */
be786000
KS
5781 f->fringe_cols = 0;
5782 f->left_fringe_width = 0;
5783 f->right_fringe_width = 0;
9eb16b62 5784
4d7e6e51 5785 block_input ();
ca56d953 5786 my_create_tip_window (f);
4d7e6e51 5787 unblock_input ();
6fc2811b
JR
5788
5789 x_make_gc (f);
5790
5791 x_default_parameter (f, parms, Qauto_raise, Qnil,
5792 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5793 x_default_parameter (f, parms, Qauto_lower, Qnil,
5794 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5795 x_default_parameter (f, parms, Qcursor_type, Qbox,
5796 "cursorType", "CursorType", RES_TYPE_SYMBOL);
5797
880e6158
MR
5798 /* Dimensions, especially FRAME_LINES (f), must be done via
5799 change_frame_size. Change will not be effected unless different
5800 from the current FRAME_LINES (f). */
be786000
KS
5801 width = FRAME_COLS (f);
5802 height = FRAME_LINES (f);
5803 FRAME_LINES (f) = 0;
5804 SET_FRAME_COLS (f, 0);
880e6158 5805 change_frame_size (f, width, height, 1, 0, 0, 0);
6fc2811b 5806
cd1d850f 5807 /* Add `tooltip' frame parameter's default value. */
54ee7410
CY
5808 if (NILP (Fframe_parameter (frame, Qtooltip)))
5809 Fmodify_frame_parameters (frame, Fcons (Fcons (Qtooltip, Qt), Qnil));
7d0393cf 5810
3cf3436e
JR
5811 /* Set up faces after all frame parameters are known. This call
5812 also merges in face attributes specified for new frames.
5813
5814 Frame parameters may be changed if .Xdefaults contains
5815 specifications for the default font. For example, if there is an
5816 `Emacs.default.attributeBackground: pink', the `background-color'
5817 attribute of the frame get's set, which let's the internal border
5818 of the tooltip frame appear in pink. Prevent this. */
5819 {
5820 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
601a9cf1
JB
5821 Lisp_Object fg = Fframe_parameter (frame, Qforeground_color);
5822 Lisp_Object colors = Qnil;
3cf3436e
JR
5823
5824 /* Set tip_frame here, so that */
5825 tip_frame = frame;
45cebfd9 5826 call2 (Qface_set_after_frame_default, frame, Qnil);
7d0393cf 5827
3cf3436e 5828 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
601a9cf1
JB
5829 colors = Fcons (Fcons (Qbackground_color, bg), colors);
5830 if (!EQ (fg, Fframe_parameter (frame, Qforeground_color)))
5831 colors = Fcons (Fcons (Qforeground_color, fg), colors);
5832
5833 if (!NILP (colors))
5834 Fmodify_frame_parameters (frame, colors);
3cf3436e 5835 }
7d0393cf 5836
6fc2811b
JR
5837 f->no_split = 1;
5838
5839 UNGCPRO;
5840
a06776b2
EZ
5841 /* Now that the frame is official, it counts as a reference to
5842 its display. */
aad3612f 5843 FRAME_DISPLAY_INFO (f)->reference_count++;
a06776b2
EZ
5844 f->terminal->reference_count++;
5845
6fc2811b
JR
5846 /* It is now ok to make the frame official even if we get an error
5847 below. And the frame needs to be on Vframe_list or making it
5848 visible won't work. */
5849 Vframe_list = Fcons (frame, Vframe_list);
5850
3cf3436e
JR
5851 /* Setting attributes of faces of the tooltip frame from resources
5852 and similar will increment face_change_count, which leads to the
5853 clearing of all current matrices. Since this isn't necessary
5854 here, avoid it by resetting face_change_count to the value it
5855 had before we created the tip frame. */
5856 face_change_count = face_change_count_before;
5857
5858 /* Discard the unwind_protect. */
6fc2811b 5859 return unbind_to (count, frame);
ee78dc32
GV
5860}
5861
3cf3436e
JR
5862
5863/* Compute where to display tip frame F. PARMS is the list of frame
5864 parameters for F. DX and DY are specified offsets from the current
5865 location of the mouse. WIDTH and HEIGHT are the width and height
5866 of the tooltip. Return coordinates relative to the root window of
5867 the display in *ROOT_X, and *ROOT_Y. */
5868
5869static void
b56ceb92
JB
5870compute_tip_xy (struct frame *f,
5871 Lisp_Object parms, Lisp_Object dx, Lisp_Object dy,
5872 int width, int height, int *root_x, int *root_y)
3cf3436e 5873{
3cf3436e 5874 Lisp_Object left, top;
64f0809d 5875 int min_x, min_y, max_x, max_y;
7d0393cf 5876
3cf3436e
JR
5877 /* User-specified position? */
5878 left = Fcdr (Fassq (Qleft, parms));
5879 top = Fcdr (Fassq (Qtop, parms));
7d0393cf 5880
3cf3436e
JR
5881 /* Move the tooltip window where the mouse pointer is. Resize and
5882 show it. */
ca56d953 5883 if (!INTEGERP (left) || !INTEGERP (top))
3cf3436e 5884 {
ca56d953
JR
5885 POINT pt;
5886
64f0809d
JR
5887 /* Default min and max values. */
5888 min_x = 0;
5889 min_y = 0;
aad3612f
DA
5890 max_x = x_display_pixel_width (FRAME_DISPLAY_INFO (f));
5891 max_y = x_display_pixel_height (FRAME_DISPLAY_INFO (f));
64f0809d 5892
4d7e6e51 5893 block_input ();
ca56d953
JR
5894 GetCursorPos (&pt);
5895 *root_x = pt.x;
5896 *root_y = pt.y;
4d7e6e51 5897 unblock_input ();
64f0809d
JR
5898
5899 /* If multiple monitor support is available, constrain the tip onto
5900 the current monitor. This improves the above by allowing negative
5901 co-ordinates if monitor positions are such that they are valid, and
5902 snaps a tooltip onto a single monitor if we are close to the edge
5903 where it would otherwise flow onto the other monitor (or into
5904 nothingness if there is a gap in the overlap). */
5905 if (monitor_from_point_fn && get_monitor_info_fn)
5906 {
5907 struct MONITOR_INFO info;
5908 HMONITOR monitor
5909 = monitor_from_point_fn (pt, MONITOR_DEFAULT_TO_NEAREST);
5910 info.cbSize = sizeof (info);
5911
5912 if (get_monitor_info_fn (monitor, &info))
5913 {
5914 min_x = info.rcWork.left;
5915 min_y = info.rcWork.top;
5916 max_x = info.rcWork.right;
5917 max_y = info.rcWork.bottom;
5918 }
5919 }
3cf3436e
JR
5920 }
5921
5922 if (INTEGERP (top))
5923 *root_y = XINT (top);
64f0809d
JR
5924 else if (*root_y + XINT (dy) <= min_y)
5925 *root_y = min_y; /* Can happen for negative dy */
5926 else if (*root_y + XINT (dy) + height <= max_y)
7e8410d1 5927 /* It fits below the pointer */
3cf3436e 5928 *root_y += XINT (dy);
64f0809d 5929 else if (height + XINT (dy) + min_y <= *root_y)
7e8410d1
JD
5930 /* It fits above the pointer. */
5931 *root_y -= height + XINT (dy);
5932 else
5933 /* Put it on the top. */
64f0809d 5934 *root_y = min_y;
3cf3436e
JR
5935
5936 if (INTEGERP (left))
5937 *root_x = XINT (left);
64f0809d 5938 else if (*root_x + XINT (dx) <= min_x)
bf63eb69 5939 *root_x = 0; /* Can happen for negative dx */
64f0809d 5940 else if (*root_x + XINT (dx) + width <= max_x)
72e4adef
JR
5941 /* It fits to the right of the pointer. */
5942 *root_x += XINT (dx);
64f0809d 5943 else if (width + XINT (dx) + min_x <= *root_x)
72e4adef 5944 /* It fits to the left of the pointer. */
3cf3436e
JR
5945 *root_x -= width + XINT (dx);
5946 else
72e4adef 5947 /* Put it left justified on the screen -- it ought to fit that way. */
64f0809d 5948 *root_x = min_x;
3cf3436e
JR
5949}
5950
5951
71eab8d1 5952DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
74e1aeec
JR
5953 doc: /* Show STRING in a \"tooltip\" window on frame FRAME.
5954A tooltip window is a small window displaying a string.
5955
87c891c7
EZ
5956This is an internal function; Lisp code should call `tooltip-show'.
5957
74e1aeec
JR
5958FRAME nil or omitted means use the selected frame.
5959
5960PARMS is an optional list of frame parameters which can be
5961used to change the tooltip's appearance.
5962
ca56d953
JR
5963Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
5964means use the default timeout of 5 seconds.
74e1aeec 5965
52deb19f 5966If the list of frame parameters PARMS contains a `left' parameter,
74e1aeec
JR
5967the tooltip is displayed at that x-position. Otherwise it is
5968displayed at the mouse position, with offset DX added (default is 5 if
5969DX isn't specified). Likewise for the y-position; if a `top' frame
5970parameter is specified, it determines the y-position of the tooltip
5971window, otherwise it is displayed at the mouse position, with offset
5972DY added (default is -10).
5973
5974A tooltip's maximum size is specified by `x-max-tooltip-size'.
5975Text larger than the specified size is clipped. */)
5842a27b 5976 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
ee78dc32 5977{
6fc2811b
JR
5978 struct frame *f;
5979 struct window *w;
3cf3436e 5980 int root_x, root_y;
6fc2811b
JR
5981 struct buffer *old_buffer;
5982 struct text_pos pos;
a971c0a7 5983 int i, width, height, seen_reversed_p;
6fc2811b
JR
5984 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
5985 int old_windows_or_buffers_changed = windows_or_buffers_changed;
d311d28c 5986 ptrdiff_t count = SPECPDL_INDEX ();
7d0393cf 5987
6fc2811b 5988 specbind (Qinhibit_redisplay, Qt);
ee78dc32 5989
dfff8a69 5990 GCPRO4 (string, parms, frame, timeout);
ee78dc32 5991
b7826503 5992 CHECK_STRING (string);
7452b7bd 5993 f = decode_window_system_frame (frame);
6fc2811b
JR
5994 if (NILP (timeout))
5995 timeout = make_number (5);
5996 else
b7826503 5997 CHECK_NATNUM (timeout);
ee78dc32 5998
71eab8d1
AI
5999 if (NILP (dx))
6000 dx = make_number (5);
6001 else
b7826503 6002 CHECK_NUMBER (dx);
7d0393cf 6003
71eab8d1 6004 if (NILP (dy))
dc220243 6005 dy = make_number (-10);
71eab8d1 6006 else
b7826503 6007 CHECK_NUMBER (dy);
71eab8d1 6008
dc220243
JR
6009 if (NILP (last_show_tip_args))
6010 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
6011
6012 if (!NILP (tip_frame))
6013 {
6014 Lisp_Object last_string = AREF (last_show_tip_args, 0);
6015 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
6016 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
6017
6018 if (EQ (frame, last_frame)
6019 && !NILP (Fequal (last_string, string))
6020 && !NILP (Fequal (last_parms, parms)))
6021 {
6022 struct frame *f = XFRAME (tip_frame);
7d0393cf 6023
dc220243
JR
6024 /* Only DX and DY have changed. */
6025 if (!NILP (tip_timer))
6026 {
6027 Lisp_Object timer = tip_timer;
6028 tip_timer = Qnil;
6029 call1 (Qcancel_timer, timer);
6030 }
6031
4d7e6e51 6032 block_input ();
be786000
KS
6033 compute_tip_xy (f, parms, dx, dy, FRAME_PIXEL_WIDTH (f),
6034 FRAME_PIXEL_HEIGHT (f), &root_x, &root_y);
d65a9cdc
JR
6035
6036 /* Put tooltip in topmost group and in position. */
ca56d953
JR
6037 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOPMOST,
6038 root_x, root_y, 0, 0,
6039 SWP_NOSIZE | SWP_NOACTIVATE);
d65a9cdc
JR
6040
6041 /* Ensure tooltip is on top of other topmost windows (eg menus). */
6042 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOP,
6043 0, 0, 0, 0,
6044 SWP_NOMOVE | SWP_NOSIZE | SWP_NOACTIVATE);
6045
4d7e6e51 6046 unblock_input ();
dc220243
JR
6047 goto start_timer;
6048 }
6049 }
6050
6fc2811b
JR
6051 /* Hide a previous tip, if any. */
6052 Fx_hide_tip ();
ee78dc32 6053
dc220243
JR
6054 ASET (last_show_tip_args, 0, string);
6055 ASET (last_show_tip_args, 1, frame);
6056 ASET (last_show_tip_args, 2, parms);
6057
6fc2811b
JR
6058 /* Add default values to frame parameters. */
6059 if (NILP (Fassq (Qname, parms)))
6060 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
6061 if (NILP (Fassq (Qinternal_border_width, parms)))
6062 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
880e6158
MR
6063 if (NILP (Fassq (Qright_divider_width, parms)))
6064 parms = Fcons (Fcons (Qright_divider_width, make_number (0)), parms);
6065 if (NILP (Fassq (Qbottom_divider_width, parms)))
6066 parms = Fcons (Fcons (Qbottom_divider_width, make_number (0)), parms);
6fc2811b
JR
6067 if (NILP (Fassq (Qborder_width, parms)))
6068 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
6069 if (NILP (Fassq (Qborder_color, parms)))
6070 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
6071 if (NILP (Fassq (Qbackground_color, parms)))
6072 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
6073 parms);
6074
0e3fcdef
JR
6075 /* Block input until the tip has been fully drawn, to avoid crashes
6076 when drawing tips in menus. */
4d7e6e51 6077 block_input ();
0e3fcdef 6078
6fc2811b
JR
6079 /* Create a frame for the tooltip, and record it in the global
6080 variable tip_frame. */
aad3612f 6081 frame = x_create_tip_frame (FRAME_DISPLAY_INFO (f), parms, string);
937e601e 6082 f = XFRAME (frame);
6fc2811b 6083
3cf3436e 6084 /* Set up the frame's root window. */
6fc2811b 6085 w = XWINDOW (FRAME_ROOT_WINDOW (f));
5f24fa51
DA
6086 w->left_col = 0;
6087 w->top_line = 0;
880e6158
MR
6088 w->pixel_left = 0;
6089 w->pixel_top = 0;
3cf3436e
JR
6090
6091 if (CONSP (Vx_max_tooltip_size)
6092 && INTEGERP (XCAR (Vx_max_tooltip_size))
6093 && XINT (XCAR (Vx_max_tooltip_size)) > 0
6094 && INTEGERP (XCDR (Vx_max_tooltip_size))
6095 && XINT (XCDR (Vx_max_tooltip_size)) > 0)
6096 {
5f24fa51
DA
6097 w->total_cols = XFASTINT (XCAR (Vx_max_tooltip_size));
6098 w->total_lines = XFASTINT (XCDR (Vx_max_tooltip_size));
3cf3436e
JR
6099 }
6100 else
6101 {
5f24fa51
DA
6102 w->total_cols = 80;
6103 w->total_lines = 40;
3cf3436e 6104 }
7d0393cf 6105
880e6158
MR
6106 w->pixel_width = w->total_cols * FRAME_COLUMN_WIDTH (f);
6107 w->pixel_height = w->total_lines * FRAME_LINE_HEIGHT (f);
6108
21e930f8 6109 FRAME_TOTAL_COLS (f) = WINDOW_TOTAL_COLS (w);
bd0443bb 6110 adjust_frame_glyphs (f);
6fc2811b
JR
6111 w->pseudo_window_p = 1;
6112
6113 /* Display the tooltip text in a temporary buffer. */
6fc2811b 6114 old_buffer = current_buffer;
e74aeda8 6115 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->contents));
39eb03f1 6116 bset_truncate_lines (current_buffer, Qnil);
6fc2811b
JR
6117 clear_glyph_matrix (w->desired_matrix);
6118 clear_glyph_matrix (w->current_matrix);
6119 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
39321b94 6120 try_window (FRAME_ROOT_WINDOW (f), pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
6fc2811b
JR
6121
6122 /* Compute width and height of the tooltip. */
a971c0a7 6123 width = height = seen_reversed_p = 0;
6fc2811b 6124 for (i = 0; i < w->desired_matrix->nrows; ++i)
ee78dc32 6125 {
6fc2811b
JR
6126 struct glyph_row *row = &w->desired_matrix->rows[i];
6127 struct glyph *last;
6128 int row_width;
6129
6130 /* Stop at the first empty row at the end. */
138c0ae8 6131 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
6fc2811b
JR
6132 break;
6133
6134 /* Let the row go over the full width of the frame. */
6135 row->full_width_p = 1;
6136
a971c0a7 6137 row_width = row->pixel_width;
6fc2811b
JR
6138 if (row->used[TEXT_AREA])
6139 {
a971c0a7
EZ
6140 if (!row->reversed_p)
6141 {
a971c0a7
EZ
6142 /* There's a glyph at the end of rows that is used to
6143 place the cursor there. Don't include the width of
6144 this glyph. */
6145 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
6146 if (INTEGERP (last->object))
6147 row_width -= last->pixel_width;
a971c0a7
EZ
6148 }
6149 else
6150 {
6151 /* There could be a stretch glyph at the beginning of R2L
6152 rows that is produced by extend_face_to_end_of_line.
6153 Don't count that glyph. */
6154 struct glyph *g = row->glyphs[TEXT_AREA];
6155
6156 if (g->type == STRETCH_GLYPH && INTEGERP (g->object))
6157 {
6158 row_width -= g->pixel_width;
6159 seen_reversed_p = 1;
6160 }
6161 }
6162 }
7d0393cf 6163
bfd6edcc 6164 height += row->height;
6fc2811b 6165 width = max (width, row_width);
ee78dc32
GV
6166 }
6167
a971c0a7
EZ
6168 /* If we've seen partial-length R2L rows, we need to re-adjust the
6169 tool-tip frame width and redisplay it again, to avoid over-wide
6170 tips due to the stretch glyph that extends R2L lines to full
6171 width of the frame. */
6172 if (seen_reversed_p)
6173 {
880e6158
MR
6174 /* PXW: Why do we do the pixel-to-cols conversion only if
6175 seen_reversed_p holds? Don't we have to set other fields of
f224e500 6176 the window/frame structure?
880e6158
MR
6177
6178 w->total_cols and FRAME_TOTAL_COLS want the width in columns,
a971c0a7 6179 not in pixels. */
880e6158 6180 w->pixel_width = width;
a971c0a7 6181 width /= WINDOW_FRAME_COLUMN_WIDTH (w);
5f24fa51 6182 w->total_cols = width;
a971c0a7 6183 FRAME_TOTAL_COLS (f) = width;
880e6158 6184 SET_FRAME_WIDTH (f, width);
bd0443bb 6185 adjust_frame_glyphs (f);
39321b94 6186 w->pseudo_window_p = 1;
a971c0a7
EZ
6187 clear_glyph_matrix (w->desired_matrix);
6188 clear_glyph_matrix (w->current_matrix);
39321b94 6189 try_window (FRAME_ROOT_WINDOW (f), pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
a971c0a7
EZ
6190 width = height = 0;
6191 /* Recompute width and height of the tooltip. */
6192 for (i = 0; i < w->desired_matrix->nrows; ++i)
6193 {
6194 struct glyph_row *row = &w->desired_matrix->rows[i];
6195 struct glyph *last;
6196 int row_width;
6197
138c0ae8 6198 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
a971c0a7
EZ
6199 break;
6200 row->full_width_p = 1;
6201 row_width = row->pixel_width;
a971c0a7
EZ
6202 if (row->used[TEXT_AREA] && !row->reversed_p)
6203 {
6204 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
6205 if (INTEGERP (last->object))
6206 row_width -= last->pixel_width;
6207 }
a971c0a7
EZ
6208
6209 height += row->height;
6210 width = max (width, row_width);
6211 }
6212 }
6213
39321b94 6214 /* Add the frame's internal border to the width and height the w32
6fc2811b
JR
6215 window should have. */
6216 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
6217 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
ee78dc32 6218
6fc2811b 6219 /* Move the tooltip window where the mouse pointer is. Resize and
880e6158
MR
6220 show it.
6221
6222 PXW: This should use the frame's pixel coordinates. */
3cf3436e 6223 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
71eab8d1 6224
bfd6edcc
JR
6225 {
6226 /* Adjust Window size to take border into account. */
6227 RECT rect;
6228 rect.left = rect.top = 0;
6229 rect.right = width;
6230 rect.bottom = height;
6231 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
6232 FRAME_EXTERNAL_MENU_BAR (f));
6233
1d79e521 6234 /* Position and size tooltip, and put it in the topmost group.
39321b94
EZ
6235 The add-on of FRAME_COLUMN_WIDTH to the 5th argument is a
6236 peculiarity of w32 display: without it, some fonts cause the
6237 last character of the tip to be truncated or wrapped around to
6238 the next line. */
bfd6edcc 6239 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOPMOST,
39321b94
EZ
6240 root_x, root_y,
6241 rect.right - rect.left + FRAME_COLUMN_WIDTH (f),
bfd6edcc
JR
6242 rect.bottom - rect.top, SWP_NOACTIVATE);
6243
d65a9cdc
JR
6244 /* Ensure tooltip is on top of other topmost windows (eg menus). */
6245 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOP,
6246 0, 0, 0, 0,
6247 SWP_NOMOVE | SWP_NOSIZE | SWP_NOACTIVATE);
6248
bfd6edcc 6249 /* Let redisplay know that we have made the frame visible already. */
edfa7fa0 6250 SET_FRAME_VISIBLE (f, 1);
bfd6edcc
JR
6251
6252 ShowWindow (FRAME_W32_WINDOW (f), SW_SHOWNOACTIVATE);
6253 }
ee78dc32 6254
6fc2811b
JR
6255 /* Draw into the window. */
6256 w->must_be_updated_p = 1;
6257 update_single_window (w, 1);
ee78dc32 6258
4d7e6e51 6259 unblock_input ();
0e3fcdef 6260
6fc2811b
JR
6261 /* Restore original current buffer. */
6262 set_buffer_internal_1 (old_buffer);
6263 windows_or_buffers_changed = old_windows_or_buffers_changed;
ee78dc32 6264
dc220243 6265 start_timer:
6fc2811b
JR
6266 /* Let the tip disappear after timeout seconds. */
6267 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
6268 intern ("x-hide-tip"));
ee78dc32 6269
dfff8a69 6270 UNGCPRO;
6fc2811b 6271 return unbind_to (count, Qnil);
ee78dc32
GV
6272}
6273
ee78dc32 6274
6fc2811b 6275DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
74e1aeec
JR
6276 doc: /* Hide the current tooltip window, if there is any.
6277Value is t if tooltip was open, nil otherwise. */)
5842a27b 6278 (void)
6fc2811b 6279{
d311d28c 6280 ptrdiff_t count;
937e601e
AI
6281 Lisp_Object deleted, frame, timer;
6282 struct gcpro gcpro1, gcpro2;
6283
6284 /* Return quickly if nothing to do. */
6285 if (NILP (tip_timer) && NILP (tip_frame))
6286 return Qnil;
7d0393cf 6287
937e601e
AI
6288 frame = tip_frame;
6289 timer = tip_timer;
6290 GCPRO2 (frame, timer);
6291 tip_frame = tip_timer = deleted = Qnil;
7d0393cf 6292
331379bf 6293 count = SPECPDL_INDEX ();
6fc2811b 6294 specbind (Qinhibit_redisplay, Qt);
937e601e 6295 specbind (Qinhibit_quit, Qt);
7d0393cf 6296
937e601e 6297 if (!NILP (timer))
dc220243 6298 call1 (Qcancel_timer, timer);
ee78dc32 6299
937e601e 6300 if (FRAMEP (frame))
6fc2811b 6301 {
56f2de10 6302 delete_frame (frame, Qnil);
937e601e 6303 deleted = Qt;
6fc2811b 6304 }
1edf84e7 6305
937e601e
AI
6306 UNGCPRO;
6307 return unbind_to (count, deleted);
6fc2811b 6308}
6fc2811b
JR
6309\f
6310/***********************************************************************
6311 File selection dialog
6312 ***********************************************************************/
6fc2811b 6313
0fda9b75
DC
6314#define FILE_NAME_TEXT_FIELD edt1
6315#define FILE_NAME_COMBO_BOX cmb13
6316#define FILE_NAME_LIST lst1
6317
fffa137c 6318/* Callback for altering the behavior of the Open File dialog.
1030b26b
JR
6319 Makes the Filename text field contain "Current Directory" and be
6320 read-only when "Directories" is selected in the filter. This
6321 allows us to work around the fact that the standard Open File
6322 dialog does not support directories. */
c7b36b95 6323static UINT_PTR CALLBACK
b56ceb92 6324file_dialog_callback (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
1030b26b
JR
6325{
6326 if (msg == WM_NOTIFY)
6327 {
2d716d75
EZ
6328 OFNOTIFYW * notify_w = (OFNOTIFYW *)lParam;
6329 OFNOTIFYA * notify_a = (OFNOTIFYA *)lParam;
6330 int dropdown_changed;
6331 int dir_index;
0fda9b75 6332#ifdef NTGUI_UNICODE
eac30cd4 6333 const int use_unicode = 1;
0fda9b75 6334#else /* !NTGUI_UNICODE */
2d716d75 6335 int use_unicode = w32_unicode_filenames;
0fda9b75 6336#endif /* NTGUI_UNICODE */
2d716d75 6337
1030b26b 6338 /* Detect when the Filter dropdown is changed. */
2d716d75
EZ
6339 if (use_unicode)
6340 dropdown_changed =
6341 notify_w->hdr.code == CDN_TYPECHANGE
6342 || notify_w->hdr.code == CDN_INITDONE;
6343 else
6344 dropdown_changed =
6345 notify_a->hdr.code == CDN_TYPECHANGE
6346 || notify_a->hdr.code == CDN_INITDONE;
6347 if (dropdown_changed)
1030b26b
JR
6348 {
6349 HWND dialog = GetParent (hwnd);
6350 HWND edit_control = GetDlgItem (dialog, FILE_NAME_TEXT_FIELD);
7faeca66 6351 HWND list = GetDlgItem (dialog, FILE_NAME_LIST);
2d716d75 6352 int hdr_code;
1030b26b 6353
7faeca66
BK
6354 /* At least on Windows 7, the above attempt to get the window handle
6355 to the File Name Text Field fails. The following code does the
6356 job though. Note that this code is based on my examination of the
6357 window hierarchy using Microsoft Spy++. bk */
6358 if (edit_control == NULL)
6359 {
6360 HWND tmp = GetDlgItem (dialog, FILE_NAME_COMBO_BOX);
6361 if (tmp)
6362 {
6363 tmp = GetWindow (tmp, GW_CHILD);
6364 if (tmp)
6365 edit_control = GetWindow (tmp, GW_CHILD);
6366 }
6367 }
6368
6369 /* Directories is in index 2. */
2d716d75
EZ
6370 if (use_unicode)
6371 {
6372 dir_index = notify_w->lpOFN->nFilterIndex;
6373 hdr_code = notify_w->hdr.code;
6374 }
6375 else
6376 {
6377 dir_index = notify_a->lpOFN->nFilterIndex;
6378 hdr_code = notify_a->hdr.code;
6379 }
6380 if (dir_index == 2)
1030b26b 6381 {
2d716d75
EZ
6382 if (use_unicode)
6383 SendMessageW (dialog, CDM_SETCONTROLTEXT, FILE_NAME_TEXT_FIELD,
6384 (LPARAM)L"Current Directory");
6385 else
6386 SendMessageA (dialog, CDM_SETCONTROLTEXT, FILE_NAME_TEXT_FIELD,
6387 (LPARAM)"Current Directory");
1030b26b 6388 EnableWindow (edit_control, FALSE);
7faeca66
BK
6389 /* Note that at least on Windows 7, the above call to EnableWindow
6390 disables the window that would ordinarily have focus. If we
6391 do not set focus to some other window here, focus will land in
6392 no man's land and the user will be unable to tab through the
6393 dialog box (pressing tab will only result in a beep).
6394 Avoid that problem by setting focus to the list here. */
2d716d75 6395 if (hdr_code == CDN_INITDONE)
7faeca66 6396 SetFocus (list);
1030b26b
JR
6397 }
6398 else
6399 {
ef544dc8 6400 /* Don't override default filename on init done. */
2d716d75
EZ
6401 if (hdr_code == CDN_TYPECHANGE)
6402 {
6403 if (use_unicode)
6404 SendMessageW (dialog, CDM_SETCONTROLTEXT,
6405 FILE_NAME_TEXT_FIELD, (LPARAM)L"");
6406 else
6407 SendMessageA (dialog, CDM_SETCONTROLTEXT,
6408 FILE_NAME_TEXT_FIELD, (LPARAM)"");
6409 }
1030b26b
JR
6410 EnableWindow (edit_control, TRUE);
6411 }
6412 }
6413 }
6414 return 0;
6415}
6416
f9d64bb3 6417DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
74e1aeec 6418 doc: /* Read file name, prompting with PROMPT in directory DIR.
7c051dd8
GM
6419Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
6420selection box, if specified. If MUSTMATCH is non-nil, the returned file
6421or directory must exist.
6422
d7e642cc 6423This function is only defined on NS, MS Windows, and X Windows with the
7c051dd8
GM
6424Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
6425Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
5842a27b 6426 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
6fc2811b 6427{
0fda9b75 6428 /* Filter index: 1: All Files, 2: Directories only */
2d716d75
EZ
6429 static const wchar_t filter_w[] = L"All Files (*.*)\0*.*\0Directories\0*|*\0";
6430 static const char filter_a[] = "All Files (*.*)\0*.*\0Directories\0*|*\0";
0fda9b75
DC
6431
6432 Lisp_Object filename = default_filename;
6fc2811b 6433 struct frame *f = SELECTED_FRAME ();
0fda9b75
DC
6434 BOOL file_opened = FALSE;
6435 Lisp_Object orig_dir = dir;
6436 Lisp_Object orig_prompt = prompt;
6437
6438 /* If we compile with _WIN32_WINNT set to 0x0400 (for NT4
6439 compatibility) we end up with the old file dialogs. Define a big
6440 enough struct for the new dialog to trick GetOpenFileName into
6441 giving us the new dialogs on newer versions of Windows. */
6442 struct {
0fda9b75 6443 OPENFILENAMEW details;
0fda9b75
DC
6444#if _WIN32_WINNT < 0x500 /* < win2k */
6445 PVOID pvReserved;
6446 DWORD dwReserved;
6447 DWORD FlagsEx;
6448#endif /* < win2k */
2d716d75 6449 } new_file_details_w;
0fda9b75
DC
6450
6451#ifdef NTGUI_UNICODE
2d716d75
EZ
6452 wchar_t filename_buf_w[32*1024 + 1]; // NT kernel maximum
6453 OPENFILENAMEW * file_details_w = &new_file_details_w.details;
eac30cd4 6454 const int use_unicode = 1;
0fda9b75 6455#else /* not NTGUI_UNICODE */
2d716d75
EZ
6456 struct {
6457 OPENFILENAMEA details;
6458#if _WIN32_WINNT < 0x500 /* < win2k */
6459 PVOID pvReserved;
6460 DWORD dwReserved;
6461 DWORD FlagsEx;
6462#endif /* < win2k */
6463 } new_file_details_a;
6464 wchar_t filename_buf_w[MAX_PATH + 1], dir_w[MAX_PATH];
6465 char filename_buf_a[MAX_PATH + 1], dir_a[MAX_PATH];
6466 OPENFILENAMEW * file_details_w = &new_file_details_w.details;
6467 OPENFILENAMEA * file_details_a = &new_file_details_a.details;
6468 int use_unicode = w32_unicode_filenames;
6469 wchar_t *prompt_w;
6470 char *prompt_a;
6471 int len;
6472 char fname_ret[MAX_UTF8_PATH];
0fda9b75
DC
6473#endif /* NTGUI_UNICODE */
6474
f9d64bb3 6475 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
0fda9b75 6476 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, filename);
5ac45f98 6477
0fda9b75
DC
6478 {
6479 struct gcpro gcpro1, gcpro2;
6480 GCPRO2 (orig_dir, orig_prompt); /* There is no GCPRON, N>6. */
5ac45f98 6481
0fda9b75
DC
6482 /* Note: under NTGUI_UNICODE, we do _NOT_ use ENCODE_FILE: the
6483 system file encoding expected by the platform APIs (e.g. Cygwin's
303cc1d1
EZ
6484 POSIX implementation) may not be the same as the encoding expected
6485 by the Windows "ANSI" APIs! */
ee78dc32 6486
0fda9b75
DC
6487 CHECK_STRING (prompt);
6488 CHECK_STRING (dir);
ee78dc32 6489
0fda9b75 6490 dir = Fexpand_file_name (dir, Qnil);
7faeca66 6491
0fda9b75
DC
6492 if (STRINGP (filename))
6493 filename = Ffile_name_nondirectory (filename);
6494 else
6495 filename = empty_unibyte_string;
21517c3d 6496
0fda9b75 6497#ifdef CYGWIN
6e9f7997 6498 dir = Fcygwin_convert_file_name_to_windows (dir, Qt);
0fda9b75 6499 if (SCHARS (filename) > 0)
6e9f7997 6500 filename = Fcygwin_convert_file_name_to_windows (filename, Qnil);
0fda9b75 6501#endif
ee78dc32 6502
0fda9b75
DC
6503 CHECK_STRING (dir);
6504 CHECK_STRING (filename);
6505
6506 /* The code in file_dialog_callback that attempts to set the text
6507 of the file name edit window when handling the CDN_INITDONE
6508 WM_NOTIFY message does not work. Setting filename to "Current
6509 Directory" in the only_dir_p case here does work however. */
6510 if (SCHARS (filename) == 0 && ! NILP (only_dir_p))
6511 filename = build_string ("Current Directory");
6512
6513 /* Convert the values we've computed so far to system form. */
6514#ifdef NTGUI_UNICODE
6515 to_unicode (prompt, &prompt);
6516 to_unicode (dir, &dir);
6517 to_unicode (filename, &filename);
2d716d75
EZ
6518 if (SBYTES (filename) + 1 > sizeof (filename_buf_w))
6519 report_file_error ("filename too long", default_filename);
6520
6521 memcpy (filename_buf_w, SDATA (filename), SBYTES (filename) + 1);
0fda9b75
DC
6522#else /* !NTGUI_UNICODE */
6523 prompt = ENCODE_FILE (prompt);
6524 dir = ENCODE_FILE (dir);
6525 filename = ENCODE_FILE (filename);
6526
6527 /* We modify these in-place, so make copies for safety. */
6528 dir = Fcopy_sequence (dir);
6529 unixtodos_filename (SDATA (dir));
6530 filename = Fcopy_sequence (filename);
6531 unixtodos_filename (SDATA (filename));
2d716d75
EZ
6532 if (SBYTES (filename) >= MAX_UTF8_PATH)
6533 report_file_error ("filename too long", default_filename);
6534 if (w32_unicode_filenames)
6535 {
6536 filename_to_utf16 (SSDATA (dir), dir_w);
6537 if (filename_to_utf16 (SSDATA (filename), filename_buf_w) != 0)
6538 {
6539 /* filename_to_utf16 sets errno to ENOENT when the file
6540 name is too long or cannot be converted to UTF-16. */
6541 if (errno == ENOENT && filename_buf_w[MAX_PATH - 1] != 0)
6542 report_file_error ("filename too long", default_filename);
6543 }
829f4f22
EZ
6544 len = pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS,
6545 SSDATA (prompt), -1, NULL, 0);
ff0c63f2
EZ
6546 if (len > 32768)
6547 len = 32768;
2d716d75 6548 prompt_w = alloca (len * sizeof (wchar_t));
829f4f22
EZ
6549 pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS,
6550 SSDATA (prompt), -1, prompt_w, len);
2d716d75
EZ
6551 }
6552 else
6553 {
6554 filename_to_ansi (SSDATA (dir), dir_a);
6555 if (filename_to_ansi (SSDATA (filename), filename_buf_a) != '\0')
6556 {
6557 /* filename_to_ansi sets errno to ENOENT when the file
6558 name is too long or cannot be converted to UTF-16. */
6559 if (errno == ENOENT && filename_buf_a[MAX_PATH - 1] != 0)
6560 report_file_error ("filename too long", default_filename);
6561 }
829f4f22
EZ
6562 len = pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS,
6563 SSDATA (prompt), -1, NULL, 0);
ff0c63f2
EZ
6564 if (len > 32768)
6565 len = 32768;
2d716d75 6566 prompt_w = alloca (len * sizeof (wchar_t));
829f4f22
EZ
6567 pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS,
6568 SSDATA (prompt), -1, prompt_w, len);
6569 len = pWideCharToMultiByte (CP_ACP, 0, prompt_w, -1, NULL, 0, NULL, NULL);
ff0c63f2
EZ
6570 if (len > 32768)
6571 len = 32768;
2d716d75 6572 prompt_a = alloca (len);
829f4f22 6573 pWideCharToMultiByte (CP_ACP, 0, prompt_w, -1, prompt_a, len, NULL, NULL);
2d716d75 6574 }
0fda9b75
DC
6575#endif /* NTGUI_UNICODE */
6576
501199a3
DC
6577 /* Fill in the structure for the call to GetOpenFileName below.
6578 For NTGUI_UNICODE builds (which run only on NT), we just use
6579 the actual size of the structure. For non-NTGUI_UNICODE
6580 builds, we tell the OS we're using an old version of the
6581 structure if the OS isn't new enough to support the newer
6582 version. */
2d716d75
EZ
6583 if (use_unicode)
6584 {
6585 memset (&new_file_details_w, 0, sizeof (new_file_details_w));
6586 if (w32_major_version > 4 && w32_major_version < 95)
6587 file_details_w->lStructSize = sizeof (new_file_details_w);
6588 else
6589 file_details_w->lStructSize = sizeof (*file_details_w);
6590 /* Set up the inout parameter for the selected file name. */
6591 file_details_w->lpstrFile = filename_buf_w;
6592 file_details_w->nMaxFile =
6593 sizeof (filename_buf_w) / sizeof (*filename_buf_w);
6594 file_details_w->hwndOwner = FRAME_W32_WINDOW (f);
6595 /* Undocumented Bug in Common File Dialog:
6596 If a filter is not specified, shell links are not resolved. */
6597 file_details_w->lpstrFilter = filter_w;
6598#ifdef NTGUI_UNICODE
6599 file_details_w->lpstrInitialDir = (wchar_t*) SDATA (dir);
a5c9bbb3 6600 file_details_w->lpstrTitle = (guichar_t*) SDATA (prompt);
2d716d75
EZ
6601#else
6602 file_details_w->lpstrInitialDir = dir_w;
6603 file_details_w->lpstrTitle = prompt_w;
6604#endif
6605 file_details_w->nFilterIndex = NILP (only_dir_p) ? 1 : 2;
6606 file_details_w->Flags = (OFN_HIDEREADONLY | OFN_NOCHANGEDIR
6607 | OFN_EXPLORER | OFN_ENABLEHOOK);
6608 if (!NILP (mustmatch))
6609 {
6610 /* Require that the path to the parent directory exists. */
6611 file_details_w->Flags |= OFN_PATHMUSTEXIST;
6612 /* If we are looking for a file, require that it exists. */
6613 if (NILP (only_dir_p))
6614 file_details_w->Flags |= OFN_FILEMUSTEXIST;
6615 }
6616 }
a5c9bbb3 6617#ifndef NTGUI_UNICODE
7f2b4738 6618 else
7f2b4738 6619 {
2d716d75
EZ
6620 memset (&new_file_details_a, 0, sizeof (new_file_details_a));
6621 if (w32_major_version > 4 && w32_major_version < 95)
6622 file_details_a->lStructSize = sizeof (new_file_details_a);
6623 else
6624 file_details_a->lStructSize = sizeof (*file_details_a);
6625 file_details_a->lpstrFile = filename_buf_a;
6626 file_details_a->nMaxFile =
6627 sizeof (filename_buf_a) / sizeof (*filename_buf_a);
6628 file_details_a->hwndOwner = FRAME_W32_WINDOW (f);
6629 file_details_a->lpstrFilter = filter_a;
6630 file_details_a->lpstrInitialDir = dir_a;
6631 file_details_a->lpstrTitle = prompt_a;
6632 file_details_a->nFilterIndex = NILP (only_dir_p) ? 1 : 2;
6633 file_details_a->Flags = (OFN_HIDEREADONLY | OFN_NOCHANGEDIR
6634 | OFN_EXPLORER | OFN_ENABLEHOOK);
6635 if (!NILP (mustmatch))
6636 {
6637 /* Require that the path to the parent directory exists. */
6638 file_details_a->Flags |= OFN_PATHMUSTEXIST;
6639 /* If we are looking for a file, require that it exists. */
6640 if (NILP (only_dir_p))
6641 file_details_a->Flags |= OFN_FILEMUSTEXIST;
6642 }
7f2b4738 6643 }
a5c9bbb3 6644#endif /* !NTGUI_UNICODE */
1030b26b 6645
0fda9b75
DC
6646 {
6647 int count = SPECPDL_INDEX ();
303cc1d1 6648 /* Prevent redisplay. */
0fda9b75 6649 specbind (Qinhibit_redisplay, Qt);
36a305a7 6650 block_input ();
2d716d75
EZ
6651 if (use_unicode)
6652 {
6653 file_details_w->lpfnHook = file_dialog_callback;
6654
6655 file_opened = GetOpenFileNameW (file_details_w);
6656 }
8b55eeeb 6657#ifndef NTGUI_UNICODE
2d716d75
EZ
6658 else
6659 {
6660 file_details_a->lpfnHook = file_dialog_callback;
1030b26b 6661
2d716d75
EZ
6662 file_opened = GetOpenFileNameA (file_details_a);
6663 }
8b55eeeb 6664#endif /* !NTGUI_UNICODE */
36a305a7 6665 unblock_input ();
0fda9b75
DC
6666 unbind_to (count, Qnil);
6667 }
ba6f3859
JR
6668
6669 if (file_opened)
1030b26b 6670 {
0fda9b75
DC
6671 /* Get an Emacs string from the value Windows gave us. */
6672#ifdef NTGUI_UNICODE
2d716d75 6673 filename = from_unicode_buffer (filename_buf_w);
0fda9b75 6674#else /* !NTGUI_UNICODE */
2d716d75
EZ
6675 if (use_unicode)
6676 filename_from_utf16 (filename_buf_w, fname_ret);
6677 else
6678 filename_from_ansi (filename_buf_a, fname_ret);
6679 dostounix_filename (fname_ret);
6680 filename = DECODE_FILE (build_unibyte_string (fname_ret));
0fda9b75
DC
6681#endif /* NTGUI_UNICODE */
6682
6683#ifdef CYGWIN
6e9f7997 6684 filename = Fcygwin_convert_file_name_from_windows (filename, Qt);
0fda9b75
DC
6685#endif /* CYGWIN */
6686
6687 /* Strip the dummy filename off the end of the string if we
6688 added it to select a directory. */
119f64db 6689 if ((use_unicode && file_details_w->nFilterIndex == 2)
893fcd38 6690#ifndef NTGUI_UNICODE
119f64db 6691 || (!use_unicode && file_details_a->nFilterIndex == 2)
893fcd38
EZ
6692#endif
6693 )
2d716d75 6694 filename = Ffile_name_directory (filename);
1030b26b 6695 }
c80e3b4a 6696 /* User canceled the dialog without making a selection. */
1030b26b 6697 else if (!CommDlgExtendedError ())
0fda9b75 6698 filename = Qnil;
1030b26b
JR
6699 /* An error occurred, fallback on reading from the mini-buffer. */
6700 else
0fda9b75
DC
6701 filename = Fcompleting_read (
6702 orig_prompt,
6703 intern ("read-file-name-internal"),
6704 orig_dir,
6705 mustmatch,
6706 orig_dir,
6707 Qfile_name_history,
6708 default_filename,
6709 Qnil);
1030b26b 6710
0fda9b75 6711 UNGCPRO;
1030b26b 6712 }
ee78dc32 6713
6fc2811b 6714 /* Make "Cancel" equivalent to C-g. */
0fda9b75 6715 if (NILP (filename))
6fc2811b 6716 Fsignal (Qquit, Qnil);
ee78dc32 6717
0fda9b75 6718 RETURN_UNGCPRO (filename);
6fc2811b 6719}
ee78dc32 6720
0fda9b75
DC
6721\f
6722#ifdef WINDOWSNT
6cf29fe8
JR
6723/* Moving files to the system recycle bin.
6724 Used by `move-file-to-trash' instead of the default moving to ~/.Trash */
6725DEFUN ("system-move-file-to-trash", Fsystem_move_file_to_trash,
6726 Ssystem_move_file_to_trash, 1, 1, 0,
6727 doc: /* Move file or directory named FILENAME to the recycle bin. */)
5842a27b 6728 (Lisp_Object filename)
6cf29fe8
JR
6729{
6730 Lisp_Object handler;
6731 Lisp_Object encoded_file;
6732 Lisp_Object operation;
6733
6734 operation = Qdelete_file;
6735 if (!NILP (Ffile_directory_p (filename))
6736 && NILP (Ffile_symlink_p (filename)))
6737 {
e9a0aef8 6738 operation = intern ("delete-directory");
6cf29fe8
JR
6739 filename = Fdirectory_file_name (filename);
6740 }
2c47be65
EZ
6741
6742 /* Must have fully qualified file names for moving files to Recycle
6743 Bin. */
6cf29fe8
JR
6744 filename = Fexpand_file_name (filename, Qnil);
6745
6746 handler = Ffind_file_name_handler (filename, operation);
6747 if (!NILP (handler))
6748 return call2 (handler, operation, filename);
2c47be65
EZ
6749 else
6750 {
6751 const char * path;
6752 int result;
6cf29fe8 6753
2c47be65 6754 encoded_file = ENCODE_FILE (filename);
6cf29fe8 6755
2c47be65 6756 path = map_w32_filename (SDATA (encoded_file), NULL);
6cf29fe8 6757
2c47be65
EZ
6758 /* The Unicode version of SHFileOperation is not supported on
6759 Windows 9X. */
6760 if (w32_unicode_filenames && os_subtype != OS_9X)
6761 {
6762 SHFILEOPSTRUCTW file_op_w;
6763 /* We need one more element beyond MAX_PATH because this is
6764 a list of file names, with the last element double-null
6765 terminated. */
6766 wchar_t tmp_path_w[MAX_PATH + 1];
6767
6768 memset (tmp_path_w, 0, sizeof (tmp_path_w));
6769 filename_to_utf16 (path, tmp_path_w);
6770
6771 /* On Windows, write permission is required to delete/move files. */
6772 _wchmod (tmp_path_w, 0666);
6773
6774 memset (&file_op_w, 0, sizeof (file_op_w));
6775 file_op_w.hwnd = HWND_DESKTOP;
6776 file_op_w.wFunc = FO_DELETE;
6777 file_op_w.pFrom = tmp_path_w;
6778 file_op_w.fFlags = FOF_SILENT | FOF_NOCONFIRMATION | FOF_ALLOWUNDO
6779 | FOF_NOERRORUI | FOF_NO_CONNECTED_ELEMENTS;
6780 file_op_w.fAnyOperationsAborted = FALSE;
6781
6782 result = SHFileOperationW (&file_op_w);
6783 }
6784 else
6785 {
6786 SHFILEOPSTRUCTA file_op_a;
6787 char tmp_path_a[MAX_PATH + 1];
6cf29fe8 6788
2c47be65
EZ
6789 memset (tmp_path_a, 0, sizeof (tmp_path_a));
6790 filename_to_ansi (path, tmp_path_a);
6cf29fe8 6791
2c47be65
EZ
6792 /* If a file cannot be represented in ANSI codepage, don't
6793 let them inadvertently delete other files because some
6794 characters are interpreted as a wildcards. */
6795 if (_mbspbrk (tmp_path_a, "?*"))
6796 result = ERROR_FILE_NOT_FOUND;
6797 else
6798 {
6799 _chmod (tmp_path_a, 0666);
6cf29fe8 6800
2c47be65
EZ
6801 memset (&file_op_a, 0, sizeof (file_op_a));
6802 file_op_a.hwnd = HWND_DESKTOP;
6803 file_op_a.wFunc = FO_DELETE;
6804 file_op_a.pFrom = tmp_path_a;
6805 file_op_a.fFlags = FOF_SILENT | FOF_NOCONFIRMATION | FOF_ALLOWUNDO
6806 | FOF_NOERRORUI | FOF_NO_CONNECTED_ELEMENTS;
6807 file_op_a.fAnyOperationsAborted = FALSE;
6cf29fe8 6808
2c47be65
EZ
6809 result = SHFileOperationA (&file_op_a);
6810 }
6811 }
6812 if (result != 0)
6813 report_file_error ("Removing old name", list1 (filename));
6814 }
6cf29fe8
JR
6815 return Qnil;
6816}
6817
0fda9b75
DC
6818#endif /* WINDOWSNT */
6819
6fc2811b 6820\f
6fc2811b
JR
6821/***********************************************************************
6822 w32 specialized functions
6823 ***********************************************************************/
ee78dc32 6824
74e1aeec
JR
6825DEFUN ("w32-send-sys-command", Fw32_send_sys_command,
6826 Sw32_send_sys_command, 1, 2, 0,
6827 doc: /* Send frame a Windows WM_SYSCOMMAND message of type COMMAND.
52deb19f 6828Some useful values for COMMAND are #xf030 to maximize frame (#xf020
d84b082d
JR
6829to minimize), #xf120 to restore frame to original size, and #xf100
6830to activate the menubar for keyboard access. #xf140 activates the
74e1aeec
JR
6831screen saver if defined.
6832
6833If optional parameter FRAME is not specified, use selected frame. */)
5842a27b 6834 (Lisp_Object command, Lisp_Object frame)
1edf84e7 6835{
a10c8269 6836 struct frame *f = decode_window_system_frame (frame);
1edf84e7 6837
b7826503 6838 CHECK_NUMBER (command);
1edf84e7 6839
ce6059da 6840 PostMessage (FRAME_W32_WINDOW (f), WM_SYSCOMMAND, XINT (command), 0);
1edf84e7
GV
6841
6842 return Qnil;
6843}
6844
55dcfc15 6845DEFUN ("w32-shell-execute", Fw32_shell_execute, Sw32_shell_execute, 2, 4, 0,
74e1aeec
JR
6846 doc: /* Get Windows to perform OPERATION on DOCUMENT.
6847This is a wrapper around the ShellExecute system function, which
6848invokes the application registered to handle OPERATION for DOCUMENT.
74e1aeec 6849
1dccd454
EZ
6850OPERATION is either nil or a string that names a supported operation.
6851What operations can be used depends on the particular DOCUMENT and its
6852handler application, but typically it is one of the following common
6853operations:
6854
6855 \"open\" - open DOCUMENT, which could be a file, a directory, or an
6d48053b
EZ
6856 executable program (application). If it is an application,
6857 that application is launched in the current buffer's default
1dccd454
EZ
6858 directory. Otherwise, the application associated with
6859 DOCUMENT is launched in the buffer's default directory.
6d48053b
EZ
6860 \"opennew\" - like \"open\", but instruct the application to open
6861 DOCUMENT in a new window.
6862 \"openas\" - open the \"Open With\" dialog for DOCUMENT.
6863 \"print\" - print DOCUMENT, which must be a file.
6864 \"printto\" - print DOCUMENT, which must be a file, to a specified printer.
6865 The printer should be provided in PARAMETERS, see below.
6866 \"explore\" - start the Windows Explorer on DOCUMENT.
1dccd454
EZ
6867 \"edit\" - launch an editor and open DOCUMENT for editing; which
6868 editor is launched depends on the association for the
6d48053b
EZ
6869 specified DOCUMENT.
6870 \"find\" - initiate search starting from DOCUMENT, which must specify
6871 a directory.
ec6e26b8
EZ
6872 \"runas\" - run DOCUMENT, which must be an excutable file, with
6873 elevated privileges (a.k.a. \"as Administrator\").
6d48053b
EZ
6874 \"properties\"
6875 - open the the property sheet dialog for DOCUMENT; works
6876 for *.lnk desktop shortcuts, and little or nothing else.
1dccd454 6877 nil - invoke the default OPERATION, or \"open\" if default is
6d48053b 6878 not defined or unavailable.
1dccd454
EZ
6879
6880DOCUMENT is typically the name of a document file or a URL, but can
6d48053b 6881also be an executable program to run, or a directory to open in the
9ab3ce4d
EZ
6882Windows Explorer. If it is a file, it must be a local one; this
6883function does not support remote file names.
1dccd454 6884
6d48053b 6885If DOCUMENT is an executable program, the optional third arg PARAMETERS
02b39a28 6886can be a string containing command line parameters that will be passed
6d48053b
EZ
6887to the program. Some values of OPERATION also require parameters (e.g.,
6888\"printto\" requires the printer address). Otherwise, PARAMETERS should
6889be nil or unspecified.
1dccd454 6890
02b39a28 6891Optional fourth argument SHOW-FLAG can be used to control how the
1dccd454 6892application will be displayed when it is invoked. If SHOW-FLAG is nil
6d48053b
EZ
6893or unspecified, the application is displayed as if SHOW-FLAG of 10 was
6894specified, otherwise it is an integer between 0 and 11 representing
6895a ShowWindow flag:
74e1aeec
JR
6896
6897 0 - start hidden
6d48053b
EZ
6898 1 - start as normal-size window
6899 3 - start in a maximized window
6900 6 - start in a minimized window
6901 10 - start as the application itself specifies; this is the default. */)
5842a27b 6902 (Lisp_Object operation, Lisp_Object document, Lisp_Object parameters, Lisp_Object show_flag)
55dcfc15 6903{
5cba3209 6904 char *errstr;
ff0c63f2
EZ
6905 Lisp_Object current_dir = BVAR (current_buffer, directory);;
6906 wchar_t *doc_w = NULL, *params_w = NULL, *ops_w = NULL;
a5c9bbb3 6907 intptr_t result;
ff0c63f2
EZ
6908#ifndef CYGWIN
6909 int use_unicode = w32_unicode_filenames;
6910 char *doc_a = NULL, *params_a = NULL, *ops_a = NULL;
cb13e9a8
EZ
6911 Lisp_Object absdoc, handler;
6912 struct gcpro gcpro1;
ff0c63f2 6913#endif
55dcfc15 6914
b7826503 6915 CHECK_STRING (document);
55dcfc15 6916
819e2da9
DC
6917#ifdef CYGWIN
6918 current_dir = Fcygwin_convert_file_name_to_windows (current_dir, Qt);
ec6e26b8 6919 document = Fcygwin_convert_file_name_to_windows (document, Qt);
819e2da9 6920
ff0c63f2 6921 /* Encode filename, current directory and parameters. */
819e2da9 6922 current_dir = GUI_ENCODE_FILE (current_dir);
ec6e26b8
EZ
6923 document = GUI_ENCODE_FILE (document);
6924 doc_w = GUI_SDATA (document);
3bc143eb 6925 if (STRINGP (parameters))
ff0c63f2
EZ
6926 {
6927 parameters = GUI_ENCODE_SYSTEM (parameters);
6928 params_w = GUI_SDATA (parameters);
6929 }
6930 if (STRINGP (operation))
6931 {
6932 operation = GUI_ENCODE_SYSTEM (operation);
6933 ops_w = GUI_SDATA (operation);
6934 }
a5c9bbb3
EZ
6935 result = (intptr_t) ShellExecuteW (NULL, ops_w, doc_w, params_w,
6936 GUI_SDATA (current_dir),
6937 (INTEGERP (show_flag)
6938 ? XINT (show_flag) : SW_SHOWDEFAULT));
ff0c63f2 6939#else /* !CYGWIN */
ec6e26b8 6940 current_dir = ENCODE_FILE (current_dir);
9ab3ce4d 6941 /* We have a situation here. If DOCUMENT is a relative file name,
8101203a
EZ
6942 but its name includes leading directories, i.e. it lives not in
6943 CURRENT_DIR, but in its subdirectory, then ShellExecute below
6944 will fail to find it. So we need to make the file name is
6945 absolute. But DOCUMENT does not have to be a file, it can be a
6946 URL, for example. So we make it absolute only if it is an
6947 existing file; if it is a file that does not exist, tough. */
cb13e9a8 6948 GCPRO1 (absdoc);
9ab3ce4d 6949 absdoc = Fexpand_file_name (document, Qnil);
cb13e9a8
EZ
6950 /* Don't call file handlers for file-exists-p, since they might
6951 attempt to access the file, which could fail or produce undesired
6952 consequences, see bug#16558 for an example. */
6953 handler = Ffind_file_name_handler (absdoc, Qfile_exists_p);
6954 if (NILP (handler))
6955 {
6956 Lisp_Object absdoc_encoded = ENCODE_FILE (absdoc);
6957
6958 if (faccessat (AT_FDCWD, SSDATA (absdoc_encoded), F_OK, AT_EACCESS) == 0)
6959 document = absdoc_encoded;
6960 else
6961 document = ENCODE_FILE (document);
6962 }
6963 else
6964 document = ENCODE_FILE (document);
6965 UNGCPRO;
ff0c63f2
EZ
6966 if (use_unicode)
6967 {
6968 wchar_t document_w[MAX_PATH], current_dir_w[MAX_PATH];
6969
6970 /* Encode filename, current directory and parameters, and
6971 convert operation to UTF-16. */
ff0c63f2 6972 filename_to_utf16 (SSDATA (current_dir), current_dir_w);
ec6e26b8
EZ
6973 filename_to_utf16 (SSDATA (document), document_w);
6974 doc_w = document_w;
ff0c63f2
EZ
6975 if (STRINGP (parameters))
6976 {
9f9974b4
EZ
6977 int len;
6978
6979 parameters = ENCODE_SYSTEM (parameters);
829f4f22
EZ
6980 len = pMultiByteToWideChar (CP_ACP, MB_ERR_INVALID_CHARS,
6981 SSDATA (parameters), -1, NULL, 0);
ff0c63f2
EZ
6982 if (len > 32768)
6983 len = 32768;
6984 params_w = alloca (len * sizeof (wchar_t));
829f4f22
EZ
6985 pMultiByteToWideChar (CP_ACP, MB_ERR_INVALID_CHARS,
6986 SSDATA (parameters), -1, params_w, len);
ff0c63f2
EZ
6987 }
6988 if (STRINGP (operation))
6989 {
6990 /* Assume OPERATION is pure ASCII. */
6991 const char *s = SSDATA (operation);
6992 wchar_t *d;
9f9974b4 6993 int len = SBYTES (operation) + 1;
ff0c63f2
EZ
6994
6995 if (len > 32768)
6996 len = 32768;
6997 d = ops_w = alloca (len * sizeof (wchar_t));
6998 while (d < ops_w + len - 1)
6999 *d++ = *s++;
7000 *d = 0;
7001 }
a5c9bbb3
EZ
7002 result = (intptr_t) ShellExecuteW (NULL, ops_w, doc_w, params_w,
7003 current_dir_w,
7004 (INTEGERP (show_flag)
7005 ? XINT (show_flag) : SW_SHOWDEFAULT));
ff0c63f2
EZ
7006 }
7007 else
7008 {
7009 char document_a[MAX_PATH], current_dir_a[MAX_PATH];
7010
ff0c63f2 7011 filename_to_ansi (SSDATA (current_dir), current_dir_a);
ec6e26b8
EZ
7012 filename_to_ansi (SSDATA (document), document_a);
7013 doc_a = document_a;
ff0c63f2
EZ
7014 if (STRINGP (parameters))
7015 {
9f9974b4
EZ
7016 parameters = ENCODE_SYSTEM (parameters);
7017 params_a = SSDATA (parameters);
ff0c63f2
EZ
7018 }
7019 if (STRINGP (operation))
7020 {
7021 /* Assume OPERATION is pure ASCII. */
7022 ops_a = SSDATA (operation);
7023 }
a5c9bbb3
EZ
7024 result = (intptr_t) ShellExecuteA (NULL, ops_a, doc_a, params_a,
7025 current_dir_a,
7026 (INTEGERP (show_flag)
7027 ? XINT (show_flag) : SW_SHOWDEFAULT));
ff0c63f2
EZ
7028 }
7029#endif /* !CYGWIN */
7030
7031 if (result > 32)
55dcfc15 7032 return Qt;
ff0c63f2
EZ
7033
7034 switch (result)
7035 {
7036 case SE_ERR_ACCESSDENIED:
7037 errstr = w32_strerror (ERROR_ACCESS_DENIED);
7038 break;
7039 case SE_ERR_ASSOCINCOMPLETE:
7040 case SE_ERR_NOASSOC:
7041 errstr = w32_strerror (ERROR_NO_ASSOCIATION);
7042 break;
7043 case SE_ERR_DDEBUSY:
7044 case SE_ERR_DDEFAIL:
7045 errstr = w32_strerror (ERROR_DDE_FAIL);
7046 break;
7047 case SE_ERR_DDETIMEOUT:
7048 errstr = w32_strerror (ERROR_TIMEOUT);
7049 break;
7050 case SE_ERR_DLLNOTFOUND:
7051 errstr = w32_strerror (ERROR_DLL_NOT_FOUND);
7052 break;
7053 case SE_ERR_FNF:
7054 errstr = w32_strerror (ERROR_FILE_NOT_FOUND);
7055 break;
7056 case SE_ERR_OOM:
7057 errstr = w32_strerror (ERROR_NOT_ENOUGH_MEMORY);
7058 break;
7059 case SE_ERR_PNF:
7060 errstr = w32_strerror (ERROR_PATH_NOT_FOUND);
7061 break;
7062 case SE_ERR_SHARE:
7063 errstr = w32_strerror (ERROR_SHARING_VIOLATION);
7064 break;
7065 default:
7066 errstr = w32_strerror (0);
7067 break;
7068 }
5cba3209
EZ
7069 /* The error string might be encoded in the locale's encoding. */
7070 if (!NILP (Vlocale_coding_system))
7071 {
7072 Lisp_Object decoded =
d7ea76b4 7073 code_convert_string_norecord (build_unibyte_string (errstr),
5cba3209 7074 Vlocale_coding_system, 0);
51b59d79 7075 errstr = SSDATA (decoded);
5cba3209
EZ
7076 }
7077 error ("ShellExecute failed: %s", errstr);
55dcfc15
AI
7078}
7079
ccc2d29c
GV
7080/* Lookup virtual keycode from string representing the name of a
7081 non-ascii keystroke into the corresponding virtual key, using
7082 lispy_function_keys. */
7083static int
7084lookup_vk_code (char *key)
7085{
7086 int i;
7087
7088 for (i = 0; i < 256; i++)
bf254037 7089 if (lispy_function_keys[i]
ccc2d29c
GV
7090 && strcmp (lispy_function_keys[i], key) == 0)
7091 return i;
7092
7093 return -1;
7094}
7095
7096/* Convert a one-element vector style key sequence to a hot key
7097 definition. */
2ba49441 7098static Lisp_Object
b56ceb92 7099w32_parse_hot_key (Lisp_Object key)
ccc2d29c
GV
7100{
7101 /* Copied from Fdefine_key and store_in_keymap. */
7102 register Lisp_Object c;
7103 int vk_code;
7104 int lisp_modifiers;
7105 int w32_modifiers;
7106 struct gcpro gcpro1;
7107
b7826503 7108 CHECK_VECTOR (key);
ccc2d29c 7109
9a9d91d9 7110 if (ASIZE (key) != 1)
ccc2d29c
GV
7111 return Qnil;
7112
7113 GCPRO1 (key);
7114
9a9d91d9 7115 c = AREF (key, 0);
ccc2d29c
GV
7116
7117 if (CONSP (c) && lucid_event_type_list_p (c))
7118 c = Fevent_convert_list (c);
7119
7120 UNGCPRO;
7121
7122 if (! INTEGERP (c) && ! SYMBOLP (c))
7123 error ("Key definition is invalid");
7124
7125 /* Work out the base key and the modifiers. */
7126 if (SYMBOLP (c))
7127 {
7128 c = parse_modifiers (c);
2ba49441 7129 lisp_modifiers = XINT (Fcar (Fcdr (c)));
ccc2d29c
GV
7130 c = Fcar (c);
7131 if (!SYMBOLP (c))
1088b922 7132 emacs_abort ();
d5db4077 7133 vk_code = lookup_vk_code (SDATA (SYMBOL_NAME (c)));
ccc2d29c
GV
7134 }
7135 else if (INTEGERP (c))
7136 {
7137 lisp_modifiers = XINT (c) & ~CHARACTERBITS;
7138 /* Many ascii characters are their own virtual key code. */
7139 vk_code = XINT (c) & CHARACTERBITS;
7140 }
7141
7142 if (vk_code < 0 || vk_code > 255)
7143 return Qnil;
7144
7145 if ((lisp_modifiers & meta_modifier) != 0
7146 && !NILP (Vw32_alt_is_meta))
7147 lisp_modifiers |= alt_modifier;
7148
71eab8d1
AI
7149 /* Supply defs missing from mingw32. */
7150#ifndef MOD_ALT
7151#define MOD_ALT 0x0001
7152#define MOD_CONTROL 0x0002
7153#define MOD_SHIFT 0x0004
7154#define MOD_WIN 0x0008
7155#endif
7156
ccc2d29c
GV
7157 /* Convert lisp modifiers to Windows hot-key form. */
7158 w32_modifiers = (lisp_modifiers & hyper_modifier) ? MOD_WIN : 0;
7159 w32_modifiers |= (lisp_modifiers & alt_modifier) ? MOD_ALT : 0;
7160 w32_modifiers |= (lisp_modifiers & ctrl_modifier) ? MOD_CONTROL : 0;
7161 w32_modifiers |= (lisp_modifiers & shift_modifier) ? MOD_SHIFT : 0;
7162
7163 return HOTKEY (vk_code, w32_modifiers);
7164}
7165
74e1aeec
JR
7166DEFUN ("w32-register-hot-key", Fw32_register_hot_key,
7167 Sw32_register_hot_key, 1, 1, 0,
7168 doc: /* Register KEY as a hot-key combination.
7169Certain key combinations like Alt-Tab are reserved for system use on
7170Windows, and therefore are normally intercepted by the system. However,
7171most of these key combinations can be received by registering them as
7172hot-keys, overriding their special meaning.
7173
7174KEY must be a one element key definition in vector form that would be
7175acceptable to `define-key' (e.g. [A-tab] for Alt-Tab). The meta
7176modifier is interpreted as Alt if `w32-alt-is-meta' is t, and hyper
7177is always interpreted as the Windows modifier keys.
7178
7179The return value is the hotkey-id if registered, otherwise nil. */)
5842a27b 7180 (Lisp_Object key)
ccc2d29c
GV
7181{
7182 key = w32_parse_hot_key (key);
7183
fb053a1f 7184 if (!NILP (key) && NILP (Fmemq (key, w32_grabbed_keys)))
ccc2d29c
GV
7185 {
7186 /* Reuse an empty slot if possible. */
7187 Lisp_Object item = Fmemq (Qnil, w32_grabbed_keys);
7188
7189 /* Safe to add new key to list, even if we have focus. */
7190 if (NILP (item))
7191 w32_grabbed_keys = Fcons (key, w32_grabbed_keys);
7192 else
f3fbd155 7193 XSETCAR (item, key);
ccc2d29c
GV
7194
7195 /* Notify input thread about new hot-key definition, so that it
7196 takes effect without needing to switch focus. */
2ba49441 7197 PostThreadMessage (dwWindowsThreadId, WM_EMACS_REGISTER_HOT_KEY,
646b5f55 7198 (WPARAM) XLI (key), 0);
ccc2d29c
GV
7199 }
7200
7201 return key;
7202}
7203
74e1aeec
JR
7204DEFUN ("w32-unregister-hot-key", Fw32_unregister_hot_key,
7205 Sw32_unregister_hot_key, 1, 1, 0,
52deb19f 7206 doc: /* Unregister KEY as a hot-key combination. */)
5842a27b 7207 (Lisp_Object key)
ccc2d29c
GV
7208{
7209 Lisp_Object item;
7210
7211 if (!INTEGERP (key))
7212 key = w32_parse_hot_key (key);
7213
7214 item = Fmemq (key, w32_grabbed_keys);
7215
7216 if (!NILP (item))
7217 {
7218 /* Notify input thread about hot-key definition being removed, so
7219 that it takes effect without needing focus switch. */
7220 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_UNREGISTER_HOT_KEY,
646b5f55 7221 (WPARAM) XINT (XCAR (item)), (LPARAM) XLI (item)))
ccc2d29c
GV
7222 {
7223 MSG msg;
7224 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
7225 }
7226 return Qt;
7227 }
7228 return Qnil;
7229}
7230
74e1aeec
JR
7231DEFUN ("w32-registered-hot-keys", Fw32_registered_hot_keys,
7232 Sw32_registered_hot_keys, 0, 0, 0,
7233 doc: /* Return list of registered hot-key IDs. */)
5842a27b 7234 (void)
ccc2d29c 7235{
74084731 7236 return Fdelq (Qnil, Fcopy_sequence (w32_grabbed_keys));
ccc2d29c
GV
7237}
7238
74e1aeec
JR
7239DEFUN ("w32-reconstruct-hot-key", Fw32_reconstruct_hot_key,
7240 Sw32_reconstruct_hot_key, 1, 1, 0,
52deb19f
JB
7241 doc: /* Convert hot-key ID to a lisp key combination.
7242usage: (w32-reconstruct-hot-key ID) */)
5842a27b 7243 (Lisp_Object hotkeyid)
ccc2d29c
GV
7244{
7245 int vk_code, w32_modifiers;
7246 Lisp_Object key;
7247
b7826503 7248 CHECK_NUMBER (hotkeyid);
ccc2d29c
GV
7249
7250 vk_code = HOTKEY_VK_CODE (hotkeyid);
7251 w32_modifiers = HOTKEY_MODIFIERS (hotkeyid);
7252
bf254037 7253 if (vk_code < 256 && lispy_function_keys[vk_code])
ccc2d29c
GV
7254 key = intern (lispy_function_keys[vk_code]);
7255 else
7256 key = make_number (vk_code);
7257
7258 key = Fcons (key, Qnil);
7259 if (w32_modifiers & MOD_SHIFT)
3ef68e6b 7260 key = Fcons (Qshift, key);
ccc2d29c 7261 if (w32_modifiers & MOD_CONTROL)
3ef68e6b 7262 key = Fcons (Qctrl, key);
ccc2d29c 7263 if (w32_modifiers & MOD_ALT)
3ef68e6b 7264 key = Fcons (NILP (Vw32_alt_is_meta) ? Qalt : Qmeta, key);
ccc2d29c 7265 if (w32_modifiers & MOD_WIN)
3ef68e6b 7266 key = Fcons (Qhyper, key);
ccc2d29c
GV
7267
7268 return key;
7269}
adcc3809 7270
74e1aeec
JR
7271DEFUN ("w32-toggle-lock-key", Fw32_toggle_lock_key,
7272 Sw32_toggle_lock_key, 1, 2, 0,
7273 doc: /* Toggle the state of the lock key KEY.
7274KEY can be `capslock', `kp-numlock', or `scroll'.
7275If the optional parameter NEW-STATE is a number, then the state of KEY
7276is set to off if the low bit of NEW-STATE is zero, otherwise on. */)
5842a27b 7277 (Lisp_Object key, Lisp_Object new_state)
adcc3809
GV
7278{
7279 int vk_code;
adcc3809
GV
7280
7281 if (EQ (key, intern ("capslock")))
7282 vk_code = VK_CAPITAL;
7283 else if (EQ (key, intern ("kp-numlock")))
7284 vk_code = VK_NUMLOCK;
7285 else if (EQ (key, intern ("scroll")))
7286 vk_code = VK_SCROLL;
7287 else
7288 return Qnil;
7289
7290 if (!dwWindowsThreadId)
7291 return make_number (w32_console_toggle_lock_key (vk_code, new_state));
7292
7293 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_TOGGLE_LOCK_KEY,
646b5f55 7294 (WPARAM) vk_code, (LPARAM) XLI (new_state)))
adcc3809
GV
7295 {
7296 MSG msg;
7297 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
7298 return make_number (msg.wParam);
7299 }
7300 return Qnil;
7301}
a01763cb
EZ
7302
7303DEFUN ("w32-window-exists-p", Fw32_window_exists_p, Sw32_window_exists_p,
7304 2, 2, 0,
7305 doc: /* Return non-nil if a window exists with the specified CLASS and NAME.
7306
7307This is a direct interface to the Windows API FindWindow function. */)
5842a27b 7308 (Lisp_Object class, Lisp_Object name)
a01763cb
EZ
7309{
7310 HWND hnd;
7311
7312 if (!NILP (class))
7313 CHECK_STRING (class);
7314 if (!NILP (name))
7315 CHECK_STRING (name);
7316
7317 hnd = FindWindow (STRINGP (class) ? ((LPCTSTR) SDATA (class)) : NULL,
7318 STRINGP (name) ? ((LPCTSTR) SDATA (name)) : NULL);
7319 if (!hnd)
7320 return Qnil;
7321 return Qt;
7322}
7323
880e6158
MR
7324DEFUN ("w32-frame-rect", Fw32_frame_rect, Sw32_frame_rect, 0, 2, 0,
7325 doc: /* Return boundary rectangle of FRAME in screen coordinates.
7326FRAME must be a live frame and defaults to the selected one.
7327
7328The boundary rectangle is a list of four elements, specifying the left,
7329top, right and bottom screen coordinates of FRAME including menu and
7330title bar and decorations. Optional argument CLIENT non-nil means to
7331return the boundaries of the client rectangle which excludes menu and
7332title bar and decorations. */)
7333 (Lisp_Object frame, Lisp_Object client)
7334{
7335 struct frame *f = decode_live_frame (frame);
7336 RECT rect;
7337
7338 if (!NILP (client))
7339 GetClientRect (FRAME_W32_WINDOW (f), &rect);
7340 else
7341 GetWindowRect (FRAME_W32_WINDOW (f), &rect);
7342
7343 return list4 (make_number (rect.left), make_number (rect.top),
7344 make_number (rect.right), make_number (rect.bottom));
7345}
7346
2c2279c6
JR
7347DEFUN ("w32-battery-status", Fw32_battery_status, Sw32_battery_status, 0, 0, 0,
7348 doc: /* Get power status information from Windows system.
7349
7350The following %-sequences are provided:
7351%L AC line status (verbose)
7352%B Battery status (verbose)
7353%b Battery status, empty means high, `-' means low,
7354 `!' means critical, and `+' means charging
7355%p Battery load percentage
7356%s Remaining time (to charge or discharge) in seconds
7357%m Remaining time (to charge or discharge) in minutes
7358%h Remaining time (to charge or discharge) in hours
7359%t Remaining time (to charge or discharge) in the form `h:min' */)
5842a27b 7360 (void)
2c2279c6
JR
7361{
7362 Lisp_Object status = Qnil;
7363
7364 SYSTEM_POWER_STATUS system_status;
7365 if (GetSystemPowerStatus (&system_status))
7366 {
7367 Lisp_Object line_status, battery_status, battery_status_symbol;
7368 Lisp_Object load_percentage, seconds, minutes, hours, remain;
2c2279c6
JR
7369
7370 long seconds_left = (long) system_status.BatteryLifeTime;
7371
7372 if (system_status.ACLineStatus == 0)
7373 line_status = build_string ("off-line");
7374 else if (system_status.ACLineStatus == 1)
7375 line_status = build_string ("on-line");
7376 else
7377 line_status = build_string ("N/A");
7378
7379 if (system_status.BatteryFlag & 128)
7380 {
7381 battery_status = build_string ("N/A");
fff4e459 7382 battery_status_symbol = empty_unibyte_string;
2c2279c6
JR
7383 }
7384 else if (system_status.BatteryFlag & 8)
7385 {
7386 battery_status = build_string ("charging");
7387 battery_status_symbol = build_string ("+");
7388 if (system_status.BatteryFullLifeTime != -1L)
7389 seconds_left = system_status.BatteryFullLifeTime - seconds_left;
7390 }
7391 else if (system_status.BatteryFlag & 4)
7392 {
7393 battery_status = build_string ("critical");
7394 battery_status_symbol = build_string ("!");
7395 }
7396 else if (system_status.BatteryFlag & 2)
7397 {
7398 battery_status = build_string ("low");
7399 battery_status_symbol = build_string ("-");
7400 }
7401 else if (system_status.BatteryFlag & 1)
7402 {
7403 battery_status = build_string ("high");
fff4e459 7404 battery_status_symbol = empty_unibyte_string;
2c2279c6
JR
7405 }
7406 else
7407 {
7408 battery_status = build_string ("medium");
fff4e459 7409 battery_status_symbol = empty_unibyte_string;
2c2279c6
JR
7410 }
7411
7412 if (system_status.BatteryLifePercent > 100)
7413 load_percentage = build_string ("N/A");
7414 else
7415 {
7416 char buffer[16];
0fda9b75 7417 snprintf (buffer, 16, "%d", system_status.BatteryLifePercent);
2c2279c6
JR
7418 load_percentage = build_string (buffer);
7419 }
7420
7421 if (seconds_left < 0)
7422 seconds = minutes = hours = remain = build_string ("N/A");
7423 else
7424 {
7425 long m;
7426 float h;
7427 char buffer[16];
0fda9b75 7428 snprintf (buffer, 16, "%ld", seconds_left);
2c2279c6
JR
7429 seconds = build_string (buffer);
7430
7431 m = seconds_left / 60;
0fda9b75 7432 snprintf (buffer, 16, "%ld", m);
2c2279c6
JR
7433 minutes = build_string (buffer);
7434
7435 h = seconds_left / 3600.0;
0fda9b75 7436 snprintf (buffer, 16, "%3.1f", h);
2c2279c6
JR
7437 hours = build_string (buffer);
7438
0fda9b75 7439 snprintf (buffer, 16, "%ld:%02ld", m / 60, m % 60);
2c2279c6
JR
7440 remain = build_string (buffer);
7441 }
694b6c97 7442
3438fe21 7443 status = listn (CONSTYPE_HEAP, 8,
694b6c97
DA
7444 Fcons (make_number ('L'), line_status),
7445 Fcons (make_number ('B'), battery_status),
7446 Fcons (make_number ('b'), battery_status_symbol),
7447 Fcons (make_number ('p'), load_percentage),
7448 Fcons (make_number ('s'), seconds),
7449 Fcons (make_number ('m'), minutes),
7450 Fcons (make_number ('h'), hours),
7451 Fcons (make_number ('t'), remain));
2c2279c6
JR
7452 }
7453 return status;
7454}
a01763cb 7455
ee78dc32 7456\f
819e2da9 7457#ifdef WINDOWSNT
2254bcde 7458DEFUN ("file-system-info", Ffile_system_info, Sfile_system_info, 1, 1, 0,
74e1aeec
JR
7459 doc: /* Return storage information about the file system FILENAME is on.
7460Value is a list of floats (TOTAL FREE AVAIL), where TOTAL is the total
7461storage of the file system, FREE is the free storage, and AVAIL is the
7462storage available to a non-superuser. All 3 numbers are in bytes.
7463If the underlying system call fails, value is nil. */)
5842a27b 7464 (Lisp_Object filename)
2254bcde
AI
7465{
7466 Lisp_Object encoded, value;
7467
b7826503 7468 CHECK_STRING (filename);
2254bcde
AI
7469 filename = Fexpand_file_name (filename, Qnil);
7470 encoded = ENCODE_FILE (filename);
7471
7472 value = Qnil;
7473
7474 /* Determining the required information on Windows turns out, sadly,
b46a6a83 7475 to be more involved than one would hope. The original Windows API
2254bcde
AI
7476 call for this will return bogus information on some systems, but we
7477 must dynamically probe for the replacement api, since that was
7478 added rather late on. */
7479 {
7480 HMODULE hKernel = GetModuleHandle ("kernel32");
28e6cee8 7481 BOOL (WINAPI *pfn_GetDiskFreeSpaceExW)
577c8624 7482 (wchar_t *, PULARGE_INTEGER, PULARGE_INTEGER, PULARGE_INTEGER)
28e6cee8
EZ
7483 = GetProcAddress (hKernel, "GetDiskFreeSpaceExW");
7484 BOOL (WINAPI *pfn_GetDiskFreeSpaceExA)
2254bcde 7485 (char *, PULARGE_INTEGER, PULARGE_INTEGER, PULARGE_INTEGER)
28e6cee8 7486 = GetProcAddress (hKernel, "GetDiskFreeSpaceExA");
577c8624
EZ
7487 bool have_pfn_GetDiskFreeSpaceEx =
7488 (w32_unicode_filenames && pfn_GetDiskFreeSpaceExW
7489 || !w32_unicode_filenames && pfn_GetDiskFreeSpaceExA);
2254bcde
AI
7490
7491 /* On Windows, we may need to specify the root directory of the
7492 volume holding FILENAME. */
577c8624
EZ
7493 char rootname[MAX_UTF8_PATH];
7494 wchar_t rootname_w[MAX_PATH];
7495 char rootname_a[MAX_PATH];
d5db4077 7496 char *name = SDATA (encoded);
577c8624 7497 BOOL result;
2254bcde
AI
7498
7499 /* find the root name of the volume if given */
7500 if (isalpha (name[0]) && name[1] == ':')
7501 {
7502 rootname[0] = name[0];
7503 rootname[1] = name[1];
7504 rootname[2] = '\\';
7505 rootname[3] = 0;
7506 }
7507 else if (IS_DIRECTORY_SEP (name[0]) && IS_DIRECTORY_SEP (name[1]))
7508 {
7509 char *str = rootname;
7510 int slashes = 4;
7511 do
7512 {
7513 if (IS_DIRECTORY_SEP (*name) && --slashes == 0)
7514 break;
7515 *str++ = *name++;
7516 }
7517 while ( *name );
7518
7519 *str++ = '\\';
7520 *str = 0;
7521 }
7522
577c8624
EZ
7523 if (w32_unicode_filenames)
7524 filename_to_utf16 (rootname, rootname_w);
7525 else
7526 filename_to_ansi (rootname, rootname_a);
7527
7528 if (have_pfn_GetDiskFreeSpaceEx)
2254bcde 7529 {
ac849ba4
JR
7530 /* Unsigned large integers cannot be cast to double, so
7531 use signed ones instead. */
2254bcde
AI
7532 LARGE_INTEGER availbytes;
7533 LARGE_INTEGER freebytes;
7534 LARGE_INTEGER totalbytes;
7535
577c8624
EZ
7536 if (w32_unicode_filenames)
7537 result = pfn_GetDiskFreeSpaceExW (rootname_w,
7538 (ULARGE_INTEGER *)&availbytes,
7539 (ULARGE_INTEGER *)&totalbytes,
7540 (ULARGE_INTEGER *)&freebytes);
7541 else
7542 result = pfn_GetDiskFreeSpaceExA (rootname_a,
7543 (ULARGE_INTEGER *)&availbytes,
7544 (ULARGE_INTEGER *)&totalbytes,
7545 (ULARGE_INTEGER *)&freebytes);
7546 if (result)
2254bcde
AI
7547 value = list3 (make_float ((double) totalbytes.QuadPart),
7548 make_float ((double) freebytes.QuadPart),
7549 make_float ((double) availbytes.QuadPart));
7550 }
7551 else
7552 {
7553 DWORD sectors_per_cluster;
7554 DWORD bytes_per_sector;
7555 DWORD free_clusters;
7556 DWORD total_clusters;
7557
577c8624
EZ
7558 if (w32_unicode_filenames)
7559 result = GetDiskFreeSpaceW (rootname_w,
7560 &sectors_per_cluster,
7561 &bytes_per_sector,
7562 &free_clusters,
7563 &total_clusters);
7564 else
7565 result = GetDiskFreeSpaceA (rootname_a,
7566 &sectors_per_cluster,
7567 &bytes_per_sector,
7568 &free_clusters,
7569 &total_clusters);
7570 if (result)
2254bcde
AI
7571 value = list3 (make_float ((double) total_clusters
7572 * sectors_per_cluster * bytes_per_sector),
7573 make_float ((double) free_clusters
7574 * sectors_per_cluster * bytes_per_sector),
7575 make_float ((double) free_clusters
7576 * sectors_per_cluster * bytes_per_sector));
7577 }
7578 }
7579
7580 return value;
7581}
819e2da9
DC
7582#endif /* WINDOWSNT */
7583
2254bcde 7584\f
a5c9bbb3 7585#ifdef WINDOWSNT
6b61353c
KH
7586DEFUN ("default-printer-name", Fdefault_printer_name, Sdefault_printer_name,
7587 0, 0, 0, doc: /* Return the name of Windows default printer device. */)
5842a27b 7588 (void)
6b61353c
KH
7589{
7590 static char pname_buf[256];
7591 int err;
7592 HANDLE hPrn;
080fd649
EZ
7593 PRINTER_INFO_2W *ppi2w = NULL;
7594 PRINTER_INFO_2A *ppi2a = NULL;
6b61353c 7595 DWORD dwNeeded = 0, dwReturned = 0;
080fd649
EZ
7596 char server_name[MAX_UTF8_PATH], share_name[MAX_UTF8_PATH];
7597 char port_name[MAX_UTF8_PATH];
6b61353c
KH
7598
7599 /* Retrieve the default string from Win.ini (the registry).
7600 * String will be in form "printername,drivername,portname".
7601 * This is the most portable way to get the default printer. */
7602 if (GetProfileString ("windows", "device", ",,", pname_buf, sizeof (pname_buf)) <= 0)
7603 return Qnil;
7604 /* printername precedes first "," character */
7605 strtok (pname_buf, ",");
7606 /* We want to know more than the printer name */
7607 if (!OpenPrinter (pname_buf, &hPrn, NULL))
7608 return Qnil;
080fd649
EZ
7609 /* GetPrinterW is not supported by unicows.dll. */
7610 if (w32_unicode_filenames && os_subtype != OS_9X)
7611 GetPrinterW (hPrn, 2, NULL, 0, &dwNeeded);
7612 else
7613 GetPrinterA (hPrn, 2, NULL, 0, &dwNeeded);
6b61353c
KH
7614 if (dwNeeded == 0)
7615 {
7616 ClosePrinter (hPrn);
7617 return Qnil;
7618 }
080fd649
EZ
7619 /* Call GetPrinter again with big enough memory block. */
7620 if (w32_unicode_filenames && os_subtype != OS_9X)
6b61353c 7621 {
080fd649
EZ
7622 /* Allocate memory for the PRINTER_INFO_2 struct. */
7623 ppi2w = xmalloc (dwNeeded);
7624 err = GetPrinterW (hPrn, 2, (LPBYTE)ppi2w, dwNeeded, &dwReturned);
6b61353c 7625 ClosePrinter (hPrn);
080fd649
EZ
7626 if (!err)
7627 {
7628 xfree (ppi2w);
7629 return Qnil;
7630 }
7631
7632 if ((ppi2w->Attributes & PRINTER_ATTRIBUTE_SHARED)
7633 && ppi2w->pServerName)
7634 {
7635 filename_from_utf16 (ppi2w->pServerName, server_name);
7636 filename_from_utf16 (ppi2w->pShareName, share_name);
7637 }
7638 else
7639 {
7640 server_name[0] = '\0';
7641 filename_from_utf16 (ppi2w->pPortName, port_name);
7642 }
6b61353c 7643 }
080fd649 7644 else
6b61353c 7645 {
080fd649
EZ
7646 ppi2a = xmalloc (dwNeeded);
7647 err = GetPrinterA (hPrn, 2, (LPBYTE)ppi2a, dwNeeded, &dwReturned);
7648 ClosePrinter (hPrn);
7649 if (!err)
7650 {
7651 xfree (ppi2a);
7652 return Qnil;
7653 }
6b61353c 7654
080fd649
EZ
7655 if ((ppi2a->Attributes & PRINTER_ATTRIBUTE_SHARED)
7656 && ppi2a->pServerName)
7657 {
7658 filename_from_ansi (ppi2a->pServerName, server_name);
7659 filename_from_ansi (ppi2a->pShareName, share_name);
6b61353c
KH
7660 }
7661 else
080fd649
EZ
7662 {
7663 server_name[0] = '\0';
7664 filename_from_ansi (ppi2a->pPortName, port_name);
6b61353c 7665 }
6b61353c
KH
7666 }
7667
080fd649
EZ
7668 if (server_name[0])
7669 {
7670 /* a remote printer */
7671 if (server_name[0] == '\\')
7672 snprintf (pname_buf, sizeof (pname_buf), "%s\\%s", server_name,
7673 share_name);
7674 else
7675 snprintf (pname_buf, sizeof (pname_buf), "\\\\%s\\%s", server_name,
7676 share_name);
7677 pname_buf[sizeof (pname_buf) - 1] = '\0';
7678 }
7679 else
7680 {
7681 /* a local printer */
7682 strncpy (pname_buf, port_name, sizeof (pname_buf));
7683 pname_buf[sizeof (pname_buf) - 1] = '\0';
7684 /* `pPortName' can include several ports, delimited by ','.
7685 * we only use the first one. */
7686 strtok (pname_buf, ",");
7687 }
7688
7689 return DECODE_FILE (build_unibyte_string (pname_buf));
6b61353c 7690}
a5c9bbb3 7691#endif /* WINDOWSNT */
6b61353c 7692\f
0fda9b75
DC
7693
7694/* Equivalent of strerror for W32 error codes. */
7695char *
7696w32_strerror (int error_no)
7697{
7698 static char buf[500];
7699 DWORD ret;
7700
7701 if (error_no == 0)
7702 error_no = GetLastError ();
7703
7704 ret = FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM |
7705 FORMAT_MESSAGE_IGNORE_INSERTS,
7706 NULL,
7707 error_no,
7708 0, /* choose most suitable language */
7709 buf, sizeof (buf), NULL);
7710
7711 while (ret > 0 && (buf[ret - 1] == '\n' ||
7712 buf[ret - 1] == '\r' ))
7713 --ret;
7714 buf[ret] = '\0';
7715 if (!ret)
7716 sprintf (buf, "w32 error %u", error_no);
7717
7718 return buf;
7719}
7720
b15736e6
EZ
7721/* For convenience when debugging. (You cannot call GetLastError
7722 directly from GDB: it will crash, because it uses the __stdcall
7723 calling convention, not the _cdecl convention assumed by GDB.) */
7724DWORD
0fda9b75
DC
7725w32_last_error (void)
7726{
7727 return GetLastError ();
7728}
7729
7730/* Cache information describing the NT system for later use. */
7731void
7732cache_system_info (void)
7733{
7734 union
7735 {
7736 struct info
7737 {
7738 char major;
7739 char minor;
7740 short platform;
7741 } info;
7742 DWORD data;
7743 } version;
7744
1cf1bbd5
DC
7745 /* Cache the module handle of Emacs itself. */
7746 hinst = GetModuleHandle (NULL);
7747
0fda9b75
DC
7748 /* Cache the version of the operating system. */
7749 version.data = GetVersion ();
7750 w32_major_version = version.info.major;
7751 w32_minor_version = version.info.minor;
7752
7753 if (version.info.platform & 0x8000)
7754 os_subtype = OS_9X;
7755 else
7756 os_subtype = OS_NT;
7757
7758 /* Cache page size, allocation unit, processor type, etc. */
7759 GetSystemInfo (&sysinfo_cache);
cb576b5c 7760 syspage_mask = (DWORD_PTR)sysinfo_cache.dwPageSize - 1;
0fda9b75
DC
7761
7762 /* Cache os info. */
7763 osinfo_cache.dwOSVersionInfoSize = sizeof (OSVERSIONINFO);
7764 GetVersionEx (&osinfo_cache);
7765
7766 w32_build_number = osinfo_cache.dwBuildNumber;
7767 if (os_subtype == OS_9X)
7768 w32_build_number &= 0xffff;
7769
7770 w32_num_mouse_buttons = GetSystemMetrics (SM_CMOUSEBUTTONS);
7771}
7772
7773#ifdef EMACSDEBUG
7774void
7775_DebPrint (const char *fmt, ...)
7776{
7777 char buf[1024];
7778 va_list args;
7779
7780 va_start (args, fmt);
7781 vsprintf (buf, fmt, args);
7782 va_end (args);
7783#if CYGWIN
7784 fprintf (stderr, "%s", buf);
7785#endif
7786 OutputDebugString (buf);
7787}
7788#endif
7789
7790int
7791w32_console_toggle_lock_key (int vk_code, Lisp_Object new_state)
7792{
7793 int cur_state = (GetKeyState (vk_code) & 1);
7794
7795 if (NILP (new_state)
7796 || (NUMBERP (new_state)
7797 && ((XUINT (new_state)) & 1) != cur_state))
7798 {
7799#ifdef WINDOWSNT
7800 faked_key = vk_code;
7801#endif /* WINDOWSNT */
7802
7803 keybd_event ((BYTE) vk_code,
7804 (BYTE) MapVirtualKey (vk_code, 0),
7805 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
7806 keybd_event ((BYTE) vk_code,
7807 (BYTE) MapVirtualKey (vk_code, 0),
7808 KEYEVENTF_EXTENDEDKEY | 0, 0);
7809 keybd_event ((BYTE) vk_code,
7810 (BYTE) MapVirtualKey (vk_code, 0),
7811 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
7812 cur_state = !cur_state;
7813 }
7814
7815 return cur_state;
7816}
7817
7818/* Translate console modifiers to emacs modifiers.
7819 German keyboard support (Kai Morgan Zeise 2/18/95). */
7820int
7821w32_kbd_mods_to_emacs (DWORD mods, WORD key)
7822{
7823 int retval = 0;
7824
7825 /* If we recognize right-alt and left-ctrl as AltGr, and it has been
7826 pressed, first remove those modifiers. */
7827 if (!NILP (Vw32_recognize_altgr)
7828 && (mods & (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED))
7829 == (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED))
7830 mods &= ~ (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED);
7831
7832 if (mods & (RIGHT_ALT_PRESSED | LEFT_ALT_PRESSED))
7833 retval = ((NILP (Vw32_alt_is_meta)) ? alt_modifier : meta_modifier);
7834
7835 if (mods & (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
7836 {
7837 retval |= ctrl_modifier;
7838 if ((mods & (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
7839 == (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
7840 retval |= meta_modifier;
7841 }
7842
7843 if (mods & LEFT_WIN_PRESSED)
7844 retval |= w32_key_to_modifier (VK_LWIN);
7845 if (mods & RIGHT_WIN_PRESSED)
7846 retval |= w32_key_to_modifier (VK_RWIN);
7847 if (mods & APPS_PRESSED)
7848 retval |= w32_key_to_modifier (VK_APPS);
7849 if (mods & SCROLLLOCK_ON)
7850 retval |= w32_key_to_modifier (VK_SCROLL);
7851
7852 /* Just in case someone wanted the original behavior, make it
7853 optional by setting w32-capslock-is-shiftlock to t. */
7854 if (NILP (Vw32_capslock_is_shiftlock)
7855 /* Keys that should _not_ be affected by CapsLock. */
7856 && ( (key == VK_BACK)
7857 || (key == VK_TAB)
7858 || (key == VK_CLEAR)
7859 || (key == VK_RETURN)
7860 || (key == VK_ESCAPE)
7861 || ((key >= VK_SPACE) && (key <= VK_HELP))
7862 || ((key >= VK_NUMPAD0) && (key <= VK_F24))
7863 || ((key >= VK_NUMPAD_CLEAR) && (key <= VK_NUMPAD_DELETE))
7864 ))
7865 {
7866 /* Only consider shift state. */
7867 if ((mods & SHIFT_PRESSED) != 0)
7868 retval |= shift_modifier;
7869 }
7870 else
7871 {
7872 /* Ignore CapsLock state if not enabled. */
7873 if (NILP (Vw32_enable_caps_lock))
7874 mods &= ~CAPSLOCK_ON;
7875 if ((mods & (SHIFT_PRESSED | CAPSLOCK_ON)) != 0)
7876 retval |= shift_modifier;
7877 }
7878
7879 return retval;
7880}
7881
7882/* The return code indicates key code size. cpID is the codepage to
7883 use for translation to Unicode; -1 means use the current console
7884 input codepage. */
7885int
7886w32_kbd_patch_key (KEY_EVENT_RECORD *event, int cpId)
7887{
7888 unsigned int key_code = event->wVirtualKeyCode;
7889 unsigned int mods = event->dwControlKeyState;
7890 BYTE keystate[256];
7891 static BYTE ansi_code[4];
7892 static int isdead = 0;
7893
7894 if (isdead == 2)
7895 {
7896 event->uChar.AsciiChar = ansi_code[2];
7897 isdead = 0;
7898 return 1;
7899 }
7900 if (event->uChar.AsciiChar != 0)
7901 return 1;
7902
7903 memset (keystate, 0, sizeof (keystate));
7904 keystate[key_code] = 0x80;
7905 if (mods & SHIFT_PRESSED)
7906 keystate[VK_SHIFT] = 0x80;
7907 if (mods & CAPSLOCK_ON)
7908 keystate[VK_CAPITAL] = 1;
7909 /* If we recognize right-alt and left-ctrl as AltGr, set the key
7910 states accordingly before invoking ToAscii. */
7911 if (!NILP (Vw32_recognize_altgr)
7912 && (mods & LEFT_CTRL_PRESSED) && (mods & RIGHT_ALT_PRESSED))
7913 {
7914 keystate[VK_CONTROL] = 0x80;
7915 keystate[VK_LCONTROL] = 0x80;
7916 keystate[VK_MENU] = 0x80;
7917 keystate[VK_RMENU] = 0x80;
7918 }
7919
7920#if 0
7921 /* Because of an OS bug, ToAscii corrupts the stack when called to
7922 convert a dead key in console mode on NT4. Unfortunately, trying
7923 to check for dead keys using MapVirtualKey doesn't work either -
7924 these functions apparently use internal information about keyboard
7925 layout which doesn't get properly updated in console programs when
7926 changing layout (though apparently it gets partly updated,
7927 otherwise ToAscii wouldn't crash). */
7928 if (is_dead_key (event->wVirtualKeyCode))
7929 return 0;
7930#endif
7931
7932 /* On NT, call ToUnicode instead and then convert to the current
7933 console input codepage. */
7934 if (os_subtype == OS_NT)
7935 {
7936 WCHAR buf[128];
7937
7938 isdead = ToUnicode (event->wVirtualKeyCode, event->wVirtualScanCode,
7939 keystate, buf, 128, 0);
7940 if (isdead > 0)
7941 {
7942 /* When we are called from the GUI message processing code,
7943 we are passed the current keyboard codepage, a positive
7944 number, to use below. */
7945 if (cpId == -1)
7946 cpId = GetConsoleCP ();
7947
7948 event->uChar.UnicodeChar = buf[isdead - 1];
7949 isdead = WideCharToMultiByte (cpId, 0, buf, isdead,
7950 ansi_code, 4, NULL, NULL);
7951 }
7952 else
7953 isdead = 0;
7954 }
7955 else
7956 {
7957 isdead = ToAscii (event->wVirtualKeyCode, event->wVirtualScanCode,
7958 keystate, (LPWORD) ansi_code, 0);
7959 }
7960
7961 if (isdead == 0)
7962 return 0;
7963 event->uChar.AsciiChar = ansi_code[0];
7964 return isdead;
7965}
7966
7967
7968void
7969w32_sys_ring_bell (struct frame *f)
7970{
7971 if (sound_type == 0xFFFFFFFF)
7972 {
7973 Beep (666, 100);
7974 }
7975 else if (sound_type == MB_EMACS_SILENT)
7976 {
7977 /* Do nothing. */
7978 }
7979 else
7980 MessageBeep (sound_type);
7981}
7982
7983\f
0e3fcdef
JR
7984/***********************************************************************
7985 Initialization
7986 ***********************************************************************/
7987
52deb19f 7988/* Keep this list in the same order as frame_parms in frame.c.
6d906347
KS
7989 Use 0 for unsupported frame parameters. */
7990
7991frame_parm_handler w32_frame_parm_handlers[] =
7992{
7993 x_set_autoraise,
7994 x_set_autolower,
7995 x_set_background_color,
7996 x_set_border_color,
7997 x_set_border_width,
7998 x_set_cursor_color,
7999 x_set_cursor_type,
8000 x_set_font,
8001 x_set_foreground_color,
8002 x_set_icon_name,
8003 x_set_icon_type,
8004 x_set_internal_border_width,
880e6158
MR
8005 x_set_right_divider_width,
8006 x_set_bottom_divider_width,
6d906347
KS
8007 x_set_menu_bar_lines,
8008 x_set_mouse_color,
8009 x_explicitly_set_name,
8010 x_set_scroll_bar_width,
8011 x_set_title,
8012 x_set_unsplittable,
8013 x_set_vertical_scroll_bars,
8014 x_set_visibility,
8015 x_set_tool_bar_lines,
8016 0, /* x_set_scroll_bar_foreground, */
8017 0, /* x_set_scroll_bar_background, */
8018 x_set_screen_gamma,
8019 x_set_line_spacing,
8020 x_set_fringe_width,
8021 x_set_fringe_width,
8022 0, /* x_set_wait_for_wm, */
8023 x_set_fullscreen,
a2979e8e 8024 x_set_font_backend,
cad9ef74
JD
8025 x_set_alpha,
8026 0, /* x_set_sticky */
0cc56427 8027 0, /* x_set_tool_bar_position */
6d906347
KS
8028};
8029
0e3fcdef 8030void
b56ceb92 8031syms_of_w32fns (void)
ee78dc32 8032{
afc390dc 8033 globals_of_w32fns ();
9eb16b62
JR
8034 track_mouse_window = NULL;
8035
d285988b
JR
8036 w32_visible_system_caret_hwnd = NULL;
8037
4f5b288c
JR
8038 DEFSYM (Qsuppress_icon, "suppress-icon");
8039 DEFSYM (Qundefined_color, "undefined-color");
8040 DEFSYM (Qcancel_timer, "cancel-timer");
8041 DEFSYM (Qhyper, "hyper");
8042 DEFSYM (Qsuper, "super");
8043 DEFSYM (Qmeta, "meta");
8044 DEFSYM (Qalt, "alt");
8045 DEFSYM (Qctrl, "ctrl");
8046 DEFSYM (Qcontrol, "control");
8047 DEFSYM (Qshift, "shift");
27129af9 8048 DEFSYM (Qfont_param, "font-parameter");
cf13177e
YM
8049 DEFSYM (Qgeometry, "geometry");
8050 DEFSYM (Qworkarea, "workarea");
8051 DEFSYM (Qmm_size, "mm-size");
8052 DEFSYM (Qframes, "frames");
f7b9d4d1 8053 /* This is the end of symbol initialization. */
adcc3809 8054
6fc2811b 8055
ee78dc32 8056 Fput (Qundefined_color, Qerror_conditions,
3438fe21 8057 listn (CONSTYPE_PURE, 2, Qundefined_color, Qerror));
ee78dc32 8058 Fput (Qundefined_color, Qerror_message,
2a0213a6 8059 build_pure_c_string ("Undefined color"));
ee78dc32 8060
ccc2d29c
GV
8061 staticpro (&w32_grabbed_keys);
8062 w32_grabbed_keys = Qnil;
8063
29208e82 8064 DEFVAR_LISP ("w32-color-map", Vw32_color_map,
52deb19f 8065 doc: /* An array of color name mappings for Windows. */);
fbd6baed 8066 Vw32_color_map = Qnil;
ee78dc32 8067
29208e82 8068 DEFVAR_LISP ("w32-pass-alt-to-system", Vw32_pass_alt_to_system,
1133f8e7
EZ
8069 doc: /* Non-nil if Alt key presses are passed on to Windows.
8070When non-nil, for example, Alt pressed and released and then space will
8071open the System menu. When nil, Emacs processes the Alt key events, and
8072then silently swallows them. */);
fbd6baed 8073 Vw32_pass_alt_to_system = Qnil;
da36a4d6 8074
29208e82 8075 DEFVAR_LISP ("w32-alt-is-meta", Vw32_alt_is_meta,
1133f8e7
EZ
8076 doc: /* Non-nil if the Alt key is to be considered the same as the META key.
8077When nil, Emacs will translate the Alt key to the ALT modifier, not to META. */);
fbd6baed 8078 Vw32_alt_is_meta = Qt;
8c205c63 8079
29208e82 8080 DEFVAR_INT ("w32-quit-key", w32_quit_key,
2ba49441
JR
8081 doc: /* If non-zero, the virtual key code for an alternative quit key. */);
8082 w32_quit_key = 0;
7d081355 8083
7d0393cf 8084 DEFVAR_LISP ("w32-pass-lwindow-to-system",
29208e82 8085 Vw32_pass_lwindow_to_system,
1133f8e7
EZ
8086 doc: /* If non-nil, the left \"Windows\" key is passed on to Windows.
8087
8088When non-nil, the Start menu is opened by tapping the key.
8089If you set this to nil, the left \"Windows\" key is processed by Emacs
8090according to the value of `w32-lwindow-modifier', which see.
8091
8092Note that some combinations of the left \"Windows\" key with other keys are
8093caught by Windows at low level, and so binding them in Emacs will have no
8094effect. For example, <lwindow>-r always pops up the Windows Run dialog,
8095<lwindow>-<Pause> pops up the "System Properties" dialog, etc. However, see
8096the doc string of `w32-phantom-key-code'. */);
ccc2d29c
GV
8097 Vw32_pass_lwindow_to_system = Qt;
8098
7d0393cf 8099 DEFVAR_LISP ("w32-pass-rwindow-to-system",
29208e82 8100 Vw32_pass_rwindow_to_system,
1133f8e7
EZ
8101 doc: /* If non-nil, the right \"Windows\" key is passed on to Windows.
8102
8103When non-nil, the Start menu is opened by tapping the key.
8104If you set this to nil, the right \"Windows\" key is processed by Emacs
8105according to the value of `w32-rwindow-modifier', which see.
8106
8107Note that some combinations of the right \"Windows\" key with other keys are
8108caught by Windows at low level, and so binding them in Emacs will have no
8109effect. For example, <rwindow>-r always pops up the Windows Run dialog,
8110<rwindow>-<Pause> pops up the "System Properties" dialog, etc. However, see
8111the doc string of `w32-phantom-key-code'. */);
ccc2d29c
GV
8112 Vw32_pass_rwindow_to_system = Qt;
8113
2ba49441 8114 DEFVAR_LISP ("w32-phantom-key-code",
29208e82 8115 Vw32_phantom_key_code,
2ba49441 8116 doc: /* Virtual key code used to generate \"phantom\" key presses.
74e1aeec
JR
8117Value is a number between 0 and 255.
8118
8119Phantom key presses are generated in order to stop the system from
8120acting on \"Windows\" key events when `w32-pass-lwindow-to-system' or
8121`w32-pass-rwindow-to-system' is nil. */);
ce6059da
AI
8122 /* Although 255 is technically not a valid key code, it works and
8123 means that this hack won't interfere with any real key code. */
2ba49441 8124 XSETINT (Vw32_phantom_key_code, 255);
adcc3809 8125
7d0393cf 8126 DEFVAR_LISP ("w32-enable-num-lock",
29208e82 8127 Vw32_enable_num_lock,
1133f8e7
EZ
8128 doc: /* If non-nil, the Num Lock key acts normally.
8129Set to nil to handle Num Lock as the `kp-numlock' key. */);
ccc2d29c
GV
8130 Vw32_enable_num_lock = Qt;
8131
7d0393cf 8132 DEFVAR_LISP ("w32-enable-caps-lock",
29208e82 8133 Vw32_enable_caps_lock,
1133f8e7
EZ
8134 doc: /* If non-nil, the Caps Lock key acts normally.
8135Set to nil to handle Caps Lock as the `capslock' key. */);
ccc2d29c
GV
8136 Vw32_enable_caps_lock = Qt;
8137
8138 DEFVAR_LISP ("w32-scroll-lock-modifier",
29208e82 8139 Vw32_scroll_lock_modifier,
1133f8e7 8140 doc: /* Modifier to use for the Scroll Lock ON state.
74e1aeec 8141The value can be hyper, super, meta, alt, control or shift for the
1133f8e7
EZ
8142respective modifier, or nil to handle Scroll Lock as the `scroll' key.
8143Any other value will cause the Scroll Lock key to be ignored. */);
47e0e0e4 8144 Vw32_scroll_lock_modifier = Qnil;
ccc2d29c
GV
8145
8146 DEFVAR_LISP ("w32-lwindow-modifier",
29208e82 8147 Vw32_lwindow_modifier,
74e1aeec
JR
8148 doc: /* Modifier to use for the left \"Windows\" key.
8149The value can be hyper, super, meta, alt, control or shift for the
1133f8e7 8150respective modifier, or nil to appear as the `lwindow' key.
74e1aeec 8151Any other value will cause the key to be ignored. */);
ccc2d29c
GV
8152 Vw32_lwindow_modifier = Qnil;
8153
8154 DEFVAR_LISP ("w32-rwindow-modifier",
29208e82 8155 Vw32_rwindow_modifier,
74e1aeec
JR
8156 doc: /* Modifier to use for the right \"Windows\" key.
8157The value can be hyper, super, meta, alt, control or shift for the
1133f8e7 8158respective modifier, or nil to appear as the `rwindow' key.
74e1aeec 8159Any other value will cause the key to be ignored. */);
ccc2d29c
GV
8160 Vw32_rwindow_modifier = Qnil;
8161
8162 DEFVAR_LISP ("w32-apps-modifier",
29208e82 8163 Vw32_apps_modifier,
74e1aeec
JR
8164 doc: /* Modifier to use for the \"Apps\" key.
8165The value can be hyper, super, meta, alt, control or shift for the
1133f8e7 8166respective modifier, or nil to appear as the `apps' key.
74e1aeec 8167Any other value will cause the key to be ignored. */);
ccc2d29c 8168 Vw32_apps_modifier = Qnil;
da36a4d6 8169
29208e82 8170 DEFVAR_BOOL ("w32-enable-synthesized-fonts", w32_enable_synthesized_fonts,
74e1aeec 8171 doc: /* Non-nil enables selection of artificially italicized and bold fonts. */);
d84b082d 8172 w32_enable_synthesized_fonts = 0;
5ac45f98 8173
29208e82 8174 DEFVAR_LISP ("w32-enable-palette", Vw32_enable_palette,
74e1aeec 8175 doc: /* Non-nil enables Windows palette management to map colors exactly. */);
fbd6baed 8176 Vw32_enable_palette = Qt;
5ac45f98 8177
fbd6baed 8178 DEFVAR_INT ("w32-mouse-button-tolerance",
29208e82 8179 w32_mouse_button_tolerance,
74e1aeec
JR
8180 doc: /* Analogue of double click interval for faking middle mouse events.
8181The value is the minimum time in milliseconds that must elapse between
1133f8e7 8182left and right button down events before they are considered distinct events.
74e1aeec
JR
8183If both mouse buttons are depressed within this interval, a middle mouse
8184button down event is generated instead. */);
2ba49441 8185 w32_mouse_button_tolerance = GetDoubleClickTime () / 2;
5ac45f98 8186
fbd6baed 8187 DEFVAR_INT ("w32-mouse-move-interval",
29208e82 8188 w32_mouse_move_interval,
74e1aeec
JR
8189 doc: /* Minimum interval between mouse move events.
8190The value is the minimum time in milliseconds that must elapse between
8191successive mouse move (or scroll bar drag) events before they are
8192reported as lisp events. */);
2ba49441 8193 w32_mouse_move_interval = 0;
84fb1139 8194
74214547 8195 DEFVAR_BOOL ("w32-pass-extra-mouse-buttons-to-system",
29208e82 8196 w32_pass_extra_mouse_buttons_to_system,
1133f8e7 8197 doc: /* If non-nil, the fourth and fifth mouse buttons are passed to Windows.
74214547
JR
8198Recent versions of Windows support mice with up to five buttons.
8199Since most applications don't support these extra buttons, most mouse
8200drivers will allow you to map them to functions at the system level.
8201If this variable is non-nil, Emacs will pass them on, allowing the
8202system to handle them. */);
8203 w32_pass_extra_mouse_buttons_to_system = 0;
8204
0b151762 8205 DEFVAR_BOOL ("w32-pass-multimedia-buttons-to-system",
29208e82 8206 w32_pass_multimedia_buttons_to_system,
0b151762
JR
8207 doc: /* If non-nil, media buttons are passed to Windows.
8208Some modern keyboards contain buttons for controlling media players, web
74084731 8209browsers and other applications. Generally these buttons are handled on a
0b151762
JR
8210system wide basis, but by setting this to nil they are made available
8211to Emacs for binding. Depending on your keyboard, additional keys that
8212may be available are:
8213
8214browser-back, browser-forward, browser-refresh, browser-stop,
8215browser-search, browser-favorites, browser-home,
8216mail, mail-reply, mail-forward, mail-send,
8217app-1, app-2,
8218help, find, new, open, close, save, print, undo, redo, copy, cut, paste,
8219spell-check, correction-list, toggle-dictate-command,
8220media-next, media-previous, media-stop, media-play-pause, media-select,
8221media-play, media-pause, media-record, media-fast-forward, media-rewind,
8222media-channel-up, media-channel-down,
8223volume-mute, volume-up, volume-down,
8224mic-volume-mute, mic-volume-down, mic-volume-up, mic-toggle,
74084731 8225bass-down, bass-boost, bass-up, treble-down, treble-up */);
0b151762
JR
8226 w32_pass_multimedia_buttons_to_system = 1;
8227
5f004711 8228#if 0 /* TODO: Mouse cursor customization. */
29208e82 8229 DEFVAR_LISP ("x-pointer-shape", Vx_pointer_shape,
74e1aeec
JR
8230 doc: /* The shape of the pointer when over text.
8231Changing the value does not affect existing frames
8232unless you set the mouse color. */);
ee78dc32
GV
8233 Vx_pointer_shape = Qnil;
8234
ee78dc32
GV
8235 Vx_nontext_pointer_shape = Qnil;
8236
8237 Vx_mode_pointer_shape = Qnil;
8238
29208e82 8239 DEFVAR_LISP ("x-hourglass-pointer-shape", Vx_hourglass_pointer_shape,
74e1aeec
JR
8240 doc: /* The shape of the pointer when Emacs is busy.
8241This variable takes effect when you create a new frame
8242or when you set the mouse color. */);
0af913d7 8243 Vx_hourglass_pointer_shape = Qnil;
6fc2811b 8244
6fc2811b 8245 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
29208e82 8246 Vx_sensitive_text_pointer_shape,
74e1aeec
JR
8247 doc: /* The shape of the pointer when over mouse-sensitive text.
8248This variable takes effect when you create a new frame
8249or when you set the mouse color. */);
ee78dc32
GV
8250 Vx_sensitive_text_pointer_shape = Qnil;
8251
4694d762 8252 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
29208e82 8253 Vx_window_horizontal_drag_shape,
74e1aeec
JR
8254 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
8255This variable takes effect when you create a new frame
8256or when you set the mouse color. */);
4694d762 8257 Vx_window_horizontal_drag_shape = Qnil;
880e6158
MR
8258
8259 DEFVAR_LISP ("x-window-vertical-drag-cursor",
8260 Vx_window_vertical_drag_shape,
8261 doc: /* Pointer shape to use for indicating a window can be dragged vertically.
8262This variable takes effect when you create a new frame
8263or when you set the mouse color. */);
8264 Vx_window_vertical_drag_shape = Qnil;
5f004711 8265#endif
4694d762 8266
29208e82 8267 DEFVAR_LISP ("x-cursor-fore-pixel", Vx_cursor_fore_pixel,
74e1aeec 8268 doc: /* A string indicating the foreground color of the cursor box. */);
ee78dc32
GV
8269 Vx_cursor_fore_pixel = Qnil;
8270
29208e82 8271 DEFVAR_LISP ("x-max-tooltip-size", Vx_max_tooltip_size,
b3700ae7 8272 doc: /* Maximum size for tooltips.
f5f6c0e0 8273Value is a pair (COLUMNS . ROWS). Text larger than this is clipped. */);
3cf3436e 8274 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
7d0393cf 8275
29208e82 8276 DEFVAR_LISP ("x-no-window-manager", Vx_no_window_manager,
74e1aeec
JR
8277 doc: /* Non-nil if no window manager is in use.
8278Emacs doesn't try to figure this out; this is always nil
8279unless you set it to something else. */);
ee78dc32
GV
8280 /* We don't have any way to find this out, so set it to nil
8281 and maybe the user would like to set it to t. */
8282 Vx_no_window_manager = Qnil;
8283
4587b026 8284 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
29208e82 8285 Vx_pixel_size_width_font_regexp,
74e1aeec
JR
8286 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
8287
8288Since Emacs gets width of a font matching with this regexp from
8289PIXEL_SIZE field of the name, font finding mechanism gets faster for
8290such a font. This is especially effective for such large fonts as
8291Chinese, Japanese, and Korean. */);
4587b026
GV
8292 Vx_pixel_size_width_font_regexp = Qnil;
8293
33d52f9c 8294 DEFVAR_LISP ("w32-bdf-filename-alist",
29208e82 8295 Vw32_bdf_filename_alist,
74e1aeec 8296 doc: /* List of bdf fonts and their corresponding filenames. */);
33d52f9c
GV
8297 Vw32_bdf_filename_alist = Qnil;
8298
1075afa9 8299 DEFVAR_BOOL ("w32-strict-fontnames",
29208e82 8300 w32_strict_fontnames,
74e1aeec
JR
8301 doc: /* Non-nil means only use fonts that are exact matches for those requested.
8302Default is nil, which allows old fontnames that are not XLFD compliant,
8303and allows third-party CJK display to work by specifying false charset
8304fields to trick Emacs into translating to Big5, SJIS etc.
8305Setting this to t will prevent wrong fonts being selected when
8306fontsets are automatically created. */);
1075afa9
GV
8307 w32_strict_fontnames = 0;
8308
c0611964 8309 DEFVAR_BOOL ("w32-strict-painting",
29208e82 8310 w32_strict_painting,
74e1aeec 8311 doc: /* Non-nil means use strict rules for repainting frames.
a8ab3e96 8312Set this to nil to get the old behavior for repainting; this should
74e1aeec 8313only be necessary if the default setting causes problems. */);
c0611964
AI
8314 w32_strict_painting = 1;
8315
767b1ff0 8316#if 0 /* TODO: Port to W32 */
6fc2811b
JR
8317 defsubr (&Sx_change_window_property);
8318 defsubr (&Sx_delete_window_property);
8319 defsubr (&Sx_window_property);
8320#endif
2d764c78 8321 defsubr (&Sxw_display_color_p);
ee78dc32 8322 defsubr (&Sx_display_grayscale_p);
2d764c78
EZ
8323 defsubr (&Sxw_color_defined_p);
8324 defsubr (&Sxw_color_values);
ee78dc32
GV
8325 defsubr (&Sx_server_max_request_size);
8326 defsubr (&Sx_server_vendor);
8327 defsubr (&Sx_server_version);
8328 defsubr (&Sx_display_pixel_width);
8329 defsubr (&Sx_display_pixel_height);
8330 defsubr (&Sx_display_mm_width);
8331 defsubr (&Sx_display_mm_height);
8332 defsubr (&Sx_display_screens);
8333 defsubr (&Sx_display_planes);
8334 defsubr (&Sx_display_color_cells);
8335 defsubr (&Sx_display_visual_class);
8336 defsubr (&Sx_display_backing_store);
8337 defsubr (&Sx_display_save_under);
ee78dc32 8338 defsubr (&Sx_create_frame);
ee78dc32
GV
8339 defsubr (&Sx_open_connection);
8340 defsubr (&Sx_close_connection);
8341 defsubr (&Sx_display_list);
8342 defsubr (&Sx_synchronize);
8343
fbd6baed 8344 /* W32 specific functions */
ee78dc32 8345
fbd6baed
GV
8346 defsubr (&Sw32_define_rgb_color);
8347 defsubr (&Sw32_default_color_map);
cf13177e 8348 defsubr (&Sw32_display_monitor_attributes_list);
1edf84e7 8349 defsubr (&Sw32_send_sys_command);
55dcfc15 8350 defsubr (&Sw32_shell_execute);
ccc2d29c
GV
8351 defsubr (&Sw32_register_hot_key);
8352 defsubr (&Sw32_unregister_hot_key);
8353 defsubr (&Sw32_registered_hot_keys);
8354 defsubr (&Sw32_reconstruct_hot_key);
adcc3809 8355 defsubr (&Sw32_toggle_lock_key);
a01763cb 8356 defsubr (&Sw32_window_exists_p);
880e6158 8357 defsubr (&Sw32_frame_rect);
2c2279c6 8358 defsubr (&Sw32_battery_status);
4587b026 8359
819e2da9 8360#ifdef WINDOWSNT
2254bcde 8361 defsubr (&Sfile_system_info);
a5c9bbb3 8362 defsubr (&Sdefault_printer_name);
819e2da9
DC
8363#endif
8364
0fda9b75 8365 defsubr (&Sset_message_beep);
2254bcde 8366
d148e14d 8367 hourglass_hwnd = NULL;
1885ab29 8368
6fc2811b
JR
8369 defsubr (&Sx_show_tip);
8370 defsubr (&Sx_hide_tip);
6fc2811b 8371 tip_timer = Qnil;
57fa2774
JR
8372 staticpro (&tip_timer);
8373 tip_frame = Qnil;
8374 staticpro (&tip_frame);
6fc2811b 8375
ca56d953
JR
8376 last_show_tip_args = Qnil;
8377 staticpro (&last_show_tip_args);
8378
6fc2811b 8379 defsubr (&Sx_file_dialog);
0fda9b75 8380#ifdef WINDOWSNT
6cf29fe8 8381 defsubr (&Ssystem_move_file_to_trash);
0fda9b75 8382#endif
6fc2811b
JR
8383}
8384
21bf394d 8385\f
c922a224 8386
21bf394d 8387/* Crashing and reporting backtrace. */
60860eb3 8388
21bf394d
EZ
8389#ifndef CYGWIN
8390static LONG CALLBACK my_exception_handler (EXCEPTION_POINTERS *);
8391static LPTOP_LEVEL_EXCEPTION_FILTER prev_exception_handler;
8392#endif
8393static DWORD except_code;
8394static PVOID except_addr;
cbfedb1c 8395
21bf394d
EZ
8396#ifndef CYGWIN
8397/* This handler records the exception code and the address where it
8398 was triggered so that this info could be included in the backtrace.
8399 Without that, the backtrace in some cases has no information
8400 whatsoever about the offending code, and looks as if the top-level
8401 exception handler in the MinGW startup code di the one that
8402 crashed. */
8403static LONG CALLBACK
8404my_exception_handler (EXCEPTION_POINTERS * exception_data)
8405{
8406 except_code = exception_data->ExceptionRecord->ExceptionCode;
8407 except_addr = exception_data->ExceptionRecord->ExceptionAddress;
8408
8409 if (prev_exception_handler)
8410 return prev_exception_handler (exception_data);
8411 return EXCEPTION_EXECUTE_HANDLER;
9785d95b 8412}
21bf394d 8413#endif
6fc2811b 8414
1005b4b9
EZ
8415typedef USHORT (WINAPI * CaptureStackBackTrace_proc) (ULONG, ULONG, PVOID *,
8416 PULONG);
8417
8418#define BACKTRACE_LIMIT_MAX 62
8419
8420int
8421w32_backtrace (void **buffer, int limit)
8422{
8423 static CaptureStackBackTrace_proc s_pfn_CaptureStackBackTrace = NULL;
8424 HMODULE hm_kernel32 = NULL;
8425
8426 if (!s_pfn_CaptureStackBackTrace)
8427 {
8428 hm_kernel32 = LoadLibrary ("Kernel32.dll");
8429 s_pfn_CaptureStackBackTrace =
8430 (CaptureStackBackTrace_proc) GetProcAddress (hm_kernel32,
8431 "RtlCaptureStackBackTrace");
8432 }
8433 if (s_pfn_CaptureStackBackTrace)
8434 return s_pfn_CaptureStackBackTrace (0, min (BACKTRACE_LIMIT_MAX, limit),
8435 buffer, NULL);
8436 return 0;
8437}
8438
7d0393cf 8439void
1088b922 8440emacs_abort (void)
ee78dc32 8441{
5ac45f98
GV
8442 int button;
8443 button = MessageBox (NULL,
8444 "A fatal error has occurred!\n\n"
c52e1638 8445 "Would you like to attach a debugger?\n\n"
1005b4b9
EZ
8446 "Select:\n"
8447 "YES -- to debug Emacs, or\n"
8448 "NO -- to abort Emacs and produce a backtrace\n"
8449 " (emacs_backtrace.txt in current directory)."
cb91d111
EZ
8450#if __GNUC__
8451 "\n\n(type \"gdb -p <emacs-PID>\" and\n"
8452 "\"continue\" inside GDB before clicking YES.)"
8453#endif
8454 , "Emacs Abort Dialog",
5ac45f98 8455 MB_ICONEXCLAMATION | MB_TASKMODAL
c52e1638 8456 | MB_SETFOREGROUND | MB_YESNO);
5ac45f98
GV
8457 switch (button)
8458 {
c52e1638 8459 case IDYES:
5ac45f98 8460 DebugBreak ();
c52e1638
EZ
8461 exit (2); /* tell the compiler we will never return */
8462 case IDNO:
5ac45f98 8463 default:
1005b4b9
EZ
8464 {
8465 void *stack[BACKTRACE_LIMIT_MAX + 1];
8466 int i = w32_backtrace (stack, BACKTRACE_LIMIT_MAX + 1);
8467
8468 if (i)
8469 {
21bf394d
EZ
8470 int errfile_fd = -1;
8471 int j;
8472 char buf[sizeof ("\r\nException at this address:\r\n\r\n")
39e896c1
EZ
8473 /* The type below should really be 'void *', but
8474 INT_BUFSIZE_BOUND cannot handle that without
8475 triggering compiler warnings (under certain
8476 pedantic warning switches), it wants an
8477 integer type. */
8478 + 2 * INT_BUFSIZE_BOUND (intptr_t)];
c8e3a9c3
EZ
8479#ifdef CYGWIN
8480 int stderr_fd = 2;
8481#else
1005b4b9 8482 HANDLE errout = GetStdHandle (STD_ERROR_HANDLE);
c8e3a9c3 8483 int stderr_fd = -1;
1005b4b9
EZ
8484
8485 if (errout && errout != INVALID_HANDLE_VALUE)
8486 stderr_fd = _open_osfhandle ((intptr_t)errout, O_APPEND | O_BINARY);
c8e3a9c3 8487#endif
21bf394d
EZ
8488
8489 /* We use %p, not 0x%p, as %p produces a leading "0x" on XP,
8490 but not on Windows 7. addr2line doesn't mind a missing
8491 "0x", but will be confused by an extra one. */
8492 if (except_addr)
8493 sprintf (buf, "\r\nException 0x%lx at this address:\r\n%p\r\n",
8494 except_code, except_addr);
1005b4b9 8495 if (stderr_fd >= 0)
21bf394d
EZ
8496 {
8497 if (except_addr)
8498 write (stderr_fd, buf, strlen (buf));
8499 write (stderr_fd, "\r\nBacktrace:\r\n", 14);
8500 }
789b5e9a
KB
8501#ifdef CYGWIN
8502#define _open open
8503#endif
1005b4b9
EZ
8504 errfile_fd = _open ("emacs_backtrace.txt", O_RDWR | O_CREAT | O_BINARY, S_IREAD | S_IWRITE);
8505 if (errfile_fd >= 0)
8506 {
8507 lseek (errfile_fd, 0L, SEEK_END);
21bf394d
EZ
8508 if (except_addr)
8509 write (errfile_fd, buf, strlen (buf));
1005b4b9
EZ
8510 write (errfile_fd, "\r\nBacktrace:\r\n", 14);
8511 }
8512
8513 for (j = 0; j < i; j++)
8514 {
1005b4b9
EZ
8515 /* stack[] gives the return addresses, whereas we want
8516 the address of the call, so decrease each address
8517 by approximate size of 1 CALL instruction. */
21bf394d 8518 sprintf (buf, "%p\r\n", (char *)stack[j] - sizeof(void *));
1005b4b9
EZ
8519 if (stderr_fd >= 0)
8520 write (stderr_fd, buf, strlen (buf));
8521 if (errfile_fd >= 0)
8522 write (errfile_fd, buf, strlen (buf));
8523 }
8524 if (i == BACKTRACE_LIMIT_MAX)
8525 {
8526 if (stderr_fd >= 0)
8527 write (stderr_fd, "...\r\n", 5);
8528 if (errfile_fd >= 0)
8529 write (errfile_fd, "...\r\n", 5);
8530 }
8531 if (errfile_fd >= 0)
8532 close (errfile_fd);
8533 }
8534 abort ();
8535 break;
8536 }
5ac45f98 8537 }
ee78dc32 8538}
819e2da9 8539
21bf394d
EZ
8540\f
8541
8542/* Initialization. */
8543
8544/*
8545 globals_of_w32fns is used to initialize those global variables that
8546 must always be initialized on startup even when the global variable
8547 initialized is non zero (see the function main in emacs.c).
8548 globals_of_w32fns is called from syms_of_w32fns when the global
8549 variable initialized is 0 and directly from main when initialized
8550 is non zero.
8551 */
8552void
8553globals_of_w32fns (void)
8554{
8555 HMODULE user32_lib = GetModuleHandle ("user32.dll");
8556 /*
8557 TrackMouseEvent not available in all versions of Windows, so must load
8558 it dynamically. Do it once, here, instead of every time it is used.
8559 */
8560 track_mouse_event_fn = (TrackMouseEvent_Proc)
8561 GetProcAddress (user32_lib, "TrackMouseEvent");
8562
8563 monitor_from_point_fn = (MonitorFromPoint_Proc)
8564 GetProcAddress (user32_lib, "MonitorFromPoint");
8565 get_monitor_info_fn = (GetMonitorInfo_Proc)
8566 GetProcAddress (user32_lib, "GetMonitorInfoA");
8567 monitor_from_window_fn = (MonitorFromWindow_Proc)
8568 GetProcAddress (user32_lib, "MonitorFromWindow");
8569 enum_display_monitors_fn = (EnumDisplayMonitors_Proc)
8570 GetProcAddress (user32_lib, "EnumDisplayMonitors");
8571
8572 {
8573 HMODULE imm32_lib = GetModuleHandle ("imm32.dll");
8574 get_composition_string_fn = (ImmGetCompositionString_Proc)
8575 GetProcAddress (imm32_lib, "ImmGetCompositionStringW");
8576 get_ime_context_fn = (ImmGetContext_Proc)
8577 GetProcAddress (imm32_lib, "ImmGetContext");
8578 release_ime_context_fn = (ImmReleaseContext_Proc)
8579 GetProcAddress (imm32_lib, "ImmReleaseContext");
8580 set_ime_composition_window_fn = (ImmSetCompositionWindow_Proc)
8581 GetProcAddress (imm32_lib, "ImmSetCompositionWindow");
8582 }
8583
8584 except_code = 0;
8585 except_addr = 0;
8586#ifndef CYGWIN
8587 prev_exception_handler = SetUnhandledExceptionFilter (my_exception_handler);
8588#endif
8589
8590 DEFVAR_INT ("w32-ansi-code-page",
8591 w32_ansi_code_page,
8592 doc: /* The ANSI code page used by the system. */);
8593 w32_ansi_code_page = GetACP ();
8594
8595 if (os_subtype == OS_NT)
8596 w32_unicode_gui = 1;
8597 else
8598 w32_unicode_gui = 0;
8599
8600 /* MessageBox does not work without this when linked to comctl32.dll 6.0. */
8601 InitCommonControls ();
8602
8603 syms_of_w32uniscribe ();
8604}
8605
819e2da9
DC
8606#ifdef NTGUI_UNICODE
8607
8608Lisp_Object
8609ntgui_encode_system (Lisp_Object str)
8610{
8611 Lisp_Object encoded;
8612 to_unicode (str, &encoded);
8613 return encoded;
8614}
8615
8616#endif /* NTGUI_UNICODE */