Fix some doc-strings in window.c (Bug#18112) (Bug#18194).
[emacs.git] / src / w32fns.c
blob1c73cda469a318febc936c6ad07c12fe77d972a7
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 (FRAME_INTERNAL_BORDER_WIDTH (f) != 0 && FRAME_VISIBLE_P (f))
1718 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1719 int width = FRAME_PIXEL_WIDTH (f);
1720 int y = nlines * unit;
1721 HDC hdc = get_frame_dc (f);
1723 block_input ();
1724 w32_clear_area (f, hdc, 0, y, width, height);
1725 release_frame_dc (f, hdc);
1726 unblock_input ();
1729 if (delta < 0 && WINDOWP (f->tool_bar_window))
1730 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1732 run_window_configuration_change_hook (f);
1736 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1737 w32_id_name.
1739 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1740 name; if NAME is a string, set F's name to NAME and set
1741 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1743 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1744 suggesting a new name, which lisp code should override; if
1745 F->explicit_name is set, ignore the new name; otherwise, set it. */
1747 void
1748 x_set_name (struct frame *f, Lisp_Object name, int explicit)
1750 /* Make sure that requests from lisp code override requests from
1751 Emacs redisplay code. */
1752 if (explicit)
1754 /* If we're switching from explicit to implicit, we had better
1755 update the mode lines and thereby update the title. */
1756 if (f->explicit_name && NILP (name))
1757 update_mode_lines = 25;
1759 f->explicit_name = ! NILP (name);
1761 else if (f->explicit_name)
1762 return;
1764 /* If NAME is nil, set the name to the w32_id_name. */
1765 if (NILP (name))
1767 /* Check for no change needed in this very common case
1768 before we do any consing. */
1769 if (!strcmp (FRAME_DISPLAY_INFO (f)->w32_id_name,
1770 SDATA (f->name)))
1771 return;
1772 name = build_string (FRAME_DISPLAY_INFO (f)->w32_id_name);
1774 else
1775 CHECK_STRING (name);
1777 /* Don't change the name if it's already NAME. */
1778 if (! NILP (Fstring_equal (name, f->name)))
1779 return;
1781 fset_name (f, name);
1783 /* For setting the frame title, the title parameter should override
1784 the name parameter. */
1785 if (! NILP (f->title))
1786 name = f->title;
1788 if (FRAME_W32_WINDOW (f))
1790 block_input ();
1791 GUI_FN (SetWindowText) (FRAME_W32_WINDOW (f),
1792 GUI_SDATA (GUI_ENCODE_SYSTEM (name)));
1793 unblock_input ();
1797 /* This function should be called when the user's lisp code has
1798 specified a name for the frame; the name will override any set by the
1799 redisplay code. */
1800 void
1801 x_explicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1803 x_set_name (f, arg, 1);
1806 /* This function should be called by Emacs redisplay code to set the
1807 name; names set this way will never override names set by the user's
1808 lisp code. */
1809 void
1810 x_implicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1812 x_set_name (f, arg, 0);
1815 /* Change the title of frame F to NAME.
1816 If NAME is nil, use the frame name as the title. */
1818 void
1819 x_set_title (struct frame *f, Lisp_Object name, Lisp_Object old_name)
1821 /* Don't change the title if it's already NAME. */
1822 if (EQ (name, f->title))
1823 return;
1825 update_mode_lines = 26;
1827 fset_title (f, name);
1829 if (NILP (name))
1830 name = f->name;
1832 if (FRAME_W32_WINDOW (f))
1834 block_input ();
1835 GUI_FN (SetWindowText) (FRAME_W32_WINDOW (f),
1836 GUI_SDATA (GUI_ENCODE_SYSTEM (name)));
1837 unblock_input ();
1841 void
1842 x_set_scroll_bar_default_width (struct frame *f)
1844 int unit = FRAME_COLUMN_WIDTH (f);
1846 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = GetSystemMetrics (SM_CXVSCROLL);
1847 FRAME_CONFIG_SCROLL_BAR_COLS (f)
1848 = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) + unit - 1) / unit;
1852 /* Subroutines for creating a frame. */
1854 Cursor
1855 w32_load_cursor (LPCTSTR name)
1857 /* Try first to load cursor from application resource. */
1858 Cursor cursor = LoadImage ((HINSTANCE) GetModuleHandle (NULL),
1859 name, IMAGE_CURSOR, 0, 0,
1860 LR_DEFAULTCOLOR | LR_DEFAULTSIZE | LR_SHARED);
1861 if (!cursor)
1863 /* Then try to load a shared predefined cursor. */
1864 cursor = LoadImage (NULL, name, IMAGE_CURSOR, 0, 0,
1865 LR_DEFAULTCOLOR | LR_DEFAULTSIZE | LR_SHARED);
1867 return cursor;
1870 static LRESULT CALLBACK w32_wnd_proc (HWND, UINT, WPARAM, LPARAM);
1872 #define INIT_WINDOW_CLASS(WC) \
1873 (WC).style = CS_HREDRAW | CS_VREDRAW; \
1874 (WC).lpfnWndProc = (WNDPROC) w32_wnd_proc; \
1875 (WC).cbClsExtra = 0; \
1876 (WC).cbWndExtra = WND_EXTRA_BYTES; \
1877 (WC).hInstance = hinst; \
1878 (WC).hIcon = LoadIcon (hinst, EMACS_CLASS); \
1879 (WC).hCursor = w32_load_cursor (IDC_ARROW); \
1880 (WC).hbrBackground = NULL; \
1881 (WC).lpszMenuName = NULL; \
1883 static BOOL
1884 w32_init_class (HINSTANCE hinst)
1886 if (w32_unicode_gui)
1888 WNDCLASSW uwc;
1889 INIT_WINDOW_CLASS(uwc);
1890 uwc.lpszClassName = L"Emacs";
1892 return RegisterClassW (&uwc);
1894 else
1896 WNDCLASS wc;
1897 INIT_WINDOW_CLASS(wc);
1898 wc.lpszClassName = EMACS_CLASS;
1900 return RegisterClassA (&wc);
1904 static HWND
1905 w32_createscrollbar (struct frame *f, struct scroll_bar * bar)
1907 return CreateWindow ("SCROLLBAR", "", SBS_VERT | WS_CHILD | WS_VISIBLE,
1908 /* Position and size of scroll bar. */
1909 bar->left, bar->top, bar->width, bar->height,
1910 FRAME_W32_WINDOW (f), NULL, hinst, NULL);
1913 static void
1914 w32_createwindow (struct frame *f)
1916 HWND hwnd;
1917 RECT rect;
1918 Lisp_Object top = Qunbound;
1919 Lisp_Object left = Qunbound;
1920 struct w32_display_info *dpyinfo = &one_w32_display_info;
1922 rect.left = rect.top = 0;
1923 rect.right = FRAME_PIXEL_WIDTH (f);
1924 rect.bottom = FRAME_PIXEL_HEIGHT (f);
1926 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
1927 FRAME_EXTERNAL_MENU_BAR (f));
1929 /* Do first time app init */
1931 w32_init_class (hinst);
1933 if (f->size_hint_flags & USPosition || f->size_hint_flags & PPosition)
1935 XSETINT (left, f->left_pos);
1936 XSETINT (top, f->top_pos);
1938 else if (EQ (left, Qunbound) && EQ (top, Qunbound))
1940 /* When called with RES_TYPE_NUMBER, w32_get_arg will return zero
1941 for anything that is not a number and is not Qunbound. */
1942 left = x_get_arg (dpyinfo, Qnil, Qleft, "left", "Left", RES_TYPE_NUMBER);
1943 top = x_get_arg (dpyinfo, Qnil, Qtop, "top", "Top", RES_TYPE_NUMBER);
1946 FRAME_W32_WINDOW (f) = hwnd
1947 = CreateWindow (EMACS_CLASS,
1948 f->namebuf,
1949 f->output_data.w32->dwStyle | WS_CLIPCHILDREN,
1950 EQ (left, Qunbound) ? CW_USEDEFAULT : XINT (left),
1951 EQ (top, Qunbound) ? CW_USEDEFAULT : XINT (top),
1952 rect.right - rect.left,
1953 rect.bottom - rect.top,
1954 NULL,
1955 NULL,
1956 hinst,
1957 NULL);
1959 if (hwnd)
1961 SetWindowLong (hwnd, WND_FONTWIDTH_INDEX, FRAME_COLUMN_WIDTH (f));
1962 SetWindowLong (hwnd, WND_LINEHEIGHT_INDEX, FRAME_LINE_HEIGHT (f));
1963 SetWindowLong (hwnd, WND_BORDER_INDEX, FRAME_INTERNAL_BORDER_WIDTH (f));
1964 SetWindowLong (hwnd, WND_SCROLLBAR_INDEX, FRAME_SCROLL_BAR_AREA_WIDTH (f));
1965 SetWindowLong (hwnd, WND_BACKGROUND_INDEX, FRAME_BACKGROUND_PIXEL (f));
1967 /* Enable drag-n-drop. */
1968 DragAcceptFiles (hwnd, TRUE);
1970 /* Do this to discard the default setting specified by our parent. */
1971 ShowWindow (hwnd, SW_HIDE);
1973 /* Update frame positions. */
1974 GetWindowRect (hwnd, &rect);
1975 f->left_pos = rect.left;
1976 f->top_pos = rect.top;
1980 static void
1981 my_post_msg (W32Msg * wmsg, HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
1983 wmsg->msg.hwnd = hwnd;
1984 wmsg->msg.message = msg;
1985 wmsg->msg.wParam = wParam;
1986 wmsg->msg.lParam = lParam;
1987 wmsg->msg.time = GetMessageTime ();
1989 post_msg (wmsg);
1992 /* GetKeyState and MapVirtualKey on Windows 95 do not actually distinguish
1993 between left and right keys as advertised. We test for this
1994 support dynamically, and set a flag when the support is absent. If
1995 absent, we keep track of the left and right control and alt keys
1996 ourselves. This is particularly necessary on keyboards that rely
1997 upon the AltGr key, which is represented as having the left control
1998 and right alt keys pressed. For these keyboards, we need to know
1999 when the left alt key has been pressed in addition to the AltGr key
2000 so that we can properly support M-AltGr-key sequences (such as M-@
2001 on Swedish keyboards). */
2003 #define EMACS_LCONTROL 0
2004 #define EMACS_RCONTROL 1
2005 #define EMACS_LMENU 2
2006 #define EMACS_RMENU 3
2008 static int modifiers[4];
2009 static int modifiers_recorded;
2010 static int modifier_key_support_tested;
2012 static void
2013 test_modifier_support (unsigned int wparam)
2015 unsigned int l, r;
2017 if (wparam != VK_CONTROL && wparam != VK_MENU)
2018 return;
2019 if (wparam == VK_CONTROL)
2021 l = VK_LCONTROL;
2022 r = VK_RCONTROL;
2024 else
2026 l = VK_LMENU;
2027 r = VK_RMENU;
2029 if (!(GetKeyState (l) & 0x8000) && !(GetKeyState (r) & 0x8000))
2030 modifiers_recorded = 1;
2031 else
2032 modifiers_recorded = 0;
2033 modifier_key_support_tested = 1;
2036 static void
2037 record_keydown (unsigned int wparam, unsigned int lparam)
2039 int i;
2041 if (!modifier_key_support_tested)
2042 test_modifier_support (wparam);
2044 if ((wparam != VK_CONTROL && wparam != VK_MENU) || !modifiers_recorded)
2045 return;
2047 if (wparam == VK_CONTROL)
2048 i = (lparam & 0x1000000) ? EMACS_RCONTROL : EMACS_LCONTROL;
2049 else
2050 i = (lparam & 0x1000000) ? EMACS_RMENU : EMACS_LMENU;
2052 modifiers[i] = 1;
2055 static void
2056 record_keyup (unsigned int wparam, unsigned int lparam)
2058 int i;
2060 if ((wparam != VK_CONTROL && wparam != VK_MENU) || !modifiers_recorded)
2061 return;
2063 if (wparam == VK_CONTROL)
2064 i = (lparam & 0x1000000) ? EMACS_RCONTROL : EMACS_LCONTROL;
2065 else
2066 i = (lparam & 0x1000000) ? EMACS_RMENU : EMACS_LMENU;
2068 modifiers[i] = 0;
2071 /* Emacs can lose focus while a modifier key has been pressed. When
2072 it regains focus, be conservative and clear all modifiers since
2073 we cannot reconstruct the left and right modifier state. */
2074 static void
2075 reset_modifiers (void)
2077 SHORT ctrl, alt;
2079 if (GetFocus () == NULL)
2080 /* Emacs doesn't have keyboard focus. Do nothing. */
2081 return;
2083 ctrl = GetAsyncKeyState (VK_CONTROL);
2084 alt = GetAsyncKeyState (VK_MENU);
2086 if (!(ctrl & 0x08000))
2087 /* Clear any recorded control modifier state. */
2088 modifiers[EMACS_RCONTROL] = modifiers[EMACS_LCONTROL] = 0;
2090 if (!(alt & 0x08000))
2091 /* Clear any recorded alt modifier state. */
2092 modifiers[EMACS_RMENU] = modifiers[EMACS_LMENU] = 0;
2094 /* Update the state of all modifier keys, because modifiers used in
2095 hot-key combinations can get stuck on if Emacs loses focus as a
2096 result of a hot-key being pressed. */
2098 BYTE keystate[256];
2100 #define CURRENT_STATE(key) ((GetAsyncKeyState (key) & 0x8000) >> 8)
2102 memset (keystate, 0, sizeof (keystate));
2103 GetKeyboardState (keystate);
2104 keystate[VK_SHIFT] = CURRENT_STATE (VK_SHIFT);
2105 keystate[VK_CONTROL] = CURRENT_STATE (VK_CONTROL);
2106 keystate[VK_LCONTROL] = CURRENT_STATE (VK_LCONTROL);
2107 keystate[VK_RCONTROL] = CURRENT_STATE (VK_RCONTROL);
2108 keystate[VK_MENU] = CURRENT_STATE (VK_MENU);
2109 keystate[VK_LMENU] = CURRENT_STATE (VK_LMENU);
2110 keystate[VK_RMENU] = CURRENT_STATE (VK_RMENU);
2111 keystate[VK_LWIN] = CURRENT_STATE (VK_LWIN);
2112 keystate[VK_RWIN] = CURRENT_STATE (VK_RWIN);
2113 keystate[VK_APPS] = CURRENT_STATE (VK_APPS);
2114 SetKeyboardState (keystate);
2118 /* Synchronize modifier state with what is reported with the current
2119 keystroke. Even if we cannot distinguish between left and right
2120 modifier keys, we know that, if no modifiers are set, then neither
2121 the left or right modifier should be set. */
2122 static void
2123 sync_modifiers (void)
2125 if (!modifiers_recorded)
2126 return;
2128 if (!(GetKeyState (VK_CONTROL) & 0x8000))
2129 modifiers[EMACS_RCONTROL] = modifiers[EMACS_LCONTROL] = 0;
2131 if (!(GetKeyState (VK_MENU) & 0x8000))
2132 modifiers[EMACS_RMENU] = modifiers[EMACS_LMENU] = 0;
2135 static int
2136 modifier_set (int vkey)
2138 /* Warning: The fact that VK_NUMLOCK is not treated as the other 2
2139 toggle keys is not an omission! If you want to add it, you will
2140 have to make changes in the default sub-case of the WM_KEYDOWN
2141 switch, because if the NUMLOCK modifier is set, the code there
2142 will directly convert any key that looks like an ASCII letter,
2143 and also downcase those that look like upper-case ASCII. */
2144 if (vkey == VK_CAPITAL)
2146 if (NILP (Vw32_enable_caps_lock))
2147 return 0;
2148 else
2149 return (GetKeyState (vkey) & 0x1);
2151 if (vkey == VK_SCROLL)
2153 if (NILP (Vw32_scroll_lock_modifier)
2154 /* w32-scroll-lock-modifier can be any non-nil value that is
2155 not one of the modifiers, in which case it shall be ignored. */
2156 || !( EQ (Vw32_scroll_lock_modifier, Qhyper)
2157 || EQ (Vw32_scroll_lock_modifier, Qsuper)
2158 || EQ (Vw32_scroll_lock_modifier, Qmeta)
2159 || EQ (Vw32_scroll_lock_modifier, Qalt)
2160 || EQ (Vw32_scroll_lock_modifier, Qcontrol)
2161 || EQ (Vw32_scroll_lock_modifier, Qshift)))
2162 return 0;
2163 else
2164 return (GetKeyState (vkey) & 0x1);
2167 if (!modifiers_recorded)
2168 return (GetKeyState (vkey) & 0x8000);
2170 switch (vkey)
2172 case VK_LCONTROL:
2173 return modifiers[EMACS_LCONTROL];
2174 case VK_RCONTROL:
2175 return modifiers[EMACS_RCONTROL];
2176 case VK_LMENU:
2177 return modifiers[EMACS_LMENU];
2178 case VK_RMENU:
2179 return modifiers[EMACS_RMENU];
2181 return (GetKeyState (vkey) & 0x8000);
2184 /* Convert between the modifier bits W32 uses and the modifier bits
2185 Emacs uses. */
2187 unsigned int
2188 w32_key_to_modifier (int key)
2190 Lisp_Object key_mapping;
2192 switch (key)
2194 case VK_LWIN:
2195 key_mapping = Vw32_lwindow_modifier;
2196 break;
2197 case VK_RWIN:
2198 key_mapping = Vw32_rwindow_modifier;
2199 break;
2200 case VK_APPS:
2201 key_mapping = Vw32_apps_modifier;
2202 break;
2203 case VK_SCROLL:
2204 key_mapping = Vw32_scroll_lock_modifier;
2205 break;
2206 default:
2207 key_mapping = Qnil;
2210 /* NB. This code runs in the input thread, asynchronously to the lisp
2211 thread, so we must be careful to ensure access to lisp data is
2212 thread-safe. The following code is safe because the modifier
2213 variable values are updated atomically from lisp and symbols are
2214 not relocated by GC. Also, we don't have to worry about seeing GC
2215 markbits here. */
2216 if (EQ (key_mapping, Qhyper))
2217 return hyper_modifier;
2218 if (EQ (key_mapping, Qsuper))
2219 return super_modifier;
2220 if (EQ (key_mapping, Qmeta))
2221 return meta_modifier;
2222 if (EQ (key_mapping, Qalt))
2223 return alt_modifier;
2224 if (EQ (key_mapping, Qctrl))
2225 return ctrl_modifier;
2226 if (EQ (key_mapping, Qcontrol)) /* synonym for ctrl */
2227 return ctrl_modifier;
2228 if (EQ (key_mapping, Qshift))
2229 return shift_modifier;
2231 /* Don't generate any modifier if not explicitly requested. */
2232 return 0;
2235 static unsigned int
2236 w32_get_modifiers (void)
2238 return ((modifier_set (VK_SHIFT) ? shift_modifier : 0) |
2239 (modifier_set (VK_CONTROL) ? ctrl_modifier : 0) |
2240 (modifier_set (VK_LWIN) ? w32_key_to_modifier (VK_LWIN) : 0) |
2241 (modifier_set (VK_RWIN) ? w32_key_to_modifier (VK_RWIN) : 0) |
2242 (modifier_set (VK_APPS) ? w32_key_to_modifier (VK_APPS) : 0) |
2243 (modifier_set (VK_SCROLL) ? w32_key_to_modifier (VK_SCROLL) : 0) |
2244 (modifier_set (VK_MENU) ?
2245 ((NILP (Vw32_alt_is_meta)) ? alt_modifier : meta_modifier) : 0));
2248 /* We map the VK_* modifiers into console modifier constants
2249 so that we can use the same routines to handle both console
2250 and window input. */
2252 static int
2253 construct_console_modifiers (void)
2255 int mods;
2257 mods = 0;
2258 mods |= (modifier_set (VK_SHIFT)) ? SHIFT_PRESSED : 0;
2259 mods |= (modifier_set (VK_CAPITAL)) ? CAPSLOCK_ON : 0;
2260 mods |= (modifier_set (VK_SCROLL)) ? SCROLLLOCK_ON : 0;
2261 mods |= (modifier_set (VK_NUMLOCK)) ? NUMLOCK_ON : 0;
2262 mods |= (modifier_set (VK_LCONTROL)) ? LEFT_CTRL_PRESSED : 0;
2263 mods |= (modifier_set (VK_RCONTROL)) ? RIGHT_CTRL_PRESSED : 0;
2264 mods |= (modifier_set (VK_LMENU)) ? LEFT_ALT_PRESSED : 0;
2265 mods |= (modifier_set (VK_RMENU)) ? RIGHT_ALT_PRESSED : 0;
2266 mods |= (modifier_set (VK_LWIN)) ? LEFT_WIN_PRESSED : 0;
2267 mods |= (modifier_set (VK_RWIN)) ? RIGHT_WIN_PRESSED : 0;
2268 mods |= (modifier_set (VK_APPS)) ? APPS_PRESSED : 0;
2270 return mods;
2273 static int
2274 w32_get_key_modifiers (unsigned int wparam, unsigned int lparam)
2276 int mods;
2278 /* Convert to emacs modifiers. */
2279 mods = w32_kbd_mods_to_emacs (construct_console_modifiers (), wparam);
2281 return mods;
2284 unsigned int
2285 map_keypad_keys (unsigned int virt_key, unsigned int extended)
2287 if (virt_key < VK_CLEAR || virt_key > VK_DELETE)
2288 return virt_key;
2290 if (virt_key == VK_RETURN)
2291 return (extended ? VK_NUMPAD_ENTER : VK_RETURN);
2293 if (virt_key >= VK_PRIOR && virt_key <= VK_DOWN)
2294 return (!extended ? (VK_NUMPAD_PRIOR + (virt_key - VK_PRIOR)) : virt_key);
2296 if (virt_key == VK_INSERT || virt_key == VK_DELETE)
2297 return (!extended ? (VK_NUMPAD_INSERT + (virt_key - VK_INSERT)) : virt_key);
2299 if (virt_key == VK_CLEAR)
2300 return (!extended ? VK_NUMPAD_CLEAR : virt_key);
2302 return virt_key;
2305 /* List of special key combinations which w32 would normally capture,
2306 but Emacs should grab instead. Not directly visible to lisp, to
2307 simplify synchronization. Each item is an integer encoding a virtual
2308 key code and modifier combination to capture. */
2309 static Lisp_Object w32_grabbed_keys;
2311 #define HOTKEY(vk, mods) make_number (((vk) & 255) | ((mods) << 8))
2312 #define HOTKEY_ID(k) (XFASTINT (k) & 0xbfff)
2313 #define HOTKEY_VK_CODE(k) (XFASTINT (k) & 255)
2314 #define HOTKEY_MODIFIERS(k) (XFASTINT (k) >> 8)
2316 #define RAW_HOTKEY_ID(k) ((k) & 0xbfff)
2317 #define RAW_HOTKEY_VK_CODE(k) ((k) & 255)
2318 #define RAW_HOTKEY_MODIFIERS(k) ((k) >> 8)
2320 /* Register hot-keys for reserved key combinations when Emacs has
2321 keyboard focus, since this is the only way Emacs can receive key
2322 combinations like Alt-Tab which are used by the system. */
2324 static void
2325 register_hot_keys (HWND hwnd)
2327 Lisp_Object keylist;
2329 /* Use CONSP, since we are called asynchronously. */
2330 for (keylist = w32_grabbed_keys; CONSP (keylist); keylist = XCDR (keylist))
2332 Lisp_Object key = XCAR (keylist);
2334 /* Deleted entries get set to nil. */
2335 if (!INTEGERP (key))
2336 continue;
2338 RegisterHotKey (hwnd, HOTKEY_ID (key),
2339 HOTKEY_MODIFIERS (key), HOTKEY_VK_CODE (key));
2343 static void
2344 unregister_hot_keys (HWND hwnd)
2346 Lisp_Object keylist;
2348 for (keylist = w32_grabbed_keys; CONSP (keylist); keylist = XCDR (keylist))
2350 Lisp_Object key = XCAR (keylist);
2352 if (!INTEGERP (key))
2353 continue;
2355 UnregisterHotKey (hwnd, HOTKEY_ID (key));
2359 #if EMACSDEBUG
2360 const char*
2361 w32_name_of_message (UINT msg)
2363 unsigned i;
2364 static char buf[64];
2365 static const struct {
2366 UINT msg;
2367 const char* name;
2368 } msgnames[] = {
2369 #define M(msg) { msg, # msg }
2370 M (WM_PAINT),
2371 M (WM_TIMER),
2372 M (WM_USER),
2373 M (WM_MOUSEMOVE),
2374 M (WM_LBUTTONUP),
2375 M (WM_KEYDOWN),
2376 M (WM_EMACS_KILL),
2377 M (WM_EMACS_CREATEWINDOW),
2378 M (WM_EMACS_DONE),
2379 M (WM_EMACS_CREATESCROLLBAR),
2380 M (WM_EMACS_SHOWWINDOW),
2381 M (WM_EMACS_SETWINDOWPOS),
2382 M (WM_EMACS_DESTROYWINDOW),
2383 M (WM_EMACS_TRACKPOPUPMENU),
2384 M (WM_EMACS_SETFOCUS),
2385 M (WM_EMACS_SETFOREGROUND),
2386 M (WM_EMACS_SETLOCALE),
2387 M (WM_EMACS_SETKEYBOARDLAYOUT),
2388 M (WM_EMACS_REGISTER_HOT_KEY),
2389 M (WM_EMACS_UNREGISTER_HOT_KEY),
2390 M (WM_EMACS_TOGGLE_LOCK_KEY),
2391 M (WM_EMACS_TRACK_CARET),
2392 M (WM_EMACS_DESTROY_CARET),
2393 M (WM_EMACS_SHOW_CARET),
2394 M (WM_EMACS_HIDE_CARET),
2395 M (WM_EMACS_SETCURSOR),
2396 M (WM_EMACS_PAINT),
2397 M (WM_CHAR),
2398 #undef M
2399 { 0, 0 }
2402 for (i = 0; msgnames[i].name; ++i)
2403 if (msgnames[i].msg == msg)
2404 return msgnames[i].name;
2406 sprintf (buf, "message 0x%04x", (unsigned)msg);
2407 return buf;
2409 #endif /* EMACSDEBUG */
2411 /* Here's an overview of how Emacs input works in GUI sessions on
2412 MS-Windows. (For description of non-GUI input, see the commentary
2413 before w32_console_read_socket in w32inevt.c.)
2415 System messages are read and processed by w32_msg_pump below. This
2416 function runs in a separate thread. It handles a small number of
2417 custom WM_EMACS_* messages (posted by the main thread, look for
2418 PostMessage calls), and dispatches the rest to w32_wnd_proc, which
2419 is the main window procedure for the entire Emacs application.
2421 w32_wnd_proc also runs in the same separate input thread. It
2422 handles some messages, mostly those that need GDI calls, by itself.
2423 For the others, it calls my_post_msg, which inserts the messages
2424 into the input queue serviced by w32_read_socket.
2426 w32_read_socket runs in the main (a.k.a. "Lisp") thread, and is
2427 called synchronously from keyboard.c when it is known or suspected
2428 that some input is available. w32_read_socket either handles
2429 messages immediately, or converts them into Emacs input events and
2430 stuffs them into kbd_buffer, where kbd_buffer_get_event can get at
2431 them and process them when read_char and its callers require
2432 input.
2434 Under Cygwin with the W32 toolkit, the use of /dev/windows with
2435 select(2) takes the place of w32_read_socket.
2439 /* Main message dispatch loop. */
2441 static void
2442 w32_msg_pump (deferred_msg * msg_buf)
2444 MSG msg;
2445 WPARAM result;
2446 HWND focus_window;
2448 msh_mousewheel = RegisterWindowMessage (MSH_MOUSEWHEEL);
2450 while ((w32_unicode_gui ? GetMessageW : GetMessageA) (&msg, NULL, 0, 0))
2453 /* DebPrint (("w32_msg_pump: %s time:%u\n", */
2454 /* w32_name_of_message (msg.message), msg.time)); */
2456 if (msg.hwnd == NULL)
2458 switch (msg.message)
2460 case WM_NULL:
2461 /* Produced by complete_deferred_msg; just ignore. */
2462 break;
2463 case WM_EMACS_CREATEWINDOW:
2464 /* Initialize COM for this window. Even though we don't use it,
2465 some third party shell extensions can cause it to be used in
2466 system dialogs, which causes a crash if it is not initialized.
2467 This is a known bug in Windows, which was fixed long ago, but
2468 the patch for XP is not publicly available until XP SP3,
2469 and older versions will never be patched. */
2470 CoInitialize (NULL);
2471 w32_createwindow ((struct frame *) msg.wParam);
2472 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
2473 emacs_abort ();
2474 break;
2475 case WM_EMACS_SETLOCALE:
2476 SetThreadLocale (msg.wParam);
2477 /* Reply is not expected. */
2478 break;
2479 case WM_EMACS_SETKEYBOARDLAYOUT:
2480 result = (WPARAM) ActivateKeyboardLayout ((HKL) msg.wParam, 0);
2481 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE,
2482 result, 0))
2483 emacs_abort ();
2484 break;
2485 case WM_EMACS_REGISTER_HOT_KEY:
2486 focus_window = GetFocus ();
2487 if (focus_window != NULL)
2488 RegisterHotKey (focus_window,
2489 RAW_HOTKEY_ID (msg.wParam),
2490 RAW_HOTKEY_MODIFIERS (msg.wParam),
2491 RAW_HOTKEY_VK_CODE (msg.wParam));
2492 /* Reply is not expected. */
2493 break;
2494 case WM_EMACS_UNREGISTER_HOT_KEY:
2495 focus_window = GetFocus ();
2496 if (focus_window != NULL)
2497 UnregisterHotKey (focus_window, RAW_HOTKEY_ID (msg.wParam));
2498 /* Mark item as erased. NB: this code must be
2499 thread-safe. The next line is okay because the cons
2500 cell is never made into garbage and is not relocated by
2501 GC. */
2502 XSETCAR (XIL ((EMACS_INT) msg.lParam), Qnil);
2503 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
2504 emacs_abort ();
2505 break;
2506 case WM_EMACS_TOGGLE_LOCK_KEY:
2508 int vk_code = (int) msg.wParam;
2509 int cur_state = (GetKeyState (vk_code) & 1);
2510 Lisp_Object new_state = XIL ((EMACS_INT) msg.lParam);
2512 /* NB: This code must be thread-safe. It is safe to
2513 call NILP because symbols are not relocated by GC,
2514 and pointer here is not touched by GC (so the markbit
2515 can't be set). Numbers are safe because they are
2516 immediate values. */
2517 if (NILP (new_state)
2518 || (NUMBERP (new_state)
2519 && ((XUINT (new_state)) & 1) != cur_state))
2521 one_w32_display_info.faked_key = vk_code;
2523 keybd_event ((BYTE) vk_code,
2524 (BYTE) MapVirtualKey (vk_code, 0),
2525 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
2526 keybd_event ((BYTE) vk_code,
2527 (BYTE) MapVirtualKey (vk_code, 0),
2528 KEYEVENTF_EXTENDEDKEY | 0, 0);
2529 keybd_event ((BYTE) vk_code,
2530 (BYTE) MapVirtualKey (vk_code, 0),
2531 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
2532 cur_state = !cur_state;
2534 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE,
2535 cur_state, 0))
2536 emacs_abort ();
2538 break;
2539 #ifdef MSG_DEBUG
2540 /* Broadcast messages make it here, so you need to be looking
2541 for something in particular for this to be useful. */
2542 default:
2543 DebPrint (("msg %x not expected by w32_msg_pump\n", msg.message));
2544 #endif
2547 else
2549 if (w32_unicode_gui)
2550 DispatchMessageW (&msg);
2551 else
2552 DispatchMessageA (&msg);
2555 /* Exit nested loop when our deferred message has completed. */
2556 if (msg_buf->completed)
2557 break;
2561 deferred_msg * deferred_msg_head;
2563 static deferred_msg *
2564 find_deferred_msg (HWND hwnd, UINT msg)
2566 deferred_msg * item;
2568 /* Don't actually need synchronization for read access, since
2569 modification of single pointer is always atomic. */
2570 /* enter_crit (); */
2572 for (item = deferred_msg_head; item != NULL; item = item->next)
2573 if (item->w32msg.msg.hwnd == hwnd
2574 && item->w32msg.msg.message == msg)
2575 break;
2577 /* leave_crit (); */
2579 return item;
2582 static LRESULT
2583 send_deferred_msg (deferred_msg * msg_buf,
2584 HWND hwnd,
2585 UINT msg,
2586 WPARAM wParam,
2587 LPARAM lParam)
2589 /* Only input thread can send deferred messages. */
2590 if (GetCurrentThreadId () != dwWindowsThreadId)
2591 emacs_abort ();
2593 /* It is an error to send a message that is already deferred. */
2594 if (find_deferred_msg (hwnd, msg) != NULL)
2595 emacs_abort ();
2597 /* Enforced synchronization is not needed because this is the only
2598 function that alters deferred_msg_head, and the following critical
2599 section is guaranteed to only be serially reentered (since only the
2600 input thread can call us). */
2602 /* enter_crit (); */
2604 msg_buf->completed = 0;
2605 msg_buf->next = deferred_msg_head;
2606 deferred_msg_head = msg_buf;
2607 my_post_msg (&msg_buf->w32msg, hwnd, msg, wParam, lParam);
2609 /* leave_crit (); */
2611 /* Start a new nested message loop to process other messages until
2612 this one is completed. */
2613 w32_msg_pump (msg_buf);
2615 deferred_msg_head = msg_buf->next;
2617 return msg_buf->result;
2620 void
2621 complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result)
2623 deferred_msg * msg_buf = find_deferred_msg (hwnd, msg);
2625 if (msg_buf == NULL)
2626 /* Message may have been canceled, so don't abort. */
2627 return;
2629 msg_buf->result = result;
2630 msg_buf->completed = 1;
2632 /* Ensure input thread is woken so it notices the completion. */
2633 PostThreadMessage (dwWindowsThreadId, WM_NULL, 0, 0);
2636 static void
2637 cancel_all_deferred_msgs (void)
2639 deferred_msg * item;
2641 /* Don't actually need synchronization for read access, since
2642 modification of single pointer is always atomic. */
2643 /* enter_crit (); */
2645 for (item = deferred_msg_head; item != NULL; item = item->next)
2647 item->result = 0;
2648 item->completed = 1;
2651 /* leave_crit (); */
2653 /* Ensure input thread is woken so it notices the completion. */
2654 PostThreadMessage (dwWindowsThreadId, WM_NULL, 0, 0);
2657 DWORD WINAPI
2658 w32_msg_worker (void *arg)
2660 MSG msg;
2661 deferred_msg dummy_buf;
2663 /* Ensure our message queue is created */
2665 PeekMessage (&msg, NULL, 0, 0, PM_NOREMOVE);
2667 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
2668 emacs_abort ();
2670 memset (&dummy_buf, 0, sizeof (dummy_buf));
2671 dummy_buf.w32msg.msg.hwnd = NULL;
2672 dummy_buf.w32msg.msg.message = WM_NULL;
2674 /* This is the initial message loop which should only exit when the
2675 application quits. */
2676 w32_msg_pump (&dummy_buf);
2678 return 0;
2681 static void
2682 signal_user_input (void)
2684 /* Interrupt any lisp that wants to be interrupted by input. */
2685 if (!NILP (Vthrow_on_input))
2687 Vquit_flag = Vthrow_on_input;
2688 /* Doing a QUIT from this thread is a bad idea, since this
2689 unwinds the stack of the Lisp thread, and the Windows runtime
2690 rightfully barfs. Disabled. */
2691 #if 0
2692 /* If we're inside a function that wants immediate quits,
2693 do it now. */
2694 if (immediate_quit && NILP (Vinhibit_quit))
2696 immediate_quit = 0;
2697 QUIT;
2699 #endif
2704 static void
2705 post_character_message (HWND hwnd, UINT msg,
2706 WPARAM wParam, LPARAM lParam,
2707 DWORD modifiers)
2709 W32Msg wmsg;
2711 wmsg.dwModifiers = modifiers;
2713 /* Detect quit_char and set quit-flag directly. Note that we
2714 still need to post a message to ensure the main thread will be
2715 woken up if blocked in sys_select, but we do NOT want to post
2716 the quit_char message itself (because it will usually be as if
2717 the user had typed quit_char twice). Instead, we post a dummy
2718 message that has no particular effect. */
2720 int c = wParam;
2721 if (isalpha (c) && wmsg.dwModifiers == ctrl_modifier)
2722 c = make_ctrl_char (c) & 0377;
2723 if (c == quit_char
2724 || (wmsg.dwModifiers == 0
2725 && w32_quit_key && wParam == w32_quit_key))
2727 Vquit_flag = Qt;
2729 /* The choice of message is somewhat arbitrary, as long as
2730 the main thread handler just ignores it. */
2731 msg = WM_NULL;
2733 /* Interrupt any blocking system calls. */
2734 signal_quit ();
2736 /* As a safety precaution, forcibly complete any deferred
2737 messages. This is a kludge, but I don't see any particularly
2738 clean way to handle the situation where a deferred message is
2739 "dropped" in the lisp thread, and will thus never be
2740 completed, eg. by the user trying to activate the menubar
2741 when the lisp thread is busy, and then typing C-g when the
2742 menubar doesn't open promptly (with the result that the
2743 menubar never responds at all because the deferred
2744 WM_INITMENU message is never completed). Another problem
2745 situation is when the lisp thread calls SendMessage (to send
2746 a window manager command) when a message has been deferred;
2747 the lisp thread gets blocked indefinitely waiting for the
2748 deferred message to be completed, which itself is waiting for
2749 the lisp thread to respond.
2751 Note that we don't want to block the input thread waiting for
2752 a response from the lisp thread (although that would at least
2753 solve the deadlock problem above), because we want to be able
2754 to receive C-g to interrupt the lisp thread. */
2755 cancel_all_deferred_msgs ();
2757 else
2758 signal_user_input ();
2761 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2764 /* Main window procedure */
2766 static LRESULT CALLBACK
2767 w32_wnd_proc (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
2769 struct frame *f;
2770 struct w32_display_info *dpyinfo = &one_w32_display_info;
2771 W32Msg wmsg;
2772 int windows_translate;
2773 int key;
2775 /* Note that it is okay to call x_window_to_frame, even though we are
2776 not running in the main lisp thread, because frame deletion
2777 requires the lisp thread to synchronize with this thread. Thus, if
2778 a frame struct is returned, it can be used without concern that the
2779 lisp thread might make it disappear while we are using it.
2781 NB. Walking the frame list in this thread is safe (as long as
2782 writes of Lisp_Object slots are atomic, which they are on Windows).
2783 Although delete-frame can destructively modify the frame list while
2784 we are walking it, a garbage collection cannot occur until after
2785 delete-frame has synchronized with this thread.
2787 It is also safe to use functions that make GDI calls, such as
2788 w32_clear_rect, because these functions must obtain a DC handle
2789 from the frame struct using get_frame_dc which is thread-aware. */
2791 switch (msg)
2793 case WM_ERASEBKGND:
2794 f = x_window_to_frame (dpyinfo, hwnd);
2795 if (f)
2797 HDC hdc = get_frame_dc (f);
2798 GetUpdateRect (hwnd, &wmsg.rect, FALSE);
2799 w32_clear_rect (f, hdc, &wmsg.rect);
2800 release_frame_dc (f, hdc);
2802 #if defined (W32_DEBUG_DISPLAY)
2803 DebPrint (("WM_ERASEBKGND (frame %p): erasing %d,%d-%d,%d\n",
2805 wmsg.rect.left, wmsg.rect.top,
2806 wmsg.rect.right, wmsg.rect.bottom));
2807 #endif /* W32_DEBUG_DISPLAY */
2809 return 1;
2810 case WM_PALETTECHANGED:
2811 /* ignore our own changes */
2812 if ((HWND)wParam != hwnd)
2814 f = x_window_to_frame (dpyinfo, hwnd);
2815 if (f)
2816 /* get_frame_dc will realize our palette and force all
2817 frames to be redrawn if needed. */
2818 release_frame_dc (f, get_frame_dc (f));
2820 return 0;
2821 case WM_PAINT:
2823 PAINTSTRUCT paintStruct;
2824 RECT update_rect;
2825 memset (&update_rect, 0, sizeof (update_rect));
2827 f = x_window_to_frame (dpyinfo, hwnd);
2828 if (f == 0)
2830 DebPrint (("WM_PAINT received for unknown window %p\n", hwnd));
2831 return 0;
2834 /* MSDN Docs say not to call BeginPaint if GetUpdateRect
2835 fails. Apparently this can happen under some
2836 circumstances. */
2837 if (GetUpdateRect (hwnd, &update_rect, FALSE) || !w32_strict_painting)
2839 enter_crit ();
2840 BeginPaint (hwnd, &paintStruct);
2842 /* The rectangles returned by GetUpdateRect and BeginPaint
2843 do not always match. Play it safe by assuming both areas
2844 are invalid. */
2845 UnionRect (&(wmsg.rect), &update_rect, &(paintStruct.rcPaint));
2847 #if defined (W32_DEBUG_DISPLAY)
2848 DebPrint (("WM_PAINT (frame %p): painting %d,%d-%d,%d\n",
2850 wmsg.rect.left, wmsg.rect.top,
2851 wmsg.rect.right, wmsg.rect.bottom));
2852 DebPrint ((" [update region is %d,%d-%d,%d]\n",
2853 update_rect.left, update_rect.top,
2854 update_rect.right, update_rect.bottom));
2855 #endif
2856 EndPaint (hwnd, &paintStruct);
2857 leave_crit ();
2859 /* Change the message type to prevent Windows from
2860 combining WM_PAINT messages in the Lisp thread's queue,
2861 since Windows assumes that each message queue is
2862 dedicated to one frame and does not bother checking
2863 that hwnd matches before combining them. */
2864 my_post_msg (&wmsg, hwnd, WM_EMACS_PAINT, wParam, lParam);
2866 return 0;
2869 /* If GetUpdateRect returns 0 (meaning there is no update
2870 region), assume the whole window needs to be repainted. */
2871 GetClientRect (hwnd, &wmsg.rect);
2872 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2873 return 0;
2876 case WM_INPUTLANGCHANGE:
2877 /* Inform lisp thread of keyboard layout changes. */
2878 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2880 /* Clear dead keys in the keyboard state; for simplicity only
2881 preserve modifier key states. */
2883 int i;
2884 BYTE keystate[256];
2886 GetKeyboardState (keystate);
2887 for (i = 0; i < 256; i++)
2888 if (1
2889 && i != VK_SHIFT
2890 && i != VK_LSHIFT
2891 && i != VK_RSHIFT
2892 && i != VK_CAPITAL
2893 && i != VK_NUMLOCK
2894 && i != VK_SCROLL
2895 && i != VK_CONTROL
2896 && i != VK_LCONTROL
2897 && i != VK_RCONTROL
2898 && i != VK_MENU
2899 && i != VK_LMENU
2900 && i != VK_RMENU
2901 && i != VK_LWIN
2902 && i != VK_RWIN)
2903 keystate[i] = 0;
2904 SetKeyboardState (keystate);
2906 goto dflt;
2908 case WM_HOTKEY:
2909 /* Synchronize hot keys with normal input. */
2910 PostMessage (hwnd, WM_KEYDOWN, HIWORD (lParam), 0);
2911 return (0);
2913 case WM_KEYUP:
2914 case WM_SYSKEYUP:
2915 record_keyup (wParam, lParam);
2916 goto dflt;
2918 case WM_KEYDOWN:
2919 case WM_SYSKEYDOWN:
2920 /* Ignore keystrokes we fake ourself; see below. */
2921 if (dpyinfo->faked_key == wParam)
2923 dpyinfo->faked_key = 0;
2924 /* Make sure TranslateMessage sees them though (as long as
2925 they don't produce WM_CHAR messages). This ensures that
2926 indicator lights are toggled promptly on Windows 9x, for
2927 example. */
2928 if (wParam < 256 && lispy_function_keys[wParam])
2930 windows_translate = 1;
2931 goto translate;
2933 return 0;
2936 /* Synchronize modifiers with current keystroke. */
2937 sync_modifiers ();
2938 record_keydown (wParam, lParam);
2939 wParam = map_keypad_keys (wParam, (lParam & 0x1000000L) != 0);
2941 windows_translate = 0;
2943 switch (wParam)
2945 case VK_LWIN:
2946 if (NILP (Vw32_pass_lwindow_to_system))
2948 /* Prevent system from acting on keyup (which opens the
2949 Start menu if no other key was pressed) by simulating a
2950 press of Space which we will ignore. */
2951 if (GetAsyncKeyState (wParam) & 1)
2953 if (NUMBERP (Vw32_phantom_key_code))
2954 key = XUINT (Vw32_phantom_key_code) & 255;
2955 else
2956 key = VK_SPACE;
2957 dpyinfo->faked_key = key;
2958 keybd_event (key, (BYTE) MapVirtualKey (key, 0), 0, 0);
2961 if (!NILP (Vw32_lwindow_modifier))
2962 return 0;
2963 break;
2964 case VK_RWIN:
2965 if (NILP (Vw32_pass_rwindow_to_system))
2967 if (GetAsyncKeyState (wParam) & 1)
2969 if (NUMBERP (Vw32_phantom_key_code))
2970 key = XUINT (Vw32_phantom_key_code) & 255;
2971 else
2972 key = VK_SPACE;
2973 dpyinfo->faked_key = key;
2974 keybd_event (key, (BYTE) MapVirtualKey (key, 0), 0, 0);
2977 if (!NILP (Vw32_rwindow_modifier))
2978 return 0;
2979 break;
2980 case VK_APPS:
2981 if (!NILP (Vw32_apps_modifier))
2982 return 0;
2983 break;
2984 case VK_MENU:
2985 if (NILP (Vw32_pass_alt_to_system))
2986 /* Prevent DefWindowProc from activating the menu bar if an
2987 Alt key is pressed and released by itself. */
2988 return 0;
2989 windows_translate = 1;
2990 break;
2991 case VK_CAPITAL:
2992 /* Decide whether to treat as modifier or function key. */
2993 if (NILP (Vw32_enable_caps_lock))
2994 goto disable_lock_key;
2995 windows_translate = 1;
2996 break;
2997 case VK_NUMLOCK:
2998 /* Decide whether to treat as modifier or function key. */
2999 if (NILP (Vw32_enable_num_lock))
3000 goto disable_lock_key;
3001 windows_translate = 1;
3002 break;
3003 case VK_SCROLL:
3004 /* Decide whether to treat as modifier or function key. */
3005 if (NILP (Vw32_scroll_lock_modifier))
3006 goto disable_lock_key;
3007 windows_translate = 1;
3008 break;
3009 disable_lock_key:
3010 /* Ensure the appropriate lock key state (and indicator light)
3011 remains in the same state. We do this by faking another
3012 press of the relevant key. Apparently, this really is the
3013 only way to toggle the state of the indicator lights. */
3014 dpyinfo->faked_key = wParam;
3015 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3016 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
3017 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3018 KEYEVENTF_EXTENDEDKEY | 0, 0);
3019 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3020 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
3021 /* Ensure indicator lights are updated promptly on Windows 9x
3022 (TranslateMessage apparently does this), after forwarding
3023 input event. */
3024 post_character_message (hwnd, msg, wParam, lParam,
3025 w32_get_key_modifiers (wParam, lParam));
3026 windows_translate = 1;
3027 break;
3028 case VK_CONTROL:
3029 case VK_SHIFT:
3030 case VK_PROCESSKEY: /* Generated by IME. */
3031 windows_translate = 1;
3032 break;
3033 case VK_CANCEL:
3034 /* Windows maps Ctrl-Pause (aka Ctrl-Break) into VK_CANCEL,
3035 which is confusing for purposes of key binding; convert
3036 VK_CANCEL events into VK_PAUSE events. */
3037 wParam = VK_PAUSE;
3038 break;
3039 case VK_PAUSE:
3040 /* Windows maps Ctrl-NumLock into VK_PAUSE, which is confusing
3041 for purposes of key binding; convert these back into
3042 VK_NUMLOCK events, at least when we want to see NumLock key
3043 presses. (Note that there is never any possibility that
3044 VK_PAUSE with Ctrl really is C-Pause as per above.) */
3045 if (NILP (Vw32_enable_num_lock) && modifier_set (VK_CONTROL))
3046 wParam = VK_NUMLOCK;
3047 break;
3048 default:
3049 /* If not defined as a function key, change it to a WM_CHAR message. */
3050 if (wParam > 255 || !lispy_function_keys[wParam])
3052 DWORD modifiers = construct_console_modifiers ();
3054 if (!NILP (Vw32_recognize_altgr)
3055 && modifier_set (VK_LCONTROL) && modifier_set (VK_RMENU))
3057 /* Always let TranslateMessage handle AltGr key chords;
3058 for some reason, ToAscii doesn't always process AltGr
3059 chords correctly. */
3060 windows_translate = 1;
3062 else if ((modifiers & (~SHIFT_PRESSED & ~CAPSLOCK_ON)) != 0)
3064 /* Handle key chords including any modifiers other
3065 than shift directly, in order to preserve as much
3066 modifier information as possible. */
3067 if ('A' <= wParam && wParam <= 'Z')
3069 /* Don't translate modified alphabetic keystrokes,
3070 so the user doesn't need to constantly switch
3071 layout to type control or meta keystrokes when
3072 the normal layout translates alphabetic
3073 characters to non-ascii characters. */
3074 if (!modifier_set (VK_SHIFT))
3075 wParam += ('a' - 'A');
3076 msg = WM_CHAR;
3078 else
3080 /* Try to handle other keystrokes by determining the
3081 base character (ie. translating the base key plus
3082 shift modifier). */
3083 int add;
3084 KEY_EVENT_RECORD key;
3086 key.bKeyDown = TRUE;
3087 key.wRepeatCount = 1;
3088 key.wVirtualKeyCode = wParam;
3089 key.wVirtualScanCode = (lParam & 0xFF0000) >> 16;
3090 key.uChar.AsciiChar = 0;
3091 key.dwControlKeyState = modifiers;
3093 add = w32_kbd_patch_key (&key, w32_keyboard_codepage);
3094 /* 0 means an unrecognized keycode, negative means
3095 dead key. Ignore both. */
3096 while (--add >= 0)
3098 /* Forward asciified character sequence. */
3099 post_character_message
3100 (hwnd, WM_CHAR,
3101 (unsigned char) key.uChar.AsciiChar, lParam,
3102 w32_get_key_modifiers (wParam, lParam));
3103 w32_kbd_patch_key (&key, w32_keyboard_codepage);
3105 return 0;
3108 else
3110 /* Let TranslateMessage handle everything else. */
3111 windows_translate = 1;
3116 translate:
3117 if (windows_translate)
3119 MSG windows_msg = { hwnd, msg, wParam, lParam, 0, {0,0} };
3120 windows_msg.time = GetMessageTime ();
3121 TranslateMessage (&windows_msg);
3122 goto dflt;
3125 /* Fall through */
3127 case WM_SYSCHAR:
3128 case WM_CHAR:
3129 if (wParam > 255 )
3131 W32Msg wmsg;
3133 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3134 signal_user_input ();
3135 my_post_msg (&wmsg, hwnd, WM_UNICHAR, wParam, lParam);
3138 else
3139 post_character_message (hwnd, msg, wParam, lParam,
3140 w32_get_key_modifiers (wParam, lParam));
3141 break;
3143 case WM_UNICHAR:
3144 /* WM_UNICHAR looks promising from the docs, but the exact
3145 circumstances in which TranslateMessage sends it is one of those
3146 Microsoft secret API things that EU and US courts are supposed
3147 to have put a stop to already. Spy++ shows it being sent to Notepad
3148 and other MS apps, but never to Emacs.
3150 Some third party IMEs send it in accordance with the official
3151 documentation though, so handle it here.
3153 UNICODE_NOCHAR is used to test for support for this message.
3154 TRUE indicates that the message is supported. */
3155 if (wParam == UNICODE_NOCHAR)
3156 return TRUE;
3159 W32Msg wmsg;
3160 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3161 signal_user_input ();
3162 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3164 break;
3166 case WM_IME_CHAR:
3167 /* If we can't get the IME result as Unicode, use default processing,
3168 which will at least allow characters decodable in the system locale
3169 get through. */
3170 if (!get_composition_string_fn)
3171 goto dflt;
3173 else if (!ignore_ime_char)
3175 wchar_t * buffer;
3176 int size, i;
3177 W32Msg wmsg;
3178 HIMC context = get_ime_context_fn (hwnd);
3179 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3180 /* Get buffer size. */
3181 size = get_composition_string_fn (context, GCS_RESULTSTR, NULL, 0);
3182 buffer = alloca (size);
3183 size = get_composition_string_fn (context, GCS_RESULTSTR,
3184 buffer, size);
3185 release_ime_context_fn (hwnd, context);
3187 signal_user_input ();
3188 for (i = 0; i < size / sizeof (wchar_t); i++)
3190 my_post_msg (&wmsg, hwnd, WM_UNICHAR, (WPARAM) buffer[i],
3191 lParam);
3193 /* Ignore the messages for the rest of the
3194 characters in the string that was output above. */
3195 ignore_ime_char = (size / sizeof (wchar_t)) - 1;
3197 else
3198 ignore_ime_char--;
3200 break;
3202 case WM_IME_STARTCOMPOSITION:
3203 if (!set_ime_composition_window_fn)
3204 goto dflt;
3205 else
3207 COMPOSITIONFORM form;
3208 HIMC context;
3209 struct window *w;
3211 /* Implementation note: The code below does something that
3212 one shouldn't do: it accesses the window object from a
3213 separate thread, while the main (a.k.a. "Lisp") thread
3214 runs and can legitimately delete and even GC it. That is
3215 why we are extra careful not to futz with a window that
3216 is different from the one recorded when the system caret
3217 coordinates were last modified. That is also why we are
3218 careful not to move the IME window if the window
3219 described by W was deleted, as indicated by its buffer
3220 field being reset to nil. */
3221 f = x_window_to_frame (dpyinfo, hwnd);
3222 if (!(f && FRAME_LIVE_P (f)))
3223 break;
3224 w = XWINDOW (FRAME_SELECTED_WINDOW (f));
3225 /* Punt if someone changed the frame's selected window
3226 behind our back. */
3227 if (w != w32_system_caret_window)
3228 break;
3230 form.dwStyle = CFS_RECT;
3231 form.ptCurrentPos.x = w32_system_caret_x;
3232 form.ptCurrentPos.y = w32_system_caret_y;
3234 form.rcArea.left = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, 0);
3235 form.rcArea.top = (WINDOW_TOP_EDGE_Y (w)
3236 + w32_system_caret_hdr_height);
3237 form.rcArea.right = (WINDOW_BOX_RIGHT_EDGE_X (w)
3238 - WINDOW_RIGHT_MARGIN_WIDTH (w)
3239 - WINDOW_RIGHT_FRINGE_WIDTH (w));
3240 form.rcArea.bottom = (WINDOW_BOTTOM_EDGE_Y (w)
3241 - WINDOW_BOTTOM_DIVIDER_WIDTH (w)
3242 - w32_system_caret_mode_height);
3244 /* Punt if the window was deleted behind our back. */
3245 if (!BUFFERP (w->contents))
3246 break;
3248 context = get_ime_context_fn (hwnd);
3250 if (!context)
3251 break;
3253 set_ime_composition_window_fn (context, &form);
3254 release_ime_context_fn (hwnd, context);
3256 break;
3258 case WM_IME_ENDCOMPOSITION:
3259 ignore_ime_char = 0;
3260 goto dflt;
3262 /* Simulate middle mouse button events when left and right buttons
3263 are used together, but only if user has two button mouse. */
3264 case WM_LBUTTONDOWN:
3265 case WM_RBUTTONDOWN:
3266 if (w32_num_mouse_buttons > 2)
3267 goto handle_plain_button;
3270 int this = (msg == WM_LBUTTONDOWN) ? LMOUSE : RMOUSE;
3271 int other = (msg == WM_LBUTTONDOWN) ? RMOUSE : LMOUSE;
3273 if (button_state & this)
3274 return 0;
3276 if (button_state == 0)
3277 SetCapture (hwnd);
3279 button_state |= this;
3281 if (button_state & other)
3283 if (mouse_button_timer)
3285 KillTimer (hwnd, mouse_button_timer);
3286 mouse_button_timer = 0;
3288 /* Generate middle mouse event instead. */
3289 msg = WM_MBUTTONDOWN;
3290 button_state |= MMOUSE;
3292 else if (button_state & MMOUSE)
3294 /* Ignore button event if we've already generated a
3295 middle mouse down event. This happens if the
3296 user releases and press one of the two buttons
3297 after we've faked a middle mouse event. */
3298 return 0;
3300 else
3302 /* Flush out saved message. */
3303 post_msg (&saved_mouse_button_msg);
3305 wmsg.dwModifiers = w32_get_modifiers ();
3306 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3307 signal_user_input ();
3309 /* Clear message buffer. */
3310 saved_mouse_button_msg.msg.hwnd = 0;
3312 else
3314 /* Hold onto message for now. */
3315 mouse_button_timer =
3316 SetTimer (hwnd, MOUSE_BUTTON_ID,
3317 w32_mouse_button_tolerance, NULL);
3318 saved_mouse_button_msg.msg.hwnd = hwnd;
3319 saved_mouse_button_msg.msg.message = msg;
3320 saved_mouse_button_msg.msg.wParam = wParam;
3321 saved_mouse_button_msg.msg.lParam = lParam;
3322 saved_mouse_button_msg.msg.time = GetMessageTime ();
3323 saved_mouse_button_msg.dwModifiers = w32_get_modifiers ();
3326 return 0;
3328 case WM_LBUTTONUP:
3329 case WM_RBUTTONUP:
3330 if (w32_num_mouse_buttons > 2)
3331 goto handle_plain_button;
3334 int this = (msg == WM_LBUTTONUP) ? LMOUSE : RMOUSE;
3335 int other = (msg == WM_LBUTTONUP) ? RMOUSE : LMOUSE;
3337 if ((button_state & this) == 0)
3338 return 0;
3340 button_state &= ~this;
3342 if (button_state & MMOUSE)
3344 /* Only generate event when second button is released. */
3345 if ((button_state & other) == 0)
3347 msg = WM_MBUTTONUP;
3348 button_state &= ~MMOUSE;
3350 if (button_state) emacs_abort ();
3352 else
3353 return 0;
3355 else
3357 /* Flush out saved message if necessary. */
3358 if (saved_mouse_button_msg.msg.hwnd)
3360 post_msg (&saved_mouse_button_msg);
3363 wmsg.dwModifiers = w32_get_modifiers ();
3364 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3365 signal_user_input ();
3367 /* Always clear message buffer and cancel timer. */
3368 saved_mouse_button_msg.msg.hwnd = 0;
3369 KillTimer (hwnd, mouse_button_timer);
3370 mouse_button_timer = 0;
3372 if (button_state == 0)
3373 ReleaseCapture ();
3375 return 0;
3377 case WM_XBUTTONDOWN:
3378 case WM_XBUTTONUP:
3379 if (w32_pass_extra_mouse_buttons_to_system)
3380 goto dflt;
3381 /* else fall through and process them. */
3382 case WM_MBUTTONDOWN:
3383 case WM_MBUTTONUP:
3384 handle_plain_button:
3386 BOOL up;
3387 int button;
3389 /* Ignore middle and extra buttons as long as the menu is active. */
3390 f = x_window_to_frame (dpyinfo, hwnd);
3391 if (f && f->output_data.w32->menubar_active)
3392 return 0;
3394 if (parse_button (msg, HIWORD (wParam), &button, &up))
3396 if (up) ReleaseCapture ();
3397 else SetCapture (hwnd);
3398 button = (button == 0) ? LMOUSE :
3399 ((button == 1) ? MMOUSE : RMOUSE);
3400 if (up)
3401 button_state &= ~button;
3402 else
3403 button_state |= button;
3407 wmsg.dwModifiers = w32_get_modifiers ();
3408 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3409 signal_user_input ();
3411 /* Need to return true for XBUTTON messages, false for others,
3412 to indicate that we processed the message. */
3413 return (msg == WM_XBUTTONDOWN || msg == WM_XBUTTONUP);
3415 case WM_MOUSEMOVE:
3416 /* Ignore mouse movements as long as the menu is active. These
3417 movements are processed by the window manager anyway, and
3418 it's wrong to handle them as if they happened on the
3419 underlying frame. */
3420 f = x_window_to_frame (dpyinfo, hwnd);
3421 if (f && f->output_data.w32->menubar_active)
3422 return 0;
3424 /* If the mouse has just moved into the frame, start tracking
3425 it, so we will be notified when it leaves the frame. Mouse
3426 tracking only works under W98 and NT4 and later. On earlier
3427 versions, there is no way of telling when the mouse leaves the
3428 frame, so we just have to put up with help-echo and mouse
3429 highlighting remaining while the frame is not active. */
3430 if (track_mouse_event_fn && !track_mouse_window
3431 /* If the menu bar is active, turning on tracking of mouse
3432 movement events might send these events to the tooltip
3433 frame, if the user happens to move the mouse pointer over
3434 the tooltip. But since we don't process events for
3435 tooltip frames, this causes Windows to present a
3436 hourglass cursor, which is ugly and unexpected. So don't
3437 enable tracking mouse events in this case; they will be
3438 restarted when the menu pops down. (Confusingly, the
3439 menubar_active member of f->output_data.w32, tested
3440 above, is only set when a menu was popped up _not_ from
3441 the frame's menu bar, but via x-popup-menu.) */
3442 && !menubar_in_use)
3444 TRACKMOUSEEVENT tme;
3445 tme.cbSize = sizeof (tme);
3446 tme.dwFlags = TME_LEAVE;
3447 tme.hwndTrack = hwnd;
3448 tme.dwHoverTime = HOVER_DEFAULT;
3450 track_mouse_event_fn (&tme);
3451 track_mouse_window = hwnd;
3453 case WM_VSCROLL:
3454 if (w32_mouse_move_interval <= 0
3455 || (msg == WM_MOUSEMOVE && button_state == 0))
3457 wmsg.dwModifiers = w32_get_modifiers ();
3458 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3459 return 0;
3462 /* Hang onto mouse move and scroll messages for a bit, to avoid
3463 sending such events to Emacs faster than it can process them.
3464 If we get more events before the timer from the first message
3465 expires, we just replace the first message. */
3467 if (saved_mouse_move_msg.msg.hwnd == 0)
3468 mouse_move_timer =
3469 SetTimer (hwnd, MOUSE_MOVE_ID,
3470 w32_mouse_move_interval, NULL);
3472 /* Hold onto message for now. */
3473 saved_mouse_move_msg.msg.hwnd = hwnd;
3474 saved_mouse_move_msg.msg.message = msg;
3475 saved_mouse_move_msg.msg.wParam = wParam;
3476 saved_mouse_move_msg.msg.lParam = lParam;
3477 saved_mouse_move_msg.msg.time = GetMessageTime ();
3478 saved_mouse_move_msg.dwModifiers = w32_get_modifiers ();
3480 return 0;
3482 case WM_MOUSEWHEEL:
3483 case WM_DROPFILES:
3484 wmsg.dwModifiers = w32_get_modifiers ();
3485 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3486 signal_user_input ();
3487 return 0;
3489 case WM_APPCOMMAND:
3490 if (w32_pass_multimedia_buttons_to_system)
3491 goto dflt;
3492 /* Otherwise, pass to lisp, the same way we do with mousehwheel. */
3493 case WM_MOUSEHWHEEL:
3494 wmsg.dwModifiers = w32_get_modifiers ();
3495 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3496 signal_user_input ();
3497 /* Non-zero must be returned when WM_MOUSEHWHEEL messages are
3498 handled, to prevent the system trying to handle it by faking
3499 scroll bar events. */
3500 return 1;
3502 case WM_TIMER:
3503 /* Flush out saved messages if necessary. */
3504 if (wParam == mouse_button_timer)
3506 if (saved_mouse_button_msg.msg.hwnd)
3508 post_msg (&saved_mouse_button_msg);
3509 signal_user_input ();
3510 saved_mouse_button_msg.msg.hwnd = 0;
3512 KillTimer (hwnd, mouse_button_timer);
3513 mouse_button_timer = 0;
3515 else if (wParam == mouse_move_timer)
3517 if (saved_mouse_move_msg.msg.hwnd)
3519 post_msg (&saved_mouse_move_msg);
3520 saved_mouse_move_msg.msg.hwnd = 0;
3522 KillTimer (hwnd, mouse_move_timer);
3523 mouse_move_timer = 0;
3525 else if (wParam == menu_free_timer)
3527 KillTimer (hwnd, menu_free_timer);
3528 menu_free_timer = 0;
3529 f = x_window_to_frame (dpyinfo, hwnd);
3530 /* If a popup menu is active, don't wipe its strings. */
3531 if (menubar_in_use
3532 && current_popup_menu == NULL)
3534 /* Free memory used by owner-drawn and help-echo strings. */
3535 w32_free_menu_strings (hwnd);
3536 if (f)
3537 f->output_data.w32->menubar_active = 0;
3538 menubar_in_use = 0;
3541 return 0;
3543 case WM_NCACTIVATE:
3544 /* Windows doesn't send us focus messages when putting up and
3545 taking down a system popup dialog as for Ctrl-Alt-Del on Windows 95.
3546 The only indication we get that something happened is receiving
3547 this message afterwards. So this is a good time to reset our
3548 keyboard modifiers' state. */
3549 reset_modifiers ();
3550 goto dflt;
3552 case WM_INITMENU:
3553 button_state = 0;
3554 ReleaseCapture ();
3555 /* We must ensure menu bar is fully constructed and up to date
3556 before allowing user interaction with it. To achieve this
3557 we send this message to the lisp thread and wait for a
3558 reply (whose value is not actually needed) to indicate that
3559 the menu bar is now ready for use, so we can now return.
3561 To remain responsive in the meantime, we enter a nested message
3562 loop that can process all other messages.
3564 However, we skip all this if the message results from calling
3565 TrackPopupMenu - in fact, we must NOT attempt to send the lisp
3566 thread a message because it is blocked on us at this point. We
3567 set menubar_active before calling TrackPopupMenu to indicate
3568 this (there is no possibility of confusion with real menubar
3569 being active). */
3571 f = x_window_to_frame (dpyinfo, hwnd);
3572 if (f
3573 && (f->output_data.w32->menubar_active
3574 /* We can receive this message even in the absence of a
3575 menubar (ie. when the system menu is activated) - in this
3576 case we do NOT want to forward the message, otherwise it
3577 will cause the menubar to suddenly appear when the user
3578 had requested it to be turned off! */
3579 || f->output_data.w32->menubar_widget == NULL))
3580 return 0;
3583 deferred_msg msg_buf;
3585 /* Detect if message has already been deferred; in this case
3586 we cannot return any sensible value to ignore this. */
3587 if (find_deferred_msg (hwnd, msg) != NULL)
3588 emacs_abort ();
3590 menubar_in_use = 1;
3592 return send_deferred_msg (&msg_buf, hwnd, msg, wParam, lParam);
3595 case WM_EXITMENULOOP:
3596 f = x_window_to_frame (dpyinfo, hwnd);
3598 /* If a menu is still active, check again after a short delay,
3599 since Windows often (always?) sends the WM_EXITMENULOOP
3600 before the corresponding WM_COMMAND message.
3601 Don't do this if a popup menu is active, since it is only
3602 menubar menus that require cleaning up in this way.
3604 if (f && menubar_in_use && current_popup_menu == NULL)
3605 menu_free_timer = SetTimer (hwnd, MENU_FREE_ID, MENU_FREE_DELAY, NULL);
3607 /* If hourglass cursor should be displayed, display it now. */
3608 if (f && f->output_data.w32->hourglass_p)
3609 SetCursor (f->output_data.w32->hourglass_cursor);
3611 goto dflt;
3613 case WM_MENUSELECT:
3614 /* Direct handling of help_echo in menus. Should be safe now
3615 that we generate the help_echo by placing a help event in the
3616 keyboard buffer. */
3618 HMENU menu = (HMENU) lParam;
3619 UINT menu_item = (UINT) LOWORD (wParam);
3620 UINT flags = (UINT) HIWORD (wParam);
3622 w32_menu_display_help (hwnd, menu, menu_item, flags);
3624 return 0;
3626 case WM_MEASUREITEM:
3627 f = x_window_to_frame (dpyinfo, hwnd);
3628 if (f)
3630 MEASUREITEMSTRUCT * pMis = (MEASUREITEMSTRUCT *) lParam;
3632 if (pMis->CtlType == ODT_MENU)
3634 /* Work out dimensions for popup menu titles. */
3635 char * title = (char *) pMis->itemData;
3636 HDC hdc = GetDC (hwnd);
3637 HFONT menu_font = GetCurrentObject (hdc, OBJ_FONT);
3638 LOGFONT menu_logfont;
3639 HFONT old_font;
3640 SIZE size;
3642 GetObject (menu_font, sizeof (menu_logfont), &menu_logfont);
3643 menu_logfont.lfWeight = FW_BOLD;
3644 menu_font = CreateFontIndirect (&menu_logfont);
3645 old_font = SelectObject (hdc, menu_font);
3647 pMis->itemHeight = GetSystemMetrics (SM_CYMENUSIZE);
3648 if (title)
3650 if (unicode_append_menu)
3651 GetTextExtentPoint32W (hdc, (WCHAR *) title,
3652 wcslen ((WCHAR *) title),
3653 &size);
3654 else
3655 GetTextExtentPoint32 (hdc, title, strlen (title), &size);
3657 pMis->itemWidth = size.cx;
3658 if (pMis->itemHeight < size.cy)
3659 pMis->itemHeight = size.cy;
3661 else
3662 pMis->itemWidth = 0;
3664 SelectObject (hdc, old_font);
3665 DeleteObject (menu_font);
3666 ReleaseDC (hwnd, hdc);
3667 return TRUE;
3670 return 0;
3672 case WM_DRAWITEM:
3673 f = x_window_to_frame (dpyinfo, hwnd);
3674 if (f)
3676 DRAWITEMSTRUCT * pDis = (DRAWITEMSTRUCT *) lParam;
3678 if (pDis->CtlType == ODT_MENU)
3680 /* Draw popup menu title. */
3681 char * title = (char *) pDis->itemData;
3682 if (title)
3684 HDC hdc = pDis->hDC;
3685 HFONT menu_font = GetCurrentObject (hdc, OBJ_FONT);
3686 LOGFONT menu_logfont;
3687 HFONT old_font;
3689 GetObject (menu_font, sizeof (menu_logfont), &menu_logfont);
3690 menu_logfont.lfWeight = FW_BOLD;
3691 menu_font = CreateFontIndirect (&menu_logfont);
3692 old_font = SelectObject (hdc, menu_font);
3694 /* Always draw title as if not selected. */
3695 if (unicode_append_menu)
3696 ExtTextOutW (hdc,
3697 pDis->rcItem.left
3698 + GetSystemMetrics (SM_CXMENUCHECK),
3699 pDis->rcItem.top,
3700 ETO_OPAQUE, &pDis->rcItem,
3701 (WCHAR *) title,
3702 wcslen ((WCHAR *) title), NULL);
3703 else
3704 ExtTextOut (hdc,
3705 pDis->rcItem.left
3706 + GetSystemMetrics (SM_CXMENUCHECK),
3707 pDis->rcItem.top,
3708 ETO_OPAQUE, &pDis->rcItem,
3709 title, strlen (title), NULL);
3711 SelectObject (hdc, old_font);
3712 DeleteObject (menu_font);
3714 return TRUE;
3717 return 0;
3719 #if 0
3720 /* Still not right - can't distinguish between clicks in the
3721 client area of the frame from clicks forwarded from the scroll
3722 bars - may have to hook WM_NCHITTEST to remember the mouse
3723 position and then check if it is in the client area ourselves. */
3724 case WM_MOUSEACTIVATE:
3725 /* Discard the mouse click that activates a frame, allowing the
3726 user to click anywhere without changing point (or worse!).
3727 Don't eat mouse clicks on scrollbars though!! */
3728 if (LOWORD (lParam) == HTCLIENT )
3729 return MA_ACTIVATEANDEAT;
3730 goto dflt;
3731 #endif
3733 case WM_MOUSELEAVE:
3734 /* No longer tracking mouse. */
3735 track_mouse_window = NULL;
3737 case WM_ACTIVATEAPP:
3738 case WM_ACTIVATE:
3739 case WM_WINDOWPOSCHANGED:
3740 case WM_SHOWWINDOW:
3741 /* Inform lisp thread that a frame might have just been obscured
3742 or exposed, so should recheck visibility of all frames. */
3743 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3744 goto dflt;
3746 case WM_SETFOCUS:
3747 dpyinfo->faked_key = 0;
3748 reset_modifiers ();
3749 register_hot_keys (hwnd);
3750 goto command;
3751 case WM_KILLFOCUS:
3752 unregister_hot_keys (hwnd);
3753 button_state = 0;
3754 ReleaseCapture ();
3755 /* Relinquish the system caret. */
3756 if (w32_system_caret_hwnd)
3758 w32_visible_system_caret_hwnd = NULL;
3759 w32_system_caret_hwnd = NULL;
3760 DestroyCaret ();
3762 goto command;
3763 case WM_COMMAND:
3764 menubar_in_use = 0;
3765 f = x_window_to_frame (dpyinfo, hwnd);
3766 if (f && HIWORD (wParam) == 0)
3768 if (menu_free_timer)
3770 KillTimer (hwnd, menu_free_timer);
3771 menu_free_timer = 0;
3774 case WM_MOVE:
3775 case WM_SIZE:
3776 command:
3777 wmsg.dwModifiers = w32_get_modifiers ();
3778 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3779 goto dflt;
3781 case WM_DESTROY:
3782 CoUninitialize ();
3783 return 0;
3785 case WM_CLOSE:
3786 wmsg.dwModifiers = w32_get_modifiers ();
3787 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3788 return 0;
3790 case WM_WINDOWPOSCHANGING:
3791 /* Don't restrict the sizing of tip frames. */
3792 if (frame_resize_pixelwise || hwnd == tip_window)
3793 return 0;
3795 /* Don't restrict the sizing of fullscreened frames, allowing them to be
3796 flush with the sides of the screen. */
3797 f = x_window_to_frame (dpyinfo, hwnd);
3798 if (f && FRAME_PREV_FSMODE (f) != FULLSCREEN_NONE)
3799 return 0;
3802 WINDOWPLACEMENT wp;
3803 LPWINDOWPOS lppos = (WINDOWPOS *) lParam;
3805 wp.length = sizeof (WINDOWPLACEMENT);
3806 GetWindowPlacement (hwnd, &wp);
3808 if (wp.showCmd != SW_SHOWMAXIMIZED && wp.showCmd != SW_SHOWMINIMIZED
3809 && (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);
4249 /* If the frame's image cache refcount is still the same as our
4250 private shadow variable, it means we are unwinding a frame
4251 for which we didn't yet call init_frame_faces, where the
4252 refcount is incremented. Therefore, we increment it here, so
4253 that free_frame_faces, called in x_free_frame_resources
4254 below, will not mistakenly decrement the counter that was not
4255 incremented yet to account for this new frame. */
4256 if (FRAME_IMAGE_CACHE (f) != NULL
4257 && FRAME_IMAGE_CACHE (f)->refcount == image_cache_refcount)
4258 FRAME_IMAGE_CACHE (f)->refcount++;
4259 #endif
4261 x_free_frame_resources (f);
4262 free_glyphs (f);
4264 #ifdef GLYPH_DEBUG
4265 /* Check that reference counts are indeed correct. */
4266 eassert (dpyinfo->reference_count == dpyinfo_refcount);
4267 eassert ((dpyinfo->terminal->image_cache == NULL
4268 && image_cache_refcount == 0)
4269 || (dpyinfo->terminal->image_cache != NULL
4270 && dpyinfo->terminal->image_cache->refcount == image_cache_refcount));
4271 #endif
4272 return Qt;
4275 return Qnil;
4278 static void
4279 do_unwind_create_frame (Lisp_Object frame)
4281 unwind_create_frame (frame);
4284 static void
4285 unwind_create_frame_1 (Lisp_Object val)
4287 inhibit_lisp_code = val;
4290 static void
4291 x_default_font_parameter (struct frame *f, Lisp_Object parms)
4293 struct w32_display_info *dpyinfo = FRAME_DISPLAY_INFO (f);
4294 Lisp_Object font_param = x_get_arg (dpyinfo, parms, Qfont, NULL, NULL,
4295 RES_TYPE_STRING);
4296 Lisp_Object font;
4297 if (EQ (font_param, Qunbound))
4298 font_param = Qnil;
4299 font = !NILP (font_param) ? font_param
4300 : x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
4302 if (!STRINGP (font))
4304 int i;
4305 static char *names[]
4306 = { "Courier New-10",
4307 "-*-Courier-normal-r-*-*-13-*-*-*-c-*-iso8859-1",
4308 "-*-Fixedsys-normal-r-*-*-12-*-*-*-c-*-iso8859-1",
4309 "Fixedsys",
4310 NULL };
4312 for (i = 0; names[i]; i++)
4314 font = font_open_by_name (f, build_unibyte_string (names[i]));
4315 if (! NILP (font))
4316 break;
4318 if (NILP (font))
4319 error ("No suitable font was found");
4321 else if (!NILP (font_param))
4323 /* Remember the explicit font parameter, so we can re-apply it after
4324 we've applied the `default' face settings. */
4325 x_set_frame_parameters (f, Fcons (Fcons (Qfont_param, font_param), Qnil));
4327 x_default_parameter (f, parms, Qfont, font, "font", "Font", RES_TYPE_STRING);
4330 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
4331 1, 1, 0,
4332 doc: /* Make a new window, which is called a \"frame\" in Emacs terms.
4333 Return an Emacs frame object.
4334 PARAMETERS is an alist of frame parameters.
4335 If the parameters specify that the frame should not have a minibuffer,
4336 and do not specify a specific minibuffer window to use,
4337 then `default-minibuffer-frame' must be a frame whose minibuffer can
4338 be shared by the new frame.
4340 This function is an internal primitive--use `make-frame' instead. */)
4341 (Lisp_Object parameters)
4343 struct frame *f;
4344 Lisp_Object frame, tem;
4345 Lisp_Object name;
4346 int minibuffer_only = 0;
4347 long window_prompting = 0;
4348 int width, height;
4349 ptrdiff_t count = SPECPDL_INDEX ();
4350 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4351 Lisp_Object display;
4352 struct w32_display_info *dpyinfo = NULL;
4353 Lisp_Object parent;
4354 struct kboard *kb;
4356 if (!FRAME_W32_P (SELECTED_FRAME ())
4357 && !FRAME_INITIAL_P (SELECTED_FRAME ()))
4358 error ("Cannot create a GUI frame in a -nw session");
4360 /* Make copy of frame parameters because the original is in pure
4361 storage now. */
4362 parameters = Fcopy_alist (parameters);
4364 /* Use this general default value to start with
4365 until we know if this frame has a specified name. */
4366 Vx_resource_name = Vinvocation_name;
4368 display = x_get_arg (dpyinfo, parameters, Qterminal, 0, 0, RES_TYPE_NUMBER);
4369 if (EQ (display, Qunbound))
4370 display = x_get_arg (dpyinfo, parameters, Qdisplay, 0, 0, RES_TYPE_STRING);
4371 if (EQ (display, Qunbound))
4372 display = Qnil;
4373 dpyinfo = check_x_display_info (display);
4374 kb = dpyinfo->terminal->kboard;
4376 if (!dpyinfo->terminal->name)
4377 error ("Terminal is not live, can't create new frames on it");
4379 name = x_get_arg (dpyinfo, parameters, Qname, "name", "Name", RES_TYPE_STRING);
4380 if (!STRINGP (name)
4381 && ! EQ (name, Qunbound)
4382 && ! NILP (name))
4383 error ("Invalid frame name--not a string or nil");
4385 if (STRINGP (name))
4386 Vx_resource_name = name;
4388 /* See if parent window is specified. */
4389 parent = x_get_arg (dpyinfo, parameters, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
4390 if (EQ (parent, Qunbound))
4391 parent = Qnil;
4392 if (! NILP (parent))
4393 CHECK_NUMBER (parent);
4395 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
4396 /* No need to protect DISPLAY because that's not used after passing
4397 it to make_frame_without_minibuffer. */
4398 frame = Qnil;
4399 GCPRO4 (parameters, parent, name, frame);
4400 tem = x_get_arg (dpyinfo, parameters, Qminibuffer, "minibuffer", "Minibuffer",
4401 RES_TYPE_SYMBOL);
4402 if (EQ (tem, Qnone) || NILP (tem))
4403 f = make_frame_without_minibuffer (Qnil, kb, display);
4404 else if (EQ (tem, Qonly))
4406 f = make_minibuffer_frame ();
4407 minibuffer_only = 1;
4409 else if (WINDOWP (tem))
4410 f = make_frame_without_minibuffer (tem, kb, display);
4411 else
4412 f = make_frame (1);
4414 XSETFRAME (frame, f);
4416 /* By default, make scrollbars the system standard width. */
4417 x_set_scroll_bar_default_width (f);
4419 f->terminal = dpyinfo->terminal;
4421 f->output_method = output_w32;
4422 f->output_data.w32 = xzalloc (sizeof (struct w32_output));
4423 FRAME_FONTSET (f) = -1;
4425 fset_icon_name
4426 (f, x_get_arg (dpyinfo, parameters, Qicon_name, "iconName", "Title",
4427 RES_TYPE_STRING));
4428 if (! STRINGP (f->icon_name))
4429 fset_icon_name (f, Qnil);
4431 /* FRAME_DISPLAY_INFO (f) = dpyinfo; */
4433 /* With FRAME_DISPLAY_INFO set up, this unwind-protect is safe. */
4434 record_unwind_protect (do_unwind_create_frame, frame);
4436 #ifdef GLYPH_DEBUG
4437 image_cache_refcount =
4438 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
4439 dpyinfo_refcount = dpyinfo->reference_count;
4440 #endif /* GLYPH_DEBUG */
4442 /* Specify the parent under which to make this window. */
4444 if (!NILP (parent))
4446 f->output_data.w32->parent_desc = (Window) XFASTINT (parent);
4447 f->output_data.w32->explicit_parent = 1;
4449 else
4451 f->output_data.w32->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
4452 f->output_data.w32->explicit_parent = 0;
4455 /* Set the name; the functions to which we pass f expect the name to
4456 be set. */
4457 if (EQ (name, Qunbound) || NILP (name))
4459 fset_name (f, build_string (dpyinfo->w32_id_name));
4460 f->explicit_name = 0;
4462 else
4464 fset_name (f, name);
4465 f->explicit_name = 1;
4466 /* use the frame's title when getting resources for this frame. */
4467 specbind (Qx_resource_name, name);
4470 if (uniscribe_available)
4471 register_font_driver (&uniscribe_font_driver, f);
4472 register_font_driver (&w32font_driver, f);
4474 x_default_parameter (f, parameters, Qfont_backend, Qnil,
4475 "fontBackend", "FontBackend", RES_TYPE_STRING);
4476 /* Extract the window parameters from the supplied values
4477 that are needed to determine window geometry. */
4478 x_default_font_parameter (f, parameters);
4479 x_default_parameter (f, parameters, Qborder_width, make_number (2),
4480 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4482 /* We recognize either internalBorderWidth or internalBorder
4483 (which is what xterm calls it). */
4484 if (NILP (Fassq (Qinternal_border_width, parameters)))
4486 Lisp_Object value;
4488 value = x_get_arg (dpyinfo, parameters, Qinternal_border_width,
4489 "internalBorder", "InternalBorder", RES_TYPE_NUMBER);
4490 if (! EQ (value, Qunbound))
4491 parameters = Fcons (Fcons (Qinternal_border_width, value),
4492 parameters);
4494 /* Default internalBorderWidth to 0 on Windows to match other programs. */
4495 x_default_parameter (f, parameters, Qinternal_border_width, make_number (0),
4496 "internalBorderWidth", "InternalBorder", RES_TYPE_NUMBER);
4497 x_default_parameter (f, parameters, Qright_divider_width, make_number (0),
4498 NULL, NULL, RES_TYPE_NUMBER);
4499 x_default_parameter (f, parameters, Qbottom_divider_width, make_number (0),
4500 NULL, NULL, RES_TYPE_NUMBER);
4501 x_default_parameter (f, parameters, Qvertical_scroll_bars, Qright,
4502 "verticalScrollBars", "ScrollBars", RES_TYPE_SYMBOL);
4504 /* Also do the stuff which must be set before the window exists. */
4505 x_default_parameter (f, parameters, Qforeground_color, build_string ("black"),
4506 "foreground", "Foreground", RES_TYPE_STRING);
4507 x_default_parameter (f, parameters, Qbackground_color, build_string ("white"),
4508 "background", "Background", RES_TYPE_STRING);
4509 x_default_parameter (f, parameters, Qmouse_color, build_string ("black"),
4510 "pointerColor", "Foreground", RES_TYPE_STRING);
4511 x_default_parameter (f, parameters, Qborder_color, build_string ("black"),
4512 "borderColor", "BorderColor", RES_TYPE_STRING);
4513 x_default_parameter (f, parameters, Qscreen_gamma, Qnil,
4514 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
4515 x_default_parameter (f, parameters, Qline_spacing, Qnil,
4516 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
4517 x_default_parameter (f, parameters, Qleft_fringe, Qnil,
4518 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
4519 x_default_parameter (f, parameters, Qright_fringe, Qnil,
4520 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
4521 /* Process alpha here (Bug#16619). */
4522 x_default_parameter (f, parameters, Qalpha, Qnil,
4523 "alpha", "Alpha", RES_TYPE_NUMBER);
4525 /* Init faces before x_default_parameter is called for scroll-bar
4526 parameters because that function calls x_set_scroll_bar_width,
4527 which calls change_frame_size, which calls Fset_window_buffer,
4528 which runs hooks, which call Fvertical_motion. At the end, we
4529 end up in init_iterator with a null face cache, which should not
4530 happen. */
4531 init_frame_faces (f);
4533 /* Avoid calling window-configuration-change-hook; otherwise we
4534 could get an infloop in next_frame since the frame is not yet in
4535 Vframe_list. */
4537 ptrdiff_t count2 = SPECPDL_INDEX ();
4539 record_unwind_protect (unwind_create_frame_1, inhibit_lisp_code);
4540 inhibit_lisp_code = Qt;
4542 /* PXW: This is a duplicate from below. We have to do it here since
4543 otherwise x_set_tool_bar_lines will work with the character sizes
4544 installed by init_frame_faces while the frame's pixel size is still
4545 calculated from a character size of 1 and we subsequently hit the
4546 eassert (height >= 0) assertion in window_box_height. The
4547 non-pixelwise code apparently worked around this because it had one
4548 frame line vs one toolbar line which left us with a zero root
4549 window height which was obviously wrong as well ... */
4550 change_frame_size (f, FRAME_COLS (f) * FRAME_COLUMN_WIDTH (f),
4551 FRAME_LINES (f) * FRAME_LINE_HEIGHT (f), 1, 0, 0, 1);
4553 /* The X resources controlling the menu-bar and tool-bar are
4554 processed specially at startup, and reflected in the mode
4555 variables; ignore them here. */
4556 x_default_parameter (f, parameters, Qmenu_bar_lines,
4557 NILP (Vmenu_bar_mode)
4558 ? make_number (0) : make_number (1),
4559 NULL, NULL, RES_TYPE_NUMBER);
4560 x_default_parameter (f, parameters, Qtool_bar_lines,
4561 NILP (Vtool_bar_mode)
4562 ? make_number (0) : make_number (1),
4563 NULL, NULL, RES_TYPE_NUMBER);
4565 unbind_to (count2, Qnil);
4568 x_default_parameter (f, parameters, Qbuffer_predicate, Qnil,
4569 "bufferPredicate", "BufferPredicate", RES_TYPE_SYMBOL);
4570 x_default_parameter (f, parameters, Qtitle, Qnil,
4571 "title", "Title", RES_TYPE_STRING);
4572 x_default_parameter (f, parameters, Qfullscreen, Qnil,
4573 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
4575 f->output_data.w32->dwStyle = WS_OVERLAPPEDWINDOW;
4576 f->output_data.w32->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
4578 f->output_data.w32->text_cursor = w32_load_cursor (IDC_IBEAM);
4579 f->output_data.w32->nontext_cursor = w32_load_cursor (IDC_ARROW);
4580 f->output_data.w32->modeline_cursor = w32_load_cursor (IDC_ARROW);
4581 f->output_data.w32->hand_cursor = w32_load_cursor (IDC_HAND);
4582 f->output_data.w32->hourglass_cursor = w32_load_cursor (IDC_WAIT);
4583 f->output_data.w32->horizontal_drag_cursor = w32_load_cursor (IDC_SIZEWE);
4584 f->output_data.w32->vertical_drag_cursor = w32_load_cursor (IDC_SIZENS);
4586 f->output_data.w32->current_cursor = f->output_data.w32->nontext_cursor;
4588 window_prompting = x_figure_window_size (f, parameters, 1);
4590 tem = x_get_arg (dpyinfo, parameters, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
4591 f->no_split = minibuffer_only || EQ (tem, Qt);
4593 w32_window (f, window_prompting, minibuffer_only);
4594 x_icon (f, parameters);
4596 x_make_gc (f);
4598 /* Now consider the frame official. */
4599 f->terminal->reference_count++;
4600 FRAME_DISPLAY_INFO (f)->reference_count++;
4601 Vframe_list = Fcons (frame, Vframe_list);
4603 /* We need to do this after creating the window, so that the
4604 icon-creation functions can say whose icon they're describing. */
4605 x_default_parameter (f, parameters, Qicon_type, Qnil,
4606 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
4608 x_default_parameter (f, parameters, Qauto_raise, Qnil,
4609 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4610 x_default_parameter (f, parameters, Qauto_lower, Qnil,
4611 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4612 x_default_parameter (f, parameters, Qcursor_type, Qbox,
4613 "cursorType", "CursorType", RES_TYPE_SYMBOL);
4614 x_default_parameter (f, parameters, Qscroll_bar_width, Qnil,
4615 "scrollBarWidth", "ScrollBarWidth", RES_TYPE_NUMBER);
4617 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
4618 Change will not be effected unless different from the current
4619 FRAME_LINES (f). */
4620 width = FRAME_TEXT_WIDTH (f);
4621 height = FRAME_TEXT_HEIGHT (f);
4622 FRAME_TEXT_HEIGHT (f) = 0;
4623 SET_FRAME_WIDTH (f, 0);
4624 change_frame_size (f, width, height, 1, 0, 0, 1);
4626 /* Tell the server what size and position, etc, we want, and how
4627 badly we want them. This should be done after we have the menu
4628 bar so that its size can be taken into account. */
4629 block_input ();
4630 x_wm_set_size_hint (f, window_prompting, 0);
4631 unblock_input ();
4633 /* Make the window appear on the frame and enable display, unless
4634 the caller says not to. However, with explicit parent, Emacs
4635 cannot control visibility, so don't try. */
4636 if (! f->output_data.w32->explicit_parent)
4638 Lisp_Object visibility;
4640 visibility = x_get_arg (dpyinfo, parameters, Qvisibility, 0, 0, RES_TYPE_SYMBOL);
4641 if (EQ (visibility, Qunbound))
4642 visibility = Qt;
4644 if (EQ (visibility, Qicon))
4645 x_iconify_frame (f);
4646 else if (! NILP (visibility))
4647 x_make_frame_visible (f);
4648 else
4649 /* Must have been Qnil. */
4653 /* Initialize `default-minibuffer-frame' in case this is the first
4654 frame on this terminal. */
4655 if (FRAME_HAS_MINIBUF_P (f)
4656 && (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
4657 || !FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame)))))
4658 kset_default_minibuffer_frame (kb, frame);
4660 /* All remaining specified parameters, which have not been "used"
4661 by x_get_arg and friends, now go in the misc. alist of the frame. */
4662 for (tem = parameters; CONSP (tem); tem = XCDR (tem))
4663 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
4664 fset_param_alist (f, Fcons (XCAR (tem), f->param_alist));
4666 UNGCPRO;
4668 /* Make sure windows on this frame appear in calls to next-window
4669 and similar functions. */
4670 Vwindow_list = Qnil;
4672 return unbind_to (count, frame);
4675 /* FRAME is used only to get a handle on the X display. We don't pass the
4676 display info directly because we're called from frame.c, which doesn't
4677 know about that structure. */
4678 Lisp_Object
4679 x_get_focus_frame (struct frame *frame)
4681 struct w32_display_info *dpyinfo = FRAME_DISPLAY_INFO (frame);
4682 Lisp_Object xfocus;
4683 if (! dpyinfo->w32_focus_frame)
4684 return Qnil;
4686 XSETFRAME (xfocus, dpyinfo->w32_focus_frame);
4687 return xfocus;
4690 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
4691 doc: /* Internal function called by `color-defined-p', which see.
4692 \(Note that the Nextstep version of this function ignores FRAME.) */)
4693 (Lisp_Object color, Lisp_Object frame)
4695 XColor foo;
4696 struct frame *f = decode_window_system_frame (frame);
4698 CHECK_STRING (color);
4700 if (w32_defined_color (f, SDATA (color), &foo, 0))
4701 return Qt;
4702 else
4703 return Qnil;
4706 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
4707 doc: /* Internal function called by `color-values', which see. */)
4708 (Lisp_Object color, Lisp_Object frame)
4710 XColor foo;
4711 struct frame *f = decode_window_system_frame (frame);
4713 CHECK_STRING (color);
4715 if (w32_defined_color (f, SDATA (color), &foo, 0))
4716 return list3i ((GetRValue (foo.pixel) << 8) | GetRValue (foo.pixel),
4717 (GetGValue (foo.pixel) << 8) | GetGValue (foo.pixel),
4718 (GetBValue (foo.pixel) << 8) | GetBValue (foo.pixel));
4719 else
4720 return Qnil;
4723 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
4724 doc: /* Internal function called by `display-color-p', which see. */)
4725 (Lisp_Object display)
4727 struct w32_display_info *dpyinfo = check_x_display_info (display);
4729 if ((dpyinfo->n_planes * dpyinfo->n_cbits) <= 2)
4730 return Qnil;
4732 return Qt;
4735 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p,
4736 Sx_display_grayscale_p, 0, 1, 0,
4737 doc: /* Return t if DISPLAY supports shades of gray.
4738 Note that color displays do support shades of gray.
4739 The optional argument DISPLAY specifies which display to ask about.
4740 DISPLAY should be either a frame or a display name (a string).
4741 If omitted or nil, that stands for the selected frame's display. */)
4742 (Lisp_Object display)
4744 struct w32_display_info *dpyinfo = check_x_display_info (display);
4746 if ((dpyinfo->n_planes * dpyinfo->n_cbits) <= 1)
4747 return Qnil;
4749 return Qt;
4752 DEFUN ("x-display-pixel-width", Fx_display_pixel_width,
4753 Sx_display_pixel_width, 0, 1, 0,
4754 doc: /* Return the width in pixels of DISPLAY.
4755 The optional argument DISPLAY specifies which display to ask about.
4756 DISPLAY should be either a frame or a display name (a string).
4757 If omitted or nil, that stands for the selected frame's display.
4759 On \"multi-monitor\" setups this refers to the pixel width for all
4760 physical monitors associated with DISPLAY. To get information for
4761 each physical monitor, use `display-monitor-attributes-list'. */)
4762 (Lisp_Object display)
4764 struct w32_display_info *dpyinfo = check_x_display_info (display);
4766 return make_number (x_display_pixel_width (dpyinfo));
4769 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
4770 Sx_display_pixel_height, 0, 1, 0,
4771 doc: /* Return the height in pixels of DISPLAY.
4772 The optional argument DISPLAY specifies which display to ask about.
4773 DISPLAY should be either a frame or a display name (a string).
4774 If omitted or nil, that stands for the selected frame's display.
4776 On \"multi-monitor\" setups this refers to the pixel height for all
4777 physical monitors associated with DISPLAY. To get information for
4778 each physical monitor, use `display-monitor-attributes-list'. */)
4779 (Lisp_Object display)
4781 struct w32_display_info *dpyinfo = check_x_display_info (display);
4783 return make_number (x_display_pixel_height (dpyinfo));
4786 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
4787 0, 1, 0,
4788 doc: /* Return the number of bitplanes of DISPLAY.
4789 The optional argument DISPLAY specifies which display to ask about.
4790 DISPLAY should be either a frame or a display name (a string).
4791 If omitted or nil, that stands for the selected frame's display. */)
4792 (Lisp_Object display)
4794 struct w32_display_info *dpyinfo = check_x_display_info (display);
4796 return make_number (dpyinfo->n_planes * dpyinfo->n_cbits);
4799 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
4800 0, 1, 0,
4801 doc: /* Return the number of color cells of DISPLAY.
4802 The optional argument DISPLAY specifies which display to ask about.
4803 DISPLAY should be either a frame or a display name (a string).
4804 If omitted or nil, that stands for the selected frame's display. */)
4805 (Lisp_Object display)
4807 struct w32_display_info *dpyinfo = check_x_display_info (display);
4808 int cap;
4810 /* Don't use NCOLORS: it returns incorrect results under remote
4811 * desktop. We force 24+ bit depths to 24-bit, both to prevent an
4812 * overflow and because probably is more meaningful on Windows
4813 * anyway. */
4815 cap = 1 << min (dpyinfo->n_planes * dpyinfo->n_cbits, 24);
4816 return make_number (cap);
4819 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
4820 Sx_server_max_request_size,
4821 0, 1, 0,
4822 doc: /* Return the maximum request size of the server of DISPLAY.
4823 The optional argument DISPLAY specifies which display to ask about.
4824 DISPLAY should be either a frame or a display name (a string).
4825 If omitted or nil, that stands for the selected frame's display. */)
4826 (Lisp_Object display)
4828 return make_number (1);
4831 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
4832 doc: /* Return the "vendor ID" string of the W32 system (Microsoft).
4833 The optional argument DISPLAY specifies which display to ask about.
4834 DISPLAY should be either a frame or a display name (a string).
4835 If omitted or nil, that stands for the selected frame's display. */)
4836 (Lisp_Object display)
4838 return build_string ("Microsoft Corp.");
4841 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
4842 doc: /* Return the version numbers of the server of DISPLAY.
4843 The value is a list of three integers: the major and minor
4844 version numbers of the X Protocol in use, and the distributor-specific
4845 release number. See also the function `x-server-vendor'.
4847 The optional argument DISPLAY specifies which display to ask about.
4848 DISPLAY should be either a frame or a display name (a string).
4849 If omitted or nil, that stands for the selected frame's display. */)
4850 (Lisp_Object display)
4852 return list3i (w32_major_version, w32_minor_version, w32_build_number);
4855 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
4856 doc: /* Return the number of screens on the server of DISPLAY.
4857 The optional argument DISPLAY specifies which display to ask about.
4858 DISPLAY should be either a frame or a display name (a string).
4859 If omitted or nil, that stands for the selected frame's display. */)
4860 (Lisp_Object display)
4862 return make_number (1);
4865 DEFUN ("x-display-mm-height", Fx_display_mm_height,
4866 Sx_display_mm_height, 0, 1, 0,
4867 doc: /* Return the height in millimeters of DISPLAY.
4868 The optional argument DISPLAY specifies which display to ask about.
4869 DISPLAY should be either a frame or a display name (a string).
4870 If omitted or nil, that stands for the selected frame's display.
4872 On \"multi-monitor\" setups this refers to the height in millimeters for
4873 all physical monitors associated with DISPLAY. To get information
4874 for each physical monitor, use `display-monitor-attributes-list'. */)
4875 (Lisp_Object display)
4877 struct w32_display_info *dpyinfo = check_x_display_info (display);
4878 HDC hdc;
4879 double mm_per_pixel;
4881 hdc = GetDC (NULL);
4882 mm_per_pixel = ((double) GetDeviceCaps (hdc, VERTSIZE)
4883 / GetDeviceCaps (hdc, VERTRES));
4884 ReleaseDC (NULL, hdc);
4886 return make_number (x_display_pixel_height (dpyinfo) * mm_per_pixel + 0.5);
4889 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
4890 doc: /* Return the width in millimeters of DISPLAY.
4891 The optional argument DISPLAY specifies which display to ask about.
4892 DISPLAY should be either a frame or a display name (a string).
4893 If omitted or nil, that stands for the selected frame's display.
4895 On \"multi-monitor\" setups this refers to the width in millimeters for
4896 all physical monitors associated with TERMINAL. To get information
4897 for each physical monitor, use `display-monitor-attributes-list'. */)
4898 (Lisp_Object display)
4900 struct w32_display_info *dpyinfo = check_x_display_info (display);
4901 HDC hdc;
4902 double mm_per_pixel;
4904 hdc = GetDC (NULL);
4905 mm_per_pixel = ((double) GetDeviceCaps (hdc, HORZSIZE)
4906 / GetDeviceCaps (hdc, HORZRES));
4907 ReleaseDC (NULL, hdc);
4909 return make_number (x_display_pixel_width (dpyinfo) * mm_per_pixel + 0.5);
4912 DEFUN ("x-display-backing-store", Fx_display_backing_store,
4913 Sx_display_backing_store, 0, 1, 0,
4914 doc: /* Return an indication of whether DISPLAY does backing store.
4915 The value may be `always', `when-mapped', or `not-useful'.
4916 The optional argument DISPLAY specifies which display to ask about.
4917 DISPLAY should be either a frame or a display name (a string).
4918 If omitted or nil, that stands for the selected frame's display. */)
4919 (Lisp_Object display)
4921 return intern ("not-useful");
4924 DEFUN ("x-display-visual-class", Fx_display_visual_class,
4925 Sx_display_visual_class, 0, 1, 0,
4926 doc: /* Return the visual class of DISPLAY.
4927 The value is one of the symbols `static-gray', `gray-scale',
4928 `static-color', `pseudo-color', `true-color', or `direct-color'.
4930 The optional argument DISPLAY specifies which display to ask about.
4931 DISPLAY should be either a frame or a display name (a string).
4932 If omitted or nil, that stands for the selected frame's display. */)
4933 (Lisp_Object display)
4935 struct w32_display_info *dpyinfo = check_x_display_info (display);
4936 Lisp_Object result = Qnil;
4938 if (dpyinfo->has_palette)
4939 result = intern ("pseudo-color");
4940 else if (dpyinfo->n_planes * dpyinfo->n_cbits == 1)
4941 result = intern ("static-grey");
4942 else if (dpyinfo->n_planes * dpyinfo->n_cbits == 4)
4943 result = intern ("static-color");
4944 else if (dpyinfo->n_planes * dpyinfo->n_cbits > 8)
4945 result = intern ("true-color");
4947 return result;
4950 DEFUN ("x-display-save-under", Fx_display_save_under,
4951 Sx_display_save_under, 0, 1, 0,
4952 doc: /* Return t if DISPLAY supports the save-under feature.
4953 The optional argument DISPLAY specifies which display to ask about.
4954 DISPLAY should be either a frame or a display name (a string).
4955 If omitted or nil, that stands for the selected frame's display. */)
4956 (Lisp_Object display)
4958 return Qnil;
4961 static BOOL CALLBACK
4962 w32_monitor_enum (HMONITOR monitor, HDC hdc, RECT *rcMonitor, LPARAM dwData)
4964 Lisp_Object *monitor_list = (Lisp_Object *) dwData;
4966 *monitor_list = Fcons (make_save_ptr (monitor), *monitor_list);
4968 return TRUE;
4971 static Lisp_Object
4972 w32_display_monitor_attributes_list (void)
4974 Lisp_Object attributes_list = Qnil, primary_monitor_attributes = Qnil;
4975 Lisp_Object monitor_list = Qnil, monitor_frames, rest, frame;
4976 int i, n_monitors;
4977 HMONITOR *monitors;
4978 struct gcpro gcpro1, gcpro2, gcpro3;
4980 if (!(enum_display_monitors_fn && get_monitor_info_fn
4981 && monitor_from_window_fn))
4982 return Qnil;
4984 if (!enum_display_monitors_fn (NULL, NULL, w32_monitor_enum,
4985 (LPARAM) &monitor_list)
4986 || NILP (monitor_list))
4987 return Qnil;
4989 n_monitors = 0;
4990 for (rest = monitor_list; CONSP (rest); rest = XCDR (rest))
4991 n_monitors++;
4993 monitors = xmalloc (n_monitors * sizeof (*monitors));
4994 for (i = 0; i < n_monitors; i++)
4996 monitors[i] = XSAVE_POINTER (XCAR (monitor_list), 0);
4997 monitor_list = XCDR (monitor_list);
5000 monitor_frames = Fmake_vector (make_number (n_monitors), Qnil);
5001 FOR_EACH_FRAME (rest, frame)
5003 struct frame *f = XFRAME (frame);
5005 if (FRAME_W32_P (f) && !EQ (frame, tip_frame))
5007 HMONITOR monitor =
5008 monitor_from_window_fn (FRAME_W32_WINDOW (f),
5009 MONITOR_DEFAULT_TO_NEAREST);
5011 for (i = 0; i < n_monitors; i++)
5012 if (monitors[i] == monitor)
5013 break;
5015 if (i < n_monitors)
5016 ASET (monitor_frames, i, Fcons (frame, AREF (monitor_frames, i)));
5020 GCPRO3 (attributes_list, primary_monitor_attributes, monitor_frames);
5022 for (i = 0; i < n_monitors; i++)
5024 Lisp_Object geometry, workarea, name, attributes = Qnil;
5025 HDC hdc;
5026 int width_mm, height_mm;
5027 struct MONITOR_INFO_EX mi;
5029 mi.cbSize = sizeof (mi);
5030 if (!get_monitor_info_fn (monitors[i], (struct MONITOR_INFO *) &mi))
5031 continue;
5033 hdc = CreateDCA ("DISPLAY", mi.szDevice, NULL, NULL);
5034 if (hdc == NULL)
5035 continue;
5036 width_mm = GetDeviceCaps (hdc, HORZSIZE);
5037 height_mm = GetDeviceCaps (hdc, VERTSIZE);
5038 DeleteDC (hdc);
5040 attributes = Fcons (Fcons (Qframes, AREF (monitor_frames, i)),
5041 attributes);
5043 name = DECODE_SYSTEM (build_unibyte_string (mi.szDevice));
5045 attributes = Fcons (Fcons (Qname, name), attributes);
5047 attributes = Fcons (Fcons (Qmm_size, list2i (width_mm, height_mm)),
5048 attributes);
5050 workarea = list4i (mi.rcWork.left, mi.rcWork.top,
5051 mi.rcWork.right - mi.rcWork.left,
5052 mi.rcWork.bottom - mi.rcWork.top);
5053 attributes = Fcons (Fcons (Qworkarea, workarea), attributes);
5055 geometry = list4i (mi.rcMonitor.left, mi.rcMonitor.top,
5056 mi.rcMonitor.right - mi.rcMonitor.left,
5057 mi.rcMonitor.bottom - mi.rcMonitor.top);
5058 attributes = Fcons (Fcons (Qgeometry, geometry), attributes);
5060 if (mi.dwFlags & MONITORINFOF_PRIMARY)
5061 primary_monitor_attributes = attributes;
5062 else
5063 attributes_list = Fcons (attributes, attributes_list);
5066 if (!NILP (primary_monitor_attributes))
5067 attributes_list = Fcons (primary_monitor_attributes, attributes_list);
5069 UNGCPRO;
5071 xfree (monitors);
5073 return attributes_list;
5076 static Lisp_Object
5077 w32_display_monitor_attributes_list_fallback (struct w32_display_info *dpyinfo)
5079 Lisp_Object geometry, workarea, frames, rest, frame, attributes = Qnil;
5080 HDC hdc;
5081 double mm_per_pixel;
5082 int pixel_width, pixel_height, width_mm, height_mm;
5083 RECT workarea_rect;
5085 /* Fallback: treat (possibly) multiple physical monitors as if they
5086 formed a single monitor as a whole. This should provide a
5087 consistent result at least on single monitor environments. */
5088 attributes = Fcons (Fcons (Qname, build_string ("combined screen")),
5089 attributes);
5091 frames = Qnil;
5092 FOR_EACH_FRAME (rest, frame)
5094 struct frame *f = XFRAME (frame);
5096 if (FRAME_W32_P (f) && !EQ (frame, tip_frame))
5097 frames = Fcons (frame, frames);
5099 attributes = Fcons (Fcons (Qframes, frames), attributes);
5101 pixel_width = x_display_pixel_width (dpyinfo);
5102 pixel_height = x_display_pixel_height (dpyinfo);
5104 hdc = GetDC (NULL);
5105 mm_per_pixel = ((double) GetDeviceCaps (hdc, HORZSIZE)
5106 / GetDeviceCaps (hdc, HORZRES));
5107 width_mm = pixel_width * mm_per_pixel + 0.5;
5108 mm_per_pixel = ((double) GetDeviceCaps (hdc, VERTSIZE)
5109 / GetDeviceCaps (hdc, VERTRES));
5110 height_mm = pixel_height * mm_per_pixel + 0.5;
5111 ReleaseDC (NULL, hdc);
5112 attributes = Fcons (Fcons (Qmm_size, list2i (width_mm, height_mm)),
5113 attributes);
5115 /* GetSystemMetrics below may return 0 for Windows 95 or NT 4.0, but
5116 we don't care. */
5117 geometry = list4i (GetSystemMetrics (SM_XVIRTUALSCREEN),
5118 GetSystemMetrics (SM_YVIRTUALSCREEN),
5119 pixel_width, pixel_height);
5120 if (SystemParametersInfo (SPI_GETWORKAREA, 0, &workarea_rect, 0))
5121 workarea = list4i (workarea_rect.left, workarea_rect.top,
5122 workarea_rect.right - workarea_rect.left,
5123 workarea_rect.bottom - workarea_rect.top);
5124 else
5125 workarea = geometry;
5126 attributes = Fcons (Fcons (Qworkarea, workarea), attributes);
5128 attributes = Fcons (Fcons (Qgeometry, geometry), attributes);
5130 return list1 (attributes);
5133 DEFUN ("w32-display-monitor-attributes-list", Fw32_display_monitor_attributes_list,
5134 Sw32_display_monitor_attributes_list,
5135 0, 1, 0,
5136 doc: /* Return a list of physical monitor attributes on the W32 display DISPLAY.
5138 The optional argument DISPLAY specifies which display to ask about.
5139 DISPLAY should be either a frame or a display name (a string).
5140 If omitted or nil, that stands for the selected frame's display.
5142 Internal use only, use `display-monitor-attributes-list' instead. */)
5143 (Lisp_Object display)
5145 struct w32_display_info *dpyinfo = check_x_display_info (display);
5146 Lisp_Object attributes_list;
5148 block_input ();
5149 attributes_list = w32_display_monitor_attributes_list ();
5150 if (NILP (attributes_list))
5151 attributes_list = w32_display_monitor_attributes_list_fallback (dpyinfo);
5152 unblock_input ();
5154 return attributes_list;
5157 DEFUN ("set-message-beep", Fset_message_beep, Sset_message_beep, 1, 1, 0,
5158 doc: /* Set the sound generated when the bell is rung.
5159 SOUND is 'asterisk, 'exclamation, 'hand, 'question, 'ok, or 'silent
5160 to use the corresponding system sound for the bell. The 'silent sound
5161 prevents Emacs from making any sound at all.
5162 SOUND is nil to use the normal beep. */)
5163 (Lisp_Object sound)
5165 CHECK_SYMBOL (sound);
5167 if (NILP (sound))
5168 sound_type = 0xFFFFFFFF;
5169 else if (EQ (sound, intern ("asterisk")))
5170 sound_type = MB_ICONASTERISK;
5171 else if (EQ (sound, intern ("exclamation")))
5172 sound_type = MB_ICONEXCLAMATION;
5173 else if (EQ (sound, intern ("hand")))
5174 sound_type = MB_ICONHAND;
5175 else if (EQ (sound, intern ("question")))
5176 sound_type = MB_ICONQUESTION;
5177 else if (EQ (sound, intern ("ok")))
5178 sound_type = MB_OK;
5179 else if (EQ (sound, intern ("silent")))
5180 sound_type = MB_EMACS_SILENT;
5181 else
5182 sound_type = 0xFFFFFFFF;
5184 return sound;
5188 x_screen_planes (register struct frame *f)
5190 return FRAME_DISPLAY_INFO (f)->n_planes;
5193 /* Return the display structure for the display named NAME.
5194 Open a new connection if necessary. */
5196 struct w32_display_info *
5197 x_display_info_for_name (Lisp_Object name)
5199 struct w32_display_info *dpyinfo;
5201 CHECK_STRING (name);
5203 for (dpyinfo = &one_w32_display_info; dpyinfo; dpyinfo = dpyinfo->next)
5204 if (!NILP (Fstring_equal (XCAR (dpyinfo->name_list_element), name)))
5205 return dpyinfo;
5207 /* Use this general default value to start with. */
5208 Vx_resource_name = Vinvocation_name;
5210 validate_x_resource_name ();
5212 dpyinfo = w32_term_init (name, (unsigned char *)0,
5213 SSDATA (Vx_resource_name));
5215 if (dpyinfo == 0)
5216 error ("Cannot connect to server %s", SDATA (name));
5218 XSETFASTINT (Vwindow_system_version, w32_major_version);
5220 return dpyinfo;
5223 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
5224 1, 3, 0, doc: /* Open a connection to a display server.
5225 DISPLAY is the name of the display to connect to.
5226 Optional second arg XRM-STRING is a string of resources in xrdb format.
5227 If the optional third arg MUST-SUCCEED is non-nil,
5228 terminate Emacs if we can't open the connection.
5229 \(In the Nextstep version, the last two arguments are currently ignored.) */)
5230 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
5232 unsigned char *xrm_option;
5233 struct w32_display_info *dpyinfo;
5235 CHECK_STRING (display);
5237 /* Signal an error in order to encourage correct use from callers.
5238 * If we ever support multiple window systems in the same Emacs,
5239 * we'll need callers to be precise about what window system they
5240 * want. */
5242 if (strcmp (SSDATA (display), "w32") != 0)
5243 error ("The name of the display in this Emacs must be \"w32\"");
5245 /* If initialization has already been done, return now to avoid
5246 overwriting critical parts of one_w32_display_info. */
5247 if (window_system_available (NULL))
5248 return Qnil;
5250 if (! NILP (xrm_string))
5251 CHECK_STRING (xrm_string);
5253 /* Allow color mapping to be defined externally; first look in user's
5254 HOME directory, then in Emacs etc dir for a file called rgb.txt. */
5256 Lisp_Object color_file;
5257 struct gcpro gcpro1;
5259 color_file = build_string ("~/rgb.txt");
5261 GCPRO1 (color_file);
5263 if (NILP (Ffile_readable_p (color_file)))
5264 color_file =
5265 Fexpand_file_name (build_string ("rgb.txt"),
5266 Fsymbol_value (intern ("data-directory")));
5268 Vw32_color_map = Fx_load_color_file (color_file);
5270 UNGCPRO;
5272 if (NILP (Vw32_color_map))
5273 Vw32_color_map = w32_default_color_map ();
5275 /* Merge in system logical colors. */
5276 add_system_logical_colors_to_map (&Vw32_color_map);
5278 if (! NILP (xrm_string))
5279 xrm_option = SDATA (xrm_string);
5280 else
5281 xrm_option = (unsigned char *) 0;
5283 /* Use this general default value to start with. */
5284 /* First remove .exe suffix from invocation-name - it looks ugly. */
5286 char basename[ MAX_PATH ], *str;
5288 strcpy (basename, SDATA (Vinvocation_name));
5289 str = strrchr (basename, '.');
5290 if (str) *str = 0;
5291 Vinvocation_name = build_string (basename);
5293 Vx_resource_name = Vinvocation_name;
5295 validate_x_resource_name ();
5297 /* This is what opens the connection and sets x_current_display.
5298 This also initializes many symbols, such as those used for input. */
5299 dpyinfo = w32_term_init (display, xrm_option,
5300 SSDATA (Vx_resource_name));
5302 if (dpyinfo == 0)
5304 if (!NILP (must_succeed))
5305 fatal ("Cannot connect to server %s.\n",
5306 SDATA (display));
5307 else
5308 error ("Cannot connect to server %s", SDATA (display));
5311 XSETFASTINT (Vwindow_system_version, w32_major_version);
5312 return Qnil;
5315 DEFUN ("x-close-connection", Fx_close_connection,
5316 Sx_close_connection, 1, 1, 0,
5317 doc: /* Close the connection to DISPLAY's server.
5318 For DISPLAY, specify either a frame or a display name (a string).
5319 If DISPLAY is nil, that stands for the selected frame's display. */)
5320 (Lisp_Object display)
5322 struct w32_display_info *dpyinfo = check_x_display_info (display);
5324 if (dpyinfo->reference_count > 0)
5325 error ("Display still has frames on it");
5327 block_input ();
5328 x_destroy_all_bitmaps (dpyinfo);
5330 x_delete_display (dpyinfo);
5331 unblock_input ();
5333 return Qnil;
5336 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
5337 doc: /* Return the list of display names that Emacs has connections to. */)
5338 (void)
5340 Lisp_Object result = Qnil;
5341 struct w32_display_info *wdi;
5343 for (wdi = x_display_list; wdi; wdi = wdi->next)
5344 result = Fcons (XCAR (wdi->name_list_element), result);
5346 return result;
5349 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
5350 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
5351 This function only has an effect on X Windows. With MS Windows, it is
5352 defined but does nothing.
5354 If ON is nil, allow buffering of requests.
5355 Turning on synchronization prohibits the Xlib routines from buffering
5356 requests and seriously degrades performance, but makes debugging much
5357 easier.
5358 The optional second argument TERMINAL specifies which display to act on.
5359 TERMINAL should be a terminal object, a frame or a display name (a string).
5360 If TERMINAL is omitted or nil, that stands for the selected frame's display. */)
5361 (Lisp_Object on, Lisp_Object display)
5363 return Qnil;
5368 /***********************************************************************
5369 Window properties
5370 ***********************************************************************/
5372 #if 0 /* TODO : port window properties to W32 */
5374 DEFUN ("x-change-window-property", Fx_change_window_property,
5375 Sx_change_window_property, 2, 6, 0,
5376 doc: /* Change window property PROP to VALUE on the X window of FRAME.
5377 PROP must be a string. VALUE may be a string or a list of conses,
5378 numbers and/or strings. If an element in the list is a string, it is
5379 converted to an atom and the value of the Atom is used. If an element
5380 is a cons, it is converted to a 32 bit number where the car is the 16
5381 top bits and the cdr is the lower 16 bits.
5383 FRAME nil or omitted means use the selected frame.
5384 If TYPE is given and non-nil, it is the name of the type of VALUE.
5385 If TYPE is not given or nil, the type is STRING.
5386 FORMAT gives the size in bits of each element if VALUE is a list.
5387 It must be one of 8, 16 or 32.
5388 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
5389 If OUTER-P is non-nil, the property is changed for the outer X window of
5390 FRAME. Default is to change on the edit X window. */)
5391 (Lisp_Object prop, Lisp_Object value, Lisp_Object frame,
5392 Lisp_Object type, Lisp_Object format, Lisp_Object outer_p)
5394 struct frame *f = decode_window_system_frame (frame);
5395 Atom prop_atom;
5397 CHECK_STRING (prop);
5398 CHECK_STRING (value);
5400 block_input ();
5401 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5402 XChangeProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5403 prop_atom, XA_STRING, 8, PropModeReplace,
5404 SDATA (value), SCHARS (value));
5406 /* Make sure the property is set when we return. */
5407 XFlush (FRAME_W32_DISPLAY (f));
5408 unblock_input ();
5410 return value;
5414 DEFUN ("x-delete-window-property", Fx_delete_window_property,
5415 Sx_delete_window_property, 1, 2, 0,
5416 doc: /* Remove window property PROP from X window of FRAME.
5417 FRAME nil or omitted means use the selected frame. Value is PROP. */)
5418 (Lisp_Object prop, Lisp_Object frame)
5420 struct frame *f = decode_window_system_frame (frame);
5421 Atom prop_atom;
5423 CHECK_STRING (prop);
5424 block_input ();
5425 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5426 XDeleteProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f), prop_atom);
5428 /* Make sure the property is removed when we return. */
5429 XFlush (FRAME_W32_DISPLAY (f));
5430 unblock_input ();
5432 return prop;
5436 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
5437 1, 6, 0,
5438 doc: /* Value is the value of window property PROP on FRAME.
5439 If FRAME is nil or omitted, use the selected frame.
5441 On X Windows, the following optional arguments are also accepted:
5442 If TYPE is nil or omitted, get the property as a string.
5443 Otherwise TYPE is the name of the atom that denotes the type expected.
5444 If SOURCE is non-nil, get the property on that window instead of from
5445 FRAME. The number 0 denotes the root window.
5446 If DELETE-P is non-nil, delete the property after retrieving it.
5447 If VECTOR-RET-P is non-nil, don't return a string but a vector of values.
5449 On MS Windows, this function accepts but ignores those optional arguments.
5451 Value is nil if FRAME hasn't a property with name PROP or if PROP has
5452 no value of TYPE (always string in the MS Windows case). */)
5453 (Lisp_Object prop, Lisp_Object frame, Lisp_Object type,
5454 Lisp_Object source, Lisp_Object delete_p, Lisp_Object vector_ret_p)
5456 struct frame *f = decode_window_system_frame (frame);
5457 Atom prop_atom;
5458 int rc;
5459 Lisp_Object prop_value = Qnil;
5460 char *tmp_data = NULL;
5461 Atom actual_type;
5462 int actual_format;
5463 unsigned long actual_size, bytes_remaining;
5465 CHECK_STRING (prop);
5466 block_input ();
5467 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5468 rc = XGetWindowProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5469 prop_atom, 0, 0, False, XA_STRING,
5470 &actual_type, &actual_format, &actual_size,
5471 &bytes_remaining, (unsigned char **) &tmp_data);
5472 if (rc == Success)
5474 int size = bytes_remaining;
5476 XFree (tmp_data);
5477 tmp_data = NULL;
5479 rc = XGetWindowProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5480 prop_atom, 0, bytes_remaining,
5481 False, XA_STRING,
5482 &actual_type, &actual_format,
5483 &actual_size, &bytes_remaining,
5484 (unsigned char **) &tmp_data);
5485 if (rc == Success)
5486 prop_value = make_string (tmp_data, size);
5488 XFree (tmp_data);
5491 unblock_input ();
5493 return prop_value;
5495 return Qnil;
5498 #endif /* TODO */
5501 /***********************************************************************
5502 Busy cursor
5503 ***********************************************************************/
5505 void
5506 w32_note_current_window (void)
5508 struct frame * f = SELECTED_FRAME ();
5510 if (!FRAME_W32_P (f))
5511 return;
5513 hourglass_hwnd = FRAME_W32_WINDOW (f);
5516 void
5517 show_hourglass (struct atimer *timer)
5519 struct frame *f;
5521 hourglass_atimer = NULL;
5523 block_input ();
5524 f = x_window_to_frame (&one_w32_display_info,
5525 hourglass_hwnd);
5527 if (f)
5528 f->output_data.w32->hourglass_p = 0;
5529 else
5530 f = SELECTED_FRAME ();
5532 if (!FRAME_W32_P (f))
5534 unblock_input ();
5535 return;
5538 w32_show_hourglass (f);
5539 unblock_input ();
5542 void
5543 hide_hourglass (void)
5545 block_input ();
5546 w32_hide_hourglass ();
5547 unblock_input ();
5551 /* Display an hourglass cursor. Set the hourglass_p flag in display info
5552 to indicate that an hourglass cursor is shown. */
5554 static void
5555 w32_show_hourglass (struct frame *f)
5557 if (!hourglass_shown_p)
5559 f->output_data.w32->hourglass_p = 1;
5560 if (!menubar_in_use && !current_popup_menu)
5561 SetCursor (f->output_data.w32->hourglass_cursor);
5562 hourglass_shown_p = 1;
5567 /* Hide the hourglass cursor on all frames, if it is currently shown. */
5569 static void
5570 w32_hide_hourglass (void)
5572 if (hourglass_shown_p)
5574 struct frame *f = x_window_to_frame (&one_w32_display_info,
5575 hourglass_hwnd);
5576 if (f)
5577 f->output_data.w32->hourglass_p = 0;
5578 else
5579 /* If frame was deleted, restore to selected frame's cursor. */
5580 f = SELECTED_FRAME ();
5582 if (FRAME_W32_P (f))
5583 SetCursor (f->output_data.w32->current_cursor);
5584 else
5585 /* No cursors on non GUI frames - restore to stock arrow cursor. */
5586 SetCursor (w32_load_cursor (IDC_ARROW));
5588 hourglass_shown_p = 0;
5594 /***********************************************************************
5595 Tool tips
5596 ***********************************************************************/
5598 static Lisp_Object x_create_tip_frame (struct w32_display_info *,
5599 Lisp_Object, Lisp_Object);
5600 static void compute_tip_xy (struct frame *, Lisp_Object, Lisp_Object,
5601 Lisp_Object, int, int, int *, int *);
5603 /* The frame of a currently visible tooltip. */
5605 Lisp_Object tip_frame;
5607 /* If non-nil, a timer started that hides the last tooltip when it
5608 fires. */
5610 Lisp_Object tip_timer;
5611 Window tip_window;
5613 /* If non-nil, a vector of 3 elements containing the last args
5614 with which x-show-tip was called. See there. */
5616 Lisp_Object last_show_tip_args;
5619 static void
5620 unwind_create_tip_frame (Lisp_Object frame)
5622 Lisp_Object deleted;
5624 deleted = unwind_create_frame (frame);
5625 if (EQ (deleted, Qt))
5627 tip_window = NULL;
5628 tip_frame = Qnil;
5633 /* Create a frame for a tooltip on the display described by DPYINFO.
5634 PARMS is a list of frame parameters. TEXT is the string to
5635 display in the tip frame. Value is the frame.
5637 Note that functions called here, esp. x_default_parameter can
5638 signal errors, for instance when a specified color name is
5639 undefined. We have to make sure that we're in a consistent state
5640 when this happens. */
5642 static Lisp_Object
5643 x_create_tip_frame (struct w32_display_info *dpyinfo,
5644 Lisp_Object parms, Lisp_Object text)
5646 struct frame *f;
5647 Lisp_Object frame;
5648 Lisp_Object name;
5649 long window_prompting = 0;
5650 int width, height;
5651 ptrdiff_t count = SPECPDL_INDEX ();
5652 struct gcpro gcpro1, gcpro2, gcpro3;
5653 struct kboard *kb;
5654 int face_change_count_before = face_change_count;
5655 Lisp_Object buffer;
5656 struct buffer *old_buffer;
5658 /* Use this general default value to start with until we know if
5659 this frame has a specified name. */
5660 Vx_resource_name = Vinvocation_name;
5662 kb = dpyinfo->terminal->kboard;
5664 /* The calls to x_get_arg remove elements from PARMS, so copy it to
5665 avoid destructive changes behind our caller's back. */
5666 parms = Fcopy_alist (parms);
5668 /* Get the name of the frame to use for resource lookup. */
5669 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
5670 if (!STRINGP (name)
5671 && !EQ (name, Qunbound)
5672 && !NILP (name))
5673 error ("Invalid frame name--not a string or nil");
5674 Vx_resource_name = name;
5676 frame = Qnil;
5677 GCPRO3 (parms, name, frame);
5678 /* Make a frame without minibuffer nor mode-line. */
5679 f = make_frame (0);
5680 f->wants_modeline = 0;
5681 XSETFRAME (frame, f);
5683 buffer = Fget_buffer_create (build_string (" *tip*"));
5684 /* Use set_window_buffer instead of Fset_window_buffer (see
5685 discussion of bug#11984, bug#12025, bug#12026). */
5686 set_window_buffer (FRAME_ROOT_WINDOW (f), buffer, 0, 0);
5687 old_buffer = current_buffer;
5688 set_buffer_internal_1 (XBUFFER (buffer));
5689 bset_truncate_lines (current_buffer, Qnil);
5690 specbind (Qinhibit_read_only, Qt);
5691 specbind (Qinhibit_modification_hooks, Qt);
5692 Ferase_buffer ();
5693 Finsert (1, &text);
5694 set_buffer_internal_1 (old_buffer);
5696 record_unwind_protect (unwind_create_tip_frame, frame);
5698 /* By setting the output method, we're essentially saying that
5699 the frame is live, as per FRAME_LIVE_P. If we get a signal
5700 from this point on, x_destroy_window might screw up reference
5701 counts etc. */
5702 f->terminal = dpyinfo->terminal;
5703 f->output_method = output_w32;
5704 f->output_data.w32 = xzalloc (sizeof (struct w32_output));
5706 FRAME_FONTSET (f) = -1;
5707 fset_icon_name (f, Qnil);
5709 #ifdef GLYPH_DEBUG
5710 image_cache_refcount =
5711 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
5712 dpyinfo_refcount = dpyinfo->reference_count;
5713 #endif /* GLYPH_DEBUG */
5714 FRAME_KBOARD (f) = kb;
5715 f->output_data.w32->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
5716 f->output_data.w32->explicit_parent = 0;
5718 /* Set the name; the functions to which we pass f expect the name to
5719 be set. */
5720 if (EQ (name, Qunbound) || NILP (name))
5722 fset_name (f, build_string (dpyinfo->w32_id_name));
5723 f->explicit_name = 0;
5725 else
5727 fset_name (f, name);
5728 f->explicit_name = 1;
5729 /* use the frame's title when getting resources for this frame. */
5730 specbind (Qx_resource_name, name);
5733 if (uniscribe_available)
5734 register_font_driver (&uniscribe_font_driver, f);
5735 register_font_driver (&w32font_driver, f);
5737 x_default_parameter (f, parms, Qfont_backend, Qnil,
5738 "fontBackend", "FontBackend", RES_TYPE_STRING);
5740 /* Extract the window parameters from the supplied values
5741 that are needed to determine window geometry. */
5742 x_default_font_parameter (f, parms);
5744 x_default_parameter (f, parms, Qborder_width, make_number (2),
5745 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
5746 /* This defaults to 2 in order to match xterm. We recognize either
5747 internalBorderWidth or internalBorder (which is what xterm calls
5748 it). */
5749 if (NILP (Fassq (Qinternal_border_width, parms)))
5751 Lisp_Object value;
5753 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
5754 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
5755 if (! EQ (value, Qunbound))
5756 parms = Fcons (Fcons (Qinternal_border_width, value),
5757 parms);
5759 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
5760 "internalBorderWidth", "internalBorderWidth",
5761 RES_TYPE_NUMBER);
5762 x_default_parameter (f, parms, Qright_divider_width, make_number (0),
5763 NULL, NULL, RES_TYPE_NUMBER);
5764 x_default_parameter (f, parms, Qbottom_divider_width, make_number (0),
5765 NULL, NULL, RES_TYPE_NUMBER);
5767 /* Also do the stuff which must be set before the window exists. */
5768 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
5769 "foreground", "Foreground", RES_TYPE_STRING);
5770 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
5771 "background", "Background", RES_TYPE_STRING);
5772 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
5773 "pointerColor", "Foreground", RES_TYPE_STRING);
5774 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
5775 "cursorColor", "Foreground", RES_TYPE_STRING);
5776 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
5777 "borderColor", "BorderColor", RES_TYPE_STRING);
5779 /* Init faces before x_default_parameter is called for scroll-bar
5780 parameters because that function calls x_set_scroll_bar_width,
5781 which calls change_frame_size, which calls Fset_window_buffer,
5782 which runs hooks, which call Fvertical_motion. At the end, we
5783 end up in init_iterator with a null face cache, which should not
5784 happen. */
5785 init_frame_faces (f);
5787 f->output_data.w32->dwStyle = WS_BORDER | WS_POPUP | WS_DISABLED;
5788 f->output_data.w32->parent_desc = FRAME_DISPLAY_INFO (f)->root_window;
5790 window_prompting = x_figure_window_size (f, parms, 0);
5792 /* No fringes on tip frame. */
5793 f->fringe_cols = 0;
5794 f->left_fringe_width = 0;
5795 f->right_fringe_width = 0;
5797 block_input ();
5798 my_create_tip_window (f);
5799 unblock_input ();
5801 x_make_gc (f);
5803 x_default_parameter (f, parms, Qauto_raise, Qnil,
5804 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5805 x_default_parameter (f, parms, Qauto_lower, Qnil,
5806 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5807 x_default_parameter (f, parms, Qcursor_type, Qbox,
5808 "cursorType", "CursorType", RES_TYPE_SYMBOL);
5810 /* Dimensions, especially FRAME_LINES (f), must be done via
5811 change_frame_size. Change will not be effected unless different
5812 from the current FRAME_LINES (f). */
5813 width = FRAME_COLS (f);
5814 height = FRAME_LINES (f);
5815 FRAME_LINES (f) = 0;
5816 SET_FRAME_COLS (f, 0);
5817 change_frame_size (f, width, height, 1, 0, 0, 0);
5819 /* Add `tooltip' frame parameter's default value. */
5820 if (NILP (Fframe_parameter (frame, Qtooltip)))
5821 Fmodify_frame_parameters (frame, Fcons (Fcons (Qtooltip, Qt), Qnil));
5823 /* Set up faces after all frame parameters are known. This call
5824 also merges in face attributes specified for new frames.
5826 Frame parameters may be changed if .Xdefaults contains
5827 specifications for the default font. For example, if there is an
5828 `Emacs.default.attributeBackground: pink', the `background-color'
5829 attribute of the frame get's set, which let's the internal border
5830 of the tooltip frame appear in pink. Prevent this. */
5832 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
5833 Lisp_Object fg = Fframe_parameter (frame, Qforeground_color);
5834 Lisp_Object colors = Qnil;
5836 /* Set tip_frame here, so that */
5837 tip_frame = frame;
5838 call2 (Qface_set_after_frame_default, frame, Qnil);
5840 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
5841 colors = Fcons (Fcons (Qbackground_color, bg), colors);
5842 if (!EQ (fg, Fframe_parameter (frame, Qforeground_color)))
5843 colors = Fcons (Fcons (Qforeground_color, fg), colors);
5845 if (!NILP (colors))
5846 Fmodify_frame_parameters (frame, colors);
5849 f->no_split = 1;
5851 UNGCPRO;
5853 /* Now that the frame is official, it counts as a reference to
5854 its display. */
5855 FRAME_DISPLAY_INFO (f)->reference_count++;
5856 f->terminal->reference_count++;
5858 /* It is now ok to make the frame official even if we get an error
5859 below. And the frame needs to be on Vframe_list or making it
5860 visible won't work. */
5861 Vframe_list = Fcons (frame, Vframe_list);
5863 /* Setting attributes of faces of the tooltip frame from resources
5864 and similar will increment face_change_count, which leads to the
5865 clearing of all current matrices. Since this isn't necessary
5866 here, avoid it by resetting face_change_count to the value it
5867 had before we created the tip frame. */
5868 face_change_count = face_change_count_before;
5870 /* Discard the unwind_protect. */
5871 return unbind_to (count, frame);
5875 /* Compute where to display tip frame F. PARMS is the list of frame
5876 parameters for F. DX and DY are specified offsets from the current
5877 location of the mouse. WIDTH and HEIGHT are the width and height
5878 of the tooltip. Return coordinates relative to the root window of
5879 the display in *ROOT_X, and *ROOT_Y. */
5881 static void
5882 compute_tip_xy (struct frame *f,
5883 Lisp_Object parms, Lisp_Object dx, Lisp_Object dy,
5884 int width, int height, int *root_x, int *root_y)
5886 Lisp_Object left, top;
5887 int min_x, min_y, max_x, max_y;
5889 /* User-specified position? */
5890 left = Fcdr (Fassq (Qleft, parms));
5891 top = Fcdr (Fassq (Qtop, parms));
5893 /* Move the tooltip window where the mouse pointer is. Resize and
5894 show it. */
5895 if (!INTEGERP (left) || !INTEGERP (top))
5897 POINT pt;
5899 /* Default min and max values. */
5900 min_x = 0;
5901 min_y = 0;
5902 max_x = x_display_pixel_width (FRAME_DISPLAY_INFO (f));
5903 max_y = x_display_pixel_height (FRAME_DISPLAY_INFO (f));
5905 block_input ();
5906 GetCursorPos (&pt);
5907 *root_x = pt.x;
5908 *root_y = pt.y;
5909 unblock_input ();
5911 /* If multiple monitor support is available, constrain the tip onto
5912 the current monitor. This improves the above by allowing negative
5913 co-ordinates if monitor positions are such that they are valid, and
5914 snaps a tooltip onto a single monitor if we are close to the edge
5915 where it would otherwise flow onto the other monitor (or into
5916 nothingness if there is a gap in the overlap). */
5917 if (monitor_from_point_fn && get_monitor_info_fn)
5919 struct MONITOR_INFO info;
5920 HMONITOR monitor
5921 = monitor_from_point_fn (pt, MONITOR_DEFAULT_TO_NEAREST);
5922 info.cbSize = sizeof (info);
5924 if (get_monitor_info_fn (monitor, &info))
5926 min_x = info.rcWork.left;
5927 min_y = info.rcWork.top;
5928 max_x = info.rcWork.right;
5929 max_y = info.rcWork.bottom;
5934 if (INTEGERP (top))
5935 *root_y = XINT (top);
5936 else if (*root_y + XINT (dy) <= min_y)
5937 *root_y = min_y; /* Can happen for negative dy */
5938 else if (*root_y + XINT (dy) + height <= max_y)
5939 /* It fits below the pointer */
5940 *root_y += XINT (dy);
5941 else if (height + XINT (dy) + min_y <= *root_y)
5942 /* It fits above the pointer. */
5943 *root_y -= height + XINT (dy);
5944 else
5945 /* Put it on the top. */
5946 *root_y = min_y;
5948 if (INTEGERP (left))
5949 *root_x = XINT (left);
5950 else if (*root_x + XINT (dx) <= min_x)
5951 *root_x = 0; /* Can happen for negative dx */
5952 else if (*root_x + XINT (dx) + width <= max_x)
5953 /* It fits to the right of the pointer. */
5954 *root_x += XINT (dx);
5955 else if (width + XINT (dx) + min_x <= *root_x)
5956 /* It fits to the left of the pointer. */
5957 *root_x -= width + XINT (dx);
5958 else
5959 /* Put it left justified on the screen -- it ought to fit that way. */
5960 *root_x = min_x;
5964 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
5965 doc: /* Show STRING in a \"tooltip\" window on frame FRAME.
5966 A tooltip window is a small window displaying a string.
5968 This is an internal function; Lisp code should call `tooltip-show'.
5970 FRAME nil or omitted means use the selected frame.
5972 PARMS is an optional list of frame parameters which can be
5973 used to change the tooltip's appearance.
5975 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
5976 means use the default timeout of 5 seconds.
5978 If the list of frame parameters PARMS contains a `left' parameter,
5979 the tooltip is displayed at that x-position. Otherwise it is
5980 displayed at the mouse position, with offset DX added (default is 5 if
5981 DX isn't specified). Likewise for the y-position; if a `top' frame
5982 parameter is specified, it determines the y-position of the tooltip
5983 window, otherwise it is displayed at the mouse position, with offset
5984 DY added (default is -10).
5986 A tooltip's maximum size is specified by `x-max-tooltip-size'.
5987 Text larger than the specified size is clipped. */)
5988 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
5990 struct frame *f;
5991 struct window *w;
5992 int root_x, root_y;
5993 struct buffer *old_buffer;
5994 struct text_pos pos;
5995 int i, width, height, seen_reversed_p;
5996 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
5997 int old_windows_or_buffers_changed = windows_or_buffers_changed;
5998 ptrdiff_t count = SPECPDL_INDEX ();
6000 specbind (Qinhibit_redisplay, Qt);
6002 GCPRO4 (string, parms, frame, timeout);
6004 CHECK_STRING (string);
6005 f = decode_window_system_frame (frame);
6006 if (NILP (timeout))
6007 timeout = make_number (5);
6008 else
6009 CHECK_NATNUM (timeout);
6011 if (NILP (dx))
6012 dx = make_number (5);
6013 else
6014 CHECK_NUMBER (dx);
6016 if (NILP (dy))
6017 dy = make_number (-10);
6018 else
6019 CHECK_NUMBER (dy);
6021 if (NILP (last_show_tip_args))
6022 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
6024 if (!NILP (tip_frame))
6026 Lisp_Object last_string = AREF (last_show_tip_args, 0);
6027 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
6028 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
6030 if (EQ (frame, last_frame)
6031 && !NILP (Fequal (last_string, string))
6032 && !NILP (Fequal (last_parms, parms)))
6034 struct frame *f = XFRAME (tip_frame);
6036 /* Only DX and DY have changed. */
6037 if (!NILP (tip_timer))
6039 Lisp_Object timer = tip_timer;
6040 tip_timer = Qnil;
6041 call1 (Qcancel_timer, timer);
6044 block_input ();
6045 compute_tip_xy (f, parms, dx, dy, FRAME_PIXEL_WIDTH (f),
6046 FRAME_PIXEL_HEIGHT (f), &root_x, &root_y);
6048 /* Put tooltip in topmost group and in position. */
6049 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOPMOST,
6050 root_x, root_y, 0, 0,
6051 SWP_NOSIZE | SWP_NOACTIVATE | SWP_NOOWNERZORDER);
6053 /* Ensure tooltip is on top of other topmost windows (eg menus). */
6054 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOP,
6055 0, 0, 0, 0,
6056 SWP_NOMOVE | SWP_NOSIZE
6057 | SWP_NOACTIVATE | SWP_NOOWNERZORDER);
6059 unblock_input ();
6060 goto start_timer;
6064 /* Hide a previous tip, if any. */
6065 Fx_hide_tip ();
6067 ASET (last_show_tip_args, 0, string);
6068 ASET (last_show_tip_args, 1, frame);
6069 ASET (last_show_tip_args, 2, parms);
6071 /* Add default values to frame parameters. */
6072 if (NILP (Fassq (Qname, parms)))
6073 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
6074 if (NILP (Fassq (Qinternal_border_width, parms)))
6075 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
6076 if (NILP (Fassq (Qright_divider_width, parms)))
6077 parms = Fcons (Fcons (Qright_divider_width, make_number (0)), parms);
6078 if (NILP (Fassq (Qbottom_divider_width, parms)))
6079 parms = Fcons (Fcons (Qbottom_divider_width, make_number (0)), parms);
6080 if (NILP (Fassq (Qborder_width, parms)))
6081 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
6082 if (NILP (Fassq (Qborder_color, parms)))
6083 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
6084 if (NILP (Fassq (Qbackground_color, parms)))
6085 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
6086 parms);
6088 /* Block input until the tip has been fully drawn, to avoid crashes
6089 when drawing tips in menus. */
6090 block_input ();
6092 /* Create a frame for the tooltip, and record it in the global
6093 variable tip_frame. */
6094 frame = x_create_tip_frame (FRAME_DISPLAY_INFO (f), parms, string);
6095 f = XFRAME (frame);
6097 /* Set up the frame's root window. */
6098 w = XWINDOW (FRAME_ROOT_WINDOW (f));
6099 w->left_col = 0;
6100 w->top_line = 0;
6101 w->pixel_left = 0;
6102 w->pixel_top = 0;
6104 if (CONSP (Vx_max_tooltip_size)
6105 && INTEGERP (XCAR (Vx_max_tooltip_size))
6106 && XINT (XCAR (Vx_max_tooltip_size)) > 0
6107 && INTEGERP (XCDR (Vx_max_tooltip_size))
6108 && XINT (XCDR (Vx_max_tooltip_size)) > 0)
6110 w->total_cols = XFASTINT (XCAR (Vx_max_tooltip_size));
6111 w->total_lines = XFASTINT (XCDR (Vx_max_tooltip_size));
6113 else
6115 w->total_cols = 80;
6116 w->total_lines = 40;
6119 w->pixel_width = w->total_cols * FRAME_COLUMN_WIDTH (f);
6120 w->pixel_height = w->total_lines * FRAME_LINE_HEIGHT (f);
6122 FRAME_TOTAL_COLS (f) = WINDOW_TOTAL_COLS (w);
6123 adjust_frame_glyphs (f);
6124 w->pseudo_window_p = 1;
6126 /* Display the tooltip text in a temporary buffer. */
6127 old_buffer = current_buffer;
6128 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->contents));
6129 bset_truncate_lines (current_buffer, Qnil);
6130 clear_glyph_matrix (w->desired_matrix);
6131 clear_glyph_matrix (w->current_matrix);
6132 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
6133 try_window (FRAME_ROOT_WINDOW (f), pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
6135 /* Compute width and height of the tooltip. */
6136 width = height = seen_reversed_p = 0;
6137 for (i = 0; i < w->desired_matrix->nrows; ++i)
6139 struct glyph_row *row = &w->desired_matrix->rows[i];
6140 struct glyph *last;
6141 int row_width;
6143 /* Stop at the first empty row at the end. */
6144 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
6145 break;
6147 /* Let the row go over the full width of the frame. */
6148 row->full_width_p = 1;
6150 row_width = row->pixel_width;
6151 if (row->used[TEXT_AREA])
6153 if (!row->reversed_p)
6155 /* There's a glyph at the end of rows that is used to
6156 place the cursor there. Don't include the width of
6157 this glyph. */
6158 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
6159 if (INTEGERP (last->object))
6160 row_width -= last->pixel_width;
6162 else
6164 /* There could be a stretch glyph at the beginning of R2L
6165 rows that is produced by extend_face_to_end_of_line.
6166 Don't count that glyph. */
6167 struct glyph *g = row->glyphs[TEXT_AREA];
6169 if (g->type == STRETCH_GLYPH && INTEGERP (g->object))
6171 row_width -= g->pixel_width;
6172 seen_reversed_p = 1;
6177 height += row->height;
6178 width = max (width, row_width);
6181 /* If we've seen partial-length R2L rows, we need to re-adjust the
6182 tool-tip frame width and redisplay it again, to avoid over-wide
6183 tips due to the stretch glyph that extends R2L lines to full
6184 width of the frame. */
6185 if (seen_reversed_p)
6187 /* PXW: Why do we do the pixel-to-cols conversion only if
6188 seen_reversed_p holds? Don't we have to set other fields of
6189 the window/frame structure?
6191 w->total_cols and FRAME_TOTAL_COLS want the width in columns,
6192 not in pixels. */
6193 w->pixel_width = width;
6194 width /= WINDOW_FRAME_COLUMN_WIDTH (w);
6195 w->total_cols = width;
6196 FRAME_TOTAL_COLS (f) = width;
6197 SET_FRAME_WIDTH (f, width);
6198 adjust_frame_glyphs (f);
6199 w->pseudo_window_p = 1;
6200 clear_glyph_matrix (w->desired_matrix);
6201 clear_glyph_matrix (w->current_matrix);
6202 try_window (FRAME_ROOT_WINDOW (f), pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
6203 width = height = 0;
6204 /* Recompute width and height of the tooltip. */
6205 for (i = 0; i < w->desired_matrix->nrows; ++i)
6207 struct glyph_row *row = &w->desired_matrix->rows[i];
6208 struct glyph *last;
6209 int row_width;
6211 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
6212 break;
6213 row->full_width_p = 1;
6214 row_width = row->pixel_width;
6215 if (row->used[TEXT_AREA] && !row->reversed_p)
6217 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
6218 if (INTEGERP (last->object))
6219 row_width -= last->pixel_width;
6222 height += row->height;
6223 width = max (width, row_width);
6227 /* Add the frame's internal border to the width and height the w32
6228 window should have. */
6229 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
6230 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
6232 /* Move the tooltip window where the mouse pointer is. Resize and
6233 show it.
6235 PXW: This should use the frame's pixel coordinates. */
6236 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
6239 /* Adjust Window size to take border into account. */
6240 RECT rect;
6241 rect.left = rect.top = 0;
6242 rect.right = width;
6243 rect.bottom = height;
6244 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
6245 FRAME_EXTERNAL_MENU_BAR (f));
6247 /* Position and size tooltip, and put it in the topmost group.
6248 The add-on of FRAME_COLUMN_WIDTH to the 5th argument is a
6249 peculiarity of w32 display: without it, some fonts cause the
6250 last character of the tip to be truncated or wrapped around to
6251 the next line. */
6252 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOPMOST,
6253 root_x, root_y,
6254 rect.right - rect.left + FRAME_COLUMN_WIDTH (f),
6255 rect.bottom - rect.top, SWP_NOACTIVATE | SWP_NOOWNERZORDER);
6257 /* Ensure tooltip is on top of other topmost windows (eg menus). */
6258 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOP,
6259 0, 0, 0, 0,
6260 SWP_NOMOVE | SWP_NOSIZE
6261 | SWP_NOACTIVATE | SWP_NOOWNERZORDER);
6263 /* Let redisplay know that we have made the frame visible already. */
6264 SET_FRAME_VISIBLE (f, 1);
6266 ShowWindow (FRAME_W32_WINDOW (f), SW_SHOWNOACTIVATE);
6269 /* Draw into the window. */
6270 w->must_be_updated_p = 1;
6271 update_single_window (w, 1);
6273 unblock_input ();
6275 /* Restore original current buffer. */
6276 set_buffer_internal_1 (old_buffer);
6277 windows_or_buffers_changed = old_windows_or_buffers_changed;
6279 start_timer:
6280 /* Let the tip disappear after timeout seconds. */
6281 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
6282 intern ("x-hide-tip"));
6284 UNGCPRO;
6285 return unbind_to (count, Qnil);
6289 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
6290 doc: /* Hide the current tooltip window, if there is any.
6291 Value is t if tooltip was open, nil otherwise. */)
6292 (void)
6294 ptrdiff_t count;
6295 Lisp_Object deleted, frame, timer;
6296 struct gcpro gcpro1, gcpro2;
6298 /* Return quickly if nothing to do. */
6299 if (NILP (tip_timer) && NILP (tip_frame))
6300 return Qnil;
6302 frame = tip_frame;
6303 timer = tip_timer;
6304 GCPRO2 (frame, timer);
6305 tip_frame = tip_timer = deleted = Qnil;
6307 count = SPECPDL_INDEX ();
6308 specbind (Qinhibit_redisplay, Qt);
6309 specbind (Qinhibit_quit, Qt);
6311 if (!NILP (timer))
6312 call1 (Qcancel_timer, timer);
6314 if (FRAMEP (frame))
6316 delete_frame (frame, Qnil);
6317 deleted = Qt;
6320 UNGCPRO;
6321 return unbind_to (count, deleted);
6324 /***********************************************************************
6325 File selection dialog
6326 ***********************************************************************/
6328 #define FILE_NAME_TEXT_FIELD edt1
6329 #define FILE_NAME_COMBO_BOX cmb13
6330 #define FILE_NAME_LIST lst1
6332 /* Callback for altering the behavior of the Open File dialog.
6333 Makes the Filename text field contain "Current Directory" and be
6334 read-only when "Directories" is selected in the filter. This
6335 allows us to work around the fact that the standard Open File
6336 dialog does not support directories. */
6337 static UINT_PTR CALLBACK
6338 file_dialog_callback (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
6340 if (msg == WM_NOTIFY)
6342 OFNOTIFYW * notify_w = (OFNOTIFYW *)lParam;
6343 OFNOTIFYA * notify_a = (OFNOTIFYA *)lParam;
6344 int dropdown_changed;
6345 int dir_index;
6346 #ifdef NTGUI_UNICODE
6347 const int use_unicode = 1;
6348 #else /* !NTGUI_UNICODE */
6349 int use_unicode = w32_unicode_filenames;
6350 #endif /* NTGUI_UNICODE */
6352 /* Detect when the Filter dropdown is changed. */
6353 if (use_unicode)
6354 dropdown_changed =
6355 notify_w->hdr.code == CDN_TYPECHANGE
6356 || notify_w->hdr.code == CDN_INITDONE;
6357 else
6358 dropdown_changed =
6359 notify_a->hdr.code == CDN_TYPECHANGE
6360 || notify_a->hdr.code == CDN_INITDONE;
6361 if (dropdown_changed)
6363 HWND dialog = GetParent (hwnd);
6364 HWND edit_control = GetDlgItem (dialog, FILE_NAME_TEXT_FIELD);
6365 HWND list = GetDlgItem (dialog, FILE_NAME_LIST);
6366 int hdr_code;
6368 /* At least on Windows 7, the above attempt to get the window handle
6369 to the File Name Text Field fails. The following code does the
6370 job though. Note that this code is based on my examination of the
6371 window hierarchy using Microsoft Spy++. bk */
6372 if (edit_control == NULL)
6374 HWND tmp = GetDlgItem (dialog, FILE_NAME_COMBO_BOX);
6375 if (tmp)
6377 tmp = GetWindow (tmp, GW_CHILD);
6378 if (tmp)
6379 edit_control = GetWindow (tmp, GW_CHILD);
6383 /* Directories is in index 2. */
6384 if (use_unicode)
6386 dir_index = notify_w->lpOFN->nFilterIndex;
6387 hdr_code = notify_w->hdr.code;
6389 else
6391 dir_index = notify_a->lpOFN->nFilterIndex;
6392 hdr_code = notify_a->hdr.code;
6394 if (dir_index == 2)
6396 if (use_unicode)
6397 SendMessageW (dialog, CDM_SETCONTROLTEXT, FILE_NAME_TEXT_FIELD,
6398 (LPARAM)L"Current Directory");
6399 else
6400 SendMessageA (dialog, CDM_SETCONTROLTEXT, FILE_NAME_TEXT_FIELD,
6401 (LPARAM)"Current Directory");
6402 EnableWindow (edit_control, FALSE);
6403 /* Note that at least on Windows 7, the above call to EnableWindow
6404 disables the window that would ordinarily have focus. If we
6405 do not set focus to some other window here, focus will land in
6406 no man's land and the user will be unable to tab through the
6407 dialog box (pressing tab will only result in a beep).
6408 Avoid that problem by setting focus to the list here. */
6409 if (hdr_code == CDN_INITDONE)
6410 SetFocus (list);
6412 else
6414 /* Don't override default filename on init done. */
6415 if (hdr_code == CDN_TYPECHANGE)
6417 if (use_unicode)
6418 SendMessageW (dialog, CDM_SETCONTROLTEXT,
6419 FILE_NAME_TEXT_FIELD, (LPARAM)L"");
6420 else
6421 SendMessageA (dialog, CDM_SETCONTROLTEXT,
6422 FILE_NAME_TEXT_FIELD, (LPARAM)"");
6424 EnableWindow (edit_control, TRUE);
6428 return 0;
6431 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
6432 doc: /* Read file name, prompting with PROMPT in directory DIR.
6433 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
6434 selection box, if specified. If MUSTMATCH is non-nil, the returned file
6435 or directory must exist.
6437 This function is only defined on NS, MS Windows, and X Windows with the
6438 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
6439 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories.
6440 On Windows 7 and later, the file selection dialog "remembers" the last
6441 directory where the user selected a file, and will open that directory
6442 instead of DIR on subsequent invocations of this function with the same
6443 value of DIR as in previous invocations; this is standard Windows behavior. */)
6444 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
6446 /* Filter index: 1: All Files, 2: Directories only */
6447 static const wchar_t filter_w[] = L"All Files (*.*)\0*.*\0Directories\0*|*\0";
6448 static const char filter_a[] = "All Files (*.*)\0*.*\0Directories\0*|*\0";
6450 Lisp_Object filename = default_filename;
6451 struct frame *f = SELECTED_FRAME ();
6452 BOOL file_opened = FALSE;
6453 Lisp_Object orig_dir = dir;
6454 Lisp_Object orig_prompt = prompt;
6456 /* If we compile with _WIN32_WINNT set to 0x0400 (for NT4
6457 compatibility) we end up with the old file dialogs. Define a big
6458 enough struct for the new dialog to trick GetOpenFileName into
6459 giving us the new dialogs on newer versions of Windows. */
6460 struct {
6461 OPENFILENAMEW details;
6462 #if _WIN32_WINNT < 0x500 /* < win2k */
6463 PVOID pvReserved;
6464 DWORD dwReserved;
6465 DWORD FlagsEx;
6466 #endif /* < win2k */
6467 } new_file_details_w;
6469 #ifdef NTGUI_UNICODE
6470 wchar_t filename_buf_w[32*1024 + 1]; // NT kernel maximum
6471 OPENFILENAMEW * file_details_w = &new_file_details_w.details;
6472 const int use_unicode = 1;
6473 #else /* not NTGUI_UNICODE */
6474 struct {
6475 OPENFILENAMEA details;
6476 #if _WIN32_WINNT < 0x500 /* < win2k */
6477 PVOID pvReserved;
6478 DWORD dwReserved;
6479 DWORD FlagsEx;
6480 #endif /* < win2k */
6481 } new_file_details_a;
6482 wchar_t filename_buf_w[MAX_PATH + 1], dir_w[MAX_PATH];
6483 char filename_buf_a[MAX_PATH + 1], dir_a[MAX_PATH];
6484 OPENFILENAMEW * file_details_w = &new_file_details_w.details;
6485 OPENFILENAMEA * file_details_a = &new_file_details_a.details;
6486 int use_unicode = w32_unicode_filenames;
6487 wchar_t *prompt_w;
6488 char *prompt_a;
6489 int len;
6490 char fname_ret[MAX_UTF8_PATH];
6491 #endif /* NTGUI_UNICODE */
6493 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
6494 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, filename);
6497 struct gcpro gcpro1, gcpro2;
6498 GCPRO2 (orig_dir, orig_prompt); /* There is no GCPRON, N>6. */
6500 /* Note: under NTGUI_UNICODE, we do _NOT_ use ENCODE_FILE: the
6501 system file encoding expected by the platform APIs (e.g. Cygwin's
6502 POSIX implementation) may not be the same as the encoding expected
6503 by the Windows "ANSI" APIs! */
6505 CHECK_STRING (prompt);
6506 CHECK_STRING (dir);
6508 dir = Fexpand_file_name (dir, Qnil);
6510 if (STRINGP (filename))
6511 filename = Ffile_name_nondirectory (filename);
6512 else
6513 filename = empty_unibyte_string;
6515 #ifdef CYGWIN
6516 dir = Fcygwin_convert_file_name_to_windows (dir, Qt);
6517 if (SCHARS (filename) > 0)
6518 filename = Fcygwin_convert_file_name_to_windows (filename, Qnil);
6519 #endif
6521 CHECK_STRING (dir);
6522 CHECK_STRING (filename);
6524 /* The code in file_dialog_callback that attempts to set the text
6525 of the file name edit window when handling the CDN_INITDONE
6526 WM_NOTIFY message does not work. Setting filename to "Current
6527 Directory" in the only_dir_p case here does work however. */
6528 if (SCHARS (filename) == 0 && ! NILP (only_dir_p))
6529 filename = build_string ("Current Directory");
6531 /* Convert the values we've computed so far to system form. */
6532 #ifdef NTGUI_UNICODE
6533 to_unicode (prompt, &prompt);
6534 to_unicode (dir, &dir);
6535 to_unicode (filename, &filename);
6536 if (SBYTES (filename) + 1 > sizeof (filename_buf_w))
6537 report_file_error ("filename too long", default_filename);
6539 memcpy (filename_buf_w, SDATA (filename), SBYTES (filename) + 1);
6540 #else /* !NTGUI_UNICODE */
6541 prompt = ENCODE_FILE (prompt);
6542 dir = ENCODE_FILE (dir);
6543 filename = ENCODE_FILE (filename);
6545 /* We modify these in-place, so make copies for safety. */
6546 dir = Fcopy_sequence (dir);
6547 unixtodos_filename (SDATA (dir));
6548 filename = Fcopy_sequence (filename);
6549 unixtodos_filename (SDATA (filename));
6550 if (SBYTES (filename) >= MAX_UTF8_PATH)
6551 report_file_error ("filename too long", default_filename);
6552 if (w32_unicode_filenames)
6554 filename_to_utf16 (SSDATA (dir), dir_w);
6555 if (filename_to_utf16 (SSDATA (filename), filename_buf_w) != 0)
6557 /* filename_to_utf16 sets errno to ENOENT when the file
6558 name is too long or cannot be converted to UTF-16. */
6559 if (errno == ENOENT && filename_buf_w[MAX_PATH - 1] != 0)
6560 report_file_error ("filename too long", default_filename);
6562 len = pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS,
6563 SSDATA (prompt), -1, NULL, 0);
6564 if (len > 32768)
6565 len = 32768;
6566 prompt_w = alloca (len * sizeof (wchar_t));
6567 pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS,
6568 SSDATA (prompt), -1, prompt_w, len);
6570 else
6572 filename_to_ansi (SSDATA (dir), dir_a);
6573 if (filename_to_ansi (SSDATA (filename), filename_buf_a) != '\0')
6575 /* filename_to_ansi sets errno to ENOENT when the file
6576 name is too long or cannot be converted to UTF-16. */
6577 if (errno == ENOENT && filename_buf_a[MAX_PATH - 1] != 0)
6578 report_file_error ("filename too long", default_filename);
6580 len = pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS,
6581 SSDATA (prompt), -1, NULL, 0);
6582 if (len > 32768)
6583 len = 32768;
6584 prompt_w = alloca (len * sizeof (wchar_t));
6585 pMultiByteToWideChar (CP_UTF8, MB_ERR_INVALID_CHARS,
6586 SSDATA (prompt), -1, prompt_w, len);
6587 len = pWideCharToMultiByte (CP_ACP, 0, prompt_w, -1, NULL, 0, NULL, NULL);
6588 if (len > 32768)
6589 len = 32768;
6590 prompt_a = alloca (len);
6591 pWideCharToMultiByte (CP_ACP, 0, prompt_w, -1, prompt_a, len, NULL, NULL);
6593 #endif /* NTGUI_UNICODE */
6595 /* Fill in the structure for the call to GetOpenFileName below.
6596 For NTGUI_UNICODE builds (which run only on NT), we just use
6597 the actual size of the structure. For non-NTGUI_UNICODE
6598 builds, we tell the OS we're using an old version of the
6599 structure if the OS isn't new enough to support the newer
6600 version. */
6601 if (use_unicode)
6603 memset (&new_file_details_w, 0, sizeof (new_file_details_w));
6604 if (w32_major_version > 4 && w32_major_version < 95)
6605 file_details_w->lStructSize = sizeof (new_file_details_w);
6606 else
6607 file_details_w->lStructSize = sizeof (*file_details_w);
6608 /* Set up the inout parameter for the selected file name. */
6609 file_details_w->lpstrFile = filename_buf_w;
6610 file_details_w->nMaxFile =
6611 sizeof (filename_buf_w) / sizeof (*filename_buf_w);
6612 file_details_w->hwndOwner = FRAME_W32_WINDOW (f);
6613 /* Undocumented Bug in Common File Dialog:
6614 If a filter is not specified, shell links are not resolved. */
6615 file_details_w->lpstrFilter = filter_w;
6616 #ifdef NTGUI_UNICODE
6617 file_details_w->lpstrInitialDir = (wchar_t*) SDATA (dir);
6618 file_details_w->lpstrTitle = (guichar_t*) SDATA (prompt);
6619 #else
6620 file_details_w->lpstrInitialDir = dir_w;
6621 file_details_w->lpstrTitle = prompt_w;
6622 #endif
6623 file_details_w->nFilterIndex = NILP (only_dir_p) ? 1 : 2;
6624 file_details_w->Flags = (OFN_HIDEREADONLY | OFN_NOCHANGEDIR
6625 | OFN_EXPLORER | OFN_ENABLEHOOK);
6626 if (!NILP (mustmatch))
6628 /* Require that the path to the parent directory exists. */
6629 file_details_w->Flags |= OFN_PATHMUSTEXIST;
6630 /* If we are looking for a file, require that it exists. */
6631 if (NILP (only_dir_p))
6632 file_details_w->Flags |= OFN_FILEMUSTEXIST;
6635 #ifndef NTGUI_UNICODE
6636 else
6638 memset (&new_file_details_a, 0, sizeof (new_file_details_a));
6639 if (w32_major_version > 4 && w32_major_version < 95)
6640 file_details_a->lStructSize = sizeof (new_file_details_a);
6641 else
6642 file_details_a->lStructSize = sizeof (*file_details_a);
6643 file_details_a->lpstrFile = filename_buf_a;
6644 file_details_a->nMaxFile =
6645 sizeof (filename_buf_a) / sizeof (*filename_buf_a);
6646 file_details_a->hwndOwner = FRAME_W32_WINDOW (f);
6647 file_details_a->lpstrFilter = filter_a;
6648 file_details_a->lpstrInitialDir = dir_a;
6649 file_details_a->lpstrTitle = prompt_a;
6650 file_details_a->nFilterIndex = NILP (only_dir_p) ? 1 : 2;
6651 file_details_a->Flags = (OFN_HIDEREADONLY | OFN_NOCHANGEDIR
6652 | OFN_EXPLORER | OFN_ENABLEHOOK);
6653 if (!NILP (mustmatch))
6655 /* Require that the path to the parent directory exists. */
6656 file_details_a->Flags |= OFN_PATHMUSTEXIST;
6657 /* If we are looking for a file, require that it exists. */
6658 if (NILP (only_dir_p))
6659 file_details_a->Flags |= OFN_FILEMUSTEXIST;
6662 #endif /* !NTGUI_UNICODE */
6665 int count = SPECPDL_INDEX ();
6666 /* Prevent redisplay. */
6667 specbind (Qinhibit_redisplay, Qt);
6668 block_input ();
6669 if (use_unicode)
6671 file_details_w->lpfnHook = file_dialog_callback;
6673 file_opened = GetOpenFileNameW (file_details_w);
6675 #ifndef NTGUI_UNICODE
6676 else
6678 file_details_a->lpfnHook = file_dialog_callback;
6680 file_opened = GetOpenFileNameA (file_details_a);
6682 #endif /* !NTGUI_UNICODE */
6683 unblock_input ();
6684 unbind_to (count, Qnil);
6687 if (file_opened)
6689 /* Get an Emacs string from the value Windows gave us. */
6690 #ifdef NTGUI_UNICODE
6691 filename = from_unicode_buffer (filename_buf_w);
6692 #else /* !NTGUI_UNICODE */
6693 if (use_unicode)
6694 filename_from_utf16 (filename_buf_w, fname_ret);
6695 else
6696 filename_from_ansi (filename_buf_a, fname_ret);
6697 dostounix_filename (fname_ret);
6698 filename = DECODE_FILE (build_unibyte_string (fname_ret));
6699 #endif /* NTGUI_UNICODE */
6701 #ifdef CYGWIN
6702 filename = Fcygwin_convert_file_name_from_windows (filename, Qt);
6703 #endif /* CYGWIN */
6705 /* Strip the dummy filename off the end of the string if we
6706 added it to select a directory. */
6707 if ((use_unicode && file_details_w->nFilterIndex == 2)
6708 #ifndef NTGUI_UNICODE
6709 || (!use_unicode && file_details_a->nFilterIndex == 2)
6710 #endif
6712 filename = Ffile_name_directory (filename);
6714 /* User canceled the dialog without making a selection. */
6715 else if (!CommDlgExtendedError ())
6716 filename = Qnil;
6717 /* An error occurred, fallback on reading from the mini-buffer. */
6718 else
6719 filename = Fcompleting_read (
6720 orig_prompt,
6721 intern ("read-file-name-internal"),
6722 orig_dir,
6723 mustmatch,
6724 orig_dir,
6725 Qfile_name_history,
6726 default_filename,
6727 Qnil);
6729 UNGCPRO;
6732 /* Make "Cancel" equivalent to C-g. */
6733 if (NILP (filename))
6734 Fsignal (Qquit, Qnil);
6736 RETURN_UNGCPRO (filename);
6740 #ifdef WINDOWSNT
6741 /* Moving files to the system recycle bin.
6742 Used by `move-file-to-trash' instead of the default moving to ~/.Trash */
6743 DEFUN ("system-move-file-to-trash", Fsystem_move_file_to_trash,
6744 Ssystem_move_file_to_trash, 1, 1, 0,
6745 doc: /* Move file or directory named FILENAME to the recycle bin. */)
6746 (Lisp_Object filename)
6748 Lisp_Object handler;
6749 Lisp_Object encoded_file;
6750 Lisp_Object operation;
6752 operation = Qdelete_file;
6753 if (!NILP (Ffile_directory_p (filename))
6754 && NILP (Ffile_symlink_p (filename)))
6756 operation = intern ("delete-directory");
6757 filename = Fdirectory_file_name (filename);
6760 /* Must have fully qualified file names for moving files to Recycle
6761 Bin. */
6762 filename = Fexpand_file_name (filename, Qnil);
6764 handler = Ffind_file_name_handler (filename, operation);
6765 if (!NILP (handler))
6766 return call2 (handler, operation, filename);
6767 else
6769 const char * path;
6770 int result;
6772 encoded_file = ENCODE_FILE (filename);
6774 path = map_w32_filename (SDATA (encoded_file), NULL);
6776 /* The Unicode version of SHFileOperation is not supported on
6777 Windows 9X. */
6778 if (w32_unicode_filenames && os_subtype != OS_9X)
6780 SHFILEOPSTRUCTW file_op_w;
6781 /* We need one more element beyond MAX_PATH because this is
6782 a list of file names, with the last element double-null
6783 terminated. */
6784 wchar_t tmp_path_w[MAX_PATH + 1];
6786 memset (tmp_path_w, 0, sizeof (tmp_path_w));
6787 filename_to_utf16 (path, tmp_path_w);
6789 /* On Windows, write permission is required to delete/move files. */
6790 _wchmod (tmp_path_w, 0666);
6792 memset (&file_op_w, 0, sizeof (file_op_w));
6793 file_op_w.hwnd = HWND_DESKTOP;
6794 file_op_w.wFunc = FO_DELETE;
6795 file_op_w.pFrom = tmp_path_w;
6796 file_op_w.fFlags = FOF_SILENT | FOF_NOCONFIRMATION | FOF_ALLOWUNDO
6797 | FOF_NOERRORUI | FOF_NO_CONNECTED_ELEMENTS;
6798 file_op_w.fAnyOperationsAborted = FALSE;
6800 result = SHFileOperationW (&file_op_w);
6802 else
6804 SHFILEOPSTRUCTA file_op_a;
6805 char tmp_path_a[MAX_PATH + 1];
6807 memset (tmp_path_a, 0, sizeof (tmp_path_a));
6808 filename_to_ansi (path, tmp_path_a);
6810 /* If a file cannot be represented in ANSI codepage, don't
6811 let them inadvertently delete other files because some
6812 characters are interpreted as a wildcards. */
6813 if (_mbspbrk (tmp_path_a, "?*"))
6814 result = ERROR_FILE_NOT_FOUND;
6815 else
6817 _chmod (tmp_path_a, 0666);
6819 memset (&file_op_a, 0, sizeof (file_op_a));
6820 file_op_a.hwnd = HWND_DESKTOP;
6821 file_op_a.wFunc = FO_DELETE;
6822 file_op_a.pFrom = tmp_path_a;
6823 file_op_a.fFlags = FOF_SILENT | FOF_NOCONFIRMATION | FOF_ALLOWUNDO
6824 | FOF_NOERRORUI | FOF_NO_CONNECTED_ELEMENTS;
6825 file_op_a.fAnyOperationsAborted = FALSE;
6827 result = SHFileOperationA (&file_op_a);
6830 if (result != 0)
6831 report_file_error ("Removing old name", list1 (filename));
6833 return Qnil;
6836 #endif /* WINDOWSNT */
6839 /***********************************************************************
6840 w32 specialized functions
6841 ***********************************************************************/
6843 DEFUN ("w32-send-sys-command", Fw32_send_sys_command,
6844 Sw32_send_sys_command, 1, 2, 0,
6845 doc: /* Send frame a Windows WM_SYSCOMMAND message of type COMMAND.
6846 Some useful values for COMMAND are #xf030 to maximize frame (#xf020
6847 to minimize), #xf120 to restore frame to original size, and #xf100
6848 to activate the menubar for keyboard access. #xf140 activates the
6849 screen saver if defined.
6851 If optional parameter FRAME is not specified, use selected frame. */)
6852 (Lisp_Object command, Lisp_Object frame)
6854 struct frame *f = decode_window_system_frame (frame);
6856 CHECK_NUMBER (command);
6858 PostMessage (FRAME_W32_WINDOW (f), WM_SYSCOMMAND, XINT (command), 0);
6860 return Qnil;
6863 DEFUN ("w32-shell-execute", Fw32_shell_execute, Sw32_shell_execute, 2, 4, 0,
6864 doc: /* Get Windows to perform OPERATION on DOCUMENT.
6865 This is a wrapper around the ShellExecute system function, which
6866 invokes the application registered to handle OPERATION for DOCUMENT.
6868 OPERATION is either nil or a string that names a supported operation.
6869 What operations can be used depends on the particular DOCUMENT and its
6870 handler application, but typically it is one of the following common
6871 operations:
6873 \"open\" - open DOCUMENT, which could be a file, a directory, or an
6874 executable program (application). If it is an application,
6875 that application is launched in the current buffer's default
6876 directory. Otherwise, the application associated with
6877 DOCUMENT is launched in the buffer's default directory.
6878 \"opennew\" - like \"open\", but instruct the application to open
6879 DOCUMENT in a new window.
6880 \"openas\" - open the \"Open With\" dialog for DOCUMENT.
6881 \"print\" - print DOCUMENT, which must be a file.
6882 \"printto\" - print DOCUMENT, which must be a file, to a specified printer.
6883 The printer should be provided in PARAMETERS, see below.
6884 \"explore\" - start the Windows Explorer on DOCUMENT.
6885 \"edit\" - launch an editor and open DOCUMENT for editing; which
6886 editor is launched depends on the association for the
6887 specified DOCUMENT.
6888 \"find\" - initiate search starting from DOCUMENT, which must specify
6889 a directory.
6890 \"runas\" - run DOCUMENT, which must be an excutable file, with
6891 elevated privileges (a.k.a. \"as Administrator\").
6892 \"properties\"
6893 - open the the property sheet dialog for DOCUMENT; works
6894 for *.lnk desktop shortcuts, and little or nothing else.
6895 nil - invoke the default OPERATION, or \"open\" if default is
6896 not defined or unavailable.
6898 DOCUMENT is typically the name of a document file or a URL, but can
6899 also be an executable program to run, or a directory to open in the
6900 Windows Explorer. If it is a file, it must be a local one; this
6901 function does not support remote file names.
6903 If DOCUMENT is an executable program, the optional third arg PARAMETERS
6904 can be a string containing command line parameters that will be passed
6905 to the program. Some values of OPERATION also require parameters (e.g.,
6906 \"printto\" requires the printer address). Otherwise, PARAMETERS should
6907 be nil or unspecified.
6909 Optional fourth argument SHOW-FLAG can be used to control how the
6910 application will be displayed when it is invoked. If SHOW-FLAG is nil
6911 or unspecified, the application is displayed as if SHOW-FLAG of 10 was
6912 specified, otherwise it is an integer between 0 and 11 representing
6913 a ShowWindow flag:
6915 0 - start hidden
6916 1 - start as normal-size window
6917 3 - start in a maximized window
6918 6 - start in a minimized window
6919 10 - start as the application itself specifies; this is the default. */)
6920 (Lisp_Object operation, Lisp_Object document, Lisp_Object parameters, Lisp_Object show_flag)
6922 char *errstr;
6923 Lisp_Object current_dir = BVAR (current_buffer, directory);;
6924 wchar_t *doc_w = NULL, *params_w = NULL, *ops_w = NULL;
6925 intptr_t result;
6926 #ifndef CYGWIN
6927 int use_unicode = w32_unicode_filenames;
6928 char *doc_a = NULL, *params_a = NULL, *ops_a = NULL;
6929 Lisp_Object absdoc, handler;
6930 struct gcpro gcpro1;
6931 #endif
6933 CHECK_STRING (document);
6935 #ifdef CYGWIN
6936 current_dir = Fcygwin_convert_file_name_to_windows (current_dir, Qt);
6937 document = Fcygwin_convert_file_name_to_windows (document, Qt);
6939 /* Encode filename, current directory and parameters. */
6940 current_dir = GUI_ENCODE_FILE (current_dir);
6941 document = GUI_ENCODE_FILE (document);
6942 doc_w = GUI_SDATA (document);
6943 if (STRINGP (parameters))
6945 parameters = GUI_ENCODE_SYSTEM (parameters);
6946 params_w = GUI_SDATA (parameters);
6948 if (STRINGP (operation))
6950 operation = GUI_ENCODE_SYSTEM (operation);
6951 ops_w = GUI_SDATA (operation);
6953 result = (intptr_t) ShellExecuteW (NULL, ops_w, doc_w, params_w,
6954 GUI_SDATA (current_dir),
6955 (INTEGERP (show_flag)
6956 ? XINT (show_flag) : SW_SHOWDEFAULT));
6957 #else /* !CYGWIN */
6958 current_dir = ENCODE_FILE (current_dir);
6959 /* We have a situation here. If DOCUMENT is a relative file name,
6960 but its name includes leading directories, i.e. it lives not in
6961 CURRENT_DIR, but in its subdirectory, then ShellExecute below
6962 will fail to find it. So we need to make the file name is
6963 absolute. But DOCUMENT does not have to be a file, it can be a
6964 URL, for example. So we make it absolute only if it is an
6965 existing file; if it is a file that does not exist, tough. */
6966 GCPRO1 (absdoc);
6967 absdoc = Fexpand_file_name (document, Qnil);
6968 /* Don't call file handlers for file-exists-p, since they might
6969 attempt to access the file, which could fail or produce undesired
6970 consequences, see bug#16558 for an example. */
6971 handler = Ffind_file_name_handler (absdoc, Qfile_exists_p);
6972 if (NILP (handler))
6974 Lisp_Object absdoc_encoded = ENCODE_FILE (absdoc);
6976 if (faccessat (AT_FDCWD, SSDATA (absdoc_encoded), F_OK, AT_EACCESS) == 0)
6977 document = absdoc_encoded;
6978 else
6979 document = ENCODE_FILE (document);
6981 else
6982 document = ENCODE_FILE (document);
6983 UNGCPRO;
6984 if (use_unicode)
6986 wchar_t document_w[MAX_PATH], current_dir_w[MAX_PATH];
6988 /* Encode filename, current directory and parameters, and
6989 convert operation to UTF-16. */
6990 filename_to_utf16 (SSDATA (current_dir), current_dir_w);
6991 filename_to_utf16 (SSDATA (document), document_w);
6992 doc_w = document_w;
6993 if (STRINGP (parameters))
6995 int len;
6997 parameters = ENCODE_SYSTEM (parameters);
6998 len = pMultiByteToWideChar (CP_ACP, MB_ERR_INVALID_CHARS,
6999 SSDATA (parameters), -1, NULL, 0);
7000 if (len > 32768)
7001 len = 32768;
7002 params_w = alloca (len * sizeof (wchar_t));
7003 pMultiByteToWideChar (CP_ACP, MB_ERR_INVALID_CHARS,
7004 SSDATA (parameters), -1, params_w, len);
7006 if (STRINGP (operation))
7008 /* Assume OPERATION is pure ASCII. */
7009 const char *s = SSDATA (operation);
7010 wchar_t *d;
7011 int len = SBYTES (operation) + 1;
7013 if (len > 32768)
7014 len = 32768;
7015 d = ops_w = alloca (len * sizeof (wchar_t));
7016 while (d < ops_w + len - 1)
7017 *d++ = *s++;
7018 *d = 0;
7020 result = (intptr_t) ShellExecuteW (NULL, ops_w, doc_w, params_w,
7021 current_dir_w,
7022 (INTEGERP (show_flag)
7023 ? XINT (show_flag) : SW_SHOWDEFAULT));
7025 else
7027 char document_a[MAX_PATH], current_dir_a[MAX_PATH];
7029 filename_to_ansi (SSDATA (current_dir), current_dir_a);
7030 filename_to_ansi (SSDATA (document), document_a);
7031 doc_a = document_a;
7032 if (STRINGP (parameters))
7034 parameters = ENCODE_SYSTEM (parameters);
7035 params_a = SSDATA (parameters);
7037 if (STRINGP (operation))
7039 /* Assume OPERATION is pure ASCII. */
7040 ops_a = SSDATA (operation);
7042 result = (intptr_t) ShellExecuteA (NULL, ops_a, doc_a, params_a,
7043 current_dir_a,
7044 (INTEGERP (show_flag)
7045 ? XINT (show_flag) : SW_SHOWDEFAULT));
7047 #endif /* !CYGWIN */
7049 if (result > 32)
7050 return Qt;
7052 switch (result)
7054 case SE_ERR_ACCESSDENIED:
7055 errstr = w32_strerror (ERROR_ACCESS_DENIED);
7056 break;
7057 case SE_ERR_ASSOCINCOMPLETE:
7058 case SE_ERR_NOASSOC:
7059 errstr = w32_strerror (ERROR_NO_ASSOCIATION);
7060 break;
7061 case SE_ERR_DDEBUSY:
7062 case SE_ERR_DDEFAIL:
7063 errstr = w32_strerror (ERROR_DDE_FAIL);
7064 break;
7065 case SE_ERR_DDETIMEOUT:
7066 errstr = w32_strerror (ERROR_TIMEOUT);
7067 break;
7068 case SE_ERR_DLLNOTFOUND:
7069 errstr = w32_strerror (ERROR_DLL_NOT_FOUND);
7070 break;
7071 case SE_ERR_FNF:
7072 errstr = w32_strerror (ERROR_FILE_NOT_FOUND);
7073 break;
7074 case SE_ERR_OOM:
7075 errstr = w32_strerror (ERROR_NOT_ENOUGH_MEMORY);
7076 break;
7077 case SE_ERR_PNF:
7078 errstr = w32_strerror (ERROR_PATH_NOT_FOUND);
7079 break;
7080 case SE_ERR_SHARE:
7081 errstr = w32_strerror (ERROR_SHARING_VIOLATION);
7082 break;
7083 default:
7084 errstr = w32_strerror (0);
7085 break;
7087 /* The error string might be encoded in the locale's encoding. */
7088 if (!NILP (Vlocale_coding_system))
7090 Lisp_Object decoded =
7091 code_convert_string_norecord (build_unibyte_string (errstr),
7092 Vlocale_coding_system, 0);
7093 errstr = SSDATA (decoded);
7095 error ("ShellExecute failed: %s", errstr);
7098 /* Lookup virtual keycode from string representing the name of a
7099 non-ascii keystroke into the corresponding virtual key, using
7100 lispy_function_keys. */
7101 static int
7102 lookup_vk_code (char *key)
7104 int i;
7106 for (i = 0; i < 256; i++)
7107 if (lispy_function_keys[i]
7108 && strcmp (lispy_function_keys[i], key) == 0)
7109 return i;
7111 return -1;
7114 /* Convert a one-element vector style key sequence to a hot key
7115 definition. */
7116 static Lisp_Object
7117 w32_parse_hot_key (Lisp_Object key)
7119 /* Copied from Fdefine_key and store_in_keymap. */
7120 register Lisp_Object c;
7121 int vk_code;
7122 int lisp_modifiers;
7123 int w32_modifiers;
7124 struct gcpro gcpro1;
7126 CHECK_VECTOR (key);
7128 if (ASIZE (key) != 1)
7129 return Qnil;
7131 GCPRO1 (key);
7133 c = AREF (key, 0);
7135 if (CONSP (c) && lucid_event_type_list_p (c))
7136 c = Fevent_convert_list (c);
7138 UNGCPRO;
7140 if (! INTEGERP (c) && ! SYMBOLP (c))
7141 error ("Key definition is invalid");
7143 /* Work out the base key and the modifiers. */
7144 if (SYMBOLP (c))
7146 c = parse_modifiers (c);
7147 lisp_modifiers = XINT (Fcar (Fcdr (c)));
7148 c = Fcar (c);
7149 if (!SYMBOLP (c))
7150 emacs_abort ();
7151 vk_code = lookup_vk_code (SDATA (SYMBOL_NAME (c)));
7153 else if (INTEGERP (c))
7155 lisp_modifiers = XINT (c) & ~CHARACTERBITS;
7156 /* Many ascii characters are their own virtual key code. */
7157 vk_code = XINT (c) & CHARACTERBITS;
7160 if (vk_code < 0 || vk_code > 255)
7161 return Qnil;
7163 if ((lisp_modifiers & meta_modifier) != 0
7164 && !NILP (Vw32_alt_is_meta))
7165 lisp_modifiers |= alt_modifier;
7167 /* Supply defs missing from mingw32. */
7168 #ifndef MOD_ALT
7169 #define MOD_ALT 0x0001
7170 #define MOD_CONTROL 0x0002
7171 #define MOD_SHIFT 0x0004
7172 #define MOD_WIN 0x0008
7173 #endif
7175 /* Convert lisp modifiers to Windows hot-key form. */
7176 w32_modifiers = (lisp_modifiers & hyper_modifier) ? MOD_WIN : 0;
7177 w32_modifiers |= (lisp_modifiers & alt_modifier) ? MOD_ALT : 0;
7178 w32_modifiers |= (lisp_modifiers & ctrl_modifier) ? MOD_CONTROL : 0;
7179 w32_modifiers |= (lisp_modifiers & shift_modifier) ? MOD_SHIFT : 0;
7181 return HOTKEY (vk_code, w32_modifiers);
7184 DEFUN ("w32-register-hot-key", Fw32_register_hot_key,
7185 Sw32_register_hot_key, 1, 1, 0,
7186 doc: /* Register KEY as a hot-key combination.
7187 Certain key combinations like Alt-Tab are reserved for system use on
7188 Windows, and therefore are normally intercepted by the system. However,
7189 most of these key combinations can be received by registering them as
7190 hot-keys, overriding their special meaning.
7192 KEY must be a one element key definition in vector form that would be
7193 acceptable to `define-key' (e.g. [A-tab] for Alt-Tab). The meta
7194 modifier is interpreted as Alt if `w32-alt-is-meta' is t, and hyper
7195 is always interpreted as the Windows modifier keys.
7197 The return value is the hotkey-id if registered, otherwise nil. */)
7198 (Lisp_Object key)
7200 key = w32_parse_hot_key (key);
7202 if (!NILP (key) && NILP (Fmemq (key, w32_grabbed_keys)))
7204 /* Reuse an empty slot if possible. */
7205 Lisp_Object item = Fmemq (Qnil, w32_grabbed_keys);
7207 /* Safe to add new key to list, even if we have focus. */
7208 if (NILP (item))
7209 w32_grabbed_keys = Fcons (key, w32_grabbed_keys);
7210 else
7211 XSETCAR (item, key);
7213 /* Notify input thread about new hot-key definition, so that it
7214 takes effect without needing to switch focus. */
7215 PostThreadMessage (dwWindowsThreadId, WM_EMACS_REGISTER_HOT_KEY,
7216 (WPARAM) XLI (key), 0);
7219 return key;
7222 DEFUN ("w32-unregister-hot-key", Fw32_unregister_hot_key,
7223 Sw32_unregister_hot_key, 1, 1, 0,
7224 doc: /* Unregister KEY as a hot-key combination. */)
7225 (Lisp_Object key)
7227 Lisp_Object item;
7229 if (!INTEGERP (key))
7230 key = w32_parse_hot_key (key);
7232 item = Fmemq (key, w32_grabbed_keys);
7234 if (!NILP (item))
7236 /* Notify input thread about hot-key definition being removed, so
7237 that it takes effect without needing focus switch. */
7238 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_UNREGISTER_HOT_KEY,
7239 (WPARAM) XINT (XCAR (item)), (LPARAM) XLI (item)))
7241 MSG msg;
7242 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
7244 return Qt;
7246 return Qnil;
7249 DEFUN ("w32-registered-hot-keys", Fw32_registered_hot_keys,
7250 Sw32_registered_hot_keys, 0, 0, 0,
7251 doc: /* Return list of registered hot-key IDs. */)
7252 (void)
7254 return Fdelq (Qnil, Fcopy_sequence (w32_grabbed_keys));
7257 DEFUN ("w32-reconstruct-hot-key", Fw32_reconstruct_hot_key,
7258 Sw32_reconstruct_hot_key, 1, 1, 0,
7259 doc: /* Convert hot-key ID to a lisp key combination.
7260 usage: (w32-reconstruct-hot-key ID) */)
7261 (Lisp_Object hotkeyid)
7263 int vk_code, w32_modifiers;
7264 Lisp_Object key;
7266 CHECK_NUMBER (hotkeyid);
7268 vk_code = HOTKEY_VK_CODE (hotkeyid);
7269 w32_modifiers = HOTKEY_MODIFIERS (hotkeyid);
7271 if (vk_code < 256 && lispy_function_keys[vk_code])
7272 key = intern (lispy_function_keys[vk_code]);
7273 else
7274 key = make_number (vk_code);
7276 key = Fcons (key, Qnil);
7277 if (w32_modifiers & MOD_SHIFT)
7278 key = Fcons (Qshift, key);
7279 if (w32_modifiers & MOD_CONTROL)
7280 key = Fcons (Qctrl, key);
7281 if (w32_modifiers & MOD_ALT)
7282 key = Fcons (NILP (Vw32_alt_is_meta) ? Qalt : Qmeta, key);
7283 if (w32_modifiers & MOD_WIN)
7284 key = Fcons (Qhyper, key);
7286 return key;
7289 DEFUN ("w32-toggle-lock-key", Fw32_toggle_lock_key,
7290 Sw32_toggle_lock_key, 1, 2, 0,
7291 doc: /* Toggle the state of the lock key KEY.
7292 KEY can be `capslock', `kp-numlock', or `scroll'.
7293 If the optional parameter NEW-STATE is a number, then the state of KEY
7294 is set to off if the low bit of NEW-STATE is zero, otherwise on. */)
7295 (Lisp_Object key, Lisp_Object new_state)
7297 int vk_code;
7299 if (EQ (key, intern ("capslock")))
7300 vk_code = VK_CAPITAL;
7301 else if (EQ (key, intern ("kp-numlock")))
7302 vk_code = VK_NUMLOCK;
7303 else if (EQ (key, intern ("scroll")))
7304 vk_code = VK_SCROLL;
7305 else
7306 return Qnil;
7308 if (!dwWindowsThreadId)
7309 return make_number (w32_console_toggle_lock_key (vk_code, new_state));
7311 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_TOGGLE_LOCK_KEY,
7312 (WPARAM) vk_code, (LPARAM) XLI (new_state)))
7314 MSG msg;
7315 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
7316 return make_number (msg.wParam);
7318 return Qnil;
7321 DEFUN ("w32-window-exists-p", Fw32_window_exists_p, Sw32_window_exists_p,
7322 2, 2, 0,
7323 doc: /* Return non-nil if a window exists with the specified CLASS and NAME.
7325 This is a direct interface to the Windows API FindWindow function. */)
7326 (Lisp_Object class, Lisp_Object name)
7328 HWND hnd;
7330 if (!NILP (class))
7331 CHECK_STRING (class);
7332 if (!NILP (name))
7333 CHECK_STRING (name);
7335 hnd = FindWindow (STRINGP (class) ? ((LPCTSTR) SDATA (class)) : NULL,
7336 STRINGP (name) ? ((LPCTSTR) SDATA (name)) : NULL);
7337 if (!hnd)
7338 return Qnil;
7339 return Qt;
7342 DEFUN ("w32-frame-rect", Fw32_frame_rect, Sw32_frame_rect, 0, 2, 0,
7343 doc: /* Return boundary rectangle of FRAME in screen coordinates.
7344 FRAME must be a live frame and defaults to the selected one.
7346 The boundary rectangle is a list of four elements, specifying the left,
7347 top, right and bottom screen coordinates of FRAME including menu and
7348 title bar and decorations. Optional argument CLIENT non-nil means to
7349 return the boundaries of the client rectangle which excludes menu and
7350 title bar and decorations. */)
7351 (Lisp_Object frame, Lisp_Object client)
7353 struct frame *f = decode_live_frame (frame);
7354 RECT rect;
7356 if (!NILP (client))
7357 GetClientRect (FRAME_W32_WINDOW (f), &rect);
7358 else
7359 GetWindowRect (FRAME_W32_WINDOW (f), &rect);
7361 return list4 (make_number (rect.left), make_number (rect.top),
7362 make_number (rect.right), make_number (rect.bottom));
7365 DEFUN ("w32-battery-status", Fw32_battery_status, Sw32_battery_status, 0, 0, 0,
7366 doc: /* Get power status information from Windows system.
7368 The following %-sequences are provided:
7369 %L AC line status (verbose)
7370 %B Battery status (verbose)
7371 %b Battery status, empty means high, `-' means low,
7372 `!' means critical, and `+' means charging
7373 %p Battery load percentage
7374 %s Remaining time (to charge or discharge) in seconds
7375 %m Remaining time (to charge or discharge) in minutes
7376 %h Remaining time (to charge or discharge) in hours
7377 %t Remaining time (to charge or discharge) in the form `h:min' */)
7378 (void)
7380 Lisp_Object status = Qnil;
7382 SYSTEM_POWER_STATUS system_status;
7383 if (GetSystemPowerStatus (&system_status))
7385 Lisp_Object line_status, battery_status, battery_status_symbol;
7386 Lisp_Object load_percentage, seconds, minutes, hours, remain;
7388 long seconds_left = (long) system_status.BatteryLifeTime;
7390 if (system_status.ACLineStatus == 0)
7391 line_status = build_string ("off-line");
7392 else if (system_status.ACLineStatus == 1)
7393 line_status = build_string ("on-line");
7394 else
7395 line_status = build_string ("N/A");
7397 if (system_status.BatteryFlag & 128)
7399 battery_status = build_string ("N/A");
7400 battery_status_symbol = empty_unibyte_string;
7402 else if (system_status.BatteryFlag & 8)
7404 battery_status = build_string ("charging");
7405 battery_status_symbol = build_string ("+");
7406 if (system_status.BatteryFullLifeTime != -1L)
7407 seconds_left = system_status.BatteryFullLifeTime - seconds_left;
7409 else if (system_status.BatteryFlag & 4)
7411 battery_status = build_string ("critical");
7412 battery_status_symbol = build_string ("!");
7414 else if (system_status.BatteryFlag & 2)
7416 battery_status = build_string ("low");
7417 battery_status_symbol = build_string ("-");
7419 else if (system_status.BatteryFlag & 1)
7421 battery_status = build_string ("high");
7422 battery_status_symbol = empty_unibyte_string;
7424 else
7426 battery_status = build_string ("medium");
7427 battery_status_symbol = empty_unibyte_string;
7430 if (system_status.BatteryLifePercent > 100)
7431 load_percentage = build_string ("N/A");
7432 else
7434 char buffer[16];
7435 snprintf (buffer, 16, "%d", system_status.BatteryLifePercent);
7436 load_percentage = build_string (buffer);
7439 if (seconds_left < 0)
7440 seconds = minutes = hours = remain = build_string ("N/A");
7441 else
7443 long m;
7444 float h;
7445 char buffer[16];
7446 snprintf (buffer, 16, "%ld", seconds_left);
7447 seconds = build_string (buffer);
7449 m = seconds_left / 60;
7450 snprintf (buffer, 16, "%ld", m);
7451 minutes = build_string (buffer);
7453 h = seconds_left / 3600.0;
7454 snprintf (buffer, 16, "%3.1f", h);
7455 hours = build_string (buffer);
7457 snprintf (buffer, 16, "%ld:%02ld", m / 60, m % 60);
7458 remain = build_string (buffer);
7461 status = listn (CONSTYPE_HEAP, 8,
7462 Fcons (make_number ('L'), line_status),
7463 Fcons (make_number ('B'), battery_status),
7464 Fcons (make_number ('b'), battery_status_symbol),
7465 Fcons (make_number ('p'), load_percentage),
7466 Fcons (make_number ('s'), seconds),
7467 Fcons (make_number ('m'), minutes),
7468 Fcons (make_number ('h'), hours),
7469 Fcons (make_number ('t'), remain));
7471 return status;
7475 #ifdef WINDOWSNT
7476 DEFUN ("file-system-info", Ffile_system_info, Sfile_system_info, 1, 1, 0,
7477 doc: /* Return storage information about the file system FILENAME is on.
7478 Value is a list of floats (TOTAL FREE AVAIL), where TOTAL is the total
7479 storage of the file system, FREE is the free storage, and AVAIL is the
7480 storage available to a non-superuser. All 3 numbers are in bytes.
7481 If the underlying system call fails, value is nil. */)
7482 (Lisp_Object filename)
7484 Lisp_Object encoded, value;
7486 CHECK_STRING (filename);
7487 filename = Fexpand_file_name (filename, Qnil);
7488 encoded = ENCODE_FILE (filename);
7490 value = Qnil;
7492 /* Determining the required information on Windows turns out, sadly,
7493 to be more involved than one would hope. The original Windows API
7494 call for this will return bogus information on some systems, but we
7495 must dynamically probe for the replacement api, since that was
7496 added rather late on. */
7498 HMODULE hKernel = GetModuleHandle ("kernel32");
7499 BOOL (WINAPI *pfn_GetDiskFreeSpaceExW)
7500 (wchar_t *, PULARGE_INTEGER, PULARGE_INTEGER, PULARGE_INTEGER)
7501 = GetProcAddress (hKernel, "GetDiskFreeSpaceExW");
7502 BOOL (WINAPI *pfn_GetDiskFreeSpaceExA)
7503 (char *, PULARGE_INTEGER, PULARGE_INTEGER, PULARGE_INTEGER)
7504 = GetProcAddress (hKernel, "GetDiskFreeSpaceExA");
7505 bool have_pfn_GetDiskFreeSpaceEx =
7506 (w32_unicode_filenames && pfn_GetDiskFreeSpaceExW
7507 || !w32_unicode_filenames && pfn_GetDiskFreeSpaceExA);
7509 /* On Windows, we may need to specify the root directory of the
7510 volume holding FILENAME. */
7511 char rootname[MAX_UTF8_PATH];
7512 wchar_t rootname_w[MAX_PATH];
7513 char rootname_a[MAX_PATH];
7514 char *name = SDATA (encoded);
7515 BOOL result;
7517 /* find the root name of the volume if given */
7518 if (isalpha (name[0]) && name[1] == ':')
7520 rootname[0] = name[0];
7521 rootname[1] = name[1];
7522 rootname[2] = '\\';
7523 rootname[3] = 0;
7525 else if (IS_DIRECTORY_SEP (name[0]) && IS_DIRECTORY_SEP (name[1]))
7527 char *str = rootname;
7528 int slashes = 4;
7531 if (IS_DIRECTORY_SEP (*name) && --slashes == 0)
7532 break;
7533 *str++ = *name++;
7535 while ( *name );
7537 *str++ = '\\';
7538 *str = 0;
7541 if (w32_unicode_filenames)
7542 filename_to_utf16 (rootname, rootname_w);
7543 else
7544 filename_to_ansi (rootname, rootname_a);
7546 if (have_pfn_GetDiskFreeSpaceEx)
7548 /* Unsigned large integers cannot be cast to double, so
7549 use signed ones instead. */
7550 LARGE_INTEGER availbytes;
7551 LARGE_INTEGER freebytes;
7552 LARGE_INTEGER totalbytes;
7554 if (w32_unicode_filenames)
7555 result = pfn_GetDiskFreeSpaceExW (rootname_w,
7556 (ULARGE_INTEGER *)&availbytes,
7557 (ULARGE_INTEGER *)&totalbytes,
7558 (ULARGE_INTEGER *)&freebytes);
7559 else
7560 result = pfn_GetDiskFreeSpaceExA (rootname_a,
7561 (ULARGE_INTEGER *)&availbytes,
7562 (ULARGE_INTEGER *)&totalbytes,
7563 (ULARGE_INTEGER *)&freebytes);
7564 if (result)
7565 value = list3 (make_float ((double) totalbytes.QuadPart),
7566 make_float ((double) freebytes.QuadPart),
7567 make_float ((double) availbytes.QuadPart));
7569 else
7571 DWORD sectors_per_cluster;
7572 DWORD bytes_per_sector;
7573 DWORD free_clusters;
7574 DWORD total_clusters;
7576 if (w32_unicode_filenames)
7577 result = GetDiskFreeSpaceW (rootname_w,
7578 &sectors_per_cluster,
7579 &bytes_per_sector,
7580 &free_clusters,
7581 &total_clusters);
7582 else
7583 result = GetDiskFreeSpaceA (rootname_a,
7584 &sectors_per_cluster,
7585 &bytes_per_sector,
7586 &free_clusters,
7587 &total_clusters);
7588 if (result)
7589 value = list3 (make_float ((double) total_clusters
7590 * sectors_per_cluster * bytes_per_sector),
7591 make_float ((double) free_clusters
7592 * sectors_per_cluster * bytes_per_sector),
7593 make_float ((double) free_clusters
7594 * sectors_per_cluster * bytes_per_sector));
7598 return value;
7600 #endif /* WINDOWSNT */
7603 #ifdef WINDOWSNT
7604 DEFUN ("default-printer-name", Fdefault_printer_name, Sdefault_printer_name,
7605 0, 0, 0, doc: /* Return the name of Windows default printer device. */)
7606 (void)
7608 static char pname_buf[256];
7609 int err;
7610 HANDLE hPrn;
7611 PRINTER_INFO_2W *ppi2w = NULL;
7612 PRINTER_INFO_2A *ppi2a = NULL;
7613 DWORD dwNeeded = 0, dwReturned = 0;
7614 char server_name[MAX_UTF8_PATH], share_name[MAX_UTF8_PATH];
7615 char port_name[MAX_UTF8_PATH];
7617 /* Retrieve the default string from Win.ini (the registry).
7618 * String will be in form "printername,drivername,portname".
7619 * This is the most portable way to get the default printer. */
7620 if (GetProfileString ("windows", "device", ",,", pname_buf, sizeof (pname_buf)) <= 0)
7621 return Qnil;
7622 /* printername precedes first "," character */
7623 strtok (pname_buf, ",");
7624 /* We want to know more than the printer name */
7625 if (!OpenPrinter (pname_buf, &hPrn, NULL))
7626 return Qnil;
7627 /* GetPrinterW is not supported by unicows.dll. */
7628 if (w32_unicode_filenames && os_subtype != OS_9X)
7629 GetPrinterW (hPrn, 2, NULL, 0, &dwNeeded);
7630 else
7631 GetPrinterA (hPrn, 2, NULL, 0, &dwNeeded);
7632 if (dwNeeded == 0)
7634 ClosePrinter (hPrn);
7635 return Qnil;
7637 /* Call GetPrinter again with big enough memory block. */
7638 if (w32_unicode_filenames && os_subtype != OS_9X)
7640 /* Allocate memory for the PRINTER_INFO_2 struct. */
7641 ppi2w = xmalloc (dwNeeded);
7642 err = GetPrinterW (hPrn, 2, (LPBYTE)ppi2w, dwNeeded, &dwReturned);
7643 ClosePrinter (hPrn);
7644 if (!err)
7646 xfree (ppi2w);
7647 return Qnil;
7650 if ((ppi2w->Attributes & PRINTER_ATTRIBUTE_SHARED)
7651 && ppi2w->pServerName)
7653 filename_from_utf16 (ppi2w->pServerName, server_name);
7654 filename_from_utf16 (ppi2w->pShareName, share_name);
7656 else
7658 server_name[0] = '\0';
7659 filename_from_utf16 (ppi2w->pPortName, port_name);
7662 else
7664 ppi2a = xmalloc (dwNeeded);
7665 err = GetPrinterA (hPrn, 2, (LPBYTE)ppi2a, dwNeeded, &dwReturned);
7666 ClosePrinter (hPrn);
7667 if (!err)
7669 xfree (ppi2a);
7670 return Qnil;
7673 if ((ppi2a->Attributes & PRINTER_ATTRIBUTE_SHARED)
7674 && ppi2a->pServerName)
7676 filename_from_ansi (ppi2a->pServerName, server_name);
7677 filename_from_ansi (ppi2a->pShareName, share_name);
7679 else
7681 server_name[0] = '\0';
7682 filename_from_ansi (ppi2a->pPortName, port_name);
7686 if (server_name[0])
7688 /* a remote printer */
7689 if (server_name[0] == '\\')
7690 snprintf (pname_buf, sizeof (pname_buf), "%s\\%s", server_name,
7691 share_name);
7692 else
7693 snprintf (pname_buf, sizeof (pname_buf), "\\\\%s\\%s", server_name,
7694 share_name);
7695 pname_buf[sizeof (pname_buf) - 1] = '\0';
7697 else
7699 /* a local printer */
7700 strncpy (pname_buf, port_name, sizeof (pname_buf));
7701 pname_buf[sizeof (pname_buf) - 1] = '\0';
7702 /* `pPortName' can include several ports, delimited by ','.
7703 * we only use the first one. */
7704 strtok (pname_buf, ",");
7707 return DECODE_FILE (build_unibyte_string (pname_buf));
7709 #endif /* WINDOWSNT */
7712 /* Equivalent of strerror for W32 error codes. */
7713 char *
7714 w32_strerror (int error_no)
7716 static char buf[500];
7717 DWORD ret;
7719 if (error_no == 0)
7720 error_no = GetLastError ();
7722 ret = FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM |
7723 FORMAT_MESSAGE_IGNORE_INSERTS,
7724 NULL,
7725 error_no,
7726 0, /* choose most suitable language */
7727 buf, sizeof (buf), NULL);
7729 while (ret > 0 && (buf[ret - 1] == '\n' ||
7730 buf[ret - 1] == '\r' ))
7731 --ret;
7732 buf[ret] = '\0';
7733 if (!ret)
7734 sprintf (buf, "w32 error %u", error_no);
7736 return buf;
7739 /* For convenience when debugging. (You cannot call GetLastError
7740 directly from GDB: it will crash, because it uses the __stdcall
7741 calling convention, not the _cdecl convention assumed by GDB.) */
7742 DWORD
7743 w32_last_error (void)
7745 return GetLastError ();
7748 /* Cache information describing the NT system for later use. */
7749 void
7750 cache_system_info (void)
7752 union
7754 struct info
7756 char major;
7757 char minor;
7758 short platform;
7759 } info;
7760 DWORD data;
7761 } version;
7763 /* Cache the module handle of Emacs itself. */
7764 hinst = GetModuleHandle (NULL);
7766 /* Cache the version of the operating system. */
7767 version.data = GetVersion ();
7768 w32_major_version = version.info.major;
7769 w32_minor_version = version.info.minor;
7771 if (version.info.platform & 0x8000)
7772 os_subtype = OS_9X;
7773 else
7774 os_subtype = OS_NT;
7776 /* Cache page size, allocation unit, processor type, etc. */
7777 GetSystemInfo (&sysinfo_cache);
7778 syspage_mask = (DWORD_PTR)sysinfo_cache.dwPageSize - 1;
7780 /* Cache os info. */
7781 osinfo_cache.dwOSVersionInfoSize = sizeof (OSVERSIONINFO);
7782 GetVersionEx (&osinfo_cache);
7784 w32_build_number = osinfo_cache.dwBuildNumber;
7785 if (os_subtype == OS_9X)
7786 w32_build_number &= 0xffff;
7788 w32_num_mouse_buttons = GetSystemMetrics (SM_CMOUSEBUTTONS);
7791 #ifdef EMACSDEBUG
7792 void
7793 _DebPrint (const char *fmt, ...)
7795 char buf[1024];
7796 va_list args;
7798 va_start (args, fmt);
7799 vsprintf (buf, fmt, args);
7800 va_end (args);
7801 #if CYGWIN
7802 fprintf (stderr, "%s", buf);
7803 #endif
7804 OutputDebugString (buf);
7806 #endif
7809 w32_console_toggle_lock_key (int vk_code, Lisp_Object new_state)
7811 int cur_state = (GetKeyState (vk_code) & 1);
7813 if (NILP (new_state)
7814 || (NUMBERP (new_state)
7815 && ((XUINT (new_state)) & 1) != cur_state))
7817 #ifdef WINDOWSNT
7818 faked_key = vk_code;
7819 #endif /* WINDOWSNT */
7821 keybd_event ((BYTE) vk_code,
7822 (BYTE) MapVirtualKey (vk_code, 0),
7823 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
7824 keybd_event ((BYTE) vk_code,
7825 (BYTE) MapVirtualKey (vk_code, 0),
7826 KEYEVENTF_EXTENDEDKEY | 0, 0);
7827 keybd_event ((BYTE) vk_code,
7828 (BYTE) MapVirtualKey (vk_code, 0),
7829 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
7830 cur_state = !cur_state;
7833 return cur_state;
7836 /* Translate console modifiers to emacs modifiers.
7837 German keyboard support (Kai Morgan Zeise 2/18/95). */
7839 w32_kbd_mods_to_emacs (DWORD mods, WORD key)
7841 int retval = 0;
7843 /* If we recognize right-alt and left-ctrl as AltGr, and it has been
7844 pressed, first remove those modifiers. */
7845 if (!NILP (Vw32_recognize_altgr)
7846 && (mods & (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED))
7847 == (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED))
7848 mods &= ~ (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED);
7850 if (mods & (RIGHT_ALT_PRESSED | LEFT_ALT_PRESSED))
7851 retval = ((NILP (Vw32_alt_is_meta)) ? alt_modifier : meta_modifier);
7853 if (mods & (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
7855 retval |= ctrl_modifier;
7856 if ((mods & (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
7857 == (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
7858 retval |= meta_modifier;
7861 if (mods & LEFT_WIN_PRESSED)
7862 retval |= w32_key_to_modifier (VK_LWIN);
7863 if (mods & RIGHT_WIN_PRESSED)
7864 retval |= w32_key_to_modifier (VK_RWIN);
7865 if (mods & APPS_PRESSED)
7866 retval |= w32_key_to_modifier (VK_APPS);
7867 if (mods & SCROLLLOCK_ON)
7868 retval |= w32_key_to_modifier (VK_SCROLL);
7870 /* Just in case someone wanted the original behavior, make it
7871 optional by setting w32-capslock-is-shiftlock to t. */
7872 if (NILP (Vw32_capslock_is_shiftlock)
7873 /* Keys that should _not_ be affected by CapsLock. */
7874 && ( (key == VK_BACK)
7875 || (key == VK_TAB)
7876 || (key == VK_CLEAR)
7877 || (key == VK_RETURN)
7878 || (key == VK_ESCAPE)
7879 || ((key >= VK_SPACE) && (key <= VK_HELP))
7880 || ((key >= VK_NUMPAD0) && (key <= VK_F24))
7881 || ((key >= VK_NUMPAD_CLEAR) && (key <= VK_NUMPAD_DELETE))
7884 /* Only consider shift state. */
7885 if ((mods & SHIFT_PRESSED) != 0)
7886 retval |= shift_modifier;
7888 else
7890 /* Ignore CapsLock state if not enabled. */
7891 if (NILP (Vw32_enable_caps_lock))
7892 mods &= ~CAPSLOCK_ON;
7893 if ((mods & (SHIFT_PRESSED | CAPSLOCK_ON)) != 0)
7894 retval |= shift_modifier;
7897 return retval;
7900 /* The return code indicates key code size. cpID is the codepage to
7901 use for translation to Unicode; -1 means use the current console
7902 input codepage. */
7904 w32_kbd_patch_key (KEY_EVENT_RECORD *event, int cpId)
7906 unsigned int key_code = event->wVirtualKeyCode;
7907 unsigned int mods = event->dwControlKeyState;
7908 BYTE keystate[256];
7909 static BYTE ansi_code[4];
7910 static int isdead = 0;
7912 if (isdead == 2)
7914 event->uChar.AsciiChar = ansi_code[2];
7915 isdead = 0;
7916 return 1;
7918 if (event->uChar.AsciiChar != 0)
7919 return 1;
7921 memset (keystate, 0, sizeof (keystate));
7922 keystate[key_code] = 0x80;
7923 if (mods & SHIFT_PRESSED)
7924 keystate[VK_SHIFT] = 0x80;
7925 if (mods & CAPSLOCK_ON)
7926 keystate[VK_CAPITAL] = 1;
7927 /* If we recognize right-alt and left-ctrl as AltGr, set the key
7928 states accordingly before invoking ToAscii. */
7929 if (!NILP (Vw32_recognize_altgr)
7930 && (mods & LEFT_CTRL_PRESSED) && (mods & RIGHT_ALT_PRESSED))
7932 keystate[VK_CONTROL] = 0x80;
7933 keystate[VK_LCONTROL] = 0x80;
7934 keystate[VK_MENU] = 0x80;
7935 keystate[VK_RMENU] = 0x80;
7938 #if 0
7939 /* Because of an OS bug, ToAscii corrupts the stack when called to
7940 convert a dead key in console mode on NT4. Unfortunately, trying
7941 to check for dead keys using MapVirtualKey doesn't work either -
7942 these functions apparently use internal information about keyboard
7943 layout which doesn't get properly updated in console programs when
7944 changing layout (though apparently it gets partly updated,
7945 otherwise ToAscii wouldn't crash). */
7946 if (is_dead_key (event->wVirtualKeyCode))
7947 return 0;
7948 #endif
7950 /* On NT, call ToUnicode instead and then convert to the current
7951 console input codepage. */
7952 if (os_subtype == OS_NT)
7954 WCHAR buf[128];
7956 isdead = ToUnicode (event->wVirtualKeyCode, event->wVirtualScanCode,
7957 keystate, buf, 128, 0);
7958 if (isdead > 0)
7960 /* When we are called from the GUI message processing code,
7961 we are passed the current keyboard codepage, a positive
7962 number, to use below. */
7963 if (cpId == -1)
7964 cpId = GetConsoleCP ();
7966 event->uChar.UnicodeChar = buf[isdead - 1];
7967 isdead = WideCharToMultiByte (cpId, 0, buf, isdead,
7968 ansi_code, 4, NULL, NULL);
7970 else
7971 isdead = 0;
7973 else
7975 isdead = ToAscii (event->wVirtualKeyCode, event->wVirtualScanCode,
7976 keystate, (LPWORD) ansi_code, 0);
7979 if (isdead == 0)
7980 return 0;
7981 event->uChar.AsciiChar = ansi_code[0];
7982 return isdead;
7986 void
7987 w32_sys_ring_bell (struct frame *f)
7989 if (sound_type == 0xFFFFFFFF)
7991 Beep (666, 100);
7993 else if (sound_type == MB_EMACS_SILENT)
7995 /* Do nothing. */
7997 else
7998 MessageBeep (sound_type);
8002 /***********************************************************************
8003 Initialization
8004 ***********************************************************************/
8006 /* Keep this list in the same order as frame_parms in frame.c.
8007 Use 0 for unsupported frame parameters. */
8009 frame_parm_handler w32_frame_parm_handlers[] =
8011 x_set_autoraise,
8012 x_set_autolower,
8013 x_set_background_color,
8014 x_set_border_color,
8015 x_set_border_width,
8016 x_set_cursor_color,
8017 x_set_cursor_type,
8018 x_set_font,
8019 x_set_foreground_color,
8020 x_set_icon_name,
8021 x_set_icon_type,
8022 x_set_internal_border_width,
8023 x_set_right_divider_width,
8024 x_set_bottom_divider_width,
8025 x_set_menu_bar_lines,
8026 x_set_mouse_color,
8027 x_explicitly_set_name,
8028 x_set_scroll_bar_width,
8029 x_set_title,
8030 x_set_unsplittable,
8031 x_set_vertical_scroll_bars,
8032 x_set_visibility,
8033 x_set_tool_bar_lines,
8034 0, /* x_set_scroll_bar_foreground, */
8035 0, /* x_set_scroll_bar_background, */
8036 x_set_screen_gamma,
8037 x_set_line_spacing,
8038 x_set_fringe_width,
8039 x_set_fringe_width,
8040 0, /* x_set_wait_for_wm, */
8041 x_set_fullscreen,
8042 x_set_font_backend,
8043 x_set_alpha,
8044 0, /* x_set_sticky */
8045 0, /* x_set_tool_bar_position */
8048 void
8049 syms_of_w32fns (void)
8051 globals_of_w32fns ();
8052 track_mouse_window = NULL;
8054 w32_visible_system_caret_hwnd = NULL;
8056 DEFSYM (Qsuppress_icon, "suppress-icon");
8057 DEFSYM (Qundefined_color, "undefined-color");
8058 DEFSYM (Qcancel_timer, "cancel-timer");
8059 DEFSYM (Qhyper, "hyper");
8060 DEFSYM (Qsuper, "super");
8061 DEFSYM (Qmeta, "meta");
8062 DEFSYM (Qalt, "alt");
8063 DEFSYM (Qctrl, "ctrl");
8064 DEFSYM (Qcontrol, "control");
8065 DEFSYM (Qshift, "shift");
8066 DEFSYM (Qfont_param, "font-parameter");
8067 DEFSYM (Qgeometry, "geometry");
8068 DEFSYM (Qworkarea, "workarea");
8069 DEFSYM (Qmm_size, "mm-size");
8070 DEFSYM (Qframes, "frames");
8071 /* This is the end of symbol initialization. */
8074 Fput (Qundefined_color, Qerror_conditions,
8075 listn (CONSTYPE_PURE, 2, Qundefined_color, Qerror));
8076 Fput (Qundefined_color, Qerror_message,
8077 build_pure_c_string ("Undefined color"));
8079 staticpro (&w32_grabbed_keys);
8080 w32_grabbed_keys = Qnil;
8082 DEFVAR_LISP ("w32-color-map", Vw32_color_map,
8083 doc: /* An array of color name mappings for Windows. */);
8084 Vw32_color_map = Qnil;
8086 DEFVAR_LISP ("w32-pass-alt-to-system", Vw32_pass_alt_to_system,
8087 doc: /* Non-nil if Alt key presses are passed on to Windows.
8088 When non-nil, for example, Alt pressed and released and then space will
8089 open the System menu. When nil, Emacs processes the Alt key events, and
8090 then silently swallows them. */);
8091 Vw32_pass_alt_to_system = Qnil;
8093 DEFVAR_LISP ("w32-alt-is-meta", Vw32_alt_is_meta,
8094 doc: /* Non-nil if the Alt key is to be considered the same as the META key.
8095 When nil, Emacs will translate the Alt key to the ALT modifier, not to META. */);
8096 Vw32_alt_is_meta = Qt;
8098 DEFVAR_INT ("w32-quit-key", w32_quit_key,
8099 doc: /* If non-zero, the virtual key code for an alternative quit key. */);
8100 w32_quit_key = 0;
8102 DEFVAR_LISP ("w32-pass-lwindow-to-system",
8103 Vw32_pass_lwindow_to_system,
8104 doc: /* If non-nil, the left \"Windows\" key is passed on to Windows.
8106 When non-nil, the Start menu is opened by tapping the key.
8107 If you set this to nil, the left \"Windows\" key is processed by Emacs
8108 according to the value of `w32-lwindow-modifier', which see.
8110 Note that some combinations of the left \"Windows\" key with other keys are
8111 caught by Windows at low level, and so binding them in Emacs will have no
8112 effect. For example, <lwindow>-r always pops up the Windows Run dialog,
8113 <lwindow>-<Pause> pops up the "System Properties" dialog, etc. However, see
8114 the doc string of `w32-phantom-key-code'. */);
8115 Vw32_pass_lwindow_to_system = Qt;
8117 DEFVAR_LISP ("w32-pass-rwindow-to-system",
8118 Vw32_pass_rwindow_to_system,
8119 doc: /* If non-nil, the right \"Windows\" key is passed on to Windows.
8121 When non-nil, the Start menu is opened by tapping the key.
8122 If you set this to nil, the right \"Windows\" key is processed by Emacs
8123 according to the value of `w32-rwindow-modifier', which see.
8125 Note that some combinations of the right \"Windows\" key with other keys are
8126 caught by Windows at low level, and so binding them in Emacs will have no
8127 effect. For example, <rwindow>-r always pops up the Windows Run dialog,
8128 <rwindow>-<Pause> pops up the "System Properties" dialog, etc. However, see
8129 the doc string of `w32-phantom-key-code'. */);
8130 Vw32_pass_rwindow_to_system = Qt;
8132 DEFVAR_LISP ("w32-phantom-key-code",
8133 Vw32_phantom_key_code,
8134 doc: /* Virtual key code used to generate \"phantom\" key presses.
8135 Value is a number between 0 and 255.
8137 Phantom key presses are generated in order to stop the system from
8138 acting on \"Windows\" key events when `w32-pass-lwindow-to-system' or
8139 `w32-pass-rwindow-to-system' is nil. */);
8140 /* Although 255 is technically not a valid key code, it works and
8141 means that this hack won't interfere with any real key code. */
8142 XSETINT (Vw32_phantom_key_code, 255);
8144 DEFVAR_LISP ("w32-enable-num-lock",
8145 Vw32_enable_num_lock,
8146 doc: /* If non-nil, the Num Lock key acts normally.
8147 Set to nil to handle Num Lock as the `kp-numlock' key. */);
8148 Vw32_enable_num_lock = Qt;
8150 DEFVAR_LISP ("w32-enable-caps-lock",
8151 Vw32_enable_caps_lock,
8152 doc: /* If non-nil, the Caps Lock key acts normally.
8153 Set to nil to handle Caps Lock as the `capslock' key. */);
8154 Vw32_enable_caps_lock = Qt;
8156 DEFVAR_LISP ("w32-scroll-lock-modifier",
8157 Vw32_scroll_lock_modifier,
8158 doc: /* Modifier to use for the Scroll Lock ON state.
8159 The value can be hyper, super, meta, alt, control or shift for the
8160 respective modifier, or nil to handle Scroll Lock as the `scroll' key.
8161 Any other value will cause the Scroll Lock key to be ignored. */);
8162 Vw32_scroll_lock_modifier = Qnil;
8164 DEFVAR_LISP ("w32-lwindow-modifier",
8165 Vw32_lwindow_modifier,
8166 doc: /* Modifier to use for the left \"Windows\" key.
8167 The value can be hyper, super, meta, alt, control or shift for the
8168 respective modifier, or nil to appear as the `lwindow' key.
8169 Any other value will cause the key to be ignored. */);
8170 Vw32_lwindow_modifier = Qnil;
8172 DEFVAR_LISP ("w32-rwindow-modifier",
8173 Vw32_rwindow_modifier,
8174 doc: /* Modifier to use for the right \"Windows\" key.
8175 The value can be hyper, super, meta, alt, control or shift for the
8176 respective modifier, or nil to appear as the `rwindow' key.
8177 Any other value will cause the key to be ignored. */);
8178 Vw32_rwindow_modifier = Qnil;
8180 DEFVAR_LISP ("w32-apps-modifier",
8181 Vw32_apps_modifier,
8182 doc: /* Modifier to use for the \"Apps\" key.
8183 The value can be hyper, super, meta, alt, control or shift for the
8184 respective modifier, or nil to appear as the `apps' key.
8185 Any other value will cause the key to be ignored. */);
8186 Vw32_apps_modifier = Qnil;
8188 DEFVAR_BOOL ("w32-enable-synthesized-fonts", w32_enable_synthesized_fonts,
8189 doc: /* Non-nil enables selection of artificially italicized and bold fonts. */);
8190 w32_enable_synthesized_fonts = 0;
8192 DEFVAR_LISP ("w32-enable-palette", Vw32_enable_palette,
8193 doc: /* Non-nil enables Windows palette management to map colors exactly. */);
8194 Vw32_enable_palette = Qt;
8196 DEFVAR_INT ("w32-mouse-button-tolerance",
8197 w32_mouse_button_tolerance,
8198 doc: /* Analogue of double click interval for faking middle mouse events.
8199 The value is the minimum time in milliseconds that must elapse between
8200 left and right button down events before they are considered distinct events.
8201 If both mouse buttons are depressed within this interval, a middle mouse
8202 button down event is generated instead. */);
8203 w32_mouse_button_tolerance = GetDoubleClickTime () / 2;
8205 DEFVAR_INT ("w32-mouse-move-interval",
8206 w32_mouse_move_interval,
8207 doc: /* Minimum interval between mouse move events.
8208 The value is the minimum time in milliseconds that must elapse between
8209 successive mouse move (or scroll bar drag) events before they are
8210 reported as lisp events. */);
8211 w32_mouse_move_interval = 0;
8213 DEFVAR_BOOL ("w32-pass-extra-mouse-buttons-to-system",
8214 w32_pass_extra_mouse_buttons_to_system,
8215 doc: /* If non-nil, the fourth and fifth mouse buttons are passed to Windows.
8216 Recent versions of Windows support mice with up to five buttons.
8217 Since most applications don't support these extra buttons, most mouse
8218 drivers will allow you to map them to functions at the system level.
8219 If this variable is non-nil, Emacs will pass them on, allowing the
8220 system to handle them. */);
8221 w32_pass_extra_mouse_buttons_to_system = 0;
8223 DEFVAR_BOOL ("w32-pass-multimedia-buttons-to-system",
8224 w32_pass_multimedia_buttons_to_system,
8225 doc: /* If non-nil, media buttons are passed to Windows.
8226 Some modern keyboards contain buttons for controlling media players, web
8227 browsers and other applications. Generally these buttons are handled on a
8228 system wide basis, but by setting this to nil they are made available
8229 to Emacs for binding. Depending on your keyboard, additional keys that
8230 may be available are:
8232 browser-back, browser-forward, browser-refresh, browser-stop,
8233 browser-search, browser-favorites, browser-home,
8234 mail, mail-reply, mail-forward, mail-send,
8235 app-1, app-2,
8236 help, find, new, open, close, save, print, undo, redo, copy, cut, paste,
8237 spell-check, correction-list, toggle-dictate-command,
8238 media-next, media-previous, media-stop, media-play-pause, media-select,
8239 media-play, media-pause, media-record, media-fast-forward, media-rewind,
8240 media-channel-up, media-channel-down,
8241 volume-mute, volume-up, volume-down,
8242 mic-volume-mute, mic-volume-down, mic-volume-up, mic-toggle,
8243 bass-down, bass-boost, bass-up, treble-down, treble-up */);
8244 w32_pass_multimedia_buttons_to_system = 1;
8246 #if 0 /* TODO: Mouse cursor customization. */
8247 DEFVAR_LISP ("x-pointer-shape", Vx_pointer_shape,
8248 doc: /* The shape of the pointer when over text.
8249 Changing the value does not affect existing frames
8250 unless you set the mouse color. */);
8251 Vx_pointer_shape = Qnil;
8253 Vx_nontext_pointer_shape = Qnil;
8255 Vx_mode_pointer_shape = Qnil;
8257 DEFVAR_LISP ("x-hourglass-pointer-shape", Vx_hourglass_pointer_shape,
8258 doc: /* The shape of the pointer when Emacs is busy.
8259 This variable takes effect when you create a new frame
8260 or when you set the mouse color. */);
8261 Vx_hourglass_pointer_shape = Qnil;
8263 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
8264 Vx_sensitive_text_pointer_shape,
8265 doc: /* The shape of the pointer when over mouse-sensitive text.
8266 This variable takes effect when you create a new frame
8267 or when you set the mouse color. */);
8268 Vx_sensitive_text_pointer_shape = Qnil;
8270 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
8271 Vx_window_horizontal_drag_shape,
8272 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
8273 This variable takes effect when you create a new frame
8274 or when you set the mouse color. */);
8275 Vx_window_horizontal_drag_shape = Qnil;
8277 DEFVAR_LISP ("x-window-vertical-drag-cursor",
8278 Vx_window_vertical_drag_shape,
8279 doc: /* Pointer shape to use for indicating a window can be dragged vertically.
8280 This variable takes effect when you create a new frame
8281 or when you set the mouse color. */);
8282 Vx_window_vertical_drag_shape = Qnil;
8283 #endif
8285 DEFVAR_LISP ("x-cursor-fore-pixel", Vx_cursor_fore_pixel,
8286 doc: /* A string indicating the foreground color of the cursor box. */);
8287 Vx_cursor_fore_pixel = Qnil;
8289 DEFVAR_LISP ("x-max-tooltip-size", Vx_max_tooltip_size,
8290 doc: /* Maximum size for tooltips.
8291 Value is a pair (COLUMNS . ROWS). Text larger than this is clipped. */);
8292 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
8294 DEFVAR_LISP ("x-no-window-manager", Vx_no_window_manager,
8295 doc: /* Non-nil if no window manager is in use.
8296 Emacs doesn't try to figure this out; this is always nil
8297 unless you set it to something else. */);
8298 /* We don't have any way to find this out, so set it to nil
8299 and maybe the user would like to set it to t. */
8300 Vx_no_window_manager = Qnil;
8302 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
8303 Vx_pixel_size_width_font_regexp,
8304 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
8306 Since Emacs gets width of a font matching with this regexp from
8307 PIXEL_SIZE field of the name, font finding mechanism gets faster for
8308 such a font. This is especially effective for such large fonts as
8309 Chinese, Japanese, and Korean. */);
8310 Vx_pixel_size_width_font_regexp = Qnil;
8312 DEFVAR_LISP ("w32-bdf-filename-alist",
8313 Vw32_bdf_filename_alist,
8314 doc: /* List of bdf fonts and their corresponding filenames. */);
8315 Vw32_bdf_filename_alist = Qnil;
8317 DEFVAR_BOOL ("w32-strict-fontnames",
8318 w32_strict_fontnames,
8319 doc: /* Non-nil means only use fonts that are exact matches for those requested.
8320 Default is nil, which allows old fontnames that are not XLFD compliant,
8321 and allows third-party CJK display to work by specifying false charset
8322 fields to trick Emacs into translating to Big5, SJIS etc.
8323 Setting this to t will prevent wrong fonts being selected when
8324 fontsets are automatically created. */);
8325 w32_strict_fontnames = 0;
8327 DEFVAR_BOOL ("w32-strict-painting",
8328 w32_strict_painting,
8329 doc: /* Non-nil means use strict rules for repainting frames.
8330 Set this to nil to get the old behavior for repainting; this should
8331 only be necessary if the default setting causes problems. */);
8332 w32_strict_painting = 1;
8334 #if 0 /* TODO: Port to W32 */
8335 defsubr (&Sx_change_window_property);
8336 defsubr (&Sx_delete_window_property);
8337 defsubr (&Sx_window_property);
8338 #endif
8339 defsubr (&Sxw_display_color_p);
8340 defsubr (&Sx_display_grayscale_p);
8341 defsubr (&Sxw_color_defined_p);
8342 defsubr (&Sxw_color_values);
8343 defsubr (&Sx_server_max_request_size);
8344 defsubr (&Sx_server_vendor);
8345 defsubr (&Sx_server_version);
8346 defsubr (&Sx_display_pixel_width);
8347 defsubr (&Sx_display_pixel_height);
8348 defsubr (&Sx_display_mm_width);
8349 defsubr (&Sx_display_mm_height);
8350 defsubr (&Sx_display_screens);
8351 defsubr (&Sx_display_planes);
8352 defsubr (&Sx_display_color_cells);
8353 defsubr (&Sx_display_visual_class);
8354 defsubr (&Sx_display_backing_store);
8355 defsubr (&Sx_display_save_under);
8356 defsubr (&Sx_create_frame);
8357 defsubr (&Sx_open_connection);
8358 defsubr (&Sx_close_connection);
8359 defsubr (&Sx_display_list);
8360 defsubr (&Sx_synchronize);
8362 /* W32 specific functions */
8364 defsubr (&Sw32_define_rgb_color);
8365 defsubr (&Sw32_default_color_map);
8366 defsubr (&Sw32_display_monitor_attributes_list);
8367 defsubr (&Sw32_send_sys_command);
8368 defsubr (&Sw32_shell_execute);
8369 defsubr (&Sw32_register_hot_key);
8370 defsubr (&Sw32_unregister_hot_key);
8371 defsubr (&Sw32_registered_hot_keys);
8372 defsubr (&Sw32_reconstruct_hot_key);
8373 defsubr (&Sw32_toggle_lock_key);
8374 defsubr (&Sw32_window_exists_p);
8375 defsubr (&Sw32_frame_rect);
8376 defsubr (&Sw32_battery_status);
8378 #ifdef WINDOWSNT
8379 defsubr (&Sfile_system_info);
8380 defsubr (&Sdefault_printer_name);
8381 #endif
8383 defsubr (&Sset_message_beep);
8385 hourglass_hwnd = NULL;
8387 defsubr (&Sx_show_tip);
8388 defsubr (&Sx_hide_tip);
8389 tip_timer = Qnil;
8390 staticpro (&tip_timer);
8391 tip_frame = Qnil;
8392 staticpro (&tip_frame);
8394 last_show_tip_args = Qnil;
8395 staticpro (&last_show_tip_args);
8397 defsubr (&Sx_file_dialog);
8398 #ifdef WINDOWSNT
8399 defsubr (&Ssystem_move_file_to_trash);
8400 #endif
8405 /* Crashing and reporting backtrace. */
8407 #ifndef CYGWIN
8408 static LONG CALLBACK my_exception_handler (EXCEPTION_POINTERS *);
8409 static LPTOP_LEVEL_EXCEPTION_FILTER prev_exception_handler;
8410 #endif
8411 static DWORD except_code;
8412 static PVOID except_addr;
8414 #ifndef CYGWIN
8415 /* This handler records the exception code and the address where it
8416 was triggered so that this info could be included in the backtrace.
8417 Without that, the backtrace in some cases has no information
8418 whatsoever about the offending code, and looks as if the top-level
8419 exception handler in the MinGW startup code di the one that
8420 crashed. */
8421 static LONG CALLBACK
8422 my_exception_handler (EXCEPTION_POINTERS * exception_data)
8424 except_code = exception_data->ExceptionRecord->ExceptionCode;
8425 except_addr = exception_data->ExceptionRecord->ExceptionAddress;
8427 if (prev_exception_handler)
8428 return prev_exception_handler (exception_data);
8429 return EXCEPTION_EXECUTE_HANDLER;
8431 #endif
8433 typedef USHORT (WINAPI * CaptureStackBackTrace_proc) (ULONG, ULONG, PVOID *,
8434 PULONG);
8436 #define BACKTRACE_LIMIT_MAX 62
8439 w32_backtrace (void **buffer, int limit)
8441 static CaptureStackBackTrace_proc s_pfn_CaptureStackBackTrace = NULL;
8442 HMODULE hm_kernel32 = NULL;
8444 if (!s_pfn_CaptureStackBackTrace)
8446 hm_kernel32 = LoadLibrary ("Kernel32.dll");
8447 s_pfn_CaptureStackBackTrace =
8448 (CaptureStackBackTrace_proc) GetProcAddress (hm_kernel32,
8449 "RtlCaptureStackBackTrace");
8451 if (s_pfn_CaptureStackBackTrace)
8452 return s_pfn_CaptureStackBackTrace (0, min (BACKTRACE_LIMIT_MAX, limit),
8453 buffer, NULL);
8454 return 0;
8457 void
8458 emacs_abort (void)
8460 int button;
8461 button = MessageBox (NULL,
8462 "A fatal error has occurred!\n\n"
8463 "Would you like to attach a debugger?\n\n"
8464 "Select:\n"
8465 "YES -- to debug Emacs, or\n"
8466 "NO -- to abort Emacs and produce a backtrace\n"
8467 " (emacs_backtrace.txt in current directory)."
8468 #if __GNUC__
8469 "\n\n(type \"gdb -p <emacs-PID>\" and\n"
8470 "\"continue\" inside GDB before clicking YES.)"
8471 #endif
8472 , "Emacs Abort Dialog",
8473 MB_ICONEXCLAMATION | MB_TASKMODAL
8474 | MB_SETFOREGROUND | MB_YESNO);
8475 switch (button)
8477 case IDYES:
8478 DebugBreak ();
8479 exit (2); /* tell the compiler we will never return */
8480 case IDNO:
8481 default:
8483 void *stack[BACKTRACE_LIMIT_MAX + 1];
8484 int i = w32_backtrace (stack, BACKTRACE_LIMIT_MAX + 1);
8486 if (i)
8488 int errfile_fd = -1;
8489 int j;
8490 char buf[sizeof ("\r\nException at this address:\r\n\r\n")
8491 /* The type below should really be 'void *', but
8492 INT_BUFSIZE_BOUND cannot handle that without
8493 triggering compiler warnings (under certain
8494 pedantic warning switches), it wants an
8495 integer type. */
8496 + 2 * INT_BUFSIZE_BOUND (intptr_t)];
8497 #ifdef CYGWIN
8498 int stderr_fd = 2;
8499 #else
8500 HANDLE errout = GetStdHandle (STD_ERROR_HANDLE);
8501 int stderr_fd = -1;
8503 if (errout && errout != INVALID_HANDLE_VALUE)
8504 stderr_fd = _open_osfhandle ((intptr_t)errout, O_APPEND | O_BINARY);
8505 #endif
8507 /* We use %p, not 0x%p, as %p produces a leading "0x" on XP,
8508 but not on Windows 7. addr2line doesn't mind a missing
8509 "0x", but will be confused by an extra one. */
8510 if (except_addr)
8511 sprintf (buf, "\r\nException 0x%lx at this address:\r\n%p\r\n",
8512 except_code, except_addr);
8513 if (stderr_fd >= 0)
8515 if (except_addr)
8516 write (stderr_fd, buf, strlen (buf));
8517 write (stderr_fd, "\r\nBacktrace:\r\n", 14);
8519 #ifdef CYGWIN
8520 #define _open open
8521 #endif
8522 errfile_fd = _open ("emacs_backtrace.txt", O_RDWR | O_CREAT | O_BINARY, S_IREAD | S_IWRITE);
8523 if (errfile_fd >= 0)
8525 lseek (errfile_fd, 0L, SEEK_END);
8526 if (except_addr)
8527 write (errfile_fd, buf, strlen (buf));
8528 write (errfile_fd, "\r\nBacktrace:\r\n", 14);
8531 for (j = 0; j < i; j++)
8533 /* stack[] gives the return addresses, whereas we want
8534 the address of the call, so decrease each address
8535 by approximate size of 1 CALL instruction. */
8536 sprintf (buf, "%p\r\n", (char *)stack[j] - sizeof(void *));
8537 if (stderr_fd >= 0)
8538 write (stderr_fd, buf, strlen (buf));
8539 if (errfile_fd >= 0)
8540 write (errfile_fd, buf, strlen (buf));
8542 if (i == BACKTRACE_LIMIT_MAX)
8544 if (stderr_fd >= 0)
8545 write (stderr_fd, "...\r\n", 5);
8546 if (errfile_fd >= 0)
8547 write (errfile_fd, "...\r\n", 5);
8549 if (errfile_fd >= 0)
8550 close (errfile_fd);
8552 abort ();
8553 break;
8560 /* Initialization. */
8563 globals_of_w32fns is used to initialize those global variables that
8564 must always be initialized on startup even when the global variable
8565 initialized is non zero (see the function main in emacs.c).
8566 globals_of_w32fns is called from syms_of_w32fns when the global
8567 variable initialized is 0 and directly from main when initialized
8568 is non zero.
8570 void
8571 globals_of_w32fns (void)
8573 HMODULE user32_lib = GetModuleHandle ("user32.dll");
8575 TrackMouseEvent not available in all versions of Windows, so must load
8576 it dynamically. Do it once, here, instead of every time it is used.
8578 track_mouse_event_fn = (TrackMouseEvent_Proc)
8579 GetProcAddress (user32_lib, "TrackMouseEvent");
8581 monitor_from_point_fn = (MonitorFromPoint_Proc)
8582 GetProcAddress (user32_lib, "MonitorFromPoint");
8583 get_monitor_info_fn = (GetMonitorInfo_Proc)
8584 GetProcAddress (user32_lib, "GetMonitorInfoA");
8585 monitor_from_window_fn = (MonitorFromWindow_Proc)
8586 GetProcAddress (user32_lib, "MonitorFromWindow");
8587 enum_display_monitors_fn = (EnumDisplayMonitors_Proc)
8588 GetProcAddress (user32_lib, "EnumDisplayMonitors");
8591 HMODULE imm32_lib = GetModuleHandle ("imm32.dll");
8592 get_composition_string_fn = (ImmGetCompositionString_Proc)
8593 GetProcAddress (imm32_lib, "ImmGetCompositionStringW");
8594 get_ime_context_fn = (ImmGetContext_Proc)
8595 GetProcAddress (imm32_lib, "ImmGetContext");
8596 release_ime_context_fn = (ImmReleaseContext_Proc)
8597 GetProcAddress (imm32_lib, "ImmReleaseContext");
8598 set_ime_composition_window_fn = (ImmSetCompositionWindow_Proc)
8599 GetProcAddress (imm32_lib, "ImmSetCompositionWindow");
8602 except_code = 0;
8603 except_addr = 0;
8604 #ifndef CYGWIN
8605 prev_exception_handler = SetUnhandledExceptionFilter (my_exception_handler);
8606 #endif
8608 DEFVAR_INT ("w32-ansi-code-page",
8609 w32_ansi_code_page,
8610 doc: /* The ANSI code page used by the system. */);
8611 w32_ansi_code_page = GetACP ();
8613 if (os_subtype == OS_NT)
8614 w32_unicode_gui = 1;
8615 else
8616 w32_unicode_gui = 0;
8618 /* MessageBox does not work without this when linked to comctl32.dll 6.0. */
8619 InitCommonControls ();
8621 syms_of_w32uniscribe ();
8624 #ifdef NTGUI_UNICODE
8626 Lisp_Object
8627 ntgui_encode_system (Lisp_Object str)
8629 Lisp_Object encoded;
8630 to_unicode (str, &encoded);
8631 return encoded;
8634 #endif /* NTGUI_UNICODE */