* lisp/subr.el (define-error): New function.
[emacs.git] / src / w32fns.c
blobc43b7d4adf371e75315f59325ff02ac2a986fe37
1 /* Graphical user interface functions for the Microsoft Windows API.
3 Copyright (C) 1989, 1992-2013 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 #endif /* WINDOWSNT */
56 #if CYGWIN
57 #include "cygw32.h"
58 #else
59 #include "w32.h"
60 #endif
62 #include "bitmaps/gray.xbm"
64 #include <commctrl.h>
65 #include <commdlg.h>
66 #include <shellapi.h>
67 #include <ctype.h>
68 #include <winspool.h>
69 #include <objbase.h>
71 #include <dlgs.h>
72 #include <imm.h>
74 #include "font.h"
75 #include "w32font.h"
77 #ifndef FOF_NO_CONNECTED_ELEMENTS
78 #define FOF_NO_CONNECTED_ELEMENTS 0x2000
79 #endif
81 void syms_of_w32fns (void);
82 void globals_of_w32fns (void);
84 extern void free_frame_menubar (struct frame *);
85 extern int w32_console_toggle_lock_key (int, Lisp_Object);
86 extern void w32_menu_display_help (HWND, HMENU, UINT, UINT);
87 extern void w32_free_menu_strings (HWND);
88 extern const char *map_w32_filename (const char *, const char **);
89 extern char * w32_strerror (int error_no);
91 /* If non-NULL, a handle to a frame where to display the hourglass cursor. */
92 static HWND hourglass_hwnd = NULL;
94 #ifndef IDC_HAND
95 #define IDC_HAND MAKEINTRESOURCE(32649)
96 #endif
98 Lisp_Object Qsuppress_icon;
99 Lisp_Object Qundefined_color;
100 Lisp_Object Qcancel_timer;
101 Lisp_Object Qfont_param;
102 Lisp_Object Qhyper;
103 Lisp_Object Qsuper;
104 Lisp_Object Qmeta;
105 Lisp_Object Qalt;
106 Lisp_Object Qctrl;
107 Lisp_Object Qcontrol;
108 Lisp_Object Qshift;
109 static Lisp_Object Qgeometry, Qworkarea, Qmm_size, Qframes;
112 /* Prefix for system colors. */
113 #define SYSTEM_COLOR_PREFIX "System"
114 #define SYSTEM_COLOR_PREFIX_LEN (sizeof (SYSTEM_COLOR_PREFIX) - 1)
116 /* State variables for emulating a three button mouse. */
117 #define LMOUSE 1
118 #define MMOUSE 2
119 #define RMOUSE 4
121 static int button_state = 0;
122 static W32Msg saved_mouse_button_msg;
123 static unsigned mouse_button_timer = 0; /* non-zero when timer is active */
124 static W32Msg saved_mouse_move_msg;
125 static unsigned mouse_move_timer = 0;
127 /* Window that is tracking the mouse. */
128 static HWND track_mouse_window;
130 /* Multi-monitor API definitions that are not pulled from the headers
131 since we are compiling for NT 4. */
132 #ifndef MONITOR_DEFAULT_TO_NEAREST
133 #define MONITOR_DEFAULT_TO_NEAREST 2
134 #endif
135 #ifndef MONITORINFOF_PRIMARY
136 #define MONITORINFOF_PRIMARY 1
137 #endif
138 #ifndef SM_XVIRTUALSCREEN
139 #define SM_XVIRTUALSCREEN 76
140 #endif
141 #ifndef SM_YVIRTUALSCREEN
142 #define SM_YVIRTUALSCREEN 77
143 #endif
144 /* MinGW headers define MONITORINFO unconditionally, but MSVC ones don't.
145 To avoid a compile error on one or the other, redefine with a new name. */
146 struct MONITOR_INFO
148 DWORD cbSize;
149 RECT rcMonitor;
150 RECT rcWork;
151 DWORD dwFlags;
154 #ifndef CCHDEVICENAME
155 #define CCHDEVICENAME 32
156 #endif
157 struct MONITOR_INFO_EX
159 DWORD cbSize;
160 RECT rcMonitor;
161 RECT rcWork;
162 DWORD dwFlags;
163 char szDevice[CCHDEVICENAME];
166 /* Reportedly, MSVC does not have this in its headers. */
167 #if defined (_MSC_VER) && _WIN32_WINNT < 0x0500
168 DECLARE_HANDLE(HMONITOR);
169 #endif
171 typedef BOOL (WINAPI * TrackMouseEvent_Proc)
172 (IN OUT LPTRACKMOUSEEVENT lpEventTrack);
173 typedef LONG (WINAPI * ImmGetCompositionString_Proc)
174 (IN HIMC context, IN DWORD index, OUT LPVOID buffer, IN DWORD bufLen);
175 typedef HIMC (WINAPI * ImmGetContext_Proc) (IN HWND window);
176 typedef HWND (WINAPI * ImmReleaseContext_Proc) (IN HWND wnd, IN HIMC context);
177 typedef HWND (WINAPI * ImmSetCompositionWindow_Proc) (IN HIMC context,
178 IN COMPOSITIONFORM *form);
179 typedef HMONITOR (WINAPI * MonitorFromPoint_Proc) (IN POINT pt, IN DWORD flags);
180 typedef BOOL (WINAPI * GetMonitorInfo_Proc)
181 (IN HMONITOR monitor, OUT struct MONITOR_INFO* info);
182 typedef HMONITOR (WINAPI * MonitorFromWindow_Proc)
183 (IN HWND hwnd, IN DWORD dwFlags);
184 typedef BOOL CALLBACK (* MonitorEnum_Proc)
185 (IN HMONITOR monitor, IN HDC hdc, IN RECT *rcMonitor, IN LPARAM dwData);
186 typedef BOOL (WINAPI * EnumDisplayMonitors_Proc)
187 (IN HDC hdc, IN RECT *rcClip, IN MonitorEnum_Proc fnEnum, IN LPARAM dwData);
189 TrackMouseEvent_Proc track_mouse_event_fn = NULL;
190 ImmGetCompositionString_Proc get_composition_string_fn = NULL;
191 ImmGetContext_Proc get_ime_context_fn = NULL;
192 ImmReleaseContext_Proc release_ime_context_fn = NULL;
193 ImmSetCompositionWindow_Proc set_ime_composition_window_fn = NULL;
194 MonitorFromPoint_Proc monitor_from_point_fn = NULL;
195 GetMonitorInfo_Proc get_monitor_info_fn = NULL;
196 MonitorFromWindow_Proc monitor_from_window_fn = NULL;
197 EnumDisplayMonitors_Proc enum_display_monitors_fn = NULL;
199 #ifdef NTGUI_UNICODE
200 #define unicode_append_menu AppendMenuW
201 #else /* !NTGUI_UNICODE */
202 extern AppendMenuW_Proc unicode_append_menu;
203 #endif /* NTGUI_UNICODE */
205 /* Flag to selectively ignore WM_IME_CHAR messages. */
206 static int ignore_ime_char = 0;
208 /* W95 mousewheel handler */
209 unsigned int msh_mousewheel = 0;
211 /* Timers */
212 #define MOUSE_BUTTON_ID 1
213 #define MOUSE_MOVE_ID 2
214 #define MENU_FREE_ID 3
215 /* The delay (milliseconds) before a menu is freed after WM_EXITMENULOOP
216 is received. */
217 #define MENU_FREE_DELAY 1000
218 static unsigned menu_free_timer = 0;
220 #ifdef GLYPH_DEBUG
221 static int image_cache_refcount, dpyinfo_refcount;
222 #endif
224 static HWND w32_visible_system_caret_hwnd;
226 static int w32_unicode_gui;
228 /* From w32menu.c */
229 extern HMENU current_popup_menu;
230 static int menubar_in_use = 0;
232 /* From w32uniscribe.c */
233 extern void syms_of_w32uniscribe (void);
234 extern int uniscribe_available;
236 /* Function prototypes for hourglass support. */
237 static void w32_show_hourglass (struct frame *);
238 static void w32_hide_hourglass (void);
240 #ifdef WINDOWSNT
241 /* From w32inevt.c */
242 extern int faked_key;
243 #endif /* WINDOWSNT */
245 /* This gives us the page size and the size of the allocation unit on NT. */
246 SYSTEM_INFO sysinfo_cache;
248 /* This gives us version, build, and platform identification. */
249 OSVERSIONINFO osinfo_cache;
251 DWORD_PTR syspage_mask = 0;
253 /* The major and minor versions of NT. */
254 int w32_major_version;
255 int w32_minor_version;
256 int w32_build_number;
258 /* Distinguish between Windows NT and Windows 95. */
259 int os_subtype;
261 #ifdef HAVE_NTGUI
262 HINSTANCE hinst = NULL;
263 #endif
265 static unsigned int sound_type = 0xFFFFFFFF;
266 #define MB_EMACS_SILENT (0xFFFFFFFF - 1)
268 /* Let the user specify a display with a frame.
269 nil stands for the selected frame--or, if that is not a w32 frame,
270 the first display on the list. */
272 struct w32_display_info *
273 check_x_display_info (Lisp_Object frame)
275 if (NILP (frame))
277 struct frame *sf = XFRAME (selected_frame);
279 if (FRAME_W32_P (sf) && FRAME_LIVE_P (sf))
280 return FRAME_W32_DISPLAY_INFO (sf);
281 else
282 return &one_w32_display_info;
284 else if (STRINGP (frame))
285 return x_display_info_for_name (frame);
286 else
288 struct frame *f;
290 CHECK_LIVE_FRAME (frame);
291 f = XFRAME (frame);
292 if (! FRAME_W32_P (f))
293 error ("Non-W32 frame used");
294 return FRAME_W32_DISPLAY_INFO (f);
298 /* Return the Emacs frame-object corresponding to an w32 window.
299 It could be the frame's main window or an icon window. */
301 struct frame *
302 x_window_to_frame (struct w32_display_info *dpyinfo, HWND wdesc)
304 Lisp_Object tail, frame;
305 struct frame *f;
307 FOR_EACH_FRAME (tail, frame)
309 f = XFRAME (frame);
310 if (!FRAME_W32_P (f) || FRAME_W32_DISPLAY_INFO (f) != dpyinfo)
311 continue;
313 if (FRAME_W32_WINDOW (f) == wdesc)
314 return f;
316 return 0;
320 static Lisp_Object unwind_create_frame (Lisp_Object);
321 static void unwind_create_tip_frame (Lisp_Object);
322 static void my_create_window (struct frame *);
323 static void my_create_tip_window (struct frame *);
325 /* TODO: Native Input Method support; see x_create_im. */
326 void x_set_foreground_color (struct frame *, Lisp_Object, Lisp_Object);
327 void x_set_background_color (struct frame *, Lisp_Object, Lisp_Object);
328 void x_set_mouse_color (struct frame *, Lisp_Object, Lisp_Object);
329 void x_set_cursor_color (struct frame *, Lisp_Object, Lisp_Object);
330 void x_set_border_color (struct frame *, Lisp_Object, Lisp_Object);
331 void x_set_cursor_type (struct frame *, Lisp_Object, Lisp_Object);
332 void x_set_icon_type (struct frame *, Lisp_Object, Lisp_Object);
333 void x_set_icon_name (struct frame *, Lisp_Object, Lisp_Object);
334 void x_explicitly_set_name (struct frame *, Lisp_Object, Lisp_Object);
335 void x_set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
336 void x_set_title (struct frame *, Lisp_Object, Lisp_Object);
337 void x_set_tool_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
342 /* Store the screen positions of frame F into XPTR and YPTR.
343 These are the positions of the containing window manager window,
344 not Emacs's own window. */
346 void
347 x_real_positions (struct frame *f, int *xptr, int *yptr)
349 POINT pt;
350 RECT rect;
352 /* Get the bounds of the WM window. */
353 GetWindowRect (FRAME_W32_WINDOW (f), &rect);
355 pt.x = 0;
356 pt.y = 0;
358 /* Convert (0, 0) in the client area to screen co-ordinates. */
359 ClientToScreen (FRAME_W32_WINDOW (f), &pt);
361 /* Remember x_pixels_diff and y_pixels_diff. */
362 f->x_pixels_diff = pt.x - rect.left;
363 f->y_pixels_diff = pt.y - rect.top;
365 *xptr = rect.left;
366 *yptr = rect.top;
369 /* Returns the window rectangle appropriate for the given fullscreen mode.
370 The normal rect parameter was the window's rectangle prior to entering
371 fullscreen mode. If multiple monitor support is available, the nearest
372 monitor to the window is chosen. */
374 void
375 w32_fullscreen_rect (HWND hwnd, int fsmode, RECT normal, RECT *rect)
377 struct MONITOR_INFO mi = { sizeof(mi) };
378 if (monitor_from_window_fn && get_monitor_info_fn)
380 HMONITOR monitor =
381 monitor_from_window_fn (hwnd, MONITOR_DEFAULT_TO_NEAREST);
382 get_monitor_info_fn (monitor, &mi);
384 else
386 mi.rcMonitor.left = 0;
387 mi.rcMonitor.top = 0;
388 mi.rcMonitor.right = GetSystemMetrics (SM_CXSCREEN);
389 mi.rcMonitor.bottom = GetSystemMetrics (SM_CYSCREEN);
390 mi.rcWork.left = 0;
391 mi.rcWork.top = 0;
392 mi.rcWork.right = GetSystemMetrics (SM_CXMAXIMIZED);
393 mi.rcWork.bottom = GetSystemMetrics (SM_CYMAXIMIZED);
396 switch (fsmode)
398 case FULLSCREEN_BOTH:
399 rect->left = mi.rcMonitor.left;
400 rect->top = mi.rcMonitor.top;
401 rect->right = mi.rcMonitor.right;
402 rect->bottom = mi.rcMonitor.bottom;
403 break;
404 case FULLSCREEN_MAXIMIZED:
405 rect->left = mi.rcWork.left;
406 rect->top = mi.rcWork.top;
407 rect->right = mi.rcWork.right;
408 rect->bottom = mi.rcWork.bottom;
409 break;
410 case FULLSCREEN_WIDTH:
411 rect->left = mi.rcWork.left;
412 rect->top = normal.top;
413 rect->right = mi.rcWork.right;
414 rect->bottom = normal.bottom;
415 break;
416 case FULLSCREEN_HEIGHT:
417 rect->left = normal.left;
418 rect->top = mi.rcWork.top;
419 rect->right = normal.right;
420 rect->bottom = mi.rcWork.bottom;
421 break;
422 case FULLSCREEN_NONE:
423 default:
424 *rect = normal;
425 break;
431 DEFUN ("w32-define-rgb-color", Fw32_define_rgb_color,
432 Sw32_define_rgb_color, 4, 4, 0,
433 doc: /* Convert RGB numbers to a Windows color reference and associate with NAME.
434 This adds or updates a named color to `w32-color-map', making it
435 available for use. The original entry's RGB ref is returned, or nil
436 if the entry is new. */)
437 (Lisp_Object red, Lisp_Object green, Lisp_Object blue, Lisp_Object name)
439 Lisp_Object rgb;
440 Lisp_Object oldrgb = Qnil;
441 Lisp_Object entry;
443 CHECK_NUMBER (red);
444 CHECK_NUMBER (green);
445 CHECK_NUMBER (blue);
446 CHECK_STRING (name);
448 XSETINT (rgb, RGB (XUINT (red), XUINT (green), XUINT (blue)));
450 block_input ();
452 /* replace existing entry in w32-color-map or add new entry. */
453 entry = Fassoc (name, Vw32_color_map);
454 if (NILP (entry))
456 entry = Fcons (name, rgb);
457 Vw32_color_map = Fcons (entry, Vw32_color_map);
459 else
461 oldrgb = Fcdr (entry);
462 Fsetcdr (entry, rgb);
465 unblock_input ();
467 return (oldrgb);
470 /* The default colors for the w32 color map */
471 typedef struct colormap_t
473 char *name;
474 COLORREF colorref;
475 } colormap_t;
477 colormap_t w32_color_map[] =
479 {"snow" , PALETTERGB (255,250,250)},
480 {"ghost white" , PALETTERGB (248,248,255)},
481 {"GhostWhite" , PALETTERGB (248,248,255)},
482 {"white smoke" , PALETTERGB (245,245,245)},
483 {"WhiteSmoke" , PALETTERGB (245,245,245)},
484 {"gainsboro" , PALETTERGB (220,220,220)},
485 {"floral white" , PALETTERGB (255,250,240)},
486 {"FloralWhite" , PALETTERGB (255,250,240)},
487 {"old lace" , PALETTERGB (253,245,230)},
488 {"OldLace" , PALETTERGB (253,245,230)},
489 {"linen" , PALETTERGB (250,240,230)},
490 {"antique white" , PALETTERGB (250,235,215)},
491 {"AntiqueWhite" , PALETTERGB (250,235,215)},
492 {"papaya whip" , PALETTERGB (255,239,213)},
493 {"PapayaWhip" , PALETTERGB (255,239,213)},
494 {"blanched almond" , PALETTERGB (255,235,205)},
495 {"BlanchedAlmond" , PALETTERGB (255,235,205)},
496 {"bisque" , PALETTERGB (255,228,196)},
497 {"peach puff" , PALETTERGB (255,218,185)},
498 {"PeachPuff" , PALETTERGB (255,218,185)},
499 {"navajo white" , PALETTERGB (255,222,173)},
500 {"NavajoWhite" , PALETTERGB (255,222,173)},
501 {"moccasin" , PALETTERGB (255,228,181)},
502 {"cornsilk" , PALETTERGB (255,248,220)},
503 {"ivory" , PALETTERGB (255,255,240)},
504 {"lemon chiffon" , PALETTERGB (255,250,205)},
505 {"LemonChiffon" , PALETTERGB (255,250,205)},
506 {"seashell" , PALETTERGB (255,245,238)},
507 {"honeydew" , PALETTERGB (240,255,240)},
508 {"mint cream" , PALETTERGB (245,255,250)},
509 {"MintCream" , PALETTERGB (245,255,250)},
510 {"azure" , PALETTERGB (240,255,255)},
511 {"alice blue" , PALETTERGB (240,248,255)},
512 {"AliceBlue" , PALETTERGB (240,248,255)},
513 {"lavender" , PALETTERGB (230,230,250)},
514 {"lavender blush" , PALETTERGB (255,240,245)},
515 {"LavenderBlush" , PALETTERGB (255,240,245)},
516 {"misty rose" , PALETTERGB (255,228,225)},
517 {"MistyRose" , PALETTERGB (255,228,225)},
518 {"white" , PALETTERGB (255,255,255)},
519 {"black" , PALETTERGB ( 0, 0, 0)},
520 {"dark slate gray" , PALETTERGB ( 47, 79, 79)},
521 {"DarkSlateGray" , PALETTERGB ( 47, 79, 79)},
522 {"dark slate grey" , PALETTERGB ( 47, 79, 79)},
523 {"DarkSlateGrey" , PALETTERGB ( 47, 79, 79)},
524 {"dim gray" , PALETTERGB (105,105,105)},
525 {"DimGray" , PALETTERGB (105,105,105)},
526 {"dim grey" , PALETTERGB (105,105,105)},
527 {"DimGrey" , PALETTERGB (105,105,105)},
528 {"slate gray" , PALETTERGB (112,128,144)},
529 {"SlateGray" , PALETTERGB (112,128,144)},
530 {"slate grey" , PALETTERGB (112,128,144)},
531 {"SlateGrey" , PALETTERGB (112,128,144)},
532 {"light slate gray" , PALETTERGB (119,136,153)},
533 {"LightSlateGray" , PALETTERGB (119,136,153)},
534 {"light slate grey" , PALETTERGB (119,136,153)},
535 {"LightSlateGrey" , PALETTERGB (119,136,153)},
536 {"gray" , PALETTERGB (190,190,190)},
537 {"grey" , PALETTERGB (190,190,190)},
538 {"light grey" , PALETTERGB (211,211,211)},
539 {"LightGrey" , PALETTERGB (211,211,211)},
540 {"light gray" , PALETTERGB (211,211,211)},
541 {"LightGray" , PALETTERGB (211,211,211)},
542 {"midnight blue" , PALETTERGB ( 25, 25,112)},
543 {"MidnightBlue" , PALETTERGB ( 25, 25,112)},
544 {"navy" , PALETTERGB ( 0, 0,128)},
545 {"navy blue" , PALETTERGB ( 0, 0,128)},
546 {"NavyBlue" , PALETTERGB ( 0, 0,128)},
547 {"cornflower blue" , PALETTERGB (100,149,237)},
548 {"CornflowerBlue" , PALETTERGB (100,149,237)},
549 {"dark slate blue" , PALETTERGB ( 72, 61,139)},
550 {"DarkSlateBlue" , PALETTERGB ( 72, 61,139)},
551 {"slate blue" , PALETTERGB (106, 90,205)},
552 {"SlateBlue" , PALETTERGB (106, 90,205)},
553 {"medium slate blue" , PALETTERGB (123,104,238)},
554 {"MediumSlateBlue" , PALETTERGB (123,104,238)},
555 {"light slate blue" , PALETTERGB (132,112,255)},
556 {"LightSlateBlue" , PALETTERGB (132,112,255)},
557 {"medium blue" , PALETTERGB ( 0, 0,205)},
558 {"MediumBlue" , PALETTERGB ( 0, 0,205)},
559 {"royal blue" , PALETTERGB ( 65,105,225)},
560 {"RoyalBlue" , PALETTERGB ( 65,105,225)},
561 {"blue" , PALETTERGB ( 0, 0,255)},
562 {"dodger blue" , PALETTERGB ( 30,144,255)},
563 {"DodgerBlue" , PALETTERGB ( 30,144,255)},
564 {"deep sky blue" , PALETTERGB ( 0,191,255)},
565 {"DeepSkyBlue" , PALETTERGB ( 0,191,255)},
566 {"sky blue" , PALETTERGB (135,206,235)},
567 {"SkyBlue" , PALETTERGB (135,206,235)},
568 {"light sky blue" , PALETTERGB (135,206,250)},
569 {"LightSkyBlue" , PALETTERGB (135,206,250)},
570 {"steel blue" , PALETTERGB ( 70,130,180)},
571 {"SteelBlue" , PALETTERGB ( 70,130,180)},
572 {"light steel blue" , PALETTERGB (176,196,222)},
573 {"LightSteelBlue" , PALETTERGB (176,196,222)},
574 {"light blue" , PALETTERGB (173,216,230)},
575 {"LightBlue" , PALETTERGB (173,216,230)},
576 {"powder blue" , PALETTERGB (176,224,230)},
577 {"PowderBlue" , PALETTERGB (176,224,230)},
578 {"pale turquoise" , PALETTERGB (175,238,238)},
579 {"PaleTurquoise" , PALETTERGB (175,238,238)},
580 {"dark turquoise" , PALETTERGB ( 0,206,209)},
581 {"DarkTurquoise" , PALETTERGB ( 0,206,209)},
582 {"medium turquoise" , PALETTERGB ( 72,209,204)},
583 {"MediumTurquoise" , PALETTERGB ( 72,209,204)},
584 {"turquoise" , PALETTERGB ( 64,224,208)},
585 {"cyan" , PALETTERGB ( 0,255,255)},
586 {"light cyan" , PALETTERGB (224,255,255)},
587 {"LightCyan" , PALETTERGB (224,255,255)},
588 {"cadet blue" , PALETTERGB ( 95,158,160)},
589 {"CadetBlue" , PALETTERGB ( 95,158,160)},
590 {"medium aquamarine" , PALETTERGB (102,205,170)},
591 {"MediumAquamarine" , PALETTERGB (102,205,170)},
592 {"aquamarine" , PALETTERGB (127,255,212)},
593 {"dark green" , PALETTERGB ( 0,100, 0)},
594 {"DarkGreen" , PALETTERGB ( 0,100, 0)},
595 {"dark olive green" , PALETTERGB ( 85,107, 47)},
596 {"DarkOliveGreen" , PALETTERGB ( 85,107, 47)},
597 {"dark sea green" , PALETTERGB (143,188,143)},
598 {"DarkSeaGreen" , PALETTERGB (143,188,143)},
599 {"sea green" , PALETTERGB ( 46,139, 87)},
600 {"SeaGreen" , PALETTERGB ( 46,139, 87)},
601 {"medium sea green" , PALETTERGB ( 60,179,113)},
602 {"MediumSeaGreen" , PALETTERGB ( 60,179,113)},
603 {"light sea green" , PALETTERGB ( 32,178,170)},
604 {"LightSeaGreen" , PALETTERGB ( 32,178,170)},
605 {"pale green" , PALETTERGB (152,251,152)},
606 {"PaleGreen" , PALETTERGB (152,251,152)},
607 {"spring green" , PALETTERGB ( 0,255,127)},
608 {"SpringGreen" , PALETTERGB ( 0,255,127)},
609 {"lawn green" , PALETTERGB (124,252, 0)},
610 {"LawnGreen" , PALETTERGB (124,252, 0)},
611 {"green" , PALETTERGB ( 0,255, 0)},
612 {"chartreuse" , PALETTERGB (127,255, 0)},
613 {"medium spring green" , PALETTERGB ( 0,250,154)},
614 {"MediumSpringGreen" , PALETTERGB ( 0,250,154)},
615 {"green yellow" , PALETTERGB (173,255, 47)},
616 {"GreenYellow" , PALETTERGB (173,255, 47)},
617 {"lime green" , PALETTERGB ( 50,205, 50)},
618 {"LimeGreen" , PALETTERGB ( 50,205, 50)},
619 {"yellow green" , PALETTERGB (154,205, 50)},
620 {"YellowGreen" , PALETTERGB (154,205, 50)},
621 {"forest green" , PALETTERGB ( 34,139, 34)},
622 {"ForestGreen" , PALETTERGB ( 34,139, 34)},
623 {"olive drab" , PALETTERGB (107,142, 35)},
624 {"OliveDrab" , PALETTERGB (107,142, 35)},
625 {"dark khaki" , PALETTERGB (189,183,107)},
626 {"DarkKhaki" , PALETTERGB (189,183,107)},
627 {"khaki" , PALETTERGB (240,230,140)},
628 {"pale goldenrod" , PALETTERGB (238,232,170)},
629 {"PaleGoldenrod" , PALETTERGB (238,232,170)},
630 {"light goldenrod yellow" , PALETTERGB (250,250,210)},
631 {"LightGoldenrodYellow" , PALETTERGB (250,250,210)},
632 {"light yellow" , PALETTERGB (255,255,224)},
633 {"LightYellow" , PALETTERGB (255,255,224)},
634 {"yellow" , PALETTERGB (255,255, 0)},
635 {"gold" , PALETTERGB (255,215, 0)},
636 {"light goldenrod" , PALETTERGB (238,221,130)},
637 {"LightGoldenrod" , PALETTERGB (238,221,130)},
638 {"goldenrod" , PALETTERGB (218,165, 32)},
639 {"dark goldenrod" , PALETTERGB (184,134, 11)},
640 {"DarkGoldenrod" , PALETTERGB (184,134, 11)},
641 {"rosy brown" , PALETTERGB (188,143,143)},
642 {"RosyBrown" , PALETTERGB (188,143,143)},
643 {"indian red" , PALETTERGB (205, 92, 92)},
644 {"IndianRed" , PALETTERGB (205, 92, 92)},
645 {"saddle brown" , PALETTERGB (139, 69, 19)},
646 {"SaddleBrown" , PALETTERGB (139, 69, 19)},
647 {"sienna" , PALETTERGB (160, 82, 45)},
648 {"peru" , PALETTERGB (205,133, 63)},
649 {"burlywood" , PALETTERGB (222,184,135)},
650 {"beige" , PALETTERGB (245,245,220)},
651 {"wheat" , PALETTERGB (245,222,179)},
652 {"sandy brown" , PALETTERGB (244,164, 96)},
653 {"SandyBrown" , PALETTERGB (244,164, 96)},
654 {"tan" , PALETTERGB (210,180,140)},
655 {"chocolate" , PALETTERGB (210,105, 30)},
656 {"firebrick" , PALETTERGB (178,34, 34)},
657 {"brown" , PALETTERGB (165,42, 42)},
658 {"dark salmon" , PALETTERGB (233,150,122)},
659 {"DarkSalmon" , PALETTERGB (233,150,122)},
660 {"salmon" , PALETTERGB (250,128,114)},
661 {"light salmon" , PALETTERGB (255,160,122)},
662 {"LightSalmon" , PALETTERGB (255,160,122)},
663 {"orange" , PALETTERGB (255,165, 0)},
664 {"dark orange" , PALETTERGB (255,140, 0)},
665 {"DarkOrange" , PALETTERGB (255,140, 0)},
666 {"coral" , PALETTERGB (255,127, 80)},
667 {"light coral" , PALETTERGB (240,128,128)},
668 {"LightCoral" , PALETTERGB (240,128,128)},
669 {"tomato" , PALETTERGB (255, 99, 71)},
670 {"orange red" , PALETTERGB (255, 69, 0)},
671 {"OrangeRed" , PALETTERGB (255, 69, 0)},
672 {"red" , PALETTERGB (255, 0, 0)},
673 {"hot pink" , PALETTERGB (255,105,180)},
674 {"HotPink" , PALETTERGB (255,105,180)},
675 {"deep pink" , PALETTERGB (255, 20,147)},
676 {"DeepPink" , PALETTERGB (255, 20,147)},
677 {"pink" , PALETTERGB (255,192,203)},
678 {"light pink" , PALETTERGB (255,182,193)},
679 {"LightPink" , PALETTERGB (255,182,193)},
680 {"pale violet red" , PALETTERGB (219,112,147)},
681 {"PaleVioletRed" , PALETTERGB (219,112,147)},
682 {"maroon" , PALETTERGB (176, 48, 96)},
683 {"medium violet red" , PALETTERGB (199, 21,133)},
684 {"MediumVioletRed" , PALETTERGB (199, 21,133)},
685 {"violet red" , PALETTERGB (208, 32,144)},
686 {"VioletRed" , PALETTERGB (208, 32,144)},
687 {"magenta" , PALETTERGB (255, 0,255)},
688 {"violet" , PALETTERGB (238,130,238)},
689 {"plum" , PALETTERGB (221,160,221)},
690 {"orchid" , PALETTERGB (218,112,214)},
691 {"medium orchid" , PALETTERGB (186, 85,211)},
692 {"MediumOrchid" , PALETTERGB (186, 85,211)},
693 {"dark orchid" , PALETTERGB (153, 50,204)},
694 {"DarkOrchid" , PALETTERGB (153, 50,204)},
695 {"dark violet" , PALETTERGB (148, 0,211)},
696 {"DarkViolet" , PALETTERGB (148, 0,211)},
697 {"blue violet" , PALETTERGB (138, 43,226)},
698 {"BlueViolet" , PALETTERGB (138, 43,226)},
699 {"purple" , PALETTERGB (160, 32,240)},
700 {"medium purple" , PALETTERGB (147,112,219)},
701 {"MediumPurple" , PALETTERGB (147,112,219)},
702 {"thistle" , PALETTERGB (216,191,216)},
703 {"gray0" , PALETTERGB ( 0, 0, 0)},
704 {"grey0" , PALETTERGB ( 0, 0, 0)},
705 {"dark grey" , PALETTERGB (169,169,169)},
706 {"DarkGrey" , PALETTERGB (169,169,169)},
707 {"dark gray" , PALETTERGB (169,169,169)},
708 {"DarkGray" , PALETTERGB (169,169,169)},
709 {"dark blue" , PALETTERGB ( 0, 0,139)},
710 {"DarkBlue" , PALETTERGB ( 0, 0,139)},
711 {"dark cyan" , PALETTERGB ( 0,139,139)},
712 {"DarkCyan" , PALETTERGB ( 0,139,139)},
713 {"dark magenta" , PALETTERGB (139, 0,139)},
714 {"DarkMagenta" , PALETTERGB (139, 0,139)},
715 {"dark red" , PALETTERGB (139, 0, 0)},
716 {"DarkRed" , PALETTERGB (139, 0, 0)},
717 {"light green" , PALETTERGB (144,238,144)},
718 {"LightGreen" , PALETTERGB (144,238,144)},
721 static Lisp_Object
722 w32_default_color_map (void)
724 int i;
725 colormap_t *pc = w32_color_map;
726 Lisp_Object cmap;
728 block_input ();
730 cmap = Qnil;
732 for (i = 0; i < sizeof (w32_color_map) / sizeof (w32_color_map[0]);
733 pc++, i++)
734 cmap = Fcons (Fcons (build_string (pc->name),
735 make_number (pc->colorref)),
736 cmap);
738 unblock_input ();
740 return (cmap);
743 DEFUN ("w32-default-color-map", Fw32_default_color_map, Sw32_default_color_map,
744 0, 0, 0, doc: /* Return the default color map. */)
745 (void)
747 return w32_default_color_map ();
750 static Lisp_Object
751 w32_color_map_lookup (const char *colorname)
753 Lisp_Object tail, ret = Qnil;
755 block_input ();
757 for (tail = Vw32_color_map; CONSP (tail); tail = XCDR (tail))
759 register Lisp_Object elt, tem;
761 elt = XCAR (tail);
762 if (!CONSP (elt)) continue;
764 tem = XCAR (elt);
766 if (lstrcmpi (SDATA (tem), colorname) == 0)
768 ret = Fcdr (elt);
769 break;
772 QUIT;
775 unblock_input ();
777 return ret;
781 static void
782 add_system_logical_colors_to_map (Lisp_Object *system_colors)
784 HKEY colors_key;
786 /* Other registry operations are done with input blocked. */
787 block_input ();
789 /* Look for "Control Panel/Colors" under User and Machine registry
790 settings. */
791 if (RegOpenKeyEx (HKEY_CURRENT_USER, "Control Panel\\Colors", 0,
792 KEY_READ, &colors_key) == ERROR_SUCCESS
793 || RegOpenKeyEx (HKEY_LOCAL_MACHINE, "Control Panel\\Colors", 0,
794 KEY_READ, &colors_key) == ERROR_SUCCESS)
796 /* List all keys. */
797 char color_buffer[64];
798 char full_name_buffer[MAX_PATH + SYSTEM_COLOR_PREFIX_LEN];
799 int index = 0;
800 DWORD name_size, color_size;
801 char *name_buffer = full_name_buffer + SYSTEM_COLOR_PREFIX_LEN;
803 name_size = sizeof (full_name_buffer) - SYSTEM_COLOR_PREFIX_LEN;
804 color_size = sizeof (color_buffer);
806 strcpy (full_name_buffer, SYSTEM_COLOR_PREFIX);
808 while (RegEnumValueA (colors_key, index, name_buffer, &name_size,
809 NULL, NULL, color_buffer, &color_size)
810 == ERROR_SUCCESS)
812 int r, g, b;
813 if (sscanf (color_buffer, " %u %u %u", &r, &g, &b) == 3)
814 *system_colors = Fcons (Fcons (build_string (full_name_buffer),
815 make_number (RGB (r, g, b))),
816 *system_colors);
818 name_size = sizeof (full_name_buffer) - SYSTEM_COLOR_PREFIX_LEN;
819 color_size = sizeof (color_buffer);
820 index++;
822 RegCloseKey (colors_key);
825 unblock_input ();
829 static Lisp_Object
830 x_to_w32_color (const char * colorname)
832 register Lisp_Object ret = Qnil;
834 block_input ();
836 if (colorname[0] == '#')
838 /* Could be an old-style RGB Device specification. */
839 int size = strlen (colorname + 1);
840 char *color = alloca (size + 1);
842 strcpy (color, colorname + 1);
843 if (size == 3 || size == 6 || size == 9 || size == 12)
845 UINT colorval;
846 int i, pos;
847 pos = 0;
848 size /= 3;
849 colorval = 0;
851 for (i = 0; i < 3; i++)
853 char *end;
854 char t;
855 unsigned long value;
857 /* The check for 'x' in the following conditional takes into
858 account the fact that strtol allows a "0x" in front of
859 our numbers, and we don't. */
860 if (!isxdigit (color[0]) || color[1] == 'x')
861 break;
862 t = color[size];
863 color[size] = '\0';
864 value = strtoul (color, &end, 16);
865 color[size] = t;
866 if (errno == ERANGE || end - color != size)
867 break;
868 switch (size)
870 case 1:
871 value = value * 0x10;
872 break;
873 case 2:
874 break;
875 case 3:
876 value /= 0x10;
877 break;
878 case 4:
879 value /= 0x100;
880 break;
882 colorval |= (value << pos);
883 pos += 0x8;
884 if (i == 2)
886 unblock_input ();
887 XSETINT (ret, colorval);
888 return ret;
890 color = end;
894 else if (strnicmp (colorname, "rgb:", 4) == 0)
896 const char *color;
897 UINT colorval;
898 int i, pos;
899 pos = 0;
901 colorval = 0;
902 color = colorname + 4;
903 for (i = 0; i < 3; i++)
905 char *end;
906 unsigned long value;
908 /* The check for 'x' in the following conditional takes into
909 account the fact that strtol allows a "0x" in front of
910 our numbers, and we don't. */
911 if (!isxdigit (color[0]) || color[1] == 'x')
912 break;
913 value = strtoul (color, &end, 16);
914 if (errno == ERANGE)
915 break;
916 switch (end - color)
918 case 1:
919 value = value * 0x10 + value;
920 break;
921 case 2:
922 break;
923 case 3:
924 value /= 0x10;
925 break;
926 case 4:
927 value /= 0x100;
928 break;
929 default:
930 value = ULONG_MAX;
932 if (value == ULONG_MAX)
933 break;
934 colorval |= (value << pos);
935 pos += 0x8;
936 if (i == 2)
938 if (*end != '\0')
939 break;
940 unblock_input ();
941 XSETINT (ret, colorval);
942 return ret;
944 if (*end != '/')
945 break;
946 color = end + 1;
949 else if (strnicmp (colorname, "rgbi:", 5) == 0)
951 /* This is an RGB Intensity specification. */
952 const char *color;
953 UINT colorval;
954 int i, pos;
955 pos = 0;
957 colorval = 0;
958 color = colorname + 5;
959 for (i = 0; i < 3; i++)
961 char *end;
962 double value;
963 UINT val;
965 value = strtod (color, &end);
966 if (errno == ERANGE)
967 break;
968 if (value < 0.0 || value > 1.0)
969 break;
970 val = (UINT)(0x100 * value);
971 /* We used 0x100 instead of 0xFF to give a continuous
972 range between 0.0 and 1.0 inclusive. The next statement
973 fixes the 1.0 case. */
974 if (val == 0x100)
975 val = 0xFF;
976 colorval |= (val << pos);
977 pos += 0x8;
978 if (i == 2)
980 if (*end != '\0')
981 break;
982 unblock_input ();
983 XSETINT (ret, colorval);
984 return ret;
986 if (*end != '/')
987 break;
988 color = end + 1;
991 /* I am not going to attempt to handle any of the CIE color schemes
992 or TekHVC, since I don't know the algorithms for conversion to
993 RGB. */
995 /* If we fail to lookup the color name in w32_color_map, then check the
996 colorname to see if it can be crudely approximated: If the X color
997 ends in a number (e.g., "darkseagreen2"), strip the number and
998 return the result of looking up the base color name. */
999 ret = w32_color_map_lookup (colorname);
1000 if (NILP (ret))
1002 int len = strlen (colorname);
1004 if (isdigit (colorname[len - 1]))
1006 char *ptr, *approx = alloca (len + 1);
1008 strcpy (approx, colorname);
1009 ptr = &approx[len - 1];
1010 while (ptr > approx && isdigit (*ptr))
1011 *ptr-- = '\0';
1013 ret = w32_color_map_lookup (approx);
1017 unblock_input ();
1018 return ret;
1021 void
1022 w32_regenerate_palette (struct frame *f)
1024 struct w32_palette_entry * list;
1025 LOGPALETTE * log_palette;
1026 HPALETTE new_palette;
1027 int i;
1029 /* don't bother trying to create palette if not supported */
1030 if (! FRAME_W32_DISPLAY_INFO (f)->has_palette)
1031 return;
1033 log_palette = (LOGPALETTE *)
1034 alloca (sizeof (LOGPALETTE) +
1035 FRAME_W32_DISPLAY_INFO (f)->num_colors * sizeof (PALETTEENTRY));
1036 log_palette->palVersion = 0x300;
1037 log_palette->palNumEntries = FRAME_W32_DISPLAY_INFO (f)->num_colors;
1039 list = FRAME_W32_DISPLAY_INFO (f)->color_list;
1040 for (i = 0;
1041 i < FRAME_W32_DISPLAY_INFO (f)->num_colors;
1042 i++, list = list->next)
1043 log_palette->palPalEntry[i] = list->entry;
1045 new_palette = CreatePalette (log_palette);
1047 enter_crit ();
1049 if (FRAME_W32_DISPLAY_INFO (f)->palette)
1050 DeleteObject (FRAME_W32_DISPLAY_INFO (f)->palette);
1051 FRAME_W32_DISPLAY_INFO (f)->palette = new_palette;
1053 /* Realize display palette and garbage all frames. */
1054 release_frame_dc (f, get_frame_dc (f));
1056 leave_crit ();
1059 #define W32_COLOR(pe) RGB (pe.peRed, pe.peGreen, pe.peBlue)
1060 #define SET_W32_COLOR(pe, color) \
1061 do \
1063 pe.peRed = GetRValue (color); \
1064 pe.peGreen = GetGValue (color); \
1065 pe.peBlue = GetBValue (color); \
1066 pe.peFlags = 0; \
1067 } while (0)
1069 #if 0
1070 /* Keep these around in case we ever want to track color usage. */
1071 void
1072 w32_map_color (struct frame *f, COLORREF color)
1074 struct w32_palette_entry * list = FRAME_W32_DISPLAY_INFO (f)->color_list;
1076 if (NILP (Vw32_enable_palette))
1077 return;
1079 /* check if color is already mapped */
1080 while (list)
1082 if (W32_COLOR (list->entry) == color)
1084 ++list->refcount;
1085 return;
1087 list = list->next;
1090 /* not already mapped, so add to list and recreate Windows palette */
1091 list = xmalloc (sizeof (struct w32_palette_entry));
1092 SET_W32_COLOR (list->entry, color);
1093 list->refcount = 1;
1094 list->next = FRAME_W32_DISPLAY_INFO (f)->color_list;
1095 FRAME_W32_DISPLAY_INFO (f)->color_list = list;
1096 FRAME_W32_DISPLAY_INFO (f)->num_colors++;
1098 /* set flag that palette must be regenerated */
1099 FRAME_W32_DISPLAY_INFO (f)->regen_palette = TRUE;
1102 void
1103 w32_unmap_color (struct frame *f, COLORREF color)
1105 struct w32_palette_entry * list = FRAME_W32_DISPLAY_INFO (f)->color_list;
1106 struct w32_palette_entry **prev = &FRAME_W32_DISPLAY_INFO (f)->color_list;
1108 if (NILP (Vw32_enable_palette))
1109 return;
1111 /* check if color is already mapped */
1112 while (list)
1114 if (W32_COLOR (list->entry) == color)
1116 if (--list->refcount == 0)
1118 *prev = list->next;
1119 xfree (list);
1120 FRAME_W32_DISPLAY_INFO (f)->num_colors--;
1121 break;
1123 else
1124 return;
1126 prev = &list->next;
1127 list = list->next;
1130 /* set flag that palette must be regenerated */
1131 FRAME_W32_DISPLAY_INFO (f)->regen_palette = TRUE;
1133 #endif
1136 /* Gamma-correct COLOR on frame F. */
1138 void
1139 gamma_correct (struct frame *f, COLORREF *color)
1141 if (f->gamma)
1143 *color = PALETTERGB (
1144 pow (GetRValue (*color) / 255.0, f->gamma) * 255.0 + 0.5,
1145 pow (GetGValue (*color) / 255.0, f->gamma) * 255.0 + 0.5,
1146 pow (GetBValue (*color) / 255.0, f->gamma) * 255.0 + 0.5);
1151 /* Decide if color named COLOR is valid for the display associated with
1152 the selected frame; if so, return the rgb values in COLOR_DEF.
1153 If ALLOC is nonzero, allocate a new colormap cell. */
1156 w32_defined_color (struct frame *f, const char *color, XColor *color_def, int alloc)
1158 register Lisp_Object tem;
1159 COLORREF w32_color_ref;
1161 tem = x_to_w32_color (color);
1163 if (!NILP (tem))
1165 if (f)
1167 /* Apply gamma correction. */
1168 w32_color_ref = XUINT (tem);
1169 gamma_correct (f, &w32_color_ref);
1170 XSETINT (tem, w32_color_ref);
1173 /* Map this color to the palette if it is enabled. */
1174 if (!NILP (Vw32_enable_palette))
1176 struct w32_palette_entry * entry =
1177 one_w32_display_info.color_list;
1178 struct w32_palette_entry ** prev =
1179 &one_w32_display_info.color_list;
1181 /* check if color is already mapped */
1182 while (entry)
1184 if (W32_COLOR (entry->entry) == XUINT (tem))
1185 break;
1186 prev = &entry->next;
1187 entry = entry->next;
1190 if (entry == NULL && alloc)
1192 /* not already mapped, so add to list */
1193 entry = xmalloc (sizeof (struct w32_palette_entry));
1194 SET_W32_COLOR (entry->entry, XUINT (tem));
1195 entry->next = NULL;
1196 *prev = entry;
1197 one_w32_display_info.num_colors++;
1199 /* set flag that palette must be regenerated */
1200 one_w32_display_info.regen_palette = TRUE;
1203 /* Ensure COLORREF value is snapped to nearest color in (default)
1204 palette by simulating the PALETTERGB macro. This works whether
1205 or not the display device has a palette. */
1206 w32_color_ref = XUINT (tem) | 0x2000000;
1208 color_def->pixel = w32_color_ref;
1209 color_def->red = GetRValue (w32_color_ref) * 256;
1210 color_def->green = GetGValue (w32_color_ref) * 256;
1211 color_def->blue = GetBValue (w32_color_ref) * 256;
1213 return 1;
1215 else
1217 return 0;
1221 /* Given a string ARG naming a color, compute a pixel value from it
1222 suitable for screen F.
1223 If F is not a color screen, return DEF (default) regardless of what
1224 ARG says. */
1227 x_decode_color (struct frame *f, Lisp_Object arg, int def)
1229 XColor cdef;
1231 CHECK_STRING (arg);
1233 if (strcmp (SDATA (arg), "black") == 0)
1234 return BLACK_PIX_DEFAULT (f);
1235 else if (strcmp (SDATA (arg), "white") == 0)
1236 return WHITE_PIX_DEFAULT (f);
1238 if ((FRAME_W32_DISPLAY_INFO (f)->n_planes * FRAME_W32_DISPLAY_INFO (f)->n_cbits) == 1)
1239 return def;
1241 /* w32_defined_color is responsible for coping with failures
1242 by looking for a near-miss. */
1243 if (w32_defined_color (f, SDATA (arg), &cdef, 1))
1244 return cdef.pixel;
1246 /* defined_color failed; return an ultimate default. */
1247 return def;
1252 /* Functions called only from `x_set_frame_param'
1253 to set individual parameters.
1255 If FRAME_W32_WINDOW (f) is 0,
1256 the frame is being created and its window does not exist yet.
1257 In that case, just record the parameter's new value
1258 in the standard place; do not attempt to change the window. */
1260 void
1261 x_set_foreground_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1263 struct w32_output *x = f->output_data.w32;
1264 PIX_TYPE fg, old_fg;
1266 fg = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1267 old_fg = FRAME_FOREGROUND_PIXEL (f);
1268 FRAME_FOREGROUND_PIXEL (f) = fg;
1270 if (FRAME_W32_WINDOW (f) != 0)
1272 if (x->cursor_pixel == old_fg)
1274 x->cursor_pixel = fg;
1275 x->cursor_gc->background = fg;
1278 update_face_from_frame_parameter (f, Qforeground_color, arg);
1279 if (FRAME_VISIBLE_P (f))
1280 redraw_frame (f);
1284 void
1285 x_set_background_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1287 FRAME_BACKGROUND_PIXEL (f)
1288 = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
1290 if (FRAME_W32_WINDOW (f) != 0)
1292 SetWindowLong (FRAME_W32_WINDOW (f), WND_BACKGROUND_INDEX,
1293 FRAME_BACKGROUND_PIXEL (f));
1295 update_face_from_frame_parameter (f, Qbackground_color, arg);
1297 if (FRAME_VISIBLE_P (f))
1298 redraw_frame (f);
1302 void
1303 x_set_mouse_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1305 Cursor cursor, nontext_cursor, mode_cursor, hand_cursor;
1306 int count;
1307 int mask_color;
1309 if (!EQ (Qnil, arg))
1310 f->output_data.w32->mouse_pixel
1311 = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1312 mask_color = FRAME_BACKGROUND_PIXEL (f);
1314 /* Don't let pointers be invisible. */
1315 if (mask_color == f->output_data.w32->mouse_pixel
1316 && mask_color == FRAME_BACKGROUND_PIXEL (f))
1317 f->output_data.w32->mouse_pixel = FRAME_FOREGROUND_PIXEL (f);
1319 #if 0 /* TODO : Mouse cursor customization. */
1320 block_input ();
1322 /* It's not okay to crash if the user selects a screwy cursor. */
1323 count = x_catch_errors (FRAME_W32_DISPLAY (f));
1325 if (!EQ (Qnil, Vx_pointer_shape))
1327 CHECK_NUMBER (Vx_pointer_shape);
1328 cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XINT (Vx_pointer_shape));
1330 else
1331 cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_xterm);
1332 x_check_errors (FRAME_W32_DISPLAY (f), "bad text pointer cursor: %s");
1334 if (!EQ (Qnil, Vx_nontext_pointer_shape))
1336 CHECK_NUMBER (Vx_nontext_pointer_shape);
1337 nontext_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f),
1338 XINT (Vx_nontext_pointer_shape));
1340 else
1341 nontext_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_left_ptr);
1342 x_check_errors (FRAME_W32_DISPLAY (f), "bad nontext pointer cursor: %s");
1344 if (!EQ (Qnil, Vx_hourglass_pointer_shape))
1346 CHECK_NUMBER (Vx_hourglass_pointer_shape);
1347 hourglass_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f),
1348 XINT (Vx_hourglass_pointer_shape));
1350 else
1351 hourglass_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_watch);
1352 x_check_errors (FRAME_W32_DISPLAY (f), "bad busy pointer cursor: %s");
1354 x_check_errors (FRAME_W32_DISPLAY (f), "bad nontext pointer cursor: %s");
1355 if (!EQ (Qnil, Vx_mode_pointer_shape))
1357 CHECK_NUMBER (Vx_mode_pointer_shape);
1358 mode_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f),
1359 XINT (Vx_mode_pointer_shape));
1361 else
1362 mode_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_xterm);
1363 x_check_errors (FRAME_W32_DISPLAY (f), "bad modeline pointer cursor: %s");
1365 if (!EQ (Qnil, Vx_sensitive_text_pointer_shape))
1367 CHECK_NUMBER (Vx_sensitive_text_pointer_shape);
1368 hand_cursor
1369 = XCreateFontCursor (FRAME_W32_DISPLAY (f),
1370 XINT (Vx_sensitive_text_pointer_shape));
1372 else
1373 hand_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_crosshair);
1375 if (!NILP (Vx_window_horizontal_drag_shape))
1377 CHECK_NUMBER (Vx_window_horizontal_drag_shape);
1378 horizontal_drag_cursor
1379 = XCreateFontCursor (FRAME_X_DISPLAY (f),
1380 XINT (Vx_window_horizontal_drag_shape));
1382 else
1383 horizontal_drag_cursor
1384 = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_sb_h_double_arrow);
1386 /* Check and report errors with the above calls. */
1387 x_check_errors (FRAME_W32_DISPLAY (f), "can't set cursor shape: %s");
1388 x_uncatch_errors (FRAME_W32_DISPLAY (f), count);
1391 XColor fore_color, back_color;
1393 fore_color.pixel = f->output_data.w32->mouse_pixel;
1394 back_color.pixel = mask_color;
1395 XQueryColor (FRAME_W32_DISPLAY (f),
1396 DefaultColormap (FRAME_W32_DISPLAY (f),
1397 DefaultScreen (FRAME_W32_DISPLAY (f))),
1398 &fore_color);
1399 XQueryColor (FRAME_W32_DISPLAY (f),
1400 DefaultColormap (FRAME_W32_DISPLAY (f),
1401 DefaultScreen (FRAME_W32_DISPLAY (f))),
1402 &back_color);
1403 XRecolorCursor (FRAME_W32_DISPLAY (f), cursor,
1404 &fore_color, &back_color);
1405 XRecolorCursor (FRAME_W32_DISPLAY (f), nontext_cursor,
1406 &fore_color, &back_color);
1407 XRecolorCursor (FRAME_W32_DISPLAY (f), mode_cursor,
1408 &fore_color, &back_color);
1409 XRecolorCursor (FRAME_W32_DISPLAY (f), hand_cursor,
1410 &fore_color, &back_color);
1411 XRecolorCursor (FRAME_W32_DISPLAY (f), hourglass_cursor,
1412 &fore_color, &back_color);
1415 if (FRAME_W32_WINDOW (f) != 0)
1416 XDefineCursor (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f), cursor);
1418 if (cursor != f->output_data.w32->text_cursor && f->output_data.w32->text_cursor != 0)
1419 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->text_cursor);
1420 f->output_data.w32->text_cursor = cursor;
1422 if (nontext_cursor != f->output_data.w32->nontext_cursor
1423 && f->output_data.w32->nontext_cursor != 0)
1424 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->nontext_cursor);
1425 f->output_data.w32->nontext_cursor = nontext_cursor;
1427 if (hourglass_cursor != f->output_data.w32->hourglass_cursor
1428 && f->output_data.w32->hourglass_cursor != 0)
1429 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->hourglass_cursor);
1430 f->output_data.w32->hourglass_cursor = hourglass_cursor;
1432 if (mode_cursor != f->output_data.w32->modeline_cursor
1433 && f->output_data.w32->modeline_cursor != 0)
1434 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->modeline_cursor);
1435 f->output_data.w32->modeline_cursor = mode_cursor;
1437 if (hand_cursor != f->output_data.w32->hand_cursor
1438 && f->output_data.w32->hand_cursor != 0)
1439 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->hand_cursor);
1440 f->output_data.w32->hand_cursor = hand_cursor;
1442 XFlush (FRAME_W32_DISPLAY (f));
1443 unblock_input ();
1445 update_face_from_frame_parameter (f, Qmouse_color, arg);
1446 #endif /* TODO */
1449 void
1450 x_set_cursor_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1452 unsigned long fore_pixel, pixel;
1454 if (!NILP (Vx_cursor_fore_pixel))
1455 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
1456 WHITE_PIX_DEFAULT (f));
1457 else
1458 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
1460 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1462 /* Make sure that the cursor color differs from the background color. */
1463 if (pixel == FRAME_BACKGROUND_PIXEL (f))
1465 pixel = f->output_data.w32->mouse_pixel;
1466 if (pixel == fore_pixel)
1467 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
1470 f->output_data.w32->cursor_foreground_pixel = fore_pixel;
1471 f->output_data.w32->cursor_pixel = pixel;
1473 if (FRAME_W32_WINDOW (f) != 0)
1475 block_input ();
1476 /* Update frame's cursor_gc. */
1477 f->output_data.w32->cursor_gc->foreground = fore_pixel;
1478 f->output_data.w32->cursor_gc->background = pixel;
1480 unblock_input ();
1482 if (FRAME_VISIBLE_P (f))
1484 x_update_cursor (f, 0);
1485 x_update_cursor (f, 1);
1489 update_face_from_frame_parameter (f, Qcursor_color, arg);
1492 /* Set the border-color of frame F to pixel value PIX.
1493 Note that this does not fully take effect if done before
1494 F has a window. */
1496 void
1497 x_set_border_pixel (struct frame *f, int pix)
1500 f->output_data.w32->border_pixel = pix;
1502 if (FRAME_W32_WINDOW (f) != 0 && f->border_width > 0)
1504 if (FRAME_VISIBLE_P (f))
1505 redraw_frame (f);
1509 /* Set the border-color of frame F to value described by ARG.
1510 ARG can be a string naming a color.
1511 The border-color is used for the border that is drawn by the server.
1512 Note that this does not fully take effect if done before
1513 F has a window; it must be redone when the window is created. */
1515 void
1516 x_set_border_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1518 int pix;
1520 CHECK_STRING (arg);
1521 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1522 x_set_border_pixel (f, pix);
1523 update_face_from_frame_parameter (f, Qborder_color, arg);
1527 void
1528 x_set_cursor_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1530 set_frame_cursor_types (f, arg);
1532 /* Make sure the cursor gets redrawn. */
1533 cursor_type_changed = 1;
1536 void
1537 x_set_icon_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1539 int result;
1541 if (NILP (arg) && NILP (oldval))
1542 return;
1544 if (STRINGP (arg) && STRINGP (oldval)
1545 && EQ (Fstring_equal (oldval, arg), Qt))
1546 return;
1548 if (SYMBOLP (arg) && SYMBOLP (oldval) && EQ (arg, oldval))
1549 return;
1551 block_input ();
1553 result = x_bitmap_icon (f, arg);
1554 if (result)
1556 unblock_input ();
1557 error ("No icon window available");
1560 unblock_input ();
1563 void
1564 x_set_icon_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1566 if (STRINGP (arg))
1568 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1569 return;
1571 else if (!NILP (arg) || NILP (oldval))
1572 return;
1574 fset_icon_name (f, arg);
1576 #if 0
1577 if (f->output_data.w32->icon_bitmap != 0)
1578 return;
1580 block_input ();
1582 result = x_text_icon (f,
1583 SSDATA ((!NILP (f->icon_name)
1584 ? f->icon_name
1585 : !NILP (f->title)
1586 ? f->title
1587 : f->name)));
1589 if (result)
1591 unblock_input ();
1592 error ("No icon window available");
1595 /* If the window was unmapped (and its icon was mapped),
1596 the new icon is not mapped, so map the window in its stead. */
1597 if (FRAME_VISIBLE_P (f))
1599 #ifdef USE_X_TOOLKIT
1600 XtPopup (f->output_data.w32->widget, XtGrabNone);
1601 #endif
1602 XMapWindow (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f));
1605 XFlush (FRAME_W32_DISPLAY (f));
1606 unblock_input ();
1607 #endif
1611 void
1612 x_set_menu_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1614 int nlines;
1616 /* Right now, menu bars don't work properly in minibuf-only frames;
1617 most of the commands try to apply themselves to the minibuffer
1618 frame itself, and get an error because you can't switch buffers
1619 in or split the minibuffer window. */
1620 if (FRAME_MINIBUF_ONLY_P (f))
1621 return;
1623 if (INTEGERP (value))
1624 nlines = XINT (value);
1625 else
1626 nlines = 0;
1628 FRAME_MENU_BAR_LINES (f) = 0;
1629 if (nlines)
1630 FRAME_EXTERNAL_MENU_BAR (f) = 1;
1631 else
1633 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
1634 free_frame_menubar (f);
1635 FRAME_EXTERNAL_MENU_BAR (f) = 0;
1637 /* Adjust the frame size so that the client (text) dimensions
1638 remain the same. This depends on FRAME_EXTERNAL_MENU_BAR being
1639 set correctly. */
1640 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
1641 do_pending_window_change (0);
1643 adjust_glyphs (f);
1647 /* Set the number of lines used for the tool bar of frame F to VALUE.
1648 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
1649 is the old number of tool bar lines. This function changes the
1650 height of all windows on frame F to match the new tool bar height.
1651 The frame's height doesn't change. */
1653 void
1654 x_set_tool_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1656 int delta, nlines, root_height;
1657 Lisp_Object root_window;
1659 /* Treat tool bars like menu bars. */
1660 if (FRAME_MINIBUF_ONLY_P (f))
1661 return;
1663 /* Use VALUE only if an integer >= 0. */
1664 if (INTEGERP (value) && XINT (value) >= 0)
1665 nlines = XFASTINT (value);
1666 else
1667 nlines = 0;
1669 /* Make sure we redisplay all windows in this frame. */
1670 ++windows_or_buffers_changed;
1672 delta = nlines - FRAME_TOOL_BAR_LINES (f);
1674 /* Don't resize the tool-bar to more than we have room for. */
1675 root_window = FRAME_ROOT_WINDOW (f);
1676 root_height = WINDOW_TOTAL_LINES (XWINDOW (root_window));
1677 if (root_height - delta < 1)
1679 delta = root_height - 1;
1680 nlines = FRAME_TOOL_BAR_LINES (f) + delta;
1683 FRAME_TOOL_BAR_LINES (f) = nlines;
1684 resize_frame_windows (f, FRAME_LINES (f), 0);
1685 adjust_glyphs (f);
1687 /* We also have to make sure that the internal border at the top of
1688 the frame, below the menu bar or tool bar, is redrawn when the
1689 tool bar disappears. This is so because the internal border is
1690 below the tool bar if one is displayed, but is below the menu bar
1691 if there isn't a tool bar. The tool bar draws into the area
1692 below the menu bar. */
1693 if (FRAME_W32_WINDOW (f) && FRAME_TOOL_BAR_LINES (f) == 0)
1695 clear_frame (f);
1696 clear_current_matrices (f);
1699 /* If the tool bar gets smaller, the internal border below it
1700 has to be cleared. It was formerly part of the display
1701 of the larger tool bar, and updating windows won't clear it. */
1702 if (delta < 0)
1704 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1705 int width = FRAME_PIXEL_WIDTH (f);
1706 int y = nlines * FRAME_LINE_HEIGHT (f);
1708 block_input ();
1710 HDC hdc = get_frame_dc (f);
1711 w32_clear_area (f, hdc, 0, y, width, height);
1712 release_frame_dc (f, hdc);
1714 unblock_input ();
1716 if (WINDOWP (f->tool_bar_window))
1717 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1720 run_window_configuration_change_hook (f);
1725 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1726 w32_id_name.
1728 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1729 name; if NAME is a string, set F's name to NAME and set
1730 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1732 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1733 suggesting a new name, which lisp code should override; if
1734 F->explicit_name is set, ignore the new name; otherwise, set it. */
1736 void
1737 x_set_name (struct frame *f, Lisp_Object name, int explicit)
1739 /* Make sure that requests from lisp code override requests from
1740 Emacs redisplay code. */
1741 if (explicit)
1743 /* If we're switching from explicit to implicit, we had better
1744 update the mode lines and thereby update the title. */
1745 if (f->explicit_name && NILP (name))
1746 update_mode_lines = 1;
1748 f->explicit_name = ! NILP (name);
1750 else if (f->explicit_name)
1751 return;
1753 /* If NAME is nil, set the name to the w32_id_name. */
1754 if (NILP (name))
1756 /* Check for no change needed in this very common case
1757 before we do any consing. */
1758 if (!strcmp (FRAME_W32_DISPLAY_INFO (f)->w32_id_name,
1759 SDATA (f->name)))
1760 return;
1761 name = build_string (FRAME_W32_DISPLAY_INFO (f)->w32_id_name);
1763 else
1764 CHECK_STRING (name);
1766 /* Don't change the name if it's already NAME. */
1767 if (! NILP (Fstring_equal (name, f->name)))
1768 return;
1770 fset_name (f, name);
1772 /* For setting the frame title, the title parameter should override
1773 the name parameter. */
1774 if (! NILP (f->title))
1775 name = f->title;
1777 if (FRAME_W32_WINDOW (f))
1779 block_input ();
1780 GUI_FN (SetWindowText) (FRAME_W32_WINDOW (f),
1781 GUI_SDATA (GUI_ENCODE_SYSTEM (name)));
1782 unblock_input ();
1786 /* This function should be called when the user's lisp code has
1787 specified a name for the frame; the name will override any set by the
1788 redisplay code. */
1789 void
1790 x_explicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1792 x_set_name (f, arg, 1);
1795 /* This function should be called by Emacs redisplay code to set the
1796 name; names set this way will never override names set by the user's
1797 lisp code. */
1798 void
1799 x_implicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1801 x_set_name (f, arg, 0);
1804 /* Change the title of frame F to NAME.
1805 If NAME is nil, use the frame name as the title. */
1807 void
1808 x_set_title (struct frame *f, Lisp_Object name, Lisp_Object old_name)
1810 /* Don't change the title if it's already NAME. */
1811 if (EQ (name, f->title))
1812 return;
1814 update_mode_lines = 1;
1816 fset_title (f, name);
1818 if (NILP (name))
1819 name = f->name;
1821 if (FRAME_W32_WINDOW (f))
1823 block_input ();
1824 GUI_FN (SetWindowText) (FRAME_W32_WINDOW (f),
1825 GUI_SDATA (GUI_ENCODE_SYSTEM (name)));
1826 unblock_input ();
1830 void
1831 x_set_scroll_bar_default_width (struct frame *f)
1833 int wid = FRAME_COLUMN_WIDTH (f);
1835 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = GetSystemMetrics (SM_CXVSCROLL);
1836 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) +
1837 wid - 1) / wid;
1841 /* Subroutines for creating a frame. */
1843 Cursor
1844 w32_load_cursor (LPCTSTR name)
1846 /* Try first to load cursor from application resource. */
1847 Cursor cursor = LoadImage ((HINSTANCE) GetModuleHandle (NULL),
1848 name, IMAGE_CURSOR, 0, 0,
1849 LR_DEFAULTCOLOR | LR_DEFAULTSIZE | LR_SHARED);
1850 if (!cursor)
1852 /* Then try to load a shared predefined cursor. */
1853 cursor = LoadImage (NULL, name, IMAGE_CURSOR, 0, 0,
1854 LR_DEFAULTCOLOR | LR_DEFAULTSIZE | LR_SHARED);
1856 return cursor;
1859 static LRESULT CALLBACK w32_wnd_proc (HWND, UINT, WPARAM, LPARAM);
1861 #define INIT_WINDOW_CLASS(WC) \
1862 (WC).style = CS_HREDRAW | CS_VREDRAW; \
1863 (WC).lpfnWndProc = (WNDPROC) w32_wnd_proc; \
1864 (WC).cbClsExtra = 0; \
1865 (WC).cbWndExtra = WND_EXTRA_BYTES; \
1866 (WC).hInstance = hinst; \
1867 (WC).hIcon = LoadIcon (hinst, EMACS_CLASS); \
1868 (WC).hCursor = w32_load_cursor (IDC_ARROW); \
1869 (WC).hbrBackground = NULL; \
1870 (WC).lpszMenuName = NULL; \
1872 static BOOL
1873 w32_init_class (HINSTANCE hinst)
1875 if (w32_unicode_gui)
1877 WNDCLASSW uwc;
1878 INIT_WINDOW_CLASS(uwc);
1879 uwc.lpszClassName = L"Emacs";
1881 return RegisterClassW (&uwc);
1883 else
1885 WNDCLASS wc;
1886 INIT_WINDOW_CLASS(wc);
1887 wc.lpszClassName = EMACS_CLASS;
1889 return RegisterClassA (&wc);
1893 static HWND
1894 w32_createscrollbar (struct frame *f, struct scroll_bar * bar)
1896 return (CreateWindow ("SCROLLBAR", "", SBS_VERT | WS_CHILD | WS_VISIBLE,
1897 /* Position and size of scroll bar. */
1898 XINT (bar->left) + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
1899 XINT (bar->top),
1900 XINT (bar->width) - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
1901 XINT (bar->height),
1902 FRAME_W32_WINDOW (f),
1903 NULL,
1904 hinst,
1905 NULL));
1908 static void
1909 w32_createwindow (struct frame *f)
1911 HWND hwnd;
1912 RECT rect;
1913 Lisp_Object top = Qunbound;
1914 Lisp_Object left = Qunbound;
1915 struct w32_display_info *dpyinfo = &one_w32_display_info;
1917 rect.left = rect.top = 0;
1918 rect.right = FRAME_PIXEL_WIDTH (f);
1919 rect.bottom = FRAME_PIXEL_HEIGHT (f);
1921 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
1922 FRAME_EXTERNAL_MENU_BAR (f));
1924 /* Do first time app init */
1926 w32_init_class (hinst);
1928 if (f->size_hint_flags & USPosition || f->size_hint_flags & PPosition)
1930 XSETINT (left, f->left_pos);
1931 XSETINT (top, f->top_pos);
1933 else if (EQ (left, Qunbound) && EQ (top, Qunbound))
1935 /* When called with RES_TYPE_NUMBER, w32_get_arg will return zero
1936 for anything that is not a number and is not Qunbound. */
1937 left = x_get_arg (dpyinfo, Qnil, Qleft, "left", "Left", RES_TYPE_NUMBER);
1938 top = x_get_arg (dpyinfo, Qnil, Qtop, "top", "Top", RES_TYPE_NUMBER);
1941 FRAME_W32_WINDOW (f) = hwnd
1942 = CreateWindow (EMACS_CLASS,
1943 f->namebuf,
1944 f->output_data.w32->dwStyle | WS_CLIPCHILDREN,
1945 EQ (left, Qunbound) ? CW_USEDEFAULT : XINT (left),
1946 EQ (top, Qunbound) ? CW_USEDEFAULT : XINT (top),
1947 rect.right - rect.left,
1948 rect.bottom - rect.top,
1949 NULL,
1950 NULL,
1951 hinst,
1952 NULL);
1954 if (hwnd)
1956 SetWindowLong (hwnd, WND_FONTWIDTH_INDEX, FRAME_COLUMN_WIDTH (f));
1957 SetWindowLong (hwnd, WND_LINEHEIGHT_INDEX, FRAME_LINE_HEIGHT (f));
1958 SetWindowLong (hwnd, WND_BORDER_INDEX, FRAME_INTERNAL_BORDER_WIDTH (f));
1959 SetWindowLong (hwnd, WND_SCROLLBAR_INDEX, f->scroll_bar_actual_width);
1960 SetWindowLong (hwnd, WND_BACKGROUND_INDEX, FRAME_BACKGROUND_PIXEL (f));
1962 /* Enable drag-n-drop. */
1963 DragAcceptFiles (hwnd, TRUE);
1965 /* Do this to discard the default setting specified by our parent. */
1966 ShowWindow (hwnd, SW_HIDE);
1968 /* Update frame positions. */
1969 GetWindowRect (hwnd, &rect);
1970 f->left_pos = rect.left;
1971 f->top_pos = rect.top;
1975 static void
1976 my_post_msg (W32Msg * wmsg, HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
1978 wmsg->msg.hwnd = hwnd;
1979 wmsg->msg.message = msg;
1980 wmsg->msg.wParam = wParam;
1981 wmsg->msg.lParam = lParam;
1982 wmsg->msg.time = GetMessageTime ();
1984 post_msg (wmsg);
1987 /* GetKeyState and MapVirtualKey on Windows 95 do not actually distinguish
1988 between left and right keys as advertised. We test for this
1989 support dynamically, and set a flag when the support is absent. If
1990 absent, we keep track of the left and right control and alt keys
1991 ourselves. This is particularly necessary on keyboards that rely
1992 upon the AltGr key, which is represented as having the left control
1993 and right alt keys pressed. For these keyboards, we need to know
1994 when the left alt key has been pressed in addition to the AltGr key
1995 so that we can properly support M-AltGr-key sequences (such as M-@
1996 on Swedish keyboards). */
1998 #define EMACS_LCONTROL 0
1999 #define EMACS_RCONTROL 1
2000 #define EMACS_LMENU 2
2001 #define EMACS_RMENU 3
2003 static int modifiers[4];
2004 static int modifiers_recorded;
2005 static int modifier_key_support_tested;
2007 static void
2008 test_modifier_support (unsigned int wparam)
2010 unsigned int l, r;
2012 if (wparam != VK_CONTROL && wparam != VK_MENU)
2013 return;
2014 if (wparam == VK_CONTROL)
2016 l = VK_LCONTROL;
2017 r = VK_RCONTROL;
2019 else
2021 l = VK_LMENU;
2022 r = VK_RMENU;
2024 if (!(GetKeyState (l) & 0x8000) && !(GetKeyState (r) & 0x8000))
2025 modifiers_recorded = 1;
2026 else
2027 modifiers_recorded = 0;
2028 modifier_key_support_tested = 1;
2031 static void
2032 record_keydown (unsigned int wparam, unsigned int lparam)
2034 int i;
2036 if (!modifier_key_support_tested)
2037 test_modifier_support (wparam);
2039 if ((wparam != VK_CONTROL && wparam != VK_MENU) || !modifiers_recorded)
2040 return;
2042 if (wparam == VK_CONTROL)
2043 i = (lparam & 0x1000000) ? EMACS_RCONTROL : EMACS_LCONTROL;
2044 else
2045 i = (lparam & 0x1000000) ? EMACS_RMENU : EMACS_LMENU;
2047 modifiers[i] = 1;
2050 static void
2051 record_keyup (unsigned int wparam, unsigned int lparam)
2053 int i;
2055 if ((wparam != VK_CONTROL && wparam != VK_MENU) || !modifiers_recorded)
2056 return;
2058 if (wparam == VK_CONTROL)
2059 i = (lparam & 0x1000000) ? EMACS_RCONTROL : EMACS_LCONTROL;
2060 else
2061 i = (lparam & 0x1000000) ? EMACS_RMENU : EMACS_LMENU;
2063 modifiers[i] = 0;
2066 /* Emacs can lose focus while a modifier key has been pressed. When
2067 it regains focus, be conservative and clear all modifiers since
2068 we cannot reconstruct the left and right modifier state. */
2069 static void
2070 reset_modifiers (void)
2072 SHORT ctrl, alt;
2074 if (GetFocus () == NULL)
2075 /* Emacs doesn't have keyboard focus. Do nothing. */
2076 return;
2078 ctrl = GetAsyncKeyState (VK_CONTROL);
2079 alt = GetAsyncKeyState (VK_MENU);
2081 if (!(ctrl & 0x08000))
2082 /* Clear any recorded control modifier state. */
2083 modifiers[EMACS_RCONTROL] = modifiers[EMACS_LCONTROL] = 0;
2085 if (!(alt & 0x08000))
2086 /* Clear any recorded alt modifier state. */
2087 modifiers[EMACS_RMENU] = modifiers[EMACS_LMENU] = 0;
2089 /* Update the state of all modifier keys, because modifiers used in
2090 hot-key combinations can get stuck on if Emacs loses focus as a
2091 result of a hot-key being pressed. */
2093 BYTE keystate[256];
2095 #define CURRENT_STATE(key) ((GetAsyncKeyState (key) & 0x8000) >> 8)
2097 GetKeyboardState (keystate);
2098 keystate[VK_SHIFT] = CURRENT_STATE (VK_SHIFT);
2099 keystate[VK_CONTROL] = CURRENT_STATE (VK_CONTROL);
2100 keystate[VK_LCONTROL] = CURRENT_STATE (VK_LCONTROL);
2101 keystate[VK_RCONTROL] = CURRENT_STATE (VK_RCONTROL);
2102 keystate[VK_MENU] = CURRENT_STATE (VK_MENU);
2103 keystate[VK_LMENU] = CURRENT_STATE (VK_LMENU);
2104 keystate[VK_RMENU] = CURRENT_STATE (VK_RMENU);
2105 keystate[VK_LWIN] = CURRENT_STATE (VK_LWIN);
2106 keystate[VK_RWIN] = CURRENT_STATE (VK_RWIN);
2107 keystate[VK_APPS] = CURRENT_STATE (VK_APPS);
2108 SetKeyboardState (keystate);
2112 /* Synchronize modifier state with what is reported with the current
2113 keystroke. Even if we cannot distinguish between left and right
2114 modifier keys, we know that, if no modifiers are set, then neither
2115 the left or right modifier should be set. */
2116 static void
2117 sync_modifiers (void)
2119 if (!modifiers_recorded)
2120 return;
2122 if (!(GetKeyState (VK_CONTROL) & 0x8000))
2123 modifiers[EMACS_RCONTROL] = modifiers[EMACS_LCONTROL] = 0;
2125 if (!(GetKeyState (VK_MENU) & 0x8000))
2126 modifiers[EMACS_RMENU] = modifiers[EMACS_LMENU] = 0;
2129 static int
2130 modifier_set (int vkey)
2132 /* Warning: The fact that VK_NUMLOCK is not treated as the other 2
2133 toggle keys is not an omission! If you want to add it, you will
2134 have to make changes in the default sub-case of the WM_KEYDOWN
2135 switch, because if the NUMLOCK modifier is set, the code there
2136 will directly convert any key that looks like an ASCII letter,
2137 and also downcase those that look like upper-case ASCII. */
2138 if (vkey == VK_CAPITAL)
2140 if (NILP (Vw32_enable_caps_lock))
2141 return 0;
2142 else
2143 return (GetKeyState (vkey) & 0x1);
2145 if (vkey == VK_SCROLL)
2147 if (NILP (Vw32_scroll_lock_modifier)
2148 /* w32-scroll-lock-modifier can be any non-nil value that is
2149 not one of the modifiers, in which case it shall be ignored. */
2150 || !( EQ (Vw32_scroll_lock_modifier, Qhyper)
2151 || EQ (Vw32_scroll_lock_modifier, Qsuper)
2152 || EQ (Vw32_scroll_lock_modifier, Qmeta)
2153 || EQ (Vw32_scroll_lock_modifier, Qalt)
2154 || EQ (Vw32_scroll_lock_modifier, Qcontrol)
2155 || EQ (Vw32_scroll_lock_modifier, Qshift)))
2156 return 0;
2157 else
2158 return (GetKeyState (vkey) & 0x1);
2161 if (!modifiers_recorded)
2162 return (GetKeyState (vkey) & 0x8000);
2164 switch (vkey)
2166 case VK_LCONTROL:
2167 return modifiers[EMACS_LCONTROL];
2168 case VK_RCONTROL:
2169 return modifiers[EMACS_RCONTROL];
2170 case VK_LMENU:
2171 return modifiers[EMACS_LMENU];
2172 case VK_RMENU:
2173 return modifiers[EMACS_RMENU];
2175 return (GetKeyState (vkey) & 0x8000);
2178 /* Convert between the modifier bits W32 uses and the modifier bits
2179 Emacs uses. */
2181 unsigned int
2182 w32_key_to_modifier (int key)
2184 Lisp_Object key_mapping;
2186 switch (key)
2188 case VK_LWIN:
2189 key_mapping = Vw32_lwindow_modifier;
2190 break;
2191 case VK_RWIN:
2192 key_mapping = Vw32_rwindow_modifier;
2193 break;
2194 case VK_APPS:
2195 key_mapping = Vw32_apps_modifier;
2196 break;
2197 case VK_SCROLL:
2198 key_mapping = Vw32_scroll_lock_modifier;
2199 break;
2200 default:
2201 key_mapping = Qnil;
2204 /* NB. This code runs in the input thread, asynchronously to the lisp
2205 thread, so we must be careful to ensure access to lisp data is
2206 thread-safe. The following code is safe because the modifier
2207 variable values are updated atomically from lisp and symbols are
2208 not relocated by GC. Also, we don't have to worry about seeing GC
2209 markbits here. */
2210 if (EQ (key_mapping, Qhyper))
2211 return hyper_modifier;
2212 if (EQ (key_mapping, Qsuper))
2213 return super_modifier;
2214 if (EQ (key_mapping, Qmeta))
2215 return meta_modifier;
2216 if (EQ (key_mapping, Qalt))
2217 return alt_modifier;
2218 if (EQ (key_mapping, Qctrl))
2219 return ctrl_modifier;
2220 if (EQ (key_mapping, Qcontrol)) /* synonym for ctrl */
2221 return ctrl_modifier;
2222 if (EQ (key_mapping, Qshift))
2223 return shift_modifier;
2225 /* Don't generate any modifier if not explicitly requested. */
2226 return 0;
2229 static unsigned int
2230 w32_get_modifiers (void)
2232 return ((modifier_set (VK_SHIFT) ? shift_modifier : 0) |
2233 (modifier_set (VK_CONTROL) ? ctrl_modifier : 0) |
2234 (modifier_set (VK_LWIN) ? w32_key_to_modifier (VK_LWIN) : 0) |
2235 (modifier_set (VK_RWIN) ? w32_key_to_modifier (VK_RWIN) : 0) |
2236 (modifier_set (VK_APPS) ? w32_key_to_modifier (VK_APPS) : 0) |
2237 (modifier_set (VK_SCROLL) ? w32_key_to_modifier (VK_SCROLL) : 0) |
2238 (modifier_set (VK_MENU) ?
2239 ((NILP (Vw32_alt_is_meta)) ? alt_modifier : meta_modifier) : 0));
2242 /* We map the VK_* modifiers into console modifier constants
2243 so that we can use the same routines to handle both console
2244 and window input. */
2246 static int
2247 construct_console_modifiers (void)
2249 int mods;
2251 mods = 0;
2252 mods |= (modifier_set (VK_SHIFT)) ? SHIFT_PRESSED : 0;
2253 mods |= (modifier_set (VK_CAPITAL)) ? CAPSLOCK_ON : 0;
2254 mods |= (modifier_set (VK_SCROLL)) ? SCROLLLOCK_ON : 0;
2255 mods |= (modifier_set (VK_NUMLOCK)) ? NUMLOCK_ON : 0;
2256 mods |= (modifier_set (VK_LCONTROL)) ? LEFT_CTRL_PRESSED : 0;
2257 mods |= (modifier_set (VK_RCONTROL)) ? RIGHT_CTRL_PRESSED : 0;
2258 mods |= (modifier_set (VK_LMENU)) ? LEFT_ALT_PRESSED : 0;
2259 mods |= (modifier_set (VK_RMENU)) ? RIGHT_ALT_PRESSED : 0;
2260 mods |= (modifier_set (VK_LWIN)) ? LEFT_WIN_PRESSED : 0;
2261 mods |= (modifier_set (VK_RWIN)) ? RIGHT_WIN_PRESSED : 0;
2262 mods |= (modifier_set (VK_APPS)) ? APPS_PRESSED : 0;
2264 return mods;
2267 static int
2268 w32_get_key_modifiers (unsigned int wparam, unsigned int lparam)
2270 int mods;
2272 /* Convert to emacs modifiers. */
2273 mods = w32_kbd_mods_to_emacs (construct_console_modifiers (), wparam);
2275 return mods;
2278 unsigned int
2279 map_keypad_keys (unsigned int virt_key, unsigned int extended)
2281 if (virt_key < VK_CLEAR || virt_key > VK_DELETE)
2282 return virt_key;
2284 if (virt_key == VK_RETURN)
2285 return (extended ? VK_NUMPAD_ENTER : VK_RETURN);
2287 if (virt_key >= VK_PRIOR && virt_key <= VK_DOWN)
2288 return (!extended ? (VK_NUMPAD_PRIOR + (virt_key - VK_PRIOR)) : virt_key);
2290 if (virt_key == VK_INSERT || virt_key == VK_DELETE)
2291 return (!extended ? (VK_NUMPAD_INSERT + (virt_key - VK_INSERT)) : virt_key);
2293 if (virt_key == VK_CLEAR)
2294 return (!extended ? VK_NUMPAD_CLEAR : virt_key);
2296 return virt_key;
2299 /* List of special key combinations which w32 would normally capture,
2300 but Emacs should grab instead. Not directly visible to lisp, to
2301 simplify synchronization. Each item is an integer encoding a virtual
2302 key code and modifier combination to capture. */
2303 static Lisp_Object w32_grabbed_keys;
2305 #define HOTKEY(vk, mods) make_number (((vk) & 255) | ((mods) << 8))
2306 #define HOTKEY_ID(k) (XFASTINT (k) & 0xbfff)
2307 #define HOTKEY_VK_CODE(k) (XFASTINT (k) & 255)
2308 #define HOTKEY_MODIFIERS(k) (XFASTINT (k) >> 8)
2310 #define RAW_HOTKEY_ID(k) ((k) & 0xbfff)
2311 #define RAW_HOTKEY_VK_CODE(k) ((k) & 255)
2312 #define RAW_HOTKEY_MODIFIERS(k) ((k) >> 8)
2314 /* Register hot-keys for reserved key combinations when Emacs has
2315 keyboard focus, since this is the only way Emacs can receive key
2316 combinations like Alt-Tab which are used by the system. */
2318 static void
2319 register_hot_keys (HWND hwnd)
2321 Lisp_Object keylist;
2323 /* Use CONSP, since we are called asynchronously. */
2324 for (keylist = w32_grabbed_keys; CONSP (keylist); keylist = XCDR (keylist))
2326 Lisp_Object key = XCAR (keylist);
2328 /* Deleted entries get set to nil. */
2329 if (!INTEGERP (key))
2330 continue;
2332 RegisterHotKey (hwnd, HOTKEY_ID (key),
2333 HOTKEY_MODIFIERS (key), HOTKEY_VK_CODE (key));
2337 static void
2338 unregister_hot_keys (HWND hwnd)
2340 Lisp_Object keylist;
2342 for (keylist = w32_grabbed_keys; CONSP (keylist); keylist = XCDR (keylist))
2344 Lisp_Object key = XCAR (keylist);
2346 if (!INTEGERP (key))
2347 continue;
2349 UnregisterHotKey (hwnd, HOTKEY_ID (key));
2353 #if EMACSDEBUG
2354 const char*
2355 w32_name_of_message (UINT msg)
2357 unsigned i;
2358 static char buf[64];
2359 static const struct {
2360 UINT msg;
2361 const char* name;
2362 } msgnames[] = {
2363 #define M(msg) { msg, # msg }
2364 M (WM_PAINT),
2365 M (WM_TIMER),
2366 M (WM_USER),
2367 M (WM_MOUSEMOVE),
2368 M (WM_LBUTTONUP),
2369 M (WM_KEYDOWN),
2370 M (WM_EMACS_KILL),
2371 M (WM_EMACS_CREATEWINDOW),
2372 M (WM_EMACS_DONE),
2373 M (WM_EMACS_CREATESCROLLBAR),
2374 M (WM_EMACS_SHOWWINDOW),
2375 M (WM_EMACS_SETWINDOWPOS),
2376 M (WM_EMACS_DESTROYWINDOW),
2377 M (WM_EMACS_TRACKPOPUPMENU),
2378 M (WM_EMACS_SETFOCUS),
2379 M (WM_EMACS_SETFOREGROUND),
2380 M (WM_EMACS_SETLOCALE),
2381 M (WM_EMACS_SETKEYBOARDLAYOUT),
2382 M (WM_EMACS_REGISTER_HOT_KEY),
2383 M (WM_EMACS_UNREGISTER_HOT_KEY),
2384 M (WM_EMACS_TOGGLE_LOCK_KEY),
2385 M (WM_EMACS_TRACK_CARET),
2386 M (WM_EMACS_DESTROY_CARET),
2387 M (WM_EMACS_SHOW_CARET),
2388 M (WM_EMACS_HIDE_CARET),
2389 M (WM_EMACS_SETCURSOR),
2390 M (WM_EMACS_PAINT),
2391 M (WM_CHAR),
2392 #undef M
2393 { 0, 0 }
2396 for (i = 0; msgnames[i].name; ++i)
2397 if (msgnames[i].msg == msg)
2398 return msgnames[i].name;
2400 sprintf (buf, "message 0x%04x", (unsigned)msg);
2401 return buf;
2403 #endif /* EMACSDEBUG */
2405 /* Here's an overview of how Emacs input works in GUI sessions on
2406 MS-Windows. (For description of non-GUI input, see the commentary
2407 before w32_console_read_socket in w32inevt.c.)
2409 System messages are read and processed by w32_msg_pump below. This
2410 function runs in a separate thread. It handles a small number of
2411 custom WM_EMACS_* messages (posted by the main thread, look for
2412 PostMessage calls), and dispatches the rest to w32_wnd_proc, which
2413 is the main window procedure for the entire Emacs application.
2415 w32_wnd_proc also runs in the same separate input thread. It
2416 handles some messages, mostly those that need GDI calls, by itself.
2417 For the others, it calls my_post_msg, which inserts the messages
2418 into the input queue serviced by w32_read_socket.
2420 w32_read_socket runs in the main (a.k.a. "Lisp") thread, and is
2421 called synchronously from keyboard.c when it is known or suspected
2422 that some input is available. w32_read_socket either handles
2423 messages immediately, or converts them into Emacs input events and
2424 stuffs them into kbd_buffer, where kbd_buffer_get_event can get at
2425 them and process them when read_char and its callers require
2426 input.
2428 Under Cygwin with the W32 toolkit, the use of /dev/windows with
2429 select(2) takes the place of w32_read_socket.
2433 /* Main message dispatch loop. */
2435 static void
2436 w32_msg_pump (deferred_msg * msg_buf)
2438 MSG msg;
2439 WPARAM result;
2440 HWND focus_window;
2442 msh_mousewheel = RegisterWindowMessage (MSH_MOUSEWHEEL);
2444 while ((w32_unicode_gui ? GetMessageW : GetMessageA) (&msg, NULL, 0, 0))
2447 /* DebPrint (("w32_msg_pump: %s time:%u\n", */
2448 /* w32_name_of_message (msg.message), msg.time)); */
2450 if (msg.hwnd == NULL)
2452 switch (msg.message)
2454 case WM_NULL:
2455 /* Produced by complete_deferred_msg; just ignore. */
2456 break;
2457 case WM_EMACS_CREATEWINDOW:
2458 /* Initialize COM for this window. Even though we don't use it,
2459 some third party shell extensions can cause it to be used in
2460 system dialogs, which causes a crash if it is not initialized.
2461 This is a known bug in Windows, which was fixed long ago, but
2462 the patch for XP is not publicly available until XP SP3,
2463 and older versions will never be patched. */
2464 CoInitialize (NULL);
2465 w32_createwindow ((struct frame *) msg.wParam);
2466 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
2467 emacs_abort ();
2468 break;
2469 case WM_EMACS_SETLOCALE:
2470 SetThreadLocale (msg.wParam);
2471 /* Reply is not expected. */
2472 break;
2473 case WM_EMACS_SETKEYBOARDLAYOUT:
2474 result = (WPARAM) ActivateKeyboardLayout ((HKL) msg.wParam, 0);
2475 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE,
2476 result, 0))
2477 emacs_abort ();
2478 break;
2479 case WM_EMACS_REGISTER_HOT_KEY:
2480 focus_window = GetFocus ();
2481 if (focus_window != NULL)
2482 RegisterHotKey (focus_window,
2483 RAW_HOTKEY_ID (msg.wParam),
2484 RAW_HOTKEY_MODIFIERS (msg.wParam),
2485 RAW_HOTKEY_VK_CODE (msg.wParam));
2486 /* Reply is not expected. */
2487 break;
2488 case WM_EMACS_UNREGISTER_HOT_KEY:
2489 focus_window = GetFocus ();
2490 if (focus_window != NULL)
2491 UnregisterHotKey (focus_window, RAW_HOTKEY_ID (msg.wParam));
2492 /* Mark item as erased. NB: this code must be
2493 thread-safe. The next line is okay because the cons
2494 cell is never made into garbage and is not relocated by
2495 GC. */
2496 XSETCAR (XIL ((EMACS_INT) msg.lParam), Qnil);
2497 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
2498 emacs_abort ();
2499 break;
2500 case WM_EMACS_TOGGLE_LOCK_KEY:
2502 int vk_code = (int) msg.wParam;
2503 int cur_state = (GetKeyState (vk_code) & 1);
2504 Lisp_Object new_state = XIL ((EMACS_INT) msg.lParam);
2506 /* NB: This code must be thread-safe. It is safe to
2507 call NILP because symbols are not relocated by GC,
2508 and pointer here is not touched by GC (so the markbit
2509 can't be set). Numbers are safe because they are
2510 immediate values. */
2511 if (NILP (new_state)
2512 || (NUMBERP (new_state)
2513 && ((XUINT (new_state)) & 1) != cur_state))
2515 one_w32_display_info.faked_key = vk_code;
2517 keybd_event ((BYTE) vk_code,
2518 (BYTE) MapVirtualKey (vk_code, 0),
2519 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
2520 keybd_event ((BYTE) vk_code,
2521 (BYTE) MapVirtualKey (vk_code, 0),
2522 KEYEVENTF_EXTENDEDKEY | 0, 0);
2523 keybd_event ((BYTE) vk_code,
2524 (BYTE) MapVirtualKey (vk_code, 0),
2525 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
2526 cur_state = !cur_state;
2528 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE,
2529 cur_state, 0))
2530 emacs_abort ();
2532 break;
2533 #ifdef MSG_DEBUG
2534 /* Broadcast messages make it here, so you need to be looking
2535 for something in particular for this to be useful. */
2536 default:
2537 DebPrint (("msg %x not expected by w32_msg_pump\n", msg.message));
2538 #endif
2541 else
2543 if (w32_unicode_gui)
2544 DispatchMessageW (&msg);
2545 else
2546 DispatchMessageA (&msg);
2549 /* Exit nested loop when our deferred message has completed. */
2550 if (msg_buf->completed)
2551 break;
2555 deferred_msg * deferred_msg_head;
2557 static deferred_msg *
2558 find_deferred_msg (HWND hwnd, UINT msg)
2560 deferred_msg * item;
2562 /* Don't actually need synchronization for read access, since
2563 modification of single pointer is always atomic. */
2564 /* enter_crit (); */
2566 for (item = deferred_msg_head; item != NULL; item = item->next)
2567 if (item->w32msg.msg.hwnd == hwnd
2568 && item->w32msg.msg.message == msg)
2569 break;
2571 /* leave_crit (); */
2573 return item;
2576 static LRESULT
2577 send_deferred_msg (deferred_msg * msg_buf,
2578 HWND hwnd,
2579 UINT msg,
2580 WPARAM wParam,
2581 LPARAM lParam)
2583 /* Only input thread can send deferred messages. */
2584 if (GetCurrentThreadId () != dwWindowsThreadId)
2585 emacs_abort ();
2587 /* It is an error to send a message that is already deferred. */
2588 if (find_deferred_msg (hwnd, msg) != NULL)
2589 emacs_abort ();
2591 /* Enforced synchronization is not needed because this is the only
2592 function that alters deferred_msg_head, and the following critical
2593 section is guaranteed to only be serially reentered (since only the
2594 input thread can call us). */
2596 /* enter_crit (); */
2598 msg_buf->completed = 0;
2599 msg_buf->next = deferred_msg_head;
2600 deferred_msg_head = msg_buf;
2601 my_post_msg (&msg_buf->w32msg, hwnd, msg, wParam, lParam);
2603 /* leave_crit (); */
2605 /* Start a new nested message loop to process other messages until
2606 this one is completed. */
2607 w32_msg_pump (msg_buf);
2609 deferred_msg_head = msg_buf->next;
2611 return msg_buf->result;
2614 void
2615 complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result)
2617 deferred_msg * msg_buf = find_deferred_msg (hwnd, msg);
2619 if (msg_buf == NULL)
2620 /* Message may have been canceled, so don't abort. */
2621 return;
2623 msg_buf->result = result;
2624 msg_buf->completed = 1;
2626 /* Ensure input thread is woken so it notices the completion. */
2627 PostThreadMessage (dwWindowsThreadId, WM_NULL, 0, 0);
2630 static void
2631 cancel_all_deferred_msgs (void)
2633 deferred_msg * item;
2635 /* Don't actually need synchronization for read access, since
2636 modification of single pointer is always atomic. */
2637 /* enter_crit (); */
2639 for (item = deferred_msg_head; item != NULL; item = item->next)
2641 item->result = 0;
2642 item->completed = 1;
2645 /* leave_crit (); */
2647 /* Ensure input thread is woken so it notices the completion. */
2648 PostThreadMessage (dwWindowsThreadId, WM_NULL, 0, 0);
2651 DWORD WINAPI
2652 w32_msg_worker (void *arg)
2654 MSG msg;
2655 deferred_msg dummy_buf;
2657 /* Ensure our message queue is created */
2659 PeekMessage (&msg, NULL, 0, 0, PM_NOREMOVE);
2661 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
2662 emacs_abort ();
2664 memset (&dummy_buf, 0, sizeof (dummy_buf));
2665 dummy_buf.w32msg.msg.hwnd = NULL;
2666 dummy_buf.w32msg.msg.message = WM_NULL;
2668 /* This is the initial message loop which should only exit when the
2669 application quits. */
2670 w32_msg_pump (&dummy_buf);
2672 return 0;
2675 static void
2676 signal_user_input (void)
2678 /* Interrupt any lisp that wants to be interrupted by input. */
2679 if (!NILP (Vthrow_on_input))
2681 Vquit_flag = Vthrow_on_input;
2682 /* Doing a QUIT from this thread is a bad idea, since this
2683 unwinds the stack of the Lisp thread, and the Windows runtime
2684 rightfully barfs. Disabled. */
2685 #if 0
2686 /* If we're inside a function that wants immediate quits,
2687 do it now. */
2688 if (immediate_quit && NILP (Vinhibit_quit))
2690 immediate_quit = 0;
2691 QUIT;
2693 #endif
2698 static void
2699 post_character_message (HWND hwnd, UINT msg,
2700 WPARAM wParam, LPARAM lParam,
2701 DWORD modifiers)
2703 W32Msg wmsg;
2705 wmsg.dwModifiers = modifiers;
2707 /* Detect quit_char and set quit-flag directly. Note that we
2708 still need to post a message to ensure the main thread will be
2709 woken up if blocked in sys_select, but we do NOT want to post
2710 the quit_char message itself (because it will usually be as if
2711 the user had typed quit_char twice). Instead, we post a dummy
2712 message that has no particular effect. */
2714 int c = wParam;
2715 if (isalpha (c) && wmsg.dwModifiers == ctrl_modifier)
2716 c = make_ctrl_char (c) & 0377;
2717 if (c == quit_char
2718 || (wmsg.dwModifiers == 0
2719 && w32_quit_key && wParam == w32_quit_key))
2721 Vquit_flag = Qt;
2723 /* The choice of message is somewhat arbitrary, as long as
2724 the main thread handler just ignores it. */
2725 msg = WM_NULL;
2727 /* Interrupt any blocking system calls. */
2728 signal_quit ();
2730 /* As a safety precaution, forcibly complete any deferred
2731 messages. This is a kludge, but I don't see any particularly
2732 clean way to handle the situation where a deferred message is
2733 "dropped" in the lisp thread, and will thus never be
2734 completed, eg. by the user trying to activate the menubar
2735 when the lisp thread is busy, and then typing C-g when the
2736 menubar doesn't open promptly (with the result that the
2737 menubar never responds at all because the deferred
2738 WM_INITMENU message is never completed). Another problem
2739 situation is when the lisp thread calls SendMessage (to send
2740 a window manager command) when a message has been deferred;
2741 the lisp thread gets blocked indefinitely waiting for the
2742 deferred message to be completed, which itself is waiting for
2743 the lisp thread to respond.
2745 Note that we don't want to block the input thread waiting for
2746 a response from the lisp thread (although that would at least
2747 solve the deadlock problem above), because we want to be able
2748 to receive C-g to interrupt the lisp thread. */
2749 cancel_all_deferred_msgs ();
2751 else
2752 signal_user_input ();
2755 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2758 /* Main window procedure */
2760 static LRESULT CALLBACK
2761 w32_wnd_proc (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
2763 struct frame *f;
2764 struct w32_display_info *dpyinfo = &one_w32_display_info;
2765 W32Msg wmsg;
2766 int windows_translate;
2767 int key;
2769 /* Note that it is okay to call x_window_to_frame, even though we are
2770 not running in the main lisp thread, because frame deletion
2771 requires the lisp thread to synchronize with this thread. Thus, if
2772 a frame struct is returned, it can be used without concern that the
2773 lisp thread might make it disappear while we are using it.
2775 NB. Walking the frame list in this thread is safe (as long as
2776 writes of Lisp_Object slots are atomic, which they are on Windows).
2777 Although delete-frame can destructively modify the frame list while
2778 we are walking it, a garbage collection cannot occur until after
2779 delete-frame has synchronized with this thread.
2781 It is also safe to use functions that make GDI calls, such as
2782 w32_clear_rect, because these functions must obtain a DC handle
2783 from the frame struct using get_frame_dc which is thread-aware. */
2785 switch (msg)
2787 case WM_ERASEBKGND:
2788 f = x_window_to_frame (dpyinfo, hwnd);
2789 if (f)
2791 HDC hdc = get_frame_dc (f);
2792 GetUpdateRect (hwnd, &wmsg.rect, FALSE);
2793 w32_clear_rect (f, hdc, &wmsg.rect);
2794 release_frame_dc (f, hdc);
2796 #if defined (W32_DEBUG_DISPLAY)
2797 DebPrint (("WM_ERASEBKGND (frame %p): erasing %d,%d-%d,%d\n",
2799 wmsg.rect.left, wmsg.rect.top,
2800 wmsg.rect.right, wmsg.rect.bottom));
2801 #endif /* W32_DEBUG_DISPLAY */
2803 return 1;
2804 case WM_PALETTECHANGED:
2805 /* ignore our own changes */
2806 if ((HWND)wParam != hwnd)
2808 f = x_window_to_frame (dpyinfo, hwnd);
2809 if (f)
2810 /* get_frame_dc will realize our palette and force all
2811 frames to be redrawn if needed. */
2812 release_frame_dc (f, get_frame_dc (f));
2814 return 0;
2815 case WM_PAINT:
2817 PAINTSTRUCT paintStruct;
2818 RECT update_rect;
2819 memset (&update_rect, 0, sizeof (update_rect));
2821 f = x_window_to_frame (dpyinfo, hwnd);
2822 if (f == 0)
2824 DebPrint (("WM_PAINT received for unknown window %p\n", hwnd));
2825 return 0;
2828 /* MSDN Docs say not to call BeginPaint if GetUpdateRect
2829 fails. Apparently this can happen under some
2830 circumstances. */
2831 if (GetUpdateRect (hwnd, &update_rect, FALSE) || !w32_strict_painting)
2833 enter_crit ();
2834 BeginPaint (hwnd, &paintStruct);
2836 /* The rectangles returned by GetUpdateRect and BeginPaint
2837 do not always match. Play it safe by assuming both areas
2838 are invalid. */
2839 UnionRect (&(wmsg.rect), &update_rect, &(paintStruct.rcPaint));
2841 #if defined (W32_DEBUG_DISPLAY)
2842 DebPrint (("WM_PAINT (frame %p): painting %d,%d-%d,%d\n",
2844 wmsg.rect.left, wmsg.rect.top,
2845 wmsg.rect.right, wmsg.rect.bottom));
2846 DebPrint ((" [update region is %d,%d-%d,%d]\n",
2847 update_rect.left, update_rect.top,
2848 update_rect.right, update_rect.bottom));
2849 #endif
2850 EndPaint (hwnd, &paintStruct);
2851 leave_crit ();
2853 /* Change the message type to prevent Windows from
2854 combining WM_PAINT messages in the Lisp thread's queue,
2855 since Windows assumes that each message queue is
2856 dedicated to one frame and does not bother checking
2857 that hwnd matches before combining them. */
2858 my_post_msg (&wmsg, hwnd, WM_EMACS_PAINT, wParam, lParam);
2860 return 0;
2863 /* If GetUpdateRect returns 0 (meaning there is no update
2864 region), assume the whole window needs to be repainted. */
2865 GetClientRect (hwnd, &wmsg.rect);
2866 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2867 return 0;
2870 case WM_INPUTLANGCHANGE:
2871 /* Inform lisp thread of keyboard layout changes. */
2872 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2874 /* Clear dead keys in the keyboard state; for simplicity only
2875 preserve modifier key states. */
2877 int i;
2878 BYTE keystate[256];
2880 GetKeyboardState (keystate);
2881 for (i = 0; i < 256; i++)
2882 if (1
2883 && i != VK_SHIFT
2884 && i != VK_LSHIFT
2885 && i != VK_RSHIFT
2886 && i != VK_CAPITAL
2887 && i != VK_NUMLOCK
2888 && i != VK_SCROLL
2889 && i != VK_CONTROL
2890 && i != VK_LCONTROL
2891 && i != VK_RCONTROL
2892 && i != VK_MENU
2893 && i != VK_LMENU
2894 && i != VK_RMENU
2895 && i != VK_LWIN
2896 && i != VK_RWIN)
2897 keystate[i] = 0;
2898 SetKeyboardState (keystate);
2900 goto dflt;
2902 case WM_HOTKEY:
2903 /* Synchronize hot keys with normal input. */
2904 PostMessage (hwnd, WM_KEYDOWN, HIWORD (lParam), 0);
2905 return (0);
2907 case WM_KEYUP:
2908 case WM_SYSKEYUP:
2909 record_keyup (wParam, lParam);
2910 goto dflt;
2912 case WM_KEYDOWN:
2913 case WM_SYSKEYDOWN:
2914 /* Ignore keystrokes we fake ourself; see below. */
2915 if (dpyinfo->faked_key == wParam)
2917 dpyinfo->faked_key = 0;
2918 /* Make sure TranslateMessage sees them though (as long as
2919 they don't produce WM_CHAR messages). This ensures that
2920 indicator lights are toggled promptly on Windows 9x, for
2921 example. */
2922 if (wParam < 256 && lispy_function_keys[wParam])
2924 windows_translate = 1;
2925 goto translate;
2927 return 0;
2930 /* Synchronize modifiers with current keystroke. */
2931 sync_modifiers ();
2932 record_keydown (wParam, lParam);
2933 wParam = map_keypad_keys (wParam, (lParam & 0x1000000L) != 0);
2935 windows_translate = 0;
2937 switch (wParam)
2939 case VK_LWIN:
2940 if (NILP (Vw32_pass_lwindow_to_system))
2942 /* Prevent system from acting on keyup (which opens the
2943 Start menu if no other key was pressed) by simulating a
2944 press of Space which we will ignore. */
2945 if (GetAsyncKeyState (wParam) & 1)
2947 if (NUMBERP (Vw32_phantom_key_code))
2948 key = XUINT (Vw32_phantom_key_code) & 255;
2949 else
2950 key = VK_SPACE;
2951 dpyinfo->faked_key = key;
2952 keybd_event (key, (BYTE) MapVirtualKey (key, 0), 0, 0);
2955 if (!NILP (Vw32_lwindow_modifier))
2956 return 0;
2957 break;
2958 case VK_RWIN:
2959 if (NILP (Vw32_pass_rwindow_to_system))
2961 if (GetAsyncKeyState (wParam) & 1)
2963 if (NUMBERP (Vw32_phantom_key_code))
2964 key = XUINT (Vw32_phantom_key_code) & 255;
2965 else
2966 key = VK_SPACE;
2967 dpyinfo->faked_key = key;
2968 keybd_event (key, (BYTE) MapVirtualKey (key, 0), 0, 0);
2971 if (!NILP (Vw32_rwindow_modifier))
2972 return 0;
2973 break;
2974 case VK_APPS:
2975 if (!NILP (Vw32_apps_modifier))
2976 return 0;
2977 break;
2978 case VK_MENU:
2979 if (NILP (Vw32_pass_alt_to_system))
2980 /* Prevent DefWindowProc from activating the menu bar if an
2981 Alt key is pressed and released by itself. */
2982 return 0;
2983 windows_translate = 1;
2984 break;
2985 case VK_CAPITAL:
2986 /* Decide whether to treat as modifier or function key. */
2987 if (NILP (Vw32_enable_caps_lock))
2988 goto disable_lock_key;
2989 windows_translate = 1;
2990 break;
2991 case VK_NUMLOCK:
2992 /* Decide whether to treat as modifier or function key. */
2993 if (NILP (Vw32_enable_num_lock))
2994 goto disable_lock_key;
2995 windows_translate = 1;
2996 break;
2997 case VK_SCROLL:
2998 /* Decide whether to treat as modifier or function key. */
2999 if (NILP (Vw32_scroll_lock_modifier))
3000 goto disable_lock_key;
3001 windows_translate = 1;
3002 break;
3003 disable_lock_key:
3004 /* Ensure the appropriate lock key state (and indicator light)
3005 remains in the same state. We do this by faking another
3006 press of the relevant key. Apparently, this really is the
3007 only way to toggle the state of the indicator lights. */
3008 dpyinfo->faked_key = wParam;
3009 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3010 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
3011 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3012 KEYEVENTF_EXTENDEDKEY | 0, 0);
3013 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3014 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
3015 /* Ensure indicator lights are updated promptly on Windows 9x
3016 (TranslateMessage apparently does this), after forwarding
3017 input event. */
3018 post_character_message (hwnd, msg, wParam, lParam,
3019 w32_get_key_modifiers (wParam, lParam));
3020 windows_translate = 1;
3021 break;
3022 case VK_CONTROL:
3023 case VK_SHIFT:
3024 case VK_PROCESSKEY: /* Generated by IME. */
3025 windows_translate = 1;
3026 break;
3027 case VK_CANCEL:
3028 /* Windows maps Ctrl-Pause (aka Ctrl-Break) into VK_CANCEL,
3029 which is confusing for purposes of key binding; convert
3030 VK_CANCEL events into VK_PAUSE events. */
3031 wParam = VK_PAUSE;
3032 break;
3033 case VK_PAUSE:
3034 /* Windows maps Ctrl-NumLock into VK_PAUSE, which is confusing
3035 for purposes of key binding; convert these back into
3036 VK_NUMLOCK events, at least when we want to see NumLock key
3037 presses. (Note that there is never any possibility that
3038 VK_PAUSE with Ctrl really is C-Pause as per above.) */
3039 if (NILP (Vw32_enable_num_lock) && modifier_set (VK_CONTROL))
3040 wParam = VK_NUMLOCK;
3041 break;
3042 default:
3043 /* If not defined as a function key, change it to a WM_CHAR message. */
3044 if (wParam > 255 || !lispy_function_keys[wParam])
3046 DWORD modifiers = construct_console_modifiers ();
3048 if (!NILP (Vw32_recognize_altgr)
3049 && modifier_set (VK_LCONTROL) && modifier_set (VK_RMENU))
3051 /* Always let TranslateMessage handle AltGr key chords;
3052 for some reason, ToAscii doesn't always process AltGr
3053 chords correctly. */
3054 windows_translate = 1;
3056 else if ((modifiers & (~SHIFT_PRESSED & ~CAPSLOCK_ON)) != 0)
3058 /* Handle key chords including any modifiers other
3059 than shift directly, in order to preserve as much
3060 modifier information as possible. */
3061 if ('A' <= wParam && wParam <= 'Z')
3063 /* Don't translate modified alphabetic keystrokes,
3064 so the user doesn't need to constantly switch
3065 layout to type control or meta keystrokes when
3066 the normal layout translates alphabetic
3067 characters to non-ascii characters. */
3068 if (!modifier_set (VK_SHIFT))
3069 wParam += ('a' - 'A');
3070 msg = WM_CHAR;
3072 else
3074 /* Try to handle other keystrokes by determining the
3075 base character (ie. translating the base key plus
3076 shift modifier). */
3077 int add;
3078 KEY_EVENT_RECORD key;
3080 key.bKeyDown = TRUE;
3081 key.wRepeatCount = 1;
3082 key.wVirtualKeyCode = wParam;
3083 key.wVirtualScanCode = (lParam & 0xFF0000) >> 16;
3084 key.uChar.AsciiChar = 0;
3085 key.dwControlKeyState = modifiers;
3087 add = w32_kbd_patch_key (&key, w32_keyboard_codepage);
3088 /* 0 means an unrecognized keycode, negative means
3089 dead key. Ignore both. */
3090 while (--add >= 0)
3092 /* Forward asciified character sequence. */
3093 post_character_message
3094 (hwnd, WM_CHAR,
3095 (unsigned char) key.uChar.AsciiChar, lParam,
3096 w32_get_key_modifiers (wParam, lParam));
3097 w32_kbd_patch_key (&key, w32_keyboard_codepage);
3099 return 0;
3102 else
3104 /* Let TranslateMessage handle everything else. */
3105 windows_translate = 1;
3110 translate:
3111 if (windows_translate)
3113 MSG windows_msg = { hwnd, msg, wParam, lParam, 0, {0,0} };
3114 windows_msg.time = GetMessageTime ();
3115 TranslateMessage (&windows_msg);
3116 goto dflt;
3119 /* Fall through */
3121 case WM_SYSCHAR:
3122 case WM_CHAR:
3123 if (wParam > 255 )
3125 W32Msg wmsg;
3127 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3128 signal_user_input ();
3129 my_post_msg (&wmsg, hwnd, WM_UNICHAR, wParam, lParam);
3132 else
3133 post_character_message (hwnd, msg, wParam, lParam,
3134 w32_get_key_modifiers (wParam, lParam));
3135 break;
3137 case WM_UNICHAR:
3138 /* WM_UNICHAR looks promising from the docs, but the exact
3139 circumstances in which TranslateMessage sends it is one of those
3140 Microsoft secret API things that EU and US courts are supposed
3141 to have put a stop to already. Spy++ shows it being sent to Notepad
3142 and other MS apps, but never to Emacs.
3144 Some third party IMEs send it in accordance with the official
3145 documentation though, so handle it here.
3147 UNICODE_NOCHAR is used to test for support for this message.
3148 TRUE indicates that the message is supported. */
3149 if (wParam == UNICODE_NOCHAR)
3150 return TRUE;
3153 W32Msg wmsg;
3154 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3155 signal_user_input ();
3156 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3158 break;
3160 case WM_IME_CHAR:
3161 /* If we can't get the IME result as Unicode, use default processing,
3162 which will at least allow characters decodable in the system locale
3163 get through. */
3164 if (!get_composition_string_fn)
3165 goto dflt;
3167 else if (!ignore_ime_char)
3169 wchar_t * buffer;
3170 int size, i;
3171 W32Msg wmsg;
3172 HIMC context = get_ime_context_fn (hwnd);
3173 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3174 /* Get buffer size. */
3175 size = get_composition_string_fn (context, GCS_RESULTSTR, NULL, 0);
3176 buffer = alloca (size);
3177 size = get_composition_string_fn (context, GCS_RESULTSTR,
3178 buffer, size);
3179 release_ime_context_fn (hwnd, context);
3181 signal_user_input ();
3182 for (i = 0; i < size / sizeof (wchar_t); i++)
3184 my_post_msg (&wmsg, hwnd, WM_UNICHAR, (WPARAM) buffer[i],
3185 lParam);
3187 /* Ignore the messages for the rest of the
3188 characters in the string that was output above. */
3189 ignore_ime_char = (size / sizeof (wchar_t)) - 1;
3191 else
3192 ignore_ime_char--;
3194 break;
3196 case WM_IME_STARTCOMPOSITION:
3197 if (!set_ime_composition_window_fn)
3198 goto dflt;
3199 else
3201 COMPOSITIONFORM form;
3202 HIMC context;
3203 struct window *w;
3205 /* Implementation note: The code below does something that
3206 one shouldn't do: it accesses the window object from a
3207 separate thread, while the main (a.k.a. "Lisp") thread
3208 runs and can legitimately delete and even GC it. That is
3209 why we are extra careful not to futz with a window that
3210 is different from the one recorded when the system caret
3211 coordinates were last modified. That is also why we are
3212 careful not to move the IME window if the window
3213 described by W was deleted, as indicated by its buffer
3214 field being reset to nil. */
3215 f = x_window_to_frame (dpyinfo, hwnd);
3216 if (!(f && FRAME_LIVE_P (f)))
3217 break;
3218 w = XWINDOW (FRAME_SELECTED_WINDOW (f));
3219 /* Punt if someone changed the frame's selected window
3220 behind our back. */
3221 if (w != w32_system_caret_window)
3222 break;
3224 form.dwStyle = CFS_RECT;
3225 form.ptCurrentPos.x = w32_system_caret_x;
3226 form.ptCurrentPos.y = w32_system_caret_y;
3228 form.rcArea.left = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, 0);
3229 form.rcArea.top = (WINDOW_TOP_EDGE_Y (w)
3230 + w32_system_caret_hdr_height);
3231 form.rcArea.right = (WINDOW_BOX_RIGHT_EDGE_X (w)
3232 - WINDOW_RIGHT_MARGIN_WIDTH (w)
3233 - WINDOW_RIGHT_FRINGE_WIDTH (w));
3234 form.rcArea.bottom = (WINDOW_BOTTOM_EDGE_Y (w)
3235 - w32_system_caret_mode_height);
3237 /* Punt if the window was deleted behind our back. */
3238 if (!BUFFERP (w->contents))
3239 break;
3241 context = get_ime_context_fn (hwnd);
3243 if (!context)
3244 break;
3246 set_ime_composition_window_fn (context, &form);
3247 release_ime_context_fn (hwnd, context);
3249 break;
3251 case WM_IME_ENDCOMPOSITION:
3252 ignore_ime_char = 0;
3253 goto dflt;
3255 /* Simulate middle mouse button events when left and right buttons
3256 are used together, but only if user has two button mouse. */
3257 case WM_LBUTTONDOWN:
3258 case WM_RBUTTONDOWN:
3259 if (w32_num_mouse_buttons > 2)
3260 goto handle_plain_button;
3263 int this = (msg == WM_LBUTTONDOWN) ? LMOUSE : RMOUSE;
3264 int other = (msg == WM_LBUTTONDOWN) ? RMOUSE : LMOUSE;
3266 if (button_state & this)
3267 return 0;
3269 if (button_state == 0)
3270 SetCapture (hwnd);
3272 button_state |= this;
3274 if (button_state & other)
3276 if (mouse_button_timer)
3278 KillTimer (hwnd, mouse_button_timer);
3279 mouse_button_timer = 0;
3281 /* Generate middle mouse event instead. */
3282 msg = WM_MBUTTONDOWN;
3283 button_state |= MMOUSE;
3285 else if (button_state & MMOUSE)
3287 /* Ignore button event if we've already generated a
3288 middle mouse down event. This happens if the
3289 user releases and press one of the two buttons
3290 after we've faked a middle mouse event. */
3291 return 0;
3293 else
3295 /* Flush out saved message. */
3296 post_msg (&saved_mouse_button_msg);
3298 wmsg.dwModifiers = w32_get_modifiers ();
3299 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3300 signal_user_input ();
3302 /* Clear message buffer. */
3303 saved_mouse_button_msg.msg.hwnd = 0;
3305 else
3307 /* Hold onto message for now. */
3308 mouse_button_timer =
3309 SetTimer (hwnd, MOUSE_BUTTON_ID,
3310 w32_mouse_button_tolerance, NULL);
3311 saved_mouse_button_msg.msg.hwnd = hwnd;
3312 saved_mouse_button_msg.msg.message = msg;
3313 saved_mouse_button_msg.msg.wParam = wParam;
3314 saved_mouse_button_msg.msg.lParam = lParam;
3315 saved_mouse_button_msg.msg.time = GetMessageTime ();
3316 saved_mouse_button_msg.dwModifiers = w32_get_modifiers ();
3319 return 0;
3321 case WM_LBUTTONUP:
3322 case WM_RBUTTONUP:
3323 if (w32_num_mouse_buttons > 2)
3324 goto handle_plain_button;
3327 int this = (msg == WM_LBUTTONUP) ? LMOUSE : RMOUSE;
3328 int other = (msg == WM_LBUTTONUP) ? RMOUSE : LMOUSE;
3330 if ((button_state & this) == 0)
3331 return 0;
3333 button_state &= ~this;
3335 if (button_state & MMOUSE)
3337 /* Only generate event when second button is released. */
3338 if ((button_state & other) == 0)
3340 msg = WM_MBUTTONUP;
3341 button_state &= ~MMOUSE;
3343 if (button_state) emacs_abort ();
3345 else
3346 return 0;
3348 else
3350 /* Flush out saved message if necessary. */
3351 if (saved_mouse_button_msg.msg.hwnd)
3353 post_msg (&saved_mouse_button_msg);
3356 wmsg.dwModifiers = w32_get_modifiers ();
3357 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3358 signal_user_input ();
3360 /* Always clear message buffer and cancel timer. */
3361 saved_mouse_button_msg.msg.hwnd = 0;
3362 KillTimer (hwnd, mouse_button_timer);
3363 mouse_button_timer = 0;
3365 if (button_state == 0)
3366 ReleaseCapture ();
3368 return 0;
3370 case WM_XBUTTONDOWN:
3371 case WM_XBUTTONUP:
3372 if (w32_pass_extra_mouse_buttons_to_system)
3373 goto dflt;
3374 /* else fall through and process them. */
3375 case WM_MBUTTONDOWN:
3376 case WM_MBUTTONUP:
3377 handle_plain_button:
3379 BOOL up;
3380 int button;
3382 /* Ignore middle and extra buttons as long as the menu is active. */
3383 f = x_window_to_frame (dpyinfo, hwnd);
3384 if (f && f->output_data.w32->menubar_active)
3385 return 0;
3387 if (parse_button (msg, HIWORD (wParam), &button, &up))
3389 if (up) ReleaseCapture ();
3390 else SetCapture (hwnd);
3391 button = (button == 0) ? LMOUSE :
3392 ((button == 1) ? MMOUSE : RMOUSE);
3393 if (up)
3394 button_state &= ~button;
3395 else
3396 button_state |= button;
3400 wmsg.dwModifiers = w32_get_modifiers ();
3401 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3402 signal_user_input ();
3404 /* Need to return true for XBUTTON messages, false for others,
3405 to indicate that we processed the message. */
3406 return (msg == WM_XBUTTONDOWN || msg == WM_XBUTTONUP);
3408 case WM_MOUSEMOVE:
3409 /* Ignore mouse movements as long as the menu is active. These
3410 movements are processed by the window manager anyway, and
3411 it's wrong to handle them as if they happened on the
3412 underlying frame. */
3413 f = x_window_to_frame (dpyinfo, hwnd);
3414 if (f && f->output_data.w32->menubar_active)
3415 return 0;
3417 /* If the mouse has just moved into the frame, start tracking
3418 it, so we will be notified when it leaves the frame. Mouse
3419 tracking only works under W98 and NT4 and later. On earlier
3420 versions, there is no way of telling when the mouse leaves the
3421 frame, so we just have to put up with help-echo and mouse
3422 highlighting remaining while the frame is not active. */
3423 if (track_mouse_event_fn && !track_mouse_window
3424 /* If the menu bar is active, turning on tracking of mouse
3425 movement events might send these events to the tooltip
3426 frame, if the user happens to move the mouse pointer over
3427 the tooltip. But since we don't process events for
3428 tooltip frames, this causes Windows to present a
3429 hourglass cursor, which is ugly and unexpected. So don't
3430 enable tracking mouse events in this case; they will be
3431 restarted when the menu pops down. (Confusingly, the
3432 menubar_active member of f->output_data.w32, tested
3433 above, is only set when a menu was popped up _not_ from
3434 the frame's menu bar, but via x-popup-menu.) */
3435 && !menubar_in_use)
3437 TRACKMOUSEEVENT tme;
3438 tme.cbSize = sizeof (tme);
3439 tme.dwFlags = TME_LEAVE;
3440 tme.hwndTrack = hwnd;
3442 track_mouse_event_fn (&tme);
3443 track_mouse_window = hwnd;
3445 case WM_VSCROLL:
3446 if (w32_mouse_move_interval <= 0
3447 || (msg == WM_MOUSEMOVE && button_state == 0))
3449 wmsg.dwModifiers = w32_get_modifiers ();
3450 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3451 return 0;
3454 /* Hang onto mouse move and scroll messages for a bit, to avoid
3455 sending such events to Emacs faster than it can process them.
3456 If we get more events before the timer from the first message
3457 expires, we just replace the first message. */
3459 if (saved_mouse_move_msg.msg.hwnd == 0)
3460 mouse_move_timer =
3461 SetTimer (hwnd, MOUSE_MOVE_ID,
3462 w32_mouse_move_interval, NULL);
3464 /* Hold onto message for now. */
3465 saved_mouse_move_msg.msg.hwnd = hwnd;
3466 saved_mouse_move_msg.msg.message = msg;
3467 saved_mouse_move_msg.msg.wParam = wParam;
3468 saved_mouse_move_msg.msg.lParam = lParam;
3469 saved_mouse_move_msg.msg.time = GetMessageTime ();
3470 saved_mouse_move_msg.dwModifiers = w32_get_modifiers ();
3472 return 0;
3474 case WM_MOUSEWHEEL:
3475 case WM_DROPFILES:
3476 wmsg.dwModifiers = w32_get_modifiers ();
3477 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3478 signal_user_input ();
3479 return 0;
3481 case WM_APPCOMMAND:
3482 if (w32_pass_multimedia_buttons_to_system)
3483 goto dflt;
3484 /* Otherwise, pass to lisp, the same way we do with mousehwheel. */
3485 case WM_MOUSEHWHEEL:
3486 wmsg.dwModifiers = w32_get_modifiers ();
3487 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3488 signal_user_input ();
3489 /* Non-zero must be returned when WM_MOUSEHWHEEL messages are
3490 handled, to prevent the system trying to handle it by faking
3491 scroll bar events. */
3492 return 1;
3494 case WM_TIMER:
3495 /* Flush out saved messages if necessary. */
3496 if (wParam == mouse_button_timer)
3498 if (saved_mouse_button_msg.msg.hwnd)
3500 post_msg (&saved_mouse_button_msg);
3501 signal_user_input ();
3502 saved_mouse_button_msg.msg.hwnd = 0;
3504 KillTimer (hwnd, mouse_button_timer);
3505 mouse_button_timer = 0;
3507 else if (wParam == mouse_move_timer)
3509 if (saved_mouse_move_msg.msg.hwnd)
3511 post_msg (&saved_mouse_move_msg);
3512 saved_mouse_move_msg.msg.hwnd = 0;
3514 KillTimer (hwnd, mouse_move_timer);
3515 mouse_move_timer = 0;
3517 else if (wParam == menu_free_timer)
3519 KillTimer (hwnd, menu_free_timer);
3520 menu_free_timer = 0;
3521 f = x_window_to_frame (dpyinfo, hwnd);
3522 /* If a popup menu is active, don't wipe its strings. */
3523 if (menubar_in_use
3524 && current_popup_menu == NULL)
3526 /* Free memory used by owner-drawn and help-echo strings. */
3527 w32_free_menu_strings (hwnd);
3528 if (f)
3529 f->output_data.w32->menubar_active = 0;
3530 menubar_in_use = 0;
3533 return 0;
3535 case WM_NCACTIVATE:
3536 /* Windows doesn't send us focus messages when putting up and
3537 taking down a system popup dialog as for Ctrl-Alt-Del on Windows 95.
3538 The only indication we get that something happened is receiving
3539 this message afterwards. So this is a good time to reset our
3540 keyboard modifiers' state. */
3541 reset_modifiers ();
3542 goto dflt;
3544 case WM_INITMENU:
3545 button_state = 0;
3546 ReleaseCapture ();
3547 /* We must ensure menu bar is fully constructed and up to date
3548 before allowing user interaction with it. To achieve this
3549 we send this message to the lisp thread and wait for a
3550 reply (whose value is not actually needed) to indicate that
3551 the menu bar is now ready for use, so we can now return.
3553 To remain responsive in the meantime, we enter a nested message
3554 loop that can process all other messages.
3556 However, we skip all this if the message results from calling
3557 TrackPopupMenu - in fact, we must NOT attempt to send the lisp
3558 thread a message because it is blocked on us at this point. We
3559 set menubar_active before calling TrackPopupMenu to indicate
3560 this (there is no possibility of confusion with real menubar
3561 being active). */
3563 f = x_window_to_frame (dpyinfo, hwnd);
3564 if (f
3565 && (f->output_data.w32->menubar_active
3566 /* We can receive this message even in the absence of a
3567 menubar (ie. when the system menu is activated) - in this
3568 case we do NOT want to forward the message, otherwise it
3569 will cause the menubar to suddenly appear when the user
3570 had requested it to be turned off! */
3571 || f->output_data.w32->menubar_widget == NULL))
3572 return 0;
3575 deferred_msg msg_buf;
3577 /* Detect if message has already been deferred; in this case
3578 we cannot return any sensible value to ignore this. */
3579 if (find_deferred_msg (hwnd, msg) != NULL)
3580 emacs_abort ();
3582 menubar_in_use = 1;
3584 return send_deferred_msg (&msg_buf, hwnd, msg, wParam, lParam);
3587 case WM_EXITMENULOOP:
3588 f = x_window_to_frame (dpyinfo, hwnd);
3590 /* If a menu is still active, check again after a short delay,
3591 since Windows often (always?) sends the WM_EXITMENULOOP
3592 before the corresponding WM_COMMAND message.
3593 Don't do this if a popup menu is active, since it is only
3594 menubar menus that require cleaning up in this way.
3596 if (f && menubar_in_use && current_popup_menu == NULL)
3597 menu_free_timer = SetTimer (hwnd, MENU_FREE_ID, MENU_FREE_DELAY, NULL);
3599 /* If hourglass cursor should be displayed, display it now. */
3600 if (f && f->output_data.w32->hourglass_p)
3601 SetCursor (f->output_data.w32->hourglass_cursor);
3603 goto dflt;
3605 case WM_MENUSELECT:
3606 /* Direct handling of help_echo in menus. Should be safe now
3607 that we generate the help_echo by placing a help event in the
3608 keyboard buffer. */
3610 HMENU menu = (HMENU) lParam;
3611 UINT menu_item = (UINT) LOWORD (wParam);
3612 UINT flags = (UINT) HIWORD (wParam);
3614 w32_menu_display_help (hwnd, menu, menu_item, flags);
3616 return 0;
3618 case WM_MEASUREITEM:
3619 f = x_window_to_frame (dpyinfo, hwnd);
3620 if (f)
3622 MEASUREITEMSTRUCT * pMis = (MEASUREITEMSTRUCT *) lParam;
3624 if (pMis->CtlType == ODT_MENU)
3626 /* Work out dimensions for popup menu titles. */
3627 char * title = (char *) pMis->itemData;
3628 HDC hdc = GetDC (hwnd);
3629 HFONT menu_font = GetCurrentObject (hdc, OBJ_FONT);
3630 LOGFONT menu_logfont;
3631 HFONT old_font;
3632 SIZE size;
3634 GetObject (menu_font, sizeof (menu_logfont), &menu_logfont);
3635 menu_logfont.lfWeight = FW_BOLD;
3636 menu_font = CreateFontIndirect (&menu_logfont);
3637 old_font = SelectObject (hdc, menu_font);
3639 pMis->itemHeight = GetSystemMetrics (SM_CYMENUSIZE);
3640 if (title)
3642 if (unicode_append_menu)
3643 GetTextExtentPoint32W (hdc, (WCHAR *) title,
3644 wcslen ((WCHAR *) title),
3645 &size);
3646 else
3647 GetTextExtentPoint32 (hdc, title, strlen (title), &size);
3649 pMis->itemWidth = size.cx;
3650 if (pMis->itemHeight < size.cy)
3651 pMis->itemHeight = size.cy;
3653 else
3654 pMis->itemWidth = 0;
3656 SelectObject (hdc, old_font);
3657 DeleteObject (menu_font);
3658 ReleaseDC (hwnd, hdc);
3659 return TRUE;
3662 return 0;
3664 case WM_DRAWITEM:
3665 f = x_window_to_frame (dpyinfo, hwnd);
3666 if (f)
3668 DRAWITEMSTRUCT * pDis = (DRAWITEMSTRUCT *) lParam;
3670 if (pDis->CtlType == ODT_MENU)
3672 /* Draw popup menu title. */
3673 char * title = (char *) pDis->itemData;
3674 if (title)
3676 HDC hdc = pDis->hDC;
3677 HFONT menu_font = GetCurrentObject (hdc, OBJ_FONT);
3678 LOGFONT menu_logfont;
3679 HFONT old_font;
3681 GetObject (menu_font, sizeof (menu_logfont), &menu_logfont);
3682 menu_logfont.lfWeight = FW_BOLD;
3683 menu_font = CreateFontIndirect (&menu_logfont);
3684 old_font = SelectObject (hdc, menu_font);
3686 /* Always draw title as if not selected. */
3687 if (unicode_append_menu)
3688 ExtTextOutW (hdc,
3689 pDis->rcItem.left
3690 + GetSystemMetrics (SM_CXMENUCHECK),
3691 pDis->rcItem.top,
3692 ETO_OPAQUE, &pDis->rcItem,
3693 (WCHAR *) title,
3694 wcslen ((WCHAR *) title), NULL);
3695 else
3696 ExtTextOut (hdc,
3697 pDis->rcItem.left
3698 + GetSystemMetrics (SM_CXMENUCHECK),
3699 pDis->rcItem.top,
3700 ETO_OPAQUE, &pDis->rcItem,
3701 title, strlen (title), NULL);
3703 SelectObject (hdc, old_font);
3704 DeleteObject (menu_font);
3706 return TRUE;
3709 return 0;
3711 #if 0
3712 /* Still not right - can't distinguish between clicks in the
3713 client area of the frame from clicks forwarded from the scroll
3714 bars - may have to hook WM_NCHITTEST to remember the mouse
3715 position and then check if it is in the client area ourselves. */
3716 case WM_MOUSEACTIVATE:
3717 /* Discard the mouse click that activates a frame, allowing the
3718 user to click anywhere without changing point (or worse!).
3719 Don't eat mouse clicks on scrollbars though!! */
3720 if (LOWORD (lParam) == HTCLIENT )
3721 return MA_ACTIVATEANDEAT;
3722 goto dflt;
3723 #endif
3725 case WM_MOUSELEAVE:
3726 /* No longer tracking mouse. */
3727 track_mouse_window = NULL;
3729 case WM_ACTIVATEAPP:
3730 case WM_ACTIVATE:
3731 case WM_WINDOWPOSCHANGED:
3732 case WM_SHOWWINDOW:
3733 /* Inform lisp thread that a frame might have just been obscured
3734 or exposed, so should recheck visibility of all frames. */
3735 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3736 goto dflt;
3738 case WM_SETFOCUS:
3739 dpyinfo->faked_key = 0;
3740 reset_modifiers ();
3741 register_hot_keys (hwnd);
3742 goto command;
3743 case WM_KILLFOCUS:
3744 unregister_hot_keys (hwnd);
3745 button_state = 0;
3746 ReleaseCapture ();
3747 /* Relinquish the system caret. */
3748 if (w32_system_caret_hwnd)
3750 w32_visible_system_caret_hwnd = NULL;
3751 w32_system_caret_hwnd = NULL;
3752 DestroyCaret ();
3754 goto command;
3755 case WM_COMMAND:
3756 menubar_in_use = 0;
3757 f = x_window_to_frame (dpyinfo, hwnd);
3758 if (f && HIWORD (wParam) == 0)
3760 if (menu_free_timer)
3762 KillTimer (hwnd, menu_free_timer);
3763 menu_free_timer = 0;
3766 case WM_MOVE:
3767 case WM_SIZE:
3768 command:
3769 wmsg.dwModifiers = w32_get_modifiers ();
3770 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3771 goto dflt;
3773 case WM_DESTROY:
3774 CoUninitialize ();
3775 return 0;
3777 case WM_CLOSE:
3778 wmsg.dwModifiers = w32_get_modifiers ();
3779 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3780 return 0;
3782 case WM_WINDOWPOSCHANGING:
3783 /* Don't restrict the sizing of tip frames. */
3784 if (hwnd == tip_window)
3785 return 0;
3787 /* Don't restrict the sizing of fullscreened frames, allowing them to be
3788 flush with the sides of the screen. */
3789 f = x_window_to_frame (dpyinfo, hwnd);
3790 if (f && FRAME_PREV_FSMODE (f) != FULLSCREEN_NONE)
3791 return 0;
3794 WINDOWPLACEMENT wp;
3795 LPWINDOWPOS lppos = (WINDOWPOS *) lParam;
3797 wp.length = sizeof (WINDOWPLACEMENT);
3798 GetWindowPlacement (hwnd, &wp);
3800 if (wp.showCmd != SW_SHOWMINIMIZED && (lppos->flags & SWP_NOSIZE) == 0)
3802 RECT rect;
3803 int wdiff;
3804 int hdiff;
3805 DWORD font_width;
3806 DWORD line_height;
3807 DWORD internal_border;
3808 DWORD scrollbar_extra;
3809 RECT wr;
3811 wp.length = sizeof (wp);
3812 GetWindowRect (hwnd, &wr);
3814 enter_crit ();
3816 font_width = GetWindowLong (hwnd, WND_FONTWIDTH_INDEX);
3817 line_height = GetWindowLong (hwnd, WND_LINEHEIGHT_INDEX);
3818 internal_border = GetWindowLong (hwnd, WND_BORDER_INDEX);
3819 scrollbar_extra = GetWindowLong (hwnd, WND_SCROLLBAR_INDEX);
3821 leave_crit ();
3823 memset (&rect, 0, sizeof (rect));
3824 AdjustWindowRect (&rect, GetWindowLong (hwnd, GWL_STYLE),
3825 GetMenu (hwnd) != NULL);
3827 /* Force width and height of client area to be exact
3828 multiples of the character cell dimensions. */
3829 wdiff = (lppos->cx - (rect.right - rect.left)
3830 - 2 * internal_border - scrollbar_extra)
3831 % font_width;
3832 hdiff = (lppos->cy - (rect.bottom - rect.top)
3833 - 2 * internal_border)
3834 % line_height;
3836 if (wdiff || hdiff)
3838 /* For right/bottom sizing we can just fix the sizes.
3839 However for top/left sizing we will need to fix the X
3840 and Y positions as well. */
3842 int cx_mintrack = GetSystemMetrics (SM_CXMINTRACK);
3843 int cy_mintrack = GetSystemMetrics (SM_CYMINTRACK);
3845 lppos->cx = max (lppos->cx - wdiff, cx_mintrack);
3846 lppos->cy = max (lppos->cy - hdiff, cy_mintrack);
3848 if (wp.showCmd != SW_SHOWMAXIMIZED
3849 && (lppos->flags & SWP_NOMOVE) == 0)
3851 if (lppos->x != wr.left || lppos->y != wr.top)
3853 lppos->x += wdiff;
3854 lppos->y += hdiff;
3856 else
3858 lppos->flags |= SWP_NOMOVE;
3862 return 0;
3867 goto dflt;
3869 case WM_GETMINMAXINFO:
3870 /* Hack to allow resizing the Emacs frame above the screen size.
3871 Note that Windows 9x limits coordinates to 16-bits. */
3872 ((LPMINMAXINFO) lParam)->ptMaxTrackSize.x = 32767;
3873 ((LPMINMAXINFO) lParam)->ptMaxTrackSize.y = 32767;
3874 return 0;
3876 case WM_SETCURSOR:
3877 if (LOWORD (lParam) == HTCLIENT)
3879 f = x_window_to_frame (dpyinfo, hwnd);
3880 if (f && f->output_data.w32->hourglass_p
3881 && !menubar_in_use && !current_popup_menu)
3882 SetCursor (f->output_data.w32->hourglass_cursor);
3883 else if (f)
3884 SetCursor (f->output_data.w32->current_cursor);
3885 return 0;
3887 goto dflt;
3889 case WM_EMACS_SETCURSOR:
3891 Cursor cursor = (Cursor) wParam;
3892 f = x_window_to_frame (dpyinfo, hwnd);
3893 if (f && cursor)
3895 f->output_data.w32->current_cursor = cursor;
3896 if (!f->output_data.w32->hourglass_p)
3897 SetCursor (cursor);
3899 return 0;
3902 case WM_EMACS_CREATESCROLLBAR:
3903 return (LRESULT) w32_createscrollbar ((struct frame *) wParam,
3904 (struct scroll_bar *) lParam);
3906 case WM_EMACS_SHOWWINDOW:
3907 return ShowWindow ((HWND) wParam, (WPARAM) lParam);
3909 case WM_EMACS_BRINGTOTOP:
3910 case WM_EMACS_SETFOREGROUND:
3912 HWND foreground_window;
3913 DWORD foreground_thread, retval;
3915 /* On NT 5.0, and apparently Windows 98, it is necessary to
3916 attach to the thread that currently has focus in order to
3917 pull the focus away from it. */
3918 foreground_window = GetForegroundWindow ();
3919 foreground_thread = GetWindowThreadProcessId (foreground_window, NULL);
3920 if (!foreground_window
3921 || foreground_thread == GetCurrentThreadId ()
3922 || !AttachThreadInput (GetCurrentThreadId (),
3923 foreground_thread, TRUE))
3924 foreground_thread = 0;
3926 retval = SetForegroundWindow ((HWND) wParam);
3927 if (msg == WM_EMACS_BRINGTOTOP)
3928 retval = BringWindowToTop ((HWND) wParam);
3930 /* Detach from the previous foreground thread. */
3931 if (foreground_thread)
3932 AttachThreadInput (GetCurrentThreadId (),
3933 foreground_thread, FALSE);
3935 return retval;
3938 case WM_EMACS_SETWINDOWPOS:
3940 WINDOWPOS * pos = (WINDOWPOS *) wParam;
3941 return SetWindowPos (hwnd, pos->hwndInsertAfter,
3942 pos->x, pos->y, pos->cx, pos->cy, pos->flags);
3945 case WM_EMACS_DESTROYWINDOW:
3946 DragAcceptFiles ((HWND) wParam, FALSE);
3947 return DestroyWindow ((HWND) wParam);
3949 case WM_EMACS_HIDE_CARET:
3950 return HideCaret (hwnd);
3952 case WM_EMACS_SHOW_CARET:
3953 return ShowCaret (hwnd);
3955 case WM_EMACS_DESTROY_CARET:
3956 w32_system_caret_hwnd = NULL;
3957 w32_visible_system_caret_hwnd = NULL;
3958 return DestroyCaret ();
3960 case WM_EMACS_TRACK_CARET:
3961 /* If there is currently no system caret, create one. */
3962 if (w32_system_caret_hwnd == NULL)
3964 /* Use the default caret width, and avoid changing it
3965 unnecessarily, as it confuses screen reader software. */
3966 w32_system_caret_hwnd = hwnd;
3967 CreateCaret (hwnd, NULL, 0,
3968 w32_system_caret_height);
3971 if (!SetCaretPos (w32_system_caret_x, w32_system_caret_y))
3972 return 0;
3973 /* Ensure visible caret gets turned on when requested. */
3974 else if (w32_use_visible_system_caret
3975 && w32_visible_system_caret_hwnd != hwnd)
3977 w32_visible_system_caret_hwnd = hwnd;
3978 return ShowCaret (hwnd);
3980 /* Ensure visible caret gets turned off when requested. */
3981 else if (!w32_use_visible_system_caret
3982 && w32_visible_system_caret_hwnd)
3984 w32_visible_system_caret_hwnd = NULL;
3985 return HideCaret (hwnd);
3987 else
3988 return 1;
3990 case WM_EMACS_TRACKPOPUPMENU:
3992 UINT flags;
3993 POINT *pos;
3994 int retval;
3995 pos = (POINT *)lParam;
3996 flags = TPM_CENTERALIGN;
3997 if (button_state & LMOUSE)
3998 flags |= TPM_LEFTBUTTON;
3999 else if (button_state & RMOUSE)
4000 flags |= TPM_RIGHTBUTTON;
4002 /* Remember we did a SetCapture on the initial mouse down event,
4003 so for safety, we make sure the capture is canceled now. */
4004 ReleaseCapture ();
4005 button_state = 0;
4007 /* Use menubar_active to indicate that WM_INITMENU is from
4008 TrackPopupMenu below, and should be ignored. */
4009 f = x_window_to_frame (dpyinfo, hwnd);
4010 if (f)
4011 f->output_data.w32->menubar_active = 1;
4013 if (TrackPopupMenu ((HMENU)wParam, flags, pos->x, pos->y,
4014 0, hwnd, NULL))
4016 MSG amsg;
4017 /* Eat any mouse messages during popupmenu */
4018 while (PeekMessage (&amsg, hwnd, WM_MOUSEFIRST, WM_MOUSELAST,
4019 PM_REMOVE));
4020 /* Get the menu selection, if any */
4021 if (PeekMessage (&amsg, hwnd, WM_COMMAND, WM_COMMAND, PM_REMOVE))
4023 retval = LOWORD (amsg.wParam);
4025 else
4027 retval = 0;
4030 else
4032 retval = -1;
4035 return retval;
4037 case WM_EMACS_FILENOTIFY:
4038 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4039 return 1;
4041 default:
4042 /* Check for messages registered at runtime. */
4043 if (msg == msh_mousewheel)
4045 wmsg.dwModifiers = w32_get_modifiers ();
4046 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4047 signal_user_input ();
4048 return 0;
4051 dflt:
4052 return (w32_unicode_gui ? DefWindowProcW : DefWindowProcA) (hwnd, msg, wParam, lParam);
4055 /* The most common default return code for handled messages is 0. */
4056 return 0;
4059 static void
4060 my_create_window (struct frame * f)
4062 MSG msg;
4064 if (!PostThreadMessage (dwWindowsThreadId, WM_EMACS_CREATEWINDOW, (WPARAM)f, 0))
4065 emacs_abort ();
4066 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
4070 /* Create a tooltip window. Unlike my_create_window, we do not do this
4071 indirectly via the Window thread, as we do not need to process Window
4072 messages for the tooltip. Creating tooltips indirectly also creates
4073 deadlocks when tooltips are created for menu items. */
4074 static void
4075 my_create_tip_window (struct frame *f)
4077 RECT rect;
4079 rect.left = rect.top = 0;
4080 rect.right = FRAME_PIXEL_WIDTH (f);
4081 rect.bottom = FRAME_PIXEL_HEIGHT (f);
4083 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
4084 FRAME_EXTERNAL_MENU_BAR (f));
4086 tip_window = FRAME_W32_WINDOW (f)
4087 = CreateWindow (EMACS_CLASS,
4088 f->namebuf,
4089 f->output_data.w32->dwStyle,
4090 f->left_pos,
4091 f->top_pos,
4092 rect.right - rect.left,
4093 rect.bottom - rect.top,
4094 FRAME_W32_WINDOW (SELECTED_FRAME ()), /* owner */
4095 NULL,
4096 hinst,
4097 NULL);
4099 if (tip_window)
4101 SetWindowLong (tip_window, WND_FONTWIDTH_INDEX, FRAME_COLUMN_WIDTH (f));
4102 SetWindowLong (tip_window, WND_LINEHEIGHT_INDEX, FRAME_LINE_HEIGHT (f));
4103 SetWindowLong (tip_window, WND_BORDER_INDEX, FRAME_INTERNAL_BORDER_WIDTH (f));
4104 SetWindowLong (tip_window, WND_BACKGROUND_INDEX, FRAME_BACKGROUND_PIXEL (f));
4106 /* Tip frames have no scrollbars. */
4107 SetWindowLong (tip_window, WND_SCROLLBAR_INDEX, 0);
4109 /* Do this to discard the default setting specified by our parent. */
4110 ShowWindow (tip_window, SW_HIDE);
4115 /* Create and set up the w32 window for frame F. */
4117 static void
4118 w32_window (struct frame *f, long window_prompting, int minibuffer_only)
4120 block_input ();
4122 /* Use the resource name as the top-level window name
4123 for looking up resources. Make a non-Lisp copy
4124 for the window manager, so GC relocation won't bother it.
4126 Elsewhere we specify the window name for the window manager. */
4127 f->namebuf = xstrdup (SSDATA (Vx_resource_name));
4129 my_create_window (f);
4131 validate_x_resource_name ();
4133 /* x_set_name normally ignores requests to set the name if the
4134 requested name is the same as the current name. This is the one
4135 place where that assumption isn't correct; f->name is set, but
4136 the server hasn't been told. */
4138 Lisp_Object name;
4139 int explicit = f->explicit_name;
4141 f->explicit_name = 0;
4142 name = f->name;
4143 fset_name (f, Qnil);
4144 x_set_name (f, name, explicit);
4147 unblock_input ();
4149 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
4150 initialize_frame_menubar (f);
4152 if (FRAME_W32_WINDOW (f) == 0)
4153 error ("Unable to create window");
4156 /* Handle the icon stuff for this window. Perhaps later we might
4157 want an x_set_icon_position which can be called interactively as
4158 well. */
4160 static void
4161 x_icon (struct frame *f, Lisp_Object parms)
4163 Lisp_Object icon_x, icon_y;
4164 struct w32_display_info *dpyinfo = &one_w32_display_info;
4166 /* Set the position of the icon. Note that Windows 95 groups all
4167 icons in the tray. */
4168 icon_x = x_get_arg (dpyinfo, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
4169 icon_y = x_get_arg (dpyinfo, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
4170 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
4172 CHECK_NUMBER (icon_x);
4173 CHECK_NUMBER (icon_y);
4175 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
4176 error ("Both left and top icon corners of icon must be specified");
4178 block_input ();
4180 #if 0 /* TODO */
4181 /* Start up iconic or window? */
4182 x_wm_set_window_state
4183 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL), Qicon)
4184 ? IconicState
4185 : NormalState));
4187 x_text_icon (f, SSDATA ((!NILP (f->icon_name)
4188 ? f->icon_name
4189 : f->name)));
4190 #endif
4192 unblock_input ();
4196 static void
4197 x_make_gc (struct frame *f)
4199 XGCValues gc_values;
4201 block_input ();
4203 /* Create the GC's of this frame.
4204 Note that many default values are used. */
4206 /* Normal video */
4207 gc_values.font = FRAME_FONT (f);
4209 /* Cursor has cursor-color background, background-color foreground. */
4210 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
4211 gc_values.background = f->output_data.w32->cursor_pixel;
4212 f->output_data.w32->cursor_gc
4213 = XCreateGC (NULL, FRAME_W32_WINDOW (f),
4214 (GCFont | GCForeground | GCBackground),
4215 &gc_values);
4217 /* Reliefs. */
4218 f->output_data.w32->white_relief.gc = 0;
4219 f->output_data.w32->black_relief.gc = 0;
4221 unblock_input ();
4225 /* Handler for signals raised during x_create_frame and
4226 x_create_tip_frame. FRAME is the frame which is partially
4227 constructed. */
4229 static Lisp_Object
4230 unwind_create_frame (Lisp_Object frame)
4232 struct frame *f = XFRAME (frame);
4234 /* If frame is ``official'', nothing to do. */
4235 if (NILP (Fmemq (frame, Vframe_list)))
4237 #ifdef GLYPH_DEBUG
4238 struct w32_display_info *dpyinfo = FRAME_W32_DISPLAY_INFO (f);
4239 #endif
4241 x_free_frame_resources (f);
4242 free_glyphs (f);
4244 #ifdef GLYPH_DEBUG
4245 /* Check that reference counts are indeed correct. */
4246 eassert (dpyinfo->reference_count == dpyinfo_refcount);
4247 eassert (dpyinfo->terminal->image_cache->refcount == image_cache_refcount);
4248 #endif
4249 return Qt;
4252 return Qnil;
4255 static void
4256 do_unwind_create_frame (Lisp_Object frame)
4258 unwind_create_frame (frame);
4261 static void
4262 x_default_font_parameter (struct frame *f, Lisp_Object parms)
4264 struct w32_display_info *dpyinfo = FRAME_W32_DISPLAY_INFO (f);
4265 Lisp_Object font_param = x_get_arg (dpyinfo, parms, Qfont, NULL, NULL,
4266 RES_TYPE_STRING);
4267 Lisp_Object font;
4268 if (EQ (font_param, Qunbound))
4269 font_param = Qnil;
4270 font = !NILP (font_param) ? font_param
4271 : x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
4273 if (!STRINGP (font))
4275 int i;
4276 static char *names[]
4277 = { "Courier New-10",
4278 "-*-Courier-normal-r-*-*-13-*-*-*-c-*-iso8859-1",
4279 "-*-Fixedsys-normal-r-*-*-12-*-*-*-c-*-iso8859-1",
4280 "Fixedsys",
4281 NULL };
4283 for (i = 0; names[i]; i++)
4285 font = font_open_by_name (f, build_unibyte_string (names[i]));
4286 if (! NILP (font))
4287 break;
4289 if (NILP (font))
4290 error ("No suitable font was found");
4292 else if (!NILP (font_param))
4294 /* Remember the explicit font parameter, so we can re-apply it after
4295 we've applied the `default' face settings. */
4296 x_set_frame_parameters (f, Fcons (Fcons (Qfont_param, font_param), Qnil));
4298 x_default_parameter (f, parms, Qfont, font, "font", "Font", RES_TYPE_STRING);
4301 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
4302 1, 1, 0,
4303 doc: /* Make a new window, which is called a \"frame\" in Emacs terms.
4304 Return an Emacs frame object.
4305 PARAMETERS is an alist of frame parameters.
4306 If the parameters specify that the frame should not have a minibuffer,
4307 and do not specify a specific minibuffer window to use,
4308 then `default-minibuffer-frame' must be a frame whose minibuffer can
4309 be shared by the new frame.
4311 This function is an internal primitive--use `make-frame' instead. */)
4312 (Lisp_Object parameters)
4314 struct frame *f;
4315 Lisp_Object frame, tem;
4316 Lisp_Object name;
4317 int minibuffer_only = 0;
4318 long window_prompting = 0;
4319 int width, height;
4320 ptrdiff_t count = SPECPDL_INDEX ();
4321 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4322 Lisp_Object display;
4323 struct w32_display_info *dpyinfo = NULL;
4324 Lisp_Object parent;
4325 struct kboard *kb;
4327 /* Make copy of frame parameters because the original is in pure
4328 storage now. */
4329 parameters = Fcopy_alist (parameters);
4331 /* Use this general default value to start with
4332 until we know if this frame has a specified name. */
4333 Vx_resource_name = Vinvocation_name;
4335 display = x_get_arg (dpyinfo, parameters, Qterminal, 0, 0, RES_TYPE_NUMBER);
4336 if (EQ (display, Qunbound))
4337 display = x_get_arg (dpyinfo, parameters, Qdisplay, 0, 0, RES_TYPE_STRING);
4338 if (EQ (display, Qunbound))
4339 display = Qnil;
4340 dpyinfo = check_x_display_info (display);
4341 kb = dpyinfo->terminal->kboard;
4343 if (!dpyinfo->terminal->name)
4344 error ("Terminal is not live, can't create new frames on it");
4346 name = x_get_arg (dpyinfo, parameters, Qname, "name", "Name", RES_TYPE_STRING);
4347 if (!STRINGP (name)
4348 && ! EQ (name, Qunbound)
4349 && ! NILP (name))
4350 error ("Invalid frame name--not a string or nil");
4352 if (STRINGP (name))
4353 Vx_resource_name = name;
4355 /* See if parent window is specified. */
4356 parent = x_get_arg (dpyinfo, parameters, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
4357 if (EQ (parent, Qunbound))
4358 parent = Qnil;
4359 if (! NILP (parent))
4360 CHECK_NUMBER (parent);
4362 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
4363 /* No need to protect DISPLAY because that's not used after passing
4364 it to make_frame_without_minibuffer. */
4365 frame = Qnil;
4366 GCPRO4 (parameters, parent, name, frame);
4367 tem = x_get_arg (dpyinfo, parameters, Qminibuffer, "minibuffer", "Minibuffer",
4368 RES_TYPE_SYMBOL);
4369 if (EQ (tem, Qnone) || NILP (tem))
4370 f = make_frame_without_minibuffer (Qnil, kb, display);
4371 else if (EQ (tem, Qonly))
4373 f = make_minibuffer_frame ();
4374 minibuffer_only = 1;
4376 else if (WINDOWP (tem))
4377 f = make_frame_without_minibuffer (tem, kb, display);
4378 else
4379 f = make_frame (1);
4381 XSETFRAME (frame, f);
4383 /* By default, make scrollbars the system standard width. */
4384 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = GetSystemMetrics (SM_CXVSCROLL);
4386 f->terminal = dpyinfo->terminal;
4388 f->output_method = output_w32;
4389 f->output_data.w32 = xzalloc (sizeof (struct w32_output));
4390 FRAME_FONTSET (f) = -1;
4392 fset_icon_name
4393 (f, x_get_arg (dpyinfo, parameters, Qicon_name, "iconName", "Title",
4394 RES_TYPE_STRING));
4395 if (! STRINGP (f->icon_name))
4396 fset_icon_name (f, Qnil);
4398 /* FRAME_W32_DISPLAY_INFO (f) = dpyinfo; */
4400 /* With FRAME_X_DISPLAY_INFO set up, this unwind-protect is safe. */
4401 record_unwind_protect (do_unwind_create_frame, frame);
4402 #ifdef GLYPH_DEBUG
4403 image_cache_refcount =
4404 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
4405 dpyinfo_refcount = dpyinfo->reference_count;
4406 #endif /* GLYPH_DEBUG */
4408 /* Specify the parent under which to make this window. */
4410 if (!NILP (parent))
4412 f->output_data.w32->parent_desc = (Window) XFASTINT (parent);
4413 f->output_data.w32->explicit_parent = 1;
4415 else
4417 f->output_data.w32->parent_desc = FRAME_W32_DISPLAY_INFO (f)->root_window;
4418 f->output_data.w32->explicit_parent = 0;
4421 /* Set the name; the functions to which we pass f expect the name to
4422 be set. */
4423 if (EQ (name, Qunbound) || NILP (name))
4425 fset_name (f, build_string (dpyinfo->w32_id_name));
4426 f->explicit_name = 0;
4428 else
4430 fset_name (f, name);
4431 f->explicit_name = 1;
4432 /* use the frame's title when getting resources for this frame. */
4433 specbind (Qx_resource_name, name);
4436 if (uniscribe_available)
4437 register_font_driver (&uniscribe_font_driver, f);
4438 register_font_driver (&w32font_driver, f);
4440 x_default_parameter (f, parameters, Qfont_backend, Qnil,
4441 "fontBackend", "FontBackend", RES_TYPE_STRING);
4442 /* Extract the window parameters from the supplied values
4443 that are needed to determine window geometry. */
4444 x_default_font_parameter (f, parameters);
4445 x_default_parameter (f, parameters, Qborder_width, make_number (2),
4446 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4448 /* We recognize either internalBorderWidth or internalBorder
4449 (which is what xterm calls it). */
4450 if (NILP (Fassq (Qinternal_border_width, parameters)))
4452 Lisp_Object value;
4454 value = x_get_arg (dpyinfo, parameters, Qinternal_border_width,
4455 "internalBorder", "InternalBorder", RES_TYPE_NUMBER);
4456 if (! EQ (value, Qunbound))
4457 parameters = Fcons (Fcons (Qinternal_border_width, value),
4458 parameters);
4460 /* Default internalBorderWidth to 0 on Windows to match other programs. */
4461 x_default_parameter (f, parameters, Qinternal_border_width, make_number (0),
4462 "internalBorderWidth", "InternalBorder", RES_TYPE_NUMBER);
4463 x_default_parameter (f, parameters, Qvertical_scroll_bars, Qright,
4464 "verticalScrollBars", "ScrollBars", RES_TYPE_SYMBOL);
4466 /* Also do the stuff which must be set before the window exists. */
4467 x_default_parameter (f, parameters, Qforeground_color, build_string ("black"),
4468 "foreground", "Foreground", RES_TYPE_STRING);
4469 x_default_parameter (f, parameters, Qbackground_color, build_string ("white"),
4470 "background", "Background", RES_TYPE_STRING);
4471 x_default_parameter (f, parameters, Qmouse_color, build_string ("black"),
4472 "pointerColor", "Foreground", RES_TYPE_STRING);
4473 x_default_parameter (f, parameters, Qborder_color, build_string ("black"),
4474 "borderColor", "BorderColor", RES_TYPE_STRING);
4475 x_default_parameter (f, parameters, Qscreen_gamma, Qnil,
4476 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
4477 x_default_parameter (f, parameters, Qline_spacing, Qnil,
4478 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
4479 x_default_parameter (f, parameters, Qleft_fringe, Qnil,
4480 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
4481 x_default_parameter (f, parameters, Qright_fringe, Qnil,
4482 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
4484 /* Init faces before x_default_parameter is called for scroll-bar
4485 parameters because that function calls x_set_scroll_bar_width,
4486 which calls change_frame_size, which calls Fset_window_buffer,
4487 which runs hooks, which call Fvertical_motion. At the end, we
4488 end up in init_iterator with a null face cache, which should not
4489 happen. */
4490 init_frame_faces (f);
4492 /* The X resources controlling the menu-bar and tool-bar are
4493 processed specially at startup, and reflected in the mode
4494 variables; ignore them here. */
4495 x_default_parameter (f, parameters, Qmenu_bar_lines,
4496 NILP (Vmenu_bar_mode)
4497 ? make_number (0) : make_number (1),
4498 NULL, NULL, RES_TYPE_NUMBER);
4499 x_default_parameter (f, parameters, Qtool_bar_lines,
4500 NILP (Vtool_bar_mode)
4501 ? make_number (0) : make_number (1),
4502 NULL, NULL, RES_TYPE_NUMBER);
4504 x_default_parameter (f, parameters, Qbuffer_predicate, Qnil,
4505 "bufferPredicate", "BufferPredicate", RES_TYPE_SYMBOL);
4506 x_default_parameter (f, parameters, Qtitle, Qnil,
4507 "title", "Title", RES_TYPE_STRING);
4508 x_default_parameter (f, parameters, Qfullscreen, Qnil,
4509 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
4511 f->output_data.w32->dwStyle = WS_OVERLAPPEDWINDOW;
4512 f->output_data.w32->parent_desc = FRAME_W32_DISPLAY_INFO (f)->root_window;
4514 f->output_data.w32->text_cursor = w32_load_cursor (IDC_IBEAM);
4515 f->output_data.w32->nontext_cursor = w32_load_cursor (IDC_ARROW);
4516 f->output_data.w32->modeline_cursor = w32_load_cursor (IDC_ARROW);
4517 f->output_data.w32->hand_cursor = w32_load_cursor (IDC_HAND);
4518 f->output_data.w32->hourglass_cursor = w32_load_cursor (IDC_WAIT);
4519 f->output_data.w32->horizontal_drag_cursor = w32_load_cursor (IDC_SIZEWE);
4521 f->output_data.w32->current_cursor = f->output_data.w32->nontext_cursor;
4523 window_prompting = x_figure_window_size (f, parameters, 1);
4525 tem = x_get_arg (dpyinfo, parameters, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
4526 f->no_split = minibuffer_only || EQ (tem, Qt);
4528 w32_window (f, window_prompting, minibuffer_only);
4529 x_icon (f, parameters);
4531 x_make_gc (f);
4533 /* Now consider the frame official. */
4534 f->terminal->reference_count++;
4535 FRAME_W32_DISPLAY_INFO (f)->reference_count++;
4536 Vframe_list = Fcons (frame, Vframe_list);
4538 /* We need to do this after creating the window, so that the
4539 icon-creation functions can say whose icon they're describing. */
4540 x_default_parameter (f, parameters, Qicon_type, Qnil,
4541 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
4543 x_default_parameter (f, parameters, Qauto_raise, Qnil,
4544 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4545 x_default_parameter (f, parameters, Qauto_lower, Qnil,
4546 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4547 x_default_parameter (f, parameters, Qcursor_type, Qbox,
4548 "cursorType", "CursorType", RES_TYPE_SYMBOL);
4549 x_default_parameter (f, parameters, Qscroll_bar_width, Qnil,
4550 "scrollBarWidth", "ScrollBarWidth", RES_TYPE_NUMBER);
4551 x_default_parameter (f, parameters, Qalpha, Qnil,
4552 "alpha", "Alpha", RES_TYPE_NUMBER);
4554 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
4555 Change will not be effected unless different from the current
4556 FRAME_LINES (f). */
4557 width = FRAME_COLS (f);
4558 height = FRAME_LINES (f);
4560 FRAME_LINES (f) = 0;
4561 SET_FRAME_COLS (f, 0);
4562 change_frame_size (f, height, width, 1, 0, 0);
4564 /* Tell the server what size and position, etc, we want, and how
4565 badly we want them. This should be done after we have the menu
4566 bar so that its size can be taken into account. */
4567 block_input ();
4568 x_wm_set_size_hint (f, window_prompting, 0);
4569 unblock_input ();
4571 /* Make the window appear on the frame and enable display, unless
4572 the caller says not to. However, with explicit parent, Emacs
4573 cannot control visibility, so don't try. */
4574 if (! f->output_data.w32->explicit_parent)
4576 Lisp_Object visibility;
4578 visibility = x_get_arg (dpyinfo, parameters, Qvisibility, 0, 0, RES_TYPE_SYMBOL);
4579 if (EQ (visibility, Qunbound))
4580 visibility = Qt;
4582 if (EQ (visibility, Qicon))
4583 x_iconify_frame (f);
4584 else if (! NILP (visibility))
4585 x_make_frame_visible (f);
4586 else
4587 /* Must have been Qnil. */
4591 /* Initialize `default-minibuffer-frame' in case this is the first
4592 frame on this terminal. */
4593 if (FRAME_HAS_MINIBUF_P (f)
4594 && (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
4595 || !FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame)))))
4596 kset_default_minibuffer_frame (kb, frame);
4598 /* All remaining specified parameters, which have not been "used"
4599 by x_get_arg and friends, now go in the misc. alist of the frame. */
4600 for (tem = parameters; CONSP (tem); tem = XCDR (tem))
4601 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
4602 fset_param_alist (f, Fcons (XCAR (tem), f->param_alist));
4604 UNGCPRO;
4606 /* Make sure windows on this frame appear in calls to next-window
4607 and similar functions. */
4608 Vwindow_list = Qnil;
4610 return unbind_to (count, frame);
4613 /* FRAME is used only to get a handle on the X display. We don't pass the
4614 display info directly because we're called from frame.c, which doesn't
4615 know about that structure. */
4616 Lisp_Object
4617 x_get_focus_frame (struct frame *frame)
4619 struct w32_display_info *dpyinfo = FRAME_W32_DISPLAY_INFO (frame);
4620 Lisp_Object xfocus;
4621 if (! dpyinfo->w32_focus_frame)
4622 return Qnil;
4624 XSETFRAME (xfocus, dpyinfo->w32_focus_frame);
4625 return xfocus;
4628 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
4629 doc: /* Give FRAME input focus, raising to foreground if necessary. */)
4630 (Lisp_Object frame)
4632 x_focus_on_frame (decode_window_system_frame (frame));
4633 return Qnil;
4637 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
4638 doc: /* Internal function called by `color-defined-p', which see.
4639 \(Note that the Nextstep version of this function ignores FRAME.) */)
4640 (Lisp_Object color, Lisp_Object frame)
4642 XColor foo;
4643 struct frame *f = decode_window_system_frame (frame);
4645 CHECK_STRING (color);
4647 if (w32_defined_color (f, SDATA (color), &foo, 0))
4648 return Qt;
4649 else
4650 return Qnil;
4653 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
4654 doc: /* Internal function called by `color-values', which see. */)
4655 (Lisp_Object color, Lisp_Object frame)
4657 XColor foo;
4658 struct frame *f = decode_window_system_frame (frame);
4660 CHECK_STRING (color);
4662 if (w32_defined_color (f, SDATA (color), &foo, 0))
4663 return list3i ((GetRValue (foo.pixel) << 8) | GetRValue (foo.pixel),
4664 (GetGValue (foo.pixel) << 8) | GetGValue (foo.pixel),
4665 (GetBValue (foo.pixel) << 8) | GetBValue (foo.pixel));
4666 else
4667 return Qnil;
4670 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
4671 doc: /* Internal function called by `display-color-p', which see. */)
4672 (Lisp_Object display)
4674 struct w32_display_info *dpyinfo = check_x_display_info (display);
4676 if ((dpyinfo->n_planes * dpyinfo->n_cbits) <= 2)
4677 return Qnil;
4679 return Qt;
4682 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p,
4683 Sx_display_grayscale_p, 0, 1, 0,
4684 doc: /* Return t if DISPLAY supports shades of gray.
4685 Note that color displays do support shades of gray.
4686 The optional argument DISPLAY specifies which display to ask about.
4687 DISPLAY should be either a frame or a display name (a string).
4688 If omitted or nil, that stands for the selected frame's display. */)
4689 (Lisp_Object display)
4691 struct w32_display_info *dpyinfo = check_x_display_info (display);
4693 if ((dpyinfo->n_planes * dpyinfo->n_cbits) <= 1)
4694 return Qnil;
4696 return Qt;
4699 DEFUN ("x-display-pixel-width", Fx_display_pixel_width,
4700 Sx_display_pixel_width, 0, 1, 0,
4701 doc: /* Return the width in pixels of DISPLAY.
4702 The optional argument DISPLAY specifies which display to ask about.
4703 DISPLAY should be either a frame or a display name (a string).
4704 If omitted or nil, that stands for the selected frame's display.
4706 On \"multi-monitor\" setups this refers to the pixel width for all
4707 physical monitors associated with DISPLAY. To get information for
4708 each physical monitor, use `display-monitor-attributes-list'. */)
4709 (Lisp_Object display)
4711 struct w32_display_info *dpyinfo = check_x_display_info (display);
4713 return make_number (x_display_pixel_width (dpyinfo));
4716 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
4717 Sx_display_pixel_height, 0, 1, 0,
4718 doc: /* Return the height in pixels of DISPLAY.
4719 The optional argument DISPLAY specifies which display to ask about.
4720 DISPLAY should be either a frame or a display name (a string).
4721 If omitted or nil, that stands for the selected frame's display.
4723 On \"multi-monitor\" setups this refers to the pixel height for all
4724 physical monitors associated with DISPLAY. To get information for
4725 each physical monitor, use `display-monitor-attributes-list'. */)
4726 (Lisp_Object display)
4728 struct w32_display_info *dpyinfo = check_x_display_info (display);
4730 return make_number (x_display_pixel_height (dpyinfo));
4733 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
4734 0, 1, 0,
4735 doc: /* Return the number of bitplanes of DISPLAY.
4736 The optional argument DISPLAY specifies which display to ask about.
4737 DISPLAY should be either a frame or a display name (a string).
4738 If omitted or nil, that stands for the selected frame's display. */)
4739 (Lisp_Object display)
4741 struct w32_display_info *dpyinfo = check_x_display_info (display);
4743 return make_number (dpyinfo->n_planes * dpyinfo->n_cbits);
4746 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
4747 0, 1, 0,
4748 doc: /* Return the number of color cells of DISPLAY.
4749 The optional argument DISPLAY specifies which display to ask about.
4750 DISPLAY should be either a frame or a display name (a string).
4751 If omitted or nil, that stands for the selected frame's display. */)
4752 (Lisp_Object display)
4754 struct w32_display_info *dpyinfo = check_x_display_info (display);
4755 int cap;
4757 /* Don't use NCOLORS: it returns incorrect results under remote
4758 * desktop. We force 24+ bit depths to 24-bit, both to prevent an
4759 * overflow and because probably is more meaningful on Windows
4760 * anyway. */
4762 cap = 1 << min (dpyinfo->n_planes * dpyinfo->n_cbits, 24);
4763 return make_number (cap);
4766 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
4767 Sx_server_max_request_size,
4768 0, 1, 0,
4769 doc: /* Return the maximum request size of the server of DISPLAY.
4770 The optional argument DISPLAY specifies which display to ask about.
4771 DISPLAY should be either a frame or a display name (a string).
4772 If omitted or nil, that stands for the selected frame's display. */)
4773 (Lisp_Object display)
4775 return make_number (1);
4778 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
4779 doc: /* Return the "vendor ID" string of the W32 system (Microsoft).
4780 The optional argument DISPLAY specifies which display to ask about.
4781 DISPLAY should be either a frame or a display name (a string).
4782 If omitted or nil, that stands for the selected frame's display. */)
4783 (Lisp_Object display)
4785 return build_string ("Microsoft Corp.");
4788 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
4789 doc: /* Return the version numbers of the server of DISPLAY.
4790 The value is a list of three integers: the major and minor
4791 version numbers of the X Protocol in use, and the distributor-specific
4792 release number. See also the function `x-server-vendor'.
4794 The optional argument DISPLAY specifies which display to ask about.
4795 DISPLAY should be either a frame or a display name (a string).
4796 If omitted or nil, that stands for the selected frame's display. */)
4797 (Lisp_Object display)
4799 return list3i (w32_major_version, w32_minor_version, w32_build_number);
4802 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
4803 doc: /* Return the number of screens on the server of DISPLAY.
4804 The optional argument DISPLAY specifies which display to ask about.
4805 DISPLAY should be either a frame or a display name (a string).
4806 If omitted or nil, that stands for the selected frame's display. */)
4807 (Lisp_Object display)
4809 return make_number (1);
4812 DEFUN ("x-display-mm-height", Fx_display_mm_height,
4813 Sx_display_mm_height, 0, 1, 0,
4814 doc: /* Return the height in millimeters of DISPLAY.
4815 The optional argument DISPLAY specifies which display to ask about.
4816 DISPLAY should be either a frame or a display name (a string).
4817 If omitted or nil, that stands for the selected frame's display.
4819 On \"multi-monitor\" setups this refers to the height in millimeters for
4820 all physical monitors associated with DISPLAY. To get information
4821 for each physical monitor, use `display-monitor-attributes-list'. */)
4822 (Lisp_Object display)
4824 struct w32_display_info *dpyinfo = check_x_display_info (display);
4825 HDC hdc;
4826 double mm_per_pixel;
4828 hdc = GetDC (NULL);
4829 mm_per_pixel = ((double) GetDeviceCaps (hdc, VERTSIZE)
4830 / GetDeviceCaps (hdc, VERTRES));
4831 ReleaseDC (NULL, hdc);
4833 return make_number (x_display_pixel_height (dpyinfo) * mm_per_pixel + 0.5);
4836 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
4837 doc: /* Return the width in millimeters of DISPLAY.
4838 The optional argument DISPLAY specifies which display to ask about.
4839 DISPLAY should be either a frame or a display name (a string).
4840 If omitted or nil, that stands for the selected frame's display.
4842 On \"multi-monitor\" setups this refers to the width in millimeters for
4843 all physical monitors associated with TERMINAL. To get information
4844 for each physical monitor, use `display-monitor-attributes-list'. */)
4845 (Lisp_Object display)
4847 struct w32_display_info *dpyinfo = check_x_display_info (display);
4848 HDC hdc;
4849 double mm_per_pixel;
4851 hdc = GetDC (NULL);
4852 mm_per_pixel = ((double) GetDeviceCaps (hdc, HORZSIZE)
4853 / GetDeviceCaps (hdc, HORZRES));
4854 ReleaseDC (NULL, hdc);
4856 return make_number (x_display_pixel_width (dpyinfo) * mm_per_pixel + 0.5);
4859 DEFUN ("x-display-backing-store", Fx_display_backing_store,
4860 Sx_display_backing_store, 0, 1, 0,
4861 doc: /* Return an indication of whether DISPLAY does backing store.
4862 The value may be `always', `when-mapped', or `not-useful'.
4863 The optional argument DISPLAY specifies which display to ask about.
4864 DISPLAY should be either a frame or a display name (a string).
4865 If omitted or nil, that stands for the selected frame's display. */)
4866 (Lisp_Object display)
4868 return intern ("not-useful");
4871 DEFUN ("x-display-visual-class", Fx_display_visual_class,
4872 Sx_display_visual_class, 0, 1, 0,
4873 doc: /* Return the visual class of DISPLAY.
4874 The value is one of the symbols `static-gray', `gray-scale',
4875 `static-color', `pseudo-color', `true-color', or `direct-color'.
4877 The optional argument DISPLAY specifies which display to ask about.
4878 DISPLAY should be either a frame or a display name (a string).
4879 If omitted or nil, that stands for the selected frame's display. */)
4880 (Lisp_Object display)
4882 struct w32_display_info *dpyinfo = check_x_display_info (display);
4883 Lisp_Object result = Qnil;
4885 if (dpyinfo->has_palette)
4886 result = intern ("pseudo-color");
4887 else if (dpyinfo->n_planes * dpyinfo->n_cbits == 1)
4888 result = intern ("static-grey");
4889 else if (dpyinfo->n_planes * dpyinfo->n_cbits == 4)
4890 result = intern ("static-color");
4891 else if (dpyinfo->n_planes * dpyinfo->n_cbits > 8)
4892 result = intern ("true-color");
4894 return result;
4897 DEFUN ("x-display-save-under", Fx_display_save_under,
4898 Sx_display_save_under, 0, 1, 0,
4899 doc: /* Return t if DISPLAY supports the save-under feature.
4900 The optional argument DISPLAY specifies which display to ask about.
4901 DISPLAY should be either a frame or a display name (a string).
4902 If omitted or nil, that stands for the selected frame's display. */)
4903 (Lisp_Object display)
4905 return Qnil;
4908 static BOOL CALLBACK
4909 w32_monitor_enum (HMONITOR monitor, HDC hdc, RECT *rcMonitor, LPARAM dwData)
4911 Lisp_Object *monitor_list = (Lisp_Object *) dwData;
4913 *monitor_list = Fcons (make_save_ptr (monitor), *monitor_list);
4915 return TRUE;
4918 static Lisp_Object
4919 w32_display_monitor_attributes_list (void)
4921 Lisp_Object attributes_list = Qnil, primary_monitor_attributes = Qnil;
4922 Lisp_Object monitor_list = Qnil, monitor_frames, rest, frame;
4923 int i, n_monitors;
4924 HMONITOR *monitors;
4925 struct gcpro gcpro1, gcpro2, gcpro3;
4927 if (!(enum_display_monitors_fn && get_monitor_info_fn
4928 && monitor_from_window_fn))
4929 return Qnil;
4931 if (!enum_display_monitors_fn (NULL, NULL, w32_monitor_enum,
4932 (LPARAM) &monitor_list)
4933 || NILP (monitor_list))
4934 return Qnil;
4936 n_monitors = 0;
4937 for (rest = monitor_list; CONSP (rest); rest = XCDR (rest))
4938 n_monitors++;
4940 monitors = xmalloc (n_monitors * sizeof (*monitors));
4941 for (i = 0; i < n_monitors; i++)
4943 monitors[i] = XSAVE_POINTER (XCAR (monitor_list), 0);
4944 monitor_list = XCDR (monitor_list);
4947 monitor_frames = Fmake_vector (make_number (n_monitors), Qnil);
4948 FOR_EACH_FRAME (rest, frame)
4950 struct frame *f = XFRAME (frame);
4952 if (FRAME_W32_P (f) && !EQ (frame, tip_frame))
4954 HMONITOR monitor =
4955 monitor_from_window_fn (FRAME_W32_WINDOW (f),
4956 MONITOR_DEFAULT_TO_NEAREST);
4958 for (i = 0; i < n_monitors; i++)
4959 if (monitors[i] == monitor)
4960 break;
4962 if (i < n_monitors)
4963 ASET (monitor_frames, i, Fcons (frame, AREF (monitor_frames, i)));
4967 GCPRO3 (attributes_list, primary_monitor_attributes, monitor_frames);
4969 for (i = 0; i < n_monitors; i++)
4971 Lisp_Object geometry, workarea, name, attributes = Qnil;
4972 HDC hdc;
4973 int width_mm, height_mm;
4974 struct MONITOR_INFO_EX mi;
4976 mi.cbSize = sizeof (mi);
4977 if (!get_monitor_info_fn (monitors[i], (struct MONITOR_INFO *) &mi))
4978 continue;
4980 hdc = CreateDCA ("DISPLAY", mi.szDevice, NULL, NULL);
4981 if (hdc == NULL)
4982 continue;
4983 width_mm = GetDeviceCaps (hdc, HORZSIZE);
4984 height_mm = GetDeviceCaps (hdc, VERTSIZE);
4985 DeleteDC (hdc);
4987 attributes = Fcons (Fcons (Qframes, AREF (monitor_frames, i)),
4988 attributes);
4990 name = DECODE_SYSTEM (build_unibyte_string (mi.szDevice));
4992 attributes = Fcons (Fcons (Qname, name), attributes);
4994 attributes = Fcons (Fcons (Qmm_size, list2i (width_mm, height_mm)),
4995 attributes);
4997 workarea = list4i (mi.rcWork.left, mi.rcWork.top,
4998 mi.rcWork.right - mi.rcWork.left,
4999 mi.rcWork.bottom - mi.rcWork.top);
5000 attributes = Fcons (Fcons (Qworkarea, workarea), attributes);
5002 geometry = list4i (mi.rcMonitor.left, mi.rcMonitor.top,
5003 mi.rcMonitor.right - mi.rcMonitor.left,
5004 mi.rcMonitor.bottom - mi.rcMonitor.top);
5005 attributes = Fcons (Fcons (Qgeometry, geometry), attributes);
5007 if (mi.dwFlags & MONITORINFOF_PRIMARY)
5008 primary_monitor_attributes = attributes;
5009 else
5010 attributes_list = Fcons (attributes, attributes_list);
5013 if (!NILP (primary_monitor_attributes))
5014 attributes_list = Fcons (primary_monitor_attributes, attributes_list);
5016 UNGCPRO;
5018 xfree (monitors);
5020 return attributes_list;
5023 static Lisp_Object
5024 w32_display_monitor_attributes_list_fallback (struct w32_display_info *dpyinfo)
5026 Lisp_Object geometry, workarea, frames, rest, frame, attributes = Qnil;
5027 HDC hdc;
5028 double mm_per_pixel;
5029 int pixel_width, pixel_height, width_mm, height_mm;
5030 RECT workarea_rect;
5032 /* Fallback: treat (possibly) multiple physical monitors as if they
5033 formed a single monitor as a whole. This should provide a
5034 consistent result at least on single monitor environments. */
5035 attributes = Fcons (Fcons (Qname, build_string ("combined screen")),
5036 attributes);
5038 frames = Qnil;
5039 FOR_EACH_FRAME (rest, frame)
5041 struct frame *f = XFRAME (frame);
5043 if (FRAME_W32_P (f) && !EQ (frame, tip_frame))
5044 frames = Fcons (frame, frames);
5046 attributes = Fcons (Fcons (Qframes, frames), attributes);
5048 pixel_width = x_display_pixel_width (dpyinfo);
5049 pixel_height = x_display_pixel_height (dpyinfo);
5051 hdc = GetDC (NULL);
5052 mm_per_pixel = ((double) GetDeviceCaps (hdc, HORZSIZE)
5053 / GetDeviceCaps (hdc, HORZRES));
5054 width_mm = pixel_width * mm_per_pixel + 0.5;
5055 mm_per_pixel = ((double) GetDeviceCaps (hdc, VERTSIZE)
5056 / GetDeviceCaps (hdc, VERTRES));
5057 height_mm = pixel_height * mm_per_pixel + 0.5;
5058 ReleaseDC (NULL, hdc);
5059 attributes = Fcons (Fcons (Qmm_size, list2i (width_mm, height_mm)),
5060 attributes);
5062 /* GetSystemMetrics below may return 0 for Windows 95 or NT 4.0, but
5063 we don't care. */
5064 geometry = list4i (GetSystemMetrics (SM_XVIRTUALSCREEN),
5065 GetSystemMetrics (SM_YVIRTUALSCREEN),
5066 pixel_width, pixel_height);
5067 if (SystemParametersInfo (SPI_GETWORKAREA, 0, &workarea_rect, 0))
5068 workarea = list4i (workarea_rect.left, workarea_rect.top,
5069 workarea_rect.right - workarea_rect.left,
5070 workarea_rect.bottom - workarea_rect.top);
5071 else
5072 workarea = geometry;
5073 attributes = Fcons (Fcons (Qworkarea, workarea), attributes);
5075 attributes = Fcons (Fcons (Qgeometry, geometry), attributes);
5077 return list1 (attributes);
5080 DEFUN ("w32-display-monitor-attributes-list", Fw32_display_monitor_attributes_list,
5081 Sw32_display_monitor_attributes_list,
5082 0, 1, 0,
5083 doc: /* Return a list of physical monitor attributes on the W32 display DISPLAY.
5085 The optional argument DISPLAY specifies which display to ask about.
5086 DISPLAY should be either a frame or a display name (a string).
5087 If omitted or nil, that stands for the selected frame's display.
5089 Internal use only, use `display-monitor-attributes-list' instead. */)
5090 (Lisp_Object display)
5092 struct w32_display_info *dpyinfo = check_x_display_info (display);
5093 Lisp_Object attributes_list;
5095 block_input ();
5096 attributes_list = w32_display_monitor_attributes_list ();
5097 if (NILP (attributes_list))
5098 attributes_list = w32_display_monitor_attributes_list_fallback (dpyinfo);
5099 unblock_input ();
5101 return attributes_list;
5104 DEFUN ("set-message-beep", Fset_message_beep, Sset_message_beep, 1, 1, 0,
5105 doc: /* Set the sound generated when the bell is rung.
5106 SOUND is 'asterisk, 'exclamation, 'hand, 'question, 'ok, or 'silent
5107 to use the corresponding system sound for the bell. The 'silent sound
5108 prevents Emacs from making any sound at all.
5109 SOUND is nil to use the normal beep. */)
5110 (Lisp_Object sound)
5112 CHECK_SYMBOL (sound);
5114 if (NILP (sound))
5115 sound_type = 0xFFFFFFFF;
5116 else if (EQ (sound, intern ("asterisk")))
5117 sound_type = MB_ICONASTERISK;
5118 else if (EQ (sound, intern ("exclamation")))
5119 sound_type = MB_ICONEXCLAMATION;
5120 else if (EQ (sound, intern ("hand")))
5121 sound_type = MB_ICONHAND;
5122 else if (EQ (sound, intern ("question")))
5123 sound_type = MB_ICONQUESTION;
5124 else if (EQ (sound, intern ("ok")))
5125 sound_type = MB_OK;
5126 else if (EQ (sound, intern ("silent")))
5127 sound_type = MB_EMACS_SILENT;
5128 else
5129 sound_type = 0xFFFFFFFF;
5131 return sound;
5135 x_screen_planes (register struct frame *f)
5137 return FRAME_W32_DISPLAY_INFO (f)->n_planes;
5140 /* Return the display structure for the display named NAME.
5141 Open a new connection if necessary. */
5143 struct w32_display_info *
5144 x_display_info_for_name (Lisp_Object name)
5146 Lisp_Object names;
5147 struct w32_display_info *dpyinfo;
5149 CHECK_STRING (name);
5151 for (dpyinfo = &one_w32_display_info, names = w32_display_name_list;
5152 dpyinfo && !NILP (w32_display_name_list);
5153 dpyinfo = dpyinfo->next, names = XCDR (names))
5155 Lisp_Object tem;
5156 tem = Fstring_equal (XCAR (XCAR (names)), name);
5157 if (!NILP (tem))
5158 return dpyinfo;
5161 /* Use this general default value to start with. */
5162 Vx_resource_name = Vinvocation_name;
5164 validate_x_resource_name ();
5166 dpyinfo = w32_term_init (name, (unsigned char *)0,
5167 SSDATA (Vx_resource_name));
5169 if (dpyinfo == 0)
5170 error ("Cannot connect to server %s", SDATA (name));
5172 XSETFASTINT (Vwindow_system_version, w32_major_version);
5174 return dpyinfo;
5177 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
5178 1, 3, 0, doc: /* Open a connection to a display server.
5179 DISPLAY is the name of the display to connect to.
5180 Optional second arg XRM-STRING is a string of resources in xrdb format.
5181 If the optional third arg MUST-SUCCEED is non-nil,
5182 terminate Emacs if we can't open the connection.
5183 \(In the Nextstep version, the last two arguments are currently ignored.) */)
5184 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
5186 unsigned char *xrm_option;
5187 struct w32_display_info *dpyinfo;
5189 CHECK_STRING (display);
5191 /* Signal an error in order to encourage correct use from callers.
5192 * If we ever support multiple window systems in the same Emacs,
5193 * we'll need callers to be precise about what window system they
5194 * want. */
5196 if (strcmp (SSDATA (display), "w32") != 0)
5197 error ("The name of the display in this Emacs must be \"w32\"");
5199 /* If initialization has already been done, return now to avoid
5200 overwriting critical parts of one_w32_display_info. */
5201 if (window_system_available (NULL))
5202 return Qnil;
5204 if (! NILP (xrm_string))
5205 CHECK_STRING (xrm_string);
5207 #if 0
5208 if (! EQ (Vwindow_system, intern ("w32")))
5209 error ("Not using Microsoft Windows");
5210 #endif
5212 /* Allow color mapping to be defined externally; first look in user's
5213 HOME directory, then in Emacs etc dir for a file called rgb.txt. */
5215 Lisp_Object color_file;
5216 struct gcpro gcpro1;
5218 color_file = build_string ("~/rgb.txt");
5220 GCPRO1 (color_file);
5222 if (NILP (Ffile_readable_p (color_file)))
5223 color_file =
5224 Fexpand_file_name (build_string ("rgb.txt"),
5225 Fsymbol_value (intern ("data-directory")));
5227 Vw32_color_map = Fx_load_color_file (color_file);
5229 UNGCPRO;
5231 if (NILP (Vw32_color_map))
5232 Vw32_color_map = w32_default_color_map ();
5234 /* Merge in system logical colors. */
5235 add_system_logical_colors_to_map (&Vw32_color_map);
5237 if (! NILP (xrm_string))
5238 xrm_option = SDATA (xrm_string);
5239 else
5240 xrm_option = (unsigned char *) 0;
5242 /* Use this general default value to start with. */
5243 /* First remove .exe suffix from invocation-name - it looks ugly. */
5245 char basename[ MAX_PATH ], *str;
5247 strcpy (basename, SDATA (Vinvocation_name));
5248 str = strrchr (basename, '.');
5249 if (str) *str = 0;
5250 Vinvocation_name = build_string (basename);
5252 Vx_resource_name = Vinvocation_name;
5254 validate_x_resource_name ();
5256 /* This is what opens the connection and sets x_current_display.
5257 This also initializes many symbols, such as those used for input. */
5258 dpyinfo = w32_term_init (display, xrm_option,
5259 SSDATA (Vx_resource_name));
5261 if (dpyinfo == 0)
5263 if (!NILP (must_succeed))
5264 fatal ("Cannot connect to server %s.\n",
5265 SDATA (display));
5266 else
5267 error ("Cannot connect to server %s", SDATA (display));
5270 XSETFASTINT (Vwindow_system_version, w32_major_version);
5271 return Qnil;
5274 DEFUN ("x-close-connection", Fx_close_connection,
5275 Sx_close_connection, 1, 1, 0,
5276 doc: /* Close the connection to DISPLAY's server.
5277 For DISPLAY, specify either a frame or a display name (a string).
5278 If DISPLAY is nil, that stands for the selected frame's display. */)
5279 (Lisp_Object display)
5281 struct w32_display_info *dpyinfo = check_x_display_info (display);
5283 if (dpyinfo->reference_count > 0)
5284 error ("Display still has frames on it");
5286 block_input ();
5287 x_destroy_all_bitmaps (dpyinfo);
5289 x_delete_display (dpyinfo);
5290 unblock_input ();
5292 return Qnil;
5295 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
5296 doc: /* Return the list of display names that Emacs has connections to. */)
5297 (void)
5299 Lisp_Object tail, result;
5301 result = Qnil;
5302 for (tail = w32_display_name_list; CONSP (tail); tail = XCDR (tail))
5303 result = Fcons (XCAR (XCAR (tail)), result);
5305 return result;
5308 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
5309 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
5310 This function only has an effect on X Windows. With MS Windows, it is
5311 defined but does nothing.
5313 If ON is nil, allow buffering of requests.
5314 Turning on synchronization prohibits the Xlib routines from buffering
5315 requests and seriously degrades performance, but makes debugging much
5316 easier.
5317 The optional second argument TERMINAL specifies which display to act on.
5318 TERMINAL should be a terminal object, a frame or a display name (a string).
5319 If TERMINAL is omitted or nil, that stands for the selected frame's display. */)
5320 (Lisp_Object on, Lisp_Object display)
5322 return Qnil;
5327 /***********************************************************************
5328 Window properties
5329 ***********************************************************************/
5331 #if 0 /* TODO : port window properties to W32 */
5333 DEFUN ("x-change-window-property", Fx_change_window_property,
5334 Sx_change_window_property, 2, 6, 0,
5335 doc: /* Change window property PROP to VALUE on the X window of FRAME.
5336 PROP must be a string. VALUE may be a string or a list of conses,
5337 numbers and/or strings. If an element in the list is a string, it is
5338 converted to an atom and the value of the Atom is used. If an element
5339 is a cons, it is converted to a 32 bit number where the car is the 16
5340 top bits and the cdr is the lower 16 bits.
5342 FRAME nil or omitted means use the selected frame.
5343 If TYPE is given and non-nil, it is the name of the type of VALUE.
5344 If TYPE is not given or nil, the type is STRING.
5345 FORMAT gives the size in bits of each element if VALUE is a list.
5346 It must be one of 8, 16 or 32.
5347 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
5348 If OUTER-P is non-nil, the property is changed for the outer X window of
5349 FRAME. Default is to change on the edit X window. */)
5350 (Lisp_Object prop, Lisp_Object value, Lisp_Object frame,
5351 Lisp_Object type, Lisp_Object format, Lisp_Object outer_p)
5353 struct frame *f = decode_window_system_frame (frame);
5354 Atom prop_atom;
5356 CHECK_STRING (prop);
5357 CHECK_STRING (value);
5359 block_input ();
5360 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5361 XChangeProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5362 prop_atom, XA_STRING, 8, PropModeReplace,
5363 SDATA (value), SCHARS (value));
5365 /* Make sure the property is set when we return. */
5366 XFlush (FRAME_W32_DISPLAY (f));
5367 unblock_input ();
5369 return value;
5373 DEFUN ("x-delete-window-property", Fx_delete_window_property,
5374 Sx_delete_window_property, 1, 2, 0,
5375 doc: /* Remove window property PROP from X window of FRAME.
5376 FRAME nil or omitted means use the selected frame. Value is PROP. */)
5377 (Lisp_Object prop, Lisp_Object frame)
5379 struct frame *f = decode_window_system_frame (frame);
5380 Atom prop_atom;
5382 CHECK_STRING (prop);
5383 block_input ();
5384 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5385 XDeleteProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f), prop_atom);
5387 /* Make sure the property is removed when we return. */
5388 XFlush (FRAME_W32_DISPLAY (f));
5389 unblock_input ();
5391 return prop;
5395 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
5396 1, 6, 0,
5397 doc: /* Value is the value of window property PROP on FRAME.
5398 If FRAME is nil or omitted, use the selected frame.
5400 On X Windows, the following optional arguments are also accepted:
5401 If TYPE is nil or omitted, get the property as a string.
5402 Otherwise TYPE is the name of the atom that denotes the type expected.
5403 If SOURCE is non-nil, get the property on that window instead of from
5404 FRAME. The number 0 denotes the root window.
5405 If DELETE-P is non-nil, delete the property after retrieving it.
5406 If VECTOR-RET-P is non-nil, don't return a string but a vector of values.
5408 On MS Windows, this function accepts but ignores those optional arguments.
5410 Value is nil if FRAME hasn't a property with name PROP or if PROP has
5411 no value of TYPE (always string in the MS Windows case). */)
5412 (Lisp_Object prop, Lisp_Object frame, Lisp_Object type,
5413 Lisp_Object source, Lisp_Object delete_p, Lisp_Object vector_ret_p)
5415 struct frame *f = decode_window_system_frame (frame);
5416 Atom prop_atom;
5417 int rc;
5418 Lisp_Object prop_value = Qnil;
5419 char *tmp_data = NULL;
5420 Atom actual_type;
5421 int actual_format;
5422 unsigned long actual_size, bytes_remaining;
5424 CHECK_STRING (prop);
5425 block_input ();
5426 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5427 rc = XGetWindowProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5428 prop_atom, 0, 0, False, XA_STRING,
5429 &actual_type, &actual_format, &actual_size,
5430 &bytes_remaining, (unsigned char **) &tmp_data);
5431 if (rc == Success)
5433 int size = bytes_remaining;
5435 XFree (tmp_data);
5436 tmp_data = NULL;
5438 rc = XGetWindowProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5439 prop_atom, 0, bytes_remaining,
5440 False, XA_STRING,
5441 &actual_type, &actual_format,
5442 &actual_size, &bytes_remaining,
5443 (unsigned char **) &tmp_data);
5444 if (rc == Success)
5445 prop_value = make_string (tmp_data, size);
5447 XFree (tmp_data);
5450 unblock_input ();
5452 return prop_value;
5454 return Qnil;
5457 #endif /* TODO */
5460 /***********************************************************************
5461 Busy cursor
5462 ***********************************************************************/
5464 void
5465 w32_note_current_window (void)
5467 struct frame * f = SELECTED_FRAME ();
5469 if (!FRAME_W32_P (f))
5470 return;
5472 hourglass_hwnd = FRAME_W32_WINDOW (f);
5475 void
5476 show_hourglass (struct atimer *timer)
5478 struct frame *f;
5480 hourglass_atimer = NULL;
5482 block_input ();
5483 f = x_window_to_frame (&one_w32_display_info,
5484 hourglass_hwnd);
5486 if (f)
5487 f->output_data.w32->hourglass_p = 0;
5488 else
5489 f = SELECTED_FRAME ();
5491 if (!FRAME_W32_P (f))
5492 return;
5494 w32_show_hourglass (f);
5495 unblock_input ();
5498 void
5499 hide_hourglass (void)
5501 block_input ();
5502 w32_hide_hourglass ();
5503 unblock_input ();
5507 /* Display an hourglass cursor. Set the hourglass_p flag in display info
5508 to indicate that an hourglass cursor is shown. */
5510 static void
5511 w32_show_hourglass (struct frame *f)
5513 if (!hourglass_shown_p)
5515 f->output_data.w32->hourglass_p = 1;
5516 if (!menubar_in_use && !current_popup_menu)
5517 SetCursor (f->output_data.w32->hourglass_cursor);
5518 hourglass_shown_p = 1;
5523 /* Hide the hourglass cursor on all frames, if it is currently shown. */
5525 static void
5526 w32_hide_hourglass (void)
5528 if (hourglass_shown_p)
5530 struct frame *f = x_window_to_frame (&one_w32_display_info,
5531 hourglass_hwnd);
5532 if (f)
5533 f->output_data.w32->hourglass_p = 0;
5534 else
5535 /* If frame was deleted, restore to selected frame's cursor. */
5536 f = SELECTED_FRAME ();
5538 if (FRAME_W32_P (f))
5539 SetCursor (f->output_data.w32->current_cursor);
5540 else
5541 /* No cursors on non GUI frames - restore to stock arrow cursor. */
5542 SetCursor (w32_load_cursor (IDC_ARROW));
5544 hourglass_shown_p = 0;
5550 /***********************************************************************
5551 Tool tips
5552 ***********************************************************************/
5554 static Lisp_Object x_create_tip_frame (struct w32_display_info *,
5555 Lisp_Object, Lisp_Object);
5556 static void compute_tip_xy (struct frame *, Lisp_Object, Lisp_Object,
5557 Lisp_Object, int, int, int *, int *);
5559 /* The frame of a currently visible tooltip. */
5561 Lisp_Object tip_frame;
5563 /* If non-nil, a timer started that hides the last tooltip when it
5564 fires. */
5566 Lisp_Object tip_timer;
5567 Window tip_window;
5569 /* If non-nil, a vector of 3 elements containing the last args
5570 with which x-show-tip was called. See there. */
5572 Lisp_Object last_show_tip_args;
5575 static void
5576 unwind_create_tip_frame (Lisp_Object frame)
5578 Lisp_Object deleted;
5580 deleted = unwind_create_frame (frame);
5581 if (EQ (deleted, Qt))
5583 tip_window = NULL;
5584 tip_frame = Qnil;
5589 /* Create a frame for a tooltip on the display described by DPYINFO.
5590 PARMS is a list of frame parameters. TEXT is the string to
5591 display in the tip frame. Value is the frame.
5593 Note that functions called here, esp. x_default_parameter can
5594 signal errors, for instance when a specified color name is
5595 undefined. We have to make sure that we're in a consistent state
5596 when this happens. */
5598 static Lisp_Object
5599 x_create_tip_frame (struct w32_display_info *dpyinfo,
5600 Lisp_Object parms, Lisp_Object text)
5602 struct frame *f;
5603 Lisp_Object frame;
5604 Lisp_Object name;
5605 long window_prompting = 0;
5606 int width, height;
5607 ptrdiff_t count = SPECPDL_INDEX ();
5608 struct gcpro gcpro1, gcpro2, gcpro3;
5609 struct kboard *kb;
5610 int face_change_count_before = face_change_count;
5611 Lisp_Object buffer;
5612 struct buffer *old_buffer;
5614 /* Use this general default value to start with until we know if
5615 this frame has a specified name. */
5616 Vx_resource_name = Vinvocation_name;
5618 kb = dpyinfo->terminal->kboard;
5620 /* The calls to x_get_arg remove elements from PARMS, so copy it to
5621 avoid destructive changes behind our caller's back. */
5622 parms = Fcopy_alist (parms);
5624 /* Get the name of the frame to use for resource lookup. */
5625 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
5626 if (!STRINGP (name)
5627 && !EQ (name, Qunbound)
5628 && !NILP (name))
5629 error ("Invalid frame name--not a string or nil");
5630 Vx_resource_name = name;
5632 frame = Qnil;
5633 GCPRO3 (parms, name, frame);
5634 /* Make a frame without minibuffer nor mode-line. */
5635 f = make_frame (0);
5636 f->wants_modeline = 0;
5637 XSETFRAME (frame, f);
5639 buffer = Fget_buffer_create (build_string (" *tip*"));
5640 /* Use set_window_buffer instead of Fset_window_buffer (see
5641 discussion of bug#11984, bug#12025, bug#12026). */
5642 set_window_buffer (FRAME_ROOT_WINDOW (f), buffer, 0, 0);
5643 old_buffer = current_buffer;
5644 set_buffer_internal_1 (XBUFFER (buffer));
5645 bset_truncate_lines (current_buffer, Qnil);
5646 specbind (Qinhibit_read_only, Qt);
5647 specbind (Qinhibit_modification_hooks, Qt);
5648 Ferase_buffer ();
5649 Finsert (1, &text);
5650 set_buffer_internal_1 (old_buffer);
5652 record_unwind_protect (unwind_create_tip_frame, frame);
5654 /* By setting the output method, we're essentially saying that
5655 the frame is live, as per FRAME_LIVE_P. If we get a signal
5656 from this point on, x_destroy_window might screw up reference
5657 counts etc. */
5658 f->terminal = dpyinfo->terminal;
5659 f->output_method = output_w32;
5660 f->output_data.w32 = xzalloc (sizeof (struct w32_output));
5662 FRAME_FONTSET (f) = -1;
5663 fset_icon_name (f, Qnil);
5665 #ifdef GLYPH_DEBUG
5666 image_cache_refcount =
5667 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
5668 dpyinfo_refcount = dpyinfo->reference_count;
5669 #endif /* GLYPH_DEBUG */
5670 FRAME_KBOARD (f) = kb;
5671 f->output_data.w32->parent_desc = FRAME_W32_DISPLAY_INFO (f)->root_window;
5672 f->output_data.w32->explicit_parent = 0;
5674 /* Set the name; the functions to which we pass f expect the name to
5675 be set. */
5676 if (EQ (name, Qunbound) || NILP (name))
5678 fset_name (f, build_string (dpyinfo->w32_id_name));
5679 f->explicit_name = 0;
5681 else
5683 fset_name (f, name);
5684 f->explicit_name = 1;
5685 /* use the frame's title when getting resources for this frame. */
5686 specbind (Qx_resource_name, name);
5689 if (uniscribe_available)
5690 register_font_driver (&uniscribe_font_driver, f);
5691 register_font_driver (&w32font_driver, f);
5693 x_default_parameter (f, parms, Qfont_backend, Qnil,
5694 "fontBackend", "FontBackend", RES_TYPE_STRING);
5696 /* Extract the window parameters from the supplied values
5697 that are needed to determine window geometry. */
5698 x_default_font_parameter (f, parms);
5700 x_default_parameter (f, parms, Qborder_width, make_number (2),
5701 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
5702 /* This defaults to 2 in order to match xterm. We recognize either
5703 internalBorderWidth or internalBorder (which is what xterm calls
5704 it). */
5705 if (NILP (Fassq (Qinternal_border_width, parms)))
5707 Lisp_Object value;
5709 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
5710 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
5711 if (! EQ (value, Qunbound))
5712 parms = Fcons (Fcons (Qinternal_border_width, value),
5713 parms);
5715 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
5716 "internalBorderWidth", "internalBorderWidth",
5717 RES_TYPE_NUMBER);
5719 /* Also do the stuff which must be set before the window exists. */
5720 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
5721 "foreground", "Foreground", RES_TYPE_STRING);
5722 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
5723 "background", "Background", RES_TYPE_STRING);
5724 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
5725 "pointerColor", "Foreground", RES_TYPE_STRING);
5726 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
5727 "cursorColor", "Foreground", RES_TYPE_STRING);
5728 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
5729 "borderColor", "BorderColor", RES_TYPE_STRING);
5731 /* Init faces before x_default_parameter is called for scroll-bar
5732 parameters because that function calls x_set_scroll_bar_width,
5733 which calls change_frame_size, which calls Fset_window_buffer,
5734 which runs hooks, which call Fvertical_motion. At the end, we
5735 end up in init_iterator with a null face cache, which should not
5736 happen. */
5737 init_frame_faces (f);
5739 f->output_data.w32->dwStyle = WS_BORDER | WS_POPUP | WS_DISABLED;
5740 f->output_data.w32->parent_desc = FRAME_W32_DISPLAY_INFO (f)->root_window;
5742 window_prompting = x_figure_window_size (f, parms, 0);
5744 /* No fringes on tip frame. */
5745 f->fringe_cols = 0;
5746 f->left_fringe_width = 0;
5747 f->right_fringe_width = 0;
5749 block_input ();
5750 my_create_tip_window (f);
5751 unblock_input ();
5753 x_make_gc (f);
5755 x_default_parameter (f, parms, Qauto_raise, Qnil,
5756 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5757 x_default_parameter (f, parms, Qauto_lower, Qnil,
5758 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5759 x_default_parameter (f, parms, Qcursor_type, Qbox,
5760 "cursorType", "CursorType", RES_TYPE_SYMBOL);
5762 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
5763 Change will not be effected unless different from the current
5764 FRAME_LINES (f). */
5765 width = FRAME_COLS (f);
5766 height = FRAME_LINES (f);
5767 FRAME_LINES (f) = 0;
5768 SET_FRAME_COLS (f, 0);
5769 change_frame_size (f, height, width, 1, 0, 0);
5771 /* Add `tooltip' frame parameter's default value. */
5772 if (NILP (Fframe_parameter (frame, Qtooltip)))
5773 Fmodify_frame_parameters (frame, Fcons (Fcons (Qtooltip, Qt), Qnil));
5775 /* Set up faces after all frame parameters are known. This call
5776 also merges in face attributes specified for new frames.
5778 Frame parameters may be changed if .Xdefaults contains
5779 specifications for the default font. For example, if there is an
5780 `Emacs.default.attributeBackground: pink', the `background-color'
5781 attribute of the frame get's set, which let's the internal border
5782 of the tooltip frame appear in pink. Prevent this. */
5784 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
5785 Lisp_Object fg = Fframe_parameter (frame, Qforeground_color);
5786 Lisp_Object colors = Qnil;
5788 /* Set tip_frame here, so that */
5789 tip_frame = frame;
5790 call2 (Qface_set_after_frame_default, frame, Qnil);
5792 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
5793 colors = Fcons (Fcons (Qbackground_color, bg), colors);
5794 if (!EQ (fg, Fframe_parameter (frame, Qforeground_color)))
5795 colors = Fcons (Fcons (Qforeground_color, fg), colors);
5797 if (!NILP (colors))
5798 Fmodify_frame_parameters (frame, colors);
5801 f->no_split = 1;
5803 UNGCPRO;
5805 /* Now that the frame is official, it counts as a reference to
5806 its display. */
5807 FRAME_W32_DISPLAY_INFO (f)->reference_count++;
5808 f->terminal->reference_count++;
5810 /* It is now ok to make the frame official even if we get an error
5811 below. And the frame needs to be on Vframe_list or making it
5812 visible won't work. */
5813 Vframe_list = Fcons (frame, Vframe_list);
5815 /* Setting attributes of faces of the tooltip frame from resources
5816 and similar will increment face_change_count, which leads to the
5817 clearing of all current matrices. Since this isn't necessary
5818 here, avoid it by resetting face_change_count to the value it
5819 had before we created the tip frame. */
5820 face_change_count = face_change_count_before;
5822 /* Discard the unwind_protect. */
5823 return unbind_to (count, frame);
5827 /* Compute where to display tip frame F. PARMS is the list of frame
5828 parameters for F. DX and DY are specified offsets from the current
5829 location of the mouse. WIDTH and HEIGHT are the width and height
5830 of the tooltip. Return coordinates relative to the root window of
5831 the display in *ROOT_X, and *ROOT_Y. */
5833 static void
5834 compute_tip_xy (struct frame *f,
5835 Lisp_Object parms, Lisp_Object dx, Lisp_Object dy,
5836 int width, int height, int *root_x, int *root_y)
5838 Lisp_Object left, top;
5839 int min_x, min_y, max_x, max_y;
5841 /* User-specified position? */
5842 left = Fcdr (Fassq (Qleft, parms));
5843 top = Fcdr (Fassq (Qtop, parms));
5845 /* Move the tooltip window where the mouse pointer is. Resize and
5846 show it. */
5847 if (!INTEGERP (left) || !INTEGERP (top))
5849 POINT pt;
5851 /* Default min and max values. */
5852 min_x = 0;
5853 min_y = 0;
5854 max_x = x_display_pixel_width (FRAME_W32_DISPLAY_INFO (f));
5855 max_y = x_display_pixel_height (FRAME_W32_DISPLAY_INFO (f));
5857 block_input ();
5858 GetCursorPos (&pt);
5859 *root_x = pt.x;
5860 *root_y = pt.y;
5861 unblock_input ();
5863 /* If multiple monitor support is available, constrain the tip onto
5864 the current monitor. This improves the above by allowing negative
5865 co-ordinates if monitor positions are such that they are valid, and
5866 snaps a tooltip onto a single monitor if we are close to the edge
5867 where it would otherwise flow onto the other monitor (or into
5868 nothingness if there is a gap in the overlap). */
5869 if (monitor_from_point_fn && get_monitor_info_fn)
5871 struct MONITOR_INFO info;
5872 HMONITOR monitor
5873 = monitor_from_point_fn (pt, MONITOR_DEFAULT_TO_NEAREST);
5874 info.cbSize = sizeof (info);
5876 if (get_monitor_info_fn (monitor, &info))
5878 min_x = info.rcWork.left;
5879 min_y = info.rcWork.top;
5880 max_x = info.rcWork.right;
5881 max_y = info.rcWork.bottom;
5886 if (INTEGERP (top))
5887 *root_y = XINT (top);
5888 else if (*root_y + XINT (dy) <= min_y)
5889 *root_y = min_y; /* Can happen for negative dy */
5890 else if (*root_y + XINT (dy) + height <= max_y)
5891 /* It fits below the pointer */
5892 *root_y += XINT (dy);
5893 else if (height + XINT (dy) + min_y <= *root_y)
5894 /* It fits above the pointer. */
5895 *root_y -= height + XINT (dy);
5896 else
5897 /* Put it on the top. */
5898 *root_y = min_y;
5900 if (INTEGERP (left))
5901 *root_x = XINT (left);
5902 else if (*root_x + XINT (dx) <= min_x)
5903 *root_x = 0; /* Can happen for negative dx */
5904 else if (*root_x + XINT (dx) + width <= max_x)
5905 /* It fits to the right of the pointer. */
5906 *root_x += XINT (dx);
5907 else if (width + XINT (dx) + min_x <= *root_x)
5908 /* It fits to the left of the pointer. */
5909 *root_x -= width + XINT (dx);
5910 else
5911 /* Put it left justified on the screen -- it ought to fit that way. */
5912 *root_x = min_x;
5916 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
5917 doc: /* Show STRING in a \"tooltip\" window on frame FRAME.
5918 A tooltip window is a small window displaying a string.
5920 This is an internal function; Lisp code should call `tooltip-show'.
5922 FRAME nil or omitted means use the selected frame.
5924 PARMS is an optional list of frame parameters which can be
5925 used to change the tooltip's appearance.
5927 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
5928 means use the default timeout of 5 seconds.
5930 If the list of frame parameters PARMS contains a `left' parameter,
5931 the tooltip is displayed at that x-position. Otherwise it is
5932 displayed at the mouse position, with offset DX added (default is 5 if
5933 DX isn't specified). Likewise for the y-position; if a `top' frame
5934 parameter is specified, it determines the y-position of the tooltip
5935 window, otherwise it is displayed at the mouse position, with offset
5936 DY added (default is -10).
5938 A tooltip's maximum size is specified by `x-max-tooltip-size'.
5939 Text larger than the specified size is clipped. */)
5940 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
5942 struct frame *f;
5943 struct window *w;
5944 int root_x, root_y;
5945 struct buffer *old_buffer;
5946 struct text_pos pos;
5947 int i, width, height, seen_reversed_p;
5948 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
5949 int old_windows_or_buffers_changed = windows_or_buffers_changed;
5950 ptrdiff_t count = SPECPDL_INDEX ();
5952 specbind (Qinhibit_redisplay, Qt);
5954 GCPRO4 (string, parms, frame, timeout);
5956 CHECK_STRING (string);
5957 f = decode_window_system_frame (frame);
5958 if (NILP (timeout))
5959 timeout = make_number (5);
5960 else
5961 CHECK_NATNUM (timeout);
5963 if (NILP (dx))
5964 dx = make_number (5);
5965 else
5966 CHECK_NUMBER (dx);
5968 if (NILP (dy))
5969 dy = make_number (-10);
5970 else
5971 CHECK_NUMBER (dy);
5973 if (NILP (last_show_tip_args))
5974 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
5976 if (!NILP (tip_frame))
5978 Lisp_Object last_string = AREF (last_show_tip_args, 0);
5979 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
5980 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
5982 if (EQ (frame, last_frame)
5983 && !NILP (Fequal (last_string, string))
5984 && !NILP (Fequal (last_parms, parms)))
5986 struct frame *f = XFRAME (tip_frame);
5988 /* Only DX and DY have changed. */
5989 if (!NILP (tip_timer))
5991 Lisp_Object timer = tip_timer;
5992 tip_timer = Qnil;
5993 call1 (Qcancel_timer, timer);
5996 block_input ();
5997 compute_tip_xy (f, parms, dx, dy, FRAME_PIXEL_WIDTH (f),
5998 FRAME_PIXEL_HEIGHT (f), &root_x, &root_y);
6000 /* Put tooltip in topmost group and in position. */
6001 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOPMOST,
6002 root_x, root_y, 0, 0,
6003 SWP_NOSIZE | SWP_NOACTIVATE);
6005 /* Ensure tooltip is on top of other topmost windows (eg menus). */
6006 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOP,
6007 0, 0, 0, 0,
6008 SWP_NOMOVE | SWP_NOSIZE | SWP_NOACTIVATE);
6010 unblock_input ();
6011 goto start_timer;
6015 /* Hide a previous tip, if any. */
6016 Fx_hide_tip ();
6018 ASET (last_show_tip_args, 0, string);
6019 ASET (last_show_tip_args, 1, frame);
6020 ASET (last_show_tip_args, 2, parms);
6022 /* Add default values to frame parameters. */
6023 if (NILP (Fassq (Qname, parms)))
6024 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
6025 if (NILP (Fassq (Qinternal_border_width, parms)))
6026 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
6027 if (NILP (Fassq (Qborder_width, parms)))
6028 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
6029 if (NILP (Fassq (Qborder_color, parms)))
6030 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
6031 if (NILP (Fassq (Qbackground_color, parms)))
6032 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
6033 parms);
6035 /* Block input until the tip has been fully drawn, to avoid crashes
6036 when drawing tips in menus. */
6037 block_input ();
6039 /* Create a frame for the tooltip, and record it in the global
6040 variable tip_frame. */
6041 frame = x_create_tip_frame (FRAME_W32_DISPLAY_INFO (f), parms, string);
6042 f = XFRAME (frame);
6044 /* Set up the frame's root window. */
6045 w = XWINDOW (FRAME_ROOT_WINDOW (f));
6046 w->left_col = 0;
6047 w->top_line = 0;
6049 if (CONSP (Vx_max_tooltip_size)
6050 && INTEGERP (XCAR (Vx_max_tooltip_size))
6051 && XINT (XCAR (Vx_max_tooltip_size)) > 0
6052 && INTEGERP (XCDR (Vx_max_tooltip_size))
6053 && XINT (XCDR (Vx_max_tooltip_size)) > 0)
6055 w->total_cols = XFASTINT (XCAR (Vx_max_tooltip_size));
6056 w->total_lines = XFASTINT (XCDR (Vx_max_tooltip_size));
6058 else
6060 w->total_cols = 80;
6061 w->total_lines = 40;
6064 FRAME_TOTAL_COLS (f) = WINDOW_TOTAL_COLS (w);
6065 adjust_glyphs (f);
6066 w->pseudo_window_p = 1;
6068 /* Display the tooltip text in a temporary buffer. */
6069 old_buffer = current_buffer;
6070 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->contents));
6071 bset_truncate_lines (current_buffer, Qnil);
6072 clear_glyph_matrix (w->desired_matrix);
6073 clear_glyph_matrix (w->current_matrix);
6074 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
6075 try_window (FRAME_ROOT_WINDOW (f), pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
6077 /* Compute width and height of the tooltip. */
6078 width = height = seen_reversed_p = 0;
6079 for (i = 0; i < w->desired_matrix->nrows; ++i)
6081 struct glyph_row *row = &w->desired_matrix->rows[i];
6082 struct glyph *last;
6083 int row_width;
6085 /* Stop at the first empty row at the end. */
6086 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
6087 break;
6089 /* Let the row go over the full width of the frame. */
6090 row->full_width_p = 1;
6092 row_width = row->pixel_width;
6093 if (row->used[TEXT_AREA])
6095 if (!row->reversed_p)
6097 /* There's a glyph at the end of rows that is used to
6098 place the cursor there. Don't include the width of
6099 this glyph. */
6100 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
6101 if (INTEGERP (last->object))
6102 row_width -= last->pixel_width;
6104 else
6106 /* There could be a stretch glyph at the beginning of R2L
6107 rows that is produced by extend_face_to_end_of_line.
6108 Don't count that glyph. */
6109 struct glyph *g = row->glyphs[TEXT_AREA];
6111 if (g->type == STRETCH_GLYPH && INTEGERP (g->object))
6113 row_width -= g->pixel_width;
6114 seen_reversed_p = 1;
6119 height += row->height;
6120 width = max (width, row_width);
6123 /* If we've seen partial-length R2L rows, we need to re-adjust the
6124 tool-tip frame width and redisplay it again, to avoid over-wide
6125 tips due to the stretch glyph that extends R2L lines to full
6126 width of the frame. */
6127 if (seen_reversed_p)
6129 /* w->total_cols and FRAME_TOTAL_COLS want the width in columns,
6130 not in pixels. */
6131 width /= WINDOW_FRAME_COLUMN_WIDTH (w);
6132 w->total_cols = width;
6133 FRAME_TOTAL_COLS (f) = width;
6134 adjust_glyphs (f);
6135 w->pseudo_window_p = 1;
6136 clear_glyph_matrix (w->desired_matrix);
6137 clear_glyph_matrix (w->current_matrix);
6138 try_window (FRAME_ROOT_WINDOW (f), pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
6139 width = height = 0;
6140 /* Recompute width and height of the tooltip. */
6141 for (i = 0; i < w->desired_matrix->nrows; ++i)
6143 struct glyph_row *row = &w->desired_matrix->rows[i];
6144 struct glyph *last;
6145 int row_width;
6147 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
6148 break;
6149 row->full_width_p = 1;
6150 row_width = row->pixel_width;
6151 if (row->used[TEXT_AREA] && !row->reversed_p)
6153 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
6154 if (INTEGERP (last->object))
6155 row_width -= last->pixel_width;
6158 height += row->height;
6159 width = max (width, row_width);
6163 /* Round up the height to an integral multiple of FRAME_LINE_HEIGHT. */
6164 if (height % FRAME_LINE_HEIGHT (f) != 0)
6165 height += FRAME_LINE_HEIGHT (f) - height % FRAME_LINE_HEIGHT (f);
6166 /* Add the frame's internal border to the width and height the w32
6167 window should have. */
6168 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
6169 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
6171 /* Move the tooltip window where the mouse pointer is. Resize and
6172 show it. */
6173 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
6176 /* Adjust Window size to take border into account. */
6177 RECT rect;
6178 rect.left = rect.top = 0;
6179 rect.right = width;
6180 rect.bottom = height;
6181 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
6182 FRAME_EXTERNAL_MENU_BAR (f));
6184 /* Position and size tooltip, and put it in the topmost group.
6185 The add-on of FRAME_COLUMN_WIDTH to the 5th argument is a
6186 peculiarity of w32 display: without it, some fonts cause the
6187 last character of the tip to be truncated or wrapped around to
6188 the next line. */
6189 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOPMOST,
6190 root_x, root_y,
6191 rect.right - rect.left + FRAME_COLUMN_WIDTH (f),
6192 rect.bottom - rect.top, SWP_NOACTIVATE);
6194 /* Ensure tooltip is on top of other topmost windows (eg menus). */
6195 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOP,
6196 0, 0, 0, 0,
6197 SWP_NOMOVE | SWP_NOSIZE | SWP_NOACTIVATE);
6199 /* Let redisplay know that we have made the frame visible already. */
6200 SET_FRAME_VISIBLE (f, 1);
6202 ShowWindow (FRAME_W32_WINDOW (f), SW_SHOWNOACTIVATE);
6205 /* Draw into the window. */
6206 w->must_be_updated_p = 1;
6207 update_single_window (w, 1);
6209 unblock_input ();
6211 /* Restore original current buffer. */
6212 set_buffer_internal_1 (old_buffer);
6213 windows_or_buffers_changed = old_windows_or_buffers_changed;
6215 start_timer:
6216 /* Let the tip disappear after timeout seconds. */
6217 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
6218 intern ("x-hide-tip"));
6220 UNGCPRO;
6221 return unbind_to (count, Qnil);
6225 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
6226 doc: /* Hide the current tooltip window, if there is any.
6227 Value is t if tooltip was open, nil otherwise. */)
6228 (void)
6230 ptrdiff_t count;
6231 Lisp_Object deleted, frame, timer;
6232 struct gcpro gcpro1, gcpro2;
6234 /* Return quickly if nothing to do. */
6235 if (NILP (tip_timer) && NILP (tip_frame))
6236 return Qnil;
6238 frame = tip_frame;
6239 timer = tip_timer;
6240 GCPRO2 (frame, timer);
6241 tip_frame = tip_timer = deleted = Qnil;
6243 count = SPECPDL_INDEX ();
6244 specbind (Qinhibit_redisplay, Qt);
6245 specbind (Qinhibit_quit, Qt);
6247 if (!NILP (timer))
6248 call1 (Qcancel_timer, timer);
6250 if (FRAMEP (frame))
6252 delete_frame (frame, Qnil);
6253 deleted = Qt;
6256 UNGCPRO;
6257 return unbind_to (count, deleted);
6260 /***********************************************************************
6261 File selection dialog
6262 ***********************************************************************/
6264 #define FILE_NAME_TEXT_FIELD edt1
6265 #define FILE_NAME_COMBO_BOX cmb13
6266 #define FILE_NAME_LIST lst1
6268 /* Callback for altering the behavior of the Open File dialog.
6269 Makes the Filename text field contain "Current Directory" and be
6270 read-only when "Directories" is selected in the filter. This
6271 allows us to work around the fact that the standard Open File
6272 dialog does not support directories. */
6273 static UINT_PTR CALLBACK
6274 file_dialog_callback (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
6276 if (msg == WM_NOTIFY)
6278 #ifdef NTGUI_UNICODE
6279 OFNOTIFYW * notify = (OFNOTIFYW *)lParam;
6280 #else /* !NTGUI_UNICODE */
6281 OFNOTIFYA * notify = (OFNOTIFYA *)lParam;
6282 #endif /* NTGUI_UNICODE */
6283 /* Detect when the Filter dropdown is changed. */
6284 if (notify->hdr.code == CDN_TYPECHANGE
6285 || notify->hdr.code == CDN_INITDONE)
6287 HWND dialog = GetParent (hwnd);
6288 HWND edit_control = GetDlgItem (dialog, FILE_NAME_TEXT_FIELD);
6289 HWND list = GetDlgItem (dialog, FILE_NAME_LIST);
6291 /* At least on Windows 7, the above attempt to get the window handle
6292 to the File Name Text Field fails. The following code does the
6293 job though. Note that this code is based on my examination of the
6294 window hierarchy using Microsoft Spy++. bk */
6295 if (edit_control == NULL)
6297 HWND tmp = GetDlgItem (dialog, FILE_NAME_COMBO_BOX);
6298 if (tmp)
6300 tmp = GetWindow (tmp, GW_CHILD);
6301 if (tmp)
6302 edit_control = GetWindow (tmp, GW_CHILD);
6306 /* Directories is in index 2. */
6307 if (notify->lpOFN->nFilterIndex == 2)
6309 CommDlg_OpenSave_SetControlText (dialog, FILE_NAME_TEXT_FIELD,
6310 GUISTR ("Current Directory"));
6311 EnableWindow (edit_control, FALSE);
6312 /* Note that at least on Windows 7, the above call to EnableWindow
6313 disables the window that would ordinarily have focus. If we
6314 do not set focus to some other window here, focus will land in
6315 no man's land and the user will be unable to tab through the
6316 dialog box (pressing tab will only result in a beep).
6317 Avoid that problem by setting focus to the list here. */
6318 if (notify->hdr.code == CDN_INITDONE)
6319 SetFocus (list);
6321 else
6323 /* Don't override default filename on init done. */
6324 if (notify->hdr.code == CDN_TYPECHANGE)
6325 CommDlg_OpenSave_SetControlText (dialog,
6326 FILE_NAME_TEXT_FIELD,
6327 GUISTR (""));
6328 EnableWindow (edit_control, TRUE);
6332 return 0;
6335 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
6336 doc: /* Read file name, prompting with PROMPT in directory DIR.
6337 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
6338 selection box, if specified. If MUSTMATCH is non-nil, the returned file
6339 or directory must exist.
6341 This function is only defined on NS, MS Windows, and X Windows with the
6342 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
6343 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
6344 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
6346 /* Filter index: 1: All Files, 2: Directories only */
6347 static const guichar_t filter[] =
6348 GUISTR ("All Files (*.*)\0*.*\0Directories\0*|*\0");
6350 Lisp_Object filename = default_filename;
6351 struct frame *f = SELECTED_FRAME ();
6352 BOOL file_opened = FALSE;
6353 Lisp_Object orig_dir = dir;
6354 Lisp_Object orig_prompt = prompt;
6356 /* If we compile with _WIN32_WINNT set to 0x0400 (for NT4
6357 compatibility) we end up with the old file dialogs. Define a big
6358 enough struct for the new dialog to trick GetOpenFileName into
6359 giving us the new dialogs on newer versions of Windows. */
6360 struct {
6361 #ifdef NTGUI_UNICODE
6362 OPENFILENAMEW details;
6363 #else /* !NTGUI_UNICODE */
6364 OPENFILENAMEA details;
6365 #endif /* NTGUI_UNICODE */
6367 #if _WIN32_WINNT < 0x500 /* < win2k */
6368 PVOID pvReserved;
6369 DWORD dwReserved;
6370 DWORD FlagsEx;
6371 #endif /* < win2k */
6372 } new_file_details;
6374 #ifdef NTGUI_UNICODE
6375 wchar_t filename_buf[32*1024 + 1]; // NT kernel maximum
6376 OPENFILENAMEW * file_details = &new_file_details.details;
6377 #else /* not NTGUI_UNICODE */
6378 char filename_buf[MAX_PATH + 1];
6379 OPENFILENAMEA * file_details = &new_file_details.details;
6380 #endif /* NTGUI_UNICODE */
6382 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
6383 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, filename);
6386 struct gcpro gcpro1, gcpro2;
6387 GCPRO2 (orig_dir, orig_prompt); /* There is no GCPRON, N>6. */
6389 /* Note: under NTGUI_UNICODE, we do _NOT_ use ENCODE_FILE: the
6390 system file encoding expected by the platform APIs (e.g. Cygwin's
6391 POSIX implementation) may not be the same as the encoding expected
6392 by the Windows "ANSI" APIs! */
6394 CHECK_STRING (prompt);
6395 CHECK_STRING (dir);
6397 dir = Fexpand_file_name (dir, Qnil);
6399 if (STRINGP (filename))
6400 filename = Ffile_name_nondirectory (filename);
6401 else
6402 filename = empty_unibyte_string;
6404 #ifdef CYGWIN
6405 dir = Fcygwin_convert_file_name_to_windows (dir, Qt);
6406 if (SCHARS (filename) > 0)
6407 filename = Fcygwin_convert_file_name_to_windows (filename, Qnil);
6408 #endif
6410 CHECK_STRING (dir);
6411 CHECK_STRING (filename);
6413 /* The code in file_dialog_callback that attempts to set the text
6414 of the file name edit window when handling the CDN_INITDONE
6415 WM_NOTIFY message does not work. Setting filename to "Current
6416 Directory" in the only_dir_p case here does work however. */
6417 if (SCHARS (filename) == 0 && ! NILP (only_dir_p))
6418 filename = build_string ("Current Directory");
6420 /* Convert the values we've computed so far to system form. */
6421 #ifdef NTGUI_UNICODE
6422 to_unicode (prompt, &prompt);
6423 to_unicode (dir, &dir);
6424 to_unicode (filename, &filename);
6425 #else /* !NTGUI_UNICODE */
6426 prompt = ENCODE_FILE (prompt);
6427 dir = ENCODE_FILE (dir);
6428 filename = ENCODE_FILE (filename);
6430 /* We modify these in-place, so make copies for safety. */
6431 dir = Fcopy_sequence (dir);
6432 unixtodos_filename (SDATA (dir));
6433 filename = Fcopy_sequence (filename);
6434 unixtodos_filename (SDATA (filename));
6435 #endif /* NTGUI_UNICODE */
6437 /* Fill in the structure for the call to GetOpenFileName below.
6438 For NTGUI_UNICODE builds (which run only on NT), we just use
6439 the actual size of the structure. For non-NTGUI_UNICODE
6440 builds, we tell the OS we're using an old version of the
6441 structure if the OS isn't new enough to support the newer
6442 version. */
6443 memset (&new_file_details, 0, sizeof (new_file_details));
6445 if (w32_major_version > 4 && w32_major_version < 95)
6446 file_details->lStructSize = sizeof (new_file_details);
6447 else
6448 file_details->lStructSize = sizeof (*file_details);
6450 /* Set up the inout parameter for the selected file name. */
6451 if (SBYTES (filename) + 1 > sizeof (filename_buf))
6452 report_file_error ("filename too long", default_filename);
6454 memcpy (filename_buf, SDATA (filename), SBYTES (filename) + 1);
6455 file_details->lpstrFile = filename_buf;
6456 file_details->nMaxFile = sizeof (filename_buf) / sizeof (*filename_buf);
6458 file_details->hwndOwner = FRAME_W32_WINDOW (f);
6459 /* Undocumented Bug in Common File Dialog:
6460 If a filter is not specified, shell links are not resolved. */
6461 file_details->lpstrFilter = filter;
6462 file_details->lpstrInitialDir = (guichar_t*) SDATA (dir);
6463 file_details->lpstrTitle = (guichar_t*) SDATA (prompt);
6464 file_details->nFilterIndex = NILP (only_dir_p) ? 1 : 2;
6465 file_details->Flags = (OFN_HIDEREADONLY | OFN_NOCHANGEDIR
6466 | OFN_EXPLORER | OFN_ENABLEHOOK);
6468 if (!NILP (mustmatch))
6470 /* Require that the path to the parent directory exists. */
6471 file_details->Flags |= OFN_PATHMUSTEXIST;
6472 /* If we are looking for a file, require that it exists. */
6473 if (NILP (only_dir_p))
6474 file_details->Flags |= OFN_FILEMUSTEXIST;
6478 int count = SPECPDL_INDEX ();
6479 /* Prevent redisplay. */
6480 specbind (Qinhibit_redisplay, Qt);
6481 block_input ();
6482 file_details->lpfnHook = file_dialog_callback;
6484 file_opened = GUI_FN (GetOpenFileName) (file_details);
6485 unblock_input ();
6486 unbind_to (count, Qnil);
6489 if (file_opened)
6491 /* Get an Emacs string from the value Windows gave us. */
6492 #ifdef NTGUI_UNICODE
6493 filename = from_unicode_buffer (filename_buf);
6494 #else /* !NTGUI_UNICODE */
6495 dostounix_filename (filename_buf, 0);
6496 filename = DECODE_FILE (build_string (filename_buf));
6497 #endif /* NTGUI_UNICODE */
6499 #ifdef CYGWIN
6500 filename = Fcygwin_convert_file_name_from_windows (filename, Qt);
6501 #endif /* CYGWIN */
6503 /* Strip the dummy filename off the end of the string if we
6504 added it to select a directory. */
6505 if (file_details->nFilterIndex == 2)
6507 filename = Ffile_name_directory (filename);
6510 /* User canceled the dialog without making a selection. */
6511 else if (!CommDlgExtendedError ())
6512 filename = Qnil;
6513 /* An error occurred, fallback on reading from the mini-buffer. */
6514 else
6515 filename = Fcompleting_read (
6516 orig_prompt,
6517 intern ("read-file-name-internal"),
6518 orig_dir,
6519 mustmatch,
6520 orig_dir,
6521 Qfile_name_history,
6522 default_filename,
6523 Qnil);
6525 UNGCPRO;
6528 /* Make "Cancel" equivalent to C-g. */
6529 if (NILP (filename))
6530 Fsignal (Qquit, Qnil);
6532 RETURN_UNGCPRO (filename);
6536 #ifdef WINDOWSNT
6537 /* Moving files to the system recycle bin.
6538 Used by `move-file-to-trash' instead of the default moving to ~/.Trash */
6539 DEFUN ("system-move-file-to-trash", Fsystem_move_file_to_trash,
6540 Ssystem_move_file_to_trash, 1, 1, 0,
6541 doc: /* Move file or directory named FILENAME to the recycle bin. */)
6542 (Lisp_Object filename)
6544 Lisp_Object handler;
6545 Lisp_Object encoded_file;
6546 Lisp_Object operation;
6548 operation = Qdelete_file;
6549 if (!NILP (Ffile_directory_p (filename))
6550 && NILP (Ffile_symlink_p (filename)))
6552 operation = intern ("delete-directory");
6553 filename = Fdirectory_file_name (filename);
6555 filename = Fexpand_file_name (filename, Qnil);
6557 handler = Ffind_file_name_handler (filename, operation);
6558 if (!NILP (handler))
6559 return call2 (handler, operation, filename);
6561 encoded_file = ENCODE_FILE (filename);
6564 const char * path;
6565 SHFILEOPSTRUCT file_op;
6566 char tmp_path[MAX_PATH + 1];
6568 path = map_w32_filename (SDATA (encoded_file), NULL);
6570 /* On Windows, write permission is required to delete/move files. */
6571 _chmod (path, 0666);
6573 memset (tmp_path, 0, sizeof (tmp_path));
6574 strcpy (tmp_path, path);
6576 memset (&file_op, 0, sizeof (file_op));
6577 file_op.hwnd = HWND_DESKTOP;
6578 file_op.wFunc = FO_DELETE;
6579 file_op.pFrom = tmp_path;
6580 file_op.fFlags = FOF_SILENT | FOF_NOCONFIRMATION | FOF_ALLOWUNDO
6581 | FOF_NOERRORUI | FOF_NO_CONNECTED_ELEMENTS;
6582 file_op.fAnyOperationsAborted = FALSE;
6584 if (SHFileOperation (&file_op) != 0)
6585 report_file_error ("Removing old name", list1 (filename));
6587 return Qnil;
6590 #endif /* WINDOWSNT */
6593 /***********************************************************************
6594 w32 specialized functions
6595 ***********************************************************************/
6597 DEFUN ("w32-send-sys-command", Fw32_send_sys_command,
6598 Sw32_send_sys_command, 1, 2, 0,
6599 doc: /* Send frame a Windows WM_SYSCOMMAND message of type COMMAND.
6600 Some useful values for COMMAND are #xf030 to maximize frame (#xf020
6601 to minimize), #xf120 to restore frame to original size, and #xf100
6602 to activate the menubar for keyboard access. #xf140 activates the
6603 screen saver if defined.
6605 If optional parameter FRAME is not specified, use selected frame. */)
6606 (Lisp_Object command, Lisp_Object frame)
6608 struct frame *f = decode_window_system_frame (frame);
6610 CHECK_NUMBER (command);
6612 PostMessage (FRAME_W32_WINDOW (f), WM_SYSCOMMAND, XINT (command), 0);
6614 return Qnil;
6617 DEFUN ("w32-shell-execute", Fw32_shell_execute, Sw32_shell_execute, 2, 4, 0,
6618 doc: /* Get Windows to perform OPERATION on DOCUMENT.
6619 This is a wrapper around the ShellExecute system function, which
6620 invokes the application registered to handle OPERATION for DOCUMENT.
6622 OPERATION is either nil or a string that names a supported operation.
6623 What operations can be used depends on the particular DOCUMENT and its
6624 handler application, but typically it is one of the following common
6625 operations:
6627 \"open\" - open DOCUMENT, which could be a file, a directory, or an
6628 executable program. If it is an application, that
6629 application is launched in the current buffer's default
6630 directory. Otherwise, the application associated with
6631 DOCUMENT is launched in the buffer's default directory.
6632 \"print\" - print DOCUMENT, which must be a file
6633 \"explore\" - start the Windows Explorer on DOCUMENT
6634 \"edit\" - launch an editor and open DOCUMENT for editing; which
6635 editor is launched depends on the association for the
6636 specified DOCUMENT
6637 \"find\" - initiate search starting from DOCUMENT which must specify
6638 a directory
6639 nil - invoke the default OPERATION, or \"open\" if default is
6640 not defined or unavailable
6642 DOCUMENT is typically the name of a document file or a URL, but can
6643 also be a program executable to run, or a directory to open in the
6644 Windows Explorer.
6646 If DOCUMENT is a program executable, the optional third arg PARAMETERS
6647 can be a string containing command line parameters that will be passed
6648 to the program; otherwise, PARAMETERS should be nil or unspecified.
6650 Optional fourth argument SHOW-FLAG can be used to control how the
6651 application will be displayed when it is invoked. If SHOW-FLAG is nil
6652 or unspecified, the application is displayed normally, otherwise it is
6653 an integer representing a ShowWindow flag:
6655 0 - start hidden
6656 1 - start normally
6657 3 - start maximized
6658 6 - start minimized */)
6659 (Lisp_Object operation, Lisp_Object document, Lisp_Object parameters, Lisp_Object show_flag)
6661 Lisp_Object current_dir;
6662 char *errstr;
6664 CHECK_STRING (document);
6666 /* Encode filename, current directory and parameters. */
6667 current_dir = BVAR (current_buffer, directory);
6669 #ifdef CYGWIN
6670 current_dir = Fcygwin_convert_file_name_to_windows (current_dir, Qt);
6671 if (STRINGP (document))
6672 document = Fcygwin_convert_file_name_to_windows (document, Qt);
6673 #endif /* CYGWIN */
6675 current_dir = GUI_ENCODE_FILE (current_dir);
6676 if (STRINGP (document))
6677 document = GUI_ENCODE_FILE (document);
6678 if (STRINGP (parameters))
6679 parameters = GUI_ENCODE_SYSTEM (parameters);
6681 if ((int) GUI_FN (ShellExecute) (NULL,
6682 (STRINGP (operation) ?
6683 GUI_SDATA (operation) : NULL),
6684 GUI_SDATA (document),
6685 (STRINGP (parameters) ?
6686 GUI_SDATA (parameters) : NULL),
6687 GUI_SDATA (current_dir),
6688 (INTEGERP (show_flag) ?
6689 XINT (show_flag) : SW_SHOWDEFAULT))
6690 > 32)
6691 return Qt;
6692 errstr = w32_strerror (0);
6693 /* The error string might be encoded in the locale's encoding. */
6694 if (!NILP (Vlocale_coding_system))
6696 Lisp_Object decoded =
6697 code_convert_string_norecord (build_unibyte_string (errstr),
6698 Vlocale_coding_system, 0);
6699 errstr = SSDATA (decoded);
6701 error ("ShellExecute failed: %s", errstr);
6704 /* Lookup virtual keycode from string representing the name of a
6705 non-ascii keystroke into the corresponding virtual key, using
6706 lispy_function_keys. */
6707 static int
6708 lookup_vk_code (char *key)
6710 int i;
6712 for (i = 0; i < 256; i++)
6713 if (lispy_function_keys[i]
6714 && strcmp (lispy_function_keys[i], key) == 0)
6715 return i;
6717 return -1;
6720 /* Convert a one-element vector style key sequence to a hot key
6721 definition. */
6722 static Lisp_Object
6723 w32_parse_hot_key (Lisp_Object key)
6725 /* Copied from Fdefine_key and store_in_keymap. */
6726 register Lisp_Object c;
6727 int vk_code;
6728 int lisp_modifiers;
6729 int w32_modifiers;
6730 struct gcpro gcpro1;
6732 CHECK_VECTOR (key);
6734 if (ASIZE (key) != 1)
6735 return Qnil;
6737 GCPRO1 (key);
6739 c = AREF (key, 0);
6741 if (CONSP (c) && lucid_event_type_list_p (c))
6742 c = Fevent_convert_list (c);
6744 UNGCPRO;
6746 if (! INTEGERP (c) && ! SYMBOLP (c))
6747 error ("Key definition is invalid");
6749 /* Work out the base key and the modifiers. */
6750 if (SYMBOLP (c))
6752 c = parse_modifiers (c);
6753 lisp_modifiers = XINT (Fcar (Fcdr (c)));
6754 c = Fcar (c);
6755 if (!SYMBOLP (c))
6756 emacs_abort ();
6757 vk_code = lookup_vk_code (SDATA (SYMBOL_NAME (c)));
6759 else if (INTEGERP (c))
6761 lisp_modifiers = XINT (c) & ~CHARACTERBITS;
6762 /* Many ascii characters are their own virtual key code. */
6763 vk_code = XINT (c) & CHARACTERBITS;
6766 if (vk_code < 0 || vk_code > 255)
6767 return Qnil;
6769 if ((lisp_modifiers & meta_modifier) != 0
6770 && !NILP (Vw32_alt_is_meta))
6771 lisp_modifiers |= alt_modifier;
6773 /* Supply defs missing from mingw32. */
6774 #ifndef MOD_ALT
6775 #define MOD_ALT 0x0001
6776 #define MOD_CONTROL 0x0002
6777 #define MOD_SHIFT 0x0004
6778 #define MOD_WIN 0x0008
6779 #endif
6781 /* Convert lisp modifiers to Windows hot-key form. */
6782 w32_modifiers = (lisp_modifiers & hyper_modifier) ? MOD_WIN : 0;
6783 w32_modifiers |= (lisp_modifiers & alt_modifier) ? MOD_ALT : 0;
6784 w32_modifiers |= (lisp_modifiers & ctrl_modifier) ? MOD_CONTROL : 0;
6785 w32_modifiers |= (lisp_modifiers & shift_modifier) ? MOD_SHIFT : 0;
6787 return HOTKEY (vk_code, w32_modifiers);
6790 DEFUN ("w32-register-hot-key", Fw32_register_hot_key,
6791 Sw32_register_hot_key, 1, 1, 0,
6792 doc: /* Register KEY as a hot-key combination.
6793 Certain key combinations like Alt-Tab are reserved for system use on
6794 Windows, and therefore are normally intercepted by the system. However,
6795 most of these key combinations can be received by registering them as
6796 hot-keys, overriding their special meaning.
6798 KEY must be a one element key definition in vector form that would be
6799 acceptable to `define-key' (e.g. [A-tab] for Alt-Tab). The meta
6800 modifier is interpreted as Alt if `w32-alt-is-meta' is t, and hyper
6801 is always interpreted as the Windows modifier keys.
6803 The return value is the hotkey-id if registered, otherwise nil. */)
6804 (Lisp_Object key)
6806 key = w32_parse_hot_key (key);
6808 if (!NILP (key) && NILP (Fmemq (key, w32_grabbed_keys)))
6810 /* Reuse an empty slot if possible. */
6811 Lisp_Object item = Fmemq (Qnil, w32_grabbed_keys);
6813 /* Safe to add new key to list, even if we have focus. */
6814 if (NILP (item))
6815 w32_grabbed_keys = Fcons (key, w32_grabbed_keys);
6816 else
6817 XSETCAR (item, key);
6819 /* Notify input thread about new hot-key definition, so that it
6820 takes effect without needing to switch focus. */
6821 PostThreadMessage (dwWindowsThreadId, WM_EMACS_REGISTER_HOT_KEY,
6822 (WPARAM) XLI (key), 0);
6825 return key;
6828 DEFUN ("w32-unregister-hot-key", Fw32_unregister_hot_key,
6829 Sw32_unregister_hot_key, 1, 1, 0,
6830 doc: /* Unregister KEY as a hot-key combination. */)
6831 (Lisp_Object key)
6833 Lisp_Object item;
6835 if (!INTEGERP (key))
6836 key = w32_parse_hot_key (key);
6838 item = Fmemq (key, w32_grabbed_keys);
6840 if (!NILP (item))
6842 /* Notify input thread about hot-key definition being removed, so
6843 that it takes effect without needing focus switch. */
6844 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_UNREGISTER_HOT_KEY,
6845 (WPARAM) XINT (XCAR (item)), (LPARAM) XLI (item)))
6847 MSG msg;
6848 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
6850 return Qt;
6852 return Qnil;
6855 DEFUN ("w32-registered-hot-keys", Fw32_registered_hot_keys,
6856 Sw32_registered_hot_keys, 0, 0, 0,
6857 doc: /* Return list of registered hot-key IDs. */)
6858 (void)
6860 return Fdelq (Qnil, Fcopy_sequence (w32_grabbed_keys));
6863 DEFUN ("w32-reconstruct-hot-key", Fw32_reconstruct_hot_key,
6864 Sw32_reconstruct_hot_key, 1, 1, 0,
6865 doc: /* Convert hot-key ID to a lisp key combination.
6866 usage: (w32-reconstruct-hot-key ID) */)
6867 (Lisp_Object hotkeyid)
6869 int vk_code, w32_modifiers;
6870 Lisp_Object key;
6872 CHECK_NUMBER (hotkeyid);
6874 vk_code = HOTKEY_VK_CODE (hotkeyid);
6875 w32_modifiers = HOTKEY_MODIFIERS (hotkeyid);
6877 if (vk_code < 256 && lispy_function_keys[vk_code])
6878 key = intern (lispy_function_keys[vk_code]);
6879 else
6880 key = make_number (vk_code);
6882 key = Fcons (key, Qnil);
6883 if (w32_modifiers & MOD_SHIFT)
6884 key = Fcons (Qshift, key);
6885 if (w32_modifiers & MOD_CONTROL)
6886 key = Fcons (Qctrl, key);
6887 if (w32_modifiers & MOD_ALT)
6888 key = Fcons (NILP (Vw32_alt_is_meta) ? Qalt : Qmeta, key);
6889 if (w32_modifiers & MOD_WIN)
6890 key = Fcons (Qhyper, key);
6892 return key;
6895 DEFUN ("w32-toggle-lock-key", Fw32_toggle_lock_key,
6896 Sw32_toggle_lock_key, 1, 2, 0,
6897 doc: /* Toggle the state of the lock key KEY.
6898 KEY can be `capslock', `kp-numlock', or `scroll'.
6899 If the optional parameter NEW-STATE is a number, then the state of KEY
6900 is set to off if the low bit of NEW-STATE is zero, otherwise on. */)
6901 (Lisp_Object key, Lisp_Object new_state)
6903 int vk_code;
6905 if (EQ (key, intern ("capslock")))
6906 vk_code = VK_CAPITAL;
6907 else if (EQ (key, intern ("kp-numlock")))
6908 vk_code = VK_NUMLOCK;
6909 else if (EQ (key, intern ("scroll")))
6910 vk_code = VK_SCROLL;
6911 else
6912 return Qnil;
6914 if (!dwWindowsThreadId)
6915 return make_number (w32_console_toggle_lock_key (vk_code, new_state));
6917 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_TOGGLE_LOCK_KEY,
6918 (WPARAM) vk_code, (LPARAM) XLI (new_state)))
6920 MSG msg;
6921 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
6922 return make_number (msg.wParam);
6924 return Qnil;
6927 DEFUN ("w32-window-exists-p", Fw32_window_exists_p, Sw32_window_exists_p,
6928 2, 2, 0,
6929 doc: /* Return non-nil if a window exists with the specified CLASS and NAME.
6931 This is a direct interface to the Windows API FindWindow function. */)
6932 (Lisp_Object class, Lisp_Object name)
6934 HWND hnd;
6936 if (!NILP (class))
6937 CHECK_STRING (class);
6938 if (!NILP (name))
6939 CHECK_STRING (name);
6941 hnd = FindWindow (STRINGP (class) ? ((LPCTSTR) SDATA (class)) : NULL,
6942 STRINGP (name) ? ((LPCTSTR) SDATA (name)) : NULL);
6943 if (!hnd)
6944 return Qnil;
6945 return Qt;
6948 DEFUN ("w32-battery-status", Fw32_battery_status, Sw32_battery_status, 0, 0, 0,
6949 doc: /* Get power status information from Windows system.
6951 The following %-sequences are provided:
6952 %L AC line status (verbose)
6953 %B Battery status (verbose)
6954 %b Battery status, empty means high, `-' means low,
6955 `!' means critical, and `+' means charging
6956 %p Battery load percentage
6957 %s Remaining time (to charge or discharge) in seconds
6958 %m Remaining time (to charge or discharge) in minutes
6959 %h Remaining time (to charge or discharge) in hours
6960 %t Remaining time (to charge or discharge) in the form `h:min' */)
6961 (void)
6963 Lisp_Object status = Qnil;
6965 SYSTEM_POWER_STATUS system_status;
6966 if (GetSystemPowerStatus (&system_status))
6968 Lisp_Object line_status, battery_status, battery_status_symbol;
6969 Lisp_Object load_percentage, seconds, minutes, hours, remain;
6971 long seconds_left = (long) system_status.BatteryLifeTime;
6973 if (system_status.ACLineStatus == 0)
6974 line_status = build_string ("off-line");
6975 else if (system_status.ACLineStatus == 1)
6976 line_status = build_string ("on-line");
6977 else
6978 line_status = build_string ("N/A");
6980 if (system_status.BatteryFlag & 128)
6982 battery_status = build_string ("N/A");
6983 battery_status_symbol = empty_unibyte_string;
6985 else if (system_status.BatteryFlag & 8)
6987 battery_status = build_string ("charging");
6988 battery_status_symbol = build_string ("+");
6989 if (system_status.BatteryFullLifeTime != -1L)
6990 seconds_left = system_status.BatteryFullLifeTime - seconds_left;
6992 else if (system_status.BatteryFlag & 4)
6994 battery_status = build_string ("critical");
6995 battery_status_symbol = build_string ("!");
6997 else if (system_status.BatteryFlag & 2)
6999 battery_status = build_string ("low");
7000 battery_status_symbol = build_string ("-");
7002 else if (system_status.BatteryFlag & 1)
7004 battery_status = build_string ("high");
7005 battery_status_symbol = empty_unibyte_string;
7007 else
7009 battery_status = build_string ("medium");
7010 battery_status_symbol = empty_unibyte_string;
7013 if (system_status.BatteryLifePercent > 100)
7014 load_percentage = build_string ("N/A");
7015 else
7017 char buffer[16];
7018 snprintf (buffer, 16, "%d", system_status.BatteryLifePercent);
7019 load_percentage = build_string (buffer);
7022 if (seconds_left < 0)
7023 seconds = minutes = hours = remain = build_string ("N/A");
7024 else
7026 long m;
7027 float h;
7028 char buffer[16];
7029 snprintf (buffer, 16, "%ld", seconds_left);
7030 seconds = build_string (buffer);
7032 m = seconds_left / 60;
7033 snprintf (buffer, 16, "%ld", m);
7034 minutes = build_string (buffer);
7036 h = seconds_left / 3600.0;
7037 snprintf (buffer, 16, "%3.1f", h);
7038 hours = build_string (buffer);
7040 snprintf (buffer, 16, "%ld:%02ld", m / 60, m % 60);
7041 remain = build_string (buffer);
7044 status = listn (CONSTYPE_HEAP, 8,
7045 Fcons (make_number ('L'), line_status),
7046 Fcons (make_number ('B'), battery_status),
7047 Fcons (make_number ('b'), battery_status_symbol),
7048 Fcons (make_number ('p'), load_percentage),
7049 Fcons (make_number ('s'), seconds),
7050 Fcons (make_number ('m'), minutes),
7051 Fcons (make_number ('h'), hours),
7052 Fcons (make_number ('t'), remain));
7054 return status;
7058 #ifdef WINDOWSNT
7059 DEFUN ("file-system-info", Ffile_system_info, Sfile_system_info, 1, 1, 0,
7060 doc: /* Return storage information about the file system FILENAME is on.
7061 Value is a list of floats (TOTAL FREE AVAIL), where TOTAL is the total
7062 storage of the file system, FREE is the free storage, and AVAIL is the
7063 storage available to a non-superuser. All 3 numbers are in bytes.
7064 If the underlying system call fails, value is nil. */)
7065 (Lisp_Object filename)
7067 Lisp_Object encoded, value;
7069 CHECK_STRING (filename);
7070 filename = Fexpand_file_name (filename, Qnil);
7071 encoded = ENCODE_FILE (filename);
7073 value = Qnil;
7075 /* Determining the required information on Windows turns out, sadly,
7076 to be more involved than one would hope. The original Windows API
7077 call for this will return bogus information on some systems, but we
7078 must dynamically probe for the replacement api, since that was
7079 added rather late on. */
7081 HMODULE hKernel = GetModuleHandle ("kernel32");
7082 BOOL (*pfn_GetDiskFreeSpaceEx)
7083 (char *, PULARGE_INTEGER, PULARGE_INTEGER, PULARGE_INTEGER)
7084 = (void *) GetProcAddress (hKernel, "GetDiskFreeSpaceEx");
7086 /* On Windows, we may need to specify the root directory of the
7087 volume holding FILENAME. */
7088 char rootname[MAX_PATH];
7089 char *name = SDATA (encoded);
7091 /* find the root name of the volume if given */
7092 if (isalpha (name[0]) && name[1] == ':')
7094 rootname[0] = name[0];
7095 rootname[1] = name[1];
7096 rootname[2] = '\\';
7097 rootname[3] = 0;
7099 else if (IS_DIRECTORY_SEP (name[0]) && IS_DIRECTORY_SEP (name[1]))
7101 char *str = rootname;
7102 int slashes = 4;
7105 if (IS_DIRECTORY_SEP (*name) && --slashes == 0)
7106 break;
7107 *str++ = *name++;
7109 while ( *name );
7111 *str++ = '\\';
7112 *str = 0;
7115 if (pfn_GetDiskFreeSpaceEx)
7117 /* Unsigned large integers cannot be cast to double, so
7118 use signed ones instead. */
7119 LARGE_INTEGER availbytes;
7120 LARGE_INTEGER freebytes;
7121 LARGE_INTEGER totalbytes;
7123 if (pfn_GetDiskFreeSpaceEx (rootname,
7124 (ULARGE_INTEGER *)&availbytes,
7125 (ULARGE_INTEGER *)&totalbytes,
7126 (ULARGE_INTEGER *)&freebytes))
7127 value = list3 (make_float ((double) totalbytes.QuadPart),
7128 make_float ((double) freebytes.QuadPart),
7129 make_float ((double) availbytes.QuadPart));
7131 else
7133 DWORD sectors_per_cluster;
7134 DWORD bytes_per_sector;
7135 DWORD free_clusters;
7136 DWORD total_clusters;
7138 if (GetDiskFreeSpace (rootname,
7139 &sectors_per_cluster,
7140 &bytes_per_sector,
7141 &free_clusters,
7142 &total_clusters))
7143 value = list3 (make_float ((double) total_clusters
7144 * sectors_per_cluster * bytes_per_sector),
7145 make_float ((double) free_clusters
7146 * sectors_per_cluster * bytes_per_sector),
7147 make_float ((double) free_clusters
7148 * sectors_per_cluster * bytes_per_sector));
7152 return value;
7154 #endif /* WINDOWSNT */
7157 DEFUN ("default-printer-name", Fdefault_printer_name, Sdefault_printer_name,
7158 0, 0, 0, doc: /* Return the name of Windows default printer device. */)
7159 (void)
7161 static char pname_buf[256];
7162 int err;
7163 HANDLE hPrn;
7164 PRINTER_INFO_2 *ppi2 = NULL;
7165 DWORD dwNeeded = 0, dwReturned = 0;
7167 /* Retrieve the default string from Win.ini (the registry).
7168 * String will be in form "printername,drivername,portname".
7169 * This is the most portable way to get the default printer. */
7170 if (GetProfileString ("windows", "device", ",,", pname_buf, sizeof (pname_buf)) <= 0)
7171 return Qnil;
7172 /* printername precedes first "," character */
7173 strtok (pname_buf, ",");
7174 /* We want to know more than the printer name */
7175 if (!OpenPrinter (pname_buf, &hPrn, NULL))
7176 return Qnil;
7177 GetPrinter (hPrn, 2, NULL, 0, &dwNeeded);
7178 if (dwNeeded == 0)
7180 ClosePrinter (hPrn);
7181 return Qnil;
7183 /* Allocate memory for the PRINTER_INFO_2 struct */
7184 ppi2 = xmalloc (dwNeeded);
7185 if (!ppi2)
7187 ClosePrinter (hPrn);
7188 return Qnil;
7190 /* Call GetPrinter again with big enough memory block. */
7191 err = GetPrinter (hPrn, 2, (LPBYTE)ppi2, dwNeeded, &dwReturned);
7192 ClosePrinter (hPrn);
7193 if (!err)
7195 xfree (ppi2);
7196 return Qnil;
7199 if (ppi2)
7201 if (ppi2->Attributes & PRINTER_ATTRIBUTE_SHARED && ppi2->pServerName)
7203 /* a remote printer */
7204 if (*ppi2->pServerName == '\\')
7205 snprintf (pname_buf, sizeof (pname_buf), "%s\\%s", ppi2->pServerName,
7206 ppi2->pShareName);
7207 else
7208 snprintf (pname_buf, sizeof (pname_buf), "\\\\%s\\%s", ppi2->pServerName,
7209 ppi2->pShareName);
7210 pname_buf[sizeof (pname_buf) - 1] = '\0';
7212 else
7214 /* a local printer */
7215 strncpy (pname_buf, ppi2->pPortName, sizeof (pname_buf));
7216 pname_buf[sizeof (pname_buf) - 1] = '\0';
7217 /* `pPortName' can include several ports, delimited by ','.
7218 * we only use the first one. */
7219 strtok (pname_buf, ",");
7221 xfree (ppi2);
7224 return build_string (pname_buf);
7228 /* Equivalent of strerror for W32 error codes. */
7229 char *
7230 w32_strerror (int error_no)
7232 static char buf[500];
7233 DWORD ret;
7235 if (error_no == 0)
7236 error_no = GetLastError ();
7238 ret = FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM |
7239 FORMAT_MESSAGE_IGNORE_INSERTS,
7240 NULL,
7241 error_no,
7242 0, /* choose most suitable language */
7243 buf, sizeof (buf), NULL);
7245 while (ret > 0 && (buf[ret - 1] == '\n' ||
7246 buf[ret - 1] == '\r' ))
7247 --ret;
7248 buf[ret] = '\0';
7249 if (!ret)
7250 sprintf (buf, "w32 error %u", error_no);
7252 return buf;
7255 /* For convenience when debugging. (You cannot call GetLastError
7256 directly from GDB: it will crash, because it uses the __stdcall
7257 calling convention, not the _cdecl convention assumed by GDB.) */
7258 DWORD
7259 w32_last_error (void)
7261 return GetLastError ();
7264 /* Cache information describing the NT system for later use. */
7265 void
7266 cache_system_info (void)
7268 union
7270 struct info
7272 char major;
7273 char minor;
7274 short platform;
7275 } info;
7276 DWORD data;
7277 } version;
7279 /* Cache the module handle of Emacs itself. */
7280 hinst = GetModuleHandle (NULL);
7282 /* Cache the version of the operating system. */
7283 version.data = GetVersion ();
7284 w32_major_version = version.info.major;
7285 w32_minor_version = version.info.minor;
7287 if (version.info.platform & 0x8000)
7288 os_subtype = OS_9X;
7289 else
7290 os_subtype = OS_NT;
7292 /* Cache page size, allocation unit, processor type, etc. */
7293 GetSystemInfo (&sysinfo_cache);
7294 syspage_mask = (DWORD_PTR)sysinfo_cache.dwPageSize - 1;
7296 /* Cache os info. */
7297 osinfo_cache.dwOSVersionInfoSize = sizeof (OSVERSIONINFO);
7298 GetVersionEx (&osinfo_cache);
7300 w32_build_number = osinfo_cache.dwBuildNumber;
7301 if (os_subtype == OS_9X)
7302 w32_build_number &= 0xffff;
7304 w32_num_mouse_buttons = GetSystemMetrics (SM_CMOUSEBUTTONS);
7307 #ifdef EMACSDEBUG
7308 void
7309 _DebPrint (const char *fmt, ...)
7311 char buf[1024];
7312 va_list args;
7314 va_start (args, fmt);
7315 vsprintf (buf, fmt, args);
7316 va_end (args);
7317 #if CYGWIN
7318 fprintf (stderr, "%s", buf);
7319 #endif
7320 OutputDebugString (buf);
7322 #endif
7325 w32_console_toggle_lock_key (int vk_code, Lisp_Object new_state)
7327 int cur_state = (GetKeyState (vk_code) & 1);
7329 if (NILP (new_state)
7330 || (NUMBERP (new_state)
7331 && ((XUINT (new_state)) & 1) != cur_state))
7333 #ifdef WINDOWSNT
7334 faked_key = vk_code;
7335 #endif /* WINDOWSNT */
7337 keybd_event ((BYTE) vk_code,
7338 (BYTE) MapVirtualKey (vk_code, 0),
7339 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
7340 keybd_event ((BYTE) vk_code,
7341 (BYTE) MapVirtualKey (vk_code, 0),
7342 KEYEVENTF_EXTENDEDKEY | 0, 0);
7343 keybd_event ((BYTE) vk_code,
7344 (BYTE) MapVirtualKey (vk_code, 0),
7345 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
7346 cur_state = !cur_state;
7349 return cur_state;
7352 /* Translate console modifiers to emacs modifiers.
7353 German keyboard support (Kai Morgan Zeise 2/18/95). */
7355 w32_kbd_mods_to_emacs (DWORD mods, WORD key)
7357 int retval = 0;
7359 /* If we recognize right-alt and left-ctrl as AltGr, and it has been
7360 pressed, first remove those modifiers. */
7361 if (!NILP (Vw32_recognize_altgr)
7362 && (mods & (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED))
7363 == (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED))
7364 mods &= ~ (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED);
7366 if (mods & (RIGHT_ALT_PRESSED | LEFT_ALT_PRESSED))
7367 retval = ((NILP (Vw32_alt_is_meta)) ? alt_modifier : meta_modifier);
7369 if (mods & (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
7371 retval |= ctrl_modifier;
7372 if ((mods & (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
7373 == (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
7374 retval |= meta_modifier;
7377 if (mods & LEFT_WIN_PRESSED)
7378 retval |= w32_key_to_modifier (VK_LWIN);
7379 if (mods & RIGHT_WIN_PRESSED)
7380 retval |= w32_key_to_modifier (VK_RWIN);
7381 if (mods & APPS_PRESSED)
7382 retval |= w32_key_to_modifier (VK_APPS);
7383 if (mods & SCROLLLOCK_ON)
7384 retval |= w32_key_to_modifier (VK_SCROLL);
7386 /* Just in case someone wanted the original behavior, make it
7387 optional by setting w32-capslock-is-shiftlock to t. */
7388 if (NILP (Vw32_capslock_is_shiftlock)
7389 /* Keys that should _not_ be affected by CapsLock. */
7390 && ( (key == VK_BACK)
7391 || (key == VK_TAB)
7392 || (key == VK_CLEAR)
7393 || (key == VK_RETURN)
7394 || (key == VK_ESCAPE)
7395 || ((key >= VK_SPACE) && (key <= VK_HELP))
7396 || ((key >= VK_NUMPAD0) && (key <= VK_F24))
7397 || ((key >= VK_NUMPAD_CLEAR) && (key <= VK_NUMPAD_DELETE))
7400 /* Only consider shift state. */
7401 if ((mods & SHIFT_PRESSED) != 0)
7402 retval |= shift_modifier;
7404 else
7406 /* Ignore CapsLock state if not enabled. */
7407 if (NILP (Vw32_enable_caps_lock))
7408 mods &= ~CAPSLOCK_ON;
7409 if ((mods & (SHIFT_PRESSED | CAPSLOCK_ON)) != 0)
7410 retval |= shift_modifier;
7413 return retval;
7416 /* The return code indicates key code size. cpID is the codepage to
7417 use for translation to Unicode; -1 means use the current console
7418 input codepage. */
7420 w32_kbd_patch_key (KEY_EVENT_RECORD *event, int cpId)
7422 unsigned int key_code = event->wVirtualKeyCode;
7423 unsigned int mods = event->dwControlKeyState;
7424 BYTE keystate[256];
7425 static BYTE ansi_code[4];
7426 static int isdead = 0;
7428 if (isdead == 2)
7430 event->uChar.AsciiChar = ansi_code[2];
7431 isdead = 0;
7432 return 1;
7434 if (event->uChar.AsciiChar != 0)
7435 return 1;
7437 memset (keystate, 0, sizeof (keystate));
7438 keystate[key_code] = 0x80;
7439 if (mods & SHIFT_PRESSED)
7440 keystate[VK_SHIFT] = 0x80;
7441 if (mods & CAPSLOCK_ON)
7442 keystate[VK_CAPITAL] = 1;
7443 /* If we recognize right-alt and left-ctrl as AltGr, set the key
7444 states accordingly before invoking ToAscii. */
7445 if (!NILP (Vw32_recognize_altgr)
7446 && (mods & LEFT_CTRL_PRESSED) && (mods & RIGHT_ALT_PRESSED))
7448 keystate[VK_CONTROL] = 0x80;
7449 keystate[VK_LCONTROL] = 0x80;
7450 keystate[VK_MENU] = 0x80;
7451 keystate[VK_RMENU] = 0x80;
7454 #if 0
7455 /* Because of an OS bug, ToAscii corrupts the stack when called to
7456 convert a dead key in console mode on NT4. Unfortunately, trying
7457 to check for dead keys using MapVirtualKey doesn't work either -
7458 these functions apparently use internal information about keyboard
7459 layout which doesn't get properly updated in console programs when
7460 changing layout (though apparently it gets partly updated,
7461 otherwise ToAscii wouldn't crash). */
7462 if (is_dead_key (event->wVirtualKeyCode))
7463 return 0;
7464 #endif
7466 /* On NT, call ToUnicode instead and then convert to the current
7467 console input codepage. */
7468 if (os_subtype == OS_NT)
7470 WCHAR buf[128];
7472 isdead = ToUnicode (event->wVirtualKeyCode, event->wVirtualScanCode,
7473 keystate, buf, 128, 0);
7474 if (isdead > 0)
7476 /* When we are called from the GUI message processing code,
7477 we are passed the current keyboard codepage, a positive
7478 number, to use below. */
7479 if (cpId == -1)
7480 cpId = GetConsoleCP ();
7482 event->uChar.UnicodeChar = buf[isdead - 1];
7483 isdead = WideCharToMultiByte (cpId, 0, buf, isdead,
7484 ansi_code, 4, NULL, NULL);
7486 else
7487 isdead = 0;
7489 else
7491 isdead = ToAscii (event->wVirtualKeyCode, event->wVirtualScanCode,
7492 keystate, (LPWORD) ansi_code, 0);
7495 if (isdead == 0)
7496 return 0;
7497 event->uChar.AsciiChar = ansi_code[0];
7498 return isdead;
7502 void
7503 w32_sys_ring_bell (struct frame *f)
7505 if (sound_type == 0xFFFFFFFF)
7507 Beep (666, 100);
7509 else if (sound_type == MB_EMACS_SILENT)
7511 /* Do nothing. */
7513 else
7514 MessageBeep (sound_type);
7518 /***********************************************************************
7519 Initialization
7520 ***********************************************************************/
7522 /* Keep this list in the same order as frame_parms in frame.c.
7523 Use 0 for unsupported frame parameters. */
7525 frame_parm_handler w32_frame_parm_handlers[] =
7527 x_set_autoraise,
7528 x_set_autolower,
7529 x_set_background_color,
7530 x_set_border_color,
7531 x_set_border_width,
7532 x_set_cursor_color,
7533 x_set_cursor_type,
7534 x_set_font,
7535 x_set_foreground_color,
7536 x_set_icon_name,
7537 x_set_icon_type,
7538 x_set_internal_border_width,
7539 x_set_menu_bar_lines,
7540 x_set_mouse_color,
7541 x_explicitly_set_name,
7542 x_set_scroll_bar_width,
7543 x_set_title,
7544 x_set_unsplittable,
7545 x_set_vertical_scroll_bars,
7546 x_set_visibility,
7547 x_set_tool_bar_lines,
7548 0, /* x_set_scroll_bar_foreground, */
7549 0, /* x_set_scroll_bar_background, */
7550 x_set_screen_gamma,
7551 x_set_line_spacing,
7552 x_set_fringe_width,
7553 x_set_fringe_width,
7554 0, /* x_set_wait_for_wm, */
7555 x_set_fullscreen,
7556 x_set_font_backend,
7557 x_set_alpha,
7558 0, /* x_set_sticky */
7559 0, /* x_set_tool_bar_position */
7562 void
7563 syms_of_w32fns (void)
7565 globals_of_w32fns ();
7566 track_mouse_window = NULL;
7568 w32_visible_system_caret_hwnd = NULL;
7570 DEFSYM (Qsuppress_icon, "suppress-icon");
7571 DEFSYM (Qundefined_color, "undefined-color");
7572 DEFSYM (Qcancel_timer, "cancel-timer");
7573 DEFSYM (Qhyper, "hyper");
7574 DEFSYM (Qsuper, "super");
7575 DEFSYM (Qmeta, "meta");
7576 DEFSYM (Qalt, "alt");
7577 DEFSYM (Qctrl, "ctrl");
7578 DEFSYM (Qcontrol, "control");
7579 DEFSYM (Qshift, "shift");
7580 DEFSYM (Qfont_param, "font-parameter");
7581 DEFSYM (Qgeometry, "geometry");
7582 DEFSYM (Qworkarea, "workarea");
7583 DEFSYM (Qmm_size, "mm-size");
7584 DEFSYM (Qframes, "frames");
7585 /* This is the end of symbol initialization. */
7588 Fput (Qundefined_color, Qerror_conditions,
7589 listn (CONSTYPE_PURE, 2, Qundefined_color, Qerror));
7590 Fput (Qundefined_color, Qerror_message,
7591 build_pure_c_string ("Undefined color"));
7593 staticpro (&w32_grabbed_keys);
7594 w32_grabbed_keys = Qnil;
7596 DEFVAR_LISP ("w32-color-map", Vw32_color_map,
7597 doc: /* An array of color name mappings for Windows. */);
7598 Vw32_color_map = Qnil;
7600 DEFVAR_LISP ("w32-pass-alt-to-system", Vw32_pass_alt_to_system,
7601 doc: /* Non-nil if Alt key presses are passed on to Windows.
7602 When non-nil, for example, Alt pressed and released and then space will
7603 open the System menu. When nil, Emacs processes the Alt key events, and
7604 then silently swallows them. */);
7605 Vw32_pass_alt_to_system = Qnil;
7607 DEFVAR_LISP ("w32-alt-is-meta", Vw32_alt_is_meta,
7608 doc: /* Non-nil if the Alt key is to be considered the same as the META key.
7609 When nil, Emacs will translate the Alt key to the ALT modifier, not to META. */);
7610 Vw32_alt_is_meta = Qt;
7612 DEFVAR_INT ("w32-quit-key", w32_quit_key,
7613 doc: /* If non-zero, the virtual key code for an alternative quit key. */);
7614 w32_quit_key = 0;
7616 DEFVAR_LISP ("w32-pass-lwindow-to-system",
7617 Vw32_pass_lwindow_to_system,
7618 doc: /* If non-nil, the left \"Windows\" key is passed on to Windows.
7620 When non-nil, the Start menu is opened by tapping the key.
7621 If you set this to nil, the left \"Windows\" key is processed by Emacs
7622 according to the value of `w32-lwindow-modifier', which see.
7624 Note that some combinations of the left \"Windows\" key with other keys are
7625 caught by Windows at low level, and so binding them in Emacs will have no
7626 effect. For example, <lwindow>-r always pops up the Windows Run dialog,
7627 <lwindow>-<Pause> pops up the "System Properties" dialog, etc. However, see
7628 the doc string of `w32-phantom-key-code'. */);
7629 Vw32_pass_lwindow_to_system = Qt;
7631 DEFVAR_LISP ("w32-pass-rwindow-to-system",
7632 Vw32_pass_rwindow_to_system,
7633 doc: /* If non-nil, the right \"Windows\" key is passed on to Windows.
7635 When non-nil, the Start menu is opened by tapping the key.
7636 If you set this to nil, the right \"Windows\" key is processed by Emacs
7637 according to the value of `w32-rwindow-modifier', which see.
7639 Note that some combinations of the right \"Windows\" key with other keys are
7640 caught by Windows at low level, and so binding them in Emacs will have no
7641 effect. For example, <rwindow>-r always pops up the Windows Run dialog,
7642 <rwindow>-<Pause> pops up the "System Properties" dialog, etc. However, see
7643 the doc string of `w32-phantom-key-code'. */);
7644 Vw32_pass_rwindow_to_system = Qt;
7646 DEFVAR_LISP ("w32-phantom-key-code",
7647 Vw32_phantom_key_code,
7648 doc: /* Virtual key code used to generate \"phantom\" key presses.
7649 Value is a number between 0 and 255.
7651 Phantom key presses are generated in order to stop the system from
7652 acting on \"Windows\" key events when `w32-pass-lwindow-to-system' or
7653 `w32-pass-rwindow-to-system' is nil. */);
7654 /* Although 255 is technically not a valid key code, it works and
7655 means that this hack won't interfere with any real key code. */
7656 XSETINT (Vw32_phantom_key_code, 255);
7658 DEFVAR_LISP ("w32-enable-num-lock",
7659 Vw32_enable_num_lock,
7660 doc: /* If non-nil, the Num Lock key acts normally.
7661 Set to nil to handle Num Lock as the `kp-numlock' key. */);
7662 Vw32_enable_num_lock = Qt;
7664 DEFVAR_LISP ("w32-enable-caps-lock",
7665 Vw32_enable_caps_lock,
7666 doc: /* If non-nil, the Caps Lock key acts normally.
7667 Set to nil to handle Caps Lock as the `capslock' key. */);
7668 Vw32_enable_caps_lock = Qt;
7670 DEFVAR_LISP ("w32-scroll-lock-modifier",
7671 Vw32_scroll_lock_modifier,
7672 doc: /* Modifier to use for the Scroll Lock ON state.
7673 The value can be hyper, super, meta, alt, control or shift for the
7674 respective modifier, or nil to handle Scroll Lock as the `scroll' key.
7675 Any other value will cause the Scroll Lock key to be ignored. */);
7676 Vw32_scroll_lock_modifier = Qnil;
7678 DEFVAR_LISP ("w32-lwindow-modifier",
7679 Vw32_lwindow_modifier,
7680 doc: /* Modifier to use for the left \"Windows\" key.
7681 The value can be hyper, super, meta, alt, control or shift for the
7682 respective modifier, or nil to appear as the `lwindow' key.
7683 Any other value will cause the key to be ignored. */);
7684 Vw32_lwindow_modifier = Qnil;
7686 DEFVAR_LISP ("w32-rwindow-modifier",
7687 Vw32_rwindow_modifier,
7688 doc: /* Modifier to use for the right \"Windows\" key.
7689 The value can be hyper, super, meta, alt, control or shift for the
7690 respective modifier, or nil to appear as the `rwindow' key.
7691 Any other value will cause the key to be ignored. */);
7692 Vw32_rwindow_modifier = Qnil;
7694 DEFVAR_LISP ("w32-apps-modifier",
7695 Vw32_apps_modifier,
7696 doc: /* Modifier to use for the \"Apps\" key.
7697 The value can be hyper, super, meta, alt, control or shift for the
7698 respective modifier, or nil to appear as the `apps' key.
7699 Any other value will cause the key to be ignored. */);
7700 Vw32_apps_modifier = Qnil;
7702 DEFVAR_BOOL ("w32-enable-synthesized-fonts", w32_enable_synthesized_fonts,
7703 doc: /* Non-nil enables selection of artificially italicized and bold fonts. */);
7704 w32_enable_synthesized_fonts = 0;
7706 DEFVAR_LISP ("w32-enable-palette", Vw32_enable_palette,
7707 doc: /* Non-nil enables Windows palette management to map colors exactly. */);
7708 Vw32_enable_palette = Qt;
7710 DEFVAR_INT ("w32-mouse-button-tolerance",
7711 w32_mouse_button_tolerance,
7712 doc: /* Analogue of double click interval for faking middle mouse events.
7713 The value is the minimum time in milliseconds that must elapse between
7714 left and right button down events before they are considered distinct events.
7715 If both mouse buttons are depressed within this interval, a middle mouse
7716 button down event is generated instead. */);
7717 w32_mouse_button_tolerance = GetDoubleClickTime () / 2;
7719 DEFVAR_INT ("w32-mouse-move-interval",
7720 w32_mouse_move_interval,
7721 doc: /* Minimum interval between mouse move events.
7722 The value is the minimum time in milliseconds that must elapse between
7723 successive mouse move (or scroll bar drag) events before they are
7724 reported as lisp events. */);
7725 w32_mouse_move_interval = 0;
7727 DEFVAR_BOOL ("w32-pass-extra-mouse-buttons-to-system",
7728 w32_pass_extra_mouse_buttons_to_system,
7729 doc: /* If non-nil, the fourth and fifth mouse buttons are passed to Windows.
7730 Recent versions of Windows support mice with up to five buttons.
7731 Since most applications don't support these extra buttons, most mouse
7732 drivers will allow you to map them to functions at the system level.
7733 If this variable is non-nil, Emacs will pass them on, allowing the
7734 system to handle them. */);
7735 w32_pass_extra_mouse_buttons_to_system = 0;
7737 DEFVAR_BOOL ("w32-pass-multimedia-buttons-to-system",
7738 w32_pass_multimedia_buttons_to_system,
7739 doc: /* If non-nil, media buttons are passed to Windows.
7740 Some modern keyboards contain buttons for controlling media players, web
7741 browsers and other applications. Generally these buttons are handled on a
7742 system wide basis, but by setting this to nil they are made available
7743 to Emacs for binding. Depending on your keyboard, additional keys that
7744 may be available are:
7746 browser-back, browser-forward, browser-refresh, browser-stop,
7747 browser-search, browser-favorites, browser-home,
7748 mail, mail-reply, mail-forward, mail-send,
7749 app-1, app-2,
7750 help, find, new, open, close, save, print, undo, redo, copy, cut, paste,
7751 spell-check, correction-list, toggle-dictate-command,
7752 media-next, media-previous, media-stop, media-play-pause, media-select,
7753 media-play, media-pause, media-record, media-fast-forward, media-rewind,
7754 media-channel-up, media-channel-down,
7755 volume-mute, volume-up, volume-down,
7756 mic-volume-mute, mic-volume-down, mic-volume-up, mic-toggle,
7757 bass-down, bass-boost, bass-up, treble-down, treble-up */);
7758 w32_pass_multimedia_buttons_to_system = 1;
7760 #if 0 /* TODO: Mouse cursor customization. */
7761 DEFVAR_LISP ("x-pointer-shape", Vx_pointer_shape,
7762 doc: /* The shape of the pointer when over text.
7763 Changing the value does not affect existing frames
7764 unless you set the mouse color. */);
7765 Vx_pointer_shape = Qnil;
7767 Vx_nontext_pointer_shape = Qnil;
7769 Vx_mode_pointer_shape = Qnil;
7771 DEFVAR_LISP ("x-hourglass-pointer-shape", Vx_hourglass_pointer_shape,
7772 doc: /* The shape of the pointer when Emacs is busy.
7773 This variable takes effect when you create a new frame
7774 or when you set the mouse color. */);
7775 Vx_hourglass_pointer_shape = Qnil;
7777 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
7778 Vx_sensitive_text_pointer_shape,
7779 doc: /* The shape of the pointer when over mouse-sensitive text.
7780 This variable takes effect when you create a new frame
7781 or when you set the mouse color. */);
7782 Vx_sensitive_text_pointer_shape = Qnil;
7784 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
7785 Vx_window_horizontal_drag_shape,
7786 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
7787 This variable takes effect when you create a new frame
7788 or when you set the mouse color. */);
7789 Vx_window_horizontal_drag_shape = Qnil;
7790 #endif
7792 DEFVAR_LISP ("x-cursor-fore-pixel", Vx_cursor_fore_pixel,
7793 doc: /* A string indicating the foreground color of the cursor box. */);
7794 Vx_cursor_fore_pixel = Qnil;
7796 DEFVAR_LISP ("x-max-tooltip-size", Vx_max_tooltip_size,
7797 doc: /* Maximum size for tooltips.
7798 Value is a pair (COLUMNS . ROWS). Text larger than this is clipped. */);
7799 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
7801 DEFVAR_LISP ("x-no-window-manager", Vx_no_window_manager,
7802 doc: /* Non-nil if no window manager is in use.
7803 Emacs doesn't try to figure this out; this is always nil
7804 unless you set it to something else. */);
7805 /* We don't have any way to find this out, so set it to nil
7806 and maybe the user would like to set it to t. */
7807 Vx_no_window_manager = Qnil;
7809 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
7810 Vx_pixel_size_width_font_regexp,
7811 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
7813 Since Emacs gets width of a font matching with this regexp from
7814 PIXEL_SIZE field of the name, font finding mechanism gets faster for
7815 such a font. This is especially effective for such large fonts as
7816 Chinese, Japanese, and Korean. */);
7817 Vx_pixel_size_width_font_regexp = Qnil;
7819 DEFVAR_LISP ("w32-bdf-filename-alist",
7820 Vw32_bdf_filename_alist,
7821 doc: /* List of bdf fonts and their corresponding filenames. */);
7822 Vw32_bdf_filename_alist = Qnil;
7824 DEFVAR_BOOL ("w32-strict-fontnames",
7825 w32_strict_fontnames,
7826 doc: /* Non-nil means only use fonts that are exact matches for those requested.
7827 Default is nil, which allows old fontnames that are not XLFD compliant,
7828 and allows third-party CJK display to work by specifying false charset
7829 fields to trick Emacs into translating to Big5, SJIS etc.
7830 Setting this to t will prevent wrong fonts being selected when
7831 fontsets are automatically created. */);
7832 w32_strict_fontnames = 0;
7834 DEFVAR_BOOL ("w32-strict-painting",
7835 w32_strict_painting,
7836 doc: /* Non-nil means use strict rules for repainting frames.
7837 Set this to nil to get the old behavior for repainting; this should
7838 only be necessary if the default setting causes problems. */);
7839 w32_strict_painting = 1;
7841 #if 0 /* TODO: Port to W32 */
7842 defsubr (&Sx_change_window_property);
7843 defsubr (&Sx_delete_window_property);
7844 defsubr (&Sx_window_property);
7845 #endif
7846 defsubr (&Sxw_display_color_p);
7847 defsubr (&Sx_display_grayscale_p);
7848 defsubr (&Sxw_color_defined_p);
7849 defsubr (&Sxw_color_values);
7850 defsubr (&Sx_server_max_request_size);
7851 defsubr (&Sx_server_vendor);
7852 defsubr (&Sx_server_version);
7853 defsubr (&Sx_display_pixel_width);
7854 defsubr (&Sx_display_pixel_height);
7855 defsubr (&Sx_display_mm_width);
7856 defsubr (&Sx_display_mm_height);
7857 defsubr (&Sx_display_screens);
7858 defsubr (&Sx_display_planes);
7859 defsubr (&Sx_display_color_cells);
7860 defsubr (&Sx_display_visual_class);
7861 defsubr (&Sx_display_backing_store);
7862 defsubr (&Sx_display_save_under);
7863 defsubr (&Sx_create_frame);
7864 defsubr (&Sx_open_connection);
7865 defsubr (&Sx_close_connection);
7866 defsubr (&Sx_display_list);
7867 defsubr (&Sx_synchronize);
7868 defsubr (&Sx_focus_frame);
7870 /* W32 specific functions */
7872 defsubr (&Sw32_define_rgb_color);
7873 defsubr (&Sw32_default_color_map);
7874 defsubr (&Sw32_display_monitor_attributes_list);
7875 defsubr (&Sw32_send_sys_command);
7876 defsubr (&Sw32_shell_execute);
7877 defsubr (&Sw32_register_hot_key);
7878 defsubr (&Sw32_unregister_hot_key);
7879 defsubr (&Sw32_registered_hot_keys);
7880 defsubr (&Sw32_reconstruct_hot_key);
7881 defsubr (&Sw32_toggle_lock_key);
7882 defsubr (&Sw32_window_exists_p);
7883 defsubr (&Sw32_battery_status);
7885 #ifdef WINDOWSNT
7886 defsubr (&Sfile_system_info);
7887 #endif
7889 defsubr (&Sdefault_printer_name);
7890 defsubr (&Sset_message_beep);
7892 hourglass_hwnd = NULL;
7894 defsubr (&Sx_show_tip);
7895 defsubr (&Sx_hide_tip);
7896 tip_timer = Qnil;
7897 staticpro (&tip_timer);
7898 tip_frame = Qnil;
7899 staticpro (&tip_frame);
7901 last_show_tip_args = Qnil;
7902 staticpro (&last_show_tip_args);
7904 defsubr (&Sx_file_dialog);
7905 #ifdef WINDOWSNT
7906 defsubr (&Ssystem_move_file_to_trash);
7907 #endif
7912 globals_of_w32fns is used to initialize those global variables that
7913 must always be initialized on startup even when the global variable
7914 initialized is non zero (see the function main in emacs.c).
7915 globals_of_w32fns is called from syms_of_w32fns when the global
7916 variable initialized is 0 and directly from main when initialized
7917 is non zero.
7919 void
7920 globals_of_w32fns (void)
7922 HMODULE user32_lib = GetModuleHandle ("user32.dll");
7924 TrackMouseEvent not available in all versions of Windows, so must load
7925 it dynamically. Do it once, here, instead of every time it is used.
7927 track_mouse_event_fn = (TrackMouseEvent_Proc)
7928 GetProcAddress (user32_lib, "TrackMouseEvent");
7930 monitor_from_point_fn = (MonitorFromPoint_Proc)
7931 GetProcAddress (user32_lib, "MonitorFromPoint");
7932 get_monitor_info_fn = (GetMonitorInfo_Proc)
7933 GetProcAddress (user32_lib, "GetMonitorInfoA");
7934 monitor_from_window_fn = (MonitorFromWindow_Proc)
7935 GetProcAddress (user32_lib, "MonitorFromWindow");
7936 enum_display_monitors_fn = (EnumDisplayMonitors_Proc)
7937 GetProcAddress (user32_lib, "EnumDisplayMonitors");
7940 HMODULE imm32_lib = GetModuleHandle ("imm32.dll");
7941 get_composition_string_fn = (ImmGetCompositionString_Proc)
7942 GetProcAddress (imm32_lib, "ImmGetCompositionStringW");
7943 get_ime_context_fn = (ImmGetContext_Proc)
7944 GetProcAddress (imm32_lib, "ImmGetContext");
7945 release_ime_context_fn = (ImmReleaseContext_Proc)
7946 GetProcAddress (imm32_lib, "ImmReleaseContext");
7947 set_ime_composition_window_fn = (ImmSetCompositionWindow_Proc)
7948 GetProcAddress (imm32_lib, "ImmSetCompositionWindow");
7950 DEFVAR_INT ("w32-ansi-code-page",
7951 w32_ansi_code_page,
7952 doc: /* The ANSI code page used by the system. */);
7953 w32_ansi_code_page = GetACP ();
7955 if (os_subtype == OS_NT)
7956 w32_unicode_gui = 1;
7957 else
7958 w32_unicode_gui = 0;
7960 /* MessageBox does not work without this when linked to comctl32.dll 6.0. */
7961 InitCommonControls ();
7963 syms_of_w32uniscribe ();
7966 typedef USHORT (WINAPI * CaptureStackBackTrace_proc) (ULONG, ULONG, PVOID *,
7967 PULONG);
7969 #define BACKTRACE_LIMIT_MAX 62
7972 w32_backtrace (void **buffer, int limit)
7974 static CaptureStackBackTrace_proc s_pfn_CaptureStackBackTrace = NULL;
7975 HMODULE hm_kernel32 = NULL;
7977 if (!s_pfn_CaptureStackBackTrace)
7979 hm_kernel32 = LoadLibrary ("Kernel32.dll");
7980 s_pfn_CaptureStackBackTrace =
7981 (CaptureStackBackTrace_proc) GetProcAddress (hm_kernel32,
7982 "RtlCaptureStackBackTrace");
7984 if (s_pfn_CaptureStackBackTrace)
7985 return s_pfn_CaptureStackBackTrace (0, min (BACKTRACE_LIMIT_MAX, limit),
7986 buffer, NULL);
7987 return 0;
7990 void
7991 emacs_abort (void)
7993 int button;
7994 button = MessageBox (NULL,
7995 "A fatal error has occurred!\n\n"
7996 "Would you like to attach a debugger?\n\n"
7997 "Select:\n"
7998 "YES -- to debug Emacs, or\n"
7999 "NO -- to abort Emacs and produce a backtrace\n"
8000 " (emacs_backtrace.txt in current directory)."
8001 #if __GNUC__
8002 "\n\n(type \"gdb -p <emacs-PID>\" and\n"
8003 "\"continue\" inside GDB before clicking YES.)"
8004 #endif
8005 , "Emacs Abort Dialog",
8006 MB_ICONEXCLAMATION | MB_TASKMODAL
8007 | MB_SETFOREGROUND | MB_YESNO);
8008 switch (button)
8010 case IDYES:
8011 DebugBreak ();
8012 exit (2); /* tell the compiler we will never return */
8013 case IDNO:
8014 default:
8016 void *stack[BACKTRACE_LIMIT_MAX + 1];
8017 int i = w32_backtrace (stack, BACKTRACE_LIMIT_MAX + 1);
8019 if (i)
8021 #ifdef CYGWIN
8022 int stderr_fd = 2;
8023 #else
8024 HANDLE errout = GetStdHandle (STD_ERROR_HANDLE);
8025 int stderr_fd = -1;
8026 #endif
8027 int errfile_fd = -1;
8028 int j;
8030 #ifndef CYGWIN
8031 if (errout && errout != INVALID_HANDLE_VALUE)
8032 stderr_fd = _open_osfhandle ((intptr_t)errout, O_APPEND | O_BINARY);
8033 #endif
8034 if (stderr_fd >= 0)
8035 write (stderr_fd, "\r\nBacktrace:\r\n", 14);
8036 #ifdef CYGWIN
8037 #define _open open
8038 #endif
8039 errfile_fd = _open ("emacs_backtrace.txt", O_RDWR | O_CREAT | O_BINARY, S_IREAD | S_IWRITE);
8040 if (errfile_fd >= 0)
8042 lseek (errfile_fd, 0L, SEEK_END);
8043 write (errfile_fd, "\r\nBacktrace:\r\n", 14);
8046 for (j = 0; j < i; j++)
8048 char buf[INT_BUFSIZE_BOUND (void *)];
8050 /* stack[] gives the return addresses, whereas we want
8051 the address of the call, so decrease each address
8052 by approximate size of 1 CALL instruction. */
8053 sprintf (buf, "0x%p\r\n", (char *)stack[j] - sizeof(void *));
8054 if (stderr_fd >= 0)
8055 write (stderr_fd, buf, strlen (buf));
8056 if (errfile_fd >= 0)
8057 write (errfile_fd, buf, strlen (buf));
8059 if (i == BACKTRACE_LIMIT_MAX)
8061 if (stderr_fd >= 0)
8062 write (stderr_fd, "...\r\n", 5);
8063 if (errfile_fd >= 0)
8064 write (errfile_fd, "...\r\n", 5);
8066 if (errfile_fd >= 0)
8067 close (errfile_fd);
8069 abort ();
8070 break;
8075 #ifdef NTGUI_UNICODE
8077 Lisp_Object
8078 ntgui_encode_system (Lisp_Object str)
8080 Lisp_Object encoded;
8081 to_unicode (str, &encoded);
8082 return encoded;
8085 #endif /* NTGUI_UNICODE */