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