]> code.delx.au - gnu-emacs/blob - src/w32fns.c
delx.au / code / gnu-emacs / blob
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Merge from origin/emacs-25
[gnu-emacs] / src / w32fns.c
1 /* Graphical user interface functions for the Microsoft Windows API.
2
3 Copyright (C) 1989, 1992-2016 Free Software Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or (at
10 your option) any later version.
11
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
19
20 /* Added by Kevin Gallo */
21
22 #include <config.h>
23 /* Override API version to get the latest functionality. */
24 #undef _WIN32_WINNT
25 #define _WIN32_WINNT 0x0600
26
27 #include <signal.h>
28 #include <stdio.h>
29 #include <limits.h>
30 #include <errno.h>
31 #include <math.h>
32 #include <fcntl.h>
33 #include <unistd.h>
34
35 #include <c-ctype.h>
36
37 #include "lisp.h"
38 #include "w32term.h"
39 #include "frame.h"
40 #include "window.h"
41 #include "buffer.h"
42 #include "keyboard.h"
43 #include "blockinput.h"
44 #include "coding.h"
45
46 #include "w32common.h"
47 #include "w32inevt.h"
48
49 #ifdef WINDOWSNT
50 #include <mbstring.h>
51 #endif /* WINDOWSNT */
52
53 #if CYGWIN
54 #include "cygw32.h"
55 #else
56 #include "w32.h"
57 #endif
58
59 #include <basetyps.h>
60 #include <unknwn.h>
61 #include <commctrl.h>
62 #include <commdlg.h>
63 #include <shellapi.h>
64 #include <shlwapi.h>
65 #include <ctype.h>
66 #include <winspool.h>
67 #include <objbase.h>
68
69 #include <dlgs.h>
70 #include <imm.h>
71 #include <windowsx.h>
72
73 #ifndef FOF_NO_CONNECTED_ELEMENTS
74 #define FOF_NO_CONNECTED_ELEMENTS 0x2000
75 #endif
76
77 void syms_of_w32fns (void);
78 void globals_of_w32fns (void);
79
80 extern void free_frame_menubar (struct frame *);
81 extern int w32_console_toggle_lock_key (int, Lisp_Object);
82 extern void w32_menu_display_help (HWND, HMENU, UINT, UINT);
83 extern void w32_free_menu_strings (HWND);
84 extern const char *map_w32_filename (const char *, const char **);
85 extern char * w32_strerror (int error_no);
86
87 #ifndef IDC_HAND
88 #define IDC_HAND MAKEINTRESOURCE(32649)
89 #endif
90
91 /* Prefix for system colors. */
92 #define SYSTEM_COLOR_PREFIX "System"
93 #define SYSTEM_COLOR_PREFIX_LEN (sizeof (SYSTEM_COLOR_PREFIX) - 1)
94
95 /* State variables for emulating a three button mouse. */
96 #define LMOUSE 1
97 #define MMOUSE 2
98 #define RMOUSE 4
99
100 static int button_state = 0;
101 static W32Msg saved_mouse_button_msg;
102 static unsigned mouse_button_timer = 0; /* non-zero when timer is active */
103 static W32Msg saved_mouse_move_msg;
104 static unsigned mouse_move_timer = 0;
105
106 /* Window that is tracking the mouse. */
107 static HWND track_mouse_window;
108
109 /* Multi-monitor API definitions that are not pulled from the headers
110 since we are compiling for NT 4. */
111 #ifndef MONITOR_DEFAULT_TO_NEAREST
112 #define MONITOR_DEFAULT_TO_NEAREST 2
113 #endif
114 #ifndef MONITORINFOF_PRIMARY
115 #define MONITORINFOF_PRIMARY 1
116 #endif
117 #ifndef SM_XVIRTUALSCREEN
118 #define SM_XVIRTUALSCREEN 76
119 #endif
120 #ifndef SM_YVIRTUALSCREEN
121 #define SM_YVIRTUALSCREEN 77
122 #endif
123 /* MinGW headers define MONITORINFO unconditionally, but MSVC ones don't.
124 To avoid a compile error on one or the other, redefine with a new name. */
125 struct MONITOR_INFO
126 {
127 DWORD cbSize;
128 RECT rcMonitor;
129 RECT rcWork;
130 DWORD dwFlags;
131 };
132
133 #if _WIN32_WINDOWS >= 0x0410
134 #define C_CHILDREN_TITLEBAR CCHILDREN_TITLEBAR
135 typedef TITLEBARINFO TITLEBAR_INFO;
136 #else
137 #define C_CHILDREN_TITLEBAR 5
138 typedef struct
139 {
140 DWORD cbSize;
141 RECT rcTitleBar;
142 DWORD rgstate[C_CHILDREN_TITLEBAR+1];
143 } TITLEBAR_INFO, *PTITLEBAR_INFO;
144 #endif
145
146 #ifndef CCHDEVICENAME
147 #define CCHDEVICENAME 32
148 #endif
149 struct MONITOR_INFO_EX
150 {
151 DWORD cbSize;
152 RECT rcMonitor;
153 RECT rcWork;
154 DWORD dwFlags;
155 char szDevice[CCHDEVICENAME];
156 };
157
158 /* Reportedly, MSVC does not have this in its headers. */
159 #if defined (_MSC_VER) && _WIN32_WINNT < 0x0500
160 DECLARE_HANDLE(HMONITOR);
161 #endif
162
163 typedef BOOL (WINAPI * TrackMouseEvent_Proc)
164 (IN OUT LPTRACKMOUSEEVENT lpEventTrack);
165 typedef LONG (WINAPI * ImmGetCompositionString_Proc)
166 (IN HIMC context, IN DWORD index, OUT LPVOID buffer, IN DWORD bufLen);
167 typedef HIMC (WINAPI * ImmGetContext_Proc) (IN HWND window);
168 typedef BOOL (WINAPI * ImmReleaseContext_Proc) (IN HWND wnd, IN HIMC context);
169 typedef BOOL (WINAPI * ImmSetCompositionWindow_Proc) (IN HIMC context,
170 IN COMPOSITIONFORM *form);
171 typedef HMONITOR (WINAPI * MonitorFromPoint_Proc) (IN POINT pt, IN DWORD flags);
172 typedef BOOL (WINAPI * GetMonitorInfo_Proc)
173 (IN HMONITOR monitor, OUT struct MONITOR_INFO* info);
174 typedef HMONITOR (WINAPI * MonitorFromWindow_Proc)
175 (IN HWND hwnd, IN DWORD dwFlags);
176 typedef BOOL CALLBACK (* MonitorEnum_Proc)
177 (IN HMONITOR monitor, IN HDC hdc, IN RECT *rcMonitor, IN LPARAM dwData);
178 typedef BOOL (WINAPI * EnumDisplayMonitors_Proc)
179 (IN HDC hdc, IN RECT *rcClip, IN MonitorEnum_Proc fnEnum, IN LPARAM dwData);
180 typedef BOOL (WINAPI * GetTitleBarInfo_Proc)
181 (IN HWND hwnd, OUT TITLEBAR_INFO* info);
182
183 TrackMouseEvent_Proc track_mouse_event_fn = NULL;
184 ImmGetCompositionString_Proc get_composition_string_fn = NULL;
185 ImmGetContext_Proc get_ime_context_fn = NULL;
186 ImmReleaseContext_Proc release_ime_context_fn = NULL;
187 ImmSetCompositionWindow_Proc set_ime_composition_window_fn = NULL;
188 MonitorFromPoint_Proc monitor_from_point_fn = NULL;
189 GetMonitorInfo_Proc get_monitor_info_fn = NULL;
190 MonitorFromWindow_Proc monitor_from_window_fn = NULL;
191 EnumDisplayMonitors_Proc enum_display_monitors_fn = NULL;
192 GetTitleBarInfo_Proc get_title_bar_info_fn = NULL;
193
194 #ifdef NTGUI_UNICODE
195 #define unicode_append_menu AppendMenuW
196 #else /* !NTGUI_UNICODE */
197 extern AppendMenuW_Proc unicode_append_menu;
198 #endif /* NTGUI_UNICODE */
199
200 /* Flag to selectively ignore WM_IME_CHAR messages. */
201 static int ignore_ime_char = 0;
202
203 /* W95 mousewheel handler */
204 unsigned int msh_mousewheel = 0;
205
206 /* Timers */
207 #define MOUSE_BUTTON_ID 1
208 #define MOUSE_MOVE_ID 2
209 #define MENU_FREE_ID 3
210 /* The delay (milliseconds) before a menu is freed after WM_EXITMENULOOP
211 is received. */
212 #define MENU_FREE_DELAY 1000
213 static unsigned menu_free_timer = 0;
214
215 #ifdef GLYPH_DEBUG
216 static ptrdiff_t image_cache_refcount;
217 static int dpyinfo_refcount;
218 #endif
219
220 static HWND w32_visible_system_caret_hwnd;
221
222 static int w32_unicode_gui;
223
224 /* From w32menu.c */
225 extern HMENU current_popup_menu;
226 int menubar_in_use = 0;
227
228 /* From w32uniscribe.c */
229 extern void syms_of_w32uniscribe (void);
230 extern int uniscribe_available;
231
232 #ifdef WINDOWSNT
233 /* From w32inevt.c */
234 extern int faked_key;
235 #endif /* WINDOWSNT */
236
237 /* This gives us the page size and the size of the allocation unit on NT. */
238 SYSTEM_INFO sysinfo_cache;
239
240 /* This gives us version, build, and platform identification. */
241 OSVERSIONINFO osinfo_cache;
242
243 DWORD_PTR syspage_mask = 0;
244
245 /* The major and minor versions of NT. */
246 int w32_major_version;
247 int w32_minor_version;
248 int w32_build_number;
249
250 /* Distinguish between Windows NT and Windows 95. */
251 int os_subtype;
252
253 #ifdef HAVE_NTGUI
254 HINSTANCE hinst = NULL;
255 #endif
256
257 static unsigned int sound_type = 0xFFFFFFFF;
258 #define MB_EMACS_SILENT (0xFFFFFFFF - 1)
259
260 /* Special virtual key code for indicating "any" key. */
261 #define VK_ANY 0xFF
262
263 #ifndef WM_WTSSESSION_CHANGE
264 /* 32-bit MinGW does not define these constants. */
265 # define WM_WTSSESSION_CHANGE 0x02B1
266 # define WTS_SESSION_LOCK 0x7
267 #endif
268
269 /* Keyboard hook state data. */
270 static struct
271 {
272 int hook_count; /* counter, if several windows are created */
273 HHOOK hook; /* hook handle */
274 HWND console; /* console window handle */
275
276 int lwindown; /* Left Windows key currently pressed (and hooked) */
277 int rwindown; /* Right Windows key currently pressed (and hooked) */
278 int winsdown; /* Number of handled keys currently pressed */
279 int send_win_up; /* Pass through the keyup for this Windows key press? */
280 int suppress_lone; /* Suppress simulated Windows keydown-keyup for this press? */
281 int winseen; /* Windows keys seen during this press? */
282
283 char alt_hooked[256]; /* hook Alt+[this key]? */
284 char lwin_hooked[256]; /* hook left Win+[this key]? */
285 char rwin_hooked[256]; /* hook right Win+[this key]? */
286 } kbdhook;
287 typedef HWND (WINAPI *GetConsoleWindow_Proc) (void);
288
289 /* stdin, from w32console.c */
290 extern HANDLE keyboard_handle;
291
292 /* Let the user specify a display with a frame.
293 nil stands for the selected frame--or, if that is not a w32 frame,
294 the first display on the list. */
295
296 struct w32_display_info *
297 check_x_display_info (Lisp_Object object)
298 {
299 if (NILP (object))
300 {
301 struct frame *sf = XFRAME (selected_frame);
302
303 if (FRAME_W32_P (sf) && FRAME_LIVE_P (sf))
304 return FRAME_DISPLAY_INFO (sf);
305 else
306 return &one_w32_display_info;
307 }
308 else if (TERMINALP (object))
309 {
310 struct terminal *t = decode_live_terminal (object);
311
312 if (t->type != output_w32)
313 error ("Terminal %d is not a W32 display", t->id);
314
315 return t->display_info.w32;
316 }
317 else if (STRINGP (object))
318 return x_display_info_for_name (object);
319 else
320 {
321 struct frame *f;
322
323 CHECK_LIVE_FRAME (object);
324 f = XFRAME (object);
325 if (! FRAME_W32_P (f))
326 error ("Non-W32 frame used");
327 return FRAME_DISPLAY_INFO (f);
328 }
329 }
330 \f
331 /* Return the Emacs frame-object corresponding to an w32 window.
332 It could be the frame's main window or an icon window. */
333
334 struct frame *
335 x_window_to_frame (struct w32_display_info *dpyinfo, HWND wdesc)
336 {
337 Lisp_Object tail, frame;
338 struct frame *f;
339
340 FOR_EACH_FRAME (tail, frame)
341 {
342 f = XFRAME (frame);
343 if (!FRAME_W32_P (f) || FRAME_DISPLAY_INFO (f) != dpyinfo)
344 continue;
345
346 if (FRAME_W32_WINDOW (f) == wdesc)
347 return f;
348 }
349 return 0;
350 }
351
352 \f
353 static Lisp_Object unwind_create_frame (Lisp_Object);
354 static void unwind_create_tip_frame (Lisp_Object);
355 static void my_create_window (struct frame *);
356 static void my_create_tip_window (struct frame *);
357
358 /* TODO: Native Input Method support; see x_create_im. */
359 void x_set_foreground_color (struct frame *, Lisp_Object, Lisp_Object);
360 void x_set_background_color (struct frame *, Lisp_Object, Lisp_Object);
361 void x_set_mouse_color (struct frame *, Lisp_Object, Lisp_Object);
362 void x_set_cursor_color (struct frame *, Lisp_Object, Lisp_Object);
363 void x_set_border_color (struct frame *, Lisp_Object, Lisp_Object);
364 void x_set_cursor_type (struct frame *, Lisp_Object, Lisp_Object);
365 void x_set_icon_type (struct frame *, Lisp_Object, Lisp_Object);
366 void x_set_icon_name (struct frame *, Lisp_Object, Lisp_Object);
367 void x_explicitly_set_name (struct frame *, Lisp_Object, Lisp_Object);
368 void x_set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
369 void x_set_title (struct frame *, Lisp_Object, Lisp_Object);
370 void x_set_tool_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
371 void x_set_internal_border_width (struct frame *f, Lisp_Object, Lisp_Object);
372 \f
373
374 /* Store the screen positions of frame F into XPTR and YPTR.
375 These are the positions of the containing window manager window,
376 not Emacs's own window. */
377
378 void
379 x_real_positions (struct frame *f, int *xptr, int *yptr)
380 {
381 POINT pt;
382 RECT rect;
383
384 /* Get the bounds of the WM window. */
385 GetWindowRect (FRAME_W32_WINDOW (f), &rect);
386
387 pt.x = 0;
388 pt.y = 0;
389
390 /* Convert (0, 0) in the client area to screen co-ordinates. */
391 ClientToScreen (FRAME_W32_WINDOW (f), &pt);
392
393 *xptr = rect.left;
394 *yptr = rect.top;
395 }
396
397 /* Returns the window rectangle appropriate for the given fullscreen mode.
398 The normal rect parameter was the window's rectangle prior to entering
399 fullscreen mode. If multiple monitor support is available, the nearest
400 monitor to the window is chosen. */
401
402 void
403 w32_fullscreen_rect (HWND hwnd, int fsmode, RECT normal, RECT *rect)
404 {
405 struct MONITOR_INFO mi = { sizeof(mi) };
406 if (monitor_from_window_fn && get_monitor_info_fn)
407 {
408 HMONITOR monitor =
409 monitor_from_window_fn (hwnd, MONITOR_DEFAULT_TO_NEAREST);
410 get_monitor_info_fn (monitor, &mi);
411 }
412 else
413 {
414 mi.rcMonitor.left = 0;
415 mi.rcMonitor.top = 0;
416 mi.rcMonitor.right = GetSystemMetrics (SM_CXSCREEN);
417 mi.rcMonitor.bottom = GetSystemMetrics (SM_CYSCREEN);
418 mi.rcWork.left = 0;
419 mi.rcWork.top = 0;
420 mi.rcWork.right = GetSystemMetrics (SM_CXMAXIMIZED);
421 mi.rcWork.bottom = GetSystemMetrics (SM_CYMAXIMIZED);
422 }
423
424 switch (fsmode)
425 {
426 case FULLSCREEN_BOTH:
427 rect->left = mi.rcMonitor.left;
428 rect->top = mi.rcMonitor.top;
429 rect->right = mi.rcMonitor.right;
430 rect->bottom = mi.rcMonitor.bottom;
431 break;
432 case FULLSCREEN_WIDTH:
433 rect->left = mi.rcWork.left;
434 rect->top = normal.top;
435 rect->right = mi.rcWork.right;
436 rect->bottom = normal.bottom;
437 break;
438 case FULLSCREEN_HEIGHT:
439 rect->left = normal.left;
440 rect->top = mi.rcWork.top;
441 rect->right = normal.right;
442 rect->bottom = mi.rcWork.bottom;
443 break;
444 default:
445 *rect = normal;
446 break;
447 }
448 }
449
450 \f
451
452 DEFUN ("w32-define-rgb-color", Fw32_define_rgb_color,
453 Sw32_define_rgb_color, 4, 4, 0,
454 doc: /* Convert RGB numbers to a Windows color reference and associate with NAME.
455 This adds or updates a named color to `w32-color-map', making it
456 available for use. The original entry's RGB ref is returned, or nil
457 if the entry is new. */)
458 (Lisp_Object red, Lisp_Object green, Lisp_Object blue, Lisp_Object name)
459 {
460 Lisp_Object rgb;
461 Lisp_Object oldrgb = Qnil;
462 Lisp_Object entry;
463
464 CHECK_NUMBER (red);
465 CHECK_NUMBER (green);
466 CHECK_NUMBER (blue);
467 CHECK_STRING (name);
468
469 XSETINT (rgb, RGB (XUINT (red), XUINT (green), XUINT (blue)));
470
471 block_input ();
472
473 /* replace existing entry in w32-color-map or add new entry. */
474 entry = Fassoc (name, Vw32_color_map);
475 if (NILP (entry))
476 {
477 entry = Fcons (name, rgb);
478 Vw32_color_map = Fcons (entry, Vw32_color_map);
479 }
480 else
481 {
482 oldrgb = Fcdr (entry);
483 Fsetcdr (entry, rgb);
484 }
485
486 unblock_input ();
487
488 return (oldrgb);
489 }
490
491 /* The default colors for the w32 color map */
492 typedef struct colormap_t
493 {
494 char *name;
495 COLORREF colorref;
496 } colormap_t;
497
498 colormap_t w32_color_map[] =
499 {
500 {"snow" , PALETTERGB (255,250,250)},
501 {"ghost white" , PALETTERGB (248,248,255)},
502 {"GhostWhite" , PALETTERGB (248,248,255)},
503 {"white smoke" , PALETTERGB (245,245,245)},
504 {"WhiteSmoke" , PALETTERGB (245,245,245)},
505 {"gainsboro" , PALETTERGB (220,220,220)},
506 {"floral white" , PALETTERGB (255,250,240)},
507 {"FloralWhite" , PALETTERGB (255,250,240)},
508 {"old lace" , PALETTERGB (253,245,230)},
509 {"OldLace" , PALETTERGB (253,245,230)},
510 {"linen" , PALETTERGB (250,240,230)},
511 {"antique white" , PALETTERGB (250,235,215)},
512 {"AntiqueWhite" , PALETTERGB (250,235,215)},
513 {"papaya whip" , PALETTERGB (255,239,213)},
514 {"PapayaWhip" , PALETTERGB (255,239,213)},
515 {"blanched almond" , PALETTERGB (255,235,205)},
516 {"BlanchedAlmond" , PALETTERGB (255,235,205)},
517 {"bisque" , PALETTERGB (255,228,196)},
518 {"peach puff" , PALETTERGB (255,218,185)},
519 {"PeachPuff" , PALETTERGB (255,218,185)},
520 {"navajo white" , PALETTERGB (255,222,173)},
521 {"NavajoWhite" , PALETTERGB (255,222,173)},
522 {"moccasin" , PALETTERGB (255,228,181)},
523 {"cornsilk" , PALETTERGB (255,248,220)},
524 {"ivory" , PALETTERGB (255,255,240)},
525 {"lemon chiffon" , PALETTERGB (255,250,205)},
526 {"LemonChiffon" , PALETTERGB (255,250,205)},
527 {"seashell" , PALETTERGB (255,245,238)},
528 {"honeydew" , PALETTERGB (240,255,240)},
529 {"mint cream" , PALETTERGB (245,255,250)},
530 {"MintCream" , PALETTERGB (245,255,250)},
531 {"azure" , PALETTERGB (240,255,255)},
532 {"alice blue" , PALETTERGB (240,248,255)},
533 {"AliceBlue" , PALETTERGB (240,248,255)},
534 {"lavender" , PALETTERGB (230,230,250)},
535 {"lavender blush" , PALETTERGB (255,240,245)},
536 {"LavenderBlush" , PALETTERGB (255,240,245)},
537 {"misty rose" , PALETTERGB (255,228,225)},
538 {"MistyRose" , PALETTERGB (255,228,225)},
539 {"white" , PALETTERGB (255,255,255)},
540 {"black" , PALETTERGB ( 0, 0, 0)},
541 {"dark slate gray" , PALETTERGB ( 47, 79, 79)},
542 {"DarkSlateGray" , PALETTERGB ( 47, 79, 79)},
543 {"dark slate grey" , PALETTERGB ( 47, 79, 79)},
544 {"DarkSlateGrey" , PALETTERGB ( 47, 79, 79)},
545 {"dim gray" , PALETTERGB (105,105,105)},
546 {"DimGray" , PALETTERGB (105,105,105)},
547 {"dim grey" , PALETTERGB (105,105,105)},
548 {"DimGrey" , PALETTERGB (105,105,105)},
549 {"slate gray" , PALETTERGB (112,128,144)},
550 {"SlateGray" , PALETTERGB (112,128,144)},
551 {"slate grey" , PALETTERGB (112,128,144)},
552 {"SlateGrey" , PALETTERGB (112,128,144)},
553 {"light slate gray" , PALETTERGB (119,136,153)},
554 {"LightSlateGray" , PALETTERGB (119,136,153)},
555 {"light slate grey" , PALETTERGB (119,136,153)},
556 {"LightSlateGrey" , PALETTERGB (119,136,153)},
557 {"gray" , PALETTERGB (190,190,190)},
558 {"grey" , PALETTERGB (190,190,190)},
559 {"light grey" , PALETTERGB (211,211,211)},
560 {"LightGrey" , PALETTERGB (211,211,211)},
561 {"light gray" , PALETTERGB (211,211,211)},
562 {"LightGray" , PALETTERGB (211,211,211)},
563 {"midnight blue" , PALETTERGB ( 25, 25,112)},
564 {"MidnightBlue" , PALETTERGB ( 25, 25,112)},
565 {"navy" , PALETTERGB ( 0, 0,128)},
566 {"navy blue" , PALETTERGB ( 0, 0,128)},
567 {"NavyBlue" , PALETTERGB ( 0, 0,128)},
568 {"cornflower blue" , PALETTERGB (100,149,237)},
569 {"CornflowerBlue" , PALETTERGB (100,149,237)},
570 {"dark slate blue" , PALETTERGB ( 72, 61,139)},
571 {"DarkSlateBlue" , PALETTERGB ( 72, 61,139)},
572 {"slate blue" , PALETTERGB (106, 90,205)},
573 {"SlateBlue" , PALETTERGB (106, 90,205)},
574 {"medium slate blue" , PALETTERGB (123,104,238)},
575 {"MediumSlateBlue" , PALETTERGB (123,104,238)},
576 {"light slate blue" , PALETTERGB (132,112,255)},
577 {"LightSlateBlue" , PALETTERGB (132,112,255)},
578 {"medium blue" , PALETTERGB ( 0, 0,205)},
579 {"MediumBlue" , PALETTERGB ( 0, 0,205)},
580 {"royal blue" , PALETTERGB ( 65,105,225)},
581 {"RoyalBlue" , PALETTERGB ( 65,105,225)},
582 {"blue" , PALETTERGB ( 0, 0,255)},
583 {"dodger blue" , PALETTERGB ( 30,144,255)},
584 {"DodgerBlue" , PALETTERGB ( 30,144,255)},
585 {"deep sky blue" , PALETTERGB ( 0,191,255)},
586 {"DeepSkyBlue" , PALETTERGB ( 0,191,255)},
587 {"sky blue" , PALETTERGB (135,206,235)},
588 {"SkyBlue" , PALETTERGB (135,206,235)},
589 {"light sky blue" , PALETTERGB (135,206,250)},
590 {"LightSkyBlue" , PALETTERGB (135,206,250)},
591 {"steel blue" , PALETTERGB ( 70,130,180)},
592 {"SteelBlue" , PALETTERGB ( 70,130,180)},
593 {"light steel blue" , PALETTERGB (176,196,222)},
594 {"LightSteelBlue" , PALETTERGB (176,196,222)},
595 {"light blue" , PALETTERGB (173,216,230)},
596 {"LightBlue" , PALETTERGB (173,216,230)},
597 {"powder blue" , PALETTERGB (176,224,230)},
598 {"PowderBlue" , PALETTERGB (176,224,230)},
599 {"pale turquoise" , PALETTERGB (175,238,238)},
600 {"PaleTurquoise" , PALETTERGB (175,238,238)},
601 {"dark turquoise" , PALETTERGB ( 0,206,209)},
602 {"DarkTurquoise" , PALETTERGB ( 0,206,209)},
603 {"medium turquoise" , PALETTERGB ( 72,209,204)},
604 {"MediumTurquoise" , PALETTERGB ( 72,209,204)},
605 {"turquoise" , PALETTERGB ( 64,224,208)},
606 {"cyan" , PALETTERGB ( 0,255,255)},
607 {"light cyan" , PALETTERGB (224,255,255)},
608 {"LightCyan" , PALETTERGB (224,255,255)},
609 {"cadet blue" , PALETTERGB ( 95,158,160)},
610 {"CadetBlue" , PALETTERGB ( 95,158,160)},
611 {"medium aquamarine" , PALETTERGB (102,205,170)},
612 {"MediumAquamarine" , PALETTERGB (102,205,170)},
613 {"aquamarine" , PALETTERGB (127,255,212)},
614 {"dark green" , PALETTERGB ( 0,100, 0)},
615 {"DarkGreen" , PALETTERGB ( 0,100, 0)},
616 {"dark olive green" , PALETTERGB ( 85,107, 47)},
617 {"DarkOliveGreen" , PALETTERGB ( 85,107, 47)},
618 {"dark sea green" , PALETTERGB (143,188,143)},
619 {"DarkSeaGreen" , PALETTERGB (143,188,143)},
620 {"sea green" , PALETTERGB ( 46,139, 87)},
621 {"SeaGreen" , PALETTERGB ( 46,139, 87)},
622 {"medium sea green" , PALETTERGB ( 60,179,113)},
623 {"MediumSeaGreen" , PALETTERGB ( 60,179,113)},
624 {"light sea green" , PALETTERGB ( 32,178,170)},
625 {"LightSeaGreen" , PALETTERGB ( 32,178,170)},
626 {"pale green" , PALETTERGB (152,251,152)},
627 {"PaleGreen" , PALETTERGB (152,251,152)},
628 {"spring green" , PALETTERGB ( 0,255,127)},
629 {"SpringGreen" , PALETTERGB ( 0,255,127)},
630 {"lawn green" , PALETTERGB (124,252, 0)},
631 {"LawnGreen" , PALETTERGB (124,252, 0)},
632 {"green" , PALETTERGB ( 0,255, 0)},
633 {"chartreuse" , PALETTERGB (127,255, 0)},
634 {"medium spring green" , PALETTERGB ( 0,250,154)},
635 {"MediumSpringGreen" , PALETTERGB ( 0,250,154)},
636 {"green yellow" , PALETTERGB (173,255, 47)},
637 {"GreenYellow" , PALETTERGB (173,255, 47)},
638 {"lime green" , PALETTERGB ( 50,205, 50)},
639 {"LimeGreen" , PALETTERGB ( 50,205, 50)},
640 {"yellow green" , PALETTERGB (154,205, 50)},
641 {"YellowGreen" , PALETTERGB (154,205, 50)},
642 {"forest green" , PALETTERGB ( 34,139, 34)},
643 {"ForestGreen" , PALETTERGB ( 34,139, 34)},
644 {"olive drab" , PALETTERGB (107,142, 35)},
645 {"OliveDrab" , PALETTERGB (107,142, 35)},
646 {"dark khaki" , PALETTERGB (189,183,107)},
647 {"DarkKhaki" , PALETTERGB (189,183,107)},
648 {"khaki" , PALETTERGB (240,230,140)},
649 {"pale goldenrod" , PALETTERGB (238,232,170)},
650 {"PaleGoldenrod" , PALETTERGB (238,232,170)},
651 {"light goldenrod yellow" , PALETTERGB (250,250,210)},
652 {"LightGoldenrodYellow" , PALETTERGB (250,250,210)},
653 {"light yellow" , PALETTERGB (255,255,224)},
654 {"LightYellow" , PALETTERGB (255,255,224)},
655 {"yellow" , PALETTERGB (255,255, 0)},
656 {"gold" , PALETTERGB (255,215, 0)},
657 {"light goldenrod" , PALETTERGB (238,221,130)},
658 {"LightGoldenrod" , PALETTERGB (238,221,130)},
659 {"goldenrod" , PALETTERGB (218,165, 32)},
660 {"dark goldenrod" , PALETTERGB (184,134, 11)},
661 {"DarkGoldenrod" , PALETTERGB (184,134, 11)},
662 {"rosy brown" , PALETTERGB (188,143,143)},
663 {"RosyBrown" , PALETTERGB (188,143,143)},
664 {"indian red" , PALETTERGB (205, 92, 92)},
665 {"IndianRed" , PALETTERGB (205, 92, 92)},
666 {"saddle brown" , PALETTERGB (139, 69, 19)},
667 {"SaddleBrown" , PALETTERGB (139, 69, 19)},
668 {"sienna" , PALETTERGB (160, 82, 45)},
669 {"peru" , PALETTERGB (205,133, 63)},
670 {"burlywood" , PALETTERGB (222,184,135)},
671 {"beige" , PALETTERGB (245,245,220)},
672 {"wheat" , PALETTERGB (245,222,179)},
673 {"sandy brown" , PALETTERGB (244,164, 96)},
674 {"SandyBrown" , PALETTERGB (244,164, 96)},
675 {"tan" , PALETTERGB (210,180,140)},
676 {"chocolate" , PALETTERGB (210,105, 30)},
677 {"firebrick" , PALETTERGB (178,34, 34)},
678 {"brown" , PALETTERGB (165,42, 42)},
679 {"dark salmon" , PALETTERGB (233,150,122)},
680 {"DarkSalmon" , PALETTERGB (233,150,122)},
681 {"salmon" , PALETTERGB (250,128,114)},
682 {"light salmon" , PALETTERGB (255,160,122)},
683 {"LightSalmon" , PALETTERGB (255,160,122)},
684 {"orange" , PALETTERGB (255,165, 0)},
685 {"dark orange" , PALETTERGB (255,140, 0)},
686 {"DarkOrange" , PALETTERGB (255,140, 0)},
687 {"coral" , PALETTERGB (255,127, 80)},
688 {"light coral" , PALETTERGB (240,128,128)},
689 {"LightCoral" , PALETTERGB (240,128,128)},
690 {"tomato" , PALETTERGB (255, 99, 71)},
691 {"orange red" , PALETTERGB (255, 69, 0)},
692 {"OrangeRed" , PALETTERGB (255, 69, 0)},
693 {"red" , PALETTERGB (255, 0, 0)},
694 {"hot pink" , PALETTERGB (255,105,180)},
695 {"HotPink" , PALETTERGB (255,105,180)},
696 {"deep pink" , PALETTERGB (255, 20,147)},
697 {"DeepPink" , PALETTERGB (255, 20,147)},
698 {"pink" , PALETTERGB (255,192,203)},
699 {"light pink" , PALETTERGB (255,182,193)},
700 {"LightPink" , PALETTERGB (255,182,193)},
701 {"pale violet red" , PALETTERGB (219,112,147)},
702 {"PaleVioletRed" , PALETTERGB (219,112,147)},
703 {"maroon" , PALETTERGB (176, 48, 96)},
704 {"medium violet red" , PALETTERGB (199, 21,133)},
705 {"MediumVioletRed" , PALETTERGB (199, 21,133)},
706 {"violet red" , PALETTERGB (208, 32,144)},
707 {"VioletRed" , PALETTERGB (208, 32,144)},
708 {"magenta" , PALETTERGB (255, 0,255)},
709 {"violet" , PALETTERGB (238,130,238)},
710 {"plum" , PALETTERGB (221,160,221)},
711 {"orchid" , PALETTERGB (218,112,214)},
712 {"medium orchid" , PALETTERGB (186, 85,211)},
713 {"MediumOrchid" , PALETTERGB (186, 85,211)},
714 {"dark orchid" , PALETTERGB (153, 50,204)},
715 {"DarkOrchid" , PALETTERGB (153, 50,204)},
716 {"dark violet" , PALETTERGB (148, 0,211)},
717 {"DarkViolet" , PALETTERGB (148, 0,211)},
718 {"blue violet" , PALETTERGB (138, 43,226)},
719 {"BlueViolet" , PALETTERGB (138, 43,226)},
720 {"purple" , PALETTERGB (160, 32,240)},
721 {"medium purple" , PALETTERGB (147,112,219)},
722 {"MediumPurple" , PALETTERGB (147,112,219)},
723 {"thistle" , PALETTERGB (216,191,216)},
724 {"gray0" , PALETTERGB ( 0, 0, 0)},
725 {"grey0" , PALETTERGB ( 0, 0, 0)},
726 {"dark grey" , PALETTERGB (169,169,169)},
727 {"DarkGrey" , PALETTERGB (169,169,169)},
728 {"dark gray" , PALETTERGB (169,169,169)},
729 {"DarkGray" , PALETTERGB (169,169,169)},
730 {"dark blue" , PALETTERGB ( 0, 0,139)},
731 {"DarkBlue" , PALETTERGB ( 0, 0,139)},
732 {"dark cyan" , PALETTERGB ( 0,139,139)},
733 {"DarkCyan" , PALETTERGB ( 0,139,139)},
734 {"dark magenta" , PALETTERGB (139, 0,139)},
735 {"DarkMagenta" , PALETTERGB (139, 0,139)},
736 {"dark red" , PALETTERGB (139, 0, 0)},
737 {"DarkRed" , PALETTERGB (139, 0, 0)},
738 {"light green" , PALETTERGB (144,238,144)},
739 {"LightGreen" , PALETTERGB (144,238,144)},
740 };
741
742 static Lisp_Object
743 w32_default_color_map (void)
744 {
745 int i;
746 colormap_t *pc = w32_color_map;
747 Lisp_Object cmap;
748
749 block_input ();
750
751 cmap = Qnil;
752
753 for (i = 0; i < ARRAYELTS (w32_color_map); pc++, i++)
754 cmap = Fcons (Fcons (build_string (pc->name),
755 make_number (pc->colorref)),
756 cmap);
757
758 unblock_input ();
759
760 return (cmap);
761 }
762
763 DEFUN ("w32-default-color-map", Fw32_default_color_map, Sw32_default_color_map,
764 0, 0, 0, doc: /* Return the default color map. */)
765 (void)
766 {
767 return w32_default_color_map ();
768 }
769
770 static Lisp_Object
771 w32_color_map_lookup (const char *colorname)
772 {
773 Lisp_Object tail, ret = Qnil;
774
775 block_input ();
776
777 for (tail = Vw32_color_map; CONSP (tail); tail = XCDR (tail))
778 {
779 register Lisp_Object elt, tem;
780
781 elt = XCAR (tail);
782 if (!CONSP (elt)) continue;
783
784 tem = XCAR (elt);
785
786 if (lstrcmpi (SSDATA (tem), colorname) == 0)
787 {
788 ret = Fcdr (elt);
789 break;
790 }
791
792 QUIT;
793 }
794
795 unblock_input ();
796
797 return ret;
798 }
799
800
801 static void
802 add_system_logical_colors_to_map (Lisp_Object *system_colors)
803 {
804 HKEY colors_key;
805
806 /* Other registry operations are done with input blocked. */
807 block_input ();
808
809 /* Look for "Control Panel/Colors" under User and Machine registry
810 settings. */
811 if (RegOpenKeyEx (HKEY_CURRENT_USER, "Control Panel\\Colors", 0,
812 KEY_READ, &colors_key) == ERROR_SUCCESS
813 || RegOpenKeyEx (HKEY_LOCAL_MACHINE, "Control Panel\\Colors", 0,
814 KEY_READ, &colors_key) == ERROR_SUCCESS)
815 {
816 /* List all keys. */
817 char color_buffer[64];
818 char full_name_buffer[MAX_PATH + SYSTEM_COLOR_PREFIX_LEN];
819 int index = 0;
820 DWORD name_size, color_size;
821 char *name_buffer = full_name_buffer + SYSTEM_COLOR_PREFIX_LEN;
822
823 name_size = sizeof (full_name_buffer) - SYSTEM_COLOR_PREFIX_LEN;
824 color_size = sizeof (color_buffer);
825
826 strcpy (full_name_buffer, SYSTEM_COLOR_PREFIX);
827
828 while (RegEnumValueA (colors_key, index, name_buffer, &name_size,
829 NULL, NULL, (LPBYTE)color_buffer, &color_size)
830 == ERROR_SUCCESS)
831 {
832 int r, g, b;
833 if (sscanf (color_buffer, " %u %u %u", &r, &g, &b) == 3)
834 *system_colors = Fcons (Fcons (build_string (full_name_buffer),
835 make_number (RGB (r, g, b))),
836 *system_colors);
837
838 name_size = sizeof (full_name_buffer) - SYSTEM_COLOR_PREFIX_LEN;
839 color_size = sizeof (color_buffer);
840 index++;
841 }
842 RegCloseKey (colors_key);
843 }
844
845 unblock_input ();
846 }
847
848
849 static Lisp_Object
850 x_to_w32_color (const char * colorname)
851 {
852 register Lisp_Object ret = Qnil;
853
854 block_input ();
855
856 if (colorname[0] == '#')
857 {
858 /* Could be an old-style RGB Device specification. */
859 int size = strlen (colorname + 1);
860 char *color = alloca (size + 1);
861
862 strcpy (color, colorname + 1);
863 if (size == 3 || size == 6 || size == 9 || size == 12)
864 {
865 UINT colorval;
866 int i, pos;
867 pos = 0;
868 size /= 3;
869 colorval = 0;
870
871 for (i = 0; i < 3; i++)
872 {
873 char *end;
874 char t;
875 unsigned long value;
876
877 /* The check for 'x' in the following conditional takes into
878 account the fact that strtol allows a "0x" in front of
879 our numbers, and we don't. */
880 if (!isxdigit (color[0]) || color[1] == 'x')
881 break;
882 t = color[size];
883 color[size] = '\0';
884 value = strtoul (color, &end, 16);
885 color[size] = t;
886 if (errno == ERANGE || end - color != size)
887 break;
888 switch (size)
889 {
890 case 1:
891 value = value * 0x10;
892 break;
893 case 2:
894 break;
895 case 3:
896 value /= 0x10;
897 break;
898 case 4:
899 value /= 0x100;
900 break;
901 }
902 colorval |= (value << pos);
903 pos += 0x8;
904 if (i == 2)
905 {
906 unblock_input ();
907 XSETINT (ret, colorval);
908 return ret;
909 }
910 color = end;
911 }
912 }
913 }
914 else if (strnicmp (colorname, "rgb:", 4) == 0)
915 {
916 const char *color;
917 UINT colorval;
918 int i, pos;
919 pos = 0;
920
921 colorval = 0;
922 color = colorname + 4;
923 for (i = 0; i < 3; i++)
924 {
925 char *end;
926 unsigned long value;
927
928 /* The check for 'x' in the following conditional takes into
929 account the fact that strtol allows a "0x" in front of
930 our numbers, and we don't. */
931 if (!isxdigit (color[0]) || color[1] == 'x')
932 break;
933 value = strtoul (color, &end, 16);
934 if (errno == ERANGE)
935 break;
936 switch (end - color)
937 {
938 case 1:
939 value = value * 0x10 + value;
940 break;
941 case 2:
942 break;
943 case 3:
944 value /= 0x10;
945 break;
946 case 4:
947 value /= 0x100;
948 break;
949 default:
950 value = ULONG_MAX;
951 }
952 if (value == ULONG_MAX)
953 break;
954 colorval |= (value << pos);
955 pos += 0x8;
956 if (i == 2)
957 {
958 if (*end != '\0')
959 break;
960 unblock_input ();
961 XSETINT (ret, colorval);
962 return ret;
963 }
964 if (*end != '/')
965 break;
966 color = end + 1;
967 }
968 }
969 else if (strnicmp (colorname, "rgbi:", 5) == 0)
970 {
971 /* This is an RGB Intensity specification. */
972 const char *color;
973 UINT colorval;
974 int i, pos;
975 pos = 0;
976
977 colorval = 0;
978 color = colorname + 5;
979 for (i = 0; i < 3; i++)
980 {
981 char *end;
982 double value;
983 UINT val;
984
985 value = strtod (color, &end);
986 if (errno == ERANGE)
987 break;
988 if (value < 0.0 || value > 1.0)
989 break;
990 val = (UINT)(0x100 * value);
991 /* We used 0x100 instead of 0xFF to give a continuous
992 range between 0.0 and 1.0 inclusive. The next statement
993 fixes the 1.0 case. */
994 if (val == 0x100)
995 val = 0xFF;
996 colorval |= (val << pos);
997 pos += 0x8;
998 if (i == 2)
999 {
1000 if (*end != '\0')
1001 break;
1002 unblock_input ();
1003 XSETINT (ret, colorval);
1004 return ret;
1005 }
1006 if (*end != '/')
1007 break;
1008 color = end + 1;
1009 }
1010 }
1011 /* I am not going to attempt to handle any of the CIE color schemes
1012 or TekHVC, since I don't know the algorithms for conversion to
1013 RGB. */
1014
1015 /* If we fail to lookup the color name in w32_color_map, then check the
1016 colorname to see if it can be crudely approximated: If the X color
1017 ends in a number (e.g., "darkseagreen2"), strip the number and
1018 return the result of looking up the base color name. */
1019 ret = w32_color_map_lookup (colorname);
1020 if (NILP (ret))
1021 {
1022 int len = strlen (colorname);
1023
1024 if (isdigit (colorname[len - 1]))
1025 {
1026 char *ptr, *approx = alloca (len + 1);
1027
1028 strcpy (approx, colorname);
1029 ptr = &approx[len - 1];
1030 while (ptr > approx && isdigit (*ptr))
1031 *ptr-- = '\0';
1032
1033 ret = w32_color_map_lookup (approx);
1034 }
1035 }
1036
1037 unblock_input ();
1038 return ret;
1039 }
1040
1041 void
1042 w32_regenerate_palette (struct frame *f)
1043 {
1044 struct w32_palette_entry * list;
1045 LOGPALETTE * log_palette;
1046 HPALETTE new_palette;
1047 int i;
1048
1049 /* don't bother trying to create palette if not supported */
1050 if (! FRAME_DISPLAY_INFO (f)->has_palette)
1051 return;
1052
1053 log_palette = (LOGPALETTE *)
1054 alloca (sizeof (LOGPALETTE) +
1055 FRAME_DISPLAY_INFO (f)->num_colors * sizeof (PALETTEENTRY));
1056 log_palette->palVersion = 0x300;
1057 log_palette->palNumEntries = FRAME_DISPLAY_INFO (f)->num_colors;
1058
1059 list = FRAME_DISPLAY_INFO (f)->color_list;
1060 for (i = 0;
1061 i < FRAME_DISPLAY_INFO (f)->num_colors;
1062 i++, list = list->next)
1063 log_palette->palPalEntry[i] = list->entry;
1064
1065 new_palette = CreatePalette (log_palette);
1066
1067 enter_crit ();
1068
1069 if (FRAME_DISPLAY_INFO (f)->palette)
1070 DeleteObject (FRAME_DISPLAY_INFO (f)->palette);
1071 FRAME_DISPLAY_INFO (f)->palette = new_palette;
1072
1073 /* Realize display palette and garbage all frames. */
1074 release_frame_dc (f, get_frame_dc (f));
1075
1076 leave_crit ();
1077 }
1078
1079 #define W32_COLOR(pe) RGB (pe.peRed, pe.peGreen, pe.peBlue)
1080 #define SET_W32_COLOR(pe, color) \
1081 do \
1082 { \
1083 pe.peRed = GetRValue (color); \
1084 pe.peGreen = GetGValue (color); \
1085 pe.peBlue = GetBValue (color); \
1086 pe.peFlags = 0; \
1087 } while (0)
1088
1089 #if 0
1090 /* Keep these around in case we ever want to track color usage. */
1091 void
1092 w32_map_color (struct frame *f, COLORREF color)
1093 {
1094 struct w32_palette_entry * list = FRAME_DISPLAY_INFO (f)->color_list;
1095
1096 if (NILP (Vw32_enable_palette))
1097 return;
1098
1099 /* check if color is already mapped */
1100 while (list)
1101 {
1102 if (W32_COLOR (list->entry) == color)
1103 {
1104 ++list->refcount;
1105 return;
1106 }
1107 list = list->next;
1108 }
1109
1110 /* not already mapped, so add to list and recreate Windows palette */
1111 list = xmalloc (sizeof (struct w32_palette_entry));
1112 SET_W32_COLOR (list->entry, color);
1113 list->refcount = 1;
1114 list->next = FRAME_DISPLAY_INFO (f)->color_list;
1115 FRAME_DISPLAY_INFO (f)->color_list = list;
1116 FRAME_DISPLAY_INFO (f)->num_colors++;
1117
1118 /* set flag that palette must be regenerated */
1119 FRAME_DISPLAY_INFO (f)->regen_palette = TRUE;
1120 }
1121
1122 void
1123 w32_unmap_color (struct frame *f, COLORREF color)
1124 {
1125 struct w32_palette_entry * list = FRAME_DISPLAY_INFO (f)->color_list;
1126 struct w32_palette_entry **prev = &FRAME_DISPLAY_INFO (f)->color_list;
1127
1128 if (NILP (Vw32_enable_palette))
1129 return;
1130
1131 /* check if color is already mapped */
1132 while (list)
1133 {
1134 if (W32_COLOR (list->entry) == color)
1135 {
1136 if (--list->refcount == 0)
1137 {
1138 *prev = list->next;
1139 xfree (list);
1140 FRAME_DISPLAY_INFO (f)->num_colors--;
1141 break;
1142 }
1143 else
1144 return;
1145 }
1146 prev = &list->next;
1147 list = list->next;
1148 }
1149
1150 /* set flag that palette must be regenerated */
1151 FRAME_DISPLAY_INFO (f)->regen_palette = TRUE;
1152 }
1153 #endif
1154
1155
1156 /* Gamma-correct COLOR on frame F. */
1157
1158 void
1159 gamma_correct (struct frame *f, COLORREF *color)
1160 {
1161 if (f->gamma)
1162 {
1163 *color = PALETTERGB (
1164 pow (GetRValue (*color) / 255.0, f->gamma) * 255.0 + 0.5,
1165 pow (GetGValue (*color) / 255.0, f->gamma) * 255.0 + 0.5,
1166 pow (GetBValue (*color) / 255.0, f->gamma) * 255.0 + 0.5);
1167 }
1168 }
1169
1170
1171 /* Decide if color named COLOR is valid for the display associated with
1172 the selected frame; if so, return the rgb values in COLOR_DEF.
1173 If ALLOC is nonzero, allocate a new colormap cell. */
1174
1175 int
1176 w32_defined_color (struct frame *f, const char *color, XColor *color_def,
1177 bool alloc_p)
1178 {
1179 register Lisp_Object tem;
1180 COLORREF w32_color_ref;
1181
1182 tem = x_to_w32_color (color);
1183
1184 if (!NILP (tem))
1185 {
1186 if (f)
1187 {
1188 /* Apply gamma correction. */
1189 w32_color_ref = XUINT (tem);
1190 gamma_correct (f, &w32_color_ref);
1191 XSETINT (tem, w32_color_ref);
1192 }
1193
1194 /* Map this color to the palette if it is enabled. */
1195 if (!NILP (Vw32_enable_palette))
1196 {
1197 struct w32_palette_entry * entry =
1198 one_w32_display_info.color_list;
1199 struct w32_palette_entry ** prev =
1200 &one_w32_display_info.color_list;
1201
1202 /* check if color is already mapped */
1203 while (entry)
1204 {
1205 if (W32_COLOR (entry->entry) == XUINT (tem))
1206 break;
1207 prev = &entry->next;
1208 entry = entry->next;
1209 }
1210
1211 if (entry == NULL && alloc_p)
1212 {
1213 /* not already mapped, so add to list */
1214 entry = xmalloc (sizeof (struct w32_palette_entry));
1215 SET_W32_COLOR (entry->entry, XUINT (tem));
1216 entry->next = NULL;
1217 *prev = entry;
1218 one_w32_display_info.num_colors++;
1219
1220 /* set flag that palette must be regenerated */
1221 one_w32_display_info.regen_palette = TRUE;
1222 }
1223 }
1224 /* Ensure COLORREF value is snapped to nearest color in (default)
1225 palette by simulating the PALETTERGB macro. This works whether
1226 or not the display device has a palette. */
1227 w32_color_ref = XUINT (tem) | 0x2000000;
1228
1229 color_def->pixel = w32_color_ref;
1230 color_def->red = GetRValue (w32_color_ref) * 256;
1231 color_def->green = GetGValue (w32_color_ref) * 256;
1232 color_def->blue = GetBValue (w32_color_ref) * 256;
1233
1234 return 1;
1235 }
1236 else
1237 {
1238 return 0;
1239 }
1240 }
1241
1242 /* Given a string ARG naming a color, compute a pixel value from it
1243 suitable for screen F.
1244 If F is not a color screen, return DEF (default) regardless of what
1245 ARG says. */
1246
1247 int
1248 x_decode_color (struct frame *f, Lisp_Object arg, int def)
1249 {
1250 XColor cdef;
1251
1252 CHECK_STRING (arg);
1253
1254 if (strcmp (SSDATA (arg), "black") == 0)
1255 return BLACK_PIX_DEFAULT (f);
1256 else if (strcmp (SSDATA (arg), "white") == 0)
1257 return WHITE_PIX_DEFAULT (f);
1258
1259 if ((FRAME_DISPLAY_INFO (f)->n_planes * FRAME_DISPLAY_INFO (f)->n_cbits) == 1)
1260 return def;
1261
1262 /* w32_defined_color is responsible for coping with failures
1263 by looking for a near-miss. */
1264 if (w32_defined_color (f, SSDATA (arg), &cdef, true))
1265 return cdef.pixel;
1266
1267 /* defined_color failed; return an ultimate default. */
1268 return def;
1269 }
1270 \f
1271
1272
1273 /* Functions called only from `x_set_frame_param'
1274 to set individual parameters.
1275
1276 If FRAME_W32_WINDOW (f) is 0,
1277 the frame is being created and its window does not exist yet.
1278 In that case, just record the parameter's new value
1279 in the standard place; do not attempt to change the window. */
1280
1281 void
1282 x_set_foreground_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1283 {
1284 struct w32_output *x = f->output_data.w32;
1285 PIX_TYPE fg, old_fg;
1286
1287 fg = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1288 old_fg = FRAME_FOREGROUND_PIXEL (f);
1289 FRAME_FOREGROUND_PIXEL (f) = fg;
1290
1291 if (FRAME_W32_WINDOW (f) != 0)
1292 {
1293 if (x->cursor_pixel == old_fg)
1294 {
1295 x->cursor_pixel = fg;
1296 x->cursor_gc->background = fg;
1297 }
1298
1299 update_face_from_frame_parameter (f, Qforeground_color, arg);
1300 if (FRAME_VISIBLE_P (f))
1301 redraw_frame (f);
1302 }
1303 }
1304
1305 void
1306 x_set_background_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1307 {
1308 FRAME_BACKGROUND_PIXEL (f)
1309 = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
1310
1311 if (FRAME_W32_WINDOW (f) != 0)
1312 {
1313 SetWindowLong (FRAME_W32_WINDOW (f), WND_BACKGROUND_INDEX,
1314 FRAME_BACKGROUND_PIXEL (f));
1315
1316 update_face_from_frame_parameter (f, Qbackground_color, arg);
1317
1318 if (FRAME_VISIBLE_P (f))
1319 redraw_frame (f);
1320 }
1321 }
1322
1323 void
1324 x_set_mouse_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1325 {
1326 #if 0
1327 Cursor cursor, nontext_cursor, mode_cursor, hand_cursor;
1328 int count;
1329 #endif
1330 int mask_color;
1331
1332 if (!EQ (Qnil, arg))
1333 f->output_data.w32->mouse_pixel
1334 = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1335 mask_color = FRAME_BACKGROUND_PIXEL (f);
1336
1337 /* Don't let pointers be invisible. */
1338 if (mask_color == f->output_data.w32->mouse_pixel
1339 && mask_color == FRAME_BACKGROUND_PIXEL (f))
1340 f->output_data.w32->mouse_pixel = FRAME_FOREGROUND_PIXEL (f);
1341
1342 #if 0 /* TODO : Mouse cursor customization. */
1343 block_input ();
1344
1345 /* It's not okay to crash if the user selects a screwy cursor. */
1346 count = x_catch_errors (FRAME_W32_DISPLAY (f));
1347
1348 if (!EQ (Qnil, Vx_pointer_shape))
1349 {
1350 CHECK_NUMBER (Vx_pointer_shape);
1351 cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XINT (Vx_pointer_shape));
1352 }
1353 else
1354 cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_xterm);
1355 x_check_errors (FRAME_W32_DISPLAY (f), "bad text pointer cursor: %s");
1356
1357 if (!EQ (Qnil, Vx_nontext_pointer_shape))
1358 {
1359 CHECK_NUMBER (Vx_nontext_pointer_shape);
1360 nontext_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f),
1361 XINT (Vx_nontext_pointer_shape));
1362 }
1363 else
1364 nontext_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_left_ptr);
1365 x_check_errors (FRAME_W32_DISPLAY (f), "bad nontext pointer cursor: %s");
1366
1367 if (!EQ (Qnil, Vx_hourglass_pointer_shape))
1368 {
1369 CHECK_NUMBER (Vx_hourglass_pointer_shape);
1370 hourglass_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f),
1371 XINT (Vx_hourglass_pointer_shape));
1372 }
1373 else
1374 hourglass_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_watch);
1375 x_check_errors (FRAME_W32_DISPLAY (f), "bad busy pointer cursor: %s");
1376
1377 x_check_errors (FRAME_W32_DISPLAY (f), "bad nontext pointer cursor: %s");
1378 if (!EQ (Qnil, Vx_mode_pointer_shape))
1379 {
1380 CHECK_NUMBER (Vx_mode_pointer_shape);
1381 mode_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f),
1382 XINT (Vx_mode_pointer_shape));
1383 }
1384 else
1385 mode_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_xterm);
1386 x_check_errors (FRAME_W32_DISPLAY (f), "bad modeline pointer cursor: %s");
1387
1388 if (!EQ (Qnil, Vx_sensitive_text_pointer_shape))
1389 {
1390 CHECK_NUMBER (Vx_sensitive_text_pointer_shape);
1391 hand_cursor
1392 = XCreateFontCursor (FRAME_W32_DISPLAY (f),
1393 XINT (Vx_sensitive_text_pointer_shape));
1394 }
1395 else
1396 hand_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_crosshair);
1397
1398 if (!NILP (Vx_window_horizontal_drag_shape))
1399 {
1400 CHECK_NUMBER (Vx_window_horizontal_drag_shape);
1401 horizontal_drag_cursor
1402 = XCreateFontCursor (FRAME_W32_DISPLAY (f),
1403 XINT (Vx_window_horizontal_drag_shape));
1404 }
1405 else
1406 horizontal_drag_cursor
1407 = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_sb_h_double_arrow);
1408
1409 if (!NILP (Vx_window_vertical_drag_shape))
1410 {
1411 CHECK_NUMBER (Vx_window_vertical_drag_shape);
1412 vertical_drag_cursor
1413 = XCreateFontCursor (FRAME_W32_DISPLAY (f),
1414 XINT (Vx_window_vertical_drag_shape));
1415 }
1416 else
1417 vertical_drag_cursor
1418 = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_sb_v_double_arrow);
1419
1420 /* Check and report errors with the above calls. */
1421 x_check_errors (FRAME_W32_DISPLAY (f), "can't set cursor shape: %s");
1422 x_uncatch_errors (FRAME_W32_DISPLAY (f), count);
1423
1424 {
1425 XColor fore_color, back_color;
1426
1427 fore_color.pixel = f->output_data.w32->mouse_pixel;
1428 back_color.pixel = mask_color;
1429 XQueryColor (FRAME_W32_DISPLAY (f),
1430 DefaultColormap (FRAME_W32_DISPLAY (f),
1431 DefaultScreen (FRAME_W32_DISPLAY (f))),
1432 &fore_color);
1433 XQueryColor (FRAME_W32_DISPLAY (f),
1434 DefaultColormap (FRAME_W32_DISPLAY (f),
1435 DefaultScreen (FRAME_W32_DISPLAY (f))),
1436 &back_color);
1437 XRecolorCursor (FRAME_W32_DISPLAY (f), cursor,
1438 &fore_color, &back_color);
1439 XRecolorCursor (FRAME_W32_DISPLAY (f), nontext_cursor,
1440 &fore_color, &back_color);
1441 XRecolorCursor (FRAME_W32_DISPLAY (f), mode_cursor,
1442 &fore_color, &back_color);
1443 XRecolorCursor (FRAME_W32_DISPLAY (f), hand_cursor,
1444 &fore_color, &back_color);
1445 XRecolorCursor (FRAME_W32_DISPLAY (f), hourglass_cursor,
1446 &fore_color, &back_color);
1447 }
1448
1449 if (FRAME_W32_WINDOW (f) != 0)
1450 XDefineCursor (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f), cursor);
1451
1452 if (cursor != f->output_data.w32->text_cursor && f->output_data.w32->text_cursor != 0)
1453 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->text_cursor);
1454 f->output_data.w32->text_cursor = cursor;
1455
1456 if (nontext_cursor != f->output_data.w32->nontext_cursor
1457 && f->output_data.w32->nontext_cursor != 0)
1458 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->nontext_cursor);
1459 f->output_data.w32->nontext_cursor = nontext_cursor;
1460
1461 if (hourglass_cursor != f->output_data.w32->hourglass_cursor
1462 && f->output_data.w32->hourglass_cursor != 0)
1463 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->hourglass_cursor);
1464 f->output_data.w32->hourglass_cursor = hourglass_cursor;
1465
1466 if (mode_cursor != f->output_data.w32->modeline_cursor
1467 && f->output_data.w32->modeline_cursor != 0)
1468 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->modeline_cursor);
1469 f->output_data.w32->modeline_cursor = mode_cursor;
1470
1471 if (hand_cursor != f->output_data.w32->hand_cursor
1472 && f->output_data.w32->hand_cursor != 0)
1473 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->hand_cursor);
1474 f->output_data.w32->hand_cursor = hand_cursor;
1475
1476 XFlush (FRAME_W32_DISPLAY (f));
1477 unblock_input ();
1478
1479 update_face_from_frame_parameter (f, Qmouse_color, arg);
1480 #endif /* TODO */
1481 }
1482
1483 void
1484 x_set_cursor_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1485 {
1486 unsigned long fore_pixel, pixel;
1487
1488 if (!NILP (Vx_cursor_fore_pixel))
1489 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
1490 WHITE_PIX_DEFAULT (f));
1491 else
1492 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
1493
1494 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1495
1496 /* Make sure that the cursor color differs from the background color. */
1497 if (pixel == FRAME_BACKGROUND_PIXEL (f))
1498 {
1499 pixel = f->output_data.w32->mouse_pixel;
1500 if (pixel == fore_pixel)
1501 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
1502 }
1503
1504 f->output_data.w32->cursor_foreground_pixel = fore_pixel;
1505 f->output_data.w32->cursor_pixel = pixel;
1506
1507 if (FRAME_W32_WINDOW (f) != 0)
1508 {
1509 block_input ();
1510 /* Update frame's cursor_gc. */
1511 f->output_data.w32->cursor_gc->foreground = fore_pixel;
1512 f->output_data.w32->cursor_gc->background = pixel;
1513
1514 unblock_input ();
1515
1516 if (FRAME_VISIBLE_P (f))
1517 {
1518 x_update_cursor (f, 0);
1519 x_update_cursor (f, 1);
1520 }
1521 }
1522
1523 update_face_from_frame_parameter (f, Qcursor_color, arg);
1524 }
1525
1526 /* Set the border-color of frame F to pixel value PIX.
1527 Note that this does not fully take effect if done before
1528 F has a window. */
1529
1530 void
1531 x_set_border_pixel (struct frame *f, int pix)
1532 {
1533
1534 f->output_data.w32->border_pixel = pix;
1535
1536 if (FRAME_W32_WINDOW (f) != 0 && f->border_width > 0)
1537 {
1538 if (FRAME_VISIBLE_P (f))
1539 redraw_frame (f);
1540 }
1541 }
1542
1543 /* Set the border-color of frame F to value described by ARG.
1544 ARG can be a string naming a color.
1545 The border-color is used for the border that is drawn by the server.
1546 Note that this does not fully take effect if done before
1547 F has a window; it must be redone when the window is created. */
1548
1549 void
1550 x_set_border_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1551 {
1552 int pix;
1553
1554 CHECK_STRING (arg);
1555 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1556 x_set_border_pixel (f, pix);
1557 update_face_from_frame_parameter (f, Qborder_color, arg);
1558 }
1559
1560
1561 void
1562 x_set_cursor_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1563 {
1564 set_frame_cursor_types (f, arg);
1565 }
1566
1567 void
1568 x_set_icon_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1569 {
1570 bool result;
1571
1572 if (NILP (arg) && NILP (oldval))
1573 return;
1574
1575 if (STRINGP (arg) && STRINGP (oldval)
1576 && EQ (Fstring_equal (oldval, arg), Qt))
1577 return;
1578
1579 if (SYMBOLP (arg) && SYMBOLP (oldval) && EQ (arg, oldval))
1580 return;
1581
1582 block_input ();
1583
1584 result = x_bitmap_icon (f, arg);
1585 if (result)
1586 {
1587 unblock_input ();
1588 error ("No icon window available");
1589 }
1590
1591 unblock_input ();
1592 }
1593
1594 void
1595 x_set_icon_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1596 {
1597 if (STRINGP (arg))
1598 {
1599 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1600 return;
1601 }
1602 else if (!NILP (arg) || NILP (oldval))
1603 return;
1604
1605 fset_icon_name (f, arg);
1606
1607 #if 0
1608 if (f->output_data.w32->icon_bitmap != 0)
1609 return;
1610
1611 block_input ();
1612
1613 result = x_text_icon (f,
1614 SSDATA ((!NILP (f->icon_name)
1615 ? f->icon_name
1616 : !NILP (f->title)
1617 ? f->title
1618 : f->name)));
1619
1620 if (result)
1621 {
1622 unblock_input ();
1623 error ("No icon window available");
1624 }
1625
1626 /* If the window was unmapped (and its icon was mapped),
1627 the new icon is not mapped, so map the window in its stead. */
1628 if (FRAME_VISIBLE_P (f))
1629 {
1630 #ifdef USE_X_TOOLKIT
1631 XtPopup (f->output_data.w32->widget, XtGrabNone);
1632 #endif
1633 XMapWindow (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f));
1634 }
1635
1636 XFlush (FRAME_W32_DISPLAY (f));
1637 unblock_input ();
1638 #endif
1639 }
1640 \f
1641 void
1642 x_clear_under_internal_border (struct frame *f)
1643 {
1644 int border = FRAME_INTERNAL_BORDER_WIDTH (f);
1645
1646 /* Clear border if it's larger than before. */
1647 if (border != 0)
1648 {
1649 HDC hdc = get_frame_dc (f);
1650 int width = FRAME_PIXEL_WIDTH (f);
1651 int height = FRAME_PIXEL_HEIGHT (f);
1652
1653 block_input ();
1654 w32_clear_area (f, hdc, 0, FRAME_TOP_MARGIN_HEIGHT (f), width, border);
1655 w32_clear_area (f, hdc, 0, 0, border, height);
1656 w32_clear_area (f, hdc, width - border, 0, border, height);
1657 w32_clear_area (f, hdc, 0, height - border, width, border);
1658 release_frame_dc (f, hdc);
1659 unblock_input ();
1660 }
1661 }
1662
1663
1664 void
1665 x_set_internal_border_width (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1666 {
1667 int border;
1668
1669 CHECK_TYPE_RANGED_INTEGER (int, arg);
1670 border = max (XINT (arg), 0);
1671
1672 if (border != FRAME_INTERNAL_BORDER_WIDTH (f))
1673 {
1674 FRAME_INTERNAL_BORDER_WIDTH (f) = border;
1675
1676 if (FRAME_X_WINDOW (f) != 0)
1677 {
1678 adjust_frame_size (f, -1, -1, 3, false, Qinternal_border_width);
1679
1680 if (FRAME_VISIBLE_P (f))
1681 x_clear_under_internal_border (f);
1682 }
1683 }
1684 }
1685
1686
1687 void
1688 x_set_menu_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1689 {
1690 int nlines;
1691
1692 /* Right now, menu bars don't work properly in minibuf-only frames;
1693 most of the commands try to apply themselves to the minibuffer
1694 frame itself, and get an error because you can't switch buffers
1695 in or split the minibuffer window. */
1696 if (FRAME_MINIBUF_ONLY_P (f))
1697 return;
1698
1699 if (INTEGERP (value))
1700 nlines = XINT (value);
1701 else
1702 nlines = 0;
1703
1704 FRAME_MENU_BAR_LINES (f) = 0;
1705 FRAME_MENU_BAR_HEIGHT (f) = 0;
1706 if (nlines)
1707 FRAME_EXTERNAL_MENU_BAR (f) = 1;
1708 else
1709 {
1710 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
1711 free_frame_menubar (f);
1712 FRAME_EXTERNAL_MENU_BAR (f) = 0;
1713
1714 /* Adjust the frame size so that the client (text) dimensions
1715 remain the same. This depends on FRAME_EXTERNAL_MENU_BAR being
1716 set correctly. Note that we resize twice: The first time upon
1717 a request from the window manager who wants to keep the height
1718 of the outer rectangle (including decorations) unchanged, and a
1719 second time because we want to keep the height of the inner
1720 rectangle (without the decorations unchanged). */
1721 adjust_frame_size (f, -1, -1, 2, true, Qmenu_bar_lines);
1722
1723 /* Not sure whether this is needed. */
1724 x_clear_under_internal_border (f);
1725 }
1726 }
1727
1728
1729 /* Set the number of lines used for the tool bar of frame F to VALUE.
1730 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL is
1731 the old number of tool bar lines (and is unused). This function may
1732 change the height of all windows on frame F to match the new tool bar
1733 height. By design, the frame's height doesn't change (but maybe it
1734 should if we don't get enough space otherwise). */
1735
1736 void
1737 x_set_tool_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1738 {
1739 int nlines;
1740
1741 /* Treat tool bars like menu bars. */
1742 if (FRAME_MINIBUF_ONLY_P (f))
1743 return;
1744
1745 /* Use VALUE only if an integer >= 0. */
1746 if (INTEGERP (value) && XINT (value) >= 0)
1747 nlines = XFASTINT (value);
1748 else
1749 nlines = 0;
1750
1751 x_change_tool_bar_height (f, nlines * FRAME_LINE_HEIGHT (f));
1752 }
1753
1754
1755 /* Set the pixel height of the tool bar of frame F to HEIGHT. */
1756 void
1757 x_change_tool_bar_height (struct frame *f, int height)
1758 {
1759 int unit = FRAME_LINE_HEIGHT (f);
1760 int old_height = FRAME_TOOL_BAR_HEIGHT (f);
1761 int lines = (height + unit - 1) / unit;
1762 Lisp_Object fullscreen;
1763
1764 /* Make sure we redisplay all windows in this frame. */
1765 windows_or_buffers_changed = 23;
1766
1767 /* Recalculate tool bar and frame text sizes. */
1768 FRAME_TOOL_BAR_HEIGHT (f) = height;
1769 FRAME_TOOL_BAR_LINES (f) = lines;
1770 /* Store `tool-bar-lines' and `height' frame parameters. */
1771 store_frame_param (f, Qtool_bar_lines, make_number (lines));
1772 store_frame_param (f, Qheight, make_number (FRAME_LINES (f)));
1773
1774 if (FRAME_W32_WINDOW (f) && FRAME_TOOL_BAR_HEIGHT (f) == 0)
1775 {
1776 clear_frame (f);
1777 clear_current_matrices (f);
1778 }
1779
1780 if ((height < old_height) && WINDOWP (f->tool_bar_window))
1781 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1782
1783 /* Recalculate toolbar height. */
1784 f->n_tool_bar_rows = 0;
1785 if (old_height == 0
1786 && (!f->after_make_frame
1787 || NILP (frame_inhibit_implied_resize)
1788 || (CONSP (frame_inhibit_implied_resize)
1789 && NILP (Fmemq (Qtool_bar_lines, frame_inhibit_implied_resize)))))
1790 f->tool_bar_redisplayed = f->tool_bar_resized = false;
1791
1792 adjust_frame_size (f, -1, -1,
1793 ((!f->tool_bar_resized
1794 && (NILP (fullscreen =
1795 get_frame_param (f, Qfullscreen))
1796 || EQ (fullscreen, Qfullwidth))) ? 1
1797 : (old_height == 0 || height == 0) ? 2
1798 : 4),
1799 false, Qtool_bar_lines);
1800
1801 f->tool_bar_resized = f->tool_bar_redisplayed;
1802
1803 /* adjust_frame_size might not have done anything, garbage frame
1804 here. */
1805 adjust_frame_glyphs (f);
1806 SET_FRAME_GARBAGED (f);
1807 if (FRAME_X_WINDOW (f))
1808 x_clear_under_internal_border (f);
1809 }
1810
1811 static void
1812 w32_set_title_bar_text (struct frame *f, Lisp_Object name)
1813 {
1814 if (FRAME_W32_WINDOW (f))
1815 {
1816 block_input ();
1817 #ifdef __CYGWIN__
1818 GUI_FN (SetWindowText) (FRAME_W32_WINDOW (f),
1819 GUI_SDATA (GUI_ENCODE_SYSTEM (name)));
1820 #else
1821 /* The frame's title many times shows the name of the file
1822 visited in the selected window's buffer, so it makes sense to
1823 support non-ASCII characters outside of the current system
1824 codepage in the title. */
1825 if (w32_unicode_filenames)
1826 {
1827 Lisp_Object encoded_title = ENCODE_UTF_8 (name);
1828 wchar_t *title_w;
1829 int tlen = pMultiByteToWideChar (CP_UTF8, 0, SSDATA (encoded_title),
1830 -1, NULL, 0);
1831
1832 if (tlen > 0)
1833 {
1834 /* Windows truncates the title text beyond what fits on
1835 a single line, so we can limit the length to some
1836 reasonably large value, and use alloca. */
1837 if (tlen > 10000)
1838 tlen = 10000;
1839 title_w = alloca ((tlen + 1) * sizeof (wchar_t));
1840 pMultiByteToWideChar (CP_UTF8, 0, SSDATA (encoded_title), -1,
1841 title_w, tlen);
1842 title_w[tlen] = L'\0';
1843 SetWindowTextW (FRAME_W32_WINDOW (f), title_w);
1844 }
1845 else /* Conversion to UTF-16 failed, so we punt. */
1846 SetWindowTextA (FRAME_W32_WINDOW (f),
1847 SSDATA (ENCODE_SYSTEM (name)));
1848 }
1849 else
1850 SetWindowTextA (FRAME_W32_WINDOW (f), SSDATA (ENCODE_SYSTEM (name)));
1851 #endif
1852 unblock_input ();
1853 }
1854 }
1855
1856 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1857 w32_id_name.
1858
1859 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1860 name; if NAME is a string, set F's name to NAME and set
1861 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1862
1863 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1864 suggesting a new name, which lisp code should override; if
1865 F->explicit_name is set, ignore the new name; otherwise, set it. */
1866
1867 void
1868 x_set_name (struct frame *f, Lisp_Object name, bool explicit)
1869 {
1870 /* Make sure that requests from lisp code override requests from
1871 Emacs redisplay code. */
1872 if (explicit)
1873 {
1874 /* If we're switching from explicit to implicit, we had better
1875 update the mode lines and thereby update the title. */
1876 if (f->explicit_name && NILP (name))
1877 update_mode_lines = 25;
1878
1879 f->explicit_name = ! NILP (name);
1880 }
1881 else if (f->explicit_name)
1882 return;
1883
1884 /* If NAME is nil, set the name to the w32_id_name. */
1885 if (NILP (name))
1886 {
1887 /* Check for no change needed in this very common case
1888 before we do any consing. */
1889 if (!strcmp (FRAME_DISPLAY_INFO (f)->w32_id_name,
1890 SSDATA (f->name)))
1891 return;
1892 name = build_string (FRAME_DISPLAY_INFO (f)->w32_id_name);
1893 }
1894 else
1895 CHECK_STRING (name);
1896
1897 /* Don't change the name if it's already NAME. */
1898 if (! NILP (Fstring_equal (name, f->name)))
1899 return;
1900
1901 fset_name (f, name);
1902
1903 /* For setting the frame title, the title parameter should override
1904 the name parameter. */
1905 if (! NILP (f->title))
1906 name = f->title;
1907
1908 w32_set_title_bar_text (f, name);
1909 }
1910
1911 /* This function should be called when the user's lisp code has
1912 specified a name for the frame; the name will override any set by the
1913 redisplay code. */
1914 void
1915 x_explicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1916 {
1917 x_set_name (f, arg, true);
1918 }
1919
1920 /* This function should be called by Emacs redisplay code to set the
1921 name; names set this way will never override names set by the user's
1922 lisp code. */
1923 void
1924 x_implicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1925 {
1926 x_set_name (f, arg, false);
1927 }
1928 \f
1929 /* Change the title of frame F to NAME.
1930 If NAME is nil, use the frame name as the title. */
1931
1932 void
1933 x_set_title (struct frame *f, Lisp_Object name, Lisp_Object old_name)
1934 {
1935 /* Don't change the title if it's already NAME. */
1936 if (EQ (name, f->title))
1937 return;
1938
1939 update_mode_lines = 26;
1940
1941 fset_title (f, name);
1942
1943 if (NILP (name))
1944 name = f->name;
1945
1946 w32_set_title_bar_text (f, name);
1947 }
1948
1949 void
1950 x_set_scroll_bar_default_width (struct frame *f)
1951 {
1952 int unit = FRAME_COLUMN_WIDTH (f);
1953
1954 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = GetSystemMetrics (SM_CXVSCROLL);
1955 FRAME_CONFIG_SCROLL_BAR_COLS (f)
1956 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + unit - 1) / unit;
1957 }
1958
1959
1960 void
1961 x_set_scroll_bar_default_height (struct frame *f)
1962 {
1963 int unit = FRAME_LINE_HEIGHT (f);
1964
1965 FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) = GetSystemMetrics (SM_CXHSCROLL);
1966 FRAME_CONFIG_SCROLL_BAR_LINES (f)
1967 = (FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) + unit - 1) / unit;
1968 }
1969 \f
1970 /* Subroutines for creating a frame. */
1971
1972 Cursor
1973 w32_load_cursor (LPCTSTR name)
1974 {
1975 /* Try first to load cursor from application resource. */
1976 Cursor cursor = LoadImage ((HINSTANCE) GetModuleHandle (NULL),
1977 name, IMAGE_CURSOR, 0, 0,
1978 LR_DEFAULTCOLOR | LR_DEFAULTSIZE | LR_SHARED);
1979 if (!cursor)
1980 {
1981 /* Then try to load a shared predefined cursor. */
1982 cursor = LoadImage (NULL, name, IMAGE_CURSOR, 0, 0,
1983 LR_DEFAULTCOLOR | LR_DEFAULTSIZE | LR_SHARED);
1984 }
1985 return cursor;
1986 }
1987
1988 static LRESULT CALLBACK w32_wnd_proc (HWND, UINT, WPARAM, LPARAM);
1989
1990 #define INIT_WINDOW_CLASS(WC) \
1991 (WC).style = CS_HREDRAW | CS_VREDRAW; \
1992 (WC).lpfnWndProc = (WNDPROC) w32_wnd_proc; \
1993 (WC).cbClsExtra = 0; \
1994 (WC).cbWndExtra = WND_EXTRA_BYTES; \
1995 (WC).hInstance = hinst; \
1996 (WC).hIcon = LoadIcon (hinst, EMACS_CLASS); \
1997 (WC).hCursor = w32_load_cursor (IDC_ARROW); \
1998 (WC).hbrBackground = NULL; \
1999 (WC).lpszMenuName = NULL; \
2000
2001 static BOOL
2002 w32_init_class (HINSTANCE hinst)
2003 {
2004 if (w32_unicode_gui)
2005 {
2006 WNDCLASSW uwc;
2007 INIT_WINDOW_CLASS(uwc);
2008 uwc.lpszClassName = L"Emacs";
2009
2010 return RegisterClassW (&uwc);
2011 }
2012 else
2013 {
2014 WNDCLASS wc;
2015 INIT_WINDOW_CLASS(wc);
2016 wc.lpszClassName = EMACS_CLASS;
2017
2018 return RegisterClassA (&wc);
2019 }
2020 }
2021
2022 static HWND
2023 w32_createvscrollbar (struct frame *f, struct scroll_bar * bar)
2024 {
2025 return CreateWindow ("SCROLLBAR", "", SBS_VERT | WS_CHILD | WS_VISIBLE,
2026 /* Position and size of scroll bar. */
2027 bar->left, bar->top, bar->width, bar->height,
2028 FRAME_W32_WINDOW (f), NULL, hinst, NULL);
2029 }
2030
2031 static HWND
2032 w32_createhscrollbar (struct frame *f, struct scroll_bar * bar)
2033 {
2034 return CreateWindow ("SCROLLBAR", "", SBS_HORZ | WS_CHILD | WS_VISIBLE,
2035 /* Position and size of scroll bar. */
2036 bar->left, bar->top, bar->width, bar->height,
2037 FRAME_W32_WINDOW (f), NULL, hinst, NULL);
2038 }
2039
2040 static void
2041 w32_createwindow (struct frame *f, int *coords)
2042 {
2043 HWND hwnd;
2044 RECT rect;
2045 int top;
2046 int left;
2047
2048 rect.left = rect.top = 0;
2049 rect.right = FRAME_PIXEL_WIDTH (f);
2050 rect.bottom = FRAME_PIXEL_HEIGHT (f);
2051
2052 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
2053 FRAME_EXTERNAL_MENU_BAR (f));
2054
2055 /* Do first time app init */
2056
2057 w32_init_class (hinst);
2058
2059 if (f->size_hint_flags & USPosition || f->size_hint_flags & PPosition)
2060 {
2061 left = f->left_pos;
2062 top = f->top_pos;
2063 }
2064 else
2065 {
2066 left = coords[0];
2067 top = coords[1];
2068 }
2069
2070 FRAME_W32_WINDOW (f) = hwnd
2071 = CreateWindow (EMACS_CLASS,
2072 f->namebuf,
2073 f->output_data.w32->dwStyle | WS_CLIPCHILDREN,
2074 left, top,
2075 rect.right - rect.left, rect.bottom - rect.top,
2076 NULL,
2077 NULL,
2078 hinst,
2079 NULL);
2080
2081 if (hwnd)
2082 {
2083 SetWindowLong (hwnd, WND_FONTWIDTH_INDEX, FRAME_COLUMN_WIDTH (f));
2084 SetWindowLong (hwnd, WND_LINEHEIGHT_INDEX, FRAME_LINE_HEIGHT (f));
2085 SetWindowLong (hwnd, WND_BORDER_INDEX, FRAME_INTERNAL_BORDER_WIDTH (f));
2086 SetWindowLong (hwnd, WND_VSCROLLBAR_INDEX, FRAME_SCROLL_BAR_AREA_WIDTH (f));
2087 SetWindowLong (hwnd, WND_HSCROLLBAR_INDEX, FRAME_SCROLL_BAR_AREA_HEIGHT (f));
2088 SetWindowLong (hwnd, WND_BACKGROUND_INDEX, FRAME_BACKGROUND_PIXEL (f));
2089
2090 /* Enable drag-n-drop. */
2091 DragAcceptFiles (hwnd, TRUE);
2092
2093 /* Do this to discard the default setting specified by our parent. */
2094 ShowWindow (hwnd, SW_HIDE);
2095
2096 /* Update frame positions. */
2097 GetWindowRect (hwnd, &rect);
2098 f->left_pos = rect.left;
2099 f->top_pos = rect.top;
2100 }
2101 }
2102
2103 static void
2104 my_post_msg (W32Msg * wmsg, HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
2105 {
2106 wmsg->msg.hwnd = hwnd;
2107 wmsg->msg.message = msg;
2108 wmsg->msg.wParam = wParam;
2109 wmsg->msg.lParam = lParam;
2110 wmsg->msg.time = GetMessageTime ();
2111
2112 post_msg (wmsg);
2113 }
2114
2115 #ifdef WINDOWSNT
2116 /* The Windows keyboard hook callback. */
2117 static LRESULT CALLBACK
2118 funhook (int code, WPARAM w, LPARAM l)
2119 {
2120 INPUT inputs[2];
2121 HWND focus = GetFocus ();
2122 int console = 0;
2123 KBDLLHOOKSTRUCT const *hs = (KBDLLHOOKSTRUCT*)l;
2124
2125 if (code < 0 || (hs->flags & LLKHF_INJECTED))
2126 return CallNextHookEx (0, code, w, l);
2127
2128 /* The keyboard hook sees keyboard input on all processes (except
2129 elevated ones, when Emacs itself is not elevated). As such,
2130 care must be taken to only filter out keyboard input when Emacs
2131 itself is on the foreground.
2132
2133 GetFocus returns a non-NULL window if another application is active,
2134 and always for a console Emacs process. For a console Emacs, determine
2135 focus by checking if the current foreground window is the process's
2136 console window. */
2137 if (focus == NULL && kbdhook.console != NULL)
2138 {
2139 if (GetForegroundWindow () == kbdhook.console)
2140 {
2141 focus = kbdhook.console;
2142 console = 1;
2143 }
2144 }
2145
2146 /* First, check hooks for the left and right Windows keys. */
2147 if (hs->vkCode == VK_LWIN || hs->vkCode == VK_RWIN)
2148 {
2149 if (focus != NULL && (w == WM_KEYDOWN || w == WM_SYSKEYDOWN))
2150 {
2151 /* The key is being pressed in an Emacs window. */
2152 if (hs->vkCode == VK_LWIN && !kbdhook.lwindown)
2153 {
2154 kbdhook.lwindown = 1;
2155 kbdhook.winseen = 1;
2156 kbdhook.winsdown++;
2157 }
2158 else if (hs->vkCode == VK_RWIN && !kbdhook.rwindown)
2159 {
2160 kbdhook.rwindown = 1;
2161 kbdhook.winseen = 1;
2162 kbdhook.winsdown++;
2163 }
2164 /* Returning 1 here drops the keypress without further processing.
2165 If the keypress was allowed to go through, the normal Windows
2166 hotkeys would take over. */
2167 return 1;
2168 }
2169 else if (kbdhook.winsdown > 0 && (w == WM_KEYUP || w == WM_SYSKEYUP))
2170 {
2171 /* A key that has been captured earlier is being released now. */
2172 if (hs->vkCode == VK_LWIN && kbdhook.lwindown)
2173 {
2174 kbdhook.lwindown = 0;
2175 kbdhook.winsdown--;
2176 }
2177 else if (hs->vkCode == VK_RWIN && kbdhook.rwindown)
2178 {
2179 kbdhook.rwindown = 0;
2180 kbdhook.winsdown--;
2181 }
2182 if (kbdhook.winsdown == 0 && kbdhook.winseen)
2183 {
2184 if (!kbdhook.suppress_lone)
2185 {
2186 /* The Windows key was pressed, then released,
2187 without any other key pressed simultaneously.
2188 Normally, this opens the Start menu, but the user
2189 can prevent this by setting the
2190 w32-pass-[lr]window-to-system variable to
2191 NIL. */
2192 if (hs->vkCode == VK_LWIN && !NILP (Vw32_pass_lwindow_to_system) ||
2193 hs->vkCode == VK_RWIN && !NILP (Vw32_pass_rwindow_to_system))
2194 {
2195 /* Not prevented - Simulate the keypress to the system. */
2196 memset (inputs, 0, sizeof (inputs));
2197 inputs[0].type = INPUT_KEYBOARD;
2198 inputs[0].ki.wVk = hs->vkCode;
2199 inputs[0].ki.wScan = hs->vkCode;
2200 inputs[0].ki.dwFlags = KEYEVENTF_EXTENDEDKEY;
2201 inputs[0].ki.time = 0;
2202 inputs[1].type = INPUT_KEYBOARD;
2203 inputs[1].ki.wVk = hs->vkCode;
2204 inputs[1].ki.wScan = hs->vkCode;
2205 inputs[1].ki.dwFlags
2206 = KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP;
2207 inputs[1].ki.time = 0;
2208 SendInput (2, inputs, sizeof (INPUT));
2209 }
2210 else if (focus != NULL)
2211 {
2212 /* When not passed to system, must simulate privately to Emacs. */
2213 PostMessage (focus, WM_SYSKEYDOWN, hs->vkCode, 0);
2214 PostMessage (focus, WM_SYSKEYUP, hs->vkCode, 0);
2215 }
2216 }
2217 }
2218 if (kbdhook.winsdown == 0)
2219 {
2220 /* No Windows keys pressed anymore - clear the state flags. */
2221 kbdhook.suppress_lone = 0;
2222 kbdhook.winseen = 0;
2223 }
2224 if (!kbdhook.send_win_up)
2225 {
2226 /* Swallow this release message, as not to confuse
2227 applications who did not get to see the original
2228 WM_KEYDOWN message either. */
2229 return 1;
2230 }
2231 kbdhook.send_win_up = 0;
2232 }
2233 }
2234 else if (kbdhook.winsdown > 0)
2235 {
2236 /* Some other key was pressed while a captured Win key is down.
2237 This is either an Emacs registered hotkey combination, or a
2238 system hotkey. */
2239 if (kbdhook.lwindown && kbdhook.lwin_hooked[hs->vkCode] ||
2240 kbdhook.rwindown && kbdhook.rwin_hooked[hs->vkCode])
2241 {
2242 /* Hooked Win-x combination, do not pass the keypress to Windows. */
2243 kbdhook.suppress_lone = 1;
2244 }
2245 else if (!kbdhook.suppress_lone)
2246 {
2247 /* Unhooked S-x combination; simulate the combination now
2248 (will be seen by the system). */
2249 memset (inputs, 0, sizeof (inputs));
2250 inputs[0].type = INPUT_KEYBOARD;
2251 inputs[0].ki.wVk = kbdhook.lwindown ? VK_LWIN : VK_RWIN;
2252 inputs[0].ki.wScan = kbdhook.lwindown ? VK_LWIN : VK_RWIN;
2253 inputs[0].ki.dwFlags = KEYEVENTF_EXTENDEDKEY;
2254 inputs[0].ki.time = 0;
2255 inputs[1].type = INPUT_KEYBOARD;
2256 inputs[1].ki.wVk = hs->vkCode;
2257 inputs[1].ki.wScan = hs->scanCode;
2258 inputs[1].ki.dwFlags =
2259 (hs->flags & LLKHF_EXTENDED) ? KEYEVENTF_EXTENDEDKEY : 0;
2260 inputs[1].ki.time = 0;
2261 SendInput (2, inputs, sizeof (INPUT));
2262 /* Stop processing of this Win sequence here; the
2263 corresponding keyup messages will come through the normal
2264 channel when the keys are released. */
2265 kbdhook.suppress_lone = 1;
2266 kbdhook.send_win_up = 1;
2267 /* Swallow the original keypress (as we want the Win key
2268 down message simulated above to precede this real message). */
2269 return 1;
2270 }
2271 }
2272
2273 /* Next, handle the registered Alt-* combinations. */
2274 if ((w == WM_SYSKEYDOWN || w == WM_KEYDOWN)
2275 && kbdhook.alt_hooked[hs->vkCode]
2276 && focus != NULL
2277 && (GetAsyncKeyState (VK_MENU) & 0x8000))
2278 {
2279 /* Prevent the system from getting this Alt-* key - suppress the
2280 message and post as a normal keypress to Emacs. */
2281 if (console)
2282 {
2283 INPUT_RECORD rec;
2284 DWORD n;
2285 rec.EventType = KEY_EVENT;
2286 rec.Event.KeyEvent.bKeyDown = TRUE;
2287 rec.Event.KeyEvent.wVirtualKeyCode = hs->vkCode;
2288 rec.Event.KeyEvent.wVirtualScanCode = hs->scanCode;
2289 rec.Event.KeyEvent.uChar.UnicodeChar = 0;
2290 rec.Event.KeyEvent.dwControlKeyState =
2291 ((GetAsyncKeyState (VK_LMENU) & 0x8000) ? LEFT_ALT_PRESSED : 0)
2292 | ((GetAsyncKeyState (VK_RMENU) & 0x8000) ? RIGHT_ALT_PRESSED : 0)
2293 | ((GetAsyncKeyState (VK_LCONTROL) & 0x8000) ? LEFT_CTRL_PRESSED : 0)
2294 | ((GetAsyncKeyState (VK_RCONTROL) & 0x8000) ? RIGHT_CTRL_PRESSED : 0)
2295 | ((GetAsyncKeyState (VK_SHIFT) & 0x8000) ? SHIFT_PRESSED : 0)
2296 | ((hs->flags & LLKHF_EXTENDED) ? ENHANCED_KEY : 0);
2297 if (w32_console_unicode_input)
2298 WriteConsoleInputW (keyboard_handle, &rec, 1, &n);
2299 else
2300 WriteConsoleInputA (keyboard_handle, &rec, 1, &n);
2301 }
2302 else
2303 PostMessage (focus, w, hs->vkCode, 1 | (1<<29));
2304 return 1;
2305 }
2306
2307 /* The normal case - pass the message through. */
2308 return CallNextHookEx (0, code, w, l);
2309 }
2310
2311 /* Set up the hook; can be called several times, with matching
2312 remove_w32_kbdhook calls. */
2313 void
2314 setup_w32_kbdhook (void)
2315 {
2316 kbdhook.hook_count++;
2317
2318 /* Hooking is only available on NT architecture systems, as
2319 indicated by the w32_kbdhook_active variable. */
2320 if (kbdhook.hook_count == 1 && w32_kbdhook_active)
2321 {
2322 /* Get the handle of the Emacs console window. As the
2323 GetConsoleWindow function is only available on Win2000+, a
2324 hackish workaround described in Microsoft KB article 124103
2325 (https://support.microsoft.com/en-us/kb/124103) is used for
2326 NT 4 systems. */
2327 GetConsoleWindow_Proc get_console = (GetConsoleWindow_Proc)
2328 GetProcAddress (GetModuleHandle ("kernel32.dll"), "GetConsoleWindow");
2329
2330 if (get_console != NULL)
2331 kbdhook.console = get_console ();
2332 else
2333 {
2334 GUID guid;
2335 wchar_t *oldTitle = malloc (1024 * sizeof(wchar_t));
2336 wchar_t newTitle[64];
2337 int i;
2338
2339 CoCreateGuid (&guid);
2340 StringFromGUID2 (&guid, newTitle, 64);
2341 if (newTitle != NULL)
2342 {
2343 GetConsoleTitleW (oldTitle, 1024);
2344 SetConsoleTitleW (newTitle);
2345 for (i = 0; i < 25; i++)
2346 {
2347 Sleep (40);
2348 kbdhook.console = FindWindowW (NULL, newTitle);
2349 if (kbdhook.console != NULL)
2350 break;
2351 }
2352 SetConsoleTitleW (oldTitle);
2353 }
2354 free (oldTitle);
2355 }
2356
2357 /* Set the hook. */
2358 kbdhook.hook = SetWindowsHookEx (WH_KEYBOARD_LL, funhook,
2359 GetModuleHandle (NULL), 0);
2360 }
2361 }
2362
2363 /* Remove the hook. */
2364 void
2365 remove_w32_kbdhook (void)
2366 {
2367 kbdhook.hook_count--;
2368 if (kbdhook.hook_count == 0 && w32_kbdhook_active)
2369 {
2370 UnhookWindowsHookEx (kbdhook.hook);
2371 kbdhook.hook = NULL;
2372 }
2373 }
2374 #endif /* WINDOWSNT */
2375
2376 /* Mark a specific key combination as hooked, preventing it to be
2377 handled by the system. */
2378 void
2379 hook_w32_key (int hook, int modifier, int vkey)
2380 {
2381 char *tbl = NULL;
2382
2383 switch (modifier)
2384 {
2385 case VK_MENU:
2386 tbl = kbdhook.alt_hooked;
2387 break;
2388 case VK_LWIN:
2389 tbl = kbdhook.lwin_hooked;
2390 break;
2391 case VK_RWIN:
2392 tbl = kbdhook.rwin_hooked;
2393 break;
2394 }
2395
2396 if (tbl != NULL && vkey >= 0 && vkey <= 255)
2397 {
2398 /* VK_ANY hooks all keys for this modifier */
2399 if (vkey == VK_ANY)
2400 memset (tbl, (char)hook, 256);
2401 else
2402 tbl[vkey] = (char)hook;
2403 /* Alt-<modifier>s should go through */
2404 kbdhook.alt_hooked[VK_MENU] = 0;
2405 kbdhook.alt_hooked[VK_LMENU] = 0;
2406 kbdhook.alt_hooked[VK_RMENU] = 0;
2407 kbdhook.alt_hooked[VK_CONTROL] = 0;
2408 kbdhook.alt_hooked[VK_LCONTROL] = 0;
2409 kbdhook.alt_hooked[VK_RCONTROL] = 0;
2410 kbdhook.alt_hooked[VK_SHIFT] = 0;
2411 kbdhook.alt_hooked[VK_LSHIFT] = 0;
2412 kbdhook.alt_hooked[VK_RSHIFT] = 0;
2413 }
2414 }
2415
2416 /* Check the current Win key pressed state. */
2417 int
2418 check_w32_winkey_state (int vkey)
2419 {
2420 /* The hook code handles grabbing of the Windows keys and Alt-* key
2421 combinations reserved by the system. Handling Alt is a bit
2422 easier, as Windows intends Alt-* shortcuts for application use in
2423 Windows; hotkeys such as Alt-tab and Alt-escape are special
2424 cases. Win-* hotkeys, on the other hand, are primarily meant for
2425 system use.
2426
2427 As a result, when we want Emacs to be able to grab the Win-*
2428 keys, we must swallow all Win key presses in a low-level keyboard
2429 hook. Unfortunately, this means that the Emacs window procedure
2430 (and console input handler) never see the keypresses either.
2431 Thus, to check the modifier states properly, Emacs code must use
2432 the check_w32_winkey_state function that uses the flags directly
2433 updated by the hook callback. */
2434 switch (vkey)
2435 {
2436 case VK_LWIN:
2437 return kbdhook.lwindown;
2438 case VK_RWIN:
2439 return kbdhook.rwindown;
2440 }
2441 return 0;
2442 }
2443
2444 /* Reset the keyboard hook state. Locking the workstation with Win-L
2445 leaves the Win key(s) "down" from the hook's point of view - the
2446 keyup event is never seen. Thus, this function must be called when
2447 the system is locked. */
2448 void
2449 reset_w32_kbdhook_state (void)
2450 {
2451 kbdhook.lwindown = 0;
2452 kbdhook.rwindown = 0;
2453 kbdhook.winsdown = 0;
2454 kbdhook.send_win_up = 0;
2455 kbdhook.suppress_lone = 0;
2456 kbdhook.winseen = 0;
2457 }
2458
2459 /* GetKeyState and MapVirtualKey on Windows 95 do not actually distinguish
2460 between left and right keys as advertised. We test for this
2461 support dynamically, and set a flag when the support is absent. If
2462 absent, we keep track of the left and right control and alt keys
2463 ourselves. This is particularly necessary on keyboards that rely
2464 upon the AltGr key, which is represented as having the left control
2465 and right alt keys pressed. For these keyboards, we need to know
2466 when the left alt key has been pressed in addition to the AltGr key
2467 so that we can properly support M-AltGr-key sequences (such as M-@
2468 on Swedish keyboards). */
2469
2470 #define EMACS_LCONTROL 0
2471 #define EMACS_RCONTROL 1
2472 #define EMACS_LMENU 2
2473 #define EMACS_RMENU 3
2474
2475 static int modifiers[4];
2476 static int modifiers_recorded;
2477 static int modifier_key_support_tested;
2478
2479 static void
2480 test_modifier_support (unsigned int wparam)
2481 {
2482 unsigned int l, r;
2483
2484 if (wparam != VK_CONTROL && wparam != VK_MENU)
2485 return;
2486 if (wparam == VK_CONTROL)
2487 {
2488 l = VK_LCONTROL;
2489 r = VK_RCONTROL;
2490 }
2491 else
2492 {
2493 l = VK_LMENU;
2494 r = VK_RMENU;
2495 }
2496 if (!(GetKeyState (l) & 0x8000) && !(GetKeyState (r) & 0x8000))
2497 modifiers_recorded = 1;
2498 else
2499 modifiers_recorded = 0;
2500 modifier_key_support_tested = 1;
2501 }
2502
2503 static void
2504 record_keydown (unsigned int wparam, unsigned int lparam)
2505 {
2506 int i;
2507
2508 if (!modifier_key_support_tested)
2509 test_modifier_support (wparam);
2510
2511 if ((wparam != VK_CONTROL && wparam != VK_MENU) || !modifiers_recorded)
2512 return;
2513
2514 if (wparam == VK_CONTROL)
2515 i = (lparam & 0x1000000) ? EMACS_RCONTROL : EMACS_LCONTROL;
2516 else
2517 i = (lparam & 0x1000000) ? EMACS_RMENU : EMACS_LMENU;
2518
2519 modifiers[i] = 1;
2520 }
2521
2522 static void
2523 record_keyup (unsigned int wparam, unsigned int lparam)
2524 {
2525 int i;
2526
2527 if ((wparam != VK_CONTROL && wparam != VK_MENU) || !modifiers_recorded)
2528 return;
2529
2530 if (wparam == VK_CONTROL)
2531 i = (lparam & 0x1000000) ? EMACS_RCONTROL : EMACS_LCONTROL;
2532 else
2533 i = (lparam & 0x1000000) ? EMACS_RMENU : EMACS_LMENU;
2534
2535 modifiers[i] = 0;
2536 }
2537
2538 /* Emacs can lose focus while a modifier key has been pressed. When
2539 it regains focus, be conservative and clear all modifiers since
2540 we cannot reconstruct the left and right modifier state. */
2541 static void
2542 reset_modifiers (void)
2543 {
2544 SHORT ctrl, alt;
2545
2546 if (GetFocus () == NULL)
2547 /* Emacs doesn't have keyboard focus. Do nothing. */
2548 return;
2549
2550 ctrl = GetAsyncKeyState (VK_CONTROL);
2551 alt = GetAsyncKeyState (VK_MENU);
2552
2553 if (!(ctrl & 0x08000))
2554 /* Clear any recorded control modifier state. */
2555 modifiers[EMACS_RCONTROL] = modifiers[EMACS_LCONTROL] = 0;
2556
2557 if (!(alt & 0x08000))
2558 /* Clear any recorded alt modifier state. */
2559 modifiers[EMACS_RMENU] = modifiers[EMACS_LMENU] = 0;
2560
2561 /* Update the state of all modifier keys, because modifiers used in
2562 hot-key combinations can get stuck on if Emacs loses focus as a
2563 result of a hot-key being pressed. */
2564 {
2565 BYTE keystate[256];
2566
2567 #define CURRENT_STATE(key) ((GetAsyncKeyState (key) & 0x8000) >> 8)
2568
2569 memset (keystate, 0, sizeof (keystate));
2570 GetKeyboardState (keystate);
2571 keystate[VK_SHIFT] = CURRENT_STATE (VK_SHIFT);
2572 keystate[VK_CONTROL] = CURRENT_STATE (VK_CONTROL);
2573 keystate[VK_LCONTROL] = CURRENT_STATE (VK_LCONTROL);
2574 keystate[VK_RCONTROL] = CURRENT_STATE (VK_RCONTROL);
2575 keystate[VK_MENU] = CURRENT_STATE (VK_MENU);
2576 keystate[VK_LMENU] = CURRENT_STATE (VK_LMENU);
2577 keystate[VK_RMENU] = CURRENT_STATE (VK_RMENU);
2578 keystate[VK_LWIN] = CURRENT_STATE (VK_LWIN);
2579 keystate[VK_RWIN] = CURRENT_STATE (VK_RWIN);
2580 keystate[VK_APPS] = CURRENT_STATE (VK_APPS);
2581 SetKeyboardState (keystate);
2582 }
2583 }
2584
2585 /* Synchronize modifier state with what is reported with the current
2586 keystroke. Even if we cannot distinguish between left and right
2587 modifier keys, we know that, if no modifiers are set, then neither
2588 the left or right modifier should be set. */
2589 static void
2590 sync_modifiers (void)
2591 {
2592 if (!modifiers_recorded)
2593 return;
2594
2595 if (!(GetKeyState (VK_CONTROL) & 0x8000))
2596 modifiers[EMACS_RCONTROL] = modifiers[EMACS_LCONTROL] = 0;
2597
2598 if (!(GetKeyState (VK_MENU) & 0x8000))
2599 modifiers[EMACS_RMENU] = modifiers[EMACS_LMENU] = 0;
2600 }
2601
2602 static int
2603 modifier_set (int vkey)
2604 {
2605 /* Warning: The fact that VK_NUMLOCK is not treated as the other 2
2606 toggle keys is not an omission! If you want to add it, you will
2607 have to make changes in the default sub-case of the WM_KEYDOWN
2608 switch, because if the NUMLOCK modifier is set, the code there
2609 will directly convert any key that looks like an ASCII letter,
2610 and also downcase those that look like upper-case ASCII. */
2611 if (vkey == VK_CAPITAL)
2612 {
2613 if (NILP (Vw32_enable_caps_lock))
2614 return 0;
2615 else
2616 return (GetKeyState (vkey) & 0x1);
2617 }
2618 if (vkey == VK_SCROLL)
2619 {
2620 if (NILP (Vw32_scroll_lock_modifier)
2621 /* w32-scroll-lock-modifier can be any non-nil value that is
2622 not one of the modifiers, in which case it shall be ignored. */
2623 || !( EQ (Vw32_scroll_lock_modifier, Qhyper)
2624 || EQ (Vw32_scroll_lock_modifier, Qsuper)
2625 || EQ (Vw32_scroll_lock_modifier, Qmeta)
2626 || EQ (Vw32_scroll_lock_modifier, Qalt)
2627 || EQ (Vw32_scroll_lock_modifier, Qcontrol)
2628 || EQ (Vw32_scroll_lock_modifier, Qshift)))
2629 return 0;
2630 else
2631 return (GetKeyState (vkey) & 0x1);
2632 }
2633 if (w32_kbdhook_active && (vkey == VK_LWIN || vkey == VK_RWIN))
2634 return check_w32_winkey_state (vkey);
2635
2636 if (!modifiers_recorded)
2637 return (GetKeyState (vkey) & 0x8000);
2638
2639 switch (vkey)
2640 {
2641 case VK_LCONTROL:
2642 return modifiers[EMACS_LCONTROL];
2643 case VK_RCONTROL:
2644 return modifiers[EMACS_RCONTROL];
2645 case VK_LMENU:
2646 return modifiers[EMACS_LMENU];
2647 case VK_RMENU:
2648 return modifiers[EMACS_RMENU];
2649 }
2650 return (GetKeyState (vkey) & 0x8000);
2651 }
2652
2653 /* Convert between the modifier bits W32 uses and the modifier bits
2654 Emacs uses. */
2655
2656 unsigned int
2657 w32_key_to_modifier (int key)
2658 {
2659 Lisp_Object key_mapping;
2660
2661 switch (key)
2662 {
2663 case VK_LWIN:
2664 key_mapping = Vw32_lwindow_modifier;
2665 break;
2666 case VK_RWIN:
2667 key_mapping = Vw32_rwindow_modifier;
2668 break;
2669 case VK_APPS:
2670 key_mapping = Vw32_apps_modifier;
2671 break;
2672 case VK_SCROLL:
2673 key_mapping = Vw32_scroll_lock_modifier;
2674 break;
2675 default:
2676 key_mapping = Qnil;
2677 }
2678
2679 /* NB. This code runs in the input thread, asynchronously to the lisp
2680 thread, so we must be careful to ensure access to lisp data is
2681 thread-safe. The following code is safe because the modifier
2682 variable values are updated atomically from lisp and symbols are
2683 not relocated by GC. Also, we don't have to worry about seeing GC
2684 markbits here. */
2685 if (EQ (key_mapping, Qhyper))
2686 return hyper_modifier;
2687 if (EQ (key_mapping, Qsuper))
2688 return super_modifier;
2689 if (EQ (key_mapping, Qmeta))
2690 return meta_modifier;
2691 if (EQ (key_mapping, Qalt))
2692 return alt_modifier;
2693 if (EQ (key_mapping, Qctrl))
2694 return ctrl_modifier;
2695 if (EQ (key_mapping, Qcontrol)) /* synonym for ctrl */
2696 return ctrl_modifier;
2697 if (EQ (key_mapping, Qshift))
2698 return shift_modifier;
2699
2700 /* Don't generate any modifier if not explicitly requested. */
2701 return 0;
2702 }
2703
2704 static unsigned int
2705 w32_get_modifiers (void)
2706 {
2707 return ((modifier_set (VK_SHIFT) ? shift_modifier : 0) |
2708 (modifier_set (VK_CONTROL) ? ctrl_modifier : 0) |
2709 (modifier_set (VK_LWIN) ? w32_key_to_modifier (VK_LWIN) : 0) |
2710 (modifier_set (VK_RWIN) ? w32_key_to_modifier (VK_RWIN) : 0) |
2711 (modifier_set (VK_APPS) ? w32_key_to_modifier (VK_APPS) : 0) |
2712 (modifier_set (VK_SCROLL) ? w32_key_to_modifier (VK_SCROLL) : 0) |
2713 (modifier_set (VK_MENU) ?
2714 ((NILP (Vw32_alt_is_meta)) ? alt_modifier : meta_modifier) : 0));
2715 }
2716
2717 /* We map the VK_* modifiers into console modifier constants
2718 so that we can use the same routines to handle both console
2719 and window input. */
2720
2721 static int
2722 construct_console_modifiers (void)
2723 {
2724 int mods;
2725
2726 mods = 0;
2727 mods |= (modifier_set (VK_SHIFT)) ? SHIFT_PRESSED : 0;
2728 mods |= (modifier_set (VK_CAPITAL)) ? CAPSLOCK_ON : 0;
2729 mods |= (modifier_set (VK_SCROLL)) ? SCROLLLOCK_ON : 0;
2730 mods |= (modifier_set (VK_NUMLOCK)) ? NUMLOCK_ON : 0;
2731 mods |= (modifier_set (VK_LCONTROL)) ? LEFT_CTRL_PRESSED : 0;
2732 mods |= (modifier_set (VK_RCONTROL)) ? RIGHT_CTRL_PRESSED : 0;
2733 mods |= (modifier_set (VK_LMENU)) ? LEFT_ALT_PRESSED : 0;
2734 mods |= (modifier_set (VK_RMENU)) ? RIGHT_ALT_PRESSED : 0;
2735 mods |= (modifier_set (VK_LWIN)) ? LEFT_WIN_PRESSED : 0;
2736 mods |= (modifier_set (VK_RWIN)) ? RIGHT_WIN_PRESSED : 0;
2737 mods |= (modifier_set (VK_APPS)) ? APPS_PRESSED : 0;
2738
2739 return mods;
2740 }
2741
2742 static int
2743 w32_get_key_modifiers (unsigned int wparam, unsigned int lparam)
2744 {
2745 int mods;
2746
2747 /* Convert to emacs modifiers. */
2748 mods = w32_kbd_mods_to_emacs (construct_console_modifiers (), wparam);
2749
2750 return mods;
2751 }
2752
2753 unsigned int
2754 map_keypad_keys (unsigned int virt_key, unsigned int extended)
2755 {
2756 if (virt_key < VK_CLEAR || virt_key > VK_DELETE)
2757 return virt_key;
2758
2759 if (virt_key == VK_RETURN)
2760 return (extended ? VK_NUMPAD_ENTER : VK_RETURN);
2761
2762 if (virt_key >= VK_PRIOR && virt_key <= VK_DOWN)
2763 return (!extended ? (VK_NUMPAD_PRIOR + (virt_key - VK_PRIOR)) : virt_key);
2764
2765 if (virt_key == VK_INSERT || virt_key == VK_DELETE)
2766 return (!extended ? (VK_NUMPAD_INSERT + (virt_key - VK_INSERT)) : virt_key);
2767
2768 if (virt_key == VK_CLEAR)
2769 return (!extended ? VK_NUMPAD_CLEAR : virt_key);
2770
2771 return virt_key;
2772 }
2773
2774 /* List of special key combinations which w32 would normally capture,
2775 but Emacs should grab instead. Not directly visible to lisp, to
2776 simplify synchronization. Each item is an integer encoding a virtual
2777 key code and modifier combination to capture.
2778 Note: This code is not used if keyboard hooks are active
2779 (Windows 2000 and later). */
2780 static Lisp_Object w32_grabbed_keys;
2781
2782 #define HOTKEY(vk, mods) make_number (((vk) & 255) | ((mods) << 8))
2783 #define HOTKEY_ID(k) (XFASTINT (k) & 0xbfff)
2784 #define HOTKEY_VK_CODE(k) (XFASTINT (k) & 255)
2785 #define HOTKEY_MODIFIERS(k) (XFASTINT (k) >> 8)
2786
2787 #define RAW_HOTKEY_ID(k) ((k) & 0xbfff)
2788 #define RAW_HOTKEY_VK_CODE(k) ((k) & 255)
2789 #define RAW_HOTKEY_MODIFIERS(k) ((k) >> 8)
2790
2791 /* Register hot-keys for reserved key combinations when Emacs has
2792 keyboard focus, since this is the only way Emacs can receive key
2793 combinations like Alt-Tab which are used by the system. */
2794
2795 static void
2796 register_hot_keys (HWND hwnd)
2797 {
2798 Lisp_Object keylist;
2799
2800 /* Use CONSP, since we are called asynchronously. */
2801 for (keylist = w32_grabbed_keys; CONSP (keylist); keylist = XCDR (keylist))
2802 {
2803 Lisp_Object key = XCAR (keylist);
2804
2805 /* Deleted entries get set to nil. */
2806 if (!INTEGERP (key))
2807 continue;
2808
2809 RegisterHotKey (hwnd, HOTKEY_ID (key),
2810 HOTKEY_MODIFIERS (key), HOTKEY_VK_CODE (key));
2811 }
2812 }
2813
2814 static void
2815 unregister_hot_keys (HWND hwnd)
2816 {
2817 Lisp_Object keylist;
2818
2819 for (keylist = w32_grabbed_keys; CONSP (keylist); keylist = XCDR (keylist))
2820 {
2821 Lisp_Object key = XCAR (keylist);
2822
2823 if (!INTEGERP (key))
2824 continue;
2825
2826 UnregisterHotKey (hwnd, HOTKEY_ID (key));
2827 }
2828 }
2829
2830 #if EMACSDEBUG
2831 const char*
2832 w32_name_of_message (UINT msg)
2833 {
2834 unsigned i;
2835 static char buf[64];
2836 static const struct {
2837 UINT msg;
2838 const char* name;
2839 } msgnames[] = {
2840 #define M(msg) { msg, # msg }
2841 M (WM_PAINT),
2842 M (WM_TIMER),
2843 M (WM_USER),
2844 M (WM_MOUSEMOVE),
2845 M (WM_LBUTTONUP),
2846 M (WM_KEYDOWN),
2847 M (WM_EMACS_KILL),
2848 M (WM_EMACS_CREATEWINDOW),
2849 M (WM_EMACS_DONE),
2850 M (WM_EMACS_CREATEVSCROLLBAR),
2851 M (WM_EMACS_CREATEHSCROLLBAR),
2852 M (WM_EMACS_SHOWWINDOW),
2853 M (WM_EMACS_SETWINDOWPOS),
2854 M (WM_EMACS_DESTROYWINDOW),
2855 M (WM_EMACS_TRACKPOPUPMENU),
2856 M (WM_EMACS_SETFOCUS),
2857 M (WM_EMACS_SETFOREGROUND),
2858 M (WM_EMACS_SETLOCALE),
2859 M (WM_EMACS_SETKEYBOARDLAYOUT),
2860 M (WM_EMACS_REGISTER_HOT_KEY),
2861 M (WM_EMACS_UNREGISTER_HOT_KEY),
2862 M (WM_EMACS_TOGGLE_LOCK_KEY),
2863 M (WM_EMACS_TRACK_CARET),
2864 M (WM_EMACS_DESTROY_CARET),
2865 M (WM_EMACS_SHOW_CARET),
2866 M (WM_EMACS_HIDE_CARET),
2867 M (WM_EMACS_SETCURSOR),
2868 M (WM_EMACS_SHOWCURSOR),
2869 M (WM_EMACS_PAINT),
2870 M (WM_CHAR),
2871 #undef M
2872 { 0, 0 }
2873 };
2874
2875 for (i = 0; msgnames[i].name; ++i)
2876 if (msgnames[i].msg == msg)
2877 return msgnames[i].name;
2878
2879 sprintf (buf, "message 0x%04x", (unsigned)msg);
2880 return buf;
2881 }
2882 #endif /* EMACSDEBUG */
2883
2884 /* Here's an overview of how Emacs input works in GUI sessions on
2885 MS-Windows. (For description of non-GUI input, see the commentary
2886 before w32_console_read_socket in w32inevt.c.)
2887
2888 System messages are read and processed by w32_msg_pump below. This
2889 function runs in a separate thread. It handles a small number of
2890 custom WM_EMACS_* messages (posted by the main thread, look for
2891 PostMessage calls), and dispatches the rest to w32_wnd_proc, which
2892 is the main window procedure for the entire Emacs application.
2893
2894 w32_wnd_proc also runs in the same separate input thread. It
2895 handles some messages, mostly those that need GDI calls, by itself.
2896 For the others, it calls my_post_msg, which inserts the messages
2897 into the input queue serviced by w32_read_socket.
2898
2899 w32_read_socket runs in the main (a.k.a. "Lisp") thread, and is
2900 called synchronously from keyboard.c when it is known or suspected
2901 that some input is available. w32_read_socket either handles
2902 messages immediately, or converts them into Emacs input events and
2903 stuffs them into kbd_buffer, where kbd_buffer_get_event can get at
2904 them and process them when read_char and its callers require
2905 input.
2906
2907 Under Cygwin with the W32 toolkit, the use of /dev/windows with
2908 select(2) takes the place of w32_read_socket.
2909
2910 */
2911
2912 /* Main message dispatch loop. */
2913
2914 static void
2915 w32_msg_pump (deferred_msg * msg_buf)
2916 {
2917 MSG msg;
2918 WPARAM result;
2919 HWND focus_window;
2920
2921 msh_mousewheel = RegisterWindowMessage (MSH_MOUSEWHEEL);
2922
2923 while ((w32_unicode_gui ? GetMessageW : GetMessageA) (&msg, NULL, 0, 0))
2924 {
2925
2926 /* DebPrint (("w32_msg_pump: %s time:%u\n", */
2927 /* w32_name_of_message (msg.message), msg.time)); */
2928
2929 if (msg.hwnd == NULL)
2930 {
2931 switch (msg.message)
2932 {
2933 case WM_NULL:
2934 /* Produced by complete_deferred_msg; just ignore. */
2935 break;
2936 case WM_EMACS_CREATEWINDOW:
2937 /* Initialize COM for this window. Even though we don't use it,
2938 some third party shell extensions can cause it to be used in
2939 system dialogs, which causes a crash if it is not initialized.
2940 This is a known bug in Windows, which was fixed long ago, but
2941 the patch for XP is not publicly available until XP SP3,
2942 and older versions will never be patched. */
2943 CoInitialize (NULL);
2944 w32_createwindow ((struct frame *) msg.wParam,
2945 (int *) msg.lParam);
2946 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
2947 emacs_abort ();
2948 break;
2949 case WM_EMACS_SETLOCALE:
2950 SetThreadLocale (msg.wParam);
2951 /* Reply is not expected. */
2952 break;
2953 case WM_EMACS_SETKEYBOARDLAYOUT:
2954 result = (WPARAM) ActivateKeyboardLayout ((HKL) msg.wParam, 0);
2955 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE,
2956 result, 0))
2957 emacs_abort ();
2958 break;
2959 case WM_EMACS_REGISTER_HOT_KEY:
2960 focus_window = GetFocus ();
2961 if (focus_window != NULL)
2962 RegisterHotKey (focus_window,
2963 RAW_HOTKEY_ID (msg.wParam),
2964 RAW_HOTKEY_MODIFIERS (msg.wParam),
2965 RAW_HOTKEY_VK_CODE (msg.wParam));
2966 /* Reply is not expected. */
2967 break;
2968 case WM_EMACS_UNREGISTER_HOT_KEY:
2969 focus_window = GetFocus ();
2970 if (focus_window != NULL)
2971 UnregisterHotKey (focus_window, RAW_HOTKEY_ID (msg.wParam));
2972 /* Mark item as erased. NB: this code must be
2973 thread-safe. The next line is okay because the cons
2974 cell is never made into garbage and is not relocated by
2975 GC. */
2976 XSETCAR (make_lisp_ptr ((void *)msg.lParam, Lisp_Cons), Qnil);
2977 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
2978 emacs_abort ();
2979 break;
2980 case WM_EMACS_TOGGLE_LOCK_KEY:
2981 {
2982 int vk_code = (int) msg.wParam;
2983 int cur_state = (GetKeyState (vk_code) & 1);
2984 int new_state = msg.lParam;
2985
2986 if (new_state == -1
2987 || ((new_state & 1) != cur_state))
2988 {
2989 one_w32_display_info.faked_key = vk_code;
2990
2991 keybd_event ((BYTE) vk_code,
2992 (BYTE) MapVirtualKey (vk_code, 0),
2993 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
2994 keybd_event ((BYTE) vk_code,
2995 (BYTE) MapVirtualKey (vk_code, 0),
2996 KEYEVENTF_EXTENDEDKEY | 0, 0);
2997 keybd_event ((BYTE) vk_code,
2998 (BYTE) MapVirtualKey (vk_code, 0),
2999 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
3000 cur_state = !cur_state;
3001 }
3002 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE,
3003 cur_state, 0))
3004 emacs_abort ();
3005 }
3006 break;
3007 #ifdef MSG_DEBUG
3008 /* Broadcast messages make it here, so you need to be looking
3009 for something in particular for this to be useful. */
3010 default:
3011 DebPrint (("msg %x not expected by w32_msg_pump\n", msg.message));
3012 #endif
3013 }
3014 }
3015 else
3016 {
3017 if (w32_unicode_gui)
3018 DispatchMessageW (&msg);
3019 else
3020 DispatchMessageA (&msg);
3021 }
3022
3023 /* Exit nested loop when our deferred message has completed. */
3024 if (msg_buf->completed)
3025 break;
3026 }
3027 }
3028
3029 deferred_msg * deferred_msg_head;
3030
3031 static deferred_msg *
3032 find_deferred_msg (HWND hwnd, UINT msg)
3033 {
3034 deferred_msg * item;
3035
3036 /* Don't actually need synchronization for read access, since
3037 modification of single pointer is always atomic. */
3038 /* enter_crit (); */
3039
3040 for (item = deferred_msg_head; item != NULL; item = item->next)
3041 if (item->w32msg.msg.hwnd == hwnd
3042 && item->w32msg.msg.message == msg)
3043 break;
3044
3045 /* leave_crit (); */
3046
3047 return item;
3048 }
3049
3050 static LRESULT
3051 send_deferred_msg (deferred_msg * msg_buf,
3052 HWND hwnd,
3053 UINT msg,
3054 WPARAM wParam,
3055 LPARAM lParam)
3056 {
3057 /* Only input thread can send deferred messages. */
3058 if (GetCurrentThreadId () != dwWindowsThreadId)
3059 emacs_abort ();
3060
3061 /* It is an error to send a message that is already deferred. */
3062 if (find_deferred_msg (hwnd, msg) != NULL)
3063 emacs_abort ();
3064
3065 /* Enforced synchronization is not needed because this is the only
3066 function that alters deferred_msg_head, and the following critical
3067 section is guaranteed to only be serially reentered (since only the
3068 input thread can call us). */
3069
3070 /* enter_crit (); */
3071
3072 msg_buf->completed = 0;
3073 msg_buf->next = deferred_msg_head;
3074 deferred_msg_head = msg_buf;
3075 my_post_msg (&msg_buf->w32msg, hwnd, msg, wParam, lParam);
3076
3077 /* leave_crit (); */
3078
3079 /* Start a new nested message loop to process other messages until
3080 this one is completed. */
3081 w32_msg_pump (msg_buf);
3082
3083 deferred_msg_head = msg_buf->next;
3084
3085 return msg_buf->result;
3086 }
3087
3088 void
3089 complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result)
3090 {
3091 deferred_msg * msg_buf = find_deferred_msg (hwnd, msg);
3092
3093 if (msg_buf == NULL)
3094 /* Message may have been canceled, so don't abort. */
3095 return;
3096
3097 msg_buf->result = result;
3098 msg_buf->completed = 1;
3099
3100 /* Ensure input thread is woken so it notices the completion. */
3101 PostThreadMessage (dwWindowsThreadId, WM_NULL, 0, 0);
3102 }
3103
3104 static void
3105 cancel_all_deferred_msgs (void)
3106 {
3107 deferred_msg * item;
3108
3109 /* Don't actually need synchronization for read access, since
3110 modification of single pointer is always atomic. */
3111 /* enter_crit (); */
3112
3113 for (item = deferred_msg_head; item != NULL; item = item->next)
3114 {
3115 item->result = 0;
3116 item->completed = 1;
3117 }
3118
3119 /* leave_crit (); */
3120
3121 /* Ensure input thread is woken so it notices the completion. */
3122 PostThreadMessage (dwWindowsThreadId, WM_NULL, 0, 0);
3123 }
3124
3125 DWORD WINAPI
3126 w32_msg_worker (void *arg)
3127 {
3128 MSG msg;
3129 deferred_msg dummy_buf;
3130
3131 /* Ensure our message queue is created */
3132
3133 PeekMessage (&msg, NULL, 0, 0, PM_NOREMOVE);
3134
3135 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
3136 emacs_abort ();
3137
3138 memset (&dummy_buf, 0, sizeof (dummy_buf));
3139 dummy_buf.w32msg.msg.hwnd = NULL;
3140 dummy_buf.w32msg.msg.message = WM_NULL;
3141
3142 /* This is the initial message loop which should only exit when the
3143 application quits. */
3144 w32_msg_pump (&dummy_buf);
3145
3146 return 0;
3147 }
3148
3149 static void
3150 signal_user_input (void)
3151 {
3152 /* Interrupt any lisp that wants to be interrupted by input. */
3153 if (!NILP (Vthrow_on_input))
3154 {
3155 Vquit_flag = Vthrow_on_input;
3156 /* Doing a QUIT from this thread is a bad idea, since this
3157 unwinds the stack of the Lisp thread, and the Windows runtime
3158 rightfully barfs. Disabled. */
3159 #if 0
3160 /* If we're inside a function that wants immediate quits,
3161 do it now. */
3162 if (immediate_quit && NILP (Vinhibit_quit))
3163 {
3164 immediate_quit = 0;
3165 QUIT;
3166 }
3167 #endif
3168 }
3169 }
3170
3171
3172 static void
3173 post_character_message (HWND hwnd, UINT msg,
3174 WPARAM wParam, LPARAM lParam,
3175 DWORD modifiers)
3176 {
3177 W32Msg wmsg;
3178
3179 wmsg.dwModifiers = modifiers;
3180
3181 /* Detect quit_char and set quit-flag directly. Note that we
3182 still need to post a message to ensure the main thread will be
3183 woken up if blocked in sys_select, but we do NOT want to post
3184 the quit_char message itself (because it will usually be as if
3185 the user had typed quit_char twice). Instead, we post a dummy
3186 message that has no particular effect. */
3187 {
3188 int c = wParam;
3189 if (isalpha (c) && wmsg.dwModifiers == ctrl_modifier)
3190 c = make_ctrl_char (c) & 0377;
3191 if (c == quit_char
3192 || (wmsg.dwModifiers == 0
3193 && w32_quit_key && wParam == w32_quit_key))
3194 {
3195 Vquit_flag = Qt;
3196
3197 /* The choice of message is somewhat arbitrary, as long as
3198 the main thread handler just ignores it. */
3199 msg = WM_NULL;
3200
3201 /* Interrupt any blocking system calls. */
3202 signal_quit ();
3203
3204 /* As a safety precaution, forcibly complete any deferred
3205 messages. This is a kludge, but I don't see any particularly
3206 clean way to handle the situation where a deferred message is
3207 "dropped" in the lisp thread, and will thus never be
3208 completed, eg. by the user trying to activate the menubar
3209 when the lisp thread is busy, and then typing C-g when the
3210 menubar doesn't open promptly (with the result that the
3211 menubar never responds at all because the deferred
3212 WM_INITMENU message is never completed). Another problem
3213 situation is when the lisp thread calls SendMessage (to send
3214 a window manager command) when a message has been deferred;
3215 the lisp thread gets blocked indefinitely waiting for the
3216 deferred message to be completed, which itself is waiting for
3217 the lisp thread to respond.
3218
3219 Note that we don't want to block the input thread waiting for
3220 a response from the lisp thread (although that would at least
3221 solve the deadlock problem above), because we want to be able
3222 to receive C-g to interrupt the lisp thread. */
3223 cancel_all_deferred_msgs ();
3224 }
3225 else
3226 signal_user_input ();
3227 }
3228
3229 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3230 }
3231
3232 static int
3233 get_wm_chars (HWND aWnd, int *buf, int buflen, int ignore_ctrl, int ctrl,
3234 int *ctrl_cnt, int *is_dead, int vk, int exp)
3235 {
3236 MSG msg;
3237 /* If doubled is at the end, ignore it. */
3238 int i = buflen, doubled = 0, code_unit;
3239
3240 if (ctrl_cnt)
3241 *ctrl_cnt = 0;
3242 if (is_dead)
3243 *is_dead = -1;
3244 eassert (w32_unicode_gui);
3245 while (buflen
3246 /* Should be called only when w32_unicode_gui: */
3247 && PeekMessageW (&msg, aWnd, WM_KEYFIRST, WM_KEYLAST,
3248 PM_NOREMOVE | PM_NOYIELD)
3249 && (msg.message == WM_CHAR || msg.message == WM_SYSCHAR
3250 || msg.message == WM_DEADCHAR || msg.message == WM_SYSDEADCHAR
3251 || msg.message == WM_UNICHAR))
3252 {
3253 /* We extract character payload, but in this call we handle only the
3254 characters which come BEFORE the next keyup/keydown message. */
3255 int dead;
3256
3257 GetMessageW (&msg, aWnd, msg.message, msg.message);
3258 dead = (msg.message == WM_DEADCHAR || msg.message == WM_SYSDEADCHAR);
3259 if (is_dead)
3260 *is_dead = (dead ? msg.wParam : -1);
3261 if (dead)
3262 continue;
3263 code_unit = msg.wParam;
3264 if (doubled)
3265 {
3266 /* Had surrogate. */
3267 if (msg.message == WM_UNICHAR
3268 || code_unit < 0xDC00 || code_unit > 0xDFFF)
3269 { /* Mismatched first surrogate.
3270 Pass both code units as if they were two characters. */
3271 *buf++ = doubled;
3272 if (!--buflen)
3273 return i; /* Drop the 2nd char if at the end of the buffer. */
3274 }
3275 else /* see https://en.wikipedia.org/wiki/UTF-16 */
3276 code_unit = (doubled << 10) + code_unit - 0x35FDC00;
3277 doubled = 0;
3278 }
3279 else if (code_unit >= 0xD800 && code_unit <= 0xDBFF)
3280 {
3281 /* Handle mismatched 2nd surrogate the same as a normal character. */
3282 doubled = code_unit;
3283 continue;
3284 }
3285
3286 /* The only "fake" characters delivered by ToUnicode() or
3287 TranslateMessage() are:
3288 0x01 .. 0x1a for Ctrl-letter, Enter, Tab, Ctrl-Break, Esc, Backspace
3289 0x00 and 0x1b .. 0x1f for Control- []\@^_
3290 0x7f for Control-BackSpace
3291 0x20 for Control-Space */
3292 if (ignore_ctrl
3293 && (code_unit < 0x20 || code_unit == 0x7f
3294 || (code_unit == 0x20 && ctrl)))
3295 {
3296 /* Non-character payload in a WM_CHAR
3297 (Ctrl-something pressed, see above). Ignore, and report. */
3298 if (ctrl_cnt)
3299 (*ctrl_cnt)++;
3300 continue;
3301 }
3302 /* Traditionally, Emacs would ignore the character payload of VK_NUMPAD*
3303 keys, and would treat them later via `function-key-map'. In addition
3304 to usual 102-key NUMPAD keys, this map also treats `kp-'-variants of
3305 space, tab, enter, separator, equal. TAB and EQUAL, apparently,
3306 cannot be generated on Win-GUI branch. ENTER is already handled
3307 by the code above. According to `lispy_function_keys', kp_space is
3308 generated by not-extended VK_CLEAR. (kp-tab != VK_OEM_NEC_EQUAL!).
3309
3310 We do similarly for backward-compatibility, but ignore only the
3311 characters restorable later by `function-key-map'. */
3312 if (code_unit < 0x7f
3313 && ((vk >= VK_NUMPAD0 && vk <= VK_DIVIDE)
3314 || (exp && ((vk >= VK_PRIOR && vk <= VK_DOWN) ||
3315 vk == VK_INSERT || vk == VK_DELETE || vk == VK_CLEAR)))
3316 && strchr ("0123456789/*-+.,", code_unit))
3317 continue;
3318 *buf++ = code_unit;
3319 buflen--;
3320 }
3321 return i - buflen;
3322 }
3323
3324 #ifdef DBG_WM_CHARS
3325 # define FPRINTF_WM_CHARS(ARG) fprintf ARG
3326 #else
3327 # define FPRINTF_WM_CHARS(ARG) (void)0
3328 #endif
3329
3330 /* This is a heuristic only. This is supposed to track the state of the
3331 finite automaton in the language environment of Windows.
3332
3333 However, separate windows (if with the same different language
3334 environments!) should have different values. Moreover, switching to a
3335 non-Emacs window with the same language environment, and using (dead)keys
3336 there would change the value stored in the kernel, but not this value. */
3337 /* A layout may emit deadkey=0. It looks like this would reset the state
3338 of the kernel's finite automaton (equivalent to emiting 0-length string,
3339 which is otherwise impossible in the dead-key map of a layout).
3340 Be ready to treat the case when this delivers WM_(SYS)DEADCHAR. */
3341 static int after_deadkey = -1;
3342
3343 int
3344 deliver_wm_chars (int do_translate, HWND hwnd, UINT msg, UINT wParam,
3345 UINT lParam, int legacy_alt_meta)
3346 {
3347 /* An "old style" keyboard description may assign up to 125 UTF-16 code
3348 points to a keypress.
3349 (However, the "old style" TranslateMessage() would deliver at most 16 of
3350 them.) Be on a safe side, and prepare to treat many more. */
3351 int ctrl_cnt, buf[1024], count, is_dead, after_dead = (after_deadkey > 0);
3352
3353 /* Since the keypress processing logic of Windows has a lot of state, it
3354 is important to call TranslateMessage() for every keyup/keydown, AND
3355 do it exactly once. (The actual change of state is done by
3356 ToUnicode[Ex](), which is called by TranslateMessage(). So one can
3357 call ToUnicode[Ex]() instead.)
3358
3359 The "usual" message pump calls TranslateMessage() for EVERY event.
3360 Emacs calls TranslateMessage() very selectively (is it needed for doing
3361 some tricky stuff with Win95??? With newer Windows, selectiveness is,
3362 most probably, not needed -- and harms a lot).
3363
3364 So, with the usual message pump, the following call to TranslateMessage()
3365 is not needed (and is going to be VERY harmful). With Emacs' message
3366 pump, the call is needed. */
3367 if (do_translate)
3368 {
3369 MSG windows_msg = { hwnd, msg, wParam, lParam, 0, {0,0} };
3370
3371 windows_msg.time = GetMessageTime ();
3372 TranslateMessage (&windows_msg);
3373 }
3374 count = get_wm_chars (hwnd, buf, sizeof (buf)/sizeof (*buf), 1,
3375 /* The message may have been synthesized by
3376 who knows what; be conservative. */
3377 modifier_set (VK_LCONTROL)
3378 || modifier_set (VK_RCONTROL)
3379 || modifier_set (VK_CONTROL),
3380 &ctrl_cnt, &is_dead, wParam,
3381 (lParam & 0x1000000L) != 0);
3382 if (count)
3383 {
3384 W32Msg wmsg;
3385 DWORD console_modifiers = construct_console_modifiers ();
3386 int *b = buf, strip_ExtraMods = 1, hairy = 0;
3387 char *type_CtrlAlt = NULL;
3388
3389 /* XXXX In fact, there may be another case when we need to do the same:
3390 What happens if the string defined in the LIGATURES has length
3391 0? Probably, we will get count==0, but the state of the finite
3392 automaton would reset to 0??? */
3393 after_deadkey = -1;
3394
3395 /* wParam is checked when converting CapsLock to Shift; this is a clone
3396 of w32_get_key_modifiers (). */
3397 wmsg.dwModifiers = w32_kbd_mods_to_emacs (console_modifiers, wParam);
3398
3399 /* What follows is just heuristics; the correct treatement requires
3400 non-destructive ToUnicode():
3401 http://search.cpan.org/~ilyaz/UI-KeyboardLayout/lib/UI/KeyboardLayout.pm#Can_an_application_on_Windows_accept_keyboard_events?_Part_IV:_application-specific_modifiers
3402
3403 What one needs to find is:
3404 * which of the present modifiers AFFECT the resulting char(s)
3405 (so should be stripped, since their EFFECT is "already
3406 taken into account" in the string in buf), and
3407 * which modifiers are not affecting buf, so should be reported to
3408 the application for further treatment.
3409
3410 Example: assume that we know:
3411 (A) lCtrl+rCtrl+rAlt modifiers with VK_A key produce a Latin "f"
3412 ("may be logical" in JCUKEN-flavored Russian keyboard flavors);
3413 (B) removing any of lCtrl, rCtrl, rAlt changes the produced char;
3414 (C) Win-modifier is not affecting the produced character
3415 (this is the common case: happens with all "standard" layouts).
3416
3417 Suppose the user presses Win+lCtrl+rCtrl+rAlt modifiers with VK_A.
3418 What is the intent of the user? We need to guess the intent to decide
3419 which event to deliver to the application.
3420
3421 This looks like a reasonable logic: since Win- modifier doesn't affect
3422 the output string, the user was pressing Win for SOME OTHER purpose.
3423 So the user wanted to generate Win-SOMETHING event. Now, what is
3424 something? If one takes the mantra that "character payload is more
3425 important than the combination of keypresses which resulted in this
3426 payload", then one should ignore lCtrl+rCtrl+rAlt, ignore VK_A, and
3427 assume that the user wanted to generate Win-f.
3428
3429 Unfortunately, without non-destructive ToUnicode(), checking (B),(C)
3430 is out of question. So we use heuristics (hopefully, covering
3431 99.9999% of cases). */
3432
3433 /* Another thing to watch for is a possibility to use AltGr-* and
3434 Ctrl-Alt-* with different semantic.
3435
3436 Background: the layout defining the KLLF_ALTGR bit are treated
3437 specially by the kernel: when VK_RMENU (=rightAlt, =AltGr) is pressed
3438 (released), a press (release) of VK_LCONTROL is emulated (unless Ctrl
3439 is already down). As a result, any press/release of AltGr is seen
3440 by applications as a press/release of lCtrl AND rAlt. This is
3441 applicable, in particular, to ToUnicode[Ex](). (Keyrepeat is covered
3442 the same way!)
3443
3444 NOTE: it IS possible to see bare rAlt even with KLLF_ALTGR; but this
3445 requires a good finger coordination: doing (physically)
3446 Down-lCtrl Down-rAlt Up-lCtrl Down-a
3447 (doing quick enough, so that key repeat of rAlt [which would
3448 generate new "fake" Down-lCtrl events] does not happens before 'a'
3449 is down) results in no "fake" events, so the application will see
3450 only rAlt down when 'a' is pressed. (However, fake Up-lCtrl WILL
3451 be generated when rAlt goes UP.)
3452
3453 In fact, note also that KLLF_ALTGR does not prohibit construction of
3454 rCtrl-rAlt (just press them in this order!).
3455
3456 Moreover: "traditional" layouts do not define distinct modifier-masks
3457 for VK_LMENU and VK_RMENU (same for VK_L/RCONTROL). Instead, they
3458 rely on the KLLF_ALTGR bit to make the behavior of VK_LMENU and
3459 VK_RMENU distinct. As a corollary, for such layouts, the produced
3460 character is the same for AltGr-* (=rAlt-*) and Ctrl-Alt-* (in any
3461 combination of handedness). For description of masks, see
3462
3463 http://search.cpan.org/~ilyaz/UI-KeyboardLayout/lib/UI/KeyboardLayout.pm#Keyboard_input_on_Windows,_Part_I:_what_is_the_kernel_doing?
3464
3465 By default, Emacs was using these coincidences via the following
3466 heuristics: it was treating:
3467 (*) keypresses with lCtrl-rAlt modifiers as if they are carrying
3468 ONLY the character payload (no matter what the actual keyboard
3469 was defining: if lCtrl-lAlt-b was delivering U+05df=beta, then
3470 Emacs saw [beta]; if lCtrl-lAlt-b was undefined in the layout,
3471 the keypress was completely ignored), and
3472 (*) keypresses with the other combinations of handedness of Ctrl-Alt
3473 modifiers (e.g., lCtrl-lAlt) as if they NEVER carry a character
3474 payload (so they were reported "raw": if lCtrl-lAlt-b was
3475 delivering beta, then Emacs saw event [C-A-b], and not [beta]).
3476 This worked good for "traditional" layouts: users could type both
3477 AltGr-x and Ctrl-Alt-x, and one was a character, another a bindable
3478 event.
3479
3480 However, for layouts which deliver different characters for AltGr-x
3481 and lCtrl-lAlt-x, this scheme makes the latter character unaccessible
3482 in Emacs. While it is easy to access functionality of [C-M-x] in
3483 Emacs by other means (for example, by the `controlify' prefix, or
3484 using lCtrl-rCtrl-x, or rCtrl-rAlt-x [in this order]), missing
3485 characters cannot be reconstructed without a tedious manual work. */
3486
3487 /* These two cases are often going to be distinguishable, since at most
3488 one of these character is defined with KBDCTRL | KBDMENU modifier
3489 bitmap. (This heuristic breaks if both lCtrl-lAlt- AND lCtrl-rAlt-
3490 are translated to modifier bitmaps distinct from KBDCTRL | KBDMENU,
3491 or in the cases when lCtrl-lAlt-* and lCtrl-rAlt-* are generally
3492 different, but lCtrl-lAlt-x and lCtrl-rAlt-x happen to deliver the
3493 same character.)
3494
3495 So we have 2 chunks of info:
3496 (A) is it lCtrl-rAlt-, or lCtrl-lAlt, or some other combination?
3497 (B) is the delivered character defined with KBDCTRL | KBDMENU bits?
3498 Basing on (A) and (B), we should decide whether to ignore the
3499 delivered character. (Before, Emacs was completely ignoring (B), and
3500 was treating the 3-state of (A) as a bit.) This means that we have 6
3501 bits of customization.
3502
3503 Additionally, a presence of two Ctrl down may be AltGr-rCtrl-. */
3504
3505 /* Strip all non-Shift modifiers if:
3506 - more than one UTF-16 code point delivered (can't call VkKeyScanW ())
3507 - or the character is a result of combining with a prefix key. */
3508 if (!after_dead && count == 1 && *b < 0x10000)
3509 {
3510 if (console_modifiers & (RIGHT_ALT_PRESSED | LEFT_ALT_PRESSED)
3511 && console_modifiers & (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
3512 {
3513 type_CtrlAlt = "bB"; /* generic bindable Ctrl-Alt- modifiers */
3514 if ((console_modifiers & (LEFT_CTRL_PRESSED | RIGHT_CTRL_PRESSED))
3515 == (LEFT_CTRL_PRESSED | RIGHT_CTRL_PRESSED))
3516 /* double-Ctrl:
3517 e.g. AltGr-rCtrl on some layouts (in this order!) */
3518 type_CtrlAlt = "dD";
3519 else if ((console_modifiers
3520 & (LEFT_CTRL_PRESSED | LEFT_ALT_PRESSED))
3521 == (LEFT_CTRL_PRESSED | LEFT_ALT_PRESSED))
3522 type_CtrlAlt = "lL"; /* Ctrl-Alt- modifiers on the left */
3523 else if (!NILP (Vw32_recognize_altgr)
3524 && ((console_modifiers
3525 & (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED)))
3526 == (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED))
3527 type_CtrlAlt = "gG"; /* modifiers as in AltGr */
3528 }
3529 else if (wmsg.dwModifiers & (alt_modifier | meta_modifier)
3530 || ((console_modifiers
3531 & (LEFT_WIN_PRESSED | RIGHT_WIN_PRESSED
3532 | APPS_PRESSED | SCROLLLOCK_ON))))
3533 {
3534 /* Pure Alt (or combination of Alt, Win, APPS, scrolllock. */
3535 type_CtrlAlt = "aA";
3536 }
3537 if (type_CtrlAlt)
3538 {
3539 /* Out of bound bitmap: */
3540 SHORT r = VkKeyScanW (*b), bitmap = 0x1FF;
3541
3542 FPRINTF_WM_CHARS((stderr, "VkKeyScanW %#06x %#04x\n", (int)r,
3543 wParam));
3544 if ((r & 0xFF) == wParam)
3545 bitmap = r>>8; /* *b is reachable via simple interface */
3546 else
3547 {
3548 /* VkKeyScanW() (essentially) returns the FIRST key with
3549 the specified character; so here the pressed key is the
3550 SECONDARY key producing the character.
3551
3552 Essentially, we have no information about the "role" of
3553 modifiers on this key: which contribute into the
3554 produced character (so "are consumed"), and which are
3555 "extra" (must attache to bindable events).
3556
3557 The default above would consume ALL modifiers, so the
3558 character is reported "as is". However, on many layouts
3559 the ordering of the keys (in the layout table) is not
3560 thought out well, so the "secondary" keys are often those
3561 which the users would prefer to use with Alt-CHAR.
3562 (Moreover - with e.g. Czech-QWERTY - the ASCII
3563 punctuation is accessible from two equally [nu]preferable
3564 AltGr-keys.)
3565
3566 SO: Heuristic: if the reported char is ASCII, AND Meta
3567 modifier is a candidate, behave as if Meta is present
3568 (fallback to the legacy branch; bug#23251).
3569
3570 (This would break layouts
3571 - delivering ASCII characters
3572 - on SECONDARY keys
3573 - with not Shift/AltGr-like modifier combinations.
3574 All 3 conditions together must be pretty exotic
3575 cases - and a workaround exists: use "primary" keys!) */
3576 if (*b < 0x80
3577 && (wmsg.dwModifiers
3578 & (alt_modifier | meta_modifier
3579 | super_modifier | hyper_modifier)))
3580 return 0;
3581 }
3582 if (*type_CtrlAlt == 'a') /* Simple Alt seen */
3583 {
3584 if ((bitmap & ~1) == 0) /* 1: KBDSHIFT */
3585 {
3586 /* In "traditional" layouts, Alt without Ctrl does not
3587 change the delivered character. This detects this
3588 situation; it is safe to report this as Alt-something
3589 -- as opposed to delivering the reported character
3590 without modifiers. */
3591 if (legacy_alt_meta
3592 && *b > 0x7f && ('A' <= wParam && wParam <= 'Z'))
3593 /* For backward-compatibility with older Emacsen, let
3594 this be processed by another branch below (which
3595 would convert it to Alt-Latin char via wParam). */
3596 return 0;
3597 }
3598 else
3599 hairy = 1;
3600 }
3601 /* Check whether the delivered character(s) is accessible via
3602 KBDCTRL | KBDALT ( | KBDSHIFT ) modifier mask (which is 7). */
3603 else if ((bitmap & ~1) != 6)
3604 {
3605 /* The character is not accessible via plain Ctrl-Alt(-Shift)
3606 (which is, probably, same as AltGr) modifiers.
3607 Either it was after a prefix key, or is combined with
3608 modifier keys which we don't see, or there is an asymmetry
3609 between left-hand and right-hand modifiers, or other hairy
3610 stuff. */
3611 hairy = 1;
3612 }
3613 /* The best solution is to delegate these tough (but rarely
3614 needed) choices to the user. Temporarily (???), it is
3615 implemented as C macros.
3616
3617 Essentially, there are 3 things to do: return 0 (handle to the
3618 legacy processing code [ignoring the character payload]; keep
3619 some modifiers (so that they will be processed by the binding
3620 system [on top of the character payload]; strip modifiers [so
3621 that `self-insert' is going to be triggered with the character
3622 payload]).
3623
3624 The default below should cover 99.9999% of cases:
3625 (a) strip Alt- in the hairy case only;
3626 (stripping = not ignoring)
3627 (l) for lAlt-lCtrl, ignore the char in simple cases only;
3628 (g) for what looks like AltGr, ignore the modifiers;
3629 (d) for what looks like lCtrl-rCtrl-Alt (probably
3630 AltGr-rCtrl), ignore the character in simple cases only;
3631 (b) for other cases of Ctrl-Alt, ignore the character in
3632 simple cases only.
3633
3634 Essentially, in all hairy cases, and in looks-like-AltGr case,
3635 we keep the character, ignoring the modifiers. In all the
3636 other cases, we ignore the delivered character. */
3637 #define S_TYPES_TO_IGNORE_CHARACTER_PAYLOAD "aldb"
3638 #define S_TYPES_TO_REPORT_CHARACTER_PAYLOAD_WITH_MODIFIERS ""
3639 if (strchr (S_TYPES_TO_IGNORE_CHARACTER_PAYLOAD,
3640 type_CtrlAlt[hairy]))
3641 return 0;
3642 /* If in neither list, report all the modifiers we see COMBINED
3643 WITH the reported character. */
3644 if (strchr (S_TYPES_TO_REPORT_CHARACTER_PAYLOAD_WITH_MODIFIERS,
3645 type_CtrlAlt[hairy]))
3646 strip_ExtraMods = 0;
3647 }
3648 }
3649 if (strip_ExtraMods)
3650 wmsg.dwModifiers = wmsg.dwModifiers & shift_modifier;
3651
3652 signal_user_input ();
3653 while (count--)
3654 {
3655 FPRINTF_WM_CHARS((stderr, "unichar %#06x\n", *b));
3656 my_post_msg (&wmsg, hwnd, WM_UNICHAR, *b++, lParam);
3657 }
3658 if (!ctrl_cnt) /* Process ALSO as ctrl */
3659 return 1;
3660 else
3661 FPRINTF_WM_CHARS((stderr, "extra ctrl char\n"));
3662 return -1;
3663 }
3664 else if (is_dead >= 0)
3665 {
3666 FPRINTF_WM_CHARS((stderr, "dead %#06x\n", is_dead));
3667 after_deadkey = is_dead;
3668 return 1;
3669 }
3670 return 0;
3671 }
3672
3673 /* Main window procedure */
3674
3675 static LRESULT CALLBACK
3676 w32_wnd_proc (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
3677 {
3678 struct frame *f;
3679 struct w32_display_info *dpyinfo = &one_w32_display_info;
3680 W32Msg wmsg;
3681 int windows_translate;
3682 int key;
3683
3684 /* Note that it is okay to call x_window_to_frame, even though we are
3685 not running in the main lisp thread, because frame deletion
3686 requires the lisp thread to synchronize with this thread. Thus, if
3687 a frame struct is returned, it can be used without concern that the
3688 lisp thread might make it disappear while we are using it.
3689
3690 NB. Walking the frame list in this thread is safe (as long as
3691 writes of Lisp_Object slots are atomic, which they are on Windows).
3692 Although delete-frame can destructively modify the frame list while
3693 we are walking it, a garbage collection cannot occur until after
3694 delete-frame has synchronized with this thread.
3695
3696 It is also safe to use functions that make GDI calls, such as
3697 w32_clear_rect, because these functions must obtain a DC handle
3698 from the frame struct using get_frame_dc which is thread-aware. */
3699
3700 switch (msg)
3701 {
3702 case WM_ERASEBKGND:
3703 f = x_window_to_frame (dpyinfo, hwnd);
3704 if (f)
3705 {
3706 HDC hdc = get_frame_dc (f);
3707 GetUpdateRect (hwnd, &wmsg.rect, FALSE);
3708 w32_clear_rect (f, hdc, &wmsg.rect);
3709 release_frame_dc (f, hdc);
3710
3711 #if defined (W32_DEBUG_DISPLAY)
3712 DebPrint (("WM_ERASEBKGND (frame %p): erasing %d,%d-%d,%d\n",
3713 f,
3714 wmsg.rect.left, wmsg.rect.top,
3715 wmsg.rect.right, wmsg.rect.bottom));
3716 #endif /* W32_DEBUG_DISPLAY */
3717 }
3718 return 1;
3719 case WM_PALETTECHANGED:
3720 /* ignore our own changes */
3721 if ((HWND)wParam != hwnd)
3722 {
3723 f = x_window_to_frame (dpyinfo, hwnd);
3724 if (f)
3725 /* get_frame_dc will realize our palette and force all
3726 frames to be redrawn if needed. */
3727 release_frame_dc (f, get_frame_dc (f));
3728 }
3729 return 0;
3730 case WM_PAINT:
3731 {
3732 PAINTSTRUCT paintStruct;
3733 RECT update_rect;
3734 memset (&update_rect, 0, sizeof (update_rect));
3735
3736 f = x_window_to_frame (dpyinfo, hwnd);
3737 if (f == 0)
3738 {
3739 DebPrint (("WM_PAINT received for unknown window %p\n", hwnd));
3740 return 0;
3741 }
3742
3743 /* MSDN Docs say not to call BeginPaint if GetUpdateRect
3744 fails. Apparently this can happen under some
3745 circumstances. */
3746 if (GetUpdateRect (hwnd, &update_rect, FALSE) || !w32_strict_painting)
3747 {
3748 enter_crit ();
3749 BeginPaint (hwnd, &paintStruct);
3750
3751 /* The rectangles returned by GetUpdateRect and BeginPaint
3752 do not always match. Play it safe by assuming both areas
3753 are invalid. */
3754 UnionRect (&(wmsg.rect), &update_rect, &(paintStruct.rcPaint));
3755
3756 #if defined (W32_DEBUG_DISPLAY)
3757 DebPrint (("WM_PAINT (frame %p): painting %d,%d-%d,%d\n",
3758 f,
3759 wmsg.rect.left, wmsg.rect.top,
3760 wmsg.rect.right, wmsg.rect.bottom));
3761 DebPrint ((" [update region is %d,%d-%d,%d]\n",
3762 update_rect.left, update_rect.top,
3763 update_rect.right, update_rect.bottom));
3764 #endif
3765 EndPaint (hwnd, &paintStruct);
3766 leave_crit ();
3767
3768 /* Change the message type to prevent Windows from
3769 combining WM_PAINT messages in the Lisp thread's queue,
3770 since Windows assumes that each message queue is
3771 dedicated to one frame and does not bother checking
3772 that hwnd matches before combining them. */
3773 my_post_msg (&wmsg, hwnd, WM_EMACS_PAINT, wParam, lParam);
3774
3775 return 0;
3776 }
3777
3778 /* If GetUpdateRect returns 0 (meaning there is no update
3779 region), assume the whole window needs to be repainted. */
3780 GetClientRect (hwnd, &wmsg.rect);
3781 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3782 return 0;
3783 }
3784
3785 case WM_INPUTLANGCHANGE:
3786 /* Inform lisp thread of keyboard layout changes. */
3787 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3788
3789 /* The state of the finite automaton is separate per every input
3790 language environment (so it does not change when one switches
3791 to a different window with the same environment). Moreover,
3792 the experiments show that the state is not remembered when
3793 one switches back to the pre-previous environment. */
3794 after_deadkey = -1;
3795
3796 /* XXXX??? What follows is a COMPLETE misunderstanding of Windows! */
3797
3798 /* Clear dead keys in the keyboard state; for simplicity only
3799 preserve modifier key states. */
3800 {
3801 int i;
3802 BYTE keystate[256];
3803
3804 GetKeyboardState (keystate);
3805 for (i = 0; i < 256; i++)
3806 if (1
3807 && i != VK_SHIFT
3808 && i != VK_LSHIFT
3809 && i != VK_RSHIFT
3810 && i != VK_CAPITAL
3811 && i != VK_NUMLOCK
3812 && i != VK_SCROLL
3813 && i != VK_CONTROL
3814 && i != VK_LCONTROL
3815 && i != VK_RCONTROL
3816 && i != VK_MENU
3817 && i != VK_LMENU
3818 && i != VK_RMENU
3819 && i != VK_LWIN
3820 && i != VK_RWIN)
3821 keystate[i] = 0;
3822 SetKeyboardState (keystate);
3823 }
3824 goto dflt;
3825
3826 case WM_HOTKEY:
3827 /* Synchronize hot keys with normal input. */
3828 PostMessage (hwnd, WM_KEYDOWN, HIWORD (lParam), 0);
3829 return (0);
3830
3831 case WM_KEYUP:
3832 case WM_SYSKEYUP:
3833 record_keyup (wParam, lParam);
3834 goto dflt;
3835
3836 case WM_KEYDOWN:
3837 case WM_SYSKEYDOWN:
3838 /* Ignore keystrokes we fake ourself; see below. */
3839 if (dpyinfo->faked_key == wParam)
3840 {
3841 dpyinfo->faked_key = 0;
3842 /* Make sure TranslateMessage sees them though (as long as
3843 they don't produce WM_CHAR messages). This ensures that
3844 indicator lights are toggled promptly on Windows 9x, for
3845 example. */
3846 if (wParam < 256 && lispy_function_keys[wParam])
3847 {
3848 windows_translate = 1;
3849 goto translate;
3850 }
3851 return 0;
3852 }
3853
3854 /* Synchronize modifiers with current keystroke. */
3855 sync_modifiers ();
3856 record_keydown (wParam, lParam);
3857 if (w32_use_fallback_wm_chars_method)
3858 wParam = map_keypad_keys (wParam, (lParam & 0x1000000L) != 0);
3859
3860 windows_translate = 0;
3861
3862 switch (wParam)
3863 {
3864 case VK_LWIN:
3865 if (!w32_kbdhook_active && NILP (Vw32_pass_lwindow_to_system))
3866 {
3867 /* Prevent system from acting on keyup (which opens the
3868 Start menu if no other key was pressed) by simulating a
3869 press of Space which we will ignore. */
3870 if (GetAsyncKeyState (wParam) & 1)
3871 {
3872 if (NUMBERP (Vw32_phantom_key_code))
3873 key = XUINT (Vw32_phantom_key_code) & 255;
3874 else
3875 key = VK_SPACE;
3876 dpyinfo->faked_key = key;
3877 keybd_event (key, (BYTE) MapVirtualKey (key, 0), 0, 0);
3878 }
3879 }
3880 if (!NILP (Vw32_lwindow_modifier))
3881 return 0;
3882 break;
3883 case VK_RWIN:
3884 if (!w32_kbdhook_active && NILP (Vw32_pass_rwindow_to_system))
3885 {
3886 if (GetAsyncKeyState (wParam) & 1)
3887 {
3888 if (NUMBERP (Vw32_phantom_key_code))
3889 key = XUINT (Vw32_phantom_key_code) & 255;
3890 else
3891 key = VK_SPACE;
3892 dpyinfo->faked_key = key;
3893 keybd_event (key, (BYTE) MapVirtualKey (key, 0), 0, 0);
3894 }
3895 }
3896 if (!NILP (Vw32_rwindow_modifier))
3897 return 0;
3898 break;
3899 case VK_APPS:
3900 if (!NILP (Vw32_apps_modifier))
3901 return 0;
3902 break;
3903 case VK_MENU:
3904 if (NILP (Vw32_pass_alt_to_system))
3905 /* Prevent DefWindowProc from activating the menu bar if an
3906 Alt key is pressed and released by itself. */
3907 return 0;
3908 windows_translate = 1;
3909 break;
3910 case VK_CAPITAL:
3911 /* Decide whether to treat as modifier or function key. */
3912 if (NILP (Vw32_enable_caps_lock))
3913 goto disable_lock_key;
3914 windows_translate = 1;
3915 break;
3916 case VK_NUMLOCK:
3917 /* Decide whether to treat as modifier or function key. */
3918 if (NILP (Vw32_enable_num_lock))
3919 goto disable_lock_key;
3920 windows_translate = 1;
3921 break;
3922 case VK_SCROLL:
3923 /* Decide whether to treat as modifier or function key. */
3924 if (NILP (Vw32_scroll_lock_modifier))
3925 goto disable_lock_key;
3926 windows_translate = 1;
3927 break;
3928 disable_lock_key:
3929 /* Ensure the appropriate lock key state (and indicator light)
3930 remains in the same state. We do this by faking another
3931 press of the relevant key. Apparently, this really is the
3932 only way to toggle the state of the indicator lights. */
3933 dpyinfo->faked_key = wParam;
3934 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3935 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
3936 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3937 KEYEVENTF_EXTENDEDKEY | 0, 0);
3938 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3939 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
3940 /* Ensure indicator lights are updated promptly on Windows 9x
3941 (TranslateMessage apparently does this), after forwarding
3942 input event. */
3943 post_character_message (hwnd, msg, wParam, lParam,
3944 w32_get_key_modifiers (wParam, lParam));
3945 windows_translate = 1;
3946 break;
3947 case VK_CONTROL:
3948 case VK_SHIFT:
3949 case VK_PROCESSKEY: /* Generated by IME. */
3950 windows_translate = 1;
3951 break;
3952 case VK_CANCEL:
3953 /* Windows maps Ctrl-Pause (aka Ctrl-Break) into VK_CANCEL,
3954 which is confusing for purposes of key binding; convert
3955 VK_CANCEL events into VK_PAUSE events. */
3956 wParam = VK_PAUSE;
3957 break;
3958 case VK_PAUSE:
3959 /* Windows maps Ctrl-NumLock into VK_PAUSE, which is confusing
3960 for purposes of key binding; convert these back into
3961 VK_NUMLOCK events, at least when we want to see NumLock key
3962 presses. (Note that there is never any possibility that
3963 VK_PAUSE with Ctrl really is C-Pause as per above.) */
3964 if (NILP (Vw32_enable_num_lock) && modifier_set (VK_CONTROL))
3965 wParam = VK_NUMLOCK;
3966 break;
3967 default:
3968 if (w32_unicode_gui && !w32_use_fallback_wm_chars_method)
3969 {
3970 /* If this event generates characters or deadkeys, do
3971 not interpret it as a "raw combination of modifiers
3972 and keysym". Hide deadkeys, and use the generated
3973 character(s) instead of the keysym. (Backward
3974 compatibility: exceptions for numpad keys generating
3975 0-9 . , / * - +, and for extra-Alt combined with a
3976 non-Latin char.)
3977
3978 Try to not report modifiers which have effect on
3979 which character or deadkey is generated.
3980
3981 Example (contrived): if rightAlt-? generates f (on a
3982 Cyrillic keyboard layout), and Ctrl, leftAlt do not
3983 affect the generated character, one wants to report
3984 Ctrl-leftAlt-f if the user presses
3985 Ctrl-leftAlt-rightAlt-?. */
3986 int res;
3987 #if 0
3988 /* Some of WM_CHAR may be fed to us directly, some are
3989 results of TranslateMessage(). Using 0 as the first
3990 argument (in a separate call) might help us
3991 distinguish these two cases.
3992
3993 However, the keypress feeders would most probably
3994 expect the "standard" message pump, when
3995 TranslateMessage() is called on EVERY KeyDown/KeyUp
3996 event. So they may feed us Down-Ctrl Down-FAKE
3997 Char-o and expect us to recognize it as Ctrl-o.
3998 Using 0 as the first argument would interfere with
3999 this. */
4000 deliver_wm_chars (0, hwnd, msg, wParam, lParam, 1);
4001 #endif
4002 /* Processing the generated WM_CHAR messages *WHILE* we
4003 handle KEYDOWN/UP event is the best choice, since
4004 without any fuss, we know all 3 of: scancode, virtual
4005 keycode, and expansion. (Additionally, one knows
4006 boundaries of expansion of different keypresses.) */
4007 res = deliver_wm_chars (1, hwnd, msg, wParam, lParam, 1);
4008 windows_translate = -(res != 0);
4009 if (res > 0) /* Bound to character(s) or a deadkey */
4010 break;
4011 /* deliver_wm_chars may make some branches after this vestigal. */
4012 }
4013 wParam = map_keypad_keys (wParam, (lParam & 0x1000000L) != 0);
4014 /* If not defined as a function key, change it to a WM_CHAR message. */
4015 if (wParam > 255 || !lispy_function_keys[wParam])
4016 {
4017 DWORD modifiers = construct_console_modifiers ();
4018
4019 if (!NILP (Vw32_recognize_altgr)
4020 && modifier_set (VK_LCONTROL) && modifier_set (VK_RMENU))
4021 {
4022 /* Always let TranslateMessage handle AltGr key chords;
4023 for some reason, ToAscii doesn't always process AltGr
4024 chords correctly. */
4025 windows_translate = 1;
4026 }
4027 else if ((modifiers & (~SHIFT_PRESSED & ~CAPSLOCK_ON)) != 0)
4028 {
4029 /* Handle key chords including any modifiers other
4030 than shift directly, in order to preserve as much
4031 modifier information as possible. */
4032 if ('A' <= wParam && wParam <= 'Z')
4033 {
4034 /* Don't translate modified alphabetic keystrokes,
4035 so the user doesn't need to constantly switch
4036 layout to type control or meta keystrokes when
4037 the normal layout translates alphabetic
4038 characters to non-ascii characters. */
4039 if (!modifier_set (VK_SHIFT))
4040 wParam += ('a' - 'A');
4041 msg = WM_CHAR;
4042 }
4043 else
4044 {
4045 /* Try to handle other keystrokes by determining the
4046 base character (ie. translating the base key plus
4047 shift modifier). */
4048 int add;
4049 KEY_EVENT_RECORD key;
4050
4051 key.bKeyDown = TRUE;
4052 key.wRepeatCount = 1;
4053 key.wVirtualKeyCode = wParam;
4054 key.wVirtualScanCode = (lParam & 0xFF0000) >> 16;
4055 key.uChar.AsciiChar = 0;
4056 key.dwControlKeyState = modifiers;
4057
4058 add = w32_kbd_patch_key (&key, w32_keyboard_codepage);
4059 /* 0 means an unrecognized keycode, negative means
4060 dead key. Ignore both. */
4061 while (--add >= 0)
4062 {
4063 /* Forward asciified character sequence. */
4064 post_character_message
4065 (hwnd, WM_CHAR,
4066 (unsigned char) key.uChar.AsciiChar, lParam,
4067 w32_get_key_modifiers (wParam, lParam));
4068 w32_kbd_patch_key (&key, w32_keyboard_codepage);
4069 }
4070 return 0;
4071 }
4072 }
4073 else
4074 {
4075 /* Let TranslateMessage handle everything else. */
4076 windows_translate = 1;
4077 }
4078 }
4079 }
4080
4081 if (windows_translate == -1)
4082 break;
4083 translate:
4084 if (windows_translate)
4085 {
4086 MSG windows_msg = { hwnd, msg, wParam, lParam, 0, {0,0} };
4087 windows_msg.time = GetMessageTime ();
4088 TranslateMessage (&windows_msg);
4089 goto dflt;
4090 }
4091
4092 /* Fall through */
4093
4094 case WM_SYSCHAR:
4095 case WM_CHAR:
4096 if (wParam > 255 )
4097 {
4098 W32Msg wmsg;
4099
4100 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
4101 signal_user_input ();
4102 my_post_msg (&wmsg, hwnd, WM_UNICHAR, wParam, lParam);
4103
4104 }
4105 else
4106 post_character_message (hwnd, msg, wParam, lParam,
4107 w32_get_key_modifiers (wParam, lParam));
4108 break;
4109
4110 case WM_UNICHAR:
4111 /* WM_UNICHAR looks promising from the docs, but the exact
4112 circumstances in which TranslateMessage sends it is one of those
4113 Microsoft secret API things that EU and US courts are supposed
4114 to have put a stop to already. Spy++ shows it being sent to Notepad
4115 and other MS apps, but never to Emacs.
4116
4117 Some third party IMEs send it in accordance with the official
4118 documentation though, so handle it here.
4119
4120 UNICODE_NOCHAR is used to test for support for this message.
4121 TRUE indicates that the message is supported. */
4122 if (wParam == UNICODE_NOCHAR)
4123 return TRUE;
4124
4125 {
4126 W32Msg wmsg;
4127 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
4128 signal_user_input ();
4129 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4130 }
4131 break;
4132
4133 case WM_IME_CHAR:
4134 /* If we can't get the IME result as Unicode, use default processing,
4135 which will at least allow characters decodable in the system locale
4136 get through. */
4137 if (!get_composition_string_fn)
4138 goto dflt;
4139
4140 else if (!ignore_ime_char)
4141 {
4142 wchar_t * buffer;
4143 int size, i;
4144 W32Msg wmsg;
4145 HIMC context = get_ime_context_fn (hwnd);
4146 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
4147 /* Get buffer size. */
4148 size = get_composition_string_fn (context, GCS_RESULTSTR, NULL, 0);
4149 buffer = alloca (size);
4150 size = get_composition_string_fn (context, GCS_RESULTSTR,
4151 buffer, size);
4152 release_ime_context_fn (hwnd, context);
4153
4154 signal_user_input ();
4155 for (i = 0; i < size / sizeof (wchar_t); i++)
4156 {
4157 my_post_msg (&wmsg, hwnd, WM_UNICHAR, (WPARAM) buffer[i],
4158 lParam);
4159 }
4160 /* Ignore the messages for the rest of the
4161 characters in the string that was output above. */
4162 ignore_ime_char = (size / sizeof (wchar_t)) - 1;
4163 }
4164 else
4165 ignore_ime_char--;
4166
4167 break;
4168
4169 case WM_IME_STARTCOMPOSITION:
4170 if (!set_ime_composition_window_fn)
4171 goto dflt;
4172 else
4173 {
4174 COMPOSITIONFORM form;
4175 HIMC context;
4176 struct window *w;
4177
4178 /* Implementation note: The code below does something that
4179 one shouldn't do: it accesses the window object from a
4180 separate thread, while the main (a.k.a. "Lisp") thread
4181 runs and can legitimately delete and even GC it. That is
4182 why we are extra careful not to futz with a window that
4183 is different from the one recorded when the system caret
4184 coordinates were last modified. That is also why we are
4185 careful not to move the IME window if the window
4186 described by W was deleted, as indicated by its buffer
4187 field being reset to nil. */
4188 f = x_window_to_frame (dpyinfo, hwnd);
4189 if (!(f && FRAME_LIVE_P (f)))
4190 goto dflt;
4191 w = XWINDOW (FRAME_SELECTED_WINDOW (f));
4192 /* Punt if someone changed the frame's selected window
4193 behind our back. */
4194 if (w != w32_system_caret_window)
4195 goto dflt;
4196
4197 form.dwStyle = CFS_RECT;
4198 form.ptCurrentPos.x = w32_system_caret_x;
4199 form.ptCurrentPos.y = w32_system_caret_y;
4200
4201 form.rcArea.left = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, 0);
4202 form.rcArea.top = (WINDOW_TOP_EDGE_Y (w)
4203 + w32_system_caret_hdr_height);
4204 form.rcArea.right = (WINDOW_BOX_RIGHT_EDGE_X (w)
4205 - WINDOW_RIGHT_MARGIN_WIDTH (w)
4206 - WINDOW_RIGHT_FRINGE_WIDTH (w));
4207 form.rcArea.bottom = (WINDOW_BOTTOM_EDGE_Y (w)
4208 - WINDOW_BOTTOM_DIVIDER_WIDTH (w)
4209 - w32_system_caret_mode_height);
4210
4211 /* Punt if the window was deleted behind our back. */
4212 if (!BUFFERP (w->contents))
4213 goto dflt;
4214
4215 context = get_ime_context_fn (hwnd);
4216
4217 if (!context)
4218 goto dflt;
4219
4220 set_ime_composition_window_fn (context, &form);
4221 release_ime_context_fn (hwnd, context);
4222 }
4223 /* We should "goto dflt" here to pass WM_IME_STARTCOMPOSITION to
4224 DefWindowProc, so that the composition window will actually
4225 be displayed. But doing so causes trouble with displaying
4226 dialog boxes, such as the file selection dialog or font
4227 selection dialog. So something else is needed to fix the
4228 former without breaking the latter. See bug#11732. */
4229 break;
4230
4231 case WM_IME_ENDCOMPOSITION:
4232 ignore_ime_char = 0;
4233 goto dflt;
4234
4235 /* Simulate middle mouse button events when left and right buttons
4236 are used together, but only if user has two button mouse. */
4237 case WM_LBUTTONDOWN:
4238 case WM_RBUTTONDOWN:
4239 if (w32_num_mouse_buttons > 2)
4240 goto handle_plain_button;
4241
4242 {
4243 int this = (msg == WM_LBUTTONDOWN) ? LMOUSE : RMOUSE;
4244 int other = (msg == WM_LBUTTONDOWN) ? RMOUSE : LMOUSE;
4245
4246 if (button_state & this)
4247 return 0;
4248
4249 if (button_state == 0)
4250 SetCapture (hwnd);
4251
4252 button_state |= this;
4253
4254 if (button_state & other)
4255 {
4256 if (mouse_button_timer)
4257 {
4258 KillTimer (hwnd, mouse_button_timer);
4259 mouse_button_timer = 0;
4260
4261 /* Generate middle mouse event instead. */
4262 msg = WM_MBUTTONDOWN;
4263 button_state |= MMOUSE;
4264 }
4265 else if (button_state & MMOUSE)
4266 {
4267 /* Ignore button event if we've already generated a
4268 middle mouse down event. This happens if the
4269 user releases and press one of the two buttons
4270 after we've faked a middle mouse event. */
4271 return 0;
4272 }
4273 else
4274 {
4275 /* Flush out saved message. */
4276 post_msg (&saved_mouse_button_msg);
4277 }
4278 wmsg.dwModifiers = w32_get_modifiers ();
4279 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4280 signal_user_input ();
4281
4282 /* Clear message buffer. */
4283 saved_mouse_button_msg.msg.hwnd = 0;
4284 }
4285 else
4286 {
4287 /* Hold onto message for now. */
4288 mouse_button_timer =
4289 SetTimer (hwnd, MOUSE_BUTTON_ID,
4290 w32_mouse_button_tolerance, NULL);
4291 saved_mouse_button_msg.msg.hwnd = hwnd;
4292 saved_mouse_button_msg.msg.message = msg;
4293 saved_mouse_button_msg.msg.wParam = wParam;
4294 saved_mouse_button_msg.msg.lParam = lParam;
4295 saved_mouse_button_msg.msg.time = GetMessageTime ();
4296 saved_mouse_button_msg.dwModifiers = w32_get_modifiers ();
4297 }
4298 }
4299 return 0;
4300
4301 case WM_LBUTTONUP:
4302 case WM_RBUTTONUP:
4303 if (w32_num_mouse_buttons > 2)
4304 goto handle_plain_button;
4305
4306 {
4307 int this = (msg == WM_LBUTTONUP) ? LMOUSE : RMOUSE;
4308 int other = (msg == WM_LBUTTONUP) ? RMOUSE : LMOUSE;
4309
4310 if ((button_state & this) == 0)
4311 return 0;
4312
4313 button_state &= ~this;
4314
4315 if (button_state & MMOUSE)
4316 {
4317 /* Only generate event when second button is released. */
4318 if ((button_state & other) == 0)
4319 {
4320 msg = WM_MBUTTONUP;
4321 button_state &= ~MMOUSE;
4322
4323 if (button_state) emacs_abort ();
4324 }
4325 else
4326 return 0;
4327 }
4328 else
4329 {
4330 /* Flush out saved message if necessary. */
4331 if (saved_mouse_button_msg.msg.hwnd)
4332 {
4333 post_msg (&saved_mouse_button_msg);
4334 }
4335 }
4336 wmsg.dwModifiers = w32_get_modifiers ();
4337 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4338 signal_user_input ();
4339
4340 /* Always clear message buffer and cancel timer. */
4341 saved_mouse_button_msg.msg.hwnd = 0;
4342 KillTimer (hwnd, mouse_button_timer);
4343 mouse_button_timer = 0;
4344
4345 if (button_state == 0)
4346 ReleaseCapture ();
4347 }
4348 return 0;
4349
4350 case WM_XBUTTONDOWN:
4351 case WM_XBUTTONUP:
4352 if (w32_pass_extra_mouse_buttons_to_system)
4353 goto dflt;
4354 /* else fall through and process them. */
4355 case WM_MBUTTONDOWN:
4356 case WM_MBUTTONUP:
4357 handle_plain_button:
4358 {
4359 BOOL up;
4360 int button;
4361
4362 /* Ignore middle and extra buttons as long as the menu is active. */
4363 f = x_window_to_frame (dpyinfo, hwnd);
4364 if (f && f->output_data.w32->menubar_active)
4365 return 0;
4366
4367 if (parse_button (msg, HIWORD (wParam), &button, &up))
4368 {
4369 if (up) ReleaseCapture ();
4370 else SetCapture (hwnd);
4371 button = (button == 0) ? LMOUSE :
4372 ((button == 1) ? MMOUSE : RMOUSE);
4373 if (up)
4374 button_state &= ~button;
4375 else
4376 button_state |= button;
4377 }
4378 }
4379
4380 wmsg.dwModifiers = w32_get_modifiers ();
4381 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4382 signal_user_input ();
4383
4384 /* Need to return true for XBUTTON messages, false for others,
4385 to indicate that we processed the message. */
4386 return (msg == WM_XBUTTONDOWN || msg == WM_XBUTTONUP);
4387
4388 case WM_MOUSEMOVE:
4389 f = x_window_to_frame (dpyinfo, hwnd);
4390 if (f)
4391 {
4392 /* Ignore mouse movements as long as the menu is active.
4393 These movements are processed by the window manager
4394 anyway, and it's wrong to handle them as if they happened
4395 on the underlying frame. */
4396 if (f->output_data.w32->menubar_active)
4397 return 0;
4398
4399 /* If the mouse moved, and the mouse pointer is invisible,
4400 make it visible again. We do this here so as to be able
4401 to show the mouse pointer even when the main
4402 (a.k.a. "Lisp") thread is busy doing something. */
4403 static int last_x, last_y;
4404 int x = GET_X_LPARAM (lParam);
4405 int y = GET_Y_LPARAM (lParam);
4406
4407 if (f->pointer_invisible
4408 && (x != last_x || y != last_y))
4409 f->pointer_invisible = false;
4410
4411 last_x = x;
4412 last_y = y;
4413 }
4414
4415 /* If the mouse has just moved into the frame, start tracking
4416 it, so we will be notified when it leaves the frame. Mouse
4417 tracking only works under W98 and NT4 and later. On earlier
4418 versions, there is no way of telling when the mouse leaves the
4419 frame, so we just have to put up with help-echo and mouse
4420 highlighting remaining while the frame is not active. */
4421 if (track_mouse_event_fn && !track_mouse_window
4422 /* If the menu bar is active, turning on tracking of mouse
4423 movement events might send these events to the tooltip
4424 frame, if the user happens to move the mouse pointer over
4425 the tooltip. But since we don't process events for
4426 tooltip frames, this causes Windows to present a
4427 hourglass cursor, which is ugly and unexpected. So don't
4428 enable tracking mouse events in this case; they will be
4429 restarted when the menu pops down. (Confusingly, the
4430 menubar_active member of f->output_data.w32, tested
4431 above, is only set when a menu was popped up _not_ from
4432 the frame's menu bar, but via x-popup-menu.) */
4433 && !menubar_in_use)
4434 {
4435 TRACKMOUSEEVENT tme;
4436 tme.cbSize = sizeof (tme);
4437 tme.dwFlags = TME_LEAVE;
4438 tme.hwndTrack = hwnd;
4439 tme.dwHoverTime = HOVER_DEFAULT;
4440
4441 track_mouse_event_fn (&tme);
4442 track_mouse_window = hwnd;
4443 }
4444 case WM_HSCROLL:
4445 case WM_VSCROLL:
4446 if (w32_mouse_move_interval <= 0
4447 || (msg == WM_MOUSEMOVE && button_state == 0))
4448 {
4449 wmsg.dwModifiers = w32_get_modifiers ();
4450 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4451 return 0;
4452 }
4453
4454 /* Hang onto mouse move and scroll messages for a bit, to avoid
4455 sending such events to Emacs faster than it can process them.
4456 If we get more events before the timer from the first message
4457 expires, we just replace the first message. */
4458
4459 if (saved_mouse_move_msg.msg.hwnd == 0)
4460 mouse_move_timer =
4461 SetTimer (hwnd, MOUSE_MOVE_ID,
4462 w32_mouse_move_interval, NULL);
4463
4464 /* Hold onto message for now. */
4465 saved_mouse_move_msg.msg.hwnd = hwnd;
4466 saved_mouse_move_msg.msg.message = msg;
4467 saved_mouse_move_msg.msg.wParam = wParam;
4468 saved_mouse_move_msg.msg.lParam = lParam;
4469 saved_mouse_move_msg.msg.time = GetMessageTime ();
4470 saved_mouse_move_msg.dwModifiers = w32_get_modifiers ();
4471
4472 return 0;
4473
4474 case WM_MOUSEWHEEL:
4475 case WM_DROPFILES:
4476 wmsg.dwModifiers = w32_get_modifiers ();
4477 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4478 signal_user_input ();
4479 return 0;
4480
4481 case WM_APPCOMMAND:
4482 if (w32_pass_multimedia_buttons_to_system)
4483 goto dflt;
4484 /* Otherwise, pass to lisp, the same way we do with mousehwheel. */
4485 case WM_MOUSEHWHEEL:
4486 wmsg.dwModifiers = w32_get_modifiers ();
4487 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4488 signal_user_input ();
4489 /* Non-zero must be returned when WM_MOUSEHWHEEL messages are
4490 handled, to prevent the system trying to handle it by faking
4491 scroll bar events. */
4492 return 1;
4493
4494 case WM_TIMER:
4495 /* Flush out saved messages if necessary. */
4496 if (wParam == mouse_button_timer)
4497 {
4498 if (saved_mouse_button_msg.msg.hwnd)
4499 {
4500 post_msg (&saved_mouse_button_msg);
4501 signal_user_input ();
4502 saved_mouse_button_msg.msg.hwnd = 0;
4503 }
4504 KillTimer (hwnd, mouse_button_timer);
4505 mouse_button_timer = 0;
4506 }
4507 else if (wParam == mouse_move_timer)
4508 {
4509 if (saved_mouse_move_msg.msg.hwnd)
4510 {
4511 post_msg (&saved_mouse_move_msg);
4512 saved_mouse_move_msg.msg.hwnd = 0;
4513 }
4514 KillTimer (hwnd, mouse_move_timer);
4515 mouse_move_timer = 0;
4516 }
4517 else if (wParam == menu_free_timer)
4518 {
4519 KillTimer (hwnd, menu_free_timer);
4520 menu_free_timer = 0;
4521 f = x_window_to_frame (dpyinfo, hwnd);
4522 /* If a popup menu is active, don't wipe its strings. */
4523 if (menubar_in_use
4524 && current_popup_menu == NULL)
4525 {
4526 /* Free memory used by owner-drawn and help-echo strings. */
4527 w32_free_menu_strings (hwnd);
4528 if (f)
4529 f->output_data.w32->menubar_active = 0;
4530 menubar_in_use = 0;
4531 }
4532 }
4533 return 0;
4534
4535 case WM_NCACTIVATE:
4536 /* Windows doesn't send us focus messages when putting up and
4537 taking down a system popup dialog as for Ctrl-Alt-Del on Windows 95.
4538 The only indication we get that something happened is receiving
4539 this message afterwards. So this is a good time to reset our
4540 keyboard modifiers' state. */
4541 reset_modifiers ();
4542 goto dflt;
4543
4544 case WM_INITMENU:
4545 button_state = 0;
4546 ReleaseCapture ();
4547 /* We must ensure menu bar is fully constructed and up to date
4548 before allowing user interaction with it. To achieve this
4549 we send this message to the lisp thread and wait for a
4550 reply (whose value is not actually needed) to indicate that
4551 the menu bar is now ready for use, so we can now return.
4552
4553 To remain responsive in the meantime, we enter a nested message
4554 loop that can process all other messages.
4555
4556 However, we skip all this if the message results from calling
4557 TrackPopupMenu - in fact, we must NOT attempt to send the lisp
4558 thread a message because it is blocked on us at this point. We
4559 set menubar_active before calling TrackPopupMenu to indicate
4560 this (there is no possibility of confusion with real menubar
4561 being active). */
4562
4563 f = x_window_to_frame (dpyinfo, hwnd);
4564 if (f
4565 && (f->output_data.w32->menubar_active
4566 /* We can receive this message even in the absence of a
4567 menubar (ie. when the system menu is activated) - in this
4568 case we do NOT want to forward the message, otherwise it
4569 will cause the menubar to suddenly appear when the user
4570 had requested it to be turned off! */
4571 || f->output_data.w32->menubar_widget == NULL))
4572 return 0;
4573
4574 {
4575 deferred_msg msg_buf;
4576
4577 /* Detect if message has already been deferred; in this case
4578 we cannot return any sensible value to ignore this. */
4579 if (find_deferred_msg (hwnd, msg) != NULL)
4580 emacs_abort ();
4581
4582 menubar_in_use = 1;
4583
4584 return send_deferred_msg (&msg_buf, hwnd, msg, wParam, lParam);
4585 }
4586
4587 case WM_EXITMENULOOP:
4588 f = x_window_to_frame (dpyinfo, hwnd);
4589
4590 /* If a menu is still active, check again after a short delay,
4591 since Windows often (always?) sends the WM_EXITMENULOOP
4592 before the corresponding WM_COMMAND message.
4593 Don't do this if a popup menu is active, since it is only
4594 menubar menus that require cleaning up in this way.
4595 */
4596 if (f && menubar_in_use && current_popup_menu == NULL)
4597 menu_free_timer = SetTimer (hwnd, MENU_FREE_ID, MENU_FREE_DELAY, NULL);
4598
4599 /* If hourglass cursor should be displayed, display it now. */
4600 if (f && f->output_data.w32->hourglass_p)
4601 SetCursor (f->output_data.w32->hourglass_cursor);
4602
4603 goto dflt;
4604
4605 case WM_MENUSELECT:
4606 /* Direct handling of help_echo in menus. Should be safe now
4607 that we generate the help_echo by placing a help event in the
4608 keyboard buffer. */
4609 {
4610 HMENU menu = (HMENU) lParam;
4611 UINT menu_item = (UINT) LOWORD (wParam);
4612 UINT flags = (UINT) HIWORD (wParam);
4613
4614 w32_menu_display_help (hwnd, menu, menu_item, flags);
4615 }
4616 return 0;
4617
4618 case WM_MEASUREITEM:
4619 f = x_window_to_frame (dpyinfo, hwnd);
4620 if (f)
4621 {
4622 MEASUREITEMSTRUCT * pMis = (MEASUREITEMSTRUCT *) lParam;
4623
4624 if (pMis->CtlType == ODT_MENU)
4625 {
4626 /* Work out dimensions for popup menu titles. */
4627 char * title = (char *) pMis->itemData;
4628 HDC hdc = GetDC (hwnd);
4629 HFONT menu_font = GetCurrentObject (hdc, OBJ_FONT);
4630 LOGFONT menu_logfont;
4631 HFONT old_font;
4632 SIZE size;
4633
4634 GetObject (menu_font, sizeof (menu_logfont), &menu_logfont);
4635 menu_logfont.lfWeight = FW_BOLD;
4636 menu_font = CreateFontIndirect (&menu_logfont);
4637 old_font = SelectObject (hdc, menu_font);
4638
4639 pMis->itemHeight = GetSystemMetrics (SM_CYMENUSIZE);
4640 if (title)
4641 {
4642 if (unicode_append_menu)
4643 GetTextExtentPoint32W (hdc, (WCHAR *) title,
4644 wcslen ((WCHAR *) title),
4645 &size);
4646 else
4647 GetTextExtentPoint32 (hdc, title, strlen (title), &size);
4648
4649 pMis->itemWidth = size.cx;
4650 if (pMis->itemHeight < size.cy)
4651 pMis->itemHeight = size.cy;
4652 }
4653 else
4654 pMis->itemWidth = 0;
4655
4656 SelectObject (hdc, old_font);
4657 DeleteObject (menu_font);
4658 ReleaseDC (hwnd, hdc);
4659 return TRUE;
4660 }
4661 }
4662 return 0;
4663
4664 case WM_DRAWITEM:
4665 f = x_window_to_frame (dpyinfo, hwnd);
4666 if (f)
4667 {
4668 DRAWITEMSTRUCT * pDis = (DRAWITEMSTRUCT *) lParam;
4669
4670 if (pDis->CtlType == ODT_MENU)
4671 {
4672 /* Draw popup menu title. */
4673 char * title = (char *) pDis->itemData;
4674 if (title)
4675 {
4676 HDC hdc = pDis->hDC;
4677 HFONT menu_font = GetCurrentObject (hdc, OBJ_FONT);
4678 LOGFONT menu_logfont;
4679 HFONT old_font;
4680
4681 GetObject (menu_font, sizeof (menu_logfont), &menu_logfont);
4682 menu_logfont.lfWeight = FW_BOLD;
4683 menu_font = CreateFontIndirect (&menu_logfont);
4684 old_font = SelectObject (hdc, menu_font);
4685
4686 /* Always draw title as if not selected. */
4687 if (unicode_append_menu)
4688 ExtTextOutW (hdc,
4689 pDis->rcItem.left
4690 + GetSystemMetrics (SM_CXMENUCHECK),
4691 pDis->rcItem.top,
4692 ETO_OPAQUE, &pDis->rcItem,
4693 (WCHAR *) title,
4694 wcslen ((WCHAR *) title), NULL);
4695 else
4696 ExtTextOut (hdc,
4697 pDis->rcItem.left
4698 + GetSystemMetrics (SM_CXMENUCHECK),
4699 pDis->rcItem.top,
4700 ETO_OPAQUE, &pDis->rcItem,
4701 title, strlen (title), NULL);
4702
4703 SelectObject (hdc, old_font);
4704 DeleteObject (menu_font);
4705 }
4706 return TRUE;
4707 }
4708 }
4709 return 0;
4710
4711 #if 0
4712 /* Still not right - can't distinguish between clicks in the
4713 client area of the frame from clicks forwarded from the scroll
4714 bars - may have to hook WM_NCHITTEST to remember the mouse
4715 position and then check if it is in the client area ourselves. */
4716 case WM_MOUSEACTIVATE:
4717 /* Discard the mouse click that activates a frame, allowing the
4718 user to click anywhere without changing point (or worse!).
4719 Don't eat mouse clicks on scrollbars though!! */
4720 if (LOWORD (lParam) == HTCLIENT )
4721 return MA_ACTIVATEANDEAT;
4722 goto dflt;
4723 #endif
4724
4725 case WM_MOUSELEAVE:
4726 /* No longer tracking mouse. */
4727 track_mouse_window = NULL;
4728
4729 case WM_ACTIVATEAPP:
4730 case WM_ACTIVATE:
4731 case WM_WINDOWPOSCHANGED:
4732 case WM_SHOWWINDOW:
4733 /* Inform lisp thread that a frame might have just been obscured
4734 or exposed, so should recheck visibility of all frames. */
4735 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4736 goto dflt;
4737
4738 case WM_SETFOCUS:
4739 dpyinfo->faked_key = 0;
4740 reset_modifiers ();
4741 if (!w32_kbdhook_active)
4742 register_hot_keys (hwnd);
4743 goto command;
4744 case WM_KILLFOCUS:
4745 if (!w32_kbdhook_active)
4746 unregister_hot_keys (hwnd);
4747 button_state = 0;
4748 ReleaseCapture ();
4749 /* Relinquish the system caret. */
4750 if (w32_system_caret_hwnd)
4751 {
4752 w32_visible_system_caret_hwnd = NULL;
4753 w32_system_caret_hwnd = NULL;
4754 DestroyCaret ();
4755 }
4756 goto command;
4757 case WM_COMMAND:
4758 menubar_in_use = 0;
4759 f = x_window_to_frame (dpyinfo, hwnd);
4760 if (f && HIWORD (wParam) == 0)
4761 {
4762 if (menu_free_timer)
4763 {
4764 KillTimer (hwnd, menu_free_timer);
4765 menu_free_timer = 0;
4766 }
4767 }
4768 case WM_MOVE:
4769 case WM_SIZE:
4770 command:
4771 wmsg.dwModifiers = w32_get_modifiers ();
4772 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4773 goto dflt;
4774
4775 #ifdef WINDOWSNT
4776 case WM_CREATE:
4777 setup_w32_kbdhook ();
4778 goto dflt;
4779 #endif
4780
4781 case WM_DESTROY:
4782 #ifdef WINDOWSNT
4783 remove_w32_kbdhook ();
4784 #endif
4785 CoUninitialize ();
4786 return 0;
4787
4788 case WM_WTSSESSION_CHANGE:
4789 if (wParam == WTS_SESSION_LOCK)
4790 reset_w32_kbdhook_state ();
4791 goto dflt;
4792
4793 case WM_CLOSE:
4794 wmsg.dwModifiers = w32_get_modifiers ();
4795 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4796 return 0;
4797
4798 case WM_ENDSESSION:
4799 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4800 /* If we return, the process will be terminated immediately. */
4801 sleep (1000);
4802
4803 case WM_WINDOWPOSCHANGING:
4804 /* Don't restrict the sizing of any kind of frames. If the window
4805 manager doesn't, there's no reason to do it ourselves. */
4806 return 0;
4807
4808 case WM_GETMINMAXINFO:
4809 /* Hack to allow resizing the Emacs frame above the screen size.
4810 Note that Windows 9x limits coordinates to 16-bits. */
4811 ((LPMINMAXINFO) lParam)->ptMaxTrackSize.x = 32767;
4812 ((LPMINMAXINFO) lParam)->ptMaxTrackSize.y = 32767;
4813 return 0;
4814
4815 case WM_SETCURSOR:
4816 if (LOWORD (lParam) == HTCLIENT)
4817 {
4818 f = x_window_to_frame (dpyinfo, hwnd);
4819 if (f)
4820 {
4821 if (f->output_data.w32->hourglass_p
4822 && !menubar_in_use && !current_popup_menu)
4823 SetCursor (f->output_data.w32->hourglass_cursor);
4824 else if (f->pointer_invisible)
4825 SetCursor (NULL);
4826 else
4827 SetCursor (f->output_data.w32->current_cursor);
4828 }
4829
4830 return 0;
4831 }
4832 goto dflt;
4833
4834 case WM_EMACS_SETCURSOR:
4835 {
4836 Cursor cursor = (Cursor) wParam;
4837 f = x_window_to_frame (dpyinfo, hwnd);
4838 if (f && cursor)
4839 {
4840 f->output_data.w32->current_cursor = cursor;
4841 /* Don't change the cursor while menu-bar menu is in use. */
4842 if (!f->output_data.w32->menubar_active
4843 && !f->output_data.w32->hourglass_p)
4844 {
4845 if (f->pointer_invisible)
4846 SetCursor (NULL);
4847 else
4848 SetCursor (cursor);
4849 }
4850 }
4851 return 0;
4852 }
4853
4854 case WM_EMACS_SHOWCURSOR:
4855 {
4856 ShowCursor ((BOOL) wParam);
4857
4858 return 0;
4859 }
4860
4861 case WM_EMACS_CREATEVSCROLLBAR:
4862 return (LRESULT) w32_createvscrollbar ((struct frame *) wParam,
4863 (struct scroll_bar *) lParam);
4864
4865 case WM_EMACS_CREATEHSCROLLBAR:
4866 return (LRESULT) w32_createhscrollbar ((struct frame *) wParam,
4867 (struct scroll_bar *) lParam);
4868
4869 case WM_EMACS_SHOWWINDOW:
4870 return ShowWindow ((HWND) wParam, (WPARAM) lParam);
4871
4872 case WM_EMACS_BRINGTOTOP:
4873 case WM_EMACS_SETFOREGROUND:
4874 {
4875 HWND foreground_window;
4876 DWORD foreground_thread, retval;
4877
4878 /* On NT 5.0, and apparently Windows 98, it is necessary to
4879 attach to the thread that currently has focus in order to
4880 pull the focus away from it. */
4881 foreground_window = GetForegroundWindow ();
4882 foreground_thread = GetWindowThreadProcessId (foreground_window, NULL);
4883 if (!foreground_window
4884 || foreground_thread == GetCurrentThreadId ()
4885 || !AttachThreadInput (GetCurrentThreadId (),
4886 foreground_thread, TRUE))
4887 foreground_thread = 0;
4888
4889 retval = SetForegroundWindow ((HWND) wParam);
4890 if (msg == WM_EMACS_BRINGTOTOP)
4891 retval = BringWindowToTop ((HWND) wParam);
4892
4893 /* Detach from the previous foreground thread. */
4894 if (foreground_thread)
4895 AttachThreadInput (GetCurrentThreadId (),
4896 foreground_thread, FALSE);
4897
4898 return retval;
4899 }
4900
4901 case WM_EMACS_SETWINDOWPOS:
4902 {
4903 WINDOWPOS * pos = (WINDOWPOS *) wParam;
4904 return SetWindowPos (hwnd, pos->hwndInsertAfter,
4905 pos->x, pos->y, pos->cx, pos->cy, pos->flags);
4906 }
4907
4908 case WM_EMACS_DESTROYWINDOW:
4909 DragAcceptFiles ((HWND) wParam, FALSE);
4910 return DestroyWindow ((HWND) wParam);
4911
4912 case WM_EMACS_HIDE_CARET:
4913 return HideCaret (hwnd);
4914
4915 case WM_EMACS_SHOW_CARET:
4916 return ShowCaret (hwnd);
4917
4918 case WM_EMACS_DESTROY_CARET:
4919 w32_system_caret_hwnd = NULL;
4920 w32_visible_system_caret_hwnd = NULL;
4921 return DestroyCaret ();
4922
4923 case WM_EMACS_TRACK_CARET:
4924 /* If there is currently no system caret, create one. */
4925 if (w32_system_caret_hwnd == NULL)
4926 {
4927 /* Use the default caret width, and avoid changing it
4928 unnecessarily, as it confuses screen reader software. */
4929 w32_system_caret_hwnd = hwnd;
4930 CreateCaret (hwnd, NULL, 0,
4931 w32_system_caret_height);
4932 }
4933
4934 if (!SetCaretPos (w32_system_caret_x, w32_system_caret_y))
4935 return 0;
4936 /* Ensure visible caret gets turned on when requested. */
4937 else if (w32_use_visible_system_caret
4938 && w32_visible_system_caret_hwnd != hwnd)
4939 {
4940 w32_visible_system_caret_hwnd = hwnd;
4941 return ShowCaret (hwnd);
4942 }
4943 /* Ensure visible caret gets turned off when requested. */
4944 else if (!w32_use_visible_system_caret
4945 && w32_visible_system_caret_hwnd)
4946 {
4947 w32_visible_system_caret_hwnd = NULL;
4948 return HideCaret (hwnd);
4949 }
4950 else
4951 return 1;
4952
4953 case WM_EMACS_TRACKPOPUPMENU:
4954 {
4955 UINT flags;
4956 POINT *pos;
4957 int retval;
4958 pos = (POINT *)lParam;
4959 flags = TPM_CENTERALIGN;
4960 if (button_state & LMOUSE)
4961 flags |= TPM_LEFTBUTTON;
4962 else if (button_state & RMOUSE)
4963 flags |= TPM_RIGHTBUTTON;
4964
4965 /* Remember we did a SetCapture on the initial mouse down event,
4966 so for safety, we make sure the capture is canceled now. */
4967 ReleaseCapture ();
4968 button_state = 0;
4969
4970 /* Use menubar_active to indicate that WM_INITMENU is from
4971 TrackPopupMenu below, and should be ignored. */
4972 f = x_window_to_frame (dpyinfo, hwnd);
4973 if (f)
4974 f->output_data.w32->menubar_active = 1;
4975
4976 if (TrackPopupMenu ((HMENU)wParam, flags, pos->x, pos->y,
4977 0, hwnd, NULL))
4978 {
4979 MSG amsg;
4980 /* Eat any mouse messages during popupmenu */
4981 while (PeekMessage (&amsg, hwnd, WM_MOUSEFIRST, WM_MOUSELAST,
4982 PM_REMOVE));
4983 /* Get the menu selection, if any */
4984 if (PeekMessage (&amsg, hwnd, WM_COMMAND, WM_COMMAND, PM_REMOVE))
4985 {
4986 retval = LOWORD (amsg.wParam);
4987 }
4988 else
4989 {
4990 retval = 0;
4991 }
4992 }
4993 else
4994 {
4995 retval = -1;
4996 }
4997
4998 return retval;
4999 }
5000 case WM_EMACS_FILENOTIFY:
5001 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
5002 return 1;
5003
5004 default:
5005 /* Check for messages registered at runtime. */
5006 if (msg == msh_mousewheel)
5007 {
5008 wmsg.dwModifiers = w32_get_modifiers ();
5009 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
5010 signal_user_input ();
5011 return 0;
5012 }
5013
5014 dflt:
5015 return (w32_unicode_gui ? DefWindowProcW : DefWindowProcA) (hwnd, msg, wParam, lParam);
5016 }
5017
5018 /* The most common default return code for handled messages is 0. */
5019 return 0;
5020 }
5021
5022 static void
5023 my_create_window (struct frame * f)
5024 {
5025 MSG msg;
5026 static int coords[2];
5027 Lisp_Object left, top;
5028 struct w32_display_info *dpyinfo = &one_w32_display_info;
5029
5030 /* When called with RES_TYPE_NUMBER, x_get_arg will return zero for
5031 anything that is not a number and is not Qunbound. */
5032 left = x_get_arg (dpyinfo, Qnil, Qleft, "left", "Left", RES_TYPE_NUMBER);
5033 top = x_get_arg (dpyinfo, Qnil, Qtop, "top", "Top", RES_TYPE_NUMBER);
5034 if (EQ (left, Qunbound))
5035 coords[0] = CW_USEDEFAULT;
5036 else
5037 coords[0] = XINT (left);
5038 if (EQ (top, Qunbound))
5039 coords[1] = CW_USEDEFAULT;
5040 else
5041 coords[1] = XINT (top);
5042
5043 if (!PostThreadMessage (dwWindowsThreadId, WM_EMACS_CREATEWINDOW,
5044 (WPARAM)f, (LPARAM)coords))
5045 emacs_abort ();
5046 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
5047 }
5048
5049
5050 /* Create a tooltip window. Unlike my_create_window, we do not do this
5051 indirectly via the Window thread, as we do not need to process Window
5052 messages for the tooltip. Creating tooltips indirectly also creates
5053 deadlocks when tooltips are created for menu items. */
5054 static void
5055 my_create_tip_window (struct frame *f)
5056 {
5057 RECT rect;
5058
5059 rect.left = rect.top = 0;
5060 rect.right = FRAME_PIXEL_WIDTH (f);
5061 rect.bottom = FRAME_PIXEL_HEIGHT (f);
5062
5063 AdjustWindowRect (&rect, f->output_data.w32->dwStyle, false);
5064
5065 tip_window = FRAME_W32_WINDOW (f)
5066 = CreateWindow (EMACS_CLASS,
5067 f->namebuf,
5068 f->output_data.w32->dwStyle,
5069 f->left_pos,
5070 f->top_pos,
5071 rect.right - rect.left,
5072 rect.bottom - rect.top,
5073 FRAME_W32_WINDOW (SELECTED_FRAME ()), /* owner */
5074 NULL,
5075 hinst,
5076 NULL);
5077
5078 if (tip_window)
5079 {
5080 SetWindowLong (tip_window, WND_FONTWIDTH_INDEX, FRAME_COLUMN_WIDTH (f));
5081 SetWindowLong (tip_window, WND_LINEHEIGHT_INDEX, FRAME_LINE_HEIGHT (f));
5082 SetWindowLong (tip_window, WND_BORDER_INDEX, FRAME_INTERNAL_BORDER_WIDTH (f));
5083 SetWindowLong (tip_window, WND_BACKGROUND_INDEX, FRAME_BACKGROUND_PIXEL (f));
5084
5085 /* Tip frames have no scrollbars. */
5086 SetWindowLong (tip_window, WND_VSCROLLBAR_INDEX, 0);
5087 SetWindowLong (tip_window, WND_HSCROLLBAR_INDEX, 0);
5088
5089 /* Do this to discard the default setting specified by our parent. */
5090 ShowWindow (tip_window, SW_HIDE);
5091 }
5092 }
5093
5094
5095 /* Create and set up the w32 window for frame F. */
5096
5097 static void
5098 w32_window (struct frame *f, long window_prompting, bool minibuffer_only)
5099 {
5100 block_input ();
5101
5102 /* Use the resource name as the top-level window name
5103 for looking up resources. Make a non-Lisp copy
5104 for the window manager, so GC relocation won't bother it.
5105
5106 Elsewhere we specify the window name for the window manager. */
5107 f->namebuf = xlispstrdup (Vx_resource_name);
5108
5109 my_create_window (f);
5110
5111 validate_x_resource_name ();
5112
5113 /* x_set_name normally ignores requests to set the name if the
5114 requested name is the same as the current name. This is the one
5115 place where that assumption isn't correct; f->name is set, but
5116 the server hasn't been told. */
5117 {
5118 Lisp_Object name;
5119 int explicit = f->explicit_name;
5120
5121 f->explicit_name = 0;
5122 name = f->name;
5123 fset_name (f, Qnil);
5124 x_set_name (f, name, explicit);
5125 }
5126
5127 unblock_input ();
5128
5129 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
5130 initialize_frame_menubar (f);
5131
5132 if (FRAME_W32_WINDOW (f) == 0)
5133 error ("Unable to create window");
5134 }
5135
5136 /* Handle the icon stuff for this window. Perhaps later we might
5137 want an x_set_icon_position which can be called interactively as
5138 well. */
5139
5140 static void
5141 x_icon (struct frame *f, Lisp_Object parms)
5142 {
5143 Lisp_Object icon_x, icon_y;
5144 struct w32_display_info *dpyinfo = &one_w32_display_info;
5145
5146 /* Set the position of the icon. Note that Windows 95 groups all
5147 icons in the tray. */
5148 icon_x = x_get_arg (dpyinfo, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
5149 icon_y = x_get_arg (dpyinfo, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
5150 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
5151 {
5152 CHECK_NUMBER (icon_x);
5153 CHECK_NUMBER (icon_y);
5154 }
5155 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
5156 error ("Both left and top icon corners of icon must be specified");
5157
5158 block_input ();
5159
5160 #if 0 /* TODO */
5161 /* Start up iconic or window? */
5162 x_wm_set_window_state
5163 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL), Qicon)
5164 ? IconicState
5165 : NormalState));
5166
5167 x_text_icon (f, SSDATA ((!NILP (f->icon_name)
5168 ? f->icon_name
5169 : f->name)));
5170 #endif
5171
5172 unblock_input ();
5173 }
5174
5175
5176 static void
5177 x_make_gc (struct frame *f)
5178 {
5179 XGCValues gc_values;
5180
5181 block_input ();
5182
5183 /* Create the GC's of this frame.
5184 Note that many default values are used. */
5185
5186 /* Normal video */
5187 gc_values.font = FRAME_FONT (f);
5188
5189 /* Cursor has cursor-color background, background-color foreground. */
5190 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
5191 gc_values.background = f->output_data.w32->cursor_pixel;
5192 f->output_data.w32->cursor_gc
5193 = XCreateGC (NULL, FRAME_W32_WINDOW (f),
5194 (GCFont | GCForeground | GCBackground),
5195 &gc_values);
5196
5197 /* Reliefs. */
5198 f->output_data.w32->white_relief.gc = 0;
5199 f->output_data.w32->black_relief.gc = 0;
5200
5201 unblock_input ();
5202 }
5203
5204
5205 /* Handler for signals raised during x_create_frame and
5206 x_create_tip_frame. FRAME is the frame which is partially
5207 constructed. */
5208
5209 static Lisp_Object
5210 unwind_create_frame (Lisp_Object frame)
5211 {
5212 struct frame *f = XFRAME (frame);
5213
5214 /* If frame is ``official'', nothing to do. */
5215 if (NILP (Fmemq (frame, Vframe_list)))
5216 {
5217 #ifdef GLYPH_DEBUG
5218 struct w32_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
5219
5220 /* If the frame's image cache refcount is still the same as our
5221 private shadow variable, it means we are unwinding a frame
5222 for which we didn't yet call init_frame_faces, where the
5223 refcount is incremented. Therefore, we increment it here, so
5224 that free_frame_faces, called in x_free_frame_resources
5225 below, will not mistakenly decrement the counter that was not
5226 incremented yet to account for this new frame. */
5227 if (FRAME_IMAGE_CACHE (f) != NULL
5228 && FRAME_IMAGE_CACHE (f)->refcount == image_cache_refcount)
5229 FRAME_IMAGE_CACHE (f)->refcount++;
5230 #endif
5231
5232 x_free_frame_resources (f);
5233 free_glyphs (f);
5234
5235 #ifdef GLYPH_DEBUG
5236 /* Check that reference counts are indeed correct. */
5237 eassert (dpyinfo->reference_count == dpyinfo_refcount);
5238 eassert ((dpyinfo->terminal->image_cache == NULL
5239 && image_cache_refcount == 0)
5240 || (dpyinfo->terminal->image_cache != NULL
5241 && dpyinfo->terminal->image_cache->refcount == image_cache_refcount));
5242 #endif
5243 return Qt;
5244 }
5245
5246 return Qnil;
5247 }
5248
5249 static void
5250 do_unwind_create_frame (Lisp_Object frame)
5251 {
5252 unwind_create_frame (frame);
5253 }
5254
5255 static void
5256 x_default_font_parameter (struct frame *f, Lisp_Object parms)
5257 {
5258 struct w32_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
5259 Lisp_Object font_param = x_get_arg (dpyinfo, parms, Qfont, NULL, NULL,
5260 RES_TYPE_STRING);
5261 Lisp_Object font;
5262 if (EQ (font_param, Qunbound))
5263 font_param = Qnil;
5264 font = !NILP (font_param) ? font_param
5265 : x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
5266
5267 if (!STRINGP (font))
5268 {
5269 int i;
5270 static char *names[]
5271 = { "Courier New-10",
5272 "-*-Courier-normal-r-*-*-13-*-*-*-c-*-iso8859-1",
5273 "-*-Fixedsys-normal-r-*-*-12-*-*-*-c-*-iso8859-1",
5274 "Fixedsys",
5275 NULL };
5276
5277 for (i = 0; names[i]; i++)
5278 {
5279 font = font_open_by_name (f, build_unibyte_string (names[i]));
5280 if (! NILP (font))
5281 break;
5282 }
5283 if (NILP (font))
5284 error ("No suitable font was found");
5285 }
5286 else if (!NILP (font_param))
5287 {
5288 /* Remember the explicit font parameter, so we can re-apply it after
5289 we've applied the `default' face settings. */
5290 x_set_frame_parameters (f, Fcons (Fcons (Qfont_parameter, font_param),
5291 Qnil));
5292 }
5293 x_default_parameter (f, parms, Qfont, font, "font", "Font", RES_TYPE_STRING);
5294 }
5295
5296 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
5297 1, 1, 0,
5298 doc: /* Make a new window, which is called a \"frame\" in Emacs terms.
5299 Return an Emacs frame object.
5300 PARAMETERS is an alist of frame parameters.
5301 If the parameters specify that the frame should not have a minibuffer,
5302 and do not specify a specific minibuffer window to use,
5303 then `default-minibuffer-frame' must be a frame whose minibuffer can
5304 be shared by the new frame.
5305
5306 This function is an internal primitive--use `make-frame' instead. */)
5307 (Lisp_Object parameters)
5308 {
5309 struct frame *f;
5310 Lisp_Object frame, tem;
5311 Lisp_Object name;
5312 bool minibuffer_only = false;
5313 long window_prompting = 0;
5314 ptrdiff_t count = SPECPDL_INDEX ();
5315 Lisp_Object display;
5316 struct w32_display_info *dpyinfo = NULL;
5317 Lisp_Object parent;
5318 struct kboard *kb;
5319 int x_width = 0, x_height = 0;
5320
5321 if (!FRAME_W32_P (SELECTED_FRAME ())
5322 && !FRAME_INITIAL_P (SELECTED_FRAME ()))
5323 error ("Cannot create a GUI frame in a -nw session");
5324
5325 /* Make copy of frame parameters because the original is in pure
5326 storage now. */
5327 parameters = Fcopy_alist (parameters);
5328
5329 /* Use this general default value to start with
5330 until we know if this frame has a specified name. */
5331 Vx_resource_name = Vinvocation_name;
5332
5333 display = x_get_arg (dpyinfo, parameters, Qterminal, 0, 0, RES_TYPE_NUMBER);
5334 if (EQ (display, Qunbound))
5335 display = x_get_arg (dpyinfo, parameters, Qdisplay, 0, 0, RES_TYPE_STRING);
5336 if (EQ (display, Qunbound))
5337 display = Qnil;
5338 dpyinfo = check_x_display_info (display);
5339 kb = dpyinfo->terminal->kboard;
5340
5341 if (!dpyinfo->terminal->name)
5342 error ("Terminal is not live, can't create new frames on it");
5343
5344 name = x_get_arg (dpyinfo, parameters, Qname, "name", "Name", RES_TYPE_STRING);
5345 if (!STRINGP (name)
5346 && ! EQ (name, Qunbound)
5347 && ! NILP (name))
5348 error ("Invalid frame name--not a string or nil");
5349
5350 if (STRINGP (name))
5351 Vx_resource_name = name;
5352
5353 /* See if parent window is specified. */
5354 parent = x_get_arg (dpyinfo, parameters, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
5355 if (EQ (parent, Qunbound))
5356 parent = Qnil;
5357 if (! NILP (parent))
5358 CHECK_NUMBER (parent);
5359
5360 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
5361 /* No need to protect DISPLAY because that's not used after passing
5362 it to make_frame_without_minibuffer. */
5363 frame = Qnil;
5364 tem = x_get_arg (dpyinfo, parameters, Qminibuffer, "minibuffer", "Minibuffer",
5365 RES_TYPE_SYMBOL);
5366 if (EQ (tem, Qnone) || NILP (tem))
5367 f = make_frame_without_minibuffer (Qnil, kb, display);
5368 else if (EQ (tem, Qonly))
5369 {
5370 f = make_minibuffer_frame ();
5371 minibuffer_only = true;
5372 }
5373 else if (WINDOWP (tem))
5374 f = make_frame_without_minibuffer (tem, kb, display);
5375 else
5376 f = make_frame (true);
5377
5378 XSETFRAME (frame, f);
5379
5380 /* By default, make scrollbars the system standard width and height. */
5381 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = GetSystemMetrics (SM_CXVSCROLL);
5382 FRAME_CONFIG_SCROLL_BAR_HEIGHT (f) = GetSystemMetrics (SM_CXHSCROLL);
5383
5384 f->terminal = dpyinfo->terminal;
5385
5386 f->output_method = output_w32;
5387 f->output_data.w32 = xzalloc (sizeof (struct w32_output));
5388 FRAME_FONTSET (f) = -1;
5389
5390 fset_icon_name
5391 (f, x_get_arg (dpyinfo, parameters, Qicon_name, "iconName", "Title",
5392 RES_TYPE_STRING));
5393 if (! STRINGP (f->icon_name))
5394 fset_icon_name (f, Qnil);
5395
5396 /* FRAME_DISPLAY_INFO (f) = dpyinfo; */
5397
5398 /* With FRAME_DISPLAY_INFO set up, this unwind-protect is safe. */
5399 record_unwind_protect (do_unwind_create_frame, frame);
5400
5401 #ifdef GLYPH_DEBUG
5402 image_cache_refcount =
5403 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
5404 dpyinfo_refcount = dpyinfo->reference_count;
5405 #endif /* GLYPH_DEBUG */
5406
5407 /* Specify the parent under which to make this window. */
5408 if (!NILP (parent))
5409 {
5410 /* Cast to UINT_PTR shuts up compiler warnings about cast to
5411 pointer from integer of different size. */
5412 f->output_data.w32->parent_desc = (Window) (UINT_PTR) XFASTINT (parent);
5413 f->output_data.w32->explicit_parent = true;
5414 }
5415 else
5416 {
5417 f->output_data.w32->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
5418 f->output_data.w32->explicit_parent = false;
5419 }
5420
5421 /* Set the name; the functions to which we pass f expect the name to
5422 be set. */
5423 if (EQ (name, Qunbound) || NILP (name))
5424 {
5425 fset_name (f, build_string (dpyinfo->w32_id_name));
5426 f->explicit_name = false;
5427 }
5428 else
5429 {
5430 fset_name (f, name);
5431 f->explicit_name = true;
5432 /* Use the frame's title when getting resources for this frame. */
5433 specbind (Qx_resource_name, name);
5434 }
5435
5436 if (uniscribe_available)
5437 register_font_driver (&uniscribe_font_driver, f);
5438 register_font_driver (&w32font_driver, f);
5439
5440 x_default_parameter (f, parameters, Qfont_backend, Qnil,
5441 "fontBackend", "FontBackend", RES_TYPE_STRING);
5442
5443 /* Extract the window parameters from the supplied values
5444 that are needed to determine window geometry. */
5445 x_default_font_parameter (f, parameters);
5446
5447 x_default_parameter (f, parameters, Qborder_width, make_number (2),
5448 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
5449
5450 /* We recognize either internalBorderWidth or internalBorder
5451 (which is what xterm calls it). */
5452 if (NILP (Fassq (Qinternal_border_width, parameters)))
5453 {
5454 Lisp_Object value;
5455
5456 value = x_get_arg (dpyinfo, parameters, Qinternal_border_width,
5457 "internalBorder", "InternalBorder", RES_TYPE_NUMBER);
5458 if (! EQ (value, Qunbound))
5459 parameters = Fcons (Fcons (Qinternal_border_width, value),
5460 parameters);
5461 }
5462 /* Default internalBorderWidth to 0 on Windows to match other programs. */
5463 x_default_parameter (f, parameters, Qinternal_border_width, make_number (0),
5464 "internalBorderWidth", "InternalBorder", RES_TYPE_NUMBER);
5465 x_default_parameter (f, parameters, Qright_divider_width, make_number (0),
5466 NULL, NULL, RES_TYPE_NUMBER);
5467 x_default_parameter (f, parameters, Qbottom_divider_width, make_number (0),
5468 NULL, NULL, RES_TYPE_NUMBER);
5469 x_default_parameter (f, parameters, Qvertical_scroll_bars, Qright,
5470 "verticalScrollBars", "ScrollBars", RES_TYPE_SYMBOL);
5471 x_default_parameter (f, parameters, Qhorizontal_scroll_bars, Qnil,
5472 "horizontalScrollBars", "ScrollBars", RES_TYPE_SYMBOL);
5473
5474 /* Also do the stuff which must be set before the window exists. */
5475 x_default_parameter (f, parameters, Qforeground_color, build_string ("black"),
5476 "foreground", "Foreground", RES_TYPE_STRING);
5477 x_default_parameter (f, parameters, Qbackground_color, build_string ("white"),
5478 "background", "Background", RES_TYPE_STRING);
5479 x_default_parameter (f, parameters, Qmouse_color, build_string ("black"),
5480 "pointerColor", "Foreground", RES_TYPE_STRING);
5481 x_default_parameter (f, parameters, Qborder_color, build_string ("black"),
5482 "borderColor", "BorderColor", RES_TYPE_STRING);
5483 x_default_parameter (f, parameters, Qscreen_gamma, Qnil,
5484 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
5485 x_default_parameter (f, parameters, Qline_spacing, Qnil,
5486 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
5487 x_default_parameter (f, parameters, Qleft_fringe, Qnil,
5488 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
5489 x_default_parameter (f, parameters, Qright_fringe, Qnil,
5490 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
5491 /* Process alpha here (Bug#16619). */
5492 x_default_parameter (f, parameters, Qalpha, Qnil,
5493 "alpha", "Alpha", RES_TYPE_NUMBER);
5494
5495 /* Init faces first since we need the frame's column width/line
5496 height in various occasions. */
5497 init_frame_faces (f);
5498
5499 /* The following call of change_frame_size is needed since otherwise
5500 x_set_tool_bar_lines will already work with the character sizes
5501 installed by init_frame_faces while the frame's pixel size is
5502 still calculated from a character size of 1 and we subsequently
5503 hit the (height >= 0) assertion in window_box_height.
5504
5505 The non-pixelwise code apparently worked around this because it
5506 had one frame line vs one toolbar line which left us with a zero
5507 root window height which was obviously wrong as well ... */
5508 adjust_frame_size (f, FRAME_COLS (f) * FRAME_COLUMN_WIDTH (f),
5509 FRAME_LINES (f) * FRAME_LINE_HEIGHT (f), 5, true,
5510 Qx_create_frame_1);
5511
5512 /* The X resources controlling the menu-bar and tool-bar are
5513 processed specially at startup, and reflected in the mode
5514 variables; ignore them here. */
5515 x_default_parameter (f, parameters, Qmenu_bar_lines,
5516 NILP (Vmenu_bar_mode)
5517 ? make_number (0) : make_number (1),
5518 NULL, NULL, RES_TYPE_NUMBER);
5519 x_default_parameter (f, parameters, Qtool_bar_lines,
5520 NILP (Vtool_bar_mode)
5521 ? make_number (0) : make_number (1),
5522 NULL, NULL, RES_TYPE_NUMBER);
5523
5524 x_default_parameter (f, parameters, Qbuffer_predicate, Qnil,
5525 "bufferPredicate", "BufferPredicate", RES_TYPE_SYMBOL);
5526 x_default_parameter (f, parameters, Qtitle, Qnil,
5527 "title", "Title", RES_TYPE_STRING);
5528
5529 f->output_data.w32->dwStyle = WS_OVERLAPPEDWINDOW;
5530 f->output_data.w32->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
5531
5532 f->output_data.w32->text_cursor = w32_load_cursor (IDC_IBEAM);
5533 f->output_data.w32->nontext_cursor = w32_load_cursor (IDC_ARROW);
5534 f->output_data.w32->modeline_cursor = w32_load_cursor (IDC_ARROW);
5535 f->output_data.w32->hand_cursor = w32_load_cursor (IDC_HAND);
5536 f->output_data.w32->hourglass_cursor = w32_load_cursor (IDC_WAIT);
5537 f->output_data.w32->horizontal_drag_cursor = w32_load_cursor (IDC_SIZEWE);
5538 f->output_data.w32->vertical_drag_cursor = w32_load_cursor (IDC_SIZENS);
5539
5540 f->output_data.w32->current_cursor = f->output_data.w32->nontext_cursor;
5541
5542 window_prompting = x_figure_window_size (f, parameters, true, &x_width, &x_height);
5543
5544 tem = x_get_arg (dpyinfo, parameters, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
5545 f->no_split = minibuffer_only || EQ (tem, Qt);
5546
5547 w32_window (f, window_prompting, minibuffer_only);
5548 x_icon (f, parameters);
5549
5550 x_make_gc (f);
5551
5552 /* Now consider the frame official. */
5553 f->terminal->reference_count++;
5554 FRAME_DISPLAY_INFO (f)->reference_count++;
5555 Vframe_list = Fcons (frame, Vframe_list);
5556
5557 /* We need to do this after creating the window, so that the
5558 icon-creation functions can say whose icon they're describing. */
5559 x_default_parameter (f, parameters, Qicon_type, Qnil,
5560 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
5561
5562 x_default_parameter (f, parameters, Qauto_raise, Qnil,
5563 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5564 x_default_parameter (f, parameters, Qauto_lower, Qnil,
5565 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5566 x_default_parameter (f, parameters, Qcursor_type, Qbox,
5567 "cursorType", "CursorType", RES_TYPE_SYMBOL);
5568 x_default_parameter (f, parameters, Qscroll_bar_width, Qnil,
5569 "scrollBarWidth", "ScrollBarWidth", RES_TYPE_NUMBER);
5570 x_default_parameter (f, parameters, Qscroll_bar_height, Qnil,
5571 "scrollBarHeight", "ScrollBarHeight", RES_TYPE_NUMBER);
5572
5573 /* Allow x_set_window_size, now. */
5574 f->can_x_set_window_size = true;
5575
5576 if (x_width > 0)
5577 SET_FRAME_WIDTH (f, x_width);
5578 if (x_height > 0)
5579 SET_FRAME_HEIGHT (f, x_height);
5580
5581 /* Tell the server what size and position, etc, we want, and how
5582 badly we want them. This should be done after we have the menu
5583 bar so that its size can be taken into account. */
5584 block_input ();
5585 x_wm_set_size_hint (f, window_prompting, false);
5586 unblock_input ();
5587
5588 adjust_frame_size (f, FRAME_TEXT_WIDTH (f), FRAME_TEXT_HEIGHT (f), 0, true,
5589 Qx_create_frame_2);
5590
5591 /* Process fullscreen parameter here in the hope that normalizing a
5592 fullheight/fullwidth frame will produce the size set by the last
5593 adjust_frame_size call. */
5594 x_default_parameter (f, parameters, Qfullscreen, Qnil,
5595 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
5596
5597 /* Make the window appear on the frame and enable display, unless
5598 the caller says not to. However, with explicit parent, Emacs
5599 cannot control visibility, so don't try. */
5600 if (! f->output_data.w32->explicit_parent)
5601 {
5602 Lisp_Object visibility;
5603
5604 visibility = x_get_arg (dpyinfo, parameters, Qvisibility, 0, 0, RES_TYPE_SYMBOL);
5605 if (EQ (visibility, Qunbound))
5606 visibility = Qt;
5607
5608 if (EQ (visibility, Qicon))
5609 x_iconify_frame (f);
5610 else if (! NILP (visibility))
5611 x_make_frame_visible (f);
5612 else
5613 /* Must have been Qnil. */
5614 ;
5615 }
5616
5617 /* Initialize `default-minibuffer-frame' in case this is the first
5618 frame on this terminal. */
5619 if (FRAME_HAS_MINIBUF_P (f)
5620 && (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
5621 || !FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame)))))
5622 kset_default_minibuffer_frame (kb, frame);
5623
5624 /* All remaining specified parameters, which have not been "used"
5625 by x_get_arg and friends, now go in the misc. alist of the frame. */
5626 for (tem = parameters; CONSP (tem); tem = XCDR (tem))
5627 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
5628 fset_param_alist (f, Fcons (XCAR (tem), f->param_alist));
5629
5630 /* Make sure windows on this frame appear in calls to next-window
5631 and similar functions. */
5632 Vwindow_list = Qnil;
5633
5634 return unbind_to (count, frame);
5635 }
5636
5637 /* FRAME is used only to get a handle on the X display. We don't pass the
5638 display info directly because we're called from frame.c, which doesn't
5639 know about that structure. */
5640 Lisp_Object
5641 x_get_focus_frame (struct frame *frame)
5642 {
5643 struct w32_display_info *dpyinfo = FRAME_DISPLAY_INFO (frame);
5644 Lisp_Object xfocus;
5645 if (! dpyinfo->w32_focus_frame)
5646 return Qnil;
5647
5648 XSETFRAME (xfocus, dpyinfo->w32_focus_frame);
5649 return xfocus;
5650 }
5651
5652 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
5653 doc: /* Internal function called by `color-defined-p', which see.
5654 \(Note that the Nextstep version of this function ignores FRAME.) */)
5655 (Lisp_Object color, Lisp_Object frame)
5656 {
5657 XColor foo;
5658 struct frame *f = decode_window_system_frame (frame);
5659
5660 CHECK_STRING (color);
5661
5662 if (w32_defined_color (f, SSDATA (color), &foo, false))
5663 return Qt;
5664 else
5665 return Qnil;
5666 }
5667
5668 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
5669 doc: /* Internal function called by `color-values', which see. */)
5670 (Lisp_Object color, Lisp_Object frame)
5671 {
5672 XColor foo;
5673 struct frame *f = decode_window_system_frame (frame);
5674
5675 CHECK_STRING (color);
5676
5677 if (w32_defined_color (f, SSDATA (color), &foo, false))
5678 return list3i ((GetRValue (foo.pixel) << 8) | GetRValue (foo.pixel),
5679 (GetGValue (foo.pixel) << 8) | GetGValue (foo.pixel),
5680 (GetBValue (foo.pixel) << 8) | GetBValue (foo.pixel));
5681 else
5682 return Qnil;
5683 }
5684
5685 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
5686 doc: /* Internal function called by `display-color-p', which see. */)
5687 (Lisp_Object display)
5688 {
5689 struct w32_display_info *dpyinfo = check_x_display_info (display);
5690
5691 if ((dpyinfo->n_planes * dpyinfo->n_cbits) <= 2)
5692 return Qnil;
5693
5694 return Qt;
5695 }
5696
5697 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p,
5698 Sx_display_grayscale_p, 0, 1, 0,
5699 doc: /* Return t if DISPLAY supports shades of gray.
5700 Note that color displays do support shades of gray.
5701 The optional argument DISPLAY specifies which display to ask about.
5702 DISPLAY should be either a frame or a display name (a string).
5703 If omitted or nil, that stands for the selected frame's display. */)
5704 (Lisp_Object display)
5705 {
5706 struct w32_display_info *dpyinfo = check_x_display_info (display);
5707
5708 if ((dpyinfo->n_planes * dpyinfo->n_cbits) <= 1)
5709 return Qnil;
5710
5711 return Qt;
5712 }
5713
5714 DEFUN ("x-display-pixel-width", Fx_display_pixel_width,
5715 Sx_display_pixel_width, 0, 1, 0,
5716 doc: /* Return the width in pixels of DISPLAY.
5717 The optional argument DISPLAY specifies which display to ask about.
5718 DISPLAY should be either a frame or a display name (a string).
5719 If omitted or nil, that stands for the selected frame's display.
5720
5721 On \"multi-monitor\" setups this refers to the pixel width for all
5722 physical monitors associated with DISPLAY. To get information for
5723 each physical monitor, use `display-monitor-attributes-list'. */)
5724 (Lisp_Object display)
5725 {
5726 struct w32_display_info *dpyinfo = check_x_display_info (display);
5727
5728 return make_number (x_display_pixel_width (dpyinfo));
5729 }
5730
5731 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
5732 Sx_display_pixel_height, 0, 1, 0,
5733 doc: /* Return the height in pixels of DISPLAY.
5734 The optional argument DISPLAY specifies which display to ask about.
5735 DISPLAY should be either a frame or a display name (a string).
5736 If omitted or nil, that stands for the selected frame's display.
5737
5738 On \"multi-monitor\" setups this refers to the pixel height for all
5739 physical monitors associated with DISPLAY. To get information for
5740 each physical monitor, use `display-monitor-attributes-list'. */)
5741 (Lisp_Object display)
5742 {
5743 struct w32_display_info *dpyinfo = check_x_display_info (display);
5744
5745 return make_number (x_display_pixel_height (dpyinfo));
5746 }
5747
5748 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
5749 0, 1, 0,
5750 doc: /* Return the number of bitplanes of DISPLAY.
5751 The optional argument DISPLAY specifies which display to ask about.
5752 DISPLAY should be either a frame or a display name (a string).
5753 If omitted or nil, that stands for the selected frame's display. */)
5754 (Lisp_Object display)
5755 {
5756 struct w32_display_info *dpyinfo = check_x_display_info (display);
5757
5758 return make_number (dpyinfo->n_planes * dpyinfo->n_cbits);
5759 }
5760
5761 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
5762 0, 1, 0,
5763 doc: /* Return the number of color cells of DISPLAY.
5764 The optional argument DISPLAY specifies which display to ask about.
5765 DISPLAY should be either a frame or a display name (a string).
5766 If omitted or nil, that stands for the selected frame's display. */)
5767 (Lisp_Object display)
5768 {
5769 struct w32_display_info *dpyinfo = check_x_display_info (display);
5770 int cap;
5771
5772 /* Don't use NCOLORS: it returns incorrect results under remote
5773 * desktop. We force 24+ bit depths to 24-bit, both to prevent an
5774 * overflow and because probably is more meaningful on Windows
5775 * anyway. */
5776
5777 cap = 1 << min (dpyinfo->n_planes * dpyinfo->n_cbits, 24);
5778 return make_number (cap);
5779 }
5780
5781 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
5782 Sx_server_max_request_size,
5783 0, 1, 0,
5784 doc: /* Return the maximum request size of the server of DISPLAY.
5785 The optional argument DISPLAY specifies which display to ask about.
5786 DISPLAY should be either a frame or a display name (a string).
5787 If omitted or nil, that stands for the selected frame's display. */)
5788 (Lisp_Object display)
5789 {
5790 return make_number (1);
5791 }
5792
5793 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
5794 doc: /* Return the "vendor ID" string of the GUI software on TERMINAL.
5795
5796 \(Labeling every distributor as a "vendor" embodies the false assumption
5797 that operating systems cannot be developed and distributed noncommercially.)
5798
5799 For GNU and Unix systems, this queries the X server software; for
5800 MS-Windows, this queries the OS.
5801
5802 The optional argument TERMINAL specifies which display to ask about.
5803 TERMINAL should be a terminal object, a frame or a display name (a string).
5804 If omitted or nil, that stands for the selected frame's display. */)
5805 (Lisp_Object terminal)
5806 {
5807 return build_string ("Microsoft Corp.");
5808 }
5809
5810 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
5811 doc: /* Return the version numbers of the GUI software on TERMINAL.
5812 The value is a list of three integers specifying the version of the GUI
5813 software in use.
5814
5815 For GNU and Unix system, the first 2 numbers are the version of the X
5816 Protocol used on TERMINAL and the 3rd number is the distributor-specific
5817 release number. For MS-Windows, the 3 numbers report the version and
5818 the build number of the OS.
5819
5820 See also the function `x-server-vendor'.
5821
5822 The optional argument TERMINAL specifies which display to ask about.
5823 TERMINAL should be a terminal object, a frame or a display name (a string).
5824 If omitted or nil, that stands for the selected frame's display. */)
5825 (Lisp_Object terminal)
5826 {
5827 return list3i (w32_major_version, w32_minor_version, w32_build_number);
5828 }
5829
5830 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
5831 doc: /* Return the number of screens on the server of DISPLAY.
5832 The optional argument DISPLAY specifies which display to ask about.
5833 DISPLAY should be either a frame or a display name (a string).
5834 If omitted or nil, that stands for the selected frame's display. */)
5835 (Lisp_Object display)
5836 {
5837 return make_number (1);
5838 }
5839
5840 DEFUN ("x-display-mm-height", Fx_display_mm_height,
5841 Sx_display_mm_height, 0, 1, 0,
5842 doc: /* Return the height in millimeters of DISPLAY.
5843 The optional argument DISPLAY specifies which display to ask about.
5844 DISPLAY should be either a frame or a display name (a string).
5845 If omitted or nil, that stands for the selected frame's display.
5846
5847 On \"multi-monitor\" setups this refers to the height in millimeters for
5848 all physical monitors associated with DISPLAY. To get information
5849 for each physical monitor, use `display-monitor-attributes-list'. */)
5850 (Lisp_Object display)
5851 {
5852 struct w32_display_info *dpyinfo = check_x_display_info (display);
5853 HDC hdc;
5854 double mm_per_pixel;
5855
5856 hdc = GetDC (NULL);
5857 mm_per_pixel = ((double) GetDeviceCaps (hdc, VERTSIZE)
5858 / GetDeviceCaps (hdc, VERTRES));
5859 ReleaseDC (NULL, hdc);
5860
5861 return make_number (x_display_pixel_height (dpyinfo) * mm_per_pixel + 0.5);
5862 }
5863
5864 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
5865 doc: /* Return the width in millimeters of DISPLAY.
5866 The optional argument DISPLAY specifies which display to ask about.
5867 DISPLAY should be either a frame or a display name (a string).
5868 If omitted or nil, that stands for the selected frame's display.
5869
5870 On \"multi-monitor\" setups this refers to the width in millimeters for
5871 all physical monitors associated with TERMINAL. To get information
5872 for each physical monitor, use `display-monitor-attributes-list'. */)
5873 (Lisp_Object display)
5874 {
5875 struct w32_display_info *dpyinfo = check_x_display_info (display);
5876 HDC hdc;
5877 double mm_per_pixel;
5878
5879 hdc = GetDC (NULL);
5880 mm_per_pixel = ((double) GetDeviceCaps (hdc, HORZSIZE)
5881 / GetDeviceCaps (hdc, HORZRES));
5882 ReleaseDC (NULL, hdc);
5883
5884 return make_number (x_display_pixel_width (dpyinfo) * mm_per_pixel + 0.5);
5885 }
5886
5887 DEFUN ("x-display-backing-store", Fx_display_backing_store,
5888 Sx_display_backing_store, 0, 1, 0,
5889 doc: /* Return an indication of whether DISPLAY does backing store.
5890 The value may be `always', `when-mapped', or `not-useful'.
5891 The optional argument DISPLAY specifies which display to ask about.
5892 DISPLAY should be either a frame or a display name (a string).
5893 If omitted or nil, that stands for the selected frame's display. */)
5894 (Lisp_Object display)
5895 {
5896 return intern ("not-useful");
5897 }
5898
5899 DEFUN ("x-display-visual-class", Fx_display_visual_class,
5900 Sx_display_visual_class, 0, 1, 0,
5901 doc: /* Return the visual class of DISPLAY.
5902 The value is one of the symbols `static-gray', `gray-scale',
5903 `static-color', `pseudo-color', `true-color', or `direct-color'.
5904
5905 The optional argument DISPLAY specifies which display to ask about.
5906 DISPLAY should be either a frame or a display name (a string).
5907 If omitted or nil, that stands for the selected frame's display. */)
5908 (Lisp_Object display)
5909 {
5910 struct w32_display_info *dpyinfo = check_x_display_info (display);
5911 Lisp_Object result = Qnil;
5912
5913 if (dpyinfo->has_palette)
5914 result = intern ("pseudo-color");
5915 else if (dpyinfo->n_planes * dpyinfo->n_cbits == 1)
5916 result = intern ("static-grey");
5917 else if (dpyinfo->n_planes * dpyinfo->n_cbits == 4)
5918 result = intern ("static-color");
5919 else if (dpyinfo->n_planes * dpyinfo->n_cbits > 8)
5920 result = intern ("true-color");
5921
5922 return result;
5923 }
5924
5925 DEFUN ("x-display-save-under", Fx_display_save_under,
5926 Sx_display_save_under, 0, 1, 0,
5927 doc: /* Return t if DISPLAY supports the save-under feature.
5928 The optional argument DISPLAY specifies which display to ask about.
5929 DISPLAY should be either a frame or a display name (a string).
5930 If omitted or nil, that stands for the selected frame's display. */)
5931 (Lisp_Object display)
5932 {
5933 return Qnil;
5934 }
5935
5936 static BOOL CALLBACK ALIGN_STACK
5937 w32_monitor_enum (HMONITOR monitor, HDC hdc, RECT *rcMonitor, LPARAM dwData)
5938 {
5939 Lisp_Object *monitor_list = (Lisp_Object *) dwData;
5940
5941 *monitor_list = Fcons (make_save_ptr (monitor), *monitor_list);
5942
5943 return TRUE;
5944 }
5945
5946 static Lisp_Object
5947 w32_display_monitor_attributes_list (void)
5948 {
5949 Lisp_Object attributes_list = Qnil, primary_monitor_attributes = Qnil;
5950 Lisp_Object monitor_list = Qnil, monitor_frames, rest, frame;
5951 int i, n_monitors;
5952 HMONITOR *monitors;
5953
5954 if (!(enum_display_monitors_fn && get_monitor_info_fn
5955 && monitor_from_window_fn))
5956 return Qnil;
5957
5958 if (!enum_display_monitors_fn (NULL, NULL, w32_monitor_enum,
5959 (LPARAM) &monitor_list)
5960 || NILP (monitor_list))
5961 return Qnil;
5962
5963 n_monitors = 0;
5964 for (rest = monitor_list; CONSP (rest); rest = XCDR (rest))
5965 n_monitors++;
5966
5967 monitors = xmalloc (n_monitors * sizeof (*monitors));
5968 for (i = 0; i < n_monitors; i++)
5969 {
5970 monitors[i] = XSAVE_POINTER (XCAR (monitor_list), 0);
5971 monitor_list = XCDR (monitor_list);
5972 }
5973
5974 monitor_frames = Fmake_vector (make_number (n_monitors), Qnil);
5975 FOR_EACH_FRAME (rest, frame)
5976 {
5977 struct frame *f = XFRAME (frame);
5978
5979 if (FRAME_W32_P (f) && !EQ (frame, tip_frame))
5980 {
5981 HMONITOR monitor =
5982 monitor_from_window_fn (FRAME_W32_WINDOW (f),
5983 MONITOR_DEFAULT_TO_NEAREST);
5984
5985 for (i = 0; i < n_monitors; i++)
5986 if (monitors[i] == monitor)
5987 break;
5988
5989 if (i < n_monitors)
5990 ASET (monitor_frames, i, Fcons (frame, AREF (monitor_frames, i)));
5991 }
5992 }
5993
5994 for (i = 0; i < n_monitors; i++)
5995 {
5996 Lisp_Object geometry, workarea, name, attributes = Qnil;
5997 HDC hdc;
5998 int width_mm, height_mm;
5999 struct MONITOR_INFO_EX mi;
6000
6001 mi.cbSize = sizeof (mi);
6002 if (!get_monitor_info_fn (monitors[i], (struct MONITOR_INFO *) &mi))
6003 continue;
6004
6005 hdc = CreateDCA ("DISPLAY", mi.szDevice, NULL, NULL);
6006 if (hdc == NULL)
6007 continue;
6008 width_mm = GetDeviceCaps (hdc, HORZSIZE);
6009 height_mm = GetDeviceCaps (hdc, VERTSIZE);
6010 DeleteDC (hdc);
6011
6012 attributes = Fcons (Fcons (Qframes, AREF (monitor_frames, i)),
6013 attributes);
6014
6015 name = DECODE_SYSTEM (build_unibyte_string (mi.szDevice));
6016
6017 attributes = Fcons (Fcons (Qname, name), attributes);
6018
6019 attributes = Fcons (Fcons (Qmm_size, list2i (width_mm, height_mm)),
6020 attributes);
6021
6022 workarea = list4i (mi.rcWork.left, mi.rcWork.top,
6023 mi.rcWork.right - mi.rcWork.left,
6024 mi.rcWork.bottom - mi.rcWork.top);
6025 attributes = Fcons (Fcons (Qworkarea, workarea), attributes);
6026
6027 geometry = list4i (mi.rcMonitor.left, mi.rcMonitor.top,
6028 mi.rcMonitor.right - mi.rcMonitor.left,
6029 mi.rcMonitor.bottom - mi.rcMonitor.top);
6030 attributes = Fcons (Fcons (Qgeometry, geometry), attributes);
6031
6032 if (mi.dwFlags & MONITORINFOF_PRIMARY)
6033 primary_monitor_attributes = attributes;
6034 else
6035 attributes_list = Fcons (attributes, attributes_list);
6036 }
6037
6038 if (!NILP (primary_monitor_attributes))
6039 attributes_list = Fcons (primary_monitor_attributes, attributes_list);
6040
6041 xfree (monitors);
6042
6043 return attributes_list;
6044 }
6045
6046 static Lisp_Object
6047 w32_display_monitor_attributes_list_fallback (struct w32_display_info *dpyinfo)
6048 {
6049 Lisp_Object geometry, workarea, frames, rest, frame, attributes = Qnil;
6050 HDC hdc;
6051 double mm_per_pixel;
6052 int pixel_width, pixel_height, width_mm, height_mm;
6053 RECT workarea_rect;
6054
6055 /* Fallback: treat (possibly) multiple physical monitors as if they
6056 formed a single monitor as a whole. This should provide a
6057 consistent result at least on single monitor environments. */
6058 attributes = Fcons (Fcons (Qname, build_string ("combined screen")),
6059 attributes);
6060
6061 frames = Qnil;
6062 FOR_EACH_FRAME (rest, frame)
6063 {
6064 struct frame *f = XFRAME (frame);
6065
6066 if (FRAME_W32_P (f) && !EQ (frame, tip_frame))
6067 frames = Fcons (frame, frames);
6068 }
6069 attributes = Fcons (Fcons (Qframes, frames), attributes);
6070
6071 pixel_width = x_display_pixel_width (dpyinfo);
6072 pixel_height = x_display_pixel_height (dpyinfo);
6073
6074 hdc = GetDC (NULL);
6075 mm_per_pixel = ((double) GetDeviceCaps (hdc, HORZSIZE)
6076 / GetDeviceCaps (hdc, HORZRES));
6077 width_mm = pixel_width * mm_per_pixel + 0.5;
6078 mm_per_pixel = ((double) GetDeviceCaps (hdc, VERTSIZE)
6079 / GetDeviceCaps (hdc, VERTRES));
6080 height_mm = pixel_height * mm_per_pixel + 0.5;
6081 ReleaseDC (NULL, hdc);
6082 attributes = Fcons (Fcons (Qmm_size, list2i (width_mm, height_mm)),
6083 attributes);
6084
6085 /* GetSystemMetrics below may return 0 for Windows 95 or NT 4.0, but
6086 we don't care. */
6087 geometry = list4i (GetSystemMetrics (SM_XVIRTUALSCREEN),
6088 GetSystemMetrics (SM_YVIRTUALSCREEN),
6089 pixel_width, pixel_height);
6090 if (SystemParametersInfo (SPI_GETWORKAREA, 0, &workarea_rect, 0))
6091 workarea = list4i (workarea_rect.left, workarea_rect.top,
6092 workarea_rect.right - workarea_rect.left,
6093 workarea_rect.bottom - workarea_rect.top);
6094 else
6095 workarea = geometry;
6096 attributes = Fcons (Fcons (Qworkarea, workarea), attributes);
6097
6098 attributes = Fcons (Fcons (Qgeometry, geometry), attributes);
6099
6100 return list1 (attributes);
6101 }
6102
6103 DEFUN ("w32-display-monitor-attributes-list", Fw32_display_monitor_attributes_list,
6104 Sw32_display_monitor_attributes_list,
6105 0, 1, 0,
6106 doc: /* Return a list of physical monitor attributes on the W32 display DISPLAY.
6107
6108 The optional argument DISPLAY specifies which display to ask about.
6109 DISPLAY should be either a frame or a display name (a string).
6110 If omitted or nil, that stands for the selected frame's display.
6111
6112 Internal use only, use `display-monitor-attributes-list' instead. */)
6113 (Lisp_Object display)
6114 {
6115 struct w32_display_info *dpyinfo = check_x_display_info (display);
6116 Lisp_Object attributes_list;
6117
6118 block_input ();
6119 attributes_list = w32_display_monitor_attributes_list ();
6120 if (NILP (attributes_list))
6121 attributes_list = w32_display_monitor_attributes_list_fallback (dpyinfo);
6122 unblock_input ();
6123
6124 return attributes_list;
6125 }
6126
6127 DEFUN ("set-message-beep", Fset_message_beep, Sset_message_beep, 1, 1, 0,
6128 doc: /* Set the sound generated when the bell is rung.
6129 SOUND is `asterisk', `exclamation', `hand', `question', `ok', or `silent'
6130 to use the corresponding system sound for the bell. The `silent' sound
6131 prevents Emacs from making any sound at all.
6132 SOUND is nil to use the normal beep. */)
6133 (Lisp_Object sound)
6134 {
6135 CHECK_SYMBOL (sound);
6136
6137 if (NILP (sound))
6138 sound_type = 0xFFFFFFFF;
6139 else if (EQ (sound, intern ("asterisk")))
6140 sound_type = MB_ICONASTERISK;
6141 else if (EQ (sound, intern ("exclamation")))
6142 sound_type = MB_ICONEXCLAMATION;
6143 else if (EQ (sound, intern ("hand")))
6144 sound_type = MB_ICONHAND;
6145 else if (EQ (sound, intern ("question")))
6146 sound_type = MB_ICONQUESTION;
6147 else if (EQ (sound, intern ("ok")))
6148 sound_type = MB_OK;
6149 else if (EQ (sound, intern ("silent")))
6150 sound_type = MB_EMACS_SILENT;
6151 else
6152 sound_type = 0xFFFFFFFF;
6153
6154 return sound;
6155 }
6156
6157 int
6158 x_screen_planes (register struct frame *f)
6159 {
6160 return FRAME_DISPLAY_INFO (f)->n_planes;
6161 }
6162 \f
6163 /* Return the display structure for the display named NAME.
6164 Open a new connection if necessary. */
6165
6166 struct w32_display_info *
6167 x_display_info_for_name (Lisp_Object name)
6168 {
6169 struct w32_display_info *dpyinfo;
6170
6171 CHECK_STRING (name);
6172
6173 for (dpyinfo = &one_w32_display_info; dpyinfo; dpyinfo = dpyinfo->next)
6174 if (!NILP (Fstring_equal (XCAR (dpyinfo->name_list_element), name)))
6175 return dpyinfo;
6176
6177 /* Use this general default value to start with. */
6178 Vx_resource_name = Vinvocation_name;
6179
6180 validate_x_resource_name ();
6181
6182 dpyinfo = w32_term_init (name, NULL, SSDATA (Vx_resource_name));
6183
6184 if (dpyinfo == 0)
6185 error ("Cannot connect to server %s", SDATA (name));
6186
6187 XSETFASTINT (Vwindow_system_version, w32_major_version);
6188
6189 return dpyinfo;
6190 }
6191
6192 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
6193 1, 3, 0, doc: /* Open a connection to a display server.
6194 DISPLAY is the name of the display to connect to.
6195 Optional second arg XRM-STRING is a string of resources in xrdb format.
6196 If the optional third arg MUST-SUCCEED is non-nil,
6197 terminate Emacs if we can't open the connection.
6198 \(In the Nextstep version, the last two arguments are currently ignored.) */)
6199 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
6200 {
6201 char *xrm_option;
6202 struct w32_display_info *dpyinfo;
6203
6204 CHECK_STRING (display);
6205
6206 /* Signal an error in order to encourage correct use from callers.
6207 * If we ever support multiple window systems in the same Emacs,
6208 * we'll need callers to be precise about what window system they
6209 * want. */
6210
6211 if (strcmp (SSDATA (display), "w32") != 0)
6212 error ("The name of the display in this Emacs must be \"w32\"");
6213
6214 /* If initialization has already been done, return now to avoid
6215 overwriting critical parts of one_w32_display_info. */
6216 if (window_system_available (NULL))
6217 return Qnil;
6218
6219 if (! NILP (xrm_string))
6220 CHECK_STRING (xrm_string);
6221
6222 /* Allow color mapping to be defined externally; first look in user's
6223 HOME directory, then in Emacs etc dir for a file called rgb.txt. */
6224 {
6225 Lisp_Object color_file;
6226
6227 color_file = build_string ("~/rgb.txt");
6228
6229 if (NILP (Ffile_readable_p (color_file)))
6230 color_file =
6231 Fexpand_file_name (build_string ("rgb.txt"),
6232 Fsymbol_value (intern ("data-directory")));
6233
6234 Vw32_color_map = Fx_load_color_file (color_file);
6235 }
6236 if (NILP (Vw32_color_map))
6237 Vw32_color_map = w32_default_color_map ();
6238
6239 /* Merge in system logical colors. */
6240 add_system_logical_colors_to_map (&Vw32_color_map);
6241
6242 if (! NILP (xrm_string))
6243 xrm_option = SSDATA (xrm_string);
6244 else
6245 xrm_option = NULL;
6246
6247 /* Use this general default value to start with. */
6248 /* First remove .exe suffix from invocation-name - it looks ugly. */
6249 {
6250 char basename[ MAX_PATH ], *str;
6251
6252 lispstpcpy (basename, Vinvocation_name);
6253 str = strrchr (basename, '.');
6254 if (str) *str = 0;
6255 Vinvocation_name = build_string (basename);
6256 }
6257 Vx_resource_name = Vinvocation_name;
6258
6259 validate_x_resource_name ();
6260
6261 /* This is what opens the connection and sets x_current_display.
6262 This also initializes many symbols, such as those used for input. */
6263 dpyinfo = w32_term_init (display, xrm_option, SSDATA (Vx_resource_name));
6264
6265 if (dpyinfo == 0)
6266 {
6267 if (!NILP (must_succeed))
6268 fatal ("Cannot connect to server %s.\n",
6269 SDATA (display));
6270 else
6271 error ("Cannot connect to server %s", SDATA (display));
6272 }
6273
6274 XSETFASTINT (Vwindow_system_version, w32_major_version);
6275 return Qnil;
6276 }
6277
6278 DEFUN ("x-close-connection", Fx_close_connection,
6279 Sx_close_connection, 1, 1, 0,
6280 doc: /* Close the connection to DISPLAY's server.
6281 For DISPLAY, specify either a frame or a display name (a string).
6282 If DISPLAY is nil, that stands for the selected frame's display. */)
6283 (Lisp_Object display)
6284 {
6285 struct w32_display_info *dpyinfo = check_x_display_info (display);
6286
6287 if (dpyinfo->reference_count > 0)
6288 error ("Display still has frames on it");
6289
6290 block_input ();
6291 x_destroy_all_bitmaps (dpyinfo);
6292
6293 x_delete_display (dpyinfo);
6294 unblock_input ();
6295
6296 return Qnil;
6297 }
6298
6299 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
6300 doc: /* Return the list of display names that Emacs has connections to. */)
6301 (void)
6302 {
6303 Lisp_Object result = Qnil;
6304 struct w32_display_info *wdi;
6305
6306 for (wdi = x_display_list; wdi; wdi = wdi->next)
6307 result = Fcons (XCAR (wdi->name_list_element), result);
6308
6309 return result;
6310 }
6311
6312 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
6313 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
6314 This function only has an effect on X Windows. With MS Windows, it is
6315 defined but does nothing.
6316
6317 If ON is nil, allow buffering of requests.
6318 Turning on synchronization prohibits the Xlib routines from buffering
6319 requests and seriously degrades performance, but makes debugging much
6320 easier.
6321 The optional second argument TERMINAL specifies which display to act on.
6322 TERMINAL should be a terminal object, a frame or a display name (a string).
6323 If TERMINAL is omitted or nil, that stands for the selected frame's display. */)
6324 (Lisp_Object on, Lisp_Object display)
6325 {
6326 return Qnil;
6327 }
6328
6329
6330 \f
6331 /***********************************************************************
6332 Window properties
6333 ***********************************************************************/
6334
6335 #if 0 /* TODO : port window properties to W32 */
6336
6337 DEFUN ("x-change-window-property", Fx_change_window_property,
6338 Sx_change_window_property, 2, 6, 0,
6339 doc: /* Change window property PROP to VALUE on the X window of FRAME.
6340 PROP must be a string. VALUE may be a string or a list of conses,
6341 numbers and/or strings. If an element in the list is a string, it is
6342 converted to an atom and the value of the Atom is used. If an element
6343 is a cons, it is converted to a 32 bit number where the car is the 16
6344 top bits and the cdr is the lower 16 bits.
6345
6346 FRAME nil or omitted means use the selected frame.
6347 If TYPE is given and non-nil, it is the name of the type of VALUE.
6348 If TYPE is not given or nil, the type is STRING.
6349 FORMAT gives the size in bits of each element if VALUE is a list.
6350 It must be one of 8, 16 or 32.
6351 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
6352 If OUTER-P is non-nil, the property is changed for the outer X window of
6353 FRAME. Default is to change on the edit X window. */)
6354 (Lisp_Object prop, Lisp_Object value, Lisp_Object frame,
6355 Lisp_Object type, Lisp_Object format, Lisp_Object outer_p)
6356 {
6357 struct frame *f = decode_window_system_frame (frame);
6358 Atom prop_atom;
6359
6360 CHECK_STRING (prop);
6361 CHECK_STRING (value);
6362
6363 block_input ();
6364 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
6365 XChangeProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
6366 prop_atom, XA_STRING, 8, PropModeReplace,
6367 SDATA (value), SCHARS (value));
6368
6369 /* Make sure the property is set when we return. */
6370 XFlush (FRAME_W32_DISPLAY (f));
6371 unblock_input ();
6372
6373 return value;
6374 }
6375
6376
6377 DEFUN ("x-delete-window-property", Fx_delete_window_property,
6378 Sx_delete_window_property, 1, 2, 0,
6379 doc: /* Remove window property PROP from X window of FRAME.
6380 FRAME nil or omitted means use the selected frame. Value is PROP. */)
6381 (Lisp_Object prop, Lisp_Object frame)
6382 {
6383 struct frame *f = decode_window_system_frame (frame);
6384 Atom prop_atom;
6385
6386 CHECK_STRING (prop);
6387 block_input ();
6388 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
6389 XDeleteProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f), prop_atom);
6390
6391 /* Make sure the property is removed when we return. */
6392 XFlush (FRAME_W32_DISPLAY (f));
6393 unblock_input ();
6394
6395 return prop;
6396 }
6397
6398
6399 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
6400 1, 6, 0,
6401 doc: /* Value is the value of window property PROP on FRAME.
6402 If FRAME is nil or omitted, use the selected frame.
6403
6404 On X Windows, the following optional arguments are also accepted:
6405 If TYPE is nil or omitted, get the property as a string.
6406 Otherwise TYPE is the name of the atom that denotes the type expected.
6407 If SOURCE is non-nil, get the property on that window instead of from
6408 FRAME. The number 0 denotes the root window.
6409 If DELETE-P is non-nil, delete the property after retrieving it.
6410 If VECTOR-RET-P is non-nil, don't return a string but a vector of values.
6411
6412 On MS Windows, this function accepts but ignores those optional arguments.
6413
6414 Value is nil if FRAME hasn't a property with name PROP or if PROP has
6415 no value of TYPE (always string in the MS Windows case). */)
6416 (Lisp_Object prop, Lisp_Object frame, Lisp_Object type,
6417 Lisp_Object source, Lisp_Object delete_p, Lisp_Object vector_ret_p)
6418 {
6419 struct frame *f = decode_window_system_frame (frame);
6420 Atom prop_atom;
6421 int rc;
6422 Lisp_Object prop_value = Qnil;
6423 char *tmp_data = NULL;
6424 Atom actual_type;
6425 int actual_format;
6426 unsigned long actual_size, bytes_remaining;
6427
6428 CHECK_STRING (prop);
6429 block_input ();
6430 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
6431 rc = XGetWindowProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
6432 prop_atom, 0, 0, False, XA_STRING,
6433 &actual_type, &actual_format, &actual_size,
6434 &bytes_remaining, (unsigned char **) &tmp_data);
6435 if (rc == Success)
6436 {
6437 int size = bytes_remaining;
6438
6439 XFree (tmp_data);
6440 tmp_data = NULL;
6441
6442 rc = XGetWindowProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
6443 prop_atom, 0, bytes_remaining,
6444 False, XA_STRING,
6445 &actual_type, &actual_format,
6446 &actual_size, &bytes_remaining,
6447 (unsigned char **) &tmp_data);
6448 if (rc == Success)
6449 prop_value = make_string (tmp_data, size);
6450
6451 XFree (tmp_data);
6452 }
6453
6454 unblock_input ();
6455
6456 return prop_value;
6457
6458 return Qnil;
6459 }
6460
6461 #endif /* TODO */
6462
6463 /***********************************************************************
6464 Tool tips
6465 ***********************************************************************/
6466
6467 static void compute_tip_xy (struct frame *, Lisp_Object, Lisp_Object,
6468 Lisp_Object, int, int, int *, int *);
6469
6470 /* The frame of a currently visible tooltip. */
6471
6472 Lisp_Object tip_frame;
6473
6474 /* If non-nil, a timer started that hides the last tooltip when it
6475 fires. */
6476
6477 Lisp_Object tip_timer;
6478 Window tip_window;
6479
6480 /* If non-nil, a vector of 3 elements containing the last args
6481 with which x-show-tip was called. See there. */
6482
6483 Lisp_Object last_show_tip_args;
6484
6485
6486 static void
6487 unwind_create_tip_frame (Lisp_Object frame)
6488 {
6489 Lisp_Object deleted;
6490
6491 deleted = unwind_create_frame (frame);
6492 if (EQ (deleted, Qt))
6493 {
6494 tip_window = NULL;
6495 tip_frame = Qnil;
6496 }
6497 }
6498
6499
6500 /* Create a frame for a tooltip on the display described by DPYINFO.
6501 PARMS is a list of frame parameters. Value is the frame.
6502
6503 Note that functions called here, esp. x_default_parameter can
6504 signal errors, for instance when a specified color name is
6505 undefined. We have to make sure that we're in a consistent state
6506 when this happens. */
6507
6508 static Lisp_Object
6509 x_create_tip_frame (struct w32_display_info *dpyinfo, Lisp_Object parms)
6510 {
6511 struct frame *f;
6512 Lisp_Object frame;
6513 Lisp_Object name;
6514 int width, height;
6515 ptrdiff_t count = SPECPDL_INDEX ();
6516 struct kboard *kb;
6517 bool face_change_before = face_change;
6518 int x_width = 0, x_height = 0;
6519
6520 /* Use this general default value to start with until we know if
6521 this frame has a specified name. */
6522 Vx_resource_name = Vinvocation_name;
6523
6524 kb = dpyinfo->terminal->kboard;
6525
6526 /* The calls to x_get_arg remove elements from PARMS, so copy it to
6527 avoid destructive changes behind our caller's back. */
6528 parms = Fcopy_alist (parms);
6529
6530 /* Get the name of the frame to use for resource lookup. */
6531 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
6532 if (!STRINGP (name)
6533 && !EQ (name, Qunbound)
6534 && !NILP (name))
6535 error ("Invalid frame name--not a string or nil");
6536 Vx_resource_name = name;
6537
6538 frame = Qnil;
6539 /* Make a frame without minibuffer nor mode-line. */
6540 f = make_frame (false);
6541 f->wants_modeline = false;
6542 XSETFRAME (frame, f);
6543
6544 record_unwind_protect (unwind_create_tip_frame, frame);
6545
6546 /* By setting the output method, we're essentially saying that
6547 the frame is live, as per FRAME_LIVE_P. If we get a signal
6548 from this point on, x_destroy_window might screw up reference
6549 counts etc. */
6550 f->terminal = dpyinfo->terminal;
6551 f->output_method = output_w32;
6552 f->output_data.w32 = xzalloc (sizeof (struct w32_output));
6553
6554 FRAME_FONTSET (f) = -1;
6555 fset_icon_name (f, Qnil);
6556
6557 #ifdef GLYPH_DEBUG
6558 image_cache_refcount =
6559 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
6560 dpyinfo_refcount = dpyinfo->reference_count;
6561 #endif /* GLYPH_DEBUG */
6562 FRAME_KBOARD (f) = kb;
6563 f->output_data.w32->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
6564 f->output_data.w32->explicit_parent = false;
6565
6566 /* Set the name; the functions to which we pass f expect the name to
6567 be set. */
6568 if (EQ (name, Qunbound) || NILP (name))
6569 {
6570 fset_name (f, build_string (dpyinfo->w32_id_name));
6571 f->explicit_name = false;
6572 }
6573 else
6574 {
6575 fset_name (f, name);
6576 f->explicit_name = true;
6577 /* Use the frame's title when getting resources for this frame. */
6578 specbind (Qx_resource_name, name);
6579 }
6580
6581 if (uniscribe_available)
6582 register_font_driver (&uniscribe_font_driver, f);
6583 register_font_driver (&w32font_driver, f);
6584
6585 x_default_parameter (f, parms, Qfont_backend, Qnil,
6586 "fontBackend", "FontBackend", RES_TYPE_STRING);
6587
6588 /* Extract the window parameters from the supplied values
6589 that are needed to determine window geometry. */
6590 x_default_font_parameter (f, parms);
6591
6592 x_default_parameter (f, parms, Qborder_width, make_number (2),
6593 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
6594 /* This defaults to 2 in order to match xterm. We recognize either
6595 internalBorderWidth or internalBorder (which is what xterm calls
6596 it). */
6597 if (NILP (Fassq (Qinternal_border_width, parms)))
6598 {
6599 Lisp_Object value;
6600
6601 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
6602 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
6603 if (! EQ (value, Qunbound))
6604 parms = Fcons (Fcons (Qinternal_border_width, value),
6605 parms);
6606 }
6607
6608 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
6609 "internalBorderWidth", "internalBorderWidth",
6610 RES_TYPE_NUMBER);
6611 /* Also do the stuff which must be set before the window exists. */
6612 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
6613 "foreground", "Foreground", RES_TYPE_STRING);
6614 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
6615 "background", "Background", RES_TYPE_STRING);
6616 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
6617 "pointerColor", "Foreground", RES_TYPE_STRING);
6618 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
6619 "cursorColor", "Foreground", RES_TYPE_STRING);
6620 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
6621 "borderColor", "BorderColor", RES_TYPE_STRING);
6622
6623 /* Init faces before x_default_parameter is called for the
6624 scroll-bar-width parameter because otherwise we end up in
6625 init_iterator with a null face cache, which should not happen. */
6626 init_frame_faces (f);
6627
6628 f->output_data.w32->dwStyle = WS_BORDER | WS_POPUP | WS_DISABLED;
6629 f->output_data.w32->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
6630
6631 x_figure_window_size (f, parms, true, &x_width, &x_height);
6632
6633 /* No fringes on tip frame. */
6634 f->fringe_cols = 0;
6635 f->left_fringe_width = 0;
6636 f->right_fringe_width = 0;
6637 /* No dividers on tip frame. */
6638 f->right_divider_width = 0;
6639 f->bottom_divider_width = 0;
6640
6641 block_input ();
6642 my_create_tip_window (f);
6643 unblock_input ();
6644
6645 x_make_gc (f);
6646
6647 x_default_parameter (f, parms, Qauto_raise, Qnil,
6648 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
6649 x_default_parameter (f, parms, Qauto_lower, Qnil,
6650 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
6651 x_default_parameter (f, parms, Qcursor_type, Qbox,
6652 "cursorType", "CursorType", RES_TYPE_SYMBOL);
6653 /* Process alpha here (Bug#17344). */
6654 x_default_parameter (f, parms, Qalpha, Qnil,
6655 "alpha", "Alpha", RES_TYPE_NUMBER);
6656
6657 /* Dimensions, especially FRAME_LINES (f), must be done via
6658 change_frame_size. Change will not be effected unless different
6659 from the current FRAME_LINES (f). */
6660 width = FRAME_COLS (f);
6661 height = FRAME_LINES (f);
6662 SET_FRAME_COLS (f, 0);
6663 SET_FRAME_LINES (f, 0);
6664 adjust_frame_size (f, width * FRAME_COLUMN_WIDTH (f),
6665 height * FRAME_LINE_HEIGHT (f), 0, true, Qtip_frame);
6666 /* Add `tooltip' frame parameter's default value. */
6667 if (NILP (Fframe_parameter (frame, Qtooltip)))
6668 Fmodify_frame_parameters (frame, Fcons (Fcons (Qtooltip, Qt), Qnil));
6669
6670 /* Set up faces after all frame parameters are known. This call
6671 also merges in face attributes specified for new frames.
6672
6673 Frame parameters may be changed if .Xdefaults contains
6674 specifications for the default font. For example, if there is an
6675 `Emacs.default.attributeBackground: pink', the `background-color'
6676 attribute of the frame get's set, which let's the internal border
6677 of the tooltip frame appear in pink. Prevent this. */
6678 {
6679 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
6680 Lisp_Object fg = Fframe_parameter (frame, Qforeground_color);
6681 Lisp_Object colors = Qnil;
6682
6683 call2 (Qface_set_after_frame_default, frame, Qnil);
6684
6685 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
6686 colors = Fcons (Fcons (Qbackground_color, bg), colors);
6687 if (!EQ (fg, Fframe_parameter (frame, Qforeground_color)))
6688 colors = Fcons (Fcons (Qforeground_color, fg), colors);
6689
6690 if (!NILP (colors))
6691 Fmodify_frame_parameters (frame, colors);
6692 }
6693
6694 f->no_split = true;
6695
6696 /* Now that the frame is official, it counts as a reference to
6697 its display. */
6698 FRAME_DISPLAY_INFO (f)->reference_count++;
6699 f->terminal->reference_count++;
6700
6701 /* It is now ok to make the frame official even if we get an error
6702 below. And the frame needs to be on Vframe_list or making it
6703 visible won't work. */
6704 Vframe_list = Fcons (frame, Vframe_list);
6705 f->can_x_set_window_size = true;
6706
6707 /* Setting attributes of faces of the tooltip frame from resources
6708 and similar will set face_change, which leads to the
6709 clearing of all current matrices. Since this isn't necessary
6710 here, avoid it by resetting face_change to the value it
6711 had before we created the tip frame. */
6712 face_change = face_change_before;
6713
6714 /* Discard the unwind_protect. */
6715 return unbind_to (count, frame);
6716 }
6717
6718
6719 /* Compute where to display tip frame F. PARMS is the list of frame
6720 parameters for F. DX and DY are specified offsets from the current
6721 location of the mouse. WIDTH and HEIGHT are the width and height
6722 of the tooltip. Return coordinates relative to the root window of
6723 the display in *ROOT_X and *ROOT_Y. */
6724
6725 static void
6726 compute_tip_xy (struct frame *f,
6727 Lisp_Object parms, Lisp_Object dx, Lisp_Object dy,
6728 int width, int height, int *root_x, int *root_y)
6729 {
6730 Lisp_Object left, top, right, bottom;
6731 int min_x, min_y, max_x, max_y;
6732
6733 /* User-specified position? */
6734 left = Fcdr (Fassq (Qleft, parms));
6735 top = Fcdr (Fassq (Qtop, parms));
6736 right = Fcdr (Fassq (Qright, parms));
6737 bottom = Fcdr (Fassq (Qbottom, parms));
6738
6739 /* Move the tooltip window where the mouse pointer is. Resize and
6740 show it. */
6741 if ((!INTEGERP (left) && !INTEGERP (right))
6742 || (!INTEGERP (top) && !INTEGERP (bottom)))
6743 {
6744 POINT pt;
6745
6746 /* Default min and max values. */
6747 min_x = 0;
6748 min_y = 0;
6749 max_x = x_display_pixel_width (FRAME_DISPLAY_INFO (f));
6750 max_y = x_display_pixel_height (FRAME_DISPLAY_INFO (f));
6751
6752 block_input ();
6753 GetCursorPos (&pt);
6754 *root_x = pt.x;
6755 *root_y = pt.y;
6756 unblock_input ();
6757
6758 /* If multiple monitor support is available, constrain the tip onto
6759 the current monitor. This improves the above by allowing negative
6760 co-ordinates if monitor positions are such that they are valid, and
6761 snaps a tooltip onto a single monitor if we are close to the edge
6762 where it would otherwise flow onto the other monitor (or into
6763 nothingness if there is a gap in the overlap). */
6764 if (monitor_from_point_fn && get_monitor_info_fn)
6765 {
6766 struct MONITOR_INFO info;
6767 HMONITOR monitor
6768 = monitor_from_point_fn (pt, MONITOR_DEFAULT_TO_NEAREST);
6769 info.cbSize = sizeof (info);
6770
6771 if (get_monitor_info_fn (monitor, &info))
6772 {
6773 min_x = info.rcWork.left;
6774 min_y = info.rcWork.top;
6775 max_x = info.rcWork.right;
6776 max_y = info.rcWork.bottom;
6777 }
6778 }
6779 }
6780
6781 if (INTEGERP (top))
6782 *root_y = XINT (top);
6783 else if (INTEGERP (bottom))
6784 *root_y = XINT (bottom) - height;
6785 else if (*root_y + XINT (dy) <= min_y)
6786 *root_y = min_y; /* Can happen for negative dy */
6787 else if (*root_y + XINT (dy) + height <= max_y)
6788 /* It fits below the pointer */
6789 *root_y += XINT (dy);
6790 else if (height + XINT (dy) + min_y <= *root_y)
6791 /* It fits above the pointer. */
6792 *root_y -= height + XINT (dy);
6793 else
6794 /* Put it on the top. */
6795 *root_y = min_y;
6796
6797 if (INTEGERP (left))
6798 *root_x = XINT (left);
6799 else if (INTEGERP (right))
6800 *root_x = XINT (right) - width;
6801 else if (*root_x + XINT (dx) <= min_x)
6802 *root_x = 0; /* Can happen for negative dx */
6803 else if (*root_x + XINT (dx) + width <= max_x)
6804 /* It fits to the right of the pointer. */
6805 *root_x += XINT (dx);
6806 else if (width + XINT (dx) + min_x <= *root_x)
6807 /* It fits to the left of the pointer. */
6808 *root_x -= width + XINT (dx);
6809 else
6810 /* Put it left justified on the screen -- it ought to fit that way. */
6811 *root_x = min_x;
6812 }
6813
6814 /* Hide tooltip. Delete its frame if DELETE is true. */
6815 static Lisp_Object
6816 x_hide_tip (bool delete)
6817 {
6818 if (!NILP (tip_timer))
6819 {
6820 call1 (Qcancel_timer, tip_timer);
6821 tip_timer = Qnil;
6822 }
6823
6824 if (NILP (tip_frame)
6825 || (!delete && FRAMEP (tip_frame)
6826 && !FRAME_VISIBLE_P (XFRAME (tip_frame))))
6827 return Qnil;
6828 else
6829 {
6830 ptrdiff_t count;
6831 Lisp_Object was_open = Qnil;
6832
6833 count = SPECPDL_INDEX ();
6834 specbind (Qinhibit_redisplay, Qt);
6835 specbind (Qinhibit_quit, Qt);
6836
6837 if (FRAMEP (tip_frame))
6838 {
6839 if (delete)
6840 {
6841 delete_frame (tip_frame, Qnil);
6842 tip_frame = Qnil;
6843 }
6844 else
6845 x_make_frame_invisible (XFRAME (tip_frame));
6846
6847 was_open = Qt;
6848 }
6849 else
6850 tip_frame = Qnil;
6851
6852 return unbind_to (count, was_open);
6853 }
6854 }
6855
6856
6857 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
6858 doc: /* Show STRING in a \"tooltip\" window on frame FRAME.
6859 A tooltip window is a small window displaying a string.
6860
6861 This is an internal function; Lisp code should call `tooltip-show'.
6862
6863 FRAME nil or omitted means use the selected frame.
6864
6865 PARMS is an optional list of frame parameters which can be
6866 used to change the tooltip's appearance.
6867
6868 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
6869 means use the default timeout of 5 seconds.
6870
6871 If the list of frame parameters PARMS contains a `left' parameter,
6872 display the tooltip at that x-position. If the list of frame parameters
6873 PARMS contains no `left' but a `right' parameter, display the tooltip
6874 right-adjusted at that x-position. Otherwise display it at the
6875 x-position of the mouse, with offset DX added (default is 5 if DX isn't
6876 specified).
6877
6878 Likewise for the y-position: If a `top' frame parameter is specified, it
6879 determines the position of the upper edge of the tooltip window. If a
6880 `bottom' parameter but no `top' frame parameter is specified, it
6881 determines the position of the lower edge of the tooltip window.
6882 Otherwise display the tooltip window at the y-position of the mouse,
6883 with offset DY added (default is -10).
6884
6885 A tooltip's maximum size is specified by `x-max-tooltip-size'.
6886 Text larger than the specified size is clipped. */)
6887 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
6888 {
6889 struct frame *f, *tip_f;
6890 struct window *w;
6891 int root_x, root_y;
6892 struct buffer *old_buffer;
6893 struct text_pos pos;
6894 int i, width, height;
6895 int old_windows_or_buffers_changed = windows_or_buffers_changed;
6896 ptrdiff_t count = SPECPDL_INDEX ();
6897 ptrdiff_t count_1;
6898 Lisp_Object window, size;
6899
6900 specbind (Qinhibit_redisplay, Qt);
6901
6902 CHECK_STRING (string);
6903 f = decode_window_system_frame (frame);
6904 if (NILP (timeout))
6905 timeout = make_number (5);
6906 else
6907 CHECK_NATNUM (timeout);
6908
6909 if (NILP (dx))
6910 dx = make_number (5);
6911 else
6912 CHECK_NUMBER (dx);
6913
6914 if (NILP (dy))
6915 dy = make_number (-10);
6916 else
6917 CHECK_NUMBER (dy);
6918
6919 if (NILP (last_show_tip_args))
6920 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
6921
6922 if (FRAMEP (tip_frame) && FRAME_LIVE_P (XFRAME (tip_frame)))
6923 {
6924 Lisp_Object last_string = AREF (last_show_tip_args, 0);
6925 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
6926 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
6927
6928 if (FRAME_VISIBLE_P (XFRAME (tip_frame))
6929 && EQ (frame, last_frame)
6930 && !NILP (Fequal_including_properties (last_string, string))
6931 && !NILP (Fequal (last_parms, parms)))
6932 {
6933 /* Only DX and DY have changed. */
6934 tip_f = XFRAME (tip_frame);
6935 if (!NILP (tip_timer))
6936 {
6937 Lisp_Object timer = tip_timer;
6938
6939 tip_timer = Qnil;
6940 call1 (Qcancel_timer, timer);
6941 }
6942
6943 block_input ();
6944 compute_tip_xy (tip_f, parms, dx, dy, FRAME_PIXEL_WIDTH (tip_f),
6945 FRAME_PIXEL_HEIGHT (tip_f), &root_x, &root_y);
6946
6947 /* Put tooltip in topmost group and in position. */
6948 SetWindowPos (FRAME_W32_WINDOW (tip_f), HWND_TOPMOST,
6949 root_x, root_y, 0, 0,
6950 SWP_NOSIZE | SWP_NOACTIVATE | SWP_NOOWNERZORDER);
6951
6952 /* Ensure tooltip is on top of other topmost windows (eg menus). */
6953 SetWindowPos (FRAME_W32_WINDOW (tip_f), HWND_TOP,
6954 0, 0, 0, 0,
6955 SWP_NOMOVE | SWP_NOSIZE
6956 | SWP_NOACTIVATE | SWP_NOOWNERZORDER);
6957
6958 /* Let redisplay know that we have made the frame visible already. */
6959 SET_FRAME_VISIBLE (tip_f, 1);
6960 ShowWindow (FRAME_W32_WINDOW (tip_f), SW_SHOWNOACTIVATE);
6961 unblock_input ();
6962
6963 goto start_timer;
6964 }
6965 else if (tooltip_reuse_hidden_frame && EQ (frame, last_frame))
6966 {
6967 bool delete = false;
6968 Lisp_Object tail, elt, parm, last;
6969
6970 /* Check if every parameter in PARMS has the same value in
6971 last_parms. This may destruct last_parms which, however,
6972 will be recreated below. */
6973 for (tail = parms; CONSP (tail); tail = XCDR (tail))
6974 {
6975 elt = XCAR (tail);
6976 parm = Fcar (elt);
6977 /* The left, top, right and bottom parameters are handled
6978 by compute_tip_xy so they can be ignored here. */
6979 if (!EQ (parm, Qleft) && !EQ (parm, Qtop)
6980 && !EQ (parm, Qright) && !EQ (parm, Qbottom))
6981 {
6982 last = Fassq (parm, last_parms);
6983 if (NILP (Fequal (Fcdr (elt), Fcdr (last))))
6984 {
6985 /* We lost, delete the old tooltip. */
6986 delete = true;
6987 break;
6988 }
6989 else
6990 last_parms = call2 (Qassq_delete_all, parm, last_parms);
6991 }
6992 else
6993 last_parms = call2 (Qassq_delete_all, parm, last_parms);
6994 }
6995
6996 /* Now check if there's a parameter left in last_parms with a
6997 non-nil value. */
6998 for (tail = last_parms; CONSP (tail); tail = XCDR (tail))
6999 {
7000 elt = XCAR (tail);
7001 parm = Fcar (elt);
7002 if (!EQ (parm, Qleft) && !EQ (parm, Qtop) && !EQ (parm, Qright)
7003 && !EQ (parm, Qbottom) && !NILP (Fcdr (elt)))
7004 {
7005 /* We lost, delete the old tooltip. */
7006 delete = true;
7007 break;
7008 }
7009 }
7010
7011 x_hide_tip (delete);
7012 }
7013 else
7014 x_hide_tip (true);
7015 }
7016 else
7017 x_hide_tip (true);
7018
7019 ASET (last_show_tip_args, 0, string);
7020 ASET (last_show_tip_args, 1, frame);
7021 ASET (last_show_tip_args, 2, parms);
7022
7023 /* Block input until the tip has been fully drawn, to avoid crashes
7024 when drawing tips in menus. */
7025 block_input ();
7026
7027 if (!FRAMEP (tip_frame) || !FRAME_LIVE_P (XFRAME (tip_frame)))
7028 {
7029 /* Add default values to frame parameters. */
7030 if (NILP (Fassq (Qname, parms)))
7031 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
7032 if (NILP (Fassq (Qinternal_border_width, parms)))
7033 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
7034 if (NILP (Fassq (Qborder_width, parms)))
7035 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
7036 if (NILP (Fassq (Qborder_color, parms)))
7037 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
7038 if (NILP (Fassq (Qbackground_color, parms)))
7039 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
7040 parms);
7041
7042 /* Create a frame for the tooltip, and record it in the global
7043 variable tip_frame. */
7044 if (NILP (tip_frame = x_create_tip_frame (FRAME_DISPLAY_INFO (f), parms)))
7045 {
7046 /* Creating the tip frame failed. */
7047 unblock_input ();
7048 return unbind_to (count, Qnil);
7049 }
7050 }
7051
7052 tip_f = XFRAME (tip_frame);
7053 window = FRAME_ROOT_WINDOW (tip_f);
7054 AUTO_STRING (tip, " *tip*");
7055 set_window_buffer (window, Fget_buffer_create (tip), false, false);
7056 w = XWINDOW (window);
7057 w->pseudo_window_p = true;
7058
7059 /* Set up the frame's root window. Note: The following code does not
7060 try to size the window or its frame correctly. Its only purpose is
7061 to make the subsequent text size calculations work. The right
7062 sizes should get installed when the toolkit gets back to us. */
7063 w->left_col = 0;
7064 w->top_line = 0;
7065 w->pixel_left = 0;
7066 w->pixel_top = 0;
7067
7068 if (CONSP (Vx_max_tooltip_size)
7069 && RANGED_INTEGERP (1, XCAR (Vx_max_tooltip_size), INT_MAX)
7070 && RANGED_INTEGERP (1, XCDR (Vx_max_tooltip_size), INT_MAX))
7071 {
7072 w->total_cols = XFASTINT (XCAR (Vx_max_tooltip_size));
7073 w->total_lines = XFASTINT (XCDR (Vx_max_tooltip_size));
7074 }
7075 else
7076 {
7077 w->total_cols = 80;
7078 w->total_lines = 40;
7079 }
7080
7081 w->pixel_width = w->total_cols * FRAME_COLUMN_WIDTH (tip_f);
7082 w->pixel_height = w->total_lines * FRAME_LINE_HEIGHT (tip_f);
7083 FRAME_TOTAL_COLS (tip_f) = WINDOW_TOTAL_COLS (w);
7084 adjust_frame_glyphs (tip_f);
7085
7086 /* Insert STRING into the root window's buffer and fit the frame to
7087 the buffer. */
7088 count_1 = SPECPDL_INDEX ();
7089 old_buffer = current_buffer;
7090 set_buffer_internal_1 (XBUFFER (w->contents));
7091 bset_truncate_lines (current_buffer, Qnil);
7092 specbind (Qinhibit_read_only, Qt);
7093 specbind (Qinhibit_modification_hooks, Qt);
7094 specbind (Qinhibit_point_motion_hooks, Qt);
7095 Ferase_buffer ();
7096 Finsert (1, &string);
7097 clear_glyph_matrix (w->desired_matrix);
7098 clear_glyph_matrix (w->current_matrix);
7099 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
7100 try_window (window, pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
7101 /* Calculate size of tooltip window. */
7102 size = Fwindow_text_pixel_size (window, Qnil, Qnil, Qnil,
7103 make_number (w->pixel_height), Qnil);
7104 /* Add the frame's internal border to calculated size. */
7105 width = XINT (Fcar (size)) + 2 * FRAME_INTERNAL_BORDER_WIDTH (tip_f);
7106 height = XINT (Fcdr (size)) + 2 * FRAME_INTERNAL_BORDER_WIDTH (tip_f);
7107 /* Calculate position of tooltip frame. */
7108 compute_tip_xy (tip_f, parms, dx, dy, width, height, &root_x, &root_y);
7109
7110 /* Show tooltip frame. */
7111 {
7112 RECT rect;
7113 int pad = (NUMBERP (Vw32_tooltip_extra_pixels)
7114 ? max (0, XINT (Vw32_tooltip_extra_pixels))
7115 : FRAME_COLUMN_WIDTH (tip_f));
7116
7117 rect.left = rect.top = 0;
7118 rect.right = width;
7119 rect.bottom = height;
7120 AdjustWindowRect (&rect, tip_f->output_data.w32->dwStyle,
7121 FRAME_EXTERNAL_MENU_BAR (tip_f));
7122
7123 /* Position and size tooltip and put it in the topmost group. */
7124 SetWindowPos (FRAME_W32_WINDOW (tip_f), HWND_TOPMOST,
7125 root_x, root_y,
7126 rect.right - rect.left + pad,
7127 rect.bottom - rect.top, SWP_NOACTIVATE | SWP_NOOWNERZORDER);
7128
7129 /* Ensure tooltip is on top of other topmost windows (eg menus). */
7130 SetWindowPos (FRAME_W32_WINDOW (tip_f), HWND_TOP,
7131 0, 0, 0, 0,
7132 SWP_NOMOVE | SWP_NOSIZE
7133 | SWP_NOACTIVATE | SWP_NOOWNERZORDER);
7134
7135 /* Let redisplay know that we have made the frame visible already. */
7136 SET_FRAME_VISIBLE (tip_f, 1);
7137
7138 ShowWindow (FRAME_W32_WINDOW (tip_f), SW_SHOWNOACTIVATE);
7139 }
7140
7141 w->must_be_updated_p = true;
7142 update_single_window (w);
7143 set_buffer_internal_1 (old_buffer);
7144 unbind_to (count_1, Qnil);
7145 unblock_input ();
7146 windows_or_buffers_changed = old_windows_or_buffers_changed;
7147
7148 start_timer:
7149 /* Let the tip disappear after timeout seconds. */
7150 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
7151 intern ("x-hide-tip"));
7152
7153 return unbind_to (count, Qnil);
7154 }
7155
7156
7157 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
7158 doc: /* Hide the current tooltip window, if there is any.
7159 Value is t if tooltip was open, nil otherwise. */)
7160 (void)
7161 {
7162 return x_hide_tip (!tooltip_reuse_hidden_frame);
7163 }
7164 \f
7165 /***********************************************************************
7166 File selection dialog
7167 ***********************************************************************/
7168
7169 #define FILE_NAME_TEXT_FIELD edt1
7170 #define FILE_NAME_COMBO_BOX cmb13
7171 #define FILE_NAME_LIST lst1
7172
7173 /* Callback for altering the behavior of the Open File dialog.
7174 Makes the Filename text field contain "Current Directory" and be
7175 read-only when "Directories" is selected in the filter. This
7176 allows us to work around the fact that the standard Open File
7177 dialog does not support directories. */
7178 static UINT_PTR CALLBACK
7179 file_dialog_callback (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
7180 {
7181 if (msg == WM_NOTIFY)
7182 {
7183 OFNOTIFYW * notify_w = (OFNOTIFYW *)lParam;
7184 OFNOTIFYA * notify_a = (OFNOTIFYA *)lParam;
7185 int dropdown_changed;
7186 int dir_index;
7187 #ifdef NTGUI_UNICODE
7188 const int use_unicode = 1;
7189 #else /* !NTGUI_UNICODE */
7190 int use_unicode = w32_unicode_filenames;
7191 #endif /* NTGUI_UNICODE */
7192
7193 /* Detect when the Filter dropdown is changed. */
7194 if (use_unicode)
7195 dropdown_changed =
7196 notify_w->hdr.code == CDN_TYPECHANGE
7197 || notify_w->hdr.code == CDN_INITDONE;
7198 else
7199 dropdown_changed =
7200 notify_a->hdr.code == CDN_TYPECHANGE
7201 || notify_a->hdr.code == CDN_INITDONE;
7202 if (dropdown_changed)
7203 {
7204 HWND dialog = GetParent (hwnd);
7205 HWND edit_control = GetDlgItem (dialog, FILE_NAME_TEXT_FIELD);
7206 HWND list = GetDlgItem (dialog, FILE_NAME_LIST);
7207 int hdr_code;
7208
7209 /* At least on Windows 7, the above attempt to get the window handle
7210 to the File Name Text Field fails. The following code does the
7211 job though. Note that this code is based on my examination of the
7212 window hierarchy using Microsoft Spy++. bk */
7213 if (edit_control == NULL)
7214 {
7215 HWND tmp = GetDlgItem (dialog, FILE_NAME_COMBO_BOX);
7216 if (tmp)
7217 {
7218 tmp = GetWindow (tmp, GW_CHILD);
7219 if (tmp)
7220 edit_control = GetWindow (tmp, GW_CHILD);
7221 }
7222 }
7223
7224 /* Directories is in index 2. */
7225 if (use_unicode)
7226 {
7227 dir_index = notify_w->lpOFN->nFilterIndex;
7228 hdr_code = notify_w->hdr.code;
7229 }
7230 else
7231 {
7232 dir_index = notify_a->lpOFN->nFilterIndex;
7233 hdr_code = notify_a->hdr.code;
7234 }
7235 if (dir_index == 2)
7236 {
7237 if (use_unicode)
7238 SendMessageW (dialog, CDM_SETCONTROLTEXT, FILE_NAME_TEXT_FIELD,
7239 (LPARAM)L"Current Directory");
7240 else
7241 SendMessageA (dialog, CDM_SETCONTROLTEXT, FILE_NAME_TEXT_FIELD,
7242 (LPARAM)"Current Directory");
7243 EnableWindow (edit_control, FALSE);
7244 /* Note that at least on Windows 7, the above call to EnableWindow
7245 disables the window that would ordinarily have focus. If we
7246 do not set focus to some other window here, focus will land in
7247 no man's land and the user will be unable to tab through the
7248 dialog box (pressing tab will only result in a beep).
7249 Avoid that problem by setting focus to the list here. */
7250 if (hdr_code == CDN_INITDONE)
7251 SetFocus (list);
7252 }
7253 else
7254 {
7255 /* Don't override default filename on init done. */
7256 if (hdr_code == CDN_TYPECHANGE)
7257 {
7258 if (use_unicode)
7259 SendMessageW (dialog, CDM_SETCONTROLTEXT,
7260 FILE_NAME_TEXT_FIELD, (LPARAM)L"");
7261 else
7262 SendMessageA (dialog, CDM_SETCONTROLTEXT,
7263 FILE_NAME_TEXT_FIELD, (LPARAM)"");
7264 }
7265 EnableWindow (edit_control, TRUE);
7266 }
7267 }
7268 }
7269 return 0;
7270 }
7271
7272 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
7273 doc: /* Read file name, prompting with PROMPT in directory DIR.
7274 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
7275 selection box, if specified. If MUSTMATCH is non-nil, the returned file
7276 or directory must exist.
7277
7278 This function is only defined on NS, MS Windows, and X Windows with the
7279 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
7280 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories.
7281 On Windows 7 and later, the file selection dialog "remembers" the last
7282 directory where the user selected a file, and will open that directory
7283 instead of DIR on subsequent invocations of this function with the same
7284 value of DIR as in previous invocations; this is standard Windows behavior. */)
7285 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
7286 {
7287 /* Filter index: 1: All Files, 2: Directories only */
7288 static const wchar_t filter_w[] = L"All Files (*.*)\0*.*\0Directories\0*|*\0";
7289 static const char filter_a[] = "All Files (*.*)\0*.*\0Directories\0*|*\0";
7290
7291 Lisp_Object filename = default_filename;
7292 struct frame *f = SELECTED_FRAME ();
7293 BOOL file_opened = FALSE;
7294 Lisp_Object orig_dir = dir;
7295 Lisp_Object orig_prompt = prompt;
7296
7297 /* If we compile with _WIN32_WINNT set to 0x0400 (for NT4
7298 compatibility) we end up with the old file dialogs. Define a big
7299 enough struct for the new dialog to trick GetOpenFileName into
7300 giving us the new dialogs on newer versions of Windows. */
7301 struct {
7302 OPENFILENAMEW details;
7303 #if _WIN32_WINNT < 0x500 /* < win2k */
7304 PVOID pvReserved;
7305 DWORD dwReserved;
7306 DWORD FlagsEx;
7307 #endif /* < win2k */
7308 } new_file_details_w;
7309
7310 #ifdef NTGUI_UNICODE
7311 wchar_t filename_buf_w[32*1024 + 1]; // NT kernel maximum
7312 OPENFILENAMEW * file_details_w = &new_file_details_w.details;
7313 const int use_unicode = 1;
7314 #else /* not NTGUI_UNICODE */
7315 struct {
7316 OPENFILENAMEA details;
7317 #if _WIN32_WINNT < 0x500 /* < win2k */
7318 PVOID pvReserved;
7319 DWORD dwReserved;
7320 DWORD FlagsEx;
7321 #endif /* < win2k */
7322 } new_file_details_a;
7323 wchar_t filename_buf_w[MAX_PATH + 1], dir_w[MAX_PATH];
7324 char filename_buf_a[MAX_PATH + 1], dir_a[MAX_PATH];
7325 OPENFILENAMEW * file_details_w = &new_file_details_w.details;
7326 OPENFILENAMEA * file_details_a = &new_file_details_a.details;
7327 int use_unicode = w32_unicode_filenames;
7328 wchar_t *prompt_w;
7329 char *prompt_a;
7330 int len;
7331 char fname_ret[MAX_UTF8_PATH];
7332 #endif /* NTGUI_UNICODE */
7333
7334 {
7335 /* Note: under NTGUI_UNICODE, we do _NOT_ use ENCODE_FILE: the
7336 system file encoding expected by the platform APIs (e.g. Cygwin's
7337 POSIX implementation) may not be the same as the encoding expected
7338 by the Windows "ANSI" APIs! */
7339
7340 CHECK_STRING (prompt);
7341 CHECK_STRING (dir);
7342
7343 dir = Fexpand_file_name (dir, Qnil);
7344
7345 if (STRINGP (filename))
7346 filename = Ffile_name_nondirectory (filename);
7347 else
7348 filename = empty_unibyte_string;
7349
7350 #ifdef CYGWIN
7351 dir = Fcygwin_convert_file_name_to_windows (dir, Qt);
7352 if (SCHARS (filename) > 0)
7353 filename = Fcygwin_convert_file_name_to_windows (filename, Qnil);
7354 #endif
7355
7356 CHECK_STRING (dir);
7357 CHECK_STRING (filename);
7358
7359 /* The code in file_dialog_callback that attempts to set the text
7360 of the file name edit window when handling the CDN_INITDONE
7361 WM_NOTIFY message does not work. Setting filename to "Current
7362 Directory" in the only_dir_p case here does work however. */
7363 if (SCHARS (filename) == 0 && ! NILP (only_dir_p))
7364 filename = build_string ("Current Directory");
7365
7366 /* Convert the values we've computed so far to system form. */
7367 #ifdef NTGUI_UNICODE
7368 to_unicode (prompt, &prompt);
7369 to_unicode (dir, &dir);
7370 to_unicode (filename, &filename);
7371 if (SBYTES (filename) + 1 > sizeof (filename_buf_w))
7372 report_file_error ("filename too long", default_filename);
7373
7374 memcpy (filename_buf_w, SDATA (filename), SBYTES (filename) + 1);
7375 #else /* !NTGUI_UNICODE */
7376 prompt = ENCODE_FILE (prompt);
7377 dir = ENCODE_FILE (dir);
7378 filename = ENCODE_FILE (filename);
7379
7380 /* We modify these in-place, so make copies for safety. */
7381 dir = Fcopy_sequence (dir);
7382 unixtodos_filename (SSDATA (dir));
7383 filename = Fcopy_sequence (filename);
7384 unixtodos_filename (SSDATA (filename));
7385 if (SBYTES (filename) >= MAX_UTF8_PATH)
7386 report_file_error ("filename too long", default_filename);
7387 if (w32_unicode_filenames)
7388 {
7389 filename_to_utf16 (SSDATA (dir), dir_w);
7390 if (filename_to_utf16 (SSDATA (filename), filename_buf_w) != 0)
7391 {
7392 /* filename_to_utf16 sets errno to ENOENT when the file
7393 name is too long or cannot be converted to UTF-16. */
7394 if (errno == ENOENT && filename_buf_w[MAX_PATH - 1] != 0)
7395 report_file_error ("filename too long", default_filename);
7396 }
7397 len = pMultiByteToWideChar (CP_UTF8, multiByteToWideCharFlags,
7398 SSDATA (prompt), -1, NULL, 0);
7399 if (len > 32768)
7400 len = 32768;
7401 prompt_w = alloca (len * sizeof (wchar_t));
7402 pMultiByteToWideChar (CP_UTF8, multiByteToWideCharFlags,
7403 SSDATA (prompt), -1, prompt_w, len);
7404 }
7405 else
7406 {
7407 filename_to_ansi (SSDATA (dir), dir_a);
7408 if (filename_to_ansi (SSDATA (filename), filename_buf_a) != '\0')
7409 {
7410 /* filename_to_ansi sets errno to ENOENT when the file
7411 name is too long or cannot be converted to UTF-16. */
7412 if (errno == ENOENT && filename_buf_a[MAX_PATH - 1] != 0)
7413 report_file_error ("filename too long", default_filename);
7414 }
7415 len = pMultiByteToWideChar (CP_UTF8, multiByteToWideCharFlags,
7416 SSDATA (prompt), -1, NULL, 0);
7417 if (len > 32768)
7418 len = 32768;
7419 prompt_w = alloca (len * sizeof (wchar_t));
7420 pMultiByteToWideChar (CP_UTF8, multiByteToWideCharFlags,
7421 SSDATA (prompt), -1, prompt_w, len);
7422 len = pWideCharToMultiByte (CP_ACP, 0, prompt_w, -1, NULL, 0, NULL, NULL);
7423 if (len > 32768)
7424 len = 32768;
7425 prompt_a = alloca (len);
7426 pWideCharToMultiByte (CP_ACP, 0, prompt_w, -1, prompt_a, len, NULL, NULL);
7427 }
7428 #endif /* NTGUI_UNICODE */
7429
7430 /* Fill in the structure for the call to GetOpenFileName below.
7431 For NTGUI_UNICODE builds (which run only on NT), we just use
7432 the actual size of the structure. For non-NTGUI_UNICODE
7433 builds, we tell the OS we're using an old version of the
7434 structure if the OS isn't new enough to support the newer
7435 version. */
7436 if (use_unicode)
7437 {
7438 memset (&new_file_details_w, 0, sizeof (new_file_details_w));
7439 if (w32_major_version > 4 && w32_major_version < 95)
7440 file_details_w->lStructSize = sizeof (new_file_details_w);
7441 else
7442 file_details_w->lStructSize = sizeof (*file_details_w);
7443 /* Set up the inout parameter for the selected file name. */
7444 file_details_w->lpstrFile = filename_buf_w;
7445 file_details_w->nMaxFile =
7446 sizeof (filename_buf_w) / sizeof (*filename_buf_w);
7447 file_details_w->hwndOwner = FRAME_W32_WINDOW (f);
7448 /* Undocumented Bug in Common File Dialog:
7449 If a filter is not specified, shell links are not resolved. */
7450 file_details_w->lpstrFilter = filter_w;
7451 #ifdef NTGUI_UNICODE
7452 file_details_w->lpstrInitialDir = (wchar_t*) SDATA (dir);
7453 file_details_w->lpstrTitle = (guichar_t*) SDATA (prompt);
7454 #else
7455 file_details_w->lpstrInitialDir = dir_w;
7456 file_details_w->lpstrTitle = prompt_w;
7457 #endif
7458 file_details_w->nFilterIndex = NILP (only_dir_p) ? 1 : 2;
7459 file_details_w->Flags = (OFN_HIDEREADONLY | OFN_NOCHANGEDIR
7460 | OFN_EXPLORER | OFN_ENABLEHOOK);
7461 if (!NILP (mustmatch))
7462 {
7463 /* Require that the path to the parent directory exists. */
7464 file_details_w->Flags |= OFN_PATHMUSTEXIST;
7465 /* If we are looking for a file, require that it exists. */
7466 if (NILP (only_dir_p))
7467 file_details_w->Flags |= OFN_FILEMUSTEXIST;
7468 }
7469 }
7470 #ifndef NTGUI_UNICODE
7471 else
7472 {
7473 memset (&new_file_details_a, 0, sizeof (new_file_details_a));
7474 if (w32_major_version > 4 && w32_major_version < 95)
7475 file_details_a->lStructSize = sizeof (new_file_details_a);
7476 else
7477 file_details_a->lStructSize = sizeof (*file_details_a);
7478 file_details_a->lpstrFile = filename_buf_a;
7479 file_details_a->nMaxFile =
7480 sizeof (filename_buf_a) / sizeof (*filename_buf_a);
7481 file_details_a->hwndOwner = FRAME_W32_WINDOW (f);
7482 file_details_a->lpstrFilter = filter_a;
7483 file_details_a->lpstrInitialDir = dir_a;
7484 file_details_a->lpstrTitle = prompt_a;
7485 file_details_a->nFilterIndex = NILP (only_dir_p) ? 1 : 2;
7486 file_details_a->Flags = (OFN_HIDEREADONLY | OFN_NOCHANGEDIR
7487 | OFN_EXPLORER | OFN_ENABLEHOOK);
7488 if (!NILP (mustmatch))
7489 {
7490 /* Require that the path to the parent directory exists. */
7491 file_details_a->Flags |= OFN_PATHMUSTEXIST;
7492 /* If we are looking for a file, require that it exists. */
7493 if (NILP (only_dir_p))
7494 file_details_a->Flags |= OFN_FILEMUSTEXIST;
7495 }
7496 }
7497 #endif /* !NTGUI_UNICODE */
7498
7499 {
7500 int count = SPECPDL_INDEX ();
7501 /* Prevent redisplay. */
7502 specbind (Qinhibit_redisplay, Qt);
7503 block_input ();
7504 if (use_unicode)
7505 {
7506 file_details_w->lpfnHook = file_dialog_callback;
7507
7508 file_opened = GetOpenFileNameW (file_details_w);
7509 }
7510 #ifndef NTGUI_UNICODE
7511 else
7512 {
7513 file_details_a->lpfnHook = file_dialog_callback;
7514
7515 file_opened = GetOpenFileNameA (file_details_a);
7516 }
7517 #endif /* !NTGUI_UNICODE */
7518 unblock_input ();
7519 unbind_to (count, Qnil);
7520 }
7521
7522 if (file_opened)
7523 {
7524 /* Get an Emacs string from the value Windows gave us. */
7525 #ifdef NTGUI_UNICODE
7526 filename = from_unicode_buffer (filename_buf_w);
7527 #else /* !NTGUI_UNICODE */
7528 if (use_unicode)
7529 filename_from_utf16 (filename_buf_w, fname_ret);
7530 else
7531 filename_from_ansi (filename_buf_a, fname_ret);
7532 dostounix_filename (fname_ret);
7533 filename = DECODE_FILE (build_unibyte_string (fname_ret));
7534 #endif /* NTGUI_UNICODE */
7535
7536 #ifdef CYGWIN
7537 filename = Fcygwin_convert_file_name_from_windows (filename, Qt);
7538 #endif /* CYGWIN */
7539
7540 /* Strip the dummy filename off the end of the string if we
7541 added it to select a directory. */
7542 if ((use_unicode && file_details_w->nFilterIndex == 2)
7543 #ifndef NTGUI_UNICODE
7544 || (!use_unicode && file_details_a->nFilterIndex == 2)
7545 #endif
7546 )
7547 filename = Ffile_name_directory (filename);
7548 }
7549 /* User canceled the dialog without making a selection. */
7550 else if (!CommDlgExtendedError ())
7551 filename = Qnil;
7552 /* An error occurred, fallback on reading from the mini-buffer. */
7553 else
7554 filename = Fcompleting_read (
7555 orig_prompt,
7556 intern ("read-file-name-internal"),
7557 orig_dir,
7558 mustmatch,
7559 orig_dir,
7560 Qfile_name_history,
7561 default_filename,
7562 Qnil);
7563 }
7564
7565 /* Make "Cancel" equivalent to C-g. */
7566 if (NILP (filename))
7567 Fsignal (Qquit, Qnil);
7568
7569 return filename;
7570 }
7571
7572 \f
7573 #ifdef WINDOWSNT
7574 /* Moving files to the system recycle bin.
7575 Used by `move-file-to-trash' instead of the default moving to ~/.Trash */
7576 DEFUN ("system-move-file-to-trash", Fsystem_move_file_to_trash,
7577 Ssystem_move_file_to_trash, 1, 1, 0,
7578 doc: /* Move file or directory named FILENAME to the recycle bin. */)
7579 (Lisp_Object filename)
7580 {
7581 Lisp_Object handler;
7582 Lisp_Object encoded_file;
7583 Lisp_Object operation;
7584
7585 operation = Qdelete_file;
7586 if (!NILP (Ffile_directory_p (filename))
7587 && NILP (Ffile_symlink_p (filename)))
7588 {
7589 operation = intern ("delete-directory");
7590 filename = Fdirectory_file_name (filename);
7591 }
7592
7593 /* Must have fully qualified file names for moving files to Recycle
7594 Bin. */
7595 filename = Fexpand_file_name (filename, Qnil);
7596
7597 handler = Ffind_file_name_handler (filename, operation);
7598 if (!NILP (handler))
7599 return call2 (handler, operation, filename);
7600 else
7601 {
7602 const char * path;
7603 int result;
7604
7605 encoded_file = ENCODE_FILE (filename);
7606
7607 path = map_w32_filename (SSDATA (encoded_file), NULL);
7608
7609 /* The Unicode version of SHFileOperation is not supported on
7610 Windows 9X. */
7611 if (w32_unicode_filenames && os_subtype != OS_9X)
7612 {
7613 SHFILEOPSTRUCTW file_op_w;
7614 /* We need one more element beyond MAX_PATH because this is
7615 a list of file names, with the last element double-null
7616 terminated. */
7617 wchar_t tmp_path_w[MAX_PATH + 1];
7618
7619 memset (tmp_path_w, 0, sizeof (tmp_path_w));
7620 filename_to_utf16 (path, tmp_path_w);
7621
7622 /* On Windows, write permission is required to delete/move files. */
7623 _wchmod (tmp_path_w, 0666);
7624
7625 memset (&file_op_w, 0, sizeof (file_op_w));
7626 file_op_w.hwnd = HWND_DESKTOP;
7627 file_op_w.wFunc = FO_DELETE;
7628 file_op_w.pFrom = tmp_path_w;
7629 file_op_w.fFlags = FOF_SILENT | FOF_NOCONFIRMATION | FOF_ALLOWUNDO
7630 | FOF_NOERRORUI | FOF_NO_CONNECTED_ELEMENTS;
7631 file_op_w.fAnyOperationsAborted = FALSE;
7632
7633 result = SHFileOperationW (&file_op_w);
7634 }
7635 else
7636 {
7637 SHFILEOPSTRUCTA file_op_a;
7638 char tmp_path_a[MAX_PATH + 1];
7639
7640 memset (tmp_path_a, 0, sizeof (tmp_path_a));
7641 filename_to_ansi (path, tmp_path_a);
7642
7643 /* If a file cannot be represented in ANSI codepage, don't
7644 let them inadvertently delete other files because some
7645 characters are interpreted as a wildcards. */
7646 if (_mbspbrk ((unsigned char *)tmp_path_a,
7647 (const unsigned char *)"?*"))
7648 result = ERROR_FILE_NOT_FOUND;
7649 else
7650 {
7651 _chmod (tmp_path_a, 0666);
7652
7653 memset (&file_op_a, 0, sizeof (file_op_a));
7654 file_op_a.hwnd = HWND_DESKTOP;
7655 file_op_a.wFunc = FO_DELETE;
7656 file_op_a.pFrom = tmp_path_a;
7657 file_op_a.fFlags = FOF_SILENT | FOF_NOCONFIRMATION | FOF_ALLOWUNDO
7658 | FOF_NOERRORUI | FOF_NO_CONNECTED_ELEMENTS;
7659 file_op_a.fAnyOperationsAborted = FALSE;
7660
7661 result = SHFileOperationA (&file_op_a);
7662 }
7663 }
7664 if (result != 0)
7665 report_file_error ("Removing old name", list1 (filename));
7666 }
7667 return Qnil;
7668 }
7669
7670 #endif /* WINDOWSNT */
7671
7672 \f
7673 /***********************************************************************
7674 w32 specialized functions
7675 ***********************************************************************/
7676
7677 DEFUN ("w32-send-sys-command", Fw32_send_sys_command,
7678 Sw32_send_sys_command, 1, 2, 0,
7679 doc: /* Send frame a Windows WM_SYSCOMMAND message of type COMMAND.
7680 Some useful values for COMMAND are #xf030 to maximize frame (#xf020
7681 to minimize), #xf120 to restore frame to original size, and #xf100
7682 to activate the menubar for keyboard access. #xf140 activates the
7683 screen saver if defined.
7684
7685 If optional parameter FRAME is not specified, use selected frame. */)
7686 (Lisp_Object command, Lisp_Object frame)
7687 {
7688 struct frame *f = decode_window_system_frame (frame);
7689
7690 CHECK_NUMBER (command);
7691
7692 if (FRAME_W32_P (f))
7693 PostMessage (FRAME_W32_WINDOW (f), WM_SYSCOMMAND, XINT (command), 0);
7694
7695 return Qnil;
7696 }
7697
7698 DEFUN ("w32-shell-execute", Fw32_shell_execute, Sw32_shell_execute, 2, 4, 0,
7699 doc: /* Get Windows to perform OPERATION on DOCUMENT.
7700 This is a wrapper around the ShellExecute system function, which
7701 invokes the application registered to handle OPERATION for DOCUMENT.
7702
7703 OPERATION is either nil or a string that names a supported operation.
7704 What operations can be used depends on the particular DOCUMENT and its
7705 handler application, but typically it is one of the following common
7706 operations:
7707
7708 \"open\" - open DOCUMENT, which could be a file, a directory, or an
7709 executable program (application). If it is an application,
7710 that application is launched in the current buffer's default
7711 directory. Otherwise, the application associated with
7712 DOCUMENT is launched in the buffer's default directory.
7713 \"opennew\" - like \"open\", but instruct the application to open
7714 DOCUMENT in a new window.
7715 \"openas\" - open the \"Open With\" dialog for DOCUMENT.
7716 \"print\" - print DOCUMENT, which must be a file.
7717 \"printto\" - print DOCUMENT, which must be a file, to a specified printer.
7718 The printer should be provided in PARAMETERS, see below.
7719 \"explore\" - start the Windows Explorer on DOCUMENT.
7720 \"edit\" - launch an editor and open DOCUMENT for editing; which
7721 editor is launched depends on the association for the
7722 specified DOCUMENT.
7723 \"find\" - initiate search starting from DOCUMENT, which must specify
7724 a directory.
7725 \"delete\" - move DOCUMENT, a file or a directory, to Recycle Bin.
7726 \"copy\" - copy DOCUMENT, which must be a file or a directory, into
7727 the clipboard.
7728 \"cut\" - move DOCUMENT, a file or a directory, into the clipboard.
7729 \"paste\" - paste the file whose name is in the clipboard into DOCUMENT,
7730 which must be a directory.
7731 \"pastelink\"
7732 - create a shortcut in DOCUMENT (which must be a directory)
7733 the file or directory whose name is in the clipboard.
7734 \"runas\" - run DOCUMENT, which must be an excutable file, with
7735 elevated privileges (a.k.a. \"as Administrator\").
7736 \"properties\"
7737 - open the property sheet dialog for DOCUMENT.
7738 nil - invoke the default OPERATION, or \"open\" if default is
7739 not defined or unavailable.
7740
7741 DOCUMENT is typically the name of a document file or a URL, but can
7742 also be an executable program to run, or a directory to open in the
7743 Windows Explorer. If it is a file or a directory, it must be a local
7744 one; this function does not support remote file names.
7745
7746 If DOCUMENT is an executable program, the optional third arg PARAMETERS
7747 can be a string containing command line parameters, separated by blanks,
7748 that will be passed to the program. Some values of OPERATION also require
7749 parameters (e.g., \"printto\" requires the printer address). Otherwise,
7750 PARAMETERS should be nil or unspecified. Note that double quote characters
7751 in PARAMETERS must each be enclosed in 2 additional quotes, as in \"\"\".
7752
7753 Optional fourth argument SHOW-FLAG can be used to control how the
7754 application will be displayed when it is invoked. If SHOW-FLAG is nil
7755 or unspecified, the application is displayed as if SHOW-FLAG of 10 was
7756 specified, otherwise it is an integer between 0 and 11 representing
7757 a ShowWindow flag:
7758
7759 0 - start hidden
7760 1 - start as normal-size window
7761 3 - start in a maximized window
7762 6 - start in a minimized window
7763 10 - start as the application itself specifies; this is the default. */)
7764 (Lisp_Object operation, Lisp_Object document, Lisp_Object parameters, Lisp_Object show_flag)
7765 {
7766 char *errstr;
7767 Lisp_Object current_dir = BVAR (current_buffer, directory);;
7768 wchar_t *doc_w = NULL, *params_w = NULL, *ops_w = NULL;
7769 #ifdef CYGWIN
7770 intptr_t result;
7771 #else
7772 int use_unicode = w32_unicode_filenames;
7773 char *doc_a = NULL, *params_a = NULL, *ops_a = NULL;
7774 Lisp_Object absdoc, handler;
7775 BOOL success;
7776 #endif
7777
7778 CHECK_STRING (document);
7779
7780 #ifdef CYGWIN
7781 current_dir = Fcygwin_convert_file_name_to_windows (current_dir, Qt);
7782 document = Fcygwin_convert_file_name_to_windows (document, Qt);
7783
7784 /* Encode filename, current directory and parameters. */
7785 current_dir = GUI_ENCODE_FILE (current_dir);
7786 document = GUI_ENCODE_FILE (document);
7787 doc_w = GUI_SDATA (document);
7788 if (STRINGP (parameters))
7789 {
7790 parameters = GUI_ENCODE_SYSTEM (parameters);
7791 params_w = GUI_SDATA (parameters);
7792 }
7793 if (STRINGP (operation))
7794 {
7795 operation = GUI_ENCODE_SYSTEM (operation);
7796 ops_w = GUI_SDATA (operation);
7797 }
7798 result = (intptr_t) ShellExecuteW (NULL, ops_w, doc_w, params_w,
7799 GUI_SDATA (current_dir),
7800 (INTEGERP (show_flag)
7801 ? XINT (show_flag) : SW_SHOWDEFAULT));
7802
7803 if (result > 32)
7804 return Qt;
7805
7806 switch (result)
7807 {
7808 case SE_ERR_ACCESSDENIED:
7809 errstr = w32_strerror (ERROR_ACCESS_DENIED);
7810 break;
7811 case SE_ERR_ASSOCINCOMPLETE:
7812 case SE_ERR_NOASSOC:
7813 errstr = w32_strerror (ERROR_NO_ASSOCIATION);
7814 break;
7815 case SE_ERR_DDEBUSY:
7816 case SE_ERR_DDEFAIL:
7817 errstr = w32_strerror (ERROR_DDE_FAIL);
7818 break;
7819 case SE_ERR_DDETIMEOUT:
7820 errstr = w32_strerror (ERROR_TIMEOUT);
7821 break;
7822 case SE_ERR_DLLNOTFOUND:
7823 errstr = w32_strerror (ERROR_DLL_NOT_FOUND);
7824 break;
7825 case SE_ERR_FNF:
7826 errstr = w32_strerror (ERROR_FILE_NOT_FOUND);
7827 break;
7828 case SE_ERR_OOM:
7829 errstr = w32_strerror (ERROR_NOT_ENOUGH_MEMORY);
7830 break;
7831 case SE_ERR_PNF:
7832 errstr = w32_strerror (ERROR_PATH_NOT_FOUND);
7833 break;
7834 case SE_ERR_SHARE:
7835 errstr = w32_strerror (ERROR_SHARING_VIOLATION);
7836 break;
7837 default:
7838 errstr = w32_strerror (0);
7839 break;
7840 }
7841
7842 #else /* !CYGWIN */
7843
7844 const char file_url_str[] = "file:///";
7845 const int file_url_len = sizeof (file_url_str) - 1;
7846 int doclen;
7847
7848 if (strncmp (SSDATA (document), file_url_str, file_url_len) == 0)
7849 {
7850 /* Passing "file:///" URLs to ShellExecute causes shlwapi.dll to
7851 start a thread in some rare system configurations, for
7852 unknown reasons. That thread is started in the context of
7853 the Emacs process, but out of control of our code, and seems
7854 to never exit afterwards. Each such thread reserves 8MB of
7855 stack space (because that's the value recorded in the Emacs
7856 executable at link time: Emacs needs a large stack). So a
7857 large enough number of invocations of w32-shell-execute can
7858 potentially cause the Emacs process to run out of available
7859 address space, which is nasty. To work around this, we
7860 convert such URLs to local file names, which seems to prevent
7861 those threads from starting. See bug #20220. */
7862 char *p = SSDATA (document) + file_url_len;
7863
7864 if (c_isalpha (*p) && p[1] == ':' && IS_DIRECTORY_SEP (p[2]))
7865 document = Fsubstring_no_properties (document,
7866 make_number (file_url_len), Qnil);
7867 }
7868 /* We have a situation here. If DOCUMENT is a relative file name,
7869 but its name includes leading directories, i.e. it lives not in
7870 CURRENT_DIR, but in its subdirectory, then ShellExecute below
7871 will fail to find it. So we need to make the file name is
7872 absolute. But DOCUMENT does not have to be a file, it can be a
7873 URL, for example. So we make it absolute only if it is an
7874 existing file; if it is a file that does not exist, tough. */
7875 absdoc = Fexpand_file_name (document, Qnil);
7876 /* Don't call file handlers for file-exists-p, since they might
7877 attempt to access the file, which could fail or produce undesired
7878 consequences, see bug#16558 for an example. */
7879 handler = Ffind_file_name_handler (absdoc, Qfile_exists_p);
7880 if (NILP (handler))
7881 {
7882 Lisp_Object absdoc_encoded = ENCODE_FILE (absdoc);
7883
7884 if (faccessat (AT_FDCWD, SSDATA (absdoc_encoded), F_OK, AT_EACCESS) == 0)
7885 {
7886 /* ShellExecute fails if DOCUMENT is a UNC with forward
7887 slashes (expand-file-name above converts all backslashes
7888 to forward slashes). Now that we know DOCUMENT is a
7889 file, we can mirror all forward slashes into backslashes. */
7890 unixtodos_filename (SSDATA (absdoc_encoded));
7891 document = absdoc_encoded;
7892 }
7893 else
7894 document = ENCODE_FILE (document);
7895 }
7896 else
7897 document = ENCODE_FILE (document);
7898
7899 current_dir = ENCODE_FILE (current_dir);
7900 /* Cannot use filename_to_utf16/ansi with DOCUMENT, since it could
7901 be a URL that is not limited to MAX_PATH chararcters. */
7902 doclen = pMultiByteToWideChar (CP_UTF8, multiByteToWideCharFlags,
7903 SSDATA (document), -1, NULL, 0);
7904 doc_w = xmalloc (doclen * sizeof (wchar_t));
7905 pMultiByteToWideChar (CP_UTF8, multiByteToWideCharFlags,
7906 SSDATA (document), -1, doc_w, doclen);
7907 if (use_unicode)
7908 {
7909 wchar_t current_dir_w[MAX_PATH];
7910 SHELLEXECUTEINFOW shexinfo_w;
7911
7912 /* Encode the current directory and parameters, and convert
7913 operation to UTF-16. */
7914 filename_to_utf16 (SSDATA (current_dir), current_dir_w);
7915 if (STRINGP (parameters))
7916 {
7917 int len;
7918
7919 parameters = ENCODE_SYSTEM (parameters);
7920 len = pMultiByteToWideChar (CP_ACP, multiByteToWideCharFlags,
7921 SSDATA (parameters), -1, NULL, 0);
7922 if (len > 32768)
7923 len = 32768;
7924 params_w = alloca (len * sizeof (wchar_t));
7925 pMultiByteToWideChar (CP_ACP, multiByteToWideCharFlags,
7926 SSDATA (parameters), -1, params_w, len);
7927 params_w[len - 1] = 0;
7928 }
7929 if (STRINGP (operation))
7930 {
7931 /* Assume OPERATION is pure ASCII. */
7932 const char *s = SSDATA (operation);
7933 wchar_t *d;
7934 int len = SBYTES (operation) + 1;
7935
7936 if (len > 32768)
7937 len = 32768;
7938 d = ops_w = alloca (len * sizeof (wchar_t));
7939 while (d < ops_w + len - 1)
7940 *d++ = *s++;
7941 *d = 0;
7942 }
7943
7944 /* Using ShellExecuteEx and setting the SEE_MASK_INVOKEIDLIST
7945 flag succeeds with more OPERATIONs (a.k.a. "verbs"), as it is
7946 able to invoke verbs from shortcut menu extensions, not just
7947 static verbs listed in the Registry. */
7948 memset (&shexinfo_w, 0, sizeof (shexinfo_w));
7949 shexinfo_w.cbSize = sizeof (shexinfo_w);
7950 shexinfo_w.fMask =
7951 SEE_MASK_INVOKEIDLIST | SEE_MASK_FLAG_DDEWAIT | SEE_MASK_FLAG_NO_UI;
7952 shexinfo_w.hwnd = NULL;
7953 shexinfo_w.lpVerb = ops_w;
7954 shexinfo_w.lpFile = doc_w;
7955 shexinfo_w.lpParameters = params_w;
7956 shexinfo_w.lpDirectory = current_dir_w;
7957 shexinfo_w.nShow =
7958 (INTEGERP (show_flag) ? XINT (show_flag) : SW_SHOWDEFAULT);
7959 success = ShellExecuteExW (&shexinfo_w);
7960 xfree (doc_w);
7961 }
7962 else
7963 {
7964 char current_dir_a[MAX_PATH];
7965 SHELLEXECUTEINFOA shexinfo_a;
7966 int codepage = codepage_for_filenames (NULL);
7967 int ldoc_a = pWideCharToMultiByte (codepage, 0, doc_w, -1, NULL, 0,
7968 NULL, NULL);
7969
7970 doc_a = xmalloc (ldoc_a);
7971 pWideCharToMultiByte (codepage, 0, doc_w, -1, doc_a, ldoc_a, NULL, NULL);
7972 filename_to_ansi (SSDATA (current_dir), current_dir_a);
7973 if (STRINGP (parameters))
7974 {
7975 parameters = ENCODE_SYSTEM (parameters);
7976 params_a = SSDATA (parameters);
7977 }
7978 if (STRINGP (operation))
7979 {
7980 /* Assume OPERATION is pure ASCII. */
7981 ops_a = SSDATA (operation);
7982 }
7983 memset (&shexinfo_a, 0, sizeof (shexinfo_a));
7984 shexinfo_a.cbSize = sizeof (shexinfo_a);
7985 shexinfo_a.fMask =
7986 SEE_MASK_INVOKEIDLIST | SEE_MASK_FLAG_DDEWAIT | SEE_MASK_FLAG_NO_UI;
7987 shexinfo_a.hwnd = NULL;
7988 shexinfo_a.lpVerb = ops_a;
7989 shexinfo_a.lpFile = doc_a;
7990 shexinfo_a.lpParameters = params_a;
7991 shexinfo_a.lpDirectory = current_dir_a;
7992 shexinfo_a.nShow =
7993 (INTEGERP (show_flag) ? XINT (show_flag) : SW_SHOWDEFAULT);
7994 success = ShellExecuteExA (&shexinfo_a);
7995 xfree (doc_w);
7996 xfree (doc_a);
7997 }
7998
7999 if (success)
8000 return Qt;
8001
8002 errstr = w32_strerror (0);
8003
8004 #endif /* !CYGWIN */
8005
8006 /* The error string might be encoded in the locale's encoding. */
8007 if (!NILP (Vlocale_coding_system))
8008 {
8009 Lisp_Object decoded =
8010 code_convert_string_norecord (build_unibyte_string (errstr),
8011 Vlocale_coding_system, 0);
8012 errstr = SSDATA (decoded);
8013 }
8014 error ("ShellExecute failed: %s", errstr);
8015 }
8016
8017 /* Lookup virtual keycode from string representing the name of a
8018 non-ascii keystroke into the corresponding virtual key, using
8019 lispy_function_keys. */
8020 static int
8021 lookup_vk_code (char *key)
8022 {
8023 int i;
8024
8025 for (i = 0; i < 256; i++)
8026 if (lispy_function_keys[i]
8027 && strcmp (lispy_function_keys[i], key) == 0)
8028 return i;
8029
8030 if (w32_kbdhook_active)
8031 {
8032 /* Alphanumerics map to themselves. */
8033 if (key[1] == 0)
8034 {
8035 if (key[0] >= 'A' && key[0] <= 'Z' ||
8036 key[0] >= '0' && key[0] <= '9')
8037 return key[0];
8038 if (key[0] >= 'a' && key[0] <= 'z')
8039 return toupper(key[0]);
8040 }
8041 }
8042
8043 return -1;
8044 }
8045
8046 /* Convert a one-element vector style key sequence to a hot key
8047 definition. */
8048 static Lisp_Object
8049 w32_parse_and_hook_hot_key (Lisp_Object key, int hook)
8050 {
8051 /* Copied from Fdefine_key and store_in_keymap. */
8052 register Lisp_Object c;
8053 int vk_code;
8054 int lisp_modifiers;
8055 int w32_modifiers;
8056 Lisp_Object res = Qnil;
8057 char* vkname;
8058
8059 CHECK_VECTOR (key);
8060
8061 if (ASIZE (key) != 1)
8062 return Qnil;
8063
8064 c = AREF (key, 0);
8065
8066 if (CONSP (c) && lucid_event_type_list_p (c))
8067 c = Fevent_convert_list (c);
8068
8069 if (! INTEGERP (c) && ! SYMBOLP (c))
8070 error ("Key definition is invalid");
8071
8072 /* Work out the base key and the modifiers. */
8073 if (SYMBOLP (c))
8074 {
8075 c = parse_modifiers (c);
8076 lisp_modifiers = XINT (Fcar (Fcdr (c)));
8077 c = Fcar (c);
8078 if (!SYMBOLP (c))
8079 emacs_abort ();
8080 vkname = SSDATA (SYMBOL_NAME (c));
8081 /* [s-], [M-], [h-]: Register all keys for this modifier */
8082 if (w32_kbdhook_active && vkname[0] == 0)
8083 vk_code = VK_ANY;
8084 else
8085 vk_code = lookup_vk_code (vkname);
8086 }
8087 else if (INTEGERP (c))
8088 {
8089 lisp_modifiers = XINT (c) & ~CHARACTERBITS;
8090 /* Many ascii characters are their own virtual key code. */
8091 vk_code = XINT (c) & CHARACTERBITS;
8092 }
8093
8094 if (vk_code < 0 || vk_code > 255)
8095 return Qnil;
8096
8097 if ((lisp_modifiers & meta_modifier) != 0
8098 && !NILP (Vw32_alt_is_meta))
8099 lisp_modifiers |= alt_modifier;
8100
8101 /* Supply defs missing from mingw32. */
8102 #ifndef MOD_ALT
8103 #define MOD_ALT 0x0001
8104 #define MOD_CONTROL 0x0002
8105 #define MOD_SHIFT 0x0004
8106 #define MOD_WIN 0x0008
8107 #endif
8108
8109 if (w32_kbdhook_active)
8110 {
8111 /* Register Alt-x combinations. */
8112 if (lisp_modifiers & alt_modifier)
8113 {
8114 hook_w32_key (hook, VK_MENU, vk_code);
8115 res = Qt;
8116 }
8117 /* Register Win-x combinations based on modifier mappings. */
8118 if (((lisp_modifiers & hyper_modifier)
8119 && EQ (Vw32_lwindow_modifier, Qhyper))
8120 || ((lisp_modifiers & super_modifier)
8121 && EQ (Vw32_lwindow_modifier, Qsuper)))
8122 {
8123 hook_w32_key (hook, VK_LWIN, vk_code);
8124 res = Qt;
8125 }
8126 if (((lisp_modifiers & hyper_modifier)
8127 && EQ (Vw32_rwindow_modifier, Qhyper))
8128 || ((lisp_modifiers & super_modifier)
8129 && EQ (Vw32_rwindow_modifier, Qsuper)))
8130 {
8131 hook_w32_key (hook, VK_RWIN, vk_code);
8132 res = Qt;
8133 }
8134 return res;
8135 }
8136 else
8137 {
8138 /* Convert lisp modifiers to Windows hot-key form. */
8139 w32_modifiers = (lisp_modifiers & hyper_modifier) ? MOD_WIN : 0;
8140 w32_modifiers |= (lisp_modifiers & alt_modifier) ? MOD_ALT : 0;
8141 w32_modifiers |= (lisp_modifiers & ctrl_modifier) ? MOD_CONTROL : 0;
8142 w32_modifiers |= (lisp_modifiers & shift_modifier) ? MOD_SHIFT : 0;
8143
8144 return HOTKEY (vk_code, w32_modifiers);
8145 }
8146 }
8147
8148 DEFUN ("w32-register-hot-key", Fw32_register_hot_key,
8149 Sw32_register_hot_key, 1, 1, 0,
8150 doc: /* Register KEY as a hot-key combination.
8151 Certain key combinations like Alt-Tab and Win-R are reserved for
8152 system use on Windows, and therefore are normally intercepted by the
8153 system. These key combinations can be received by registering them
8154 as hot-keys, except for Win-L which always locks the computer.
8155
8156 On Windows 98 and ME, KEY must be a one element key definition in
8157 vector form that would be acceptable to `define-key' (e.g. [A-tab] for
8158 Alt-Tab). The meta modifier is interpreted as Alt if
8159 `w32-alt-is-meta' is t, and hyper is always interpreted as the Windows
8160 modifier keys. The return value is the hotkey-id if registered, otherwise nil.
8161
8162 On Windows versions since NT, KEY can also be specified as [M-], [s-] or
8163 [h-] to indicate that all combinations of that key should be processed
8164 by Emacs instead of the operating system. The super and hyper
8165 modifiers are interpreted according to the current values of
8166 `w32-lwindow-modifier' and `w32-rwindow-modifier'. For instance,
8167 setting `w32-lwindow-modifier' to `super' and then calling
8168 `(register-hot-key [s-])' grabs all combinations of the left Windows
8169 key to Emacs, but leaves the right Windows key free for the operating
8170 system keyboard shortcuts. The return value is t if the call affected
8171 any key combinations, otherwise nil. */)
8172 (Lisp_Object key)
8173 {
8174 key = w32_parse_and_hook_hot_key (key, 1);
8175
8176 if (!w32_kbdhook_active
8177 && !NILP (key) && NILP (Fmemq (key, w32_grabbed_keys)))
8178 {
8179 /* Reuse an empty slot if possible. */
8180 Lisp_Object item = Fmemq (Qnil, w32_grabbed_keys);
8181
8182 /* Safe to add new key to list, even if we have focus. */
8183 if (NILP (item))
8184 w32_grabbed_keys = Fcons (key, w32_grabbed_keys);
8185 else
8186 XSETCAR (item, key);
8187
8188 /* Notify input thread about new hot-key definition, so that it
8189 takes effect without needing to switch focus. */
8190 PostThreadMessage (dwWindowsThreadId, WM_EMACS_REGISTER_HOT_KEY,
8191 (WPARAM) XINT (key), 0);
8192 }
8193
8194 return key;
8195 }
8196
8197 DEFUN ("w32-unregister-hot-key", Fw32_unregister_hot_key,
8198 Sw32_unregister_hot_key, 1, 1, 0,
8199 doc: /* Unregister KEY as a hot-key combination. */)
8200 (Lisp_Object key)
8201 {
8202 Lisp_Object item;
8203
8204 if (!INTEGERP (key))
8205 key = w32_parse_and_hook_hot_key (key, 0);
8206
8207 if (w32_kbdhook_active)
8208 return key;
8209
8210 item = Fmemq (key, w32_grabbed_keys);
8211
8212 if (!NILP (item))
8213 {
8214 LPARAM lparam;
8215
8216 eassert (CONSP (item));
8217 /* Pass the tail of the list as a pointer to a Lisp_Cons cell,
8218 so that it works in a --with-wide-int build as well. */
8219 lparam = (LPARAM) XUNTAG (item, Lisp_Cons);
8220
8221 /* Notify input thread about hot-key definition being removed, so
8222 that it takes effect without needing focus switch. */
8223 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_UNREGISTER_HOT_KEY,
8224 (WPARAM) XINT (XCAR (item)), lparam))
8225 {
8226 MSG msg;
8227 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
8228 }
8229 return Qt;
8230 }
8231 return Qnil;
8232 }
8233
8234 DEFUN ("w32-registered-hot-keys", Fw32_registered_hot_keys,
8235 Sw32_registered_hot_keys, 0, 0, 0,
8236 doc: /* Return list of registered hot-key IDs. */)
8237 (void)
8238 {
8239 return Fdelq (Qnil, Fcopy_sequence (w32_grabbed_keys));
8240 }
8241
8242 DEFUN ("w32-reconstruct-hot-key", Fw32_reconstruct_hot_key,
8243 Sw32_reconstruct_hot_key, 1, 1, 0,
8244 doc: /* Convert hot-key ID to a lisp key combination.
8245 usage: (w32-reconstruct-hot-key ID) */)
8246 (Lisp_Object hotkeyid)
8247 {
8248 int vk_code, w32_modifiers;
8249 Lisp_Object key;
8250
8251 CHECK_NUMBER (hotkeyid);
8252
8253 vk_code = HOTKEY_VK_CODE (hotkeyid);
8254 w32_modifiers = HOTKEY_MODIFIERS (hotkeyid);
8255
8256 if (vk_code < 256 && lispy_function_keys[vk_code])
8257 key = intern (lispy_function_keys[vk_code]);
8258 else
8259 key = make_number (vk_code);
8260
8261 key = Fcons (key, Qnil);
8262 if (w32_modifiers & MOD_SHIFT)
8263 key = Fcons (Qshift, key);
8264 if (w32_modifiers & MOD_CONTROL)
8265 key = Fcons (Qctrl, key);
8266 if (w32_modifiers & MOD_ALT)
8267 key = Fcons (NILP (Vw32_alt_is_meta) ? Qalt : Qmeta, key);
8268 if (w32_modifiers & MOD_WIN)
8269 key = Fcons (Qhyper, key);
8270
8271 return key;
8272 }
8273
8274 DEFUN ("w32-toggle-lock-key", Fw32_toggle_lock_key,
8275 Sw32_toggle_lock_key, 1, 2, 0,
8276 doc: /* Toggle the state of the lock key KEY.
8277 KEY can be `capslock', `kp-numlock', or `scroll'.
8278 If the optional parameter NEW-STATE is a number, then the state of KEY
8279 is set to off if the low bit of NEW-STATE is zero, otherwise on.
8280 If NEW-STATE is omitted or nil, the function toggles the state,
8281
8282 Value is the new state of the key, or nil if the function failed
8283 to change the state. */)
8284 (Lisp_Object key, Lisp_Object new_state)
8285 {
8286 int vk_code;
8287 LPARAM lparam;
8288
8289 if (EQ (key, intern ("capslock")))
8290 vk_code = VK_CAPITAL;
8291 else if (EQ (key, intern ("kp-numlock")))
8292 vk_code = VK_NUMLOCK;
8293 else if (EQ (key, intern ("scroll")))
8294 vk_code = VK_SCROLL;
8295 else
8296 return Qnil;
8297
8298 if (!dwWindowsThreadId)
8299 return make_number (w32_console_toggle_lock_key (vk_code, new_state));
8300
8301 if (NILP (new_state))
8302 lparam = -1;
8303 else
8304 lparam = (XUINT (new_state)) & 1;
8305 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_TOGGLE_LOCK_KEY,
8306 (WPARAM) vk_code, lparam))
8307 {
8308 MSG msg;
8309 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
8310 return make_number (msg.wParam);
8311 }
8312 return Qnil;
8313 }
8314
8315 DEFUN ("w32-window-exists-p", Fw32_window_exists_p, Sw32_window_exists_p,
8316 2, 2, 0,
8317 doc: /* Return non-nil if a window exists with the specified CLASS and NAME.
8318
8319 This is a direct interface to the Windows API FindWindow function. */)
8320 (Lisp_Object class, Lisp_Object name)
8321 {
8322 HWND hnd;
8323
8324 if (!NILP (class))
8325 CHECK_STRING (class);
8326 if (!NILP (name))
8327 CHECK_STRING (name);
8328
8329 hnd = FindWindow (STRINGP (class) ? ((LPCTSTR) SDATA (class)) : NULL,
8330 STRINGP (name) ? ((LPCTSTR) SDATA (name)) : NULL);
8331 if (!hnd)
8332 return Qnil;
8333 return Qt;
8334 }
8335
8336 DEFUN ("w32-frame-geometry", Fw32_frame_geometry, Sw32_frame_geometry, 0, 1, 0,
8337 doc: /* Return geometric attributes of FRAME.
8338 FRAME must be a live frame and defaults to the selected one. The return
8339 value is an association list of the attributes listed below. All height
8340 and width values are in pixels.
8341
8342 `outer-position' is a cons of the outer left and top edges of FRAME
8343 relative to the origin - the position (0, 0) - of FRAME's display.
8344
8345 `outer-size' is a cons of the outer width and height of FRAME. The
8346 outer size includes the title bar and the external borders as well as
8347 any menu and/or tool bar of frame.
8348
8349 `external-border-size' is a cons of the horizontal and vertical width of
8350 FRAME's external borders as supplied by the window manager.
8351
8352 `title-bar-size' is a cons of the width and height of the title bar of
8353 FRAME as supplied by the window manager. If both of them are zero,
8354 FRAME has no title bar. If only the width is zero, Emacs was not
8355 able to retrieve the width information.
8356
8357 `menu-bar-external', if non-nil, means the menu bar is external (never
8358 included in the inner edges of FRAME).
8359
8360 `menu-bar-size' is a cons of the width and height of the menu bar of
8361 FRAME.
8362
8363 `tool-bar-external', if non-nil, means the tool bar is external (never
8364 included in the inner edges of FRAME).
8365
8366 `tool-bar-position' tells on which side the tool bar on FRAME is and can
8367 be one of `left', `top', `right' or `bottom'. If this is nil, FRAME
8368 has no tool bar.
8369
8370 `tool-bar-size' is a cons of the width and height of the tool bar of
8371 FRAME.
8372
8373 `internal-border-width' is the width of the internal border of
8374 FRAME. */)
8375 (Lisp_Object frame)
8376 {
8377 struct frame *f = decode_live_frame (frame);
8378
8379 MENUBARINFO menu_bar;
8380 WINDOWINFO window;
8381 int left, top, right, bottom;
8382 unsigned int external_border_width, external_border_height;
8383 int title_bar_width = 0, title_bar_height = 0;
8384 int single_menu_bar_height, wrapped_menu_bar_height, menu_bar_height;
8385 int tool_bar_height = FRAME_TOOL_BAR_HEIGHT (f);
8386 int internal_border_width = FRAME_INTERNAL_BORDER_WIDTH (f);
8387
8388 if (FRAME_INITIAL_P (f) || !FRAME_W32_P (f))
8389 return Qnil;
8390
8391 block_input ();
8392 /* Outer rectangle and borders. */
8393 window.cbSize = sizeof (window);
8394 GetWindowInfo (FRAME_W32_WINDOW (f), &window);
8395 external_border_width = window.cxWindowBorders;
8396 external_border_height = window.cyWindowBorders;
8397 /* Title bar. */
8398 if (get_title_bar_info_fn)
8399 {
8400 TITLEBAR_INFO title_bar;
8401
8402 title_bar.cbSize = sizeof (title_bar);
8403 title_bar.rcTitleBar.left = title_bar.rcTitleBar.right = 0;
8404 title_bar.rcTitleBar.top = title_bar.rcTitleBar.bottom = 0;
8405 for (int i = 0; i < 6; i++)
8406 title_bar.rgstate[i] = 0;
8407 if (get_title_bar_info_fn (FRAME_W32_WINDOW (f), &title_bar)
8408 && !(title_bar.rgstate[0] & 0x00008001))
8409 {
8410 title_bar_width
8411 = title_bar.rcTitleBar.right - title_bar.rcTitleBar.left;
8412 title_bar_height
8413 = title_bar.rcTitleBar.bottom - title_bar.rcTitleBar.top;
8414 }
8415 }
8416 else if ((window.dwStyle & WS_CAPTION) == WS_CAPTION)
8417 title_bar_height = GetSystemMetrics (SM_CYCAPTION);
8418 /* Menu bar. */
8419 menu_bar.cbSize = sizeof (menu_bar);
8420 menu_bar.rcBar.right = menu_bar.rcBar.left = 0;
8421 menu_bar.rcBar.top = menu_bar.rcBar.bottom = 0;
8422 GetMenuBarInfo (FRAME_W32_WINDOW (f), 0xFFFFFFFD, 0, &menu_bar);
8423 single_menu_bar_height = GetSystemMetrics (SM_CYMENU);
8424 wrapped_menu_bar_height = GetSystemMetrics (SM_CYMENUSIZE);
8425 unblock_input ();
8426
8427 left = window.rcWindow.left;
8428 top = window.rcWindow.top;
8429 right = window.rcWindow.right;
8430 bottom = window.rcWindow.bottom;
8431
8432 /* Menu bar. */
8433 menu_bar_height = menu_bar.rcBar.bottom - menu_bar.rcBar.top;
8434 /* Fix menu bar height reported by GetMenuBarInfo. */
8435 if (menu_bar_height > single_menu_bar_height)
8436 /* A wrapped menu bar. */
8437 menu_bar_height += single_menu_bar_height - wrapped_menu_bar_height;
8438 else if (menu_bar_height > 0)
8439 /* A single line menu bar. */
8440 menu_bar_height = single_menu_bar_height;
8441
8442 return listn (CONSTYPE_HEAP, 10,
8443 Fcons (Qouter_position,
8444 Fcons (make_number (left), make_number (top))),
8445 Fcons (Qouter_size,
8446 Fcons (make_number (right - left),
8447 make_number (bottom - top))),
8448 Fcons (Qexternal_border_size,
8449 Fcons (make_number (external_border_width),
8450 make_number (external_border_height))),
8451 Fcons (Qtitle_bar_size,
8452 Fcons (make_number (title_bar_width),
8453 make_number (title_bar_height))),
8454 Fcons (Qmenu_bar_external, Qt),
8455 Fcons (Qmenu_bar_size,
8456 Fcons (make_number
8457 (menu_bar.rcBar.right - menu_bar.rcBar.left),
8458 make_number (menu_bar_height))),
8459 Fcons (Qtool_bar_external, Qnil),
8460 Fcons (Qtool_bar_position, tool_bar_height ? Qtop : Qnil),
8461 Fcons (Qtool_bar_size,
8462 Fcons (make_number
8463 (tool_bar_height
8464 ? right - left - 2 * internal_border_width
8465 : 0),
8466 make_number (tool_bar_height))),
8467 Fcons (Qinternal_border_width,
8468 make_number (internal_border_width)));
8469 }
8470
8471 DEFUN ("w32-frame-edges", Fw32_frame_edges, Sw32_frame_edges, 0, 2, 0,
8472 doc: /* Return edge coordinates of FRAME.
8473 FRAME must be a live frame and defaults to the selected one. The return
8474 value is a list of the form (LEFT, TOP, RIGHT, BOTTOM). All values are
8475 in pixels relative to the origin - the position (0, 0) - of FRAME's
8476 display.
8477
8478 If optional argument TYPE is the symbol `outer-edges', return the outer
8479 edges of FRAME. The outer edges comprise the decorations of the window
8480 manager (like the title bar or external borders) as well as any external
8481 menu or tool bar of FRAME. If optional argument TYPE is the symbol
8482 `native-edges' or nil, return the native edges of FRAME. The native
8483 edges exclude the decorations of the window manager and any external
8484 menu or tool bar of FRAME. If TYPE is the symbol `inner-edges', return
8485 the inner edges of FRAME. These edges exclude title bar, any borders,
8486 menu bar or tool bar of FRAME. */)
8487 (Lisp_Object frame, Lisp_Object type)
8488 {
8489 struct frame *f = decode_live_frame (frame);
8490
8491 if (FRAME_INITIAL_P (f) || !FRAME_W32_P (f))
8492 return Qnil;
8493
8494 if (EQ (type, Qouter_edges))
8495 {
8496 RECT rectangle;
8497
8498 block_input ();
8499 /* Outer frame rectangle, including outer borders and title bar. */
8500 GetWindowRect (FRAME_W32_WINDOW (f), &rectangle);
8501 unblock_input ();
8502
8503 return list4 (make_number (rectangle.left),
8504 make_number (rectangle.top),
8505 make_number (rectangle.right),
8506 make_number (rectangle.bottom));
8507 }
8508 else
8509 {
8510 RECT rectangle;
8511 POINT pt;
8512 int left, top, right, bottom;
8513
8514 block_input ();
8515 /* Inner frame rectangle, excluding borders and title bar. */
8516 GetClientRect (FRAME_W32_WINDOW (f), &rectangle);
8517 /* Get top-left corner of native rectangle in screen
8518 coordinates. */
8519 pt.x = 0;
8520 pt.y = 0;
8521 ClientToScreen (FRAME_W32_WINDOW (f), &pt);
8522 unblock_input ();
8523
8524 left = pt.x;
8525 top = pt.y;
8526 right = left + rectangle.right;
8527 bottom = top + rectangle.bottom;
8528
8529 if (EQ (type, Qinner_edges))
8530 {
8531 int internal_border_width = FRAME_INTERNAL_BORDER_WIDTH (f);
8532
8533 return list4 (make_number (left + internal_border_width),
8534 make_number (top
8535 + FRAME_TOOL_BAR_HEIGHT (f)
8536 + internal_border_width),
8537 make_number (right - internal_border_width),
8538 make_number (bottom - internal_border_width));
8539 }
8540 else
8541 return list4 (make_number (left), make_number (top),
8542 make_number (right), make_number (bottom));
8543 }
8544 }
8545
8546 DEFUN ("w32-mouse-absolute-pixel-position", Fw32_mouse_absolute_pixel_position,
8547 Sw32_mouse_absolute_pixel_position, 0, 0, 0,
8548 doc: /* Return absolute position of mouse cursor in pixels.
8549 The position is returned as a cons cell (X . Y) of the coordinates of
8550 the mouse cursor position in pixels relative to a position (0, 0) of the
8551 selected frame's display. */)
8552 (void)
8553 {
8554 POINT pt;
8555
8556 block_input ();
8557 GetCursorPos (&pt);
8558 unblock_input ();
8559
8560 return Fcons (make_number (pt.x), make_number (pt.y));
8561 }
8562
8563 DEFUN ("w32-set-mouse-absolute-pixel-position", Fw32_set_mouse_absolute_pixel_position,
8564 Sw32_set_mouse_absolute_pixel_position, 2, 2, 0,
8565 doc: /* Move mouse pointer to absolute pixel position (X, Y).
8566 The coordinates X and Y are interpreted in pixels relative to a position
8567 \(0, 0) of the selected frame's display. */)
8568 (Lisp_Object x, Lisp_Object y)
8569 {
8570 UINT trail_num = 0;
8571 BOOL ret = false;
8572
8573 CHECK_TYPE_RANGED_INTEGER (int, x);
8574 CHECK_TYPE_RANGED_INTEGER (int, y);
8575
8576 block_input ();
8577 /* When "mouse trails" are in effect, moving the mouse cursor
8578 sometimes leaves behind an annoying "ghost" of the pointer.
8579 Avoid that by momentarily switching off mouse trails. */
8580 if (os_subtype == OS_NT
8581 && w32_major_version + w32_minor_version >= 6)
8582 ret = SystemParametersInfo (SPI_GETMOUSETRAILS, 0, &trail_num, 0);
8583 SetCursorPos (XINT (x), XINT (y));
8584 if (ret)
8585 SystemParametersInfo (SPI_SETMOUSETRAILS, trail_num, NULL, 0);
8586 unblock_input ();
8587
8588 return Qnil;
8589 }
8590
8591 DEFUN ("w32-battery-status", Fw32_battery_status, Sw32_battery_status, 0, 0, 0,
8592 doc: /* Get power status information from Windows system.
8593
8594 The following %-sequences are provided:
8595 %L AC line status (verbose)
8596 %B Battery status (verbose)
8597 %b Battery status, empty means high, `-' means low,
8598 `!' means critical, and `+' means charging
8599 %p Battery load percentage
8600 %s Remaining time (to charge or discharge) in seconds
8601 %m Remaining time (to charge or discharge) in minutes
8602 %h Remaining time (to charge or discharge) in hours
8603 %t Remaining time (to charge or discharge) in the form `h:min' */)
8604 (void)
8605 {
8606 Lisp_Object status = Qnil;
8607
8608 SYSTEM_POWER_STATUS system_status;
8609 if (GetSystemPowerStatus (&system_status))
8610 {
8611 Lisp_Object line_status, battery_status, battery_status_symbol;
8612 Lisp_Object load_percentage, seconds, minutes, hours, remain;
8613
8614 long seconds_left = (long) system_status.BatteryLifeTime;
8615
8616 if (system_status.ACLineStatus == 0)
8617 line_status = build_string ("off-line");
8618 else if (system_status.ACLineStatus == 1)
8619 line_status = build_string ("on-line");
8620 else
8621 line_status = build_string ("N/A");
8622
8623 if (system_status.BatteryFlag & 128)
8624 {
8625 battery_status = build_string ("N/A");
8626 battery_status_symbol = empty_unibyte_string;
8627 }
8628 else if (system_status.BatteryFlag & 8)
8629 {
8630 battery_status = build_string ("charging");
8631 battery_status_symbol = build_string ("+");
8632 if (system_status.BatteryFullLifeTime != -1L)
8633 seconds_left = system_status.BatteryFullLifeTime - seconds_left;
8634 }
8635 else if (system_status.BatteryFlag & 4)
8636 {
8637 battery_status = build_string ("critical");
8638 battery_status_symbol = build_string ("!");
8639 }
8640 else if (system_status.BatteryFlag & 2)
8641 {
8642 battery_status = build_string ("low");
8643 battery_status_symbol = build_string ("-");
8644 }
8645 else if (system_status.BatteryFlag & 1)
8646 {
8647 battery_status = build_string ("high");
8648 battery_status_symbol = empty_unibyte_string;
8649 }
8650 else
8651 {
8652 battery_status = build_string ("medium");
8653 battery_status_symbol = empty_unibyte_string;
8654 }
8655
8656 if (system_status.BatteryLifePercent > 100)
8657 load_percentage = build_string ("N/A");
8658 else
8659 {
8660 char buffer[16];
8661 snprintf (buffer, 16, "%d", system_status.BatteryLifePercent);
8662 load_percentage = build_string (buffer);
8663 }
8664
8665 if (seconds_left < 0)
8666 seconds = minutes = hours = remain = build_string ("N/A");
8667 else
8668 {
8669 long m;
8670 float h;
8671 char buffer[16];
8672 snprintf (buffer, 16, "%ld", seconds_left);
8673 seconds = build_string (buffer);
8674
8675 m = seconds_left / 60;
8676 snprintf (buffer, 16, "%ld", m);
8677 minutes = build_string (buffer);
8678
8679 h = seconds_left / 3600.0;
8680 snprintf (buffer, 16, "%3.1f", h);
8681 hours = build_string (buffer);
8682
8683 snprintf (buffer, 16, "%ld:%02ld", m / 60, m % 60);
8684 remain = build_string (buffer);
8685 }
8686
8687 status = listn (CONSTYPE_HEAP, 8,
8688 Fcons (make_number ('L'), line_status),
8689 Fcons (make_number ('B'), battery_status),
8690 Fcons (make_number ('b'), battery_status_symbol),
8691 Fcons (make_number ('p'), load_percentage),
8692 Fcons (make_number ('s'), seconds),
8693 Fcons (make_number ('m'), minutes),
8694 Fcons (make_number ('h'), hours),
8695 Fcons (make_number ('t'), remain));
8696 }
8697 return status;
8698 }
8699
8700 \f
8701 #ifdef WINDOWSNT
8702 typedef BOOL (WINAPI *GetDiskFreeSpaceExW_Proc)
8703 (LPCWSTR, PULARGE_INTEGER, PULARGE_INTEGER, PULARGE_INTEGER);
8704 typedef BOOL (WINAPI *GetDiskFreeSpaceExA_Proc)
8705 (LPCSTR, PULARGE_INTEGER, PULARGE_INTEGER, PULARGE_INTEGER);
8706
8707 DEFUN ("file-system-info", Ffile_system_info, Sfile_system_info, 1, 1, 0,
8708 doc: /* Return storage information about the file system FILENAME is on.
8709 Value is a list of floats (TOTAL FREE AVAIL), where TOTAL is the total
8710 storage of the file system, FREE is the free storage, and AVAIL is the
8711 storage available to a non-superuser. All 3 numbers are in bytes.
8712 If the underlying system call fails, value is nil. */)
8713 (Lisp_Object filename)
8714 {
8715 Lisp_Object encoded, value;
8716
8717 CHECK_STRING (filename);
8718 filename = Fexpand_file_name (filename, Qnil);
8719 encoded = ENCODE_FILE (filename);
8720
8721 value = Qnil;
8722
8723 /* Determining the required information on Windows turns out, sadly,
8724 to be more involved than one would hope. The original Windows API
8725 call for this will return bogus information on some systems, but we
8726 must dynamically probe for the replacement api, since that was
8727 added rather late on. */
8728 {
8729 HMODULE hKernel = GetModuleHandle ("kernel32");
8730 GetDiskFreeSpaceExW_Proc pfn_GetDiskFreeSpaceExW =
8731 (GetDiskFreeSpaceExW_Proc) GetProcAddress (hKernel, "GetDiskFreeSpaceExW");
8732 GetDiskFreeSpaceExA_Proc pfn_GetDiskFreeSpaceExA =
8733 (GetDiskFreeSpaceExA_Proc) GetProcAddress (hKernel, "GetDiskFreeSpaceExA");
8734 bool have_pfn_GetDiskFreeSpaceEx =
8735 ((w32_unicode_filenames && pfn_GetDiskFreeSpaceExW)
8736 || (!w32_unicode_filenames && pfn_GetDiskFreeSpaceExA));
8737
8738 /* On Windows, we may need to specify the root directory of the
8739 volume holding FILENAME. */
8740 char rootname[MAX_UTF8_PATH];
8741 wchar_t rootname_w[MAX_PATH];
8742 char rootname_a[MAX_PATH];
8743 char *name = SSDATA (encoded);
8744 BOOL result;
8745
8746 /* find the root name of the volume if given */
8747 if (isalpha (name[0]) && name[1] == ':')
8748 {
8749 rootname[0] = name[0];
8750 rootname[1] = name[1];
8751 rootname[2] = '\\';
8752 rootname[3] = 0;
8753 }
8754 else if (IS_DIRECTORY_SEP (name[0]) && IS_DIRECTORY_SEP (name[1]))
8755 {
8756 char *str = rootname;
8757 int slashes = 4;
8758 do
8759 {
8760 if (IS_DIRECTORY_SEP (*name) && --slashes == 0)
8761 break;
8762 *str++ = *name++;
8763 }
8764 while ( *name );
8765
8766 *str++ = '\\';
8767 *str = 0;
8768 }
8769
8770 if (w32_unicode_filenames)
8771 filename_to_utf16 (rootname, rootname_w);
8772 else
8773 filename_to_ansi (rootname, rootname_a);
8774
8775 if (have_pfn_GetDiskFreeSpaceEx)
8776 {
8777 /* Unsigned large integers cannot be cast to double, so
8778 use signed ones instead. */
8779 LARGE_INTEGER availbytes;
8780 LARGE_INTEGER freebytes;
8781 LARGE_INTEGER totalbytes;
8782
8783 if (w32_unicode_filenames)
8784 result = pfn_GetDiskFreeSpaceExW (rootname_w,
8785 (ULARGE_INTEGER *)&availbytes,
8786 (ULARGE_INTEGER *)&totalbytes,
8787 (ULARGE_INTEGER *)&freebytes);
8788 else
8789 result = pfn_GetDiskFreeSpaceExA (rootname_a,
8790 (ULARGE_INTEGER *)&availbytes,
8791 (ULARGE_INTEGER *)&totalbytes,
8792 (ULARGE_INTEGER *)&freebytes);
8793 if (result)
8794 value = list3 (make_float ((double) totalbytes.QuadPart),
8795 make_float ((double) freebytes.QuadPart),
8796 make_float ((double) availbytes.QuadPart));
8797 }
8798 else
8799 {
8800 DWORD sectors_per_cluster;
8801 DWORD bytes_per_sector;
8802 DWORD free_clusters;
8803 DWORD total_clusters;
8804
8805 if (w32_unicode_filenames)
8806 result = GetDiskFreeSpaceW (rootname_w,
8807 &sectors_per_cluster,
8808 &bytes_per_sector,
8809 &free_clusters,
8810 &total_clusters);
8811 else
8812 result = GetDiskFreeSpaceA (rootname_a,
8813 &sectors_per_cluster,
8814 &bytes_per_sector,
8815 &free_clusters,
8816 &total_clusters);
8817 if (result)
8818 value = list3 (make_float ((double) total_clusters
8819 * sectors_per_cluster * bytes_per_sector),
8820 make_float ((double) free_clusters
8821 * sectors_per_cluster * bytes_per_sector),
8822 make_float ((double) free_clusters
8823 * sectors_per_cluster * bytes_per_sector));
8824 }
8825 }
8826
8827 return value;
8828 }
8829 #endif /* WINDOWSNT */
8830
8831 \f
8832 #ifdef WINDOWSNT
8833 DEFUN ("default-printer-name", Fdefault_printer_name, Sdefault_printer_name,
8834 0, 0, 0, doc: /* Return the name of Windows default printer device. */)
8835 (void)
8836 {
8837 static char pname_buf[256];
8838 int err;
8839 HANDLE hPrn;
8840 PRINTER_INFO_2W *ppi2w = NULL;
8841 PRINTER_INFO_2A *ppi2a = NULL;
8842 DWORD dwNeeded = 0, dwReturned = 0;
8843 char server_name[MAX_UTF8_PATH], share_name[MAX_UTF8_PATH];
8844 char port_name[MAX_UTF8_PATH];
8845
8846 /* Retrieve the default string from Win.ini (the registry).
8847 * String will be in form "printername,drivername,portname".
8848 * This is the most portable way to get the default printer. */
8849 if (GetProfileString ("windows", "device", ",,", pname_buf, sizeof (pname_buf)) <= 0)
8850 return Qnil;
8851 /* printername precedes first "," character */
8852 strtok (pname_buf, ",");
8853 /* We want to know more than the printer name */
8854 if (!OpenPrinter (pname_buf, &hPrn, NULL))
8855 return Qnil;
8856 /* GetPrinterW is not supported by unicows.dll. */
8857 if (w32_unicode_filenames && os_subtype != OS_9X)
8858 GetPrinterW (hPrn, 2, NULL, 0, &dwNeeded);
8859 else
8860 GetPrinterA (hPrn, 2, NULL, 0, &dwNeeded);
8861 if (dwNeeded == 0)
8862 {
8863 ClosePrinter (hPrn);
8864 return Qnil;
8865 }
8866 /* Call GetPrinter again with big enough memory block. */
8867 if (w32_unicode_filenames && os_subtype != OS_9X)
8868 {
8869 /* Allocate memory for the PRINTER_INFO_2 struct. */
8870 ppi2w = xmalloc (dwNeeded);
8871 err = GetPrinterW (hPrn, 2, (LPBYTE)ppi2w, dwNeeded, &dwReturned);
8872 ClosePrinter (hPrn);
8873 if (!err)
8874 {
8875 xfree (ppi2w);
8876 return Qnil;
8877 }
8878
8879 if ((ppi2w->Attributes & PRINTER_ATTRIBUTE_SHARED)
8880 && ppi2w->pServerName)
8881 {
8882 filename_from_utf16 (ppi2w->pServerName, server_name);
8883 filename_from_utf16 (ppi2w->pShareName, share_name);
8884 }
8885 else
8886 {
8887 server_name[0] = '\0';
8888 filename_from_utf16 (ppi2w->pPortName, port_name);
8889 }
8890 }
8891 else
8892 {
8893 ppi2a = xmalloc (dwNeeded);
8894 err = GetPrinterA (hPrn, 2, (LPBYTE)ppi2a, dwNeeded, &dwReturned);
8895 ClosePrinter (hPrn);
8896 if (!err)
8897 {
8898 xfree (ppi2a);
8899 return Qnil;
8900 }
8901
8902 if ((ppi2a->Attributes & PRINTER_ATTRIBUTE_SHARED)
8903 && ppi2a->pServerName)
8904 {
8905 filename_from_ansi (ppi2a->pServerName, server_name);
8906 filename_from_ansi (ppi2a->pShareName, share_name);
8907 }
8908 else
8909 {
8910 server_name[0] = '\0';
8911 filename_from_ansi (ppi2a->pPortName, port_name);
8912 }
8913 }
8914
8915 if (server_name[0])
8916 {
8917 /* a remote printer */
8918 if (server_name[0] == '\\')
8919 snprintf (pname_buf, sizeof (pname_buf), "%s\\%s", server_name,
8920 share_name);
8921 else
8922 snprintf (pname_buf, sizeof (pname_buf), "\\\\%s\\%s", server_name,
8923 share_name);
8924 pname_buf[sizeof (pname_buf) - 1] = '\0';
8925 }
8926 else
8927 {
8928 /* a local printer */
8929 strncpy (pname_buf, port_name, sizeof (pname_buf));
8930 pname_buf[sizeof (pname_buf) - 1] = '\0';
8931 /* `pPortName' can include several ports, delimited by ','.
8932 * we only use the first one. */
8933 strtok (pname_buf, ",");
8934 }
8935
8936 return DECODE_FILE (build_unibyte_string (pname_buf));
8937 }
8938 #endif /* WINDOWSNT */
8939 \f
8940
8941 /* Equivalent of strerror for W32 error codes. */
8942 char *
8943 w32_strerror (int error_no)
8944 {
8945 static char buf[500];
8946 DWORD ret;
8947
8948 if (error_no == 0)
8949 error_no = GetLastError ();
8950
8951 ret = FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM |
8952 FORMAT_MESSAGE_IGNORE_INSERTS,
8953 NULL,
8954 error_no,
8955 0, /* choose most suitable language */
8956 buf, sizeof (buf), NULL);
8957
8958 while (ret > 0 && (buf[ret - 1] == '\n' ||
8959 buf[ret - 1] == '\r' ))
8960 --ret;
8961 buf[ret] = '\0';
8962 if (!ret)
8963 sprintf (buf, "w32 error %u", error_no);
8964
8965 return buf;
8966 }
8967
8968 /* For convenience when debugging. (You cannot call GetLastError
8969 directly from GDB: it will crash, because it uses the __stdcall
8970 calling convention, not the _cdecl convention assumed by GDB.) */
8971 DWORD
8972 w32_last_error (void)
8973 {
8974 return GetLastError ();
8975 }
8976
8977 /* Cache information describing the NT system for later use. */
8978 void
8979 cache_system_info (void)
8980 {
8981 union
8982 {
8983 struct info
8984 {
8985 char major;
8986 char minor;
8987 short platform;
8988 } info;
8989 DWORD data;
8990 } version;
8991
8992 /* Cache the module handle of Emacs itself. */
8993 hinst = GetModuleHandle (NULL);
8994
8995 /* Cache the version of the operating system. */
8996 version.data = GetVersion ();
8997 w32_major_version = version.info.major;
8998 w32_minor_version = version.info.minor;
8999
9000 if (version.info.platform & 0x8000)
9001 os_subtype = OS_9X;
9002 else
9003 os_subtype = OS_NT;
9004
9005 /* Cache page size, allocation unit, processor type, etc. */
9006 GetSystemInfo (&sysinfo_cache);
9007 syspage_mask = (DWORD_PTR)sysinfo_cache.dwPageSize - 1;
9008
9009 /* Cache os info. */
9010 osinfo_cache.dwOSVersionInfoSize = sizeof (OSVERSIONINFO);
9011 GetVersionEx (&osinfo_cache);
9012
9013 w32_build_number = osinfo_cache.dwBuildNumber;
9014 if (os_subtype == OS_9X)
9015 w32_build_number &= 0xffff;
9016
9017 w32_num_mouse_buttons = GetSystemMetrics (SM_CMOUSEBUTTONS);
9018 }
9019
9020 #ifdef EMACSDEBUG
9021 void
9022 _DebPrint (const char *fmt, ...)
9023 {
9024 char buf[1024];
9025 va_list args;
9026
9027 va_start (args, fmt);
9028 vsprintf (buf, fmt, args);
9029 va_end (args);
9030 #if CYGWIN
9031 fprintf (stderr, "%s", buf);
9032 #endif
9033 OutputDebugString (buf);
9034 }
9035 #endif
9036
9037 int
9038 w32_console_toggle_lock_key (int vk_code, Lisp_Object new_state)
9039 {
9040 int cur_state = (GetKeyState (vk_code) & 1);
9041
9042 if (NILP (new_state)
9043 || (NUMBERP (new_state)
9044 && ((XUINT (new_state)) & 1) != cur_state))
9045 {
9046 #ifdef WINDOWSNT
9047 faked_key = vk_code;
9048 #endif /* WINDOWSNT */
9049
9050 keybd_event ((BYTE) vk_code,
9051 (BYTE) MapVirtualKey (vk_code, 0),
9052 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
9053 keybd_event ((BYTE) vk_code,
9054 (BYTE) MapVirtualKey (vk_code, 0),
9055 KEYEVENTF_EXTENDEDKEY | 0, 0);
9056 keybd_event ((BYTE) vk_code,
9057 (BYTE) MapVirtualKey (vk_code, 0),
9058 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
9059 cur_state = !cur_state;
9060 }
9061
9062 return cur_state;
9063 }
9064
9065 /* Translate console modifiers to emacs modifiers.
9066 German keyboard support (Kai Morgan Zeise 2/18/95). */
9067 int
9068 w32_kbd_mods_to_emacs (DWORD mods, WORD key)
9069 {
9070 int retval = 0;
9071
9072 /* If we recognize right-alt and left-ctrl as AltGr, and it has been
9073 pressed, first remove those modifiers. */
9074 if (!NILP (Vw32_recognize_altgr)
9075 && (mods & (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED))
9076 == (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED))
9077 mods &= ~ (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED);
9078
9079 if (mods & (RIGHT_ALT_PRESSED | LEFT_ALT_PRESSED))
9080 retval = ((NILP (Vw32_alt_is_meta)) ? alt_modifier : meta_modifier);
9081
9082 if (mods & (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
9083 {
9084 retval |= ctrl_modifier;
9085 if ((mods & (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
9086 == (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
9087 retval |= meta_modifier;
9088 }
9089
9090 if (mods & LEFT_WIN_PRESSED)
9091 retval |= w32_key_to_modifier (VK_LWIN);
9092 if (mods & RIGHT_WIN_PRESSED)
9093 retval |= w32_key_to_modifier (VK_RWIN);
9094 if (mods & APPS_PRESSED)
9095 retval |= w32_key_to_modifier (VK_APPS);
9096 if (mods & SCROLLLOCK_ON)
9097 retval |= w32_key_to_modifier (VK_SCROLL);
9098
9099 /* Just in case someone wanted the original behavior, make it
9100 optional by setting w32-capslock-is-shiftlock to t. */
9101 if (NILP (Vw32_capslock_is_shiftlock)
9102 /* Keys that should _not_ be affected by CapsLock. */
9103 && ( (key == VK_BACK)
9104 || (key == VK_TAB)
9105 || (key == VK_CLEAR)
9106 || (key == VK_RETURN)
9107 || (key == VK_ESCAPE)
9108 || ((key >= VK_SPACE) && (key <= VK_HELP))
9109 || ((key >= VK_NUMPAD0) && (key <= VK_F24))
9110 || ((key >= VK_NUMPAD_CLEAR) && (key <= VK_NUMPAD_DELETE))
9111 ))
9112 {
9113 /* Only consider shift state. */
9114 if ((mods & SHIFT_PRESSED) != 0)
9115 retval |= shift_modifier;
9116 }
9117 else
9118 {
9119 /* Ignore CapsLock state if not enabled. */
9120 if (NILP (Vw32_enable_caps_lock))
9121 mods &= ~CAPSLOCK_ON;
9122 if ((mods & (SHIFT_PRESSED | CAPSLOCK_ON)) != 0)
9123 retval |= shift_modifier;
9124 }
9125
9126 return retval;
9127 }
9128
9129 /* The return code indicates key code size. cpID is the codepage to
9130 use for translation to Unicode; -1 means use the current console
9131 input codepage. */
9132 int
9133 w32_kbd_patch_key (KEY_EVENT_RECORD *event, int cpId)
9134 {
9135 unsigned int key_code = event->wVirtualKeyCode;
9136 unsigned int mods = event->dwControlKeyState;
9137 BYTE keystate[256];
9138 static BYTE ansi_code[4];
9139 static int isdead = 0;
9140
9141 if (isdead == 2)
9142 {
9143 event->uChar.AsciiChar = ansi_code[2];
9144 isdead = 0;
9145 return 1;
9146 }
9147 if (event->uChar.AsciiChar != 0)
9148 return 1;
9149
9150 memset (keystate, 0, sizeof (keystate));
9151 keystate[key_code] = 0x80;
9152 if (mods & SHIFT_PRESSED)
9153 keystate[VK_SHIFT] = 0x80;
9154 if (mods & CAPSLOCK_ON)
9155 keystate[VK_CAPITAL] = 1;
9156 /* If we recognize right-alt and left-ctrl as AltGr, set the key
9157 states accordingly before invoking ToAscii. */
9158 if (!NILP (Vw32_recognize_altgr)
9159 && (mods & LEFT_CTRL_PRESSED) && (mods & RIGHT_ALT_PRESSED))
9160 {
9161 keystate[VK_CONTROL] = 0x80;
9162 keystate[VK_LCONTROL] = 0x80;
9163 keystate[VK_MENU] = 0x80;
9164 keystate[VK_RMENU] = 0x80;
9165 }
9166
9167 #if 0
9168 /* Because of an OS bug, ToAscii corrupts the stack when called to
9169 convert a dead key in console mode on NT4. Unfortunately, trying
9170 to check for dead keys using MapVirtualKey doesn't work either -
9171 these functions apparently use internal information about keyboard
9172 layout which doesn't get properly updated in console programs when
9173 changing layout (though apparently it gets partly updated,
9174 otherwise ToAscii wouldn't crash). */
9175 if (is_dead_key (event->wVirtualKeyCode))
9176 return 0;
9177 #endif
9178
9179 /* On NT, call ToUnicode instead and then convert to the current
9180 console input codepage. */
9181 if (os_subtype == OS_NT)
9182 {
9183 WCHAR buf[128];
9184
9185 isdead = ToUnicode (event->wVirtualKeyCode, event->wVirtualScanCode,
9186 keystate, buf, 128, 0);
9187 if (isdead > 0)
9188 {
9189 /* When we are called from the GUI message processing code,
9190 we are passed the current keyboard codepage, a positive
9191 number, to use below. */
9192 if (cpId == -1)
9193 cpId = GetConsoleCP ();
9194
9195 event->uChar.UnicodeChar = buf[isdead - 1];
9196 isdead = WideCharToMultiByte (cpId, 0, buf, isdead,
9197 (LPSTR)ansi_code, 4, NULL, NULL);
9198 }
9199 else
9200 isdead = 0;
9201 }
9202 else
9203 {
9204 isdead = ToAscii (event->wVirtualKeyCode, event->wVirtualScanCode,
9205 keystate, (LPWORD) ansi_code, 0);
9206 }
9207
9208 if (isdead == 0)
9209 return 0;
9210 event->uChar.AsciiChar = ansi_code[0];
9211 return isdead;
9212 }
9213
9214
9215 void
9216 w32_sys_ring_bell (struct frame *f)
9217 {
9218 if (sound_type == 0xFFFFFFFF)
9219 {
9220 Beep (666, 100);
9221 }
9222 else if (sound_type == MB_EMACS_SILENT)
9223 {
9224 /* Do nothing. */
9225 }
9226 else
9227 MessageBeep (sound_type);
9228 }
9229
9230 DEFUN ("w32--menu-bar-in-use", Fw32__menu_bar_in_use, Sw32__menu_bar_in_use,
9231 0, 0, 0,
9232 doc: /* Return non-nil when a menu-bar menu is being used.
9233 Internal use only. */)
9234 (void)
9235 {
9236 return menubar_in_use ? Qt : Qnil;
9237 }
9238
9239 #if defined WINDOWSNT && !defined HAVE_DBUS
9240
9241 /***********************************************************************
9242 Tray notifications
9243 ***********************************************************************/
9244 /* A private struct declaration to avoid compile-time limits. */
9245 typedef struct MY_NOTIFYICONDATAW {
9246 DWORD cbSize;
9247 HWND hWnd;
9248 UINT uID;
9249 UINT uFlags;
9250 UINT uCallbackMessage;
9251 HICON hIcon;
9252 WCHAR szTip[128];
9253 DWORD dwState;
9254 DWORD dwStateMask;
9255 WCHAR szInfo[256];
9256 _ANONYMOUS_UNION union {
9257 UINT uTimeout;
9258 UINT uVersion;
9259 } DUMMYUNIONNAME;
9260 WCHAR szInfoTitle[64];
9261 DWORD dwInfoFlags;
9262 GUID guidItem;
9263 HICON hBalloonIcon;
9264 } MY_NOTIFYICONDATAW;
9265
9266 #define MYNOTIFYICONDATAW_V1_SIZE offsetof (MY_NOTIFYICONDATAW, szTip[64])
9267 #define MYNOTIFYICONDATAW_V2_SIZE offsetof (MY_NOTIFYICONDATAW, guidItem)
9268 #define MYNOTIFYICONDATAW_V3_SIZE offsetof (MY_NOTIFYICONDATAW, hBalloonIcon)
9269 #ifndef NIF_INFO
9270 # define NIF_INFO 0x00000010
9271 #endif
9272 #ifndef NIIF_NONE
9273 # define NIIF_NONE 0x00000000
9274 #endif
9275 #ifndef NIIF_INFO
9276 # define NIIF_INFO 0x00000001
9277 #endif
9278 #ifndef NIIF_WARNING
9279 # define NIIF_WARNING 0x00000002
9280 #endif
9281 #ifndef NIIF_ERROR
9282 # define NIIF_ERROR 0x00000003
9283 #endif
9284
9285
9286 #define EMACS_TRAY_NOTIFICATION_ID 42 /* arbitrary */
9287 #define EMACS_NOTIFICATION_MSG (WM_APP + 1)
9288
9289 enum NI_Severity {
9290 Ni_None,
9291 Ni_Info,
9292 Ni_Warn,
9293 Ni_Err
9294 };
9295
9296 /* Report the version of a DLL given by its name. The return value is
9297 constructed using MAKEDLLVERULL. */
9298 static ULONGLONG
9299 get_dll_version (const char *dll_name)
9300 {
9301 ULONGLONG version = 0;
9302 HINSTANCE hdll = LoadLibrary (dll_name);
9303
9304 if (hdll)
9305 {
9306 DLLGETVERSIONPROC pDllGetVersion
9307 = (DLLGETVERSIONPROC) GetProcAddress (hdll, "DllGetVersion");
9308
9309 if (pDllGetVersion)
9310 {
9311 DLLVERSIONINFO dvi;
9312 HRESULT result;
9313
9314 memset (&dvi, 0, sizeof(dvi));
9315 dvi.cbSize = sizeof(dvi);
9316 result = pDllGetVersion (&dvi);
9317 if (SUCCEEDED (result))
9318 version = MAKEDLLVERULL (dvi.dwMajorVersion, dvi.dwMinorVersion,
9319 0, 0);
9320 }
9321 FreeLibrary (hdll);
9322 }
9323
9324 return version;
9325 }
9326
9327 /* Return the number of bytes in UTF-8 encoded string STR that
9328 corresponds to at most LIM characters. If STR ends before LIM
9329 characters, return the number of bytes in STR including the
9330 terminating null byte. */
9331 static int
9332 utf8_mbslen_lim (const char *str, int lim)
9333 {
9334 const char *p = str;
9335 int mblen = 0, nchars = 0;
9336
9337 while (*p && nchars < lim)
9338 {
9339 int nbytes = CHAR_BYTES (*p);
9340
9341 mblen += nbytes;
9342 nchars++;
9343 p += nbytes;
9344 }
9345
9346 if (!*p && nchars < lim)
9347 mblen++;
9348
9349 return mblen;
9350 }
9351
9352 /* Low-level subroutine to show tray notifications. All strings are
9353 supposed to be unibyte UTF-8 encoded by the caller. */
9354 static EMACS_INT
9355 add_tray_notification (struct frame *f, const char *icon, const char *tip,
9356 enum NI_Severity severity, unsigned timeout,
9357 const char *title, const char *msg)
9358 {
9359 EMACS_INT retval = EMACS_TRAY_NOTIFICATION_ID;
9360
9361 if (FRAME_W32_P (f))
9362 {
9363 MY_NOTIFYICONDATAW nidw;
9364 ULONGLONG shell_dll_version = get_dll_version ("Shell32.dll");
9365 wchar_t tipw[128], msgw[256], titlew[64];
9366 int tiplen;
9367
9368 memset (&nidw, 0, sizeof(nidw));
9369
9370 /* MSDN says the full struct is supported since Vista, whose
9371 Shell32.dll version is said to be 6.0.6. But DllGetVersion
9372 cannot report the 3rd field value, it reports "build number"
9373 instead, which is something else. So we use the Windows 7's
9374 version 6.1 as cutoff, and Vista loses. (Actually, the loss
9375 is not a real one, since we don't expose the hBalloonIcon
9376 member of the struct to Lisp.) */
9377 if (shell_dll_version >= MAKEDLLVERULL (6, 1, 0, 0)) /* >= Windows 7 */
9378 nidw.cbSize = sizeof (nidw);
9379 else if (shell_dll_version >= MAKEDLLVERULL (6, 0, 0, 0)) /* XP */
9380 nidw.cbSize = MYNOTIFYICONDATAW_V3_SIZE;
9381 else if (shell_dll_version >= MAKEDLLVERULL (5, 0, 0, 0)) /* W2K */
9382 nidw.cbSize = MYNOTIFYICONDATAW_V2_SIZE;
9383 else
9384 nidw.cbSize = MYNOTIFYICONDATAW_V1_SIZE; /* < W2K */
9385 nidw.hWnd = FRAME_W32_WINDOW (f);
9386 nidw.uID = EMACS_TRAY_NOTIFICATION_ID;
9387 nidw.uFlags = NIF_MESSAGE | NIF_ICON | NIF_TIP | NIF_INFO;
9388 nidw.uCallbackMessage = EMACS_NOTIFICATION_MSG;
9389 if (!*icon)
9390 nidw.hIcon = LoadIcon (hinst, EMACS_CLASS);
9391 else
9392 {
9393 if (w32_unicode_filenames)
9394 {
9395 wchar_t icon_w[MAX_PATH];
9396
9397 if (filename_to_utf16 (icon, icon_w) != 0)
9398 {
9399 errno = ENOENT;
9400 return -1;
9401 }
9402 nidw.hIcon = LoadImageW (NULL, icon_w, IMAGE_ICON, 0, 0,
9403 LR_DEFAULTSIZE | LR_LOADFROMFILE);
9404 }
9405 else
9406 {
9407 char icon_a[MAX_PATH];
9408
9409 if (filename_to_ansi (icon, icon_a) != 0)
9410 {
9411 errno = ENOENT;
9412 return -1;
9413 }
9414 nidw.hIcon = LoadImageA (NULL, icon_a, IMAGE_ICON, 0, 0,
9415 LR_DEFAULTSIZE | LR_LOADFROMFILE);
9416 }
9417 }
9418 if (!nidw.hIcon)
9419 {
9420 switch (GetLastError ())
9421 {
9422 case ERROR_FILE_NOT_FOUND:
9423 errno = ENOENT;
9424 break;
9425 default:
9426 errno = ENOMEM;
9427 break;
9428 }
9429 return -1;
9430 }
9431
9432 /* Windows 9X and NT4 support only 64 characters in the Tip,
9433 later versions support up to 128. */
9434 if (nidw.cbSize == MYNOTIFYICONDATAW_V1_SIZE)
9435 {
9436 tiplen = pMultiByteToWideChar (CP_UTF8, multiByteToWideCharFlags,
9437 tip, utf8_mbslen_lim (tip, 63),
9438 tipw, 64);
9439 if (tiplen >= 63)
9440 tipw[63] = 0;
9441 }
9442 else
9443 {
9444 tiplen = pMultiByteToWideChar (CP_UTF8, multiByteToWideCharFlags,
9445 tip, utf8_mbslen_lim (tip, 127),
9446 tipw, 128);
9447 if (tiplen >= 127)
9448 tipw[127] = 0;
9449 }
9450 if (tiplen == 0)
9451 {
9452 errno = EINVAL;
9453 retval = -1;
9454 goto done;
9455 }
9456 wcscpy (nidw.szTip, tipw);
9457
9458 /* The rest of the structure is only supported since Windows 2000. */
9459 if (nidw.cbSize > MYNOTIFYICONDATAW_V1_SIZE)
9460 {
9461 int slen;
9462
9463 slen = pMultiByteToWideChar (CP_UTF8, multiByteToWideCharFlags,
9464 msg, utf8_mbslen_lim (msg, 255),
9465 msgw, 256);
9466 if (slen >= 255)
9467 msgw[255] = 0;
9468 else if (slen == 0)
9469 {
9470 errno = EINVAL;
9471 retval = -1;
9472 goto done;
9473 }
9474 wcscpy (nidw.szInfo, msgw);
9475 nidw.uTimeout = timeout;
9476 slen = pMultiByteToWideChar (CP_UTF8, multiByteToWideCharFlags,
9477 title, utf8_mbslen_lim (title, 63),
9478 titlew, 64);
9479 if (slen >= 63)
9480 titlew[63] = 0;
9481 else if (slen == 0)
9482 {
9483 errno = EINVAL;
9484 retval = -1;
9485 goto done;
9486 }
9487 wcscpy (nidw.szInfoTitle, titlew);
9488
9489 switch (severity)
9490 {
9491 case Ni_None:
9492 nidw.dwInfoFlags = NIIF_NONE;
9493 break;
9494 case Ni_Info:
9495 default:
9496 nidw.dwInfoFlags = NIIF_INFO;
9497 break;
9498 case Ni_Warn:
9499 nidw.dwInfoFlags = NIIF_WARNING;
9500 break;
9501 case Ni_Err:
9502 nidw.dwInfoFlags = NIIF_ERROR;
9503 break;
9504 }
9505 }
9506
9507 if (!Shell_NotifyIconW (NIM_ADD, (PNOTIFYICONDATAW)&nidw))
9508 {
9509 /* GetLastError returns meaningless results when
9510 Shell_NotifyIcon fails. */
9511 DebPrint (("Shell_NotifyIcon ADD failed (err=%d)\n",
9512 GetLastError ()));
9513 errno = EINVAL;
9514 retval = -1;
9515 }
9516 done:
9517 if (*icon && !DestroyIcon (nidw.hIcon))
9518 DebPrint (("DestroyIcon failed (err=%d)\n", GetLastError ()));
9519 }
9520 return retval;
9521 }
9522
9523 /* Low-level subroutine to remove a tray notification. Note: we only
9524 pass the minimum data about the notification: its ID and the handle
9525 of the window to which it sends messages. MSDN doesn't say this is
9526 enough, but it works in practice. This allows us to avoid keeping
9527 the notification data around after we show the notification. */
9528 static void
9529 delete_tray_notification (struct frame *f, int id)
9530 {
9531 if (FRAME_W32_P (f))
9532 {
9533 MY_NOTIFYICONDATAW nidw;
9534
9535 memset (&nidw, 0, sizeof(nidw));
9536 nidw.hWnd = FRAME_W32_WINDOW (f);
9537 nidw.uID = id;
9538
9539 if (!Shell_NotifyIconW (NIM_DELETE, (PNOTIFYICONDATAW)&nidw))
9540 {
9541 /* GetLastError returns meaningless results when
9542 Shell_NotifyIcon fails. */
9543 DebPrint (("Shell_NotifyIcon DELETE failed\n"));
9544 errno = EINVAL;
9545 return;
9546 }
9547 }
9548 return;
9549 }
9550
9551 DEFUN ("w32-notification-notify",
9552 Fw32_notification_notify, Sw32_notification_notify,
9553 0, MANY, 0,
9554 doc: /* Display an MS-Windows tray notification as specified by PARAMS.
9555
9556 Value is the integer unique ID of the notification that can be used
9557 to remove the notification using `w32-notification-close', which see.
9558 If the function fails, the return value is nil.
9559
9560 Tray notifications, a.k.a. \"taskbar messages\", are messages that
9561 inform the user about events unrelated to the current user activity,
9562 such as a significant system event, by briefly displaying informative
9563 text in a balloon from an icon in the notification area of the taskbar.
9564
9565 Parameters in PARAMS are specified as keyword/value pairs. All the
9566 parameters are optional, but if no parameters are specified, the
9567 function will do nothing and return nil.
9568
9569 The following parameters are supported:
9570
9571 :icon ICON -- Display ICON in the system tray. If ICON is a string,
9572 it should specify a file name from which to load the
9573 icon; the specified file should be a .ico Windows icon
9574 file. If ICON is not a string, or if this parameter
9575 is not specified, the standard Emacs icon will be used.
9576
9577 :tip TIP -- Use TIP as the tooltip for the notification. If TIP
9578 is a string, this is the text of a tooltip that will
9579 be shown when the mouse pointer hovers over the tray
9580 icon added by the notification. If TIP is not a
9581 string, or if this parameter is not specified, the
9582 default tooltip text is \"Emacs notification\". The
9583 tooltip text can be up to 127 characters long (63
9584 on Windows versions before W2K). Longer strings
9585 will be truncated.
9586
9587 :level LEVEL -- Notification severity level, one of `info',
9588 `warning', or `error'. If given, the value
9589 determines the icon displayed to the left of the
9590 notification title, but only if the `:title'
9591 parameter (see below) is also specified and is a
9592 string.
9593
9594 :title TITLE -- The title of the notification. If TITLE is a string,
9595 it is displayed in a larger font immediately above
9596 the body text. The title text can be up to 63
9597 characters long; longer text will be truncated.
9598
9599 :body BODY -- The body of the notification. If BODY is a string,
9600 it specifies the text of the notification message.
9601 Use embedded newlines to control how the text is
9602 broken into lines. The body text can be up to 255
9603 characters long, and will be truncated if it's longer.
9604
9605 Note that versions of Windows before W2K support only `:icon' and `:tip'.
9606 You can pass the other parameters, but they will be ignored on those
9607 old systems.
9608
9609 There can be at most one active notification at any given time. An
9610 active notification must be removed by calling `w32-notification-close'
9611 before a new one can be shown.
9612
9613 usage: (w32-notification-notify &rest PARAMS) */)
9614 (ptrdiff_t nargs, Lisp_Object *args)
9615 {
9616 struct frame *f = SELECTED_FRAME ();
9617 Lisp_Object arg_plist, lres;
9618 EMACS_INT retval;
9619 char *icon, *tip, *title, *msg;
9620 enum NI_Severity severity;
9621 unsigned timeout;
9622
9623 if (nargs == 0)
9624 return Qnil;
9625
9626 arg_plist = Flist (nargs, args);
9627
9628 /* Icon. */
9629 lres = Fplist_get (arg_plist, QCicon);
9630 if (STRINGP (lres))
9631 icon = SSDATA (ENCODE_FILE (Fexpand_file_name (lres, Qnil)));
9632 else
9633 icon = "";
9634
9635 /* Tip. */
9636 lres = Fplist_get (arg_plist, QCtip);
9637 if (STRINGP (lres))
9638 tip = SSDATA (code_convert_string_norecord (lres, Qutf_8, 1));
9639 else
9640 tip = "Emacs notification";
9641
9642 /* Severity. */
9643 lres = Fplist_get (arg_plist, QClevel);
9644 if (NILP (lres))
9645 severity = Ni_None;
9646 else if (EQ (lres, Qinfo))
9647 severity = Ni_Info;
9648 else if (EQ (lres, Qwarning))
9649 severity = Ni_Warn;
9650 else if (EQ (lres, Qerror))
9651 severity = Ni_Err;
9652 else
9653 severity = Ni_Info;
9654
9655 /* Title. */
9656 lres = Fplist_get (arg_plist, QCtitle);
9657 if (STRINGP (lres))
9658 title = SSDATA (code_convert_string_norecord (lres, Qutf_8, 1));
9659 else
9660 title = "";
9661
9662 /* Notification body text. */
9663 lres = Fplist_get (arg_plist, QCbody);
9664 if (STRINGP (lres))
9665 msg = SSDATA (code_convert_string_norecord (lres, Qutf_8, 1));
9666 else
9667 msg = "";
9668
9669 /* Do it! */
9670 retval = add_tray_notification (f, icon, tip, severity, timeout, title, msg);
9671 return (retval < 0 ? Qnil : make_number (retval));
9672 }
9673
9674 DEFUN ("w32-notification-close",
9675 Fw32_notification_close, Sw32_notification_close,
9676 1, 1, 0,
9677 doc: /* Remove the MS-Windows tray notification specified by its ID. */)
9678 (Lisp_Object id)
9679 {
9680 struct frame *f = SELECTED_FRAME ();
9681
9682 if (INTEGERP (id))
9683 delete_tray_notification (f, XINT (id));
9684
9685 return Qnil;
9686 }
9687
9688 #endif /* WINDOWSNT && !HAVE_DBUS */
9689
9690 \f
9691 /***********************************************************************
9692 Initialization
9693 ***********************************************************************/
9694
9695 /* Keep this list in the same order as frame_parms in frame.c.
9696 Use 0 for unsupported frame parameters. */
9697
9698 frame_parm_handler w32_frame_parm_handlers[] =
9699 {
9700 x_set_autoraise,
9701 x_set_autolower,
9702 x_set_background_color,
9703 x_set_border_color,
9704 x_set_border_width,
9705 x_set_cursor_color,
9706 x_set_cursor_type,
9707 x_set_font,
9708 x_set_foreground_color,
9709 x_set_icon_name,
9710 x_set_icon_type,
9711 x_set_internal_border_width,
9712 x_set_right_divider_width,
9713 x_set_bottom_divider_width,
9714 x_set_menu_bar_lines,
9715 x_set_mouse_color,
9716 x_explicitly_set_name,
9717 x_set_scroll_bar_width,
9718 x_set_scroll_bar_height,
9719 x_set_title,
9720 x_set_unsplittable,
9721 x_set_vertical_scroll_bars,
9722 x_set_horizontal_scroll_bars,
9723 x_set_visibility,
9724 x_set_tool_bar_lines,
9725 0, /* x_set_scroll_bar_foreground, */
9726 0, /* x_set_scroll_bar_background, */
9727 x_set_screen_gamma,
9728 x_set_line_spacing,
9729 x_set_left_fringe,
9730 x_set_right_fringe,
9731 0, /* x_set_wait_for_wm, */
9732 x_set_fullscreen,
9733 x_set_font_backend,
9734 x_set_alpha,
9735 0, /* x_set_sticky */
9736 0, /* x_set_tool_bar_position */
9737 };
9738
9739 void
9740 syms_of_w32fns (void)
9741 {
9742 globals_of_w32fns ();
9743 track_mouse_window = NULL;
9744
9745 w32_visible_system_caret_hwnd = NULL;
9746
9747 DEFSYM (Qundefined_color, "undefined-color");
9748 DEFSYM (Qcancel_timer, "cancel-timer");
9749 DEFSYM (Qhyper, "hyper");
9750 DEFSYM (Qsuper, "super");
9751 DEFSYM (Qmeta, "meta");
9752 DEFSYM (Qalt, "alt");
9753 DEFSYM (Qctrl, "ctrl");
9754 DEFSYM (Qcontrol, "control");
9755 DEFSYM (Qshift, "shift");
9756 DEFSYM (Qfont_parameter, "font-parameter");
9757 DEFSYM (Qgeometry, "geometry");
9758 DEFSYM (Qworkarea, "workarea");
9759 DEFSYM (Qmm_size, "mm-size");
9760 DEFSYM (Qframes, "frames");
9761 DEFSYM (Qtip_frame, "tip-frame");
9762 DEFSYM (Qassq_delete_all, "assq-delete-all");
9763 DEFSYM (Qunicode_sip, "unicode-sip");
9764 #if defined WINDOWSNT && !defined HAVE_DBUS
9765 DEFSYM (QCicon, ":icon");
9766 DEFSYM (QCtip, ":tip");
9767 DEFSYM (QClevel, ":level");
9768 DEFSYM (Qinfo, "info");
9769 DEFSYM (Qwarning, "warning");
9770 DEFSYM (QCtitle, ":title");
9771 DEFSYM (QCbody, ":body");
9772 #endif
9773
9774 /* Symbols used elsewhere, but only in MS-Windows-specific code. */
9775 DEFSYM (Qgnutls, "gnutls");
9776 DEFSYM (Qlibxml2, "libxml2");
9777 DEFSYM (Qserif, "serif");
9778 DEFSYM (Qzlib, "zlib");
9779
9780 Fput (Qundefined_color, Qerror_conditions,
9781 listn (CONSTYPE_PURE, 2, Qundefined_color, Qerror));
9782 Fput (Qundefined_color, Qerror_message,
9783 build_pure_c_string ("Undefined color"));
9784
9785 staticpro (&w32_grabbed_keys);
9786 w32_grabbed_keys = Qnil;
9787
9788 DEFVAR_LISP ("w32-color-map", Vw32_color_map,
9789 doc: /* An array of color name mappings for Windows. */);
9790 Vw32_color_map = Qnil;
9791
9792 DEFVAR_LISP ("w32-pass-alt-to-system", Vw32_pass_alt_to_system,
9793 doc: /* Non-nil if Alt key presses are passed on to Windows.
9794 When non-nil, for example, Alt pressed and released and then space will
9795 open the System menu. When nil, Emacs processes the Alt key events, and
9796 then silently swallows them. */);
9797 Vw32_pass_alt_to_system = Qnil;
9798
9799 DEFVAR_LISP ("w32-alt-is-meta", Vw32_alt_is_meta,
9800 doc: /* Non-nil if the Alt key is to be considered the same as the META key.
9801 When nil, Emacs will translate the Alt key to the ALT modifier, not to META. */);
9802 Vw32_alt_is_meta = Qt;
9803
9804 DEFVAR_INT ("w32-quit-key", w32_quit_key,
9805 doc: /* If non-zero, the virtual key code for an alternative quit key. */);
9806 w32_quit_key = 0;
9807
9808 DEFVAR_LISP ("w32-pass-lwindow-to-system",
9809 Vw32_pass_lwindow_to_system,
9810 doc: /* If non-nil, the left \"Windows\" key is passed on to Windows.
9811
9812 When non-nil, the Start menu is opened by tapping the key.
9813 If you set this to nil, the left \"Windows\" key is processed by Emacs
9814 according to the value of `w32-lwindow-modifier', which see.
9815
9816 Note that some combinations of the left \"Windows\" key with other
9817 keys are caught by Windows at low level. For example, <lwindow>-r
9818 pops up the Windows Run dialog, <lwindow>-<Pause> pops up the "System
9819 Properties" dialog, etc. On Windows 10, no \"Windows\" key
9820 combinations are normally handed to applications. To enable Emacs to
9821 process \"Windows\" key combinations, use the function
9822 `w32-register-hot-key`.
9823
9824 For Windows 98/ME, see the doc string of `w32-phantom-key-code'. */);
9825 Vw32_pass_lwindow_to_system = Qt;
9826
9827 DEFVAR_LISP ("w32-pass-rwindow-to-system",
9828 Vw32_pass_rwindow_to_system,
9829 doc: /* If non-nil, the right \"Windows\" key is passed on to Windows.
9830
9831 When non-nil, the Start menu is opened by tapping the key.
9832 If you set this to nil, the right \"Windows\" key is processed by Emacs
9833 according to the value of `w32-rwindow-modifier', which see.
9834
9835 Note that some combinations of the right \"Windows\" key with other
9836 keys are caught by Windows at low level. For example, <rwindow>-r
9837 pops up the Windows Run dialog, <rwindow>-<Pause> pops up the "System
9838 Properties" dialog, etc. On Windows 10, no \"Windows\" key
9839 combinations are normally handed to applications. To enable Emacs to
9840 process \"Windows\" key combinations, use the function
9841 `w32-register-hot-key`.
9842
9843 For Windows 98/ME, see the doc string of `w32-phantom-key-code'. */);
9844 Vw32_pass_rwindow_to_system = Qt;
9845
9846 DEFVAR_LISP ("w32-phantom-key-code",
9847 Vw32_phantom_key_code,
9848 doc: /* Virtual key code used to generate \"phantom\" key presses.
9849 Value is a number between 0 and 255.
9850
9851 Phantom key presses are generated in order to stop the system from
9852 acting on \"Windows\" key events when `w32-pass-lwindow-to-system' or
9853 `w32-pass-rwindow-to-system' is nil.
9854
9855 This variable is only used on Windows 98 and ME. For other Windows
9856 versions, see the documentation of the `w32-register-hot-key`
9857 function. */);
9858 /* Although 255 is technically not a valid key code, it works and
9859 means that this hack won't interfere with any real key code. */
9860 XSETINT (Vw32_phantom_key_code, 255);
9861
9862 DEFVAR_LISP ("w32-enable-num-lock",
9863 Vw32_enable_num_lock,
9864 doc: /* If non-nil, the Num Lock key acts normally.
9865 Set to nil to handle Num Lock as the `kp-numlock' key. */);
9866 Vw32_enable_num_lock = Qt;
9867
9868 DEFVAR_LISP ("w32-enable-caps-lock",
9869 Vw32_enable_caps_lock,
9870 doc: /* If non-nil, the Caps Lock key acts normally.
9871 Set to nil to handle Caps Lock as the `capslock' key. */);
9872 Vw32_enable_caps_lock = Qt;
9873
9874 DEFVAR_LISP ("w32-scroll-lock-modifier",
9875 Vw32_scroll_lock_modifier,
9876 doc: /* Modifier to use for the Scroll Lock ON state.
9877 The value can be hyper, super, meta, alt, control or shift for the
9878 respective modifier, or nil to handle Scroll Lock as the `scroll' key.
9879 Any other value will cause the Scroll Lock key to be ignored. */);
9880 Vw32_scroll_lock_modifier = Qnil;
9881
9882 DEFVAR_LISP ("w32-lwindow-modifier",
9883 Vw32_lwindow_modifier,
9884 doc: /* Modifier to use for the left \"Windows\" key.
9885 The value can be hyper, super, meta, alt, control or shift for the
9886 respective modifier, or nil to appear as the `lwindow' key.
9887 Any other value will cause the key to be ignored.
9888
9889 Also see the documentation of the `w32-register-hot-key` function. */);
9890 Vw32_lwindow_modifier = Qnil;
9891
9892 DEFVAR_LISP ("w32-rwindow-modifier",
9893 Vw32_rwindow_modifier,
9894 doc: /* Modifier to use for the right \"Windows\" key.
9895 The value can be hyper, super, meta, alt, control or shift for the
9896 respective modifier, or nil to appear as the `rwindow' key.
9897 Any other value will cause the key to be ignored.
9898
9899 Also see the documentation of the `w32-register-hot-key` function. */);
9900 Vw32_rwindow_modifier = Qnil;
9901
9902 DEFVAR_LISP ("w32-apps-modifier",
9903 Vw32_apps_modifier,
9904 doc: /* Modifier to use for the \"Apps\" key.
9905 The value can be hyper, super, meta, alt, control or shift for the
9906 respective modifier, or nil to appear as the `apps' key.
9907 Any other value will cause the key to be ignored. */);
9908 Vw32_apps_modifier = Qnil;
9909
9910 DEFVAR_BOOL ("w32-enable-synthesized-fonts", w32_enable_synthesized_fonts,
9911 doc: /* Non-nil enables selection of artificially italicized and bold fonts. */);
9912 w32_enable_synthesized_fonts = 0;
9913
9914 DEFVAR_LISP ("w32-enable-palette", Vw32_enable_palette,
9915 doc: /* Non-nil enables Windows palette management to map colors exactly. */);
9916 Vw32_enable_palette = Qt;
9917
9918 DEFVAR_INT ("w32-mouse-button-tolerance",
9919 w32_mouse_button_tolerance,
9920 doc: /* Analogue of double click interval for faking middle mouse events.
9921 The value is the minimum time in milliseconds that must elapse between
9922 left and right button down events before they are considered distinct events.
9923 If both mouse buttons are depressed within this interval, a middle mouse
9924 button down event is generated instead. */);
9925 w32_mouse_button_tolerance = GetDoubleClickTime () / 2;
9926
9927 DEFVAR_INT ("w32-mouse-move-interval",
9928 w32_mouse_move_interval,
9929 doc: /* Minimum interval between mouse move events.
9930 The value is the minimum time in milliseconds that must elapse between
9931 successive mouse move (or scroll bar drag) events before they are
9932 reported as lisp events. */);
9933 w32_mouse_move_interval = 0;
9934
9935 DEFVAR_BOOL ("w32-pass-extra-mouse-buttons-to-system",
9936 w32_pass_extra_mouse_buttons_to_system,
9937 doc: /* If non-nil, the fourth and fifth mouse buttons are passed to Windows.
9938 Recent versions of Windows support mice with up to five buttons.
9939 Since most applications don't support these extra buttons, most mouse
9940 drivers will allow you to map them to functions at the system level.
9941 If this variable is non-nil, Emacs will pass them on, allowing the
9942 system to handle them. */);
9943 w32_pass_extra_mouse_buttons_to_system = 0;
9944
9945 DEFVAR_BOOL ("w32-pass-multimedia-buttons-to-system",
9946 w32_pass_multimedia_buttons_to_system,
9947 doc: /* If non-nil, media buttons are passed to Windows.
9948 Some modern keyboards contain buttons for controlling media players, web
9949 browsers and other applications. Generally these buttons are handled on a
9950 system wide basis, but by setting this to nil they are made available
9951 to Emacs for binding. Depending on your keyboard, additional keys that
9952 may be available are:
9953
9954 browser-back, browser-forward, browser-refresh, browser-stop,
9955 browser-search, browser-favorites, browser-home,
9956 mail, mail-reply, mail-forward, mail-send,
9957 app-1, app-2,
9958 help, find, new, open, close, save, print, undo, redo, copy, cut, paste,
9959 spell-check, correction-list, toggle-dictate-command,
9960 media-next, media-previous, media-stop, media-play-pause, media-select,
9961 media-play, media-pause, media-record, media-fast-forward, media-rewind,
9962 media-channel-up, media-channel-down,
9963 volume-mute, volume-up, volume-down,
9964 mic-volume-mute, mic-volume-down, mic-volume-up, mic-toggle,
9965 bass-down, bass-boost, bass-up, treble-down, treble-up */);
9966 w32_pass_multimedia_buttons_to_system = 1;
9967
9968 #if 0 /* TODO: Mouse cursor customization. */
9969 DEFVAR_LISP ("x-pointer-shape", Vx_pointer_shape,
9970 doc: /* The shape of the pointer when over text.
9971 Changing the value does not affect existing frames
9972 unless you set the mouse color. */);
9973 Vx_pointer_shape = Qnil;
9974
9975 Vx_nontext_pointer_shape = Qnil;
9976
9977 Vx_mode_pointer_shape = Qnil;
9978
9979 DEFVAR_LISP ("x-hourglass-pointer-shape", Vx_hourglass_pointer_shape,
9980 doc: /* The shape of the pointer when Emacs is busy.
9981 This variable takes effect when you create a new frame
9982 or when you set the mouse color. */);
9983 Vx_hourglass_pointer_shape = Qnil;
9984
9985 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
9986 Vx_sensitive_text_pointer_shape,
9987 doc: /* The shape of the pointer when over mouse-sensitive text.
9988 This variable takes effect when you create a new frame
9989 or when you set the mouse color. */);
9990 Vx_sensitive_text_pointer_shape = Qnil;
9991
9992 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
9993 Vx_window_horizontal_drag_shape,
9994 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
9995 This variable takes effect when you create a new frame
9996 or when you set the mouse color. */);
9997 Vx_window_horizontal_drag_shape = Qnil;
9998
9999 DEFVAR_LISP ("x-window-vertical-drag-cursor",
10000 Vx_window_vertical_drag_shape,
10001 doc: /* Pointer shape to use for indicating a window can be dragged vertically.
10002 This variable takes effect when you create a new frame
10003 or when you set the mouse color. */);
10004 Vx_window_vertical_drag_shape = Qnil;
10005 #endif
10006
10007 DEFVAR_LISP ("x-cursor-fore-pixel", Vx_cursor_fore_pixel,
10008 doc: /* A string indicating the foreground color of the cursor box. */);
10009 Vx_cursor_fore_pixel = Qnil;
10010
10011 DEFVAR_LISP ("x-max-tooltip-size", Vx_max_tooltip_size,
10012 doc: /* Maximum size for tooltips.
10013 Value is a pair (COLUMNS . ROWS). Text larger than this is clipped. */);
10014 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
10015
10016 DEFVAR_LISP ("x-no-window-manager", Vx_no_window_manager,
10017 doc: /* Non-nil if no window manager is in use.
10018 Emacs doesn't try to figure this out; this is always nil
10019 unless you set it to something else. */);
10020 /* We don't have any way to find this out, so set it to nil
10021 and maybe the user would like to set it to t. */
10022 Vx_no_window_manager = Qnil;
10023
10024 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
10025 Vx_pixel_size_width_font_regexp,
10026 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
10027
10028 Since Emacs gets width of a font matching with this regexp from
10029 PIXEL_SIZE field of the name, font finding mechanism gets faster for
10030 such a font. This is especially effective for such large fonts as
10031 Chinese, Japanese, and Korean. */);
10032 Vx_pixel_size_width_font_regexp = Qnil;
10033
10034 DEFVAR_LISP ("w32-bdf-filename-alist",
10035 Vw32_bdf_filename_alist,
10036 doc: /* List of bdf fonts and their corresponding filenames. */);
10037 Vw32_bdf_filename_alist = Qnil;
10038
10039 DEFVAR_BOOL ("w32-strict-fontnames",
10040 w32_strict_fontnames,
10041 doc: /* Non-nil means only use fonts that are exact matches for those requested.
10042 Default is nil, which allows old fontnames that are not XLFD compliant,
10043 and allows third-party CJK display to work by specifying false charset
10044 fields to trick Emacs into translating to Big5, SJIS etc.
10045 Setting this to t will prevent wrong fonts being selected when
10046 fontsets are automatically created. */);
10047 w32_strict_fontnames = 0;
10048
10049 DEFVAR_BOOL ("w32-strict-painting",
10050 w32_strict_painting,
10051 doc: /* Non-nil means use strict rules for repainting frames.
10052 Set this to nil to get the old behavior for repainting; this should
10053 only be necessary if the default setting causes problems. */);
10054 w32_strict_painting = 1;
10055
10056 DEFVAR_BOOL ("w32-use-fallback-wm-chars-method",
10057 w32_use_fallback_wm_chars_method,
10058 doc: /* Non-nil means use old method of processing character keys.
10059 This is intended only for debugging of the new processing method.
10060 Default is nil.
10061
10062 This variable has effect only on NT family of systems, not on Windows 9X. */);
10063 w32_use_fallback_wm_chars_method = 0;
10064
10065 DEFVAR_BOOL ("w32-disable-new-uniscribe-apis",
10066 w32_disable_new_uniscribe_apis,
10067 doc: /* Non-nil means don't use new Uniscribe APIs.
10068 The new APIs are used to access OTF features supported by fonts.
10069 This is intended only for debugging of the new Uniscribe-related code.
10070 Default is nil.
10071
10072 This variable has effect only on Windows Vista and later. */);
10073 w32_disable_new_uniscribe_apis = 0;
10074
10075 DEFVAR_LISP ("w32-tooltip-extra-pixels",
10076 Vw32_tooltip_extra_pixels,
10077 doc: /* Number of pixels added after tooltip text.
10078 On Windows some fonts may cause the last character of a tooltip be
10079 truncated or wrapped around to the next line. Adding some extra space
10080 at the end of the toooltip works around this problem.
10081
10082 This variable specifies the number of pixels that shall be added. The
10083 default value t means to add the width of one canonical character of the
10084 tip frame. */);
10085 Vw32_tooltip_extra_pixels = Qt;
10086
10087 #if 0 /* TODO: Port to W32 */
10088 defsubr (&Sx_change_window_property);
10089 defsubr (&Sx_delete_window_property);
10090 defsubr (&Sx_window_property);
10091 #endif
10092 defsubr (&Sxw_display_color_p);
10093 defsubr (&Sx_display_grayscale_p);
10094 defsubr (&Sxw_color_defined_p);
10095 defsubr (&Sxw_color_values);
10096 defsubr (&Sx_server_max_request_size);
10097 defsubr (&Sx_server_vendor);
10098 defsubr (&Sx_server_version);
10099 defsubr (&Sx_display_pixel_width);
10100 defsubr (&Sx_display_pixel_height);
10101 defsubr (&Sx_display_mm_width);
10102 defsubr (&Sx_display_mm_height);
10103 defsubr (&Sx_display_screens);
10104 defsubr (&Sx_display_planes);
10105 defsubr (&Sx_display_color_cells);
10106 defsubr (&Sx_display_visual_class);
10107 defsubr (&Sx_display_backing_store);
10108 defsubr (&Sx_display_save_under);
10109 defsubr (&Sx_create_frame);
10110 defsubr (&Sx_open_connection);
10111 defsubr (&Sx_close_connection);
10112 defsubr (&Sx_display_list);
10113 defsubr (&Sw32_frame_geometry);
10114 defsubr (&Sw32_frame_edges);
10115 defsubr (&Sw32_mouse_absolute_pixel_position);
10116 defsubr (&Sw32_set_mouse_absolute_pixel_position);
10117 defsubr (&Sx_synchronize);
10118
10119 /* W32 specific functions */
10120
10121 defsubr (&Sw32_define_rgb_color);
10122 defsubr (&Sw32_default_color_map);
10123 defsubr (&Sw32_display_monitor_attributes_list);
10124 defsubr (&Sw32_send_sys_command);
10125 defsubr (&Sw32_shell_execute);
10126 defsubr (&Sw32_register_hot_key);
10127 defsubr (&Sw32_unregister_hot_key);
10128 defsubr (&Sw32_registered_hot_keys);
10129 defsubr (&Sw32_reconstruct_hot_key);
10130 defsubr (&Sw32_toggle_lock_key);
10131 defsubr (&Sw32_window_exists_p);
10132 defsubr (&Sw32_battery_status);
10133 defsubr (&Sw32__menu_bar_in_use);
10134 #if defined WINDOWSNT && !defined HAVE_DBUS
10135 defsubr (&Sw32_notification_notify);
10136 defsubr (&Sw32_notification_close);
10137 #endif
10138
10139 #ifdef WINDOWSNT
10140 defsubr (&Sfile_system_info);
10141 defsubr (&Sdefault_printer_name);
10142 #endif
10143
10144 defsubr (&Sset_message_beep);
10145 defsubr (&Sx_show_tip);
10146 defsubr (&Sx_hide_tip);
10147 tip_timer = Qnil;
10148 staticpro (&tip_timer);
10149 tip_frame = Qnil;
10150 staticpro (&tip_frame);
10151
10152 last_show_tip_args = Qnil;
10153 staticpro (&last_show_tip_args);
10154
10155 defsubr (&Sx_file_dialog);
10156 #ifdef WINDOWSNT
10157 defsubr (&Ssystem_move_file_to_trash);
10158 #endif
10159 }
10160
10161 \f
10162
10163 /* Crashing and reporting backtrace. */
10164
10165 #ifndef CYGWIN
10166 static LONG CALLBACK my_exception_handler (EXCEPTION_POINTERS *);
10167 static LPTOP_LEVEL_EXCEPTION_FILTER prev_exception_handler;
10168 #endif
10169 static DWORD except_code;
10170 static PVOID except_addr;
10171
10172 #ifndef CYGWIN
10173
10174 /* Stack overflow recovery. */
10175
10176 /* MinGW headers don't declare this (should be in malloc.h). Also,
10177 the function is not present pre-W2K, so make the call through
10178 a function pointer. */
10179 typedef int (__cdecl *_resetstkoflw_proc) (void);
10180 static _resetstkoflw_proc resetstkoflw;
10181
10182 /* Re-establish the guard page at stack limit. This is needed because
10183 when a stack overflow is detected, Windows removes the guard bit
10184 from the guard page, so if we don't re-establish that protection,
10185 the next stack overflow will cause a crash. */
10186 void
10187 w32_reset_stack_overflow_guard (void)
10188 {
10189 if (resetstkoflw == NULL)
10190 resetstkoflw =
10191 (_resetstkoflw_proc)GetProcAddress (GetModuleHandle ("msvcrt.dll"),
10192 "_resetstkoflw");
10193 /* We ignore the return value. If _resetstkoflw fails, the next
10194 stack overflow will crash the program. */
10195 if (resetstkoflw != NULL)
10196 (void)resetstkoflw ();
10197 }
10198
10199 static void
10200 stack_overflow_handler (void)
10201 {
10202 /* Hard GC error may lead to stack overflow caused by
10203 too nested calls to mark_object. No way to survive. */
10204 if (gc_in_progress)
10205 terminate_due_to_signal (SIGSEGV, 40);
10206 #ifdef _WIN64
10207 /* See ms-w32.h: MinGW64's longjmp crashes if invoked in this context. */
10208 __builtin_longjmp (return_to_command_loop, 1);
10209 #else
10210 sys_longjmp (return_to_command_loop, 1);
10211 #endif
10212 }
10213
10214 /* This handler records the exception code and the address where it
10215 was triggered so that this info could be included in the backtrace.
10216 Without that, the backtrace in some cases has no information
10217 whatsoever about the offending code, and looks as if the top-level
10218 exception handler in the MinGW startup code was the one that
10219 crashed. We also recover from stack overflow, by calling our stack
10220 overflow handler that jumps back to top level. */
10221 static LONG CALLBACK
10222 my_exception_handler (EXCEPTION_POINTERS * exception_data)
10223 {
10224 except_code = exception_data->ExceptionRecord->ExceptionCode;
10225 except_addr = exception_data->ExceptionRecord->ExceptionAddress;
10226
10227 /* If this is a stack overflow exception, attempt to recover. */
10228 if (exception_data->ExceptionRecord->ExceptionCode == EXCEPTION_STACK_OVERFLOW
10229 && exception_data->ExceptionRecord->NumberParameters == 2
10230 /* We can only longjmp to top level from the main thread. */
10231 && GetCurrentThreadId () == dwMainThreadId)
10232 {
10233 /* Call stack_overflow_handler (). */
10234 #ifdef _WIN64
10235 exception_data->ContextRecord->Rip = (DWORD_PTR) &stack_overflow_handler;
10236 #else
10237 exception_data->ContextRecord->Eip = (DWORD_PTR) &stack_overflow_handler;
10238 #endif
10239 /* Zero this out, so the stale address of the stack overflow
10240 exception we handled is not displayed in some future
10241 unrelated crash. */
10242 except_addr = 0;
10243 return EXCEPTION_CONTINUE_EXECUTION;
10244 }
10245
10246 if (prev_exception_handler)
10247 return prev_exception_handler (exception_data);
10248 return EXCEPTION_EXECUTE_HANDLER;
10249 }
10250 #endif
10251
10252 typedef USHORT (WINAPI * CaptureStackBackTrace_proc) (ULONG, ULONG, PVOID *,
10253 PULONG);
10254
10255 #define BACKTRACE_LIMIT_MAX 62
10256
10257 int
10258 w32_backtrace (void **buffer, int limit)
10259 {
10260 static CaptureStackBackTrace_proc s_pfn_CaptureStackBackTrace = NULL;
10261 HMODULE hm_kernel32 = NULL;
10262
10263 if (!s_pfn_CaptureStackBackTrace)
10264 {
10265 hm_kernel32 = LoadLibrary ("Kernel32.dll");
10266 s_pfn_CaptureStackBackTrace =
10267 (CaptureStackBackTrace_proc) GetProcAddress (hm_kernel32,
10268 "RtlCaptureStackBackTrace");
10269 }
10270 if (s_pfn_CaptureStackBackTrace)
10271 return s_pfn_CaptureStackBackTrace (0, min (BACKTRACE_LIMIT_MAX, limit),
10272 buffer, NULL);
10273 return 0;
10274 }
10275
10276 void
10277 emacs_abort (void)
10278 {
10279 int button;
10280 button = MessageBox (NULL,
10281 "A fatal error has occurred!\n\n"
10282 "Would you like to attach a debugger?\n\n"
10283 "Select:\n"
10284 "YES -- to debug Emacs, or\n"
10285 "NO -- to abort Emacs and produce a backtrace\n"
10286 " (emacs_backtrace.txt in current directory)."
10287 #if __GNUC__
10288 "\n\n(type \"gdb -p <emacs-PID>\" and\n"
10289 "\"continue\" inside GDB before clicking YES.)"
10290 #endif
10291 , "Emacs Abort Dialog",
10292 MB_ICONEXCLAMATION | MB_TASKMODAL
10293 | MB_SETFOREGROUND | MB_YESNO);
10294 switch (button)
10295 {
10296 case IDYES:
10297 DebugBreak ();
10298 exit (2); /* tell the compiler we will never return */
10299 case IDNO:
10300 default:
10301 {
10302 void *stack[BACKTRACE_LIMIT_MAX + 1];
10303 int i = w32_backtrace (stack, BACKTRACE_LIMIT_MAX + 1);
10304
10305 if (i)
10306 {
10307 int errfile_fd = -1;
10308 int j;
10309 char buf[sizeof ("\r\nException at this address:\r\n\r\n")
10310 /* The type below should really be 'void *', but
10311 INT_BUFSIZE_BOUND cannot handle that without
10312 triggering compiler warnings (under certain
10313 pedantic warning switches), it wants an
10314 integer type. */
10315 + 2 * INT_BUFSIZE_BOUND (intptr_t)];
10316 #ifdef CYGWIN
10317 int stderr_fd = 2;
10318 #else
10319 HANDLE errout = GetStdHandle (STD_ERROR_HANDLE);
10320 int stderr_fd = -1;
10321
10322 if (errout && errout != INVALID_HANDLE_VALUE)
10323 stderr_fd = _open_osfhandle ((intptr_t)errout, O_APPEND | O_BINARY);
10324 #endif
10325
10326 /* We use %p, not 0x%p, as %p produces a leading "0x" on XP,
10327 but not on Windows 7. addr2line doesn't mind a missing
10328 "0x", but will be confused by an extra one. */
10329 if (except_addr)
10330 sprintf (buf, "\r\nException 0x%lx at this address:\r\n%p\r\n",
10331 except_code, except_addr);
10332 if (stderr_fd >= 0)
10333 {
10334 if (except_addr)
10335 write (stderr_fd, buf, strlen (buf));
10336 write (stderr_fd, "\r\nBacktrace:\r\n", 14);
10337 }
10338 #ifdef CYGWIN
10339 #define _open open
10340 #endif
10341 errfile_fd = _open ("emacs_backtrace.txt", O_RDWR | O_CREAT | O_BINARY, S_IREAD | S_IWRITE);
10342 if (errfile_fd >= 0)
10343 {
10344 lseek (errfile_fd, 0L, SEEK_END);
10345 if (except_addr)
10346 write (errfile_fd, buf, strlen (buf));
10347 write (errfile_fd, "\r\nBacktrace:\r\n", 14);
10348 }
10349
10350 for (j = 0; j < i; j++)
10351 {
10352 /* stack[] gives the return addresses, whereas we want
10353 the address of the call, so decrease each address
10354 by approximate size of 1 CALL instruction. */
10355 sprintf (buf, "%p\r\n", (char *)stack[j] - sizeof(void *));
10356 if (stderr_fd >= 0)
10357 write (stderr_fd, buf, strlen (buf));
10358 if (errfile_fd >= 0)
10359 write (errfile_fd, buf, strlen (buf));
10360 }
10361 if (i == BACKTRACE_LIMIT_MAX)
10362 {
10363 if (stderr_fd >= 0)
10364 write (stderr_fd, "...\r\n", 5);
10365 if (errfile_fd >= 0)
10366 write (errfile_fd, "...\r\n", 5);
10367 }
10368 if (errfile_fd >= 0)
10369 close (errfile_fd);
10370 }
10371 abort ();
10372 break;
10373 }
10374 }
10375 }
10376
10377 \f
10378
10379 /* Initialization. */
10380
10381 /*
10382 globals_of_w32fns is used to initialize those global variables that
10383 must always be initialized on startup even when the global variable
10384 initialized is non zero (see the function main in emacs.c).
10385 globals_of_w32fns is called from syms_of_w32fns when the global
10386 variable initialized is 0 and directly from main when initialized
10387 is non zero.
10388 */
10389 void
10390 globals_of_w32fns (void)
10391 {
10392 HMODULE user32_lib = GetModuleHandle ("user32.dll");
10393 /*
10394 TrackMouseEvent not available in all versions of Windows, so must load
10395 it dynamically. Do it once, here, instead of every time it is used.
10396 */
10397 track_mouse_event_fn = (TrackMouseEvent_Proc)
10398 GetProcAddress (user32_lib, "TrackMouseEvent");
10399
10400 monitor_from_point_fn = (MonitorFromPoint_Proc)
10401 GetProcAddress (user32_lib, "MonitorFromPoint");
10402 get_monitor_info_fn = (GetMonitorInfo_Proc)
10403 GetProcAddress (user32_lib, "GetMonitorInfoA");
10404 monitor_from_window_fn = (MonitorFromWindow_Proc)
10405 GetProcAddress (user32_lib, "MonitorFromWindow");
10406 enum_display_monitors_fn = (EnumDisplayMonitors_Proc)
10407 GetProcAddress (user32_lib, "EnumDisplayMonitors");
10408 get_title_bar_info_fn = (GetTitleBarInfo_Proc)
10409 GetProcAddress (user32_lib, "GetTitleBarInfo");
10410
10411 {
10412 HMODULE imm32_lib = GetModuleHandle ("imm32.dll");
10413 get_composition_string_fn = (ImmGetCompositionString_Proc)
10414 GetProcAddress (imm32_lib, "ImmGetCompositionStringW");
10415 get_ime_context_fn = (ImmGetContext_Proc)
10416 GetProcAddress (imm32_lib, "ImmGetContext");
10417 release_ime_context_fn = (ImmReleaseContext_Proc)
10418 GetProcAddress (imm32_lib, "ImmReleaseContext");
10419 set_ime_composition_window_fn = (ImmSetCompositionWindow_Proc)
10420 GetProcAddress (imm32_lib, "ImmSetCompositionWindow");
10421 }
10422
10423 except_code = 0;
10424 except_addr = 0;
10425 #ifndef CYGWIN
10426 prev_exception_handler = SetUnhandledExceptionFilter (my_exception_handler);
10427 resetstkoflw = NULL;
10428 #endif
10429
10430 DEFVAR_INT ("w32-ansi-code-page",
10431 w32_ansi_code_page,
10432 doc: /* The ANSI code page used by the system. */);
10433 w32_ansi_code_page = GetACP ();
10434
10435 if (os_subtype == OS_NT)
10436 w32_unicode_gui = 1;
10437 else
10438 w32_unicode_gui = 0;
10439
10440 after_deadkey = -1;
10441
10442 /* MessageBox does not work without this when linked to comctl32.dll 6.0. */
10443 InitCommonControls ();
10444
10445 syms_of_w32uniscribe ();
10446 }
10447
10448 #ifdef NTGUI_UNICODE
10449
10450 Lisp_Object
10451 ntgui_encode_system (Lisp_Object str)
10452 {
10453 Lisp_Object encoded;
10454 to_unicode (str, &encoded);
10455 return encoded;
10456 }
10457
10458 #endif /* NTGUI_UNICODE */