* process.c (allocate_pty) [PTY_OPEN]: Set fd's FD_CLOEXEC flag.
[emacs.git] / src / w32fns.c
blobb8c445a3a360f8eee02b9dad7a0517f4020da313
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);
1533 void
1534 x_set_icon_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1536 int result;
1538 if (NILP (arg) && NILP (oldval))
1539 return;
1541 if (STRINGP (arg) && STRINGP (oldval)
1542 && EQ (Fstring_equal (oldval, arg), Qt))
1543 return;
1545 if (SYMBOLP (arg) && SYMBOLP (oldval) && EQ (arg, oldval))
1546 return;
1548 block_input ();
1550 result = x_bitmap_icon (f, arg);
1551 if (result)
1553 unblock_input ();
1554 error ("No icon window available");
1557 unblock_input ();
1560 void
1561 x_set_icon_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1563 if (STRINGP (arg))
1565 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1566 return;
1568 else if (!NILP (arg) || NILP (oldval))
1569 return;
1571 fset_icon_name (f, arg);
1573 #if 0
1574 if (f->output_data.w32->icon_bitmap != 0)
1575 return;
1577 block_input ();
1579 result = x_text_icon (f,
1580 SSDATA ((!NILP (f->icon_name)
1581 ? f->icon_name
1582 : !NILP (f->title)
1583 ? f->title
1584 : f->name)));
1586 if (result)
1588 unblock_input ();
1589 error ("No icon window available");
1592 /* If the window was unmapped (and its icon was mapped),
1593 the new icon is not mapped, so map the window in its stead. */
1594 if (FRAME_VISIBLE_P (f))
1596 #ifdef USE_X_TOOLKIT
1597 XtPopup (f->output_data.w32->widget, XtGrabNone);
1598 #endif
1599 XMapWindow (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f));
1602 XFlush (FRAME_W32_DISPLAY (f));
1603 unblock_input ();
1604 #endif
1608 void
1609 x_set_menu_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1611 int nlines;
1613 /* Right now, menu bars don't work properly in minibuf-only frames;
1614 most of the commands try to apply themselves to the minibuffer
1615 frame itself, and get an error because you can't switch buffers
1616 in or split the minibuffer window. */
1617 if (FRAME_MINIBUF_ONLY_P (f))
1618 return;
1620 if (INTEGERP (value))
1621 nlines = XINT (value);
1622 else
1623 nlines = 0;
1625 FRAME_MENU_BAR_LINES (f) = 0;
1626 if (nlines)
1627 FRAME_EXTERNAL_MENU_BAR (f) = 1;
1628 else
1630 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
1631 free_frame_menubar (f);
1632 FRAME_EXTERNAL_MENU_BAR (f) = 0;
1634 /* Adjust the frame size so that the client (text) dimensions
1635 remain the same. This depends on FRAME_EXTERNAL_MENU_BAR being
1636 set correctly. */
1637 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
1638 do_pending_window_change (0);
1640 adjust_glyphs (f);
1644 /* Set the number of lines used for the tool bar of frame F to VALUE.
1645 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
1646 is the old number of tool bar lines. This function changes the
1647 height of all windows on frame F to match the new tool bar height.
1648 The frame's height doesn't change. */
1650 void
1651 x_set_tool_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1653 int delta, nlines, root_height;
1654 Lisp_Object root_window;
1656 /* Treat tool bars like menu bars. */
1657 if (FRAME_MINIBUF_ONLY_P (f))
1658 return;
1660 /* Use VALUE only if an integer >= 0. */
1661 if (INTEGERP (value) && XINT (value) >= 0)
1662 nlines = XFASTINT (value);
1663 else
1664 nlines = 0;
1666 /* Make sure we redisplay all windows in this frame. */
1667 ++windows_or_buffers_changed;
1669 delta = nlines - FRAME_TOOL_BAR_LINES (f);
1671 /* Don't resize the tool-bar to more than we have room for. */
1672 root_window = FRAME_ROOT_WINDOW (f);
1673 root_height = WINDOW_TOTAL_LINES (XWINDOW (root_window));
1674 if (root_height - delta < 1)
1676 delta = root_height - 1;
1677 nlines = FRAME_TOOL_BAR_LINES (f) + delta;
1680 FRAME_TOOL_BAR_LINES (f) = nlines;
1681 resize_frame_windows (f, FRAME_LINES (f), 0);
1682 adjust_glyphs (f);
1684 /* We also have to make sure that the internal border at the top of
1685 the frame, below the menu bar or tool bar, is redrawn when the
1686 tool bar disappears. This is so because the internal border is
1687 below the tool bar if one is displayed, but is below the menu bar
1688 if there isn't a tool bar. The tool bar draws into the area
1689 below the menu bar. */
1690 if (FRAME_W32_WINDOW (f) && FRAME_TOOL_BAR_LINES (f) == 0)
1692 clear_frame (f);
1693 clear_current_matrices (f);
1696 /* If the tool bar gets smaller, the internal border below it
1697 has to be cleared. It was formerly part of the display
1698 of the larger tool bar, and updating windows won't clear it. */
1699 if (delta < 0)
1701 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1702 int width = FRAME_PIXEL_WIDTH (f);
1703 int y = nlines * FRAME_LINE_HEIGHT (f);
1705 block_input ();
1707 HDC hdc = get_frame_dc (f);
1708 w32_clear_area (f, hdc, 0, y, width, height);
1709 release_frame_dc (f, hdc);
1711 unblock_input ();
1713 if (WINDOWP (f->tool_bar_window))
1714 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1717 run_window_configuration_change_hook (f);
1722 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1723 w32_id_name.
1725 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1726 name; if NAME is a string, set F's name to NAME and set
1727 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1729 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1730 suggesting a new name, which lisp code should override; if
1731 F->explicit_name is set, ignore the new name; otherwise, set it. */
1733 void
1734 x_set_name (struct frame *f, Lisp_Object name, int explicit)
1736 /* Make sure that requests from lisp code override requests from
1737 Emacs redisplay code. */
1738 if (explicit)
1740 /* If we're switching from explicit to implicit, we had better
1741 update the mode lines and thereby update the title. */
1742 if (f->explicit_name && NILP (name))
1743 update_mode_lines = 1;
1745 f->explicit_name = ! NILP (name);
1747 else if (f->explicit_name)
1748 return;
1750 /* If NAME is nil, set the name to the w32_id_name. */
1751 if (NILP (name))
1753 /* Check for no change needed in this very common case
1754 before we do any consing. */
1755 if (!strcmp (FRAME_W32_DISPLAY_INFO (f)->w32_id_name,
1756 SDATA (f->name)))
1757 return;
1758 name = build_string (FRAME_W32_DISPLAY_INFO (f)->w32_id_name);
1760 else
1761 CHECK_STRING (name);
1763 /* Don't change the name if it's already NAME. */
1764 if (! NILP (Fstring_equal (name, f->name)))
1765 return;
1767 fset_name (f, name);
1769 /* For setting the frame title, the title parameter should override
1770 the name parameter. */
1771 if (! NILP (f->title))
1772 name = f->title;
1774 if (FRAME_W32_WINDOW (f))
1776 block_input ();
1777 GUI_FN (SetWindowText) (FRAME_W32_WINDOW (f),
1778 GUI_SDATA (GUI_ENCODE_SYSTEM (name)));
1779 unblock_input ();
1783 /* This function should be called when the user's lisp code has
1784 specified a name for the frame; the name will override any set by the
1785 redisplay code. */
1786 void
1787 x_explicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1789 x_set_name (f, arg, 1);
1792 /* This function should be called by Emacs redisplay code to set the
1793 name; names set this way will never override names set by the user's
1794 lisp code. */
1795 void
1796 x_implicitly_set_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1798 x_set_name (f, arg, 0);
1801 /* Change the title of frame F to NAME.
1802 If NAME is nil, use the frame name as the title. */
1804 void
1805 x_set_title (struct frame *f, Lisp_Object name, Lisp_Object old_name)
1807 /* Don't change the title if it's already NAME. */
1808 if (EQ (name, f->title))
1809 return;
1811 update_mode_lines = 1;
1813 fset_title (f, name);
1815 if (NILP (name))
1816 name = f->name;
1818 if (FRAME_W32_WINDOW (f))
1820 block_input ();
1821 GUI_FN (SetWindowText) (FRAME_W32_WINDOW (f),
1822 GUI_SDATA (GUI_ENCODE_SYSTEM (name)));
1823 unblock_input ();
1827 void
1828 x_set_scroll_bar_default_width (struct frame *f)
1830 int wid = FRAME_COLUMN_WIDTH (f);
1832 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = GetSystemMetrics (SM_CXVSCROLL);
1833 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) +
1834 wid - 1) / wid;
1838 /* Subroutines for creating a frame. */
1840 Cursor
1841 w32_load_cursor (LPCTSTR name)
1843 /* Try first to load cursor from application resource. */
1844 Cursor cursor = LoadImage ((HINSTANCE) GetModuleHandle (NULL),
1845 name, IMAGE_CURSOR, 0, 0,
1846 LR_DEFAULTCOLOR | LR_DEFAULTSIZE | LR_SHARED);
1847 if (!cursor)
1849 /* Then try to load a shared predefined cursor. */
1850 cursor = LoadImage (NULL, name, IMAGE_CURSOR, 0, 0,
1851 LR_DEFAULTCOLOR | LR_DEFAULTSIZE | LR_SHARED);
1853 return cursor;
1856 static LRESULT CALLBACK w32_wnd_proc (HWND, UINT, WPARAM, LPARAM);
1858 #define INIT_WINDOW_CLASS(WC) \
1859 (WC).style = CS_HREDRAW | CS_VREDRAW; \
1860 (WC).lpfnWndProc = (WNDPROC) w32_wnd_proc; \
1861 (WC).cbClsExtra = 0; \
1862 (WC).cbWndExtra = WND_EXTRA_BYTES; \
1863 (WC).hInstance = hinst; \
1864 (WC).hIcon = LoadIcon (hinst, EMACS_CLASS); \
1865 (WC).hCursor = w32_load_cursor (IDC_ARROW); \
1866 (WC).hbrBackground = NULL; \
1867 (WC).lpszMenuName = NULL; \
1869 static BOOL
1870 w32_init_class (HINSTANCE hinst)
1872 if (w32_unicode_gui)
1874 WNDCLASSW uwc;
1875 INIT_WINDOW_CLASS(uwc);
1876 uwc.lpszClassName = L"Emacs";
1878 return RegisterClassW (&uwc);
1880 else
1882 WNDCLASS wc;
1883 INIT_WINDOW_CLASS(wc);
1884 wc.lpszClassName = EMACS_CLASS;
1886 return RegisterClassA (&wc);
1890 static HWND
1891 w32_createscrollbar (struct frame *f, struct scroll_bar * bar)
1893 return (CreateWindow ("SCROLLBAR", "", SBS_VERT | WS_CHILD | WS_VISIBLE,
1894 /* Position and size of scroll bar. */
1895 XINT (bar->left) + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
1896 XINT (bar->top),
1897 XINT (bar->width) - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
1898 XINT (bar->height),
1899 FRAME_W32_WINDOW (f),
1900 NULL,
1901 hinst,
1902 NULL));
1905 static void
1906 w32_createwindow (struct frame *f)
1908 HWND hwnd;
1909 RECT rect;
1910 Lisp_Object top = Qunbound;
1911 Lisp_Object left = Qunbound;
1912 struct w32_display_info *dpyinfo = &one_w32_display_info;
1914 rect.left = rect.top = 0;
1915 rect.right = FRAME_PIXEL_WIDTH (f);
1916 rect.bottom = FRAME_PIXEL_HEIGHT (f);
1918 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
1919 FRAME_EXTERNAL_MENU_BAR (f));
1921 /* Do first time app init */
1923 w32_init_class (hinst);
1925 if (f->size_hint_flags & USPosition || f->size_hint_flags & PPosition)
1927 XSETINT (left, f->left_pos);
1928 XSETINT (top, f->top_pos);
1930 else if (EQ (left, Qunbound) && EQ (top, Qunbound))
1932 /* When called with RES_TYPE_NUMBER, w32_get_arg will return zero
1933 for anything that is not a number and is not Qunbound. */
1934 left = x_get_arg (dpyinfo, Qnil, Qleft, "left", "Left", RES_TYPE_NUMBER);
1935 top = x_get_arg (dpyinfo, Qnil, Qtop, "top", "Top", RES_TYPE_NUMBER);
1938 FRAME_W32_WINDOW (f) = hwnd
1939 = CreateWindow (EMACS_CLASS,
1940 f->namebuf,
1941 f->output_data.w32->dwStyle | WS_CLIPCHILDREN,
1942 EQ (left, Qunbound) ? CW_USEDEFAULT : XINT (left),
1943 EQ (top, Qunbound) ? CW_USEDEFAULT : XINT (top),
1944 rect.right - rect.left,
1945 rect.bottom - rect.top,
1946 NULL,
1947 NULL,
1948 hinst,
1949 NULL);
1951 if (hwnd)
1953 SetWindowLong (hwnd, WND_FONTWIDTH_INDEX, FRAME_COLUMN_WIDTH (f));
1954 SetWindowLong (hwnd, WND_LINEHEIGHT_INDEX, FRAME_LINE_HEIGHT (f));
1955 SetWindowLong (hwnd, WND_BORDER_INDEX, FRAME_INTERNAL_BORDER_WIDTH (f));
1956 SetWindowLong (hwnd, WND_SCROLLBAR_INDEX, f->scroll_bar_actual_width);
1957 SetWindowLong (hwnd, WND_BACKGROUND_INDEX, FRAME_BACKGROUND_PIXEL (f));
1959 /* Enable drag-n-drop. */
1960 DragAcceptFiles (hwnd, TRUE);
1962 /* Do this to discard the default setting specified by our parent. */
1963 ShowWindow (hwnd, SW_HIDE);
1965 /* Update frame positions. */
1966 GetWindowRect (hwnd, &rect);
1967 f->left_pos = rect.left;
1968 f->top_pos = rect.top;
1972 static void
1973 my_post_msg (W32Msg * wmsg, HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
1975 wmsg->msg.hwnd = hwnd;
1976 wmsg->msg.message = msg;
1977 wmsg->msg.wParam = wParam;
1978 wmsg->msg.lParam = lParam;
1979 wmsg->msg.time = GetMessageTime ();
1981 post_msg (wmsg);
1984 /* GetKeyState and MapVirtualKey on Windows 95 do not actually distinguish
1985 between left and right keys as advertised. We test for this
1986 support dynamically, and set a flag when the support is absent. If
1987 absent, we keep track of the left and right control and alt keys
1988 ourselves. This is particularly necessary on keyboards that rely
1989 upon the AltGr key, which is represented as having the left control
1990 and right alt keys pressed. For these keyboards, we need to know
1991 when the left alt key has been pressed in addition to the AltGr key
1992 so that we can properly support M-AltGr-key sequences (such as M-@
1993 on Swedish keyboards). */
1995 #define EMACS_LCONTROL 0
1996 #define EMACS_RCONTROL 1
1997 #define EMACS_LMENU 2
1998 #define EMACS_RMENU 3
2000 static int modifiers[4];
2001 static int modifiers_recorded;
2002 static int modifier_key_support_tested;
2004 static void
2005 test_modifier_support (unsigned int wparam)
2007 unsigned int l, r;
2009 if (wparam != VK_CONTROL && wparam != VK_MENU)
2010 return;
2011 if (wparam == VK_CONTROL)
2013 l = VK_LCONTROL;
2014 r = VK_RCONTROL;
2016 else
2018 l = VK_LMENU;
2019 r = VK_RMENU;
2021 if (!(GetKeyState (l) & 0x8000) && !(GetKeyState (r) & 0x8000))
2022 modifiers_recorded = 1;
2023 else
2024 modifiers_recorded = 0;
2025 modifier_key_support_tested = 1;
2028 static void
2029 record_keydown (unsigned int wparam, unsigned int lparam)
2031 int i;
2033 if (!modifier_key_support_tested)
2034 test_modifier_support (wparam);
2036 if ((wparam != VK_CONTROL && wparam != VK_MENU) || !modifiers_recorded)
2037 return;
2039 if (wparam == VK_CONTROL)
2040 i = (lparam & 0x1000000) ? EMACS_RCONTROL : EMACS_LCONTROL;
2041 else
2042 i = (lparam & 0x1000000) ? EMACS_RMENU : EMACS_LMENU;
2044 modifiers[i] = 1;
2047 static void
2048 record_keyup (unsigned int wparam, unsigned int lparam)
2050 int i;
2052 if ((wparam != VK_CONTROL && wparam != VK_MENU) || !modifiers_recorded)
2053 return;
2055 if (wparam == VK_CONTROL)
2056 i = (lparam & 0x1000000) ? EMACS_RCONTROL : EMACS_LCONTROL;
2057 else
2058 i = (lparam & 0x1000000) ? EMACS_RMENU : EMACS_LMENU;
2060 modifiers[i] = 0;
2063 /* Emacs can lose focus while a modifier key has been pressed. When
2064 it regains focus, be conservative and clear all modifiers since
2065 we cannot reconstruct the left and right modifier state. */
2066 static void
2067 reset_modifiers (void)
2069 SHORT ctrl, alt;
2071 if (GetFocus () == NULL)
2072 /* Emacs doesn't have keyboard focus. Do nothing. */
2073 return;
2075 ctrl = GetAsyncKeyState (VK_CONTROL);
2076 alt = GetAsyncKeyState (VK_MENU);
2078 if (!(ctrl & 0x08000))
2079 /* Clear any recorded control modifier state. */
2080 modifiers[EMACS_RCONTROL] = modifiers[EMACS_LCONTROL] = 0;
2082 if (!(alt & 0x08000))
2083 /* Clear any recorded alt modifier state. */
2084 modifiers[EMACS_RMENU] = modifiers[EMACS_LMENU] = 0;
2086 /* Update the state of all modifier keys, because modifiers used in
2087 hot-key combinations can get stuck on if Emacs loses focus as a
2088 result of a hot-key being pressed. */
2090 BYTE keystate[256];
2092 #define CURRENT_STATE(key) ((GetAsyncKeyState (key) & 0x8000) >> 8)
2094 GetKeyboardState (keystate);
2095 keystate[VK_SHIFT] = CURRENT_STATE (VK_SHIFT);
2096 keystate[VK_CONTROL] = CURRENT_STATE (VK_CONTROL);
2097 keystate[VK_LCONTROL] = CURRENT_STATE (VK_LCONTROL);
2098 keystate[VK_RCONTROL] = CURRENT_STATE (VK_RCONTROL);
2099 keystate[VK_MENU] = CURRENT_STATE (VK_MENU);
2100 keystate[VK_LMENU] = CURRENT_STATE (VK_LMENU);
2101 keystate[VK_RMENU] = CURRENT_STATE (VK_RMENU);
2102 keystate[VK_LWIN] = CURRENT_STATE (VK_LWIN);
2103 keystate[VK_RWIN] = CURRENT_STATE (VK_RWIN);
2104 keystate[VK_APPS] = CURRENT_STATE (VK_APPS);
2105 SetKeyboardState (keystate);
2109 /* Synchronize modifier state with what is reported with the current
2110 keystroke. Even if we cannot distinguish between left and right
2111 modifier keys, we know that, if no modifiers are set, then neither
2112 the left or right modifier should be set. */
2113 static void
2114 sync_modifiers (void)
2116 if (!modifiers_recorded)
2117 return;
2119 if (!(GetKeyState (VK_CONTROL) & 0x8000))
2120 modifiers[EMACS_RCONTROL] = modifiers[EMACS_LCONTROL] = 0;
2122 if (!(GetKeyState (VK_MENU) & 0x8000))
2123 modifiers[EMACS_RMENU] = modifiers[EMACS_LMENU] = 0;
2126 static int
2127 modifier_set (int vkey)
2129 /* Warning: The fact that VK_NUMLOCK is not treated as the other 2
2130 toggle keys is not an omission! If you want to add it, you will
2131 have to make changes in the default sub-case of the WM_KEYDOWN
2132 switch, because if the NUMLOCK modifier is set, the code there
2133 will directly convert any key that looks like an ASCII letter,
2134 and also downcase those that look like upper-case ASCII. */
2135 if (vkey == VK_CAPITAL)
2137 if (NILP (Vw32_enable_caps_lock))
2138 return 0;
2139 else
2140 return (GetKeyState (vkey) & 0x1);
2142 if (vkey == VK_SCROLL)
2144 if (NILP (Vw32_scroll_lock_modifier)
2145 /* w32-scroll-lock-modifier can be any non-nil value that is
2146 not one of the modifiers, in which case it shall be ignored. */
2147 || !( EQ (Vw32_scroll_lock_modifier, Qhyper)
2148 || EQ (Vw32_scroll_lock_modifier, Qsuper)
2149 || EQ (Vw32_scroll_lock_modifier, Qmeta)
2150 || EQ (Vw32_scroll_lock_modifier, Qalt)
2151 || EQ (Vw32_scroll_lock_modifier, Qcontrol)
2152 || EQ (Vw32_scroll_lock_modifier, Qshift)))
2153 return 0;
2154 else
2155 return (GetKeyState (vkey) & 0x1);
2158 if (!modifiers_recorded)
2159 return (GetKeyState (vkey) & 0x8000);
2161 switch (vkey)
2163 case VK_LCONTROL:
2164 return modifiers[EMACS_LCONTROL];
2165 case VK_RCONTROL:
2166 return modifiers[EMACS_RCONTROL];
2167 case VK_LMENU:
2168 return modifiers[EMACS_LMENU];
2169 case VK_RMENU:
2170 return modifiers[EMACS_RMENU];
2172 return (GetKeyState (vkey) & 0x8000);
2175 /* Convert between the modifier bits W32 uses and the modifier bits
2176 Emacs uses. */
2178 unsigned int
2179 w32_key_to_modifier (int key)
2181 Lisp_Object key_mapping;
2183 switch (key)
2185 case VK_LWIN:
2186 key_mapping = Vw32_lwindow_modifier;
2187 break;
2188 case VK_RWIN:
2189 key_mapping = Vw32_rwindow_modifier;
2190 break;
2191 case VK_APPS:
2192 key_mapping = Vw32_apps_modifier;
2193 break;
2194 case VK_SCROLL:
2195 key_mapping = Vw32_scroll_lock_modifier;
2196 break;
2197 default:
2198 key_mapping = Qnil;
2201 /* NB. This code runs in the input thread, asynchronously to the lisp
2202 thread, so we must be careful to ensure access to lisp data is
2203 thread-safe. The following code is safe because the modifier
2204 variable values are updated atomically from lisp and symbols are
2205 not relocated by GC. Also, we don't have to worry about seeing GC
2206 markbits here. */
2207 if (EQ (key_mapping, Qhyper))
2208 return hyper_modifier;
2209 if (EQ (key_mapping, Qsuper))
2210 return super_modifier;
2211 if (EQ (key_mapping, Qmeta))
2212 return meta_modifier;
2213 if (EQ (key_mapping, Qalt))
2214 return alt_modifier;
2215 if (EQ (key_mapping, Qctrl))
2216 return ctrl_modifier;
2217 if (EQ (key_mapping, Qcontrol)) /* synonym for ctrl */
2218 return ctrl_modifier;
2219 if (EQ (key_mapping, Qshift))
2220 return shift_modifier;
2222 /* Don't generate any modifier if not explicitly requested. */
2223 return 0;
2226 static unsigned int
2227 w32_get_modifiers (void)
2229 return ((modifier_set (VK_SHIFT) ? shift_modifier : 0) |
2230 (modifier_set (VK_CONTROL) ? ctrl_modifier : 0) |
2231 (modifier_set (VK_LWIN) ? w32_key_to_modifier (VK_LWIN) : 0) |
2232 (modifier_set (VK_RWIN) ? w32_key_to_modifier (VK_RWIN) : 0) |
2233 (modifier_set (VK_APPS) ? w32_key_to_modifier (VK_APPS) : 0) |
2234 (modifier_set (VK_SCROLL) ? w32_key_to_modifier (VK_SCROLL) : 0) |
2235 (modifier_set (VK_MENU) ?
2236 ((NILP (Vw32_alt_is_meta)) ? alt_modifier : meta_modifier) : 0));
2239 /* We map the VK_* modifiers into console modifier constants
2240 so that we can use the same routines to handle both console
2241 and window input. */
2243 static int
2244 construct_console_modifiers (void)
2246 int mods;
2248 mods = 0;
2249 mods |= (modifier_set (VK_SHIFT)) ? SHIFT_PRESSED : 0;
2250 mods |= (modifier_set (VK_CAPITAL)) ? CAPSLOCK_ON : 0;
2251 mods |= (modifier_set (VK_SCROLL)) ? SCROLLLOCK_ON : 0;
2252 mods |= (modifier_set (VK_NUMLOCK)) ? NUMLOCK_ON : 0;
2253 mods |= (modifier_set (VK_LCONTROL)) ? LEFT_CTRL_PRESSED : 0;
2254 mods |= (modifier_set (VK_RCONTROL)) ? RIGHT_CTRL_PRESSED : 0;
2255 mods |= (modifier_set (VK_LMENU)) ? LEFT_ALT_PRESSED : 0;
2256 mods |= (modifier_set (VK_RMENU)) ? RIGHT_ALT_PRESSED : 0;
2257 mods |= (modifier_set (VK_LWIN)) ? LEFT_WIN_PRESSED : 0;
2258 mods |= (modifier_set (VK_RWIN)) ? RIGHT_WIN_PRESSED : 0;
2259 mods |= (modifier_set (VK_APPS)) ? APPS_PRESSED : 0;
2261 return mods;
2264 static int
2265 w32_get_key_modifiers (unsigned int wparam, unsigned int lparam)
2267 int mods;
2269 /* Convert to emacs modifiers. */
2270 mods = w32_kbd_mods_to_emacs (construct_console_modifiers (), wparam);
2272 return mods;
2275 unsigned int
2276 map_keypad_keys (unsigned int virt_key, unsigned int extended)
2278 if (virt_key < VK_CLEAR || virt_key > VK_DELETE)
2279 return virt_key;
2281 if (virt_key == VK_RETURN)
2282 return (extended ? VK_NUMPAD_ENTER : VK_RETURN);
2284 if (virt_key >= VK_PRIOR && virt_key <= VK_DOWN)
2285 return (!extended ? (VK_NUMPAD_PRIOR + (virt_key - VK_PRIOR)) : virt_key);
2287 if (virt_key == VK_INSERT || virt_key == VK_DELETE)
2288 return (!extended ? (VK_NUMPAD_INSERT + (virt_key - VK_INSERT)) : virt_key);
2290 if (virt_key == VK_CLEAR)
2291 return (!extended ? VK_NUMPAD_CLEAR : virt_key);
2293 return virt_key;
2296 /* List of special key combinations which w32 would normally capture,
2297 but Emacs should grab instead. Not directly visible to lisp, to
2298 simplify synchronization. Each item is an integer encoding a virtual
2299 key code and modifier combination to capture. */
2300 static Lisp_Object w32_grabbed_keys;
2302 #define HOTKEY(vk, mods) make_number (((vk) & 255) | ((mods) << 8))
2303 #define HOTKEY_ID(k) (XFASTINT (k) & 0xbfff)
2304 #define HOTKEY_VK_CODE(k) (XFASTINT (k) & 255)
2305 #define HOTKEY_MODIFIERS(k) (XFASTINT (k) >> 8)
2307 #define RAW_HOTKEY_ID(k) ((k) & 0xbfff)
2308 #define RAW_HOTKEY_VK_CODE(k) ((k) & 255)
2309 #define RAW_HOTKEY_MODIFIERS(k) ((k) >> 8)
2311 /* Register hot-keys for reserved key combinations when Emacs has
2312 keyboard focus, since this is the only way Emacs can receive key
2313 combinations like Alt-Tab which are used by the system. */
2315 static void
2316 register_hot_keys (HWND hwnd)
2318 Lisp_Object keylist;
2320 /* Use CONSP, since we are called asynchronously. */
2321 for (keylist = w32_grabbed_keys; CONSP (keylist); keylist = XCDR (keylist))
2323 Lisp_Object key = XCAR (keylist);
2325 /* Deleted entries get set to nil. */
2326 if (!INTEGERP (key))
2327 continue;
2329 RegisterHotKey (hwnd, HOTKEY_ID (key),
2330 HOTKEY_MODIFIERS (key), HOTKEY_VK_CODE (key));
2334 static void
2335 unregister_hot_keys (HWND hwnd)
2337 Lisp_Object keylist;
2339 for (keylist = w32_grabbed_keys; CONSP (keylist); keylist = XCDR (keylist))
2341 Lisp_Object key = XCAR (keylist);
2343 if (!INTEGERP (key))
2344 continue;
2346 UnregisterHotKey (hwnd, HOTKEY_ID (key));
2350 #if EMACSDEBUG
2351 const char*
2352 w32_name_of_message (UINT msg)
2354 unsigned i;
2355 static char buf[64];
2356 static const struct {
2357 UINT msg;
2358 const char* name;
2359 } msgnames[] = {
2360 #define M(msg) { msg, # msg }
2361 M (WM_PAINT),
2362 M (WM_TIMER),
2363 M (WM_USER),
2364 M (WM_MOUSEMOVE),
2365 M (WM_LBUTTONUP),
2366 M (WM_KEYDOWN),
2367 M (WM_EMACS_KILL),
2368 M (WM_EMACS_CREATEWINDOW),
2369 M (WM_EMACS_DONE),
2370 M (WM_EMACS_CREATESCROLLBAR),
2371 M (WM_EMACS_SHOWWINDOW),
2372 M (WM_EMACS_SETWINDOWPOS),
2373 M (WM_EMACS_DESTROYWINDOW),
2374 M (WM_EMACS_TRACKPOPUPMENU),
2375 M (WM_EMACS_SETFOCUS),
2376 M (WM_EMACS_SETFOREGROUND),
2377 M (WM_EMACS_SETLOCALE),
2378 M (WM_EMACS_SETKEYBOARDLAYOUT),
2379 M (WM_EMACS_REGISTER_HOT_KEY),
2380 M (WM_EMACS_UNREGISTER_HOT_KEY),
2381 M (WM_EMACS_TOGGLE_LOCK_KEY),
2382 M (WM_EMACS_TRACK_CARET),
2383 M (WM_EMACS_DESTROY_CARET),
2384 M (WM_EMACS_SHOW_CARET),
2385 M (WM_EMACS_HIDE_CARET),
2386 M (WM_EMACS_SETCURSOR),
2387 M (WM_EMACS_PAINT),
2388 M (WM_CHAR),
2389 #undef M
2390 { 0, 0 }
2393 for (i = 0; msgnames[i].name; ++i)
2394 if (msgnames[i].msg == msg)
2395 return msgnames[i].name;
2397 sprintf (buf, "message 0x%04x", (unsigned)msg);
2398 return buf;
2400 #endif /* EMACSDEBUG */
2402 /* Here's an overview of how Emacs input works in GUI sessions on
2403 MS-Windows. (For description of non-GUI input, see the commentary
2404 before w32_console_read_socket in w32inevt.c.)
2406 System messages are read and processed by w32_msg_pump below. This
2407 function runs in a separate thread. It handles a small number of
2408 custom WM_EMACS_* messages (posted by the main thread, look for
2409 PostMessage calls), and dispatches the rest to w32_wnd_proc, which
2410 is the main window procedure for the entire Emacs application.
2412 w32_wnd_proc also runs in the same separate input thread. It
2413 handles some messages, mostly those that need GDI calls, by itself.
2414 For the others, it calls my_post_msg, which inserts the messages
2415 into the input queue serviced by w32_read_socket.
2417 w32_read_socket runs in the main (a.k.a. "Lisp") thread, and is
2418 called synchronously from keyboard.c when it is known or suspected
2419 that some input is available. w32_read_socket either handles
2420 messages immediately, or converts them into Emacs input events and
2421 stuffs them into kbd_buffer, where kbd_buffer_get_event can get at
2422 them and process them when read_char and its callers require
2423 input.
2425 Under Cygwin with the W32 toolkit, the use of /dev/windows with
2426 select(2) takes the place of w32_read_socket.
2430 /* Main message dispatch loop. */
2432 static void
2433 w32_msg_pump (deferred_msg * msg_buf)
2435 MSG msg;
2436 WPARAM result;
2437 HWND focus_window;
2439 msh_mousewheel = RegisterWindowMessage (MSH_MOUSEWHEEL);
2441 while ((w32_unicode_gui ? GetMessageW : GetMessageA) (&msg, NULL, 0, 0))
2444 /* DebPrint (("w32_msg_pump: %s time:%u\n", */
2445 /* w32_name_of_message (msg.message), msg.time)); */
2447 if (msg.hwnd == NULL)
2449 switch (msg.message)
2451 case WM_NULL:
2452 /* Produced by complete_deferred_msg; just ignore. */
2453 break;
2454 case WM_EMACS_CREATEWINDOW:
2455 /* Initialize COM for this window. Even though we don't use it,
2456 some third party shell extensions can cause it to be used in
2457 system dialogs, which causes a crash if it is not initialized.
2458 This is a known bug in Windows, which was fixed long ago, but
2459 the patch for XP is not publicly available until XP SP3,
2460 and older versions will never be patched. */
2461 CoInitialize (NULL);
2462 w32_createwindow ((struct frame *) msg.wParam);
2463 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
2464 emacs_abort ();
2465 break;
2466 case WM_EMACS_SETLOCALE:
2467 SetThreadLocale (msg.wParam);
2468 /* Reply is not expected. */
2469 break;
2470 case WM_EMACS_SETKEYBOARDLAYOUT:
2471 result = (WPARAM) ActivateKeyboardLayout ((HKL) msg.wParam, 0);
2472 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE,
2473 result, 0))
2474 emacs_abort ();
2475 break;
2476 case WM_EMACS_REGISTER_HOT_KEY:
2477 focus_window = GetFocus ();
2478 if (focus_window != NULL)
2479 RegisterHotKey (focus_window,
2480 RAW_HOTKEY_ID (msg.wParam),
2481 RAW_HOTKEY_MODIFIERS (msg.wParam),
2482 RAW_HOTKEY_VK_CODE (msg.wParam));
2483 /* Reply is not expected. */
2484 break;
2485 case WM_EMACS_UNREGISTER_HOT_KEY:
2486 focus_window = GetFocus ();
2487 if (focus_window != NULL)
2488 UnregisterHotKey (focus_window, RAW_HOTKEY_ID (msg.wParam));
2489 /* Mark item as erased. NB: this code must be
2490 thread-safe. The next line is okay because the cons
2491 cell is never made into garbage and is not relocated by
2492 GC. */
2493 XSETCAR (XIL ((EMACS_INT) msg.lParam), Qnil);
2494 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
2495 emacs_abort ();
2496 break;
2497 case WM_EMACS_TOGGLE_LOCK_KEY:
2499 int vk_code = (int) msg.wParam;
2500 int cur_state = (GetKeyState (vk_code) & 1);
2501 Lisp_Object new_state = XIL ((EMACS_INT) msg.lParam);
2503 /* NB: This code must be thread-safe. It is safe to
2504 call NILP because symbols are not relocated by GC,
2505 and pointer here is not touched by GC (so the markbit
2506 can't be set). Numbers are safe because they are
2507 immediate values. */
2508 if (NILP (new_state)
2509 || (NUMBERP (new_state)
2510 && ((XUINT (new_state)) & 1) != cur_state))
2512 one_w32_display_info.faked_key = vk_code;
2514 keybd_event ((BYTE) vk_code,
2515 (BYTE) MapVirtualKey (vk_code, 0),
2516 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
2517 keybd_event ((BYTE) vk_code,
2518 (BYTE) MapVirtualKey (vk_code, 0),
2519 KEYEVENTF_EXTENDEDKEY | 0, 0);
2520 keybd_event ((BYTE) vk_code,
2521 (BYTE) MapVirtualKey (vk_code, 0),
2522 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
2523 cur_state = !cur_state;
2525 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE,
2526 cur_state, 0))
2527 emacs_abort ();
2529 break;
2530 #ifdef MSG_DEBUG
2531 /* Broadcast messages make it here, so you need to be looking
2532 for something in particular for this to be useful. */
2533 default:
2534 DebPrint (("msg %x not expected by w32_msg_pump\n", msg.message));
2535 #endif
2538 else
2540 if (w32_unicode_gui)
2541 DispatchMessageW (&msg);
2542 else
2543 DispatchMessageA (&msg);
2546 /* Exit nested loop when our deferred message has completed. */
2547 if (msg_buf->completed)
2548 break;
2552 deferred_msg * deferred_msg_head;
2554 static deferred_msg *
2555 find_deferred_msg (HWND hwnd, UINT msg)
2557 deferred_msg * item;
2559 /* Don't actually need synchronization for read access, since
2560 modification of single pointer is always atomic. */
2561 /* enter_crit (); */
2563 for (item = deferred_msg_head; item != NULL; item = item->next)
2564 if (item->w32msg.msg.hwnd == hwnd
2565 && item->w32msg.msg.message == msg)
2566 break;
2568 /* leave_crit (); */
2570 return item;
2573 static LRESULT
2574 send_deferred_msg (deferred_msg * msg_buf,
2575 HWND hwnd,
2576 UINT msg,
2577 WPARAM wParam,
2578 LPARAM lParam)
2580 /* Only input thread can send deferred messages. */
2581 if (GetCurrentThreadId () != dwWindowsThreadId)
2582 emacs_abort ();
2584 /* It is an error to send a message that is already deferred. */
2585 if (find_deferred_msg (hwnd, msg) != NULL)
2586 emacs_abort ();
2588 /* Enforced synchronization is not needed because this is the only
2589 function that alters deferred_msg_head, and the following critical
2590 section is guaranteed to only be serially reentered (since only the
2591 input thread can call us). */
2593 /* enter_crit (); */
2595 msg_buf->completed = 0;
2596 msg_buf->next = deferred_msg_head;
2597 deferred_msg_head = msg_buf;
2598 my_post_msg (&msg_buf->w32msg, hwnd, msg, wParam, lParam);
2600 /* leave_crit (); */
2602 /* Start a new nested message loop to process other messages until
2603 this one is completed. */
2604 w32_msg_pump (msg_buf);
2606 deferred_msg_head = msg_buf->next;
2608 return msg_buf->result;
2611 void
2612 complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result)
2614 deferred_msg * msg_buf = find_deferred_msg (hwnd, msg);
2616 if (msg_buf == NULL)
2617 /* Message may have been canceled, so don't abort. */
2618 return;
2620 msg_buf->result = result;
2621 msg_buf->completed = 1;
2623 /* Ensure input thread is woken so it notices the completion. */
2624 PostThreadMessage (dwWindowsThreadId, WM_NULL, 0, 0);
2627 static void
2628 cancel_all_deferred_msgs (void)
2630 deferred_msg * item;
2632 /* Don't actually need synchronization for read access, since
2633 modification of single pointer is always atomic. */
2634 /* enter_crit (); */
2636 for (item = deferred_msg_head; item != NULL; item = item->next)
2638 item->result = 0;
2639 item->completed = 1;
2642 /* leave_crit (); */
2644 /* Ensure input thread is woken so it notices the completion. */
2645 PostThreadMessage (dwWindowsThreadId, WM_NULL, 0, 0);
2648 DWORD WINAPI
2649 w32_msg_worker (void *arg)
2651 MSG msg;
2652 deferred_msg dummy_buf;
2654 /* Ensure our message queue is created */
2656 PeekMessage (&msg, NULL, 0, 0, PM_NOREMOVE);
2658 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
2659 emacs_abort ();
2661 memset (&dummy_buf, 0, sizeof (dummy_buf));
2662 dummy_buf.w32msg.msg.hwnd = NULL;
2663 dummy_buf.w32msg.msg.message = WM_NULL;
2665 /* This is the initial message loop which should only exit when the
2666 application quits. */
2667 w32_msg_pump (&dummy_buf);
2669 return 0;
2672 static void
2673 signal_user_input (void)
2675 /* Interrupt any lisp that wants to be interrupted by input. */
2676 if (!NILP (Vthrow_on_input))
2678 Vquit_flag = Vthrow_on_input;
2679 /* Doing a QUIT from this thread is a bad idea, since this
2680 unwinds the stack of the Lisp thread, and the Windows runtime
2681 rightfully barfs. Disabled. */
2682 #if 0
2683 /* If we're inside a function that wants immediate quits,
2684 do it now. */
2685 if (immediate_quit && NILP (Vinhibit_quit))
2687 immediate_quit = 0;
2688 QUIT;
2690 #endif
2695 static void
2696 post_character_message (HWND hwnd, UINT msg,
2697 WPARAM wParam, LPARAM lParam,
2698 DWORD modifiers)
2700 W32Msg wmsg;
2702 wmsg.dwModifiers = modifiers;
2704 /* Detect quit_char and set quit-flag directly. Note that we
2705 still need to post a message to ensure the main thread will be
2706 woken up if blocked in sys_select, but we do NOT want to post
2707 the quit_char message itself (because it will usually be as if
2708 the user had typed quit_char twice). Instead, we post a dummy
2709 message that has no particular effect. */
2711 int c = wParam;
2712 if (isalpha (c) && wmsg.dwModifiers == ctrl_modifier)
2713 c = make_ctrl_char (c) & 0377;
2714 if (c == quit_char
2715 || (wmsg.dwModifiers == 0
2716 && w32_quit_key && wParam == w32_quit_key))
2718 Vquit_flag = Qt;
2720 /* The choice of message is somewhat arbitrary, as long as
2721 the main thread handler just ignores it. */
2722 msg = WM_NULL;
2724 /* Interrupt any blocking system calls. */
2725 signal_quit ();
2727 /* As a safety precaution, forcibly complete any deferred
2728 messages. This is a kludge, but I don't see any particularly
2729 clean way to handle the situation where a deferred message is
2730 "dropped" in the lisp thread, and will thus never be
2731 completed, eg. by the user trying to activate the menubar
2732 when the lisp thread is busy, and then typing C-g when the
2733 menubar doesn't open promptly (with the result that the
2734 menubar never responds at all because the deferred
2735 WM_INITMENU message is never completed). Another problem
2736 situation is when the lisp thread calls SendMessage (to send
2737 a window manager command) when a message has been deferred;
2738 the lisp thread gets blocked indefinitely waiting for the
2739 deferred message to be completed, which itself is waiting for
2740 the lisp thread to respond.
2742 Note that we don't want to block the input thread waiting for
2743 a response from the lisp thread (although that would at least
2744 solve the deadlock problem above), because we want to be able
2745 to receive C-g to interrupt the lisp thread. */
2746 cancel_all_deferred_msgs ();
2748 else
2749 signal_user_input ();
2752 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2755 /* Main window procedure */
2757 static LRESULT CALLBACK
2758 w32_wnd_proc (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
2760 struct frame *f;
2761 struct w32_display_info *dpyinfo = &one_w32_display_info;
2762 W32Msg wmsg;
2763 int windows_translate;
2764 int key;
2766 /* Note that it is okay to call x_window_to_frame, even though we are
2767 not running in the main lisp thread, because frame deletion
2768 requires the lisp thread to synchronize with this thread. Thus, if
2769 a frame struct is returned, it can be used without concern that the
2770 lisp thread might make it disappear while we are using it.
2772 NB. Walking the frame list in this thread is safe (as long as
2773 writes of Lisp_Object slots are atomic, which they are on Windows).
2774 Although delete-frame can destructively modify the frame list while
2775 we are walking it, a garbage collection cannot occur until after
2776 delete-frame has synchronized with this thread.
2778 It is also safe to use functions that make GDI calls, such as
2779 w32_clear_rect, because these functions must obtain a DC handle
2780 from the frame struct using get_frame_dc which is thread-aware. */
2782 switch (msg)
2784 case WM_ERASEBKGND:
2785 f = x_window_to_frame (dpyinfo, hwnd);
2786 if (f)
2788 HDC hdc = get_frame_dc (f);
2789 GetUpdateRect (hwnd, &wmsg.rect, FALSE);
2790 w32_clear_rect (f, hdc, &wmsg.rect);
2791 release_frame_dc (f, hdc);
2793 #if defined (W32_DEBUG_DISPLAY)
2794 DebPrint (("WM_ERASEBKGND (frame %p): erasing %d,%d-%d,%d\n",
2796 wmsg.rect.left, wmsg.rect.top,
2797 wmsg.rect.right, wmsg.rect.bottom));
2798 #endif /* W32_DEBUG_DISPLAY */
2800 return 1;
2801 case WM_PALETTECHANGED:
2802 /* ignore our own changes */
2803 if ((HWND)wParam != hwnd)
2805 f = x_window_to_frame (dpyinfo, hwnd);
2806 if (f)
2807 /* get_frame_dc will realize our palette and force all
2808 frames to be redrawn if needed. */
2809 release_frame_dc (f, get_frame_dc (f));
2811 return 0;
2812 case WM_PAINT:
2814 PAINTSTRUCT paintStruct;
2815 RECT update_rect;
2816 memset (&update_rect, 0, sizeof (update_rect));
2818 f = x_window_to_frame (dpyinfo, hwnd);
2819 if (f == 0)
2821 DebPrint (("WM_PAINT received for unknown window %p\n", hwnd));
2822 return 0;
2825 /* MSDN Docs say not to call BeginPaint if GetUpdateRect
2826 fails. Apparently this can happen under some
2827 circumstances. */
2828 if (GetUpdateRect (hwnd, &update_rect, FALSE) || !w32_strict_painting)
2830 enter_crit ();
2831 BeginPaint (hwnd, &paintStruct);
2833 /* The rectangles returned by GetUpdateRect and BeginPaint
2834 do not always match. Play it safe by assuming both areas
2835 are invalid. */
2836 UnionRect (&(wmsg.rect), &update_rect, &(paintStruct.rcPaint));
2838 #if defined (W32_DEBUG_DISPLAY)
2839 DebPrint (("WM_PAINT (frame %p): painting %d,%d-%d,%d\n",
2841 wmsg.rect.left, wmsg.rect.top,
2842 wmsg.rect.right, wmsg.rect.bottom));
2843 DebPrint ((" [update region is %d,%d-%d,%d]\n",
2844 update_rect.left, update_rect.top,
2845 update_rect.right, update_rect.bottom));
2846 #endif
2847 EndPaint (hwnd, &paintStruct);
2848 leave_crit ();
2850 /* Change the message type to prevent Windows from
2851 combining WM_PAINT messages in the Lisp thread's queue,
2852 since Windows assumes that each message queue is
2853 dedicated to one frame and does not bother checking
2854 that hwnd matches before combining them. */
2855 my_post_msg (&wmsg, hwnd, WM_EMACS_PAINT, wParam, lParam);
2857 return 0;
2860 /* If GetUpdateRect returns 0 (meaning there is no update
2861 region), assume the whole window needs to be repainted. */
2862 GetClientRect (hwnd, &wmsg.rect);
2863 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2864 return 0;
2867 case WM_INPUTLANGCHANGE:
2868 /* Inform lisp thread of keyboard layout changes. */
2869 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2871 /* Clear dead keys in the keyboard state; for simplicity only
2872 preserve modifier key states. */
2874 int i;
2875 BYTE keystate[256];
2877 GetKeyboardState (keystate);
2878 for (i = 0; i < 256; i++)
2879 if (1
2880 && i != VK_SHIFT
2881 && i != VK_LSHIFT
2882 && i != VK_RSHIFT
2883 && i != VK_CAPITAL
2884 && i != VK_NUMLOCK
2885 && i != VK_SCROLL
2886 && i != VK_CONTROL
2887 && i != VK_LCONTROL
2888 && i != VK_RCONTROL
2889 && i != VK_MENU
2890 && i != VK_LMENU
2891 && i != VK_RMENU
2892 && i != VK_LWIN
2893 && i != VK_RWIN)
2894 keystate[i] = 0;
2895 SetKeyboardState (keystate);
2897 goto dflt;
2899 case WM_HOTKEY:
2900 /* Synchronize hot keys with normal input. */
2901 PostMessage (hwnd, WM_KEYDOWN, HIWORD (lParam), 0);
2902 return (0);
2904 case WM_KEYUP:
2905 case WM_SYSKEYUP:
2906 record_keyup (wParam, lParam);
2907 goto dflt;
2909 case WM_KEYDOWN:
2910 case WM_SYSKEYDOWN:
2911 /* Ignore keystrokes we fake ourself; see below. */
2912 if (dpyinfo->faked_key == wParam)
2914 dpyinfo->faked_key = 0;
2915 /* Make sure TranslateMessage sees them though (as long as
2916 they don't produce WM_CHAR messages). This ensures that
2917 indicator lights are toggled promptly on Windows 9x, for
2918 example. */
2919 if (wParam < 256 && lispy_function_keys[wParam])
2921 windows_translate = 1;
2922 goto translate;
2924 return 0;
2927 /* Synchronize modifiers with current keystroke. */
2928 sync_modifiers ();
2929 record_keydown (wParam, lParam);
2930 wParam = map_keypad_keys (wParam, (lParam & 0x1000000L) != 0);
2932 windows_translate = 0;
2934 switch (wParam)
2936 case VK_LWIN:
2937 if (NILP (Vw32_pass_lwindow_to_system))
2939 /* Prevent system from acting on keyup (which opens the
2940 Start menu if no other key was pressed) by simulating a
2941 press of Space which we will ignore. */
2942 if (GetAsyncKeyState (wParam) & 1)
2944 if (NUMBERP (Vw32_phantom_key_code))
2945 key = XUINT (Vw32_phantom_key_code) & 255;
2946 else
2947 key = VK_SPACE;
2948 dpyinfo->faked_key = key;
2949 keybd_event (key, (BYTE) MapVirtualKey (key, 0), 0, 0);
2952 if (!NILP (Vw32_lwindow_modifier))
2953 return 0;
2954 break;
2955 case VK_RWIN:
2956 if (NILP (Vw32_pass_rwindow_to_system))
2958 if (GetAsyncKeyState (wParam) & 1)
2960 if (NUMBERP (Vw32_phantom_key_code))
2961 key = XUINT (Vw32_phantom_key_code) & 255;
2962 else
2963 key = VK_SPACE;
2964 dpyinfo->faked_key = key;
2965 keybd_event (key, (BYTE) MapVirtualKey (key, 0), 0, 0);
2968 if (!NILP (Vw32_rwindow_modifier))
2969 return 0;
2970 break;
2971 case VK_APPS:
2972 if (!NILP (Vw32_apps_modifier))
2973 return 0;
2974 break;
2975 case VK_MENU:
2976 if (NILP (Vw32_pass_alt_to_system))
2977 /* Prevent DefWindowProc from activating the menu bar if an
2978 Alt key is pressed and released by itself. */
2979 return 0;
2980 windows_translate = 1;
2981 break;
2982 case VK_CAPITAL:
2983 /* Decide whether to treat as modifier or function key. */
2984 if (NILP (Vw32_enable_caps_lock))
2985 goto disable_lock_key;
2986 windows_translate = 1;
2987 break;
2988 case VK_NUMLOCK:
2989 /* Decide whether to treat as modifier or function key. */
2990 if (NILP (Vw32_enable_num_lock))
2991 goto disable_lock_key;
2992 windows_translate = 1;
2993 break;
2994 case VK_SCROLL:
2995 /* Decide whether to treat as modifier or function key. */
2996 if (NILP (Vw32_scroll_lock_modifier))
2997 goto disable_lock_key;
2998 windows_translate = 1;
2999 break;
3000 disable_lock_key:
3001 /* Ensure the appropriate lock key state (and indicator light)
3002 remains in the same state. We do this by faking another
3003 press of the relevant key. Apparently, this really is the
3004 only way to toggle the state of the indicator lights. */
3005 dpyinfo->faked_key = wParam;
3006 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3007 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
3008 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3009 KEYEVENTF_EXTENDEDKEY | 0, 0);
3010 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
3011 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
3012 /* Ensure indicator lights are updated promptly on Windows 9x
3013 (TranslateMessage apparently does this), after forwarding
3014 input event. */
3015 post_character_message (hwnd, msg, wParam, lParam,
3016 w32_get_key_modifiers (wParam, lParam));
3017 windows_translate = 1;
3018 break;
3019 case VK_CONTROL:
3020 case VK_SHIFT:
3021 case VK_PROCESSKEY: /* Generated by IME. */
3022 windows_translate = 1;
3023 break;
3024 case VK_CANCEL:
3025 /* Windows maps Ctrl-Pause (aka Ctrl-Break) into VK_CANCEL,
3026 which is confusing for purposes of key binding; convert
3027 VK_CANCEL events into VK_PAUSE events. */
3028 wParam = VK_PAUSE;
3029 break;
3030 case VK_PAUSE:
3031 /* Windows maps Ctrl-NumLock into VK_PAUSE, which is confusing
3032 for purposes of key binding; convert these back into
3033 VK_NUMLOCK events, at least when we want to see NumLock key
3034 presses. (Note that there is never any possibility that
3035 VK_PAUSE with Ctrl really is C-Pause as per above.) */
3036 if (NILP (Vw32_enable_num_lock) && modifier_set (VK_CONTROL))
3037 wParam = VK_NUMLOCK;
3038 break;
3039 default:
3040 /* If not defined as a function key, change it to a WM_CHAR message. */
3041 if (wParam > 255 || !lispy_function_keys[wParam])
3043 DWORD modifiers = construct_console_modifiers ();
3045 if (!NILP (Vw32_recognize_altgr)
3046 && modifier_set (VK_LCONTROL) && modifier_set (VK_RMENU))
3048 /* Always let TranslateMessage handle AltGr key chords;
3049 for some reason, ToAscii doesn't always process AltGr
3050 chords correctly. */
3051 windows_translate = 1;
3053 else if ((modifiers & (~SHIFT_PRESSED & ~CAPSLOCK_ON)) != 0)
3055 /* Handle key chords including any modifiers other
3056 than shift directly, in order to preserve as much
3057 modifier information as possible. */
3058 if ('A' <= wParam && wParam <= 'Z')
3060 /* Don't translate modified alphabetic keystrokes,
3061 so the user doesn't need to constantly switch
3062 layout to type control or meta keystrokes when
3063 the normal layout translates alphabetic
3064 characters to non-ascii characters. */
3065 if (!modifier_set (VK_SHIFT))
3066 wParam += ('a' - 'A');
3067 msg = WM_CHAR;
3069 else
3071 /* Try to handle other keystrokes by determining the
3072 base character (ie. translating the base key plus
3073 shift modifier). */
3074 int add;
3075 KEY_EVENT_RECORD key;
3077 key.bKeyDown = TRUE;
3078 key.wRepeatCount = 1;
3079 key.wVirtualKeyCode = wParam;
3080 key.wVirtualScanCode = (lParam & 0xFF0000) >> 16;
3081 key.uChar.AsciiChar = 0;
3082 key.dwControlKeyState = modifiers;
3084 add = w32_kbd_patch_key (&key, w32_keyboard_codepage);
3085 /* 0 means an unrecognized keycode, negative means
3086 dead key. Ignore both. */
3087 while (--add >= 0)
3089 /* Forward asciified character sequence. */
3090 post_character_message
3091 (hwnd, WM_CHAR,
3092 (unsigned char) key.uChar.AsciiChar, lParam,
3093 w32_get_key_modifiers (wParam, lParam));
3094 w32_kbd_patch_key (&key, w32_keyboard_codepage);
3096 return 0;
3099 else
3101 /* Let TranslateMessage handle everything else. */
3102 windows_translate = 1;
3107 translate:
3108 if (windows_translate)
3110 MSG windows_msg = { hwnd, msg, wParam, lParam, 0, {0,0} };
3111 windows_msg.time = GetMessageTime ();
3112 TranslateMessage (&windows_msg);
3113 goto dflt;
3116 /* Fall through */
3118 case WM_SYSCHAR:
3119 case WM_CHAR:
3120 if (wParam > 255 )
3122 W32Msg wmsg;
3124 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3125 signal_user_input ();
3126 my_post_msg (&wmsg, hwnd, WM_UNICHAR, wParam, lParam);
3129 else
3130 post_character_message (hwnd, msg, wParam, lParam,
3131 w32_get_key_modifiers (wParam, lParam));
3132 break;
3134 case WM_UNICHAR:
3135 /* WM_UNICHAR looks promising from the docs, but the exact
3136 circumstances in which TranslateMessage sends it is one of those
3137 Microsoft secret API things that EU and US courts are supposed
3138 to have put a stop to already. Spy++ shows it being sent to Notepad
3139 and other MS apps, but never to Emacs.
3141 Some third party IMEs send it in accordance with the official
3142 documentation though, so handle it here.
3144 UNICODE_NOCHAR is used to test for support for this message.
3145 TRUE indicates that the message is supported. */
3146 if (wParam == UNICODE_NOCHAR)
3147 return TRUE;
3150 W32Msg wmsg;
3151 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3152 signal_user_input ();
3153 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3155 break;
3157 case WM_IME_CHAR:
3158 /* If we can't get the IME result as Unicode, use default processing,
3159 which will at least allow characters decodable in the system locale
3160 get through. */
3161 if (!get_composition_string_fn)
3162 goto dflt;
3164 else if (!ignore_ime_char)
3166 wchar_t * buffer;
3167 int size, i;
3168 W32Msg wmsg;
3169 HIMC context = get_ime_context_fn (hwnd);
3170 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3171 /* Get buffer size. */
3172 size = get_composition_string_fn (context, GCS_RESULTSTR, NULL, 0);
3173 buffer = alloca (size);
3174 size = get_composition_string_fn (context, GCS_RESULTSTR,
3175 buffer, size);
3176 release_ime_context_fn (hwnd, context);
3178 signal_user_input ();
3179 for (i = 0; i < size / sizeof (wchar_t); i++)
3181 my_post_msg (&wmsg, hwnd, WM_UNICHAR, (WPARAM) buffer[i],
3182 lParam);
3184 /* Ignore the messages for the rest of the
3185 characters in the string that was output above. */
3186 ignore_ime_char = (size / sizeof (wchar_t)) - 1;
3188 else
3189 ignore_ime_char--;
3191 break;
3193 case WM_IME_STARTCOMPOSITION:
3194 if (!set_ime_composition_window_fn)
3195 goto dflt;
3196 else
3198 COMPOSITIONFORM form;
3199 HIMC context;
3200 struct window *w;
3202 /* Implementation note: The code below does something that
3203 one shouldn't do: it accesses the window object from a
3204 separate thread, while the main (a.k.a. "Lisp") thread
3205 runs and can legitimately delete and even GC it. That is
3206 why we are extra careful not to futz with a window that
3207 is different from the one recorded when the system caret
3208 coordinates were last modified. That is also why we are
3209 careful not to move the IME window if the window
3210 described by W was deleted, as indicated by its buffer
3211 field being reset to nil. */
3212 f = x_window_to_frame (dpyinfo, hwnd);
3213 if (!(f && FRAME_LIVE_P (f)))
3214 break;
3215 w = XWINDOW (FRAME_SELECTED_WINDOW (f));
3216 /* Punt if someone changed the frame's selected window
3217 behind our back. */
3218 if (w != w32_system_caret_window)
3219 break;
3221 form.dwStyle = CFS_RECT;
3222 form.ptCurrentPos.x = w32_system_caret_x;
3223 form.ptCurrentPos.y = w32_system_caret_y;
3225 form.rcArea.left = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, 0);
3226 form.rcArea.top = (WINDOW_TOP_EDGE_Y (w)
3227 + w32_system_caret_hdr_height);
3228 form.rcArea.right = (WINDOW_BOX_RIGHT_EDGE_X (w)
3229 - WINDOW_RIGHT_MARGIN_WIDTH (w)
3230 - WINDOW_RIGHT_FRINGE_WIDTH (w));
3231 form.rcArea.bottom = (WINDOW_BOTTOM_EDGE_Y (w)
3232 - w32_system_caret_mode_height);
3234 /* Punt if the window was deleted behind our back. */
3235 if (!BUFFERP (w->contents))
3236 break;
3238 context = get_ime_context_fn (hwnd);
3240 if (!context)
3241 break;
3243 set_ime_composition_window_fn (context, &form);
3244 release_ime_context_fn (hwnd, context);
3246 break;
3248 case WM_IME_ENDCOMPOSITION:
3249 ignore_ime_char = 0;
3250 goto dflt;
3252 /* Simulate middle mouse button events when left and right buttons
3253 are used together, but only if user has two button mouse. */
3254 case WM_LBUTTONDOWN:
3255 case WM_RBUTTONDOWN:
3256 if (w32_num_mouse_buttons > 2)
3257 goto handle_plain_button;
3260 int this = (msg == WM_LBUTTONDOWN) ? LMOUSE : RMOUSE;
3261 int other = (msg == WM_LBUTTONDOWN) ? RMOUSE : LMOUSE;
3263 if (button_state & this)
3264 return 0;
3266 if (button_state == 0)
3267 SetCapture (hwnd);
3269 button_state |= this;
3271 if (button_state & other)
3273 if (mouse_button_timer)
3275 KillTimer (hwnd, mouse_button_timer);
3276 mouse_button_timer = 0;
3278 /* Generate middle mouse event instead. */
3279 msg = WM_MBUTTONDOWN;
3280 button_state |= MMOUSE;
3282 else if (button_state & MMOUSE)
3284 /* Ignore button event if we've already generated a
3285 middle mouse down event. This happens if the
3286 user releases and press one of the two buttons
3287 after we've faked a middle mouse event. */
3288 return 0;
3290 else
3292 /* Flush out saved message. */
3293 post_msg (&saved_mouse_button_msg);
3295 wmsg.dwModifiers = w32_get_modifiers ();
3296 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3297 signal_user_input ();
3299 /* Clear message buffer. */
3300 saved_mouse_button_msg.msg.hwnd = 0;
3302 else
3304 /* Hold onto message for now. */
3305 mouse_button_timer =
3306 SetTimer (hwnd, MOUSE_BUTTON_ID,
3307 w32_mouse_button_tolerance, NULL);
3308 saved_mouse_button_msg.msg.hwnd = hwnd;
3309 saved_mouse_button_msg.msg.message = msg;
3310 saved_mouse_button_msg.msg.wParam = wParam;
3311 saved_mouse_button_msg.msg.lParam = lParam;
3312 saved_mouse_button_msg.msg.time = GetMessageTime ();
3313 saved_mouse_button_msg.dwModifiers = w32_get_modifiers ();
3316 return 0;
3318 case WM_LBUTTONUP:
3319 case WM_RBUTTONUP:
3320 if (w32_num_mouse_buttons > 2)
3321 goto handle_plain_button;
3324 int this = (msg == WM_LBUTTONUP) ? LMOUSE : RMOUSE;
3325 int other = (msg == WM_LBUTTONUP) ? RMOUSE : LMOUSE;
3327 if ((button_state & this) == 0)
3328 return 0;
3330 button_state &= ~this;
3332 if (button_state & MMOUSE)
3334 /* Only generate event when second button is released. */
3335 if ((button_state & other) == 0)
3337 msg = WM_MBUTTONUP;
3338 button_state &= ~MMOUSE;
3340 if (button_state) emacs_abort ();
3342 else
3343 return 0;
3345 else
3347 /* Flush out saved message if necessary. */
3348 if (saved_mouse_button_msg.msg.hwnd)
3350 post_msg (&saved_mouse_button_msg);
3353 wmsg.dwModifiers = w32_get_modifiers ();
3354 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3355 signal_user_input ();
3357 /* Always clear message buffer and cancel timer. */
3358 saved_mouse_button_msg.msg.hwnd = 0;
3359 KillTimer (hwnd, mouse_button_timer);
3360 mouse_button_timer = 0;
3362 if (button_state == 0)
3363 ReleaseCapture ();
3365 return 0;
3367 case WM_XBUTTONDOWN:
3368 case WM_XBUTTONUP:
3369 if (w32_pass_extra_mouse_buttons_to_system)
3370 goto dflt;
3371 /* else fall through and process them. */
3372 case WM_MBUTTONDOWN:
3373 case WM_MBUTTONUP:
3374 handle_plain_button:
3376 BOOL up;
3377 int button;
3379 /* Ignore middle and extra buttons as long as the menu is active. */
3380 f = x_window_to_frame (dpyinfo, hwnd);
3381 if (f && f->output_data.w32->menubar_active)
3382 return 0;
3384 if (parse_button (msg, HIWORD (wParam), &button, &up))
3386 if (up) ReleaseCapture ();
3387 else SetCapture (hwnd);
3388 button = (button == 0) ? LMOUSE :
3389 ((button == 1) ? MMOUSE : RMOUSE);
3390 if (up)
3391 button_state &= ~button;
3392 else
3393 button_state |= button;
3397 wmsg.dwModifiers = w32_get_modifiers ();
3398 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3399 signal_user_input ();
3401 /* Need to return true for XBUTTON messages, false for others,
3402 to indicate that we processed the message. */
3403 return (msg == WM_XBUTTONDOWN || msg == WM_XBUTTONUP);
3405 case WM_MOUSEMOVE:
3406 /* Ignore mouse movements as long as the menu is active. These
3407 movements are processed by the window manager anyway, and
3408 it's wrong to handle them as if they happened on the
3409 underlying frame. */
3410 f = x_window_to_frame (dpyinfo, hwnd);
3411 if (f && f->output_data.w32->menubar_active)
3412 return 0;
3414 /* If the mouse has just moved into the frame, start tracking
3415 it, so we will be notified when it leaves the frame. Mouse
3416 tracking only works under W98 and NT4 and later. On earlier
3417 versions, there is no way of telling when the mouse leaves the
3418 frame, so we just have to put up with help-echo and mouse
3419 highlighting remaining while the frame is not active. */
3420 if (track_mouse_event_fn && !track_mouse_window
3421 /* If the menu bar is active, turning on tracking of mouse
3422 movement events might send these events to the tooltip
3423 frame, if the user happens to move the mouse pointer over
3424 the tooltip. But since we don't process events for
3425 tooltip frames, this causes Windows to present a
3426 hourglass cursor, which is ugly and unexpected. So don't
3427 enable tracking mouse events in this case; they will be
3428 restarted when the menu pops down. (Confusingly, the
3429 menubar_active member of f->output_data.w32, tested
3430 above, is only set when a menu was popped up _not_ from
3431 the frame's menu bar, but via x-popup-menu.) */
3432 && !menubar_in_use)
3434 TRACKMOUSEEVENT tme;
3435 tme.cbSize = sizeof (tme);
3436 tme.dwFlags = TME_LEAVE;
3437 tme.hwndTrack = hwnd;
3439 track_mouse_event_fn (&tme);
3440 track_mouse_window = hwnd;
3442 case WM_VSCROLL:
3443 if (w32_mouse_move_interval <= 0
3444 || (msg == WM_MOUSEMOVE && button_state == 0))
3446 wmsg.dwModifiers = w32_get_modifiers ();
3447 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3448 return 0;
3451 /* Hang onto mouse move and scroll messages for a bit, to avoid
3452 sending such events to Emacs faster than it can process them.
3453 If we get more events before the timer from the first message
3454 expires, we just replace the first message. */
3456 if (saved_mouse_move_msg.msg.hwnd == 0)
3457 mouse_move_timer =
3458 SetTimer (hwnd, MOUSE_MOVE_ID,
3459 w32_mouse_move_interval, NULL);
3461 /* Hold onto message for now. */
3462 saved_mouse_move_msg.msg.hwnd = hwnd;
3463 saved_mouse_move_msg.msg.message = msg;
3464 saved_mouse_move_msg.msg.wParam = wParam;
3465 saved_mouse_move_msg.msg.lParam = lParam;
3466 saved_mouse_move_msg.msg.time = GetMessageTime ();
3467 saved_mouse_move_msg.dwModifiers = w32_get_modifiers ();
3469 return 0;
3471 case WM_MOUSEWHEEL:
3472 case WM_DROPFILES:
3473 wmsg.dwModifiers = w32_get_modifiers ();
3474 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3475 signal_user_input ();
3476 return 0;
3478 case WM_APPCOMMAND:
3479 if (w32_pass_multimedia_buttons_to_system)
3480 goto dflt;
3481 /* Otherwise, pass to lisp, the same way we do with mousehwheel. */
3482 case WM_MOUSEHWHEEL:
3483 wmsg.dwModifiers = w32_get_modifiers ();
3484 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3485 signal_user_input ();
3486 /* Non-zero must be returned when WM_MOUSEHWHEEL messages are
3487 handled, to prevent the system trying to handle it by faking
3488 scroll bar events. */
3489 return 1;
3491 case WM_TIMER:
3492 /* Flush out saved messages if necessary. */
3493 if (wParam == mouse_button_timer)
3495 if (saved_mouse_button_msg.msg.hwnd)
3497 post_msg (&saved_mouse_button_msg);
3498 signal_user_input ();
3499 saved_mouse_button_msg.msg.hwnd = 0;
3501 KillTimer (hwnd, mouse_button_timer);
3502 mouse_button_timer = 0;
3504 else if (wParam == mouse_move_timer)
3506 if (saved_mouse_move_msg.msg.hwnd)
3508 post_msg (&saved_mouse_move_msg);
3509 saved_mouse_move_msg.msg.hwnd = 0;
3511 KillTimer (hwnd, mouse_move_timer);
3512 mouse_move_timer = 0;
3514 else if (wParam == menu_free_timer)
3516 KillTimer (hwnd, menu_free_timer);
3517 menu_free_timer = 0;
3518 f = x_window_to_frame (dpyinfo, hwnd);
3519 /* If a popup menu is active, don't wipe its strings. */
3520 if (menubar_in_use
3521 && current_popup_menu == NULL)
3523 /* Free memory used by owner-drawn and help-echo strings. */
3524 w32_free_menu_strings (hwnd);
3525 if (f)
3526 f->output_data.w32->menubar_active = 0;
3527 menubar_in_use = 0;
3530 return 0;
3532 case WM_NCACTIVATE:
3533 /* Windows doesn't send us focus messages when putting up and
3534 taking down a system popup dialog as for Ctrl-Alt-Del on Windows 95.
3535 The only indication we get that something happened is receiving
3536 this message afterwards. So this is a good time to reset our
3537 keyboard modifiers' state. */
3538 reset_modifiers ();
3539 goto dflt;
3541 case WM_INITMENU:
3542 button_state = 0;
3543 ReleaseCapture ();
3544 /* We must ensure menu bar is fully constructed and up to date
3545 before allowing user interaction with it. To achieve this
3546 we send this message to the lisp thread and wait for a
3547 reply (whose value is not actually needed) to indicate that
3548 the menu bar is now ready for use, so we can now return.
3550 To remain responsive in the meantime, we enter a nested message
3551 loop that can process all other messages.
3553 However, we skip all this if the message results from calling
3554 TrackPopupMenu - in fact, we must NOT attempt to send the lisp
3555 thread a message because it is blocked on us at this point. We
3556 set menubar_active before calling TrackPopupMenu to indicate
3557 this (there is no possibility of confusion with real menubar
3558 being active). */
3560 f = x_window_to_frame (dpyinfo, hwnd);
3561 if (f
3562 && (f->output_data.w32->menubar_active
3563 /* We can receive this message even in the absence of a
3564 menubar (ie. when the system menu is activated) - in this
3565 case we do NOT want to forward the message, otherwise it
3566 will cause the menubar to suddenly appear when the user
3567 had requested it to be turned off! */
3568 || f->output_data.w32->menubar_widget == NULL))
3569 return 0;
3572 deferred_msg msg_buf;
3574 /* Detect if message has already been deferred; in this case
3575 we cannot return any sensible value to ignore this. */
3576 if (find_deferred_msg (hwnd, msg) != NULL)
3577 emacs_abort ();
3579 menubar_in_use = 1;
3581 return send_deferred_msg (&msg_buf, hwnd, msg, wParam, lParam);
3584 case WM_EXITMENULOOP:
3585 f = x_window_to_frame (dpyinfo, hwnd);
3587 /* If a menu is still active, check again after a short delay,
3588 since Windows often (always?) sends the WM_EXITMENULOOP
3589 before the corresponding WM_COMMAND message.
3590 Don't do this if a popup menu is active, since it is only
3591 menubar menus that require cleaning up in this way.
3593 if (f && menubar_in_use && current_popup_menu == NULL)
3594 menu_free_timer = SetTimer (hwnd, MENU_FREE_ID, MENU_FREE_DELAY, NULL);
3596 /* If hourglass cursor should be displayed, display it now. */
3597 if (f && f->output_data.w32->hourglass_p)
3598 SetCursor (f->output_data.w32->hourglass_cursor);
3600 goto dflt;
3602 case WM_MENUSELECT:
3603 /* Direct handling of help_echo in menus. Should be safe now
3604 that we generate the help_echo by placing a help event in the
3605 keyboard buffer. */
3607 HMENU menu = (HMENU) lParam;
3608 UINT menu_item = (UINT) LOWORD (wParam);
3609 UINT flags = (UINT) HIWORD (wParam);
3611 w32_menu_display_help (hwnd, menu, menu_item, flags);
3613 return 0;
3615 case WM_MEASUREITEM:
3616 f = x_window_to_frame (dpyinfo, hwnd);
3617 if (f)
3619 MEASUREITEMSTRUCT * pMis = (MEASUREITEMSTRUCT *) lParam;
3621 if (pMis->CtlType == ODT_MENU)
3623 /* Work out dimensions for popup menu titles. */
3624 char * title = (char *) pMis->itemData;
3625 HDC hdc = GetDC (hwnd);
3626 HFONT menu_font = GetCurrentObject (hdc, OBJ_FONT);
3627 LOGFONT menu_logfont;
3628 HFONT old_font;
3629 SIZE size;
3631 GetObject (menu_font, sizeof (menu_logfont), &menu_logfont);
3632 menu_logfont.lfWeight = FW_BOLD;
3633 menu_font = CreateFontIndirect (&menu_logfont);
3634 old_font = SelectObject (hdc, menu_font);
3636 pMis->itemHeight = GetSystemMetrics (SM_CYMENUSIZE);
3637 if (title)
3639 if (unicode_append_menu)
3640 GetTextExtentPoint32W (hdc, (WCHAR *) title,
3641 wcslen ((WCHAR *) title),
3642 &size);
3643 else
3644 GetTextExtentPoint32 (hdc, title, strlen (title), &size);
3646 pMis->itemWidth = size.cx;
3647 if (pMis->itemHeight < size.cy)
3648 pMis->itemHeight = size.cy;
3650 else
3651 pMis->itemWidth = 0;
3653 SelectObject (hdc, old_font);
3654 DeleteObject (menu_font);
3655 ReleaseDC (hwnd, hdc);
3656 return TRUE;
3659 return 0;
3661 case WM_DRAWITEM:
3662 f = x_window_to_frame (dpyinfo, hwnd);
3663 if (f)
3665 DRAWITEMSTRUCT * pDis = (DRAWITEMSTRUCT *) lParam;
3667 if (pDis->CtlType == ODT_MENU)
3669 /* Draw popup menu title. */
3670 char * title = (char *) pDis->itemData;
3671 if (title)
3673 HDC hdc = pDis->hDC;
3674 HFONT menu_font = GetCurrentObject (hdc, OBJ_FONT);
3675 LOGFONT menu_logfont;
3676 HFONT old_font;
3678 GetObject (menu_font, sizeof (menu_logfont), &menu_logfont);
3679 menu_logfont.lfWeight = FW_BOLD;
3680 menu_font = CreateFontIndirect (&menu_logfont);
3681 old_font = SelectObject (hdc, menu_font);
3683 /* Always draw title as if not selected. */
3684 if (unicode_append_menu)
3685 ExtTextOutW (hdc,
3686 pDis->rcItem.left
3687 + GetSystemMetrics (SM_CXMENUCHECK),
3688 pDis->rcItem.top,
3689 ETO_OPAQUE, &pDis->rcItem,
3690 (WCHAR *) title,
3691 wcslen ((WCHAR *) title), NULL);
3692 else
3693 ExtTextOut (hdc,
3694 pDis->rcItem.left
3695 + GetSystemMetrics (SM_CXMENUCHECK),
3696 pDis->rcItem.top,
3697 ETO_OPAQUE, &pDis->rcItem,
3698 title, strlen (title), NULL);
3700 SelectObject (hdc, old_font);
3701 DeleteObject (menu_font);
3703 return TRUE;
3706 return 0;
3708 #if 0
3709 /* Still not right - can't distinguish between clicks in the
3710 client area of the frame from clicks forwarded from the scroll
3711 bars - may have to hook WM_NCHITTEST to remember the mouse
3712 position and then check if it is in the client area ourselves. */
3713 case WM_MOUSEACTIVATE:
3714 /* Discard the mouse click that activates a frame, allowing the
3715 user to click anywhere without changing point (or worse!).
3716 Don't eat mouse clicks on scrollbars though!! */
3717 if (LOWORD (lParam) == HTCLIENT )
3718 return MA_ACTIVATEANDEAT;
3719 goto dflt;
3720 #endif
3722 case WM_MOUSELEAVE:
3723 /* No longer tracking mouse. */
3724 track_mouse_window = NULL;
3726 case WM_ACTIVATEAPP:
3727 case WM_ACTIVATE:
3728 case WM_WINDOWPOSCHANGED:
3729 case WM_SHOWWINDOW:
3730 /* Inform lisp thread that a frame might have just been obscured
3731 or exposed, so should recheck visibility of all frames. */
3732 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3733 goto dflt;
3735 case WM_SETFOCUS:
3736 dpyinfo->faked_key = 0;
3737 reset_modifiers ();
3738 register_hot_keys (hwnd);
3739 goto command;
3740 case WM_KILLFOCUS:
3741 unregister_hot_keys (hwnd);
3742 button_state = 0;
3743 ReleaseCapture ();
3744 /* Relinquish the system caret. */
3745 if (w32_system_caret_hwnd)
3747 w32_visible_system_caret_hwnd = NULL;
3748 w32_system_caret_hwnd = NULL;
3749 DestroyCaret ();
3751 goto command;
3752 case WM_COMMAND:
3753 menubar_in_use = 0;
3754 f = x_window_to_frame (dpyinfo, hwnd);
3755 if (f && HIWORD (wParam) == 0)
3757 if (menu_free_timer)
3759 KillTimer (hwnd, menu_free_timer);
3760 menu_free_timer = 0;
3763 case WM_MOVE:
3764 case WM_SIZE:
3765 command:
3766 wmsg.dwModifiers = w32_get_modifiers ();
3767 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3768 goto dflt;
3770 case WM_DESTROY:
3771 CoUninitialize ();
3772 return 0;
3774 case WM_CLOSE:
3775 wmsg.dwModifiers = w32_get_modifiers ();
3776 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3777 return 0;
3779 case WM_WINDOWPOSCHANGING:
3780 /* Don't restrict the sizing of tip frames. */
3781 if (hwnd == tip_window)
3782 return 0;
3784 /* Don't restrict the sizing of fullscreened frames, allowing them to be
3785 flush with the sides of the screen. */
3786 f = x_window_to_frame (dpyinfo, hwnd);
3787 if (f && FRAME_PREV_FSMODE (f) != FULLSCREEN_NONE)
3788 return 0;
3791 WINDOWPLACEMENT wp;
3792 LPWINDOWPOS lppos = (WINDOWPOS *) lParam;
3794 wp.length = sizeof (WINDOWPLACEMENT);
3795 GetWindowPlacement (hwnd, &wp);
3797 if (wp.showCmd != SW_SHOWMINIMIZED && (lppos->flags & SWP_NOSIZE) == 0)
3799 RECT rect;
3800 int wdiff;
3801 int hdiff;
3802 DWORD font_width;
3803 DWORD line_height;
3804 DWORD internal_border;
3805 DWORD scrollbar_extra;
3806 RECT wr;
3808 wp.length = sizeof (wp);
3809 GetWindowRect (hwnd, &wr);
3811 enter_crit ();
3813 font_width = GetWindowLong (hwnd, WND_FONTWIDTH_INDEX);
3814 line_height = GetWindowLong (hwnd, WND_LINEHEIGHT_INDEX);
3815 internal_border = GetWindowLong (hwnd, WND_BORDER_INDEX);
3816 scrollbar_extra = GetWindowLong (hwnd, WND_SCROLLBAR_INDEX);
3818 leave_crit ();
3820 memset (&rect, 0, sizeof (rect));
3821 AdjustWindowRect (&rect, GetWindowLong (hwnd, GWL_STYLE),
3822 GetMenu (hwnd) != NULL);
3824 /* Force width and height of client area to be exact
3825 multiples of the character cell dimensions. */
3826 wdiff = (lppos->cx - (rect.right - rect.left)
3827 - 2 * internal_border - scrollbar_extra)
3828 % font_width;
3829 hdiff = (lppos->cy - (rect.bottom - rect.top)
3830 - 2 * internal_border)
3831 % line_height;
3833 if (wdiff || hdiff)
3835 /* For right/bottom sizing we can just fix the sizes.
3836 However for top/left sizing we will need to fix the X
3837 and Y positions as well. */
3839 int cx_mintrack = GetSystemMetrics (SM_CXMINTRACK);
3840 int cy_mintrack = GetSystemMetrics (SM_CYMINTRACK);
3842 lppos->cx = max (lppos->cx - wdiff, cx_mintrack);
3843 lppos->cy = max (lppos->cy - hdiff, cy_mintrack);
3845 if (wp.showCmd != SW_SHOWMAXIMIZED
3846 && (lppos->flags & SWP_NOMOVE) == 0)
3848 if (lppos->x != wr.left || lppos->y != wr.top)
3850 lppos->x += wdiff;
3851 lppos->y += hdiff;
3853 else
3855 lppos->flags |= SWP_NOMOVE;
3859 return 0;
3864 goto dflt;
3866 case WM_GETMINMAXINFO:
3867 /* Hack to allow resizing the Emacs frame above the screen size.
3868 Note that Windows 9x limits coordinates to 16-bits. */
3869 ((LPMINMAXINFO) lParam)->ptMaxTrackSize.x = 32767;
3870 ((LPMINMAXINFO) lParam)->ptMaxTrackSize.y = 32767;
3871 return 0;
3873 case WM_SETCURSOR:
3874 if (LOWORD (lParam) == HTCLIENT)
3876 f = x_window_to_frame (dpyinfo, hwnd);
3877 if (f && f->output_data.w32->hourglass_p
3878 && !menubar_in_use && !current_popup_menu)
3879 SetCursor (f->output_data.w32->hourglass_cursor);
3880 else if (f)
3881 SetCursor (f->output_data.w32->current_cursor);
3882 return 0;
3884 goto dflt;
3886 case WM_EMACS_SETCURSOR:
3888 Cursor cursor = (Cursor) wParam;
3889 f = x_window_to_frame (dpyinfo, hwnd);
3890 if (f && cursor)
3892 f->output_data.w32->current_cursor = cursor;
3893 if (!f->output_data.w32->hourglass_p)
3894 SetCursor (cursor);
3896 return 0;
3899 case WM_EMACS_CREATESCROLLBAR:
3900 return (LRESULT) w32_createscrollbar ((struct frame *) wParam,
3901 (struct scroll_bar *) lParam);
3903 case WM_EMACS_SHOWWINDOW:
3904 return ShowWindow ((HWND) wParam, (WPARAM) lParam);
3906 case WM_EMACS_BRINGTOTOP:
3907 case WM_EMACS_SETFOREGROUND:
3909 HWND foreground_window;
3910 DWORD foreground_thread, retval;
3912 /* On NT 5.0, and apparently Windows 98, it is necessary to
3913 attach to the thread that currently has focus in order to
3914 pull the focus away from it. */
3915 foreground_window = GetForegroundWindow ();
3916 foreground_thread = GetWindowThreadProcessId (foreground_window, NULL);
3917 if (!foreground_window
3918 || foreground_thread == GetCurrentThreadId ()
3919 || !AttachThreadInput (GetCurrentThreadId (),
3920 foreground_thread, TRUE))
3921 foreground_thread = 0;
3923 retval = SetForegroundWindow ((HWND) wParam);
3924 if (msg == WM_EMACS_BRINGTOTOP)
3925 retval = BringWindowToTop ((HWND) wParam);
3927 /* Detach from the previous foreground thread. */
3928 if (foreground_thread)
3929 AttachThreadInput (GetCurrentThreadId (),
3930 foreground_thread, FALSE);
3932 return retval;
3935 case WM_EMACS_SETWINDOWPOS:
3937 WINDOWPOS * pos = (WINDOWPOS *) wParam;
3938 return SetWindowPos (hwnd, pos->hwndInsertAfter,
3939 pos->x, pos->y, pos->cx, pos->cy, pos->flags);
3942 case WM_EMACS_DESTROYWINDOW:
3943 DragAcceptFiles ((HWND) wParam, FALSE);
3944 return DestroyWindow ((HWND) wParam);
3946 case WM_EMACS_HIDE_CARET:
3947 return HideCaret (hwnd);
3949 case WM_EMACS_SHOW_CARET:
3950 return ShowCaret (hwnd);
3952 case WM_EMACS_DESTROY_CARET:
3953 w32_system_caret_hwnd = NULL;
3954 w32_visible_system_caret_hwnd = NULL;
3955 return DestroyCaret ();
3957 case WM_EMACS_TRACK_CARET:
3958 /* If there is currently no system caret, create one. */
3959 if (w32_system_caret_hwnd == NULL)
3961 /* Use the default caret width, and avoid changing it
3962 unnecessarily, as it confuses screen reader software. */
3963 w32_system_caret_hwnd = hwnd;
3964 CreateCaret (hwnd, NULL, 0,
3965 w32_system_caret_height);
3968 if (!SetCaretPos (w32_system_caret_x, w32_system_caret_y))
3969 return 0;
3970 /* Ensure visible caret gets turned on when requested. */
3971 else if (w32_use_visible_system_caret
3972 && w32_visible_system_caret_hwnd != hwnd)
3974 w32_visible_system_caret_hwnd = hwnd;
3975 return ShowCaret (hwnd);
3977 /* Ensure visible caret gets turned off when requested. */
3978 else if (!w32_use_visible_system_caret
3979 && w32_visible_system_caret_hwnd)
3981 w32_visible_system_caret_hwnd = NULL;
3982 return HideCaret (hwnd);
3984 else
3985 return 1;
3987 case WM_EMACS_TRACKPOPUPMENU:
3989 UINT flags;
3990 POINT *pos;
3991 int retval;
3992 pos = (POINT *)lParam;
3993 flags = TPM_CENTERALIGN;
3994 if (button_state & LMOUSE)
3995 flags |= TPM_LEFTBUTTON;
3996 else if (button_state & RMOUSE)
3997 flags |= TPM_RIGHTBUTTON;
3999 /* Remember we did a SetCapture on the initial mouse down event,
4000 so for safety, we make sure the capture is canceled now. */
4001 ReleaseCapture ();
4002 button_state = 0;
4004 /* Use menubar_active to indicate that WM_INITMENU is from
4005 TrackPopupMenu below, and should be ignored. */
4006 f = x_window_to_frame (dpyinfo, hwnd);
4007 if (f)
4008 f->output_data.w32->menubar_active = 1;
4010 if (TrackPopupMenu ((HMENU)wParam, flags, pos->x, pos->y,
4011 0, hwnd, NULL))
4013 MSG amsg;
4014 /* Eat any mouse messages during popupmenu */
4015 while (PeekMessage (&amsg, hwnd, WM_MOUSEFIRST, WM_MOUSELAST,
4016 PM_REMOVE));
4017 /* Get the menu selection, if any */
4018 if (PeekMessage (&amsg, hwnd, WM_COMMAND, WM_COMMAND, PM_REMOVE))
4020 retval = LOWORD (amsg.wParam);
4022 else
4024 retval = 0;
4027 else
4029 retval = -1;
4032 return retval;
4034 case WM_EMACS_FILENOTIFY:
4035 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4036 return 1;
4038 default:
4039 /* Check for messages registered at runtime. */
4040 if (msg == msh_mousewheel)
4042 wmsg.dwModifiers = w32_get_modifiers ();
4043 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
4044 signal_user_input ();
4045 return 0;
4048 dflt:
4049 return (w32_unicode_gui ? DefWindowProcW : DefWindowProcA) (hwnd, msg, wParam, lParam);
4052 /* The most common default return code for handled messages is 0. */
4053 return 0;
4056 static void
4057 my_create_window (struct frame * f)
4059 MSG msg;
4061 if (!PostThreadMessage (dwWindowsThreadId, WM_EMACS_CREATEWINDOW, (WPARAM)f, 0))
4062 emacs_abort ();
4063 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
4067 /* Create a tooltip window. Unlike my_create_window, we do not do this
4068 indirectly via the Window thread, as we do not need to process Window
4069 messages for the tooltip. Creating tooltips indirectly also creates
4070 deadlocks when tooltips are created for menu items. */
4071 static void
4072 my_create_tip_window (struct frame *f)
4074 RECT rect;
4076 rect.left = rect.top = 0;
4077 rect.right = FRAME_PIXEL_WIDTH (f);
4078 rect.bottom = FRAME_PIXEL_HEIGHT (f);
4080 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
4081 FRAME_EXTERNAL_MENU_BAR (f));
4083 tip_window = FRAME_W32_WINDOW (f)
4084 = CreateWindow (EMACS_CLASS,
4085 f->namebuf,
4086 f->output_data.w32->dwStyle,
4087 f->left_pos,
4088 f->top_pos,
4089 rect.right - rect.left,
4090 rect.bottom - rect.top,
4091 FRAME_W32_WINDOW (SELECTED_FRAME ()), /* owner */
4092 NULL,
4093 hinst,
4094 NULL);
4096 if (tip_window)
4098 SetWindowLong (tip_window, WND_FONTWIDTH_INDEX, FRAME_COLUMN_WIDTH (f));
4099 SetWindowLong (tip_window, WND_LINEHEIGHT_INDEX, FRAME_LINE_HEIGHT (f));
4100 SetWindowLong (tip_window, WND_BORDER_INDEX, FRAME_INTERNAL_BORDER_WIDTH (f));
4101 SetWindowLong (tip_window, WND_BACKGROUND_INDEX, FRAME_BACKGROUND_PIXEL (f));
4103 /* Tip frames have no scrollbars. */
4104 SetWindowLong (tip_window, WND_SCROLLBAR_INDEX, 0);
4106 /* Do this to discard the default setting specified by our parent. */
4107 ShowWindow (tip_window, SW_HIDE);
4112 /* Create and set up the w32 window for frame F. */
4114 static void
4115 w32_window (struct frame *f, long window_prompting, int minibuffer_only)
4117 block_input ();
4119 /* Use the resource name as the top-level window name
4120 for looking up resources. Make a non-Lisp copy
4121 for the window manager, so GC relocation won't bother it.
4123 Elsewhere we specify the window name for the window manager. */
4124 f->namebuf = xstrdup (SSDATA (Vx_resource_name));
4126 my_create_window (f);
4128 validate_x_resource_name ();
4130 /* x_set_name normally ignores requests to set the name if the
4131 requested name is the same as the current name. This is the one
4132 place where that assumption isn't correct; f->name is set, but
4133 the server hasn't been told. */
4135 Lisp_Object name;
4136 int explicit = f->explicit_name;
4138 f->explicit_name = 0;
4139 name = f->name;
4140 fset_name (f, Qnil);
4141 x_set_name (f, name, explicit);
4144 unblock_input ();
4146 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
4147 initialize_frame_menubar (f);
4149 if (FRAME_W32_WINDOW (f) == 0)
4150 error ("Unable to create window");
4153 /* Handle the icon stuff for this window. Perhaps later we might
4154 want an x_set_icon_position which can be called interactively as
4155 well. */
4157 static void
4158 x_icon (struct frame *f, Lisp_Object parms)
4160 Lisp_Object icon_x, icon_y;
4161 struct w32_display_info *dpyinfo = &one_w32_display_info;
4163 /* Set the position of the icon. Note that Windows 95 groups all
4164 icons in the tray. */
4165 icon_x = x_get_arg (dpyinfo, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
4166 icon_y = x_get_arg (dpyinfo, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
4167 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
4169 CHECK_NUMBER (icon_x);
4170 CHECK_NUMBER (icon_y);
4172 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
4173 error ("Both left and top icon corners of icon must be specified");
4175 block_input ();
4177 #if 0 /* TODO */
4178 /* Start up iconic or window? */
4179 x_wm_set_window_state
4180 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL), Qicon)
4181 ? IconicState
4182 : NormalState));
4184 x_text_icon (f, SSDATA ((!NILP (f->icon_name)
4185 ? f->icon_name
4186 : f->name)));
4187 #endif
4189 unblock_input ();
4193 static void
4194 x_make_gc (struct frame *f)
4196 XGCValues gc_values;
4198 block_input ();
4200 /* Create the GC's of this frame.
4201 Note that many default values are used. */
4203 /* Normal video */
4204 gc_values.font = FRAME_FONT (f);
4206 /* Cursor has cursor-color background, background-color foreground. */
4207 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
4208 gc_values.background = f->output_data.w32->cursor_pixel;
4209 f->output_data.w32->cursor_gc
4210 = XCreateGC (NULL, FRAME_W32_WINDOW (f),
4211 (GCFont | GCForeground | GCBackground),
4212 &gc_values);
4214 /* Reliefs. */
4215 f->output_data.w32->white_relief.gc = 0;
4216 f->output_data.w32->black_relief.gc = 0;
4218 unblock_input ();
4222 /* Handler for signals raised during x_create_frame and
4223 x_create_tip_frame. FRAME is the frame which is partially
4224 constructed. */
4226 static Lisp_Object
4227 unwind_create_frame (Lisp_Object frame)
4229 struct frame *f = XFRAME (frame);
4231 /* If frame is ``official'', nothing to do. */
4232 if (NILP (Fmemq (frame, Vframe_list)))
4234 #ifdef GLYPH_DEBUG
4235 struct w32_display_info *dpyinfo = FRAME_W32_DISPLAY_INFO (f);
4236 #endif
4238 x_free_frame_resources (f);
4239 free_glyphs (f);
4241 #ifdef GLYPH_DEBUG
4242 /* Check that reference counts are indeed correct. */
4243 eassert (dpyinfo->reference_count == dpyinfo_refcount);
4244 eassert (dpyinfo->terminal->image_cache->refcount == image_cache_refcount);
4245 #endif
4246 return Qt;
4249 return Qnil;
4252 static void
4253 do_unwind_create_frame (Lisp_Object frame)
4255 unwind_create_frame (frame);
4258 static void
4259 x_default_font_parameter (struct frame *f, Lisp_Object parms)
4261 struct w32_display_info *dpyinfo = FRAME_W32_DISPLAY_INFO (f);
4262 Lisp_Object font_param = x_get_arg (dpyinfo, parms, Qfont, NULL, NULL,
4263 RES_TYPE_STRING);
4264 Lisp_Object font;
4265 if (EQ (font_param, Qunbound))
4266 font_param = Qnil;
4267 font = !NILP (font_param) ? font_param
4268 : x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
4270 if (!STRINGP (font))
4272 int i;
4273 static char *names[]
4274 = { "Courier New-10",
4275 "-*-Courier-normal-r-*-*-13-*-*-*-c-*-iso8859-1",
4276 "-*-Fixedsys-normal-r-*-*-12-*-*-*-c-*-iso8859-1",
4277 "Fixedsys",
4278 NULL };
4280 for (i = 0; names[i]; i++)
4282 font = font_open_by_name (f, build_unibyte_string (names[i]));
4283 if (! NILP (font))
4284 break;
4286 if (NILP (font))
4287 error ("No suitable font was found");
4289 else if (!NILP (font_param))
4291 /* Remember the explicit font parameter, so we can re-apply it after
4292 we've applied the `default' face settings. */
4293 x_set_frame_parameters (f, Fcons (Fcons (Qfont_param, font_param), Qnil));
4295 x_default_parameter (f, parms, Qfont, font, "font", "Font", RES_TYPE_STRING);
4298 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
4299 1, 1, 0,
4300 doc: /* Make a new window, which is called a \"frame\" in Emacs terms.
4301 Return an Emacs frame object.
4302 PARAMETERS is an alist of frame parameters.
4303 If the parameters specify that the frame should not have a minibuffer,
4304 and do not specify a specific minibuffer window to use,
4305 then `default-minibuffer-frame' must be a frame whose minibuffer can
4306 be shared by the new frame.
4308 This function is an internal primitive--use `make-frame' instead. */)
4309 (Lisp_Object parameters)
4311 struct frame *f;
4312 Lisp_Object frame, tem;
4313 Lisp_Object name;
4314 int minibuffer_only = 0;
4315 long window_prompting = 0;
4316 int width, height;
4317 ptrdiff_t count = SPECPDL_INDEX ();
4318 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4319 Lisp_Object display;
4320 struct w32_display_info *dpyinfo = NULL;
4321 Lisp_Object parent;
4322 struct kboard *kb;
4324 /* Make copy of frame parameters because the original is in pure
4325 storage now. */
4326 parameters = Fcopy_alist (parameters);
4328 /* Use this general default value to start with
4329 until we know if this frame has a specified name. */
4330 Vx_resource_name = Vinvocation_name;
4332 display = x_get_arg (dpyinfo, parameters, Qterminal, 0, 0, RES_TYPE_NUMBER);
4333 if (EQ (display, Qunbound))
4334 display = x_get_arg (dpyinfo, parameters, Qdisplay, 0, 0, RES_TYPE_STRING);
4335 if (EQ (display, Qunbound))
4336 display = Qnil;
4337 dpyinfo = check_x_display_info (display);
4338 kb = dpyinfo->terminal->kboard;
4340 if (!dpyinfo->terminal->name)
4341 error ("Terminal is not live, can't create new frames on it");
4343 name = x_get_arg (dpyinfo, parameters, Qname, "name", "Name", RES_TYPE_STRING);
4344 if (!STRINGP (name)
4345 && ! EQ (name, Qunbound)
4346 && ! NILP (name))
4347 error ("Invalid frame name--not a string or nil");
4349 if (STRINGP (name))
4350 Vx_resource_name = name;
4352 /* See if parent window is specified. */
4353 parent = x_get_arg (dpyinfo, parameters, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
4354 if (EQ (parent, Qunbound))
4355 parent = Qnil;
4356 if (! NILP (parent))
4357 CHECK_NUMBER (parent);
4359 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
4360 /* No need to protect DISPLAY because that's not used after passing
4361 it to make_frame_without_minibuffer. */
4362 frame = Qnil;
4363 GCPRO4 (parameters, parent, name, frame);
4364 tem = x_get_arg (dpyinfo, parameters, Qminibuffer, "minibuffer", "Minibuffer",
4365 RES_TYPE_SYMBOL);
4366 if (EQ (tem, Qnone) || NILP (tem))
4367 f = make_frame_without_minibuffer (Qnil, kb, display);
4368 else if (EQ (tem, Qonly))
4370 f = make_minibuffer_frame ();
4371 minibuffer_only = 1;
4373 else if (WINDOWP (tem))
4374 f = make_frame_without_minibuffer (tem, kb, display);
4375 else
4376 f = make_frame (1);
4378 XSETFRAME (frame, f);
4380 /* By default, make scrollbars the system standard width. */
4381 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = GetSystemMetrics (SM_CXVSCROLL);
4383 f->terminal = dpyinfo->terminal;
4385 f->output_method = output_w32;
4386 f->output_data.w32 = xzalloc (sizeof (struct w32_output));
4387 FRAME_FONTSET (f) = -1;
4389 fset_icon_name
4390 (f, x_get_arg (dpyinfo, parameters, Qicon_name, "iconName", "Title",
4391 RES_TYPE_STRING));
4392 if (! STRINGP (f->icon_name))
4393 fset_icon_name (f, Qnil);
4395 /* FRAME_W32_DISPLAY_INFO (f) = dpyinfo; */
4397 /* With FRAME_X_DISPLAY_INFO set up, this unwind-protect is safe. */
4398 record_unwind_protect (do_unwind_create_frame, frame);
4399 #ifdef GLYPH_DEBUG
4400 image_cache_refcount =
4401 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
4402 dpyinfo_refcount = dpyinfo->reference_count;
4403 #endif /* GLYPH_DEBUG */
4405 /* Specify the parent under which to make this window. */
4407 if (!NILP (parent))
4409 f->output_data.w32->parent_desc = (Window) XFASTINT (parent);
4410 f->output_data.w32->explicit_parent = 1;
4412 else
4414 f->output_data.w32->parent_desc = FRAME_W32_DISPLAY_INFO (f)->root_window;
4415 f->output_data.w32->explicit_parent = 0;
4418 /* Set the name; the functions to which we pass f expect the name to
4419 be set. */
4420 if (EQ (name, Qunbound) || NILP (name))
4422 fset_name (f, build_string (dpyinfo->w32_id_name));
4423 f->explicit_name = 0;
4425 else
4427 fset_name (f, name);
4428 f->explicit_name = 1;
4429 /* use the frame's title when getting resources for this frame. */
4430 specbind (Qx_resource_name, name);
4433 if (uniscribe_available)
4434 register_font_driver (&uniscribe_font_driver, f);
4435 register_font_driver (&w32font_driver, f);
4437 x_default_parameter (f, parameters, Qfont_backend, Qnil,
4438 "fontBackend", "FontBackend", RES_TYPE_STRING);
4439 /* Extract the window parameters from the supplied values
4440 that are needed to determine window geometry. */
4441 x_default_font_parameter (f, parameters);
4442 x_default_parameter (f, parameters, Qborder_width, make_number (2),
4443 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4445 /* We recognize either internalBorderWidth or internalBorder
4446 (which is what xterm calls it). */
4447 if (NILP (Fassq (Qinternal_border_width, parameters)))
4449 Lisp_Object value;
4451 value = x_get_arg (dpyinfo, parameters, Qinternal_border_width,
4452 "internalBorder", "InternalBorder", RES_TYPE_NUMBER);
4453 if (! EQ (value, Qunbound))
4454 parameters = Fcons (Fcons (Qinternal_border_width, value),
4455 parameters);
4457 /* Default internalBorderWidth to 0 on Windows to match other programs. */
4458 x_default_parameter (f, parameters, Qinternal_border_width, make_number (0),
4459 "internalBorderWidth", "InternalBorder", RES_TYPE_NUMBER);
4460 x_default_parameter (f, parameters, Qvertical_scroll_bars, Qright,
4461 "verticalScrollBars", "ScrollBars", RES_TYPE_SYMBOL);
4463 /* Also do the stuff which must be set before the window exists. */
4464 x_default_parameter (f, parameters, Qforeground_color, build_string ("black"),
4465 "foreground", "Foreground", RES_TYPE_STRING);
4466 x_default_parameter (f, parameters, Qbackground_color, build_string ("white"),
4467 "background", "Background", RES_TYPE_STRING);
4468 x_default_parameter (f, parameters, Qmouse_color, build_string ("black"),
4469 "pointerColor", "Foreground", RES_TYPE_STRING);
4470 x_default_parameter (f, parameters, Qborder_color, build_string ("black"),
4471 "borderColor", "BorderColor", RES_TYPE_STRING);
4472 x_default_parameter (f, parameters, Qscreen_gamma, Qnil,
4473 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
4474 x_default_parameter (f, parameters, Qline_spacing, Qnil,
4475 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
4476 x_default_parameter (f, parameters, Qleft_fringe, Qnil,
4477 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
4478 x_default_parameter (f, parameters, Qright_fringe, Qnil,
4479 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
4481 /* Init faces before x_default_parameter is called for scroll-bar
4482 parameters because that function calls x_set_scroll_bar_width,
4483 which calls change_frame_size, which calls Fset_window_buffer,
4484 which runs hooks, which call Fvertical_motion. At the end, we
4485 end up in init_iterator with a null face cache, which should not
4486 happen. */
4487 init_frame_faces (f);
4489 /* The X resources controlling the menu-bar and tool-bar are
4490 processed specially at startup, and reflected in the mode
4491 variables; ignore them here. */
4492 x_default_parameter (f, parameters, Qmenu_bar_lines,
4493 NILP (Vmenu_bar_mode)
4494 ? make_number (0) : make_number (1),
4495 NULL, NULL, RES_TYPE_NUMBER);
4496 x_default_parameter (f, parameters, Qtool_bar_lines,
4497 NILP (Vtool_bar_mode)
4498 ? make_number (0) : make_number (1),
4499 NULL, NULL, RES_TYPE_NUMBER);
4501 x_default_parameter (f, parameters, Qbuffer_predicate, Qnil,
4502 "bufferPredicate", "BufferPredicate", RES_TYPE_SYMBOL);
4503 x_default_parameter (f, parameters, Qtitle, Qnil,
4504 "title", "Title", RES_TYPE_STRING);
4505 x_default_parameter (f, parameters, Qfullscreen, Qnil,
4506 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
4508 f->output_data.w32->dwStyle = WS_OVERLAPPEDWINDOW;
4509 f->output_data.w32->parent_desc = FRAME_W32_DISPLAY_INFO (f)->root_window;
4511 f->output_data.w32->text_cursor = w32_load_cursor (IDC_IBEAM);
4512 f->output_data.w32->nontext_cursor = w32_load_cursor (IDC_ARROW);
4513 f->output_data.w32->modeline_cursor = w32_load_cursor (IDC_ARROW);
4514 f->output_data.w32->hand_cursor = w32_load_cursor (IDC_HAND);
4515 f->output_data.w32->hourglass_cursor = w32_load_cursor (IDC_WAIT);
4516 f->output_data.w32->horizontal_drag_cursor = w32_load_cursor (IDC_SIZEWE);
4518 f->output_data.w32->current_cursor = f->output_data.w32->nontext_cursor;
4520 window_prompting = x_figure_window_size (f, parameters, 1);
4522 tem = x_get_arg (dpyinfo, parameters, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
4523 f->no_split = minibuffer_only || EQ (tem, Qt);
4525 w32_window (f, window_prompting, minibuffer_only);
4526 x_icon (f, parameters);
4528 x_make_gc (f);
4530 /* Now consider the frame official. */
4531 f->terminal->reference_count++;
4532 FRAME_W32_DISPLAY_INFO (f)->reference_count++;
4533 Vframe_list = Fcons (frame, Vframe_list);
4535 /* We need to do this after creating the window, so that the
4536 icon-creation functions can say whose icon they're describing. */
4537 x_default_parameter (f, parameters, Qicon_type, Qnil,
4538 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
4540 x_default_parameter (f, parameters, Qauto_raise, Qnil,
4541 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4542 x_default_parameter (f, parameters, Qauto_lower, Qnil,
4543 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4544 x_default_parameter (f, parameters, Qcursor_type, Qbox,
4545 "cursorType", "CursorType", RES_TYPE_SYMBOL);
4546 x_default_parameter (f, parameters, Qscroll_bar_width, Qnil,
4547 "scrollBarWidth", "ScrollBarWidth", RES_TYPE_NUMBER);
4548 x_default_parameter (f, parameters, Qalpha, Qnil,
4549 "alpha", "Alpha", RES_TYPE_NUMBER);
4551 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
4552 Change will not be effected unless different from the current
4553 FRAME_LINES (f). */
4554 width = FRAME_COLS (f);
4555 height = FRAME_LINES (f);
4557 FRAME_LINES (f) = 0;
4558 SET_FRAME_COLS (f, 0);
4559 change_frame_size (f, height, width, 1, 0, 0);
4561 /* Tell the server what size and position, etc, we want, and how
4562 badly we want them. This should be done after we have the menu
4563 bar so that its size can be taken into account. */
4564 block_input ();
4565 x_wm_set_size_hint (f, window_prompting, 0);
4566 unblock_input ();
4568 /* Make the window appear on the frame and enable display, unless
4569 the caller says not to. However, with explicit parent, Emacs
4570 cannot control visibility, so don't try. */
4571 if (! f->output_data.w32->explicit_parent)
4573 Lisp_Object visibility;
4575 visibility = x_get_arg (dpyinfo, parameters, Qvisibility, 0, 0, RES_TYPE_SYMBOL);
4576 if (EQ (visibility, Qunbound))
4577 visibility = Qt;
4579 if (EQ (visibility, Qicon))
4580 x_iconify_frame (f);
4581 else if (! NILP (visibility))
4582 x_make_frame_visible (f);
4583 else
4584 /* Must have been Qnil. */
4588 /* Initialize `default-minibuffer-frame' in case this is the first
4589 frame on this terminal. */
4590 if (FRAME_HAS_MINIBUF_P (f)
4591 && (!FRAMEP (KVAR (kb, Vdefault_minibuffer_frame))
4592 || !FRAME_LIVE_P (XFRAME (KVAR (kb, Vdefault_minibuffer_frame)))))
4593 kset_default_minibuffer_frame (kb, frame);
4595 /* All remaining specified parameters, which have not been "used"
4596 by x_get_arg and friends, now go in the misc. alist of the frame. */
4597 for (tem = parameters; CONSP (tem); tem = XCDR (tem))
4598 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
4599 fset_param_alist (f, Fcons (XCAR (tem), f->param_alist));
4601 UNGCPRO;
4603 /* Make sure windows on this frame appear in calls to next-window
4604 and similar functions. */
4605 Vwindow_list = Qnil;
4607 return unbind_to (count, frame);
4610 /* FRAME is used only to get a handle on the X display. We don't pass the
4611 display info directly because we're called from frame.c, which doesn't
4612 know about that structure. */
4613 Lisp_Object
4614 x_get_focus_frame (struct frame *frame)
4616 struct w32_display_info *dpyinfo = FRAME_W32_DISPLAY_INFO (frame);
4617 Lisp_Object xfocus;
4618 if (! dpyinfo->w32_focus_frame)
4619 return Qnil;
4621 XSETFRAME (xfocus, dpyinfo->w32_focus_frame);
4622 return xfocus;
4625 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
4626 doc: /* Give FRAME input focus, raising to foreground if necessary. */)
4627 (Lisp_Object frame)
4629 x_focus_on_frame (decode_window_system_frame (frame));
4630 return Qnil;
4634 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
4635 doc: /* Internal function called by `color-defined-p', which see.
4636 \(Note that the Nextstep version of this function ignores FRAME.) */)
4637 (Lisp_Object color, Lisp_Object frame)
4639 XColor foo;
4640 struct frame *f = decode_window_system_frame (frame);
4642 CHECK_STRING (color);
4644 if (w32_defined_color (f, SDATA (color), &foo, 0))
4645 return Qt;
4646 else
4647 return Qnil;
4650 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
4651 doc: /* Internal function called by `color-values', which see. */)
4652 (Lisp_Object color, Lisp_Object frame)
4654 XColor foo;
4655 struct frame *f = decode_window_system_frame (frame);
4657 CHECK_STRING (color);
4659 if (w32_defined_color (f, SDATA (color), &foo, 0))
4660 return list3i ((GetRValue (foo.pixel) << 8) | GetRValue (foo.pixel),
4661 (GetGValue (foo.pixel) << 8) | GetGValue (foo.pixel),
4662 (GetBValue (foo.pixel) << 8) | GetBValue (foo.pixel));
4663 else
4664 return Qnil;
4667 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
4668 doc: /* Internal function called by `display-color-p', which see. */)
4669 (Lisp_Object display)
4671 struct w32_display_info *dpyinfo = check_x_display_info (display);
4673 if ((dpyinfo->n_planes * dpyinfo->n_cbits) <= 2)
4674 return Qnil;
4676 return Qt;
4679 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p,
4680 Sx_display_grayscale_p, 0, 1, 0,
4681 doc: /* Return t if DISPLAY supports shades of gray.
4682 Note that color displays do support shades of gray.
4683 The optional argument DISPLAY specifies which display to ask about.
4684 DISPLAY should be either a frame or a display name (a string).
4685 If omitted or nil, that stands for the selected frame's display. */)
4686 (Lisp_Object display)
4688 struct w32_display_info *dpyinfo = check_x_display_info (display);
4690 if ((dpyinfo->n_planes * dpyinfo->n_cbits) <= 1)
4691 return Qnil;
4693 return Qt;
4696 DEFUN ("x-display-pixel-width", Fx_display_pixel_width,
4697 Sx_display_pixel_width, 0, 1, 0,
4698 doc: /* Return the width in pixels of DISPLAY.
4699 The optional argument DISPLAY specifies which display to ask about.
4700 DISPLAY should be either a frame or a display name (a string).
4701 If omitted or nil, that stands for the selected frame's display.
4703 On \"multi-monitor\" setups this refers to the pixel width for all
4704 physical monitors associated with DISPLAY. To get information for
4705 each physical monitor, use `display-monitor-attributes-list'. */)
4706 (Lisp_Object display)
4708 struct w32_display_info *dpyinfo = check_x_display_info (display);
4710 return make_number (x_display_pixel_width (dpyinfo));
4713 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
4714 Sx_display_pixel_height, 0, 1, 0,
4715 doc: /* Return the height in pixels of DISPLAY.
4716 The optional argument DISPLAY specifies which display to ask about.
4717 DISPLAY should be either a frame or a display name (a string).
4718 If omitted or nil, that stands for the selected frame's display.
4720 On \"multi-monitor\" setups this refers to the pixel height for all
4721 physical monitors associated with DISPLAY. To get information for
4722 each physical monitor, use `display-monitor-attributes-list'. */)
4723 (Lisp_Object display)
4725 struct w32_display_info *dpyinfo = check_x_display_info (display);
4727 return make_number (x_display_pixel_height (dpyinfo));
4730 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
4731 0, 1, 0,
4732 doc: /* Return the number of bitplanes of DISPLAY.
4733 The optional argument DISPLAY specifies which display to ask about.
4734 DISPLAY should be either a frame or a display name (a string).
4735 If omitted or nil, that stands for the selected frame's display. */)
4736 (Lisp_Object display)
4738 struct w32_display_info *dpyinfo = check_x_display_info (display);
4740 return make_number (dpyinfo->n_planes * dpyinfo->n_cbits);
4743 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
4744 0, 1, 0,
4745 doc: /* Return the number of color cells of DISPLAY.
4746 The optional argument DISPLAY specifies which display to ask about.
4747 DISPLAY should be either a frame or a display name (a string).
4748 If omitted or nil, that stands for the selected frame's display. */)
4749 (Lisp_Object display)
4751 struct w32_display_info *dpyinfo = check_x_display_info (display);
4752 int cap;
4754 /* Don't use NCOLORS: it returns incorrect results under remote
4755 * desktop. We force 24+ bit depths to 24-bit, both to prevent an
4756 * overflow and because probably is more meaningful on Windows
4757 * anyway. */
4759 cap = 1 << min (dpyinfo->n_planes * dpyinfo->n_cbits, 24);
4760 return make_number (cap);
4763 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
4764 Sx_server_max_request_size,
4765 0, 1, 0,
4766 doc: /* Return the maximum request size of the server of DISPLAY.
4767 The optional argument DISPLAY specifies which display to ask about.
4768 DISPLAY should be either a frame or a display name (a string).
4769 If omitted or nil, that stands for the selected frame's display. */)
4770 (Lisp_Object display)
4772 return make_number (1);
4775 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
4776 doc: /* Return the "vendor ID" string of the W32 system (Microsoft).
4777 The optional argument DISPLAY specifies which display to ask about.
4778 DISPLAY should be either a frame or a display name (a string).
4779 If omitted or nil, that stands for the selected frame's display. */)
4780 (Lisp_Object display)
4782 return build_string ("Microsoft Corp.");
4785 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
4786 doc: /* Return the version numbers of the server of DISPLAY.
4787 The value is a list of three integers: the major and minor
4788 version numbers of the X Protocol in use, and the distributor-specific
4789 release number. See also the function `x-server-vendor'.
4791 The optional argument DISPLAY specifies which display to ask about.
4792 DISPLAY should be either a frame or a display name (a string).
4793 If omitted or nil, that stands for the selected frame's display. */)
4794 (Lisp_Object display)
4796 return list3i (w32_major_version, w32_minor_version, w32_build_number);
4799 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
4800 doc: /* Return the number of screens on the server of DISPLAY.
4801 The optional argument DISPLAY specifies which display to ask about.
4802 DISPLAY should be either a frame or a display name (a string).
4803 If omitted or nil, that stands for the selected frame's display. */)
4804 (Lisp_Object display)
4806 return make_number (1);
4809 DEFUN ("x-display-mm-height", Fx_display_mm_height,
4810 Sx_display_mm_height, 0, 1, 0,
4811 doc: /* Return the height in millimeters of DISPLAY.
4812 The optional argument DISPLAY specifies which display to ask about.
4813 DISPLAY should be either a frame or a display name (a string).
4814 If omitted or nil, that stands for the selected frame's display.
4816 On \"multi-monitor\" setups this refers to the height in millimeters for
4817 all physical monitors associated with DISPLAY. To get information
4818 for each physical monitor, use `display-monitor-attributes-list'. */)
4819 (Lisp_Object display)
4821 struct w32_display_info *dpyinfo = check_x_display_info (display);
4822 HDC hdc;
4823 double mm_per_pixel;
4825 hdc = GetDC (NULL);
4826 mm_per_pixel = ((double) GetDeviceCaps (hdc, VERTSIZE)
4827 / GetDeviceCaps (hdc, VERTRES));
4828 ReleaseDC (NULL, hdc);
4830 return make_number (x_display_pixel_height (dpyinfo) * mm_per_pixel + 0.5);
4833 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
4834 doc: /* Return the width in millimeters of DISPLAY.
4835 The optional argument DISPLAY specifies which display to ask about.
4836 DISPLAY should be either a frame or a display name (a string).
4837 If omitted or nil, that stands for the selected frame's display.
4839 On \"multi-monitor\" setups this refers to the width in millimeters for
4840 all physical monitors associated with TERMINAL. To get information
4841 for each physical monitor, use `display-monitor-attributes-list'. */)
4842 (Lisp_Object display)
4844 struct w32_display_info *dpyinfo = check_x_display_info (display);
4845 HDC hdc;
4846 double mm_per_pixel;
4848 hdc = GetDC (NULL);
4849 mm_per_pixel = ((double) GetDeviceCaps (hdc, HORZSIZE)
4850 / GetDeviceCaps (hdc, HORZRES));
4851 ReleaseDC (NULL, hdc);
4853 return make_number (x_display_pixel_width (dpyinfo) * mm_per_pixel + 0.5);
4856 DEFUN ("x-display-backing-store", Fx_display_backing_store,
4857 Sx_display_backing_store, 0, 1, 0,
4858 doc: /* Return an indication of whether DISPLAY does backing store.
4859 The value may be `always', `when-mapped', or `not-useful'.
4860 The optional argument DISPLAY specifies which display to ask about.
4861 DISPLAY should be either a frame or a display name (a string).
4862 If omitted or nil, that stands for the selected frame's display. */)
4863 (Lisp_Object display)
4865 return intern ("not-useful");
4868 DEFUN ("x-display-visual-class", Fx_display_visual_class,
4869 Sx_display_visual_class, 0, 1, 0,
4870 doc: /* Return the visual class of DISPLAY.
4871 The value is one of the symbols `static-gray', `gray-scale',
4872 `static-color', `pseudo-color', `true-color', or `direct-color'.
4874 The optional argument DISPLAY specifies which display to ask about.
4875 DISPLAY should be either a frame or a display name (a string).
4876 If omitted or nil, that stands for the selected frame's display. */)
4877 (Lisp_Object display)
4879 struct w32_display_info *dpyinfo = check_x_display_info (display);
4880 Lisp_Object result = Qnil;
4882 if (dpyinfo->has_palette)
4883 result = intern ("pseudo-color");
4884 else if (dpyinfo->n_planes * dpyinfo->n_cbits == 1)
4885 result = intern ("static-grey");
4886 else if (dpyinfo->n_planes * dpyinfo->n_cbits == 4)
4887 result = intern ("static-color");
4888 else if (dpyinfo->n_planes * dpyinfo->n_cbits > 8)
4889 result = intern ("true-color");
4891 return result;
4894 DEFUN ("x-display-save-under", Fx_display_save_under,
4895 Sx_display_save_under, 0, 1, 0,
4896 doc: /* Return t if DISPLAY supports the save-under feature.
4897 The optional argument DISPLAY specifies which display to ask about.
4898 DISPLAY should be either a frame or a display name (a string).
4899 If omitted or nil, that stands for the selected frame's display. */)
4900 (Lisp_Object display)
4902 return Qnil;
4905 static BOOL CALLBACK
4906 w32_monitor_enum (HMONITOR monitor, HDC hdc, RECT *rcMonitor, LPARAM dwData)
4908 Lisp_Object *monitor_list = (Lisp_Object *) dwData;
4910 *monitor_list = Fcons (make_save_ptr (monitor), *monitor_list);
4912 return TRUE;
4915 static Lisp_Object
4916 w32_display_monitor_attributes_list (void)
4918 Lisp_Object attributes_list = Qnil, primary_monitor_attributes = Qnil;
4919 Lisp_Object monitor_list = Qnil, monitor_frames, rest, frame;
4920 int i, n_monitors;
4921 HMONITOR *monitors;
4922 struct gcpro gcpro1, gcpro2, gcpro3;
4924 if (!(enum_display_monitors_fn && get_monitor_info_fn
4925 && monitor_from_window_fn))
4926 return Qnil;
4928 if (!enum_display_monitors_fn (NULL, NULL, w32_monitor_enum,
4929 (LPARAM) &monitor_list)
4930 || NILP (monitor_list))
4931 return Qnil;
4933 n_monitors = 0;
4934 for (rest = monitor_list; CONSP (rest); rest = XCDR (rest))
4935 n_monitors++;
4937 monitors = xmalloc (n_monitors * sizeof (*monitors));
4938 for (i = 0; i < n_monitors; i++)
4940 monitors[i] = XSAVE_POINTER (XCAR (monitor_list), 0);
4941 monitor_list = XCDR (monitor_list);
4944 monitor_frames = Fmake_vector (make_number (n_monitors), Qnil);
4945 FOR_EACH_FRAME (rest, frame)
4947 struct frame *f = XFRAME (frame);
4949 if (FRAME_W32_P (f) && !EQ (frame, tip_frame))
4951 HMONITOR monitor =
4952 monitor_from_window_fn (FRAME_W32_WINDOW (f),
4953 MONITOR_DEFAULT_TO_NEAREST);
4955 for (i = 0; i < n_monitors; i++)
4956 if (monitors[i] == monitor)
4957 break;
4959 if (i < n_monitors)
4960 ASET (monitor_frames, i, Fcons (frame, AREF (monitor_frames, i)));
4964 GCPRO3 (attributes_list, primary_monitor_attributes, monitor_frames);
4966 for (i = 0; i < n_monitors; i++)
4968 Lisp_Object geometry, workarea, name, attributes = Qnil;
4969 HDC hdc;
4970 int width_mm, height_mm;
4971 struct MONITOR_INFO_EX mi;
4973 mi.cbSize = sizeof (mi);
4974 if (!get_monitor_info_fn (monitors[i], (struct MONITOR_INFO *) &mi))
4975 continue;
4977 hdc = CreateDCA ("DISPLAY", mi.szDevice, NULL, NULL);
4978 if (hdc == NULL)
4979 continue;
4980 width_mm = GetDeviceCaps (hdc, HORZSIZE);
4981 height_mm = GetDeviceCaps (hdc, VERTSIZE);
4982 DeleteDC (hdc);
4984 attributes = Fcons (Fcons (Qframes, AREF (monitor_frames, i)),
4985 attributes);
4987 name = DECODE_SYSTEM (build_unibyte_string (mi.szDevice));
4989 attributes = Fcons (Fcons (Qname, name), attributes);
4991 attributes = Fcons (Fcons (Qmm_size, list2i (width_mm, height_mm)),
4992 attributes);
4994 workarea = list4i (mi.rcWork.left, mi.rcWork.top,
4995 mi.rcWork.right - mi.rcWork.left,
4996 mi.rcWork.bottom - mi.rcWork.top);
4997 attributes = Fcons (Fcons (Qworkarea, workarea), attributes);
4999 geometry = list4i (mi.rcMonitor.left, mi.rcMonitor.top,
5000 mi.rcMonitor.right - mi.rcMonitor.left,
5001 mi.rcMonitor.bottom - mi.rcMonitor.top);
5002 attributes = Fcons (Fcons (Qgeometry, geometry), attributes);
5004 if (mi.dwFlags & MONITORINFOF_PRIMARY)
5005 primary_monitor_attributes = attributes;
5006 else
5007 attributes_list = Fcons (attributes, attributes_list);
5010 if (!NILP (primary_monitor_attributes))
5011 attributes_list = Fcons (primary_monitor_attributes, attributes_list);
5013 UNGCPRO;
5015 xfree (monitors);
5017 return attributes_list;
5020 static Lisp_Object
5021 w32_display_monitor_attributes_list_fallback (struct w32_display_info *dpyinfo)
5023 Lisp_Object geometry, workarea, frames, rest, frame, attributes = Qnil;
5024 HDC hdc;
5025 double mm_per_pixel;
5026 int pixel_width, pixel_height, width_mm, height_mm;
5027 RECT workarea_rect;
5029 /* Fallback: treat (possibly) multiple physical monitors as if they
5030 formed a single monitor as a whole. This should provide a
5031 consistent result at least on single monitor environments. */
5032 attributes = Fcons (Fcons (Qname, build_string ("combined screen")),
5033 attributes);
5035 frames = Qnil;
5036 FOR_EACH_FRAME (rest, frame)
5038 struct frame *f = XFRAME (frame);
5040 if (FRAME_W32_P (f) && !EQ (frame, tip_frame))
5041 frames = Fcons (frame, frames);
5043 attributes = Fcons (Fcons (Qframes, frames), attributes);
5045 pixel_width = x_display_pixel_width (dpyinfo);
5046 pixel_height = x_display_pixel_height (dpyinfo);
5048 hdc = GetDC (NULL);
5049 mm_per_pixel = ((double) GetDeviceCaps (hdc, HORZSIZE)
5050 / GetDeviceCaps (hdc, HORZRES));
5051 width_mm = pixel_width * mm_per_pixel + 0.5;
5052 mm_per_pixel = ((double) GetDeviceCaps (hdc, VERTSIZE)
5053 / GetDeviceCaps (hdc, VERTRES));
5054 height_mm = pixel_height * mm_per_pixel + 0.5;
5055 ReleaseDC (NULL, hdc);
5056 attributes = Fcons (Fcons (Qmm_size, list2i (width_mm, height_mm)),
5057 attributes);
5059 /* GetSystemMetrics below may return 0 for Windows 95 or NT 4.0, but
5060 we don't care. */
5061 geometry = list4i (GetSystemMetrics (SM_XVIRTUALSCREEN),
5062 GetSystemMetrics (SM_YVIRTUALSCREEN),
5063 pixel_width, pixel_height);
5064 if (SystemParametersInfo (SPI_GETWORKAREA, 0, &workarea_rect, 0))
5065 workarea = list4i (workarea_rect.left, workarea_rect.top,
5066 workarea_rect.right - workarea_rect.left,
5067 workarea_rect.bottom - workarea_rect.top);
5068 else
5069 workarea = geometry;
5070 attributes = Fcons (Fcons (Qworkarea, workarea), attributes);
5072 attributes = Fcons (Fcons (Qgeometry, geometry), attributes);
5074 return list1 (attributes);
5077 DEFUN ("w32-display-monitor-attributes-list", Fw32_display_monitor_attributes_list,
5078 Sw32_display_monitor_attributes_list,
5079 0, 1, 0,
5080 doc: /* Return a list of physical monitor attributes on the W32 display DISPLAY.
5082 The optional argument DISPLAY specifies which display to ask about.
5083 DISPLAY should be either a frame or a display name (a string).
5084 If omitted or nil, that stands for the selected frame's display.
5086 Internal use only, use `display-monitor-attributes-list' instead. */)
5087 (Lisp_Object display)
5089 struct w32_display_info *dpyinfo = check_x_display_info (display);
5090 Lisp_Object attributes_list;
5092 block_input ();
5093 attributes_list = w32_display_monitor_attributes_list ();
5094 if (NILP (attributes_list))
5095 attributes_list = w32_display_monitor_attributes_list_fallback (dpyinfo);
5096 unblock_input ();
5098 return attributes_list;
5101 DEFUN ("set-message-beep", Fset_message_beep, Sset_message_beep, 1, 1, 0,
5102 doc: /* Set the sound generated when the bell is rung.
5103 SOUND is 'asterisk, 'exclamation, 'hand, 'question, 'ok, or 'silent
5104 to use the corresponding system sound for the bell. The 'silent sound
5105 prevents Emacs from making any sound at all.
5106 SOUND is nil to use the normal beep. */)
5107 (Lisp_Object sound)
5109 CHECK_SYMBOL (sound);
5111 if (NILP (sound))
5112 sound_type = 0xFFFFFFFF;
5113 else if (EQ (sound, intern ("asterisk")))
5114 sound_type = MB_ICONASTERISK;
5115 else if (EQ (sound, intern ("exclamation")))
5116 sound_type = MB_ICONEXCLAMATION;
5117 else if (EQ (sound, intern ("hand")))
5118 sound_type = MB_ICONHAND;
5119 else if (EQ (sound, intern ("question")))
5120 sound_type = MB_ICONQUESTION;
5121 else if (EQ (sound, intern ("ok")))
5122 sound_type = MB_OK;
5123 else if (EQ (sound, intern ("silent")))
5124 sound_type = MB_EMACS_SILENT;
5125 else
5126 sound_type = 0xFFFFFFFF;
5128 return sound;
5132 x_screen_planes (register struct frame *f)
5134 return FRAME_W32_DISPLAY_INFO (f)->n_planes;
5137 /* Return the display structure for the display named NAME.
5138 Open a new connection if necessary. */
5140 struct w32_display_info *
5141 x_display_info_for_name (Lisp_Object name)
5143 Lisp_Object names;
5144 struct w32_display_info *dpyinfo;
5146 CHECK_STRING (name);
5148 for (dpyinfo = &one_w32_display_info, names = w32_display_name_list;
5149 dpyinfo && !NILP (w32_display_name_list);
5150 dpyinfo = dpyinfo->next, names = XCDR (names))
5152 Lisp_Object tem;
5153 tem = Fstring_equal (XCAR (XCAR (names)), name);
5154 if (!NILP (tem))
5155 return dpyinfo;
5158 /* Use this general default value to start with. */
5159 Vx_resource_name = Vinvocation_name;
5161 validate_x_resource_name ();
5163 dpyinfo = w32_term_init (name, (unsigned char *)0,
5164 SSDATA (Vx_resource_name));
5166 if (dpyinfo == 0)
5167 error ("Cannot connect to server %s", SDATA (name));
5169 XSETFASTINT (Vwindow_system_version, w32_major_version);
5171 return dpyinfo;
5174 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
5175 1, 3, 0, doc: /* Open a connection to a display server.
5176 DISPLAY is the name of the display to connect to.
5177 Optional second arg XRM-STRING is a string of resources in xrdb format.
5178 If the optional third arg MUST-SUCCEED is non-nil,
5179 terminate Emacs if we can't open the connection.
5180 \(In the Nextstep version, the last two arguments are currently ignored.) */)
5181 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
5183 unsigned char *xrm_option;
5184 struct w32_display_info *dpyinfo;
5186 CHECK_STRING (display);
5188 /* Signal an error in order to encourage correct use from callers.
5189 * If we ever support multiple window systems in the same Emacs,
5190 * we'll need callers to be precise about what window system they
5191 * want. */
5193 if (strcmp (SSDATA (display), "w32") != 0)
5194 error ("The name of the display in this Emacs must be \"w32\"");
5196 /* If initialization has already been done, return now to avoid
5197 overwriting critical parts of one_w32_display_info. */
5198 if (window_system_available (NULL))
5199 return Qnil;
5201 if (! NILP (xrm_string))
5202 CHECK_STRING (xrm_string);
5204 #if 0
5205 if (! EQ (Vwindow_system, intern ("w32")))
5206 error ("Not using Microsoft Windows");
5207 #endif
5209 /* Allow color mapping to be defined externally; first look in user's
5210 HOME directory, then in Emacs etc dir for a file called rgb.txt. */
5212 Lisp_Object color_file;
5213 struct gcpro gcpro1;
5215 color_file = build_string ("~/rgb.txt");
5217 GCPRO1 (color_file);
5219 if (NILP (Ffile_readable_p (color_file)))
5220 color_file =
5221 Fexpand_file_name (build_string ("rgb.txt"),
5222 Fsymbol_value (intern ("data-directory")));
5224 Vw32_color_map = Fx_load_color_file (color_file);
5226 UNGCPRO;
5228 if (NILP (Vw32_color_map))
5229 Vw32_color_map = w32_default_color_map ();
5231 /* Merge in system logical colors. */
5232 add_system_logical_colors_to_map (&Vw32_color_map);
5234 if (! NILP (xrm_string))
5235 xrm_option = SDATA (xrm_string);
5236 else
5237 xrm_option = (unsigned char *) 0;
5239 /* Use this general default value to start with. */
5240 /* First remove .exe suffix from invocation-name - it looks ugly. */
5242 char basename[ MAX_PATH ], *str;
5244 strcpy (basename, SDATA (Vinvocation_name));
5245 str = strrchr (basename, '.');
5246 if (str) *str = 0;
5247 Vinvocation_name = build_string (basename);
5249 Vx_resource_name = Vinvocation_name;
5251 validate_x_resource_name ();
5253 /* This is what opens the connection and sets x_current_display.
5254 This also initializes many symbols, such as those used for input. */
5255 dpyinfo = w32_term_init (display, xrm_option,
5256 SSDATA (Vx_resource_name));
5258 if (dpyinfo == 0)
5260 if (!NILP (must_succeed))
5261 fatal ("Cannot connect to server %s.\n",
5262 SDATA (display));
5263 else
5264 error ("Cannot connect to server %s", SDATA (display));
5267 XSETFASTINT (Vwindow_system_version, w32_major_version);
5268 return Qnil;
5271 DEFUN ("x-close-connection", Fx_close_connection,
5272 Sx_close_connection, 1, 1, 0,
5273 doc: /* Close the connection to DISPLAY's server.
5274 For DISPLAY, specify either a frame or a display name (a string).
5275 If DISPLAY is nil, that stands for the selected frame's display. */)
5276 (Lisp_Object display)
5278 struct w32_display_info *dpyinfo = check_x_display_info (display);
5280 if (dpyinfo->reference_count > 0)
5281 error ("Display still has frames on it");
5283 block_input ();
5284 x_destroy_all_bitmaps (dpyinfo);
5286 x_delete_display (dpyinfo);
5287 unblock_input ();
5289 return Qnil;
5292 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
5293 doc: /* Return the list of display names that Emacs has connections to. */)
5294 (void)
5296 Lisp_Object tail, result;
5298 result = Qnil;
5299 for (tail = w32_display_name_list; CONSP (tail); tail = XCDR (tail))
5300 result = Fcons (XCAR (XCAR (tail)), result);
5302 return result;
5305 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
5306 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
5307 This function only has an effect on X Windows. With MS Windows, it is
5308 defined but does nothing.
5310 If ON is nil, allow buffering of requests.
5311 Turning on synchronization prohibits the Xlib routines from buffering
5312 requests and seriously degrades performance, but makes debugging much
5313 easier.
5314 The optional second argument TERMINAL specifies which display to act on.
5315 TERMINAL should be a terminal object, a frame or a display name (a string).
5316 If TERMINAL is omitted or nil, that stands for the selected frame's display. */)
5317 (Lisp_Object on, Lisp_Object display)
5319 return Qnil;
5324 /***********************************************************************
5325 Window properties
5326 ***********************************************************************/
5328 #if 0 /* TODO : port window properties to W32 */
5330 DEFUN ("x-change-window-property", Fx_change_window_property,
5331 Sx_change_window_property, 2, 6, 0,
5332 doc: /* Change window property PROP to VALUE on the X window of FRAME.
5333 PROP must be a string. VALUE may be a string or a list of conses,
5334 numbers and/or strings. If an element in the list is a string, it is
5335 converted to an atom and the value of the Atom is used. If an element
5336 is a cons, it is converted to a 32 bit number where the car is the 16
5337 top bits and the cdr is the lower 16 bits.
5339 FRAME nil or omitted means use the selected frame.
5340 If TYPE is given and non-nil, it is the name of the type of VALUE.
5341 If TYPE is not given or nil, the type is STRING.
5342 FORMAT gives the size in bits of each element if VALUE is a list.
5343 It must be one of 8, 16 or 32.
5344 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
5345 If OUTER-P is non-nil, the property is changed for the outer X window of
5346 FRAME. Default is to change on the edit X window. */)
5347 (Lisp_Object prop, Lisp_Object value, Lisp_Object frame,
5348 Lisp_Object type, Lisp_Object format, Lisp_Object outer_p)
5350 struct frame *f = decode_window_system_frame (frame);
5351 Atom prop_atom;
5353 CHECK_STRING (prop);
5354 CHECK_STRING (value);
5356 block_input ();
5357 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5358 XChangeProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5359 prop_atom, XA_STRING, 8, PropModeReplace,
5360 SDATA (value), SCHARS (value));
5362 /* Make sure the property is set when we return. */
5363 XFlush (FRAME_W32_DISPLAY (f));
5364 unblock_input ();
5366 return value;
5370 DEFUN ("x-delete-window-property", Fx_delete_window_property,
5371 Sx_delete_window_property, 1, 2, 0,
5372 doc: /* Remove window property PROP from X window of FRAME.
5373 FRAME nil or omitted means use the selected frame. Value is PROP. */)
5374 (Lisp_Object prop, Lisp_Object frame)
5376 struct frame *f = decode_window_system_frame (frame);
5377 Atom prop_atom;
5379 CHECK_STRING (prop);
5380 block_input ();
5381 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5382 XDeleteProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f), prop_atom);
5384 /* Make sure the property is removed when we return. */
5385 XFlush (FRAME_W32_DISPLAY (f));
5386 unblock_input ();
5388 return prop;
5392 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
5393 1, 6, 0,
5394 doc: /* Value is the value of window property PROP on FRAME.
5395 If FRAME is nil or omitted, use the selected frame.
5397 On X Windows, the following optional arguments are also accepted:
5398 If TYPE is nil or omitted, get the property as a string.
5399 Otherwise TYPE is the name of the atom that denotes the type expected.
5400 If SOURCE is non-nil, get the property on that window instead of from
5401 FRAME. The number 0 denotes the root window.
5402 If DELETE-P is non-nil, delete the property after retrieving it.
5403 If VECTOR-RET-P is non-nil, don't return a string but a vector of values.
5405 On MS Windows, this function accepts but ignores those optional arguments.
5407 Value is nil if FRAME hasn't a property with name PROP or if PROP has
5408 no value of TYPE (always string in the MS Windows case). */)
5409 (Lisp_Object prop, Lisp_Object frame, Lisp_Object type,
5410 Lisp_Object source, Lisp_Object delete_p, Lisp_Object vector_ret_p)
5412 struct frame *f = decode_window_system_frame (frame);
5413 Atom prop_atom;
5414 int rc;
5415 Lisp_Object prop_value = Qnil;
5416 char *tmp_data = NULL;
5417 Atom actual_type;
5418 int actual_format;
5419 unsigned long actual_size, bytes_remaining;
5421 CHECK_STRING (prop);
5422 block_input ();
5423 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5424 rc = XGetWindowProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5425 prop_atom, 0, 0, False, XA_STRING,
5426 &actual_type, &actual_format, &actual_size,
5427 &bytes_remaining, (unsigned char **) &tmp_data);
5428 if (rc == Success)
5430 int size = bytes_remaining;
5432 XFree (tmp_data);
5433 tmp_data = NULL;
5435 rc = XGetWindowProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5436 prop_atom, 0, bytes_remaining,
5437 False, XA_STRING,
5438 &actual_type, &actual_format,
5439 &actual_size, &bytes_remaining,
5440 (unsigned char **) &tmp_data);
5441 if (rc == Success)
5442 prop_value = make_string (tmp_data, size);
5444 XFree (tmp_data);
5447 unblock_input ();
5449 return prop_value;
5451 return Qnil;
5454 #endif /* TODO */
5457 /***********************************************************************
5458 Busy cursor
5459 ***********************************************************************/
5461 void
5462 w32_note_current_window (void)
5464 struct frame * f = SELECTED_FRAME ();
5466 if (!FRAME_W32_P (f))
5467 return;
5469 hourglass_hwnd = FRAME_W32_WINDOW (f);
5472 void
5473 show_hourglass (struct atimer *timer)
5475 struct frame *f;
5477 hourglass_atimer = NULL;
5479 block_input ();
5480 f = x_window_to_frame (&one_w32_display_info,
5481 hourglass_hwnd);
5483 if (f)
5484 f->output_data.w32->hourglass_p = 0;
5485 else
5486 f = SELECTED_FRAME ();
5488 if (!FRAME_W32_P (f))
5489 return;
5491 w32_show_hourglass (f);
5492 unblock_input ();
5495 void
5496 hide_hourglass (void)
5498 block_input ();
5499 w32_hide_hourglass ();
5500 unblock_input ();
5504 /* Display an hourglass cursor. Set the hourglass_p flag in display info
5505 to indicate that an hourglass cursor is shown. */
5507 static void
5508 w32_show_hourglass (struct frame *f)
5510 if (!hourglass_shown_p)
5512 f->output_data.w32->hourglass_p = 1;
5513 if (!menubar_in_use && !current_popup_menu)
5514 SetCursor (f->output_data.w32->hourglass_cursor);
5515 hourglass_shown_p = 1;
5520 /* Hide the hourglass cursor on all frames, if it is currently shown. */
5522 static void
5523 w32_hide_hourglass (void)
5525 if (hourglass_shown_p)
5527 struct frame *f = x_window_to_frame (&one_w32_display_info,
5528 hourglass_hwnd);
5529 if (f)
5530 f->output_data.w32->hourglass_p = 0;
5531 else
5532 /* If frame was deleted, restore to selected frame's cursor. */
5533 f = SELECTED_FRAME ();
5535 if (FRAME_W32_P (f))
5536 SetCursor (f->output_data.w32->current_cursor);
5537 else
5538 /* No cursors on non GUI frames - restore to stock arrow cursor. */
5539 SetCursor (w32_load_cursor (IDC_ARROW));
5541 hourglass_shown_p = 0;
5547 /***********************************************************************
5548 Tool tips
5549 ***********************************************************************/
5551 static Lisp_Object x_create_tip_frame (struct w32_display_info *,
5552 Lisp_Object, Lisp_Object);
5553 static void compute_tip_xy (struct frame *, Lisp_Object, Lisp_Object,
5554 Lisp_Object, int, int, int *, int *);
5556 /* The frame of a currently visible tooltip. */
5558 Lisp_Object tip_frame;
5560 /* If non-nil, a timer started that hides the last tooltip when it
5561 fires. */
5563 Lisp_Object tip_timer;
5564 Window tip_window;
5566 /* If non-nil, a vector of 3 elements containing the last args
5567 with which x-show-tip was called. See there. */
5569 Lisp_Object last_show_tip_args;
5572 static void
5573 unwind_create_tip_frame (Lisp_Object frame)
5575 Lisp_Object deleted;
5577 deleted = unwind_create_frame (frame);
5578 if (EQ (deleted, Qt))
5580 tip_window = NULL;
5581 tip_frame = Qnil;
5586 /* Create a frame for a tooltip on the display described by DPYINFO.
5587 PARMS is a list of frame parameters. TEXT is the string to
5588 display in the tip frame. Value is the frame.
5590 Note that functions called here, esp. x_default_parameter can
5591 signal errors, for instance when a specified color name is
5592 undefined. We have to make sure that we're in a consistent state
5593 when this happens. */
5595 static Lisp_Object
5596 x_create_tip_frame (struct w32_display_info *dpyinfo,
5597 Lisp_Object parms, Lisp_Object text)
5599 struct frame *f;
5600 Lisp_Object frame;
5601 Lisp_Object name;
5602 long window_prompting = 0;
5603 int width, height;
5604 ptrdiff_t count = SPECPDL_INDEX ();
5605 struct gcpro gcpro1, gcpro2, gcpro3;
5606 struct kboard *kb;
5607 int face_change_count_before = face_change_count;
5608 Lisp_Object buffer;
5609 struct buffer *old_buffer;
5611 /* Use this general default value to start with until we know if
5612 this frame has a specified name. */
5613 Vx_resource_name = Vinvocation_name;
5615 kb = dpyinfo->terminal->kboard;
5617 /* The calls to x_get_arg remove elements from PARMS, so copy it to
5618 avoid destructive changes behind our caller's back. */
5619 parms = Fcopy_alist (parms);
5621 /* Get the name of the frame to use for resource lookup. */
5622 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
5623 if (!STRINGP (name)
5624 && !EQ (name, Qunbound)
5625 && !NILP (name))
5626 error ("Invalid frame name--not a string or nil");
5627 Vx_resource_name = name;
5629 frame = Qnil;
5630 GCPRO3 (parms, name, frame);
5631 /* Make a frame without minibuffer nor mode-line. */
5632 f = make_frame (0);
5633 f->wants_modeline = 0;
5634 XSETFRAME (frame, f);
5636 buffer = Fget_buffer_create (build_string (" *tip*"));
5637 /* Use set_window_buffer instead of Fset_window_buffer (see
5638 discussion of bug#11984, bug#12025, bug#12026). */
5639 set_window_buffer (FRAME_ROOT_WINDOW (f), buffer, 0, 0);
5640 old_buffer = current_buffer;
5641 set_buffer_internal_1 (XBUFFER (buffer));
5642 bset_truncate_lines (current_buffer, Qnil);
5643 specbind (Qinhibit_read_only, Qt);
5644 specbind (Qinhibit_modification_hooks, Qt);
5645 Ferase_buffer ();
5646 Finsert (1, &text);
5647 set_buffer_internal_1 (old_buffer);
5649 record_unwind_protect (unwind_create_tip_frame, frame);
5651 /* By setting the output method, we're essentially saying that
5652 the frame is live, as per FRAME_LIVE_P. If we get a signal
5653 from this point on, x_destroy_window might screw up reference
5654 counts etc. */
5655 f->terminal = dpyinfo->terminal;
5656 f->output_method = output_w32;
5657 f->output_data.w32 = xzalloc (sizeof (struct w32_output));
5659 FRAME_FONTSET (f) = -1;
5660 fset_icon_name (f, Qnil);
5662 #ifdef GLYPH_DEBUG
5663 image_cache_refcount =
5664 FRAME_IMAGE_CACHE (f) ? FRAME_IMAGE_CACHE (f)->refcount : 0;
5665 dpyinfo_refcount = dpyinfo->reference_count;
5666 #endif /* GLYPH_DEBUG */
5667 FRAME_KBOARD (f) = kb;
5668 f->output_data.w32->parent_desc = FRAME_W32_DISPLAY_INFO (f)->root_window;
5669 f->output_data.w32->explicit_parent = 0;
5671 /* Set the name; the functions to which we pass f expect the name to
5672 be set. */
5673 if (EQ (name, Qunbound) || NILP (name))
5675 fset_name (f, build_string (dpyinfo->w32_id_name));
5676 f->explicit_name = 0;
5678 else
5680 fset_name (f, name);
5681 f->explicit_name = 1;
5682 /* use the frame's title when getting resources for this frame. */
5683 specbind (Qx_resource_name, name);
5686 if (uniscribe_available)
5687 register_font_driver (&uniscribe_font_driver, f);
5688 register_font_driver (&w32font_driver, f);
5690 x_default_parameter (f, parms, Qfont_backend, Qnil,
5691 "fontBackend", "FontBackend", RES_TYPE_STRING);
5693 /* Extract the window parameters from the supplied values
5694 that are needed to determine window geometry. */
5695 x_default_font_parameter (f, parms);
5697 x_default_parameter (f, parms, Qborder_width, make_number (2),
5698 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
5699 /* This defaults to 2 in order to match xterm. We recognize either
5700 internalBorderWidth or internalBorder (which is what xterm calls
5701 it). */
5702 if (NILP (Fassq (Qinternal_border_width, parms)))
5704 Lisp_Object value;
5706 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
5707 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
5708 if (! EQ (value, Qunbound))
5709 parms = Fcons (Fcons (Qinternal_border_width, value),
5710 parms);
5712 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
5713 "internalBorderWidth", "internalBorderWidth",
5714 RES_TYPE_NUMBER);
5716 /* Also do the stuff which must be set before the window exists. */
5717 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
5718 "foreground", "Foreground", RES_TYPE_STRING);
5719 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
5720 "background", "Background", RES_TYPE_STRING);
5721 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
5722 "pointerColor", "Foreground", RES_TYPE_STRING);
5723 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
5724 "cursorColor", "Foreground", RES_TYPE_STRING);
5725 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
5726 "borderColor", "BorderColor", RES_TYPE_STRING);
5728 /* Init faces before x_default_parameter is called for scroll-bar
5729 parameters because that function calls x_set_scroll_bar_width,
5730 which calls change_frame_size, which calls Fset_window_buffer,
5731 which runs hooks, which call Fvertical_motion. At the end, we
5732 end up in init_iterator with a null face cache, which should not
5733 happen. */
5734 init_frame_faces (f);
5736 f->output_data.w32->dwStyle = WS_BORDER | WS_POPUP | WS_DISABLED;
5737 f->output_data.w32->parent_desc = FRAME_W32_DISPLAY_INFO (f)->root_window;
5739 window_prompting = x_figure_window_size (f, parms, 0);
5741 /* No fringes on tip frame. */
5742 f->fringe_cols = 0;
5743 f->left_fringe_width = 0;
5744 f->right_fringe_width = 0;
5746 block_input ();
5747 my_create_tip_window (f);
5748 unblock_input ();
5750 x_make_gc (f);
5752 x_default_parameter (f, parms, Qauto_raise, Qnil,
5753 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5754 x_default_parameter (f, parms, Qauto_lower, Qnil,
5755 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5756 x_default_parameter (f, parms, Qcursor_type, Qbox,
5757 "cursorType", "CursorType", RES_TYPE_SYMBOL);
5759 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
5760 Change will not be effected unless different from the current
5761 FRAME_LINES (f). */
5762 width = FRAME_COLS (f);
5763 height = FRAME_LINES (f);
5764 FRAME_LINES (f) = 0;
5765 SET_FRAME_COLS (f, 0);
5766 change_frame_size (f, height, width, 1, 0, 0);
5768 /* Add `tooltip' frame parameter's default value. */
5769 if (NILP (Fframe_parameter (frame, Qtooltip)))
5770 Fmodify_frame_parameters (frame, Fcons (Fcons (Qtooltip, Qt), Qnil));
5772 /* Set up faces after all frame parameters are known. This call
5773 also merges in face attributes specified for new frames.
5775 Frame parameters may be changed if .Xdefaults contains
5776 specifications for the default font. For example, if there is an
5777 `Emacs.default.attributeBackground: pink', the `background-color'
5778 attribute of the frame get's set, which let's the internal border
5779 of the tooltip frame appear in pink. Prevent this. */
5781 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
5782 Lisp_Object fg = Fframe_parameter (frame, Qforeground_color);
5783 Lisp_Object colors = Qnil;
5785 /* Set tip_frame here, so that */
5786 tip_frame = frame;
5787 call2 (Qface_set_after_frame_default, frame, Qnil);
5789 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
5790 colors = Fcons (Fcons (Qbackground_color, bg), colors);
5791 if (!EQ (fg, Fframe_parameter (frame, Qforeground_color)))
5792 colors = Fcons (Fcons (Qforeground_color, fg), colors);
5794 if (!NILP (colors))
5795 Fmodify_frame_parameters (frame, colors);
5798 f->no_split = 1;
5800 UNGCPRO;
5802 /* Now that the frame is official, it counts as a reference to
5803 its display. */
5804 FRAME_W32_DISPLAY_INFO (f)->reference_count++;
5805 f->terminal->reference_count++;
5807 /* It is now ok to make the frame official even if we get an error
5808 below. And the frame needs to be on Vframe_list or making it
5809 visible won't work. */
5810 Vframe_list = Fcons (frame, Vframe_list);
5812 /* Setting attributes of faces of the tooltip frame from resources
5813 and similar will increment face_change_count, which leads to the
5814 clearing of all current matrices. Since this isn't necessary
5815 here, avoid it by resetting face_change_count to the value it
5816 had before we created the tip frame. */
5817 face_change_count = face_change_count_before;
5819 /* Discard the unwind_protect. */
5820 return unbind_to (count, frame);
5824 /* Compute where to display tip frame F. PARMS is the list of frame
5825 parameters for F. DX and DY are specified offsets from the current
5826 location of the mouse. WIDTH and HEIGHT are the width and height
5827 of the tooltip. Return coordinates relative to the root window of
5828 the display in *ROOT_X, and *ROOT_Y. */
5830 static void
5831 compute_tip_xy (struct frame *f,
5832 Lisp_Object parms, Lisp_Object dx, Lisp_Object dy,
5833 int width, int height, int *root_x, int *root_y)
5835 Lisp_Object left, top;
5836 int min_x, min_y, max_x, max_y;
5838 /* User-specified position? */
5839 left = Fcdr (Fassq (Qleft, parms));
5840 top = Fcdr (Fassq (Qtop, parms));
5842 /* Move the tooltip window where the mouse pointer is. Resize and
5843 show it. */
5844 if (!INTEGERP (left) || !INTEGERP (top))
5846 POINT pt;
5848 /* Default min and max values. */
5849 min_x = 0;
5850 min_y = 0;
5851 max_x = x_display_pixel_width (FRAME_W32_DISPLAY_INFO (f));
5852 max_y = x_display_pixel_height (FRAME_W32_DISPLAY_INFO (f));
5854 block_input ();
5855 GetCursorPos (&pt);
5856 *root_x = pt.x;
5857 *root_y = pt.y;
5858 unblock_input ();
5860 /* If multiple monitor support is available, constrain the tip onto
5861 the current monitor. This improves the above by allowing negative
5862 co-ordinates if monitor positions are such that they are valid, and
5863 snaps a tooltip onto a single monitor if we are close to the edge
5864 where it would otherwise flow onto the other monitor (or into
5865 nothingness if there is a gap in the overlap). */
5866 if (monitor_from_point_fn && get_monitor_info_fn)
5868 struct MONITOR_INFO info;
5869 HMONITOR monitor
5870 = monitor_from_point_fn (pt, MONITOR_DEFAULT_TO_NEAREST);
5871 info.cbSize = sizeof (info);
5873 if (get_monitor_info_fn (monitor, &info))
5875 min_x = info.rcWork.left;
5876 min_y = info.rcWork.top;
5877 max_x = info.rcWork.right;
5878 max_y = info.rcWork.bottom;
5883 if (INTEGERP (top))
5884 *root_y = XINT (top);
5885 else if (*root_y + XINT (dy) <= min_y)
5886 *root_y = min_y; /* Can happen for negative dy */
5887 else if (*root_y + XINT (dy) + height <= max_y)
5888 /* It fits below the pointer */
5889 *root_y += XINT (dy);
5890 else if (height + XINT (dy) + min_y <= *root_y)
5891 /* It fits above the pointer. */
5892 *root_y -= height + XINT (dy);
5893 else
5894 /* Put it on the top. */
5895 *root_y = min_y;
5897 if (INTEGERP (left))
5898 *root_x = XINT (left);
5899 else if (*root_x + XINT (dx) <= min_x)
5900 *root_x = 0; /* Can happen for negative dx */
5901 else if (*root_x + XINT (dx) + width <= max_x)
5902 /* It fits to the right of the pointer. */
5903 *root_x += XINT (dx);
5904 else if (width + XINT (dx) + min_x <= *root_x)
5905 /* It fits to the left of the pointer. */
5906 *root_x -= width + XINT (dx);
5907 else
5908 /* Put it left justified on the screen -- it ought to fit that way. */
5909 *root_x = min_x;
5913 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
5914 doc: /* Show STRING in a \"tooltip\" window on frame FRAME.
5915 A tooltip window is a small window displaying a string.
5917 This is an internal function; Lisp code should call `tooltip-show'.
5919 FRAME nil or omitted means use the selected frame.
5921 PARMS is an optional list of frame parameters which can be
5922 used to change the tooltip's appearance.
5924 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
5925 means use the default timeout of 5 seconds.
5927 If the list of frame parameters PARMS contains a `left' parameter,
5928 the tooltip is displayed at that x-position. Otherwise it is
5929 displayed at the mouse position, with offset DX added (default is 5 if
5930 DX isn't specified). Likewise for the y-position; if a `top' frame
5931 parameter is specified, it determines the y-position of the tooltip
5932 window, otherwise it is displayed at the mouse position, with offset
5933 DY added (default is -10).
5935 A tooltip's maximum size is specified by `x-max-tooltip-size'.
5936 Text larger than the specified size is clipped. */)
5937 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
5939 struct frame *f;
5940 struct window *w;
5941 int root_x, root_y;
5942 struct buffer *old_buffer;
5943 struct text_pos pos;
5944 int i, width, height, seen_reversed_p;
5945 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
5946 int old_windows_or_buffers_changed = windows_or_buffers_changed;
5947 ptrdiff_t count = SPECPDL_INDEX ();
5949 specbind (Qinhibit_redisplay, Qt);
5951 GCPRO4 (string, parms, frame, timeout);
5953 CHECK_STRING (string);
5954 f = decode_window_system_frame (frame);
5955 if (NILP (timeout))
5956 timeout = make_number (5);
5957 else
5958 CHECK_NATNUM (timeout);
5960 if (NILP (dx))
5961 dx = make_number (5);
5962 else
5963 CHECK_NUMBER (dx);
5965 if (NILP (dy))
5966 dy = make_number (-10);
5967 else
5968 CHECK_NUMBER (dy);
5970 if (NILP (last_show_tip_args))
5971 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
5973 if (!NILP (tip_frame))
5975 Lisp_Object last_string = AREF (last_show_tip_args, 0);
5976 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
5977 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
5979 if (EQ (frame, last_frame)
5980 && !NILP (Fequal (last_string, string))
5981 && !NILP (Fequal (last_parms, parms)))
5983 struct frame *f = XFRAME (tip_frame);
5985 /* Only DX and DY have changed. */
5986 if (!NILP (tip_timer))
5988 Lisp_Object timer = tip_timer;
5989 tip_timer = Qnil;
5990 call1 (Qcancel_timer, timer);
5993 block_input ();
5994 compute_tip_xy (f, parms, dx, dy, FRAME_PIXEL_WIDTH (f),
5995 FRAME_PIXEL_HEIGHT (f), &root_x, &root_y);
5997 /* Put tooltip in topmost group and in position. */
5998 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOPMOST,
5999 root_x, root_y, 0, 0,
6000 SWP_NOSIZE | SWP_NOACTIVATE);
6002 /* Ensure tooltip is on top of other topmost windows (eg menus). */
6003 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOP,
6004 0, 0, 0, 0,
6005 SWP_NOMOVE | SWP_NOSIZE | SWP_NOACTIVATE);
6007 unblock_input ();
6008 goto start_timer;
6012 /* Hide a previous tip, if any. */
6013 Fx_hide_tip ();
6015 ASET (last_show_tip_args, 0, string);
6016 ASET (last_show_tip_args, 1, frame);
6017 ASET (last_show_tip_args, 2, parms);
6019 /* Add default values to frame parameters. */
6020 if (NILP (Fassq (Qname, parms)))
6021 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
6022 if (NILP (Fassq (Qinternal_border_width, parms)))
6023 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
6024 if (NILP (Fassq (Qborder_width, parms)))
6025 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
6026 if (NILP (Fassq (Qborder_color, parms)))
6027 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
6028 if (NILP (Fassq (Qbackground_color, parms)))
6029 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
6030 parms);
6032 /* Block input until the tip has been fully drawn, to avoid crashes
6033 when drawing tips in menus. */
6034 block_input ();
6036 /* Create a frame for the tooltip, and record it in the global
6037 variable tip_frame. */
6038 frame = x_create_tip_frame (FRAME_W32_DISPLAY_INFO (f), parms, string);
6039 f = XFRAME (frame);
6041 /* Set up the frame's root window. */
6042 w = XWINDOW (FRAME_ROOT_WINDOW (f));
6043 w->left_col = 0;
6044 w->top_line = 0;
6046 if (CONSP (Vx_max_tooltip_size)
6047 && INTEGERP (XCAR (Vx_max_tooltip_size))
6048 && XINT (XCAR (Vx_max_tooltip_size)) > 0
6049 && INTEGERP (XCDR (Vx_max_tooltip_size))
6050 && XINT (XCDR (Vx_max_tooltip_size)) > 0)
6052 w->total_cols = XFASTINT (XCAR (Vx_max_tooltip_size));
6053 w->total_lines = XFASTINT (XCDR (Vx_max_tooltip_size));
6055 else
6057 w->total_cols = 80;
6058 w->total_lines = 40;
6061 FRAME_TOTAL_COLS (f) = WINDOW_TOTAL_COLS (w);
6062 adjust_glyphs (f);
6063 w->pseudo_window_p = 1;
6065 /* Display the tooltip text in a temporary buffer. */
6066 old_buffer = current_buffer;
6067 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->contents));
6068 bset_truncate_lines (current_buffer, Qnil);
6069 clear_glyph_matrix (w->desired_matrix);
6070 clear_glyph_matrix (w->current_matrix);
6071 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
6072 try_window (FRAME_ROOT_WINDOW (f), pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
6074 /* Compute width and height of the tooltip. */
6075 width = height = seen_reversed_p = 0;
6076 for (i = 0; i < w->desired_matrix->nrows; ++i)
6078 struct glyph_row *row = &w->desired_matrix->rows[i];
6079 struct glyph *last;
6080 int row_width;
6082 /* Stop at the first empty row at the end. */
6083 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
6084 break;
6086 /* Let the row go over the full width of the frame. */
6087 row->full_width_p = 1;
6089 row_width = row->pixel_width;
6090 if (row->used[TEXT_AREA])
6092 if (!row->reversed_p)
6094 /* There's a glyph at the end of rows that is used to
6095 place the cursor there. Don't include the width of
6096 this glyph. */
6097 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
6098 if (INTEGERP (last->object))
6099 row_width -= last->pixel_width;
6101 else
6103 /* There could be a stretch glyph at the beginning of R2L
6104 rows that is produced by extend_face_to_end_of_line.
6105 Don't count that glyph. */
6106 struct glyph *g = row->glyphs[TEXT_AREA];
6108 if (g->type == STRETCH_GLYPH && INTEGERP (g->object))
6110 row_width -= g->pixel_width;
6111 seen_reversed_p = 1;
6116 height += row->height;
6117 width = max (width, row_width);
6120 /* If we've seen partial-length R2L rows, we need to re-adjust the
6121 tool-tip frame width and redisplay it again, to avoid over-wide
6122 tips due to the stretch glyph that extends R2L lines to full
6123 width of the frame. */
6124 if (seen_reversed_p)
6126 /* w->total_cols and FRAME_TOTAL_COLS want the width in columns,
6127 not in pixels. */
6128 width /= WINDOW_FRAME_COLUMN_WIDTH (w);
6129 w->total_cols = width;
6130 FRAME_TOTAL_COLS (f) = width;
6131 adjust_glyphs (f);
6132 w->pseudo_window_p = 1;
6133 clear_glyph_matrix (w->desired_matrix);
6134 clear_glyph_matrix (w->current_matrix);
6135 try_window (FRAME_ROOT_WINDOW (f), pos, TRY_WINDOW_IGNORE_FONTS_CHANGE);
6136 width = height = 0;
6137 /* Recompute width and height of the tooltip. */
6138 for (i = 0; i < w->desired_matrix->nrows; ++i)
6140 struct glyph_row *row = &w->desired_matrix->rows[i];
6141 struct glyph *last;
6142 int row_width;
6144 if (!row->enabled_p || !MATRIX_ROW_DISPLAYS_TEXT_P (row))
6145 break;
6146 row->full_width_p = 1;
6147 row_width = row->pixel_width;
6148 if (row->used[TEXT_AREA] && !row->reversed_p)
6150 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
6151 if (INTEGERP (last->object))
6152 row_width -= last->pixel_width;
6155 height += row->height;
6156 width = max (width, row_width);
6160 /* Round up the height to an integral multiple of FRAME_LINE_HEIGHT. */
6161 if (height % FRAME_LINE_HEIGHT (f) != 0)
6162 height += FRAME_LINE_HEIGHT (f) - height % FRAME_LINE_HEIGHT (f);
6163 /* Add the frame's internal border to the width and height the w32
6164 window should have. */
6165 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
6166 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
6168 /* Move the tooltip window where the mouse pointer is. Resize and
6169 show it. */
6170 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
6173 /* Adjust Window size to take border into account. */
6174 RECT rect;
6175 rect.left = rect.top = 0;
6176 rect.right = width;
6177 rect.bottom = height;
6178 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
6179 FRAME_EXTERNAL_MENU_BAR (f));
6181 /* Position and size tooltip, and put it in the topmost group.
6182 The add-on of FRAME_COLUMN_WIDTH to the 5th argument is a
6183 peculiarity of w32 display: without it, some fonts cause the
6184 last character of the tip to be truncated or wrapped around to
6185 the next line. */
6186 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOPMOST,
6187 root_x, root_y,
6188 rect.right - rect.left + FRAME_COLUMN_WIDTH (f),
6189 rect.bottom - rect.top, SWP_NOACTIVATE);
6191 /* Ensure tooltip is on top of other topmost windows (eg menus). */
6192 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOP,
6193 0, 0, 0, 0,
6194 SWP_NOMOVE | SWP_NOSIZE | SWP_NOACTIVATE);
6196 /* Let redisplay know that we have made the frame visible already. */
6197 SET_FRAME_VISIBLE (f, 1);
6199 ShowWindow (FRAME_W32_WINDOW (f), SW_SHOWNOACTIVATE);
6202 /* Draw into the window. */
6203 w->must_be_updated_p = 1;
6204 update_single_window (w, 1);
6206 unblock_input ();
6208 /* Restore original current buffer. */
6209 set_buffer_internal_1 (old_buffer);
6210 windows_or_buffers_changed = old_windows_or_buffers_changed;
6212 start_timer:
6213 /* Let the tip disappear after timeout seconds. */
6214 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
6215 intern ("x-hide-tip"));
6217 UNGCPRO;
6218 return unbind_to (count, Qnil);
6222 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
6223 doc: /* Hide the current tooltip window, if there is any.
6224 Value is t if tooltip was open, nil otherwise. */)
6225 (void)
6227 ptrdiff_t count;
6228 Lisp_Object deleted, frame, timer;
6229 struct gcpro gcpro1, gcpro2;
6231 /* Return quickly if nothing to do. */
6232 if (NILP (tip_timer) && NILP (tip_frame))
6233 return Qnil;
6235 frame = tip_frame;
6236 timer = tip_timer;
6237 GCPRO2 (frame, timer);
6238 tip_frame = tip_timer = deleted = Qnil;
6240 count = SPECPDL_INDEX ();
6241 specbind (Qinhibit_redisplay, Qt);
6242 specbind (Qinhibit_quit, Qt);
6244 if (!NILP (timer))
6245 call1 (Qcancel_timer, timer);
6247 if (FRAMEP (frame))
6249 delete_frame (frame, Qnil);
6250 deleted = Qt;
6253 UNGCPRO;
6254 return unbind_to (count, deleted);
6257 /***********************************************************************
6258 File selection dialog
6259 ***********************************************************************/
6261 #define FILE_NAME_TEXT_FIELD edt1
6262 #define FILE_NAME_COMBO_BOX cmb13
6263 #define FILE_NAME_LIST lst1
6265 /* Callback for altering the behavior of the Open File dialog.
6266 Makes the Filename text field contain "Current Directory" and be
6267 read-only when "Directories" is selected in the filter. This
6268 allows us to work around the fact that the standard Open File
6269 dialog does not support directories. */
6270 static UINT_PTR CALLBACK
6271 file_dialog_callback (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
6273 if (msg == WM_NOTIFY)
6275 #ifdef NTGUI_UNICODE
6276 OFNOTIFYW * notify = (OFNOTIFYW *)lParam;
6277 #else /* !NTGUI_UNICODE */
6278 OFNOTIFYA * notify = (OFNOTIFYA *)lParam;
6279 #endif /* NTGUI_UNICODE */
6280 /* Detect when the Filter dropdown is changed. */
6281 if (notify->hdr.code == CDN_TYPECHANGE
6282 || notify->hdr.code == CDN_INITDONE)
6284 HWND dialog = GetParent (hwnd);
6285 HWND edit_control = GetDlgItem (dialog, FILE_NAME_TEXT_FIELD);
6286 HWND list = GetDlgItem (dialog, FILE_NAME_LIST);
6288 /* At least on Windows 7, the above attempt to get the window handle
6289 to the File Name Text Field fails. The following code does the
6290 job though. Note that this code is based on my examination of the
6291 window hierarchy using Microsoft Spy++. bk */
6292 if (edit_control == NULL)
6294 HWND tmp = GetDlgItem (dialog, FILE_NAME_COMBO_BOX);
6295 if (tmp)
6297 tmp = GetWindow (tmp, GW_CHILD);
6298 if (tmp)
6299 edit_control = GetWindow (tmp, GW_CHILD);
6303 /* Directories is in index 2. */
6304 if (notify->lpOFN->nFilterIndex == 2)
6306 CommDlg_OpenSave_SetControlText (dialog, FILE_NAME_TEXT_FIELD,
6307 GUISTR ("Current Directory"));
6308 EnableWindow (edit_control, FALSE);
6309 /* Note that at least on Windows 7, the above call to EnableWindow
6310 disables the window that would ordinarily have focus. If we
6311 do not set focus to some other window here, focus will land in
6312 no man's land and the user will be unable to tab through the
6313 dialog box (pressing tab will only result in a beep).
6314 Avoid that problem by setting focus to the list here. */
6315 if (notify->hdr.code == CDN_INITDONE)
6316 SetFocus (list);
6318 else
6320 /* Don't override default filename on init done. */
6321 if (notify->hdr.code == CDN_TYPECHANGE)
6322 CommDlg_OpenSave_SetControlText (dialog,
6323 FILE_NAME_TEXT_FIELD,
6324 GUISTR (""));
6325 EnableWindow (edit_control, TRUE);
6329 return 0;
6332 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
6333 doc: /* Read file name, prompting with PROMPT in directory DIR.
6334 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
6335 selection box, if specified. If MUSTMATCH is non-nil, the returned file
6336 or directory must exist.
6338 This function is only defined on NS, MS Windows, and X Windows with the
6339 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
6340 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
6341 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
6343 /* Filter index: 1: All Files, 2: Directories only */
6344 static const guichar_t filter[] =
6345 GUISTR ("All Files (*.*)\0*.*\0Directories\0*|*\0");
6347 Lisp_Object filename = default_filename;
6348 struct frame *f = SELECTED_FRAME ();
6349 BOOL file_opened = FALSE;
6350 Lisp_Object orig_dir = dir;
6351 Lisp_Object orig_prompt = prompt;
6353 /* If we compile with _WIN32_WINNT set to 0x0400 (for NT4
6354 compatibility) we end up with the old file dialogs. Define a big
6355 enough struct for the new dialog to trick GetOpenFileName into
6356 giving us the new dialogs on newer versions of Windows. */
6357 struct {
6358 #ifdef NTGUI_UNICODE
6359 OPENFILENAMEW details;
6360 #else /* !NTGUI_UNICODE */
6361 OPENFILENAMEA details;
6362 #endif /* NTGUI_UNICODE */
6364 #if _WIN32_WINNT < 0x500 /* < win2k */
6365 PVOID pvReserved;
6366 DWORD dwReserved;
6367 DWORD FlagsEx;
6368 #endif /* < win2k */
6369 } new_file_details;
6371 #ifdef NTGUI_UNICODE
6372 wchar_t filename_buf[32*1024 + 1]; // NT kernel maximum
6373 OPENFILENAMEW * file_details = &new_file_details.details;
6374 #else /* not NTGUI_UNICODE */
6375 char filename_buf[MAX_PATH + 1];
6376 OPENFILENAMEA * file_details = &new_file_details.details;
6377 #endif /* NTGUI_UNICODE */
6379 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
6380 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, filename);
6383 struct gcpro gcpro1, gcpro2;
6384 GCPRO2 (orig_dir, orig_prompt); /* There is no GCPRON, N>6. */
6386 /* Note: under NTGUI_UNICODE, we do _NOT_ use ENCODE_FILE: the
6387 system file encoding expected by the platform APIs (e.g. Cygwin's
6388 POSIX implementation) may not be the same as the encoding expected
6389 by the Windows "ANSI" APIs! */
6391 CHECK_STRING (prompt);
6392 CHECK_STRING (dir);
6394 dir = Fexpand_file_name (dir, Qnil);
6396 if (STRINGP (filename))
6397 filename = Ffile_name_nondirectory (filename);
6398 else
6399 filename = empty_unibyte_string;
6401 #ifdef CYGWIN
6402 dir = Fcygwin_convert_file_name_to_windows (dir, Qt);
6403 if (SCHARS (filename) > 0)
6404 filename = Fcygwin_convert_file_name_to_windows (filename, Qnil);
6405 #endif
6407 CHECK_STRING (dir);
6408 CHECK_STRING (filename);
6410 /* The code in file_dialog_callback that attempts to set the text
6411 of the file name edit window when handling the CDN_INITDONE
6412 WM_NOTIFY message does not work. Setting filename to "Current
6413 Directory" in the only_dir_p case here does work however. */
6414 if (SCHARS (filename) == 0 && ! NILP (only_dir_p))
6415 filename = build_string ("Current Directory");
6417 /* Convert the values we've computed so far to system form. */
6418 #ifdef NTGUI_UNICODE
6419 to_unicode (prompt, &prompt);
6420 to_unicode (dir, &dir);
6421 to_unicode (filename, &filename);
6422 #else /* !NTGUI_UNICODE */
6423 prompt = ENCODE_FILE (prompt);
6424 dir = ENCODE_FILE (dir);
6425 filename = ENCODE_FILE (filename);
6427 /* We modify these in-place, so make copies for safety. */
6428 dir = Fcopy_sequence (dir);
6429 unixtodos_filename (SDATA (dir));
6430 filename = Fcopy_sequence (filename);
6431 unixtodos_filename (SDATA (filename));
6432 #endif /* NTGUI_UNICODE */
6434 /* Fill in the structure for the call to GetOpenFileName below.
6435 For NTGUI_UNICODE builds (which run only on NT), we just use
6436 the actual size of the structure. For non-NTGUI_UNICODE
6437 builds, we tell the OS we're using an old version of the
6438 structure if the OS isn't new enough to support the newer
6439 version. */
6440 memset (&new_file_details, 0, sizeof (new_file_details));
6442 if (w32_major_version > 4 && w32_major_version < 95)
6443 file_details->lStructSize = sizeof (new_file_details);
6444 else
6445 file_details->lStructSize = sizeof (*file_details);
6447 /* Set up the inout parameter for the selected file name. */
6448 if (SBYTES (filename) + 1 > sizeof (filename_buf))
6449 report_file_error ("filename too long", default_filename);
6451 memcpy (filename_buf, SDATA (filename), SBYTES (filename) + 1);
6452 file_details->lpstrFile = filename_buf;
6453 file_details->nMaxFile = sizeof (filename_buf) / sizeof (*filename_buf);
6455 file_details->hwndOwner = FRAME_W32_WINDOW (f);
6456 /* Undocumented Bug in Common File Dialog:
6457 If a filter is not specified, shell links are not resolved. */
6458 file_details->lpstrFilter = filter;
6459 file_details->lpstrInitialDir = (guichar_t*) SDATA (dir);
6460 file_details->lpstrTitle = (guichar_t*) SDATA (prompt);
6461 file_details->nFilterIndex = NILP (only_dir_p) ? 1 : 2;
6462 file_details->Flags = (OFN_HIDEREADONLY | OFN_NOCHANGEDIR
6463 | OFN_EXPLORER | OFN_ENABLEHOOK);
6465 if (!NILP (mustmatch))
6467 /* Require that the path to the parent directory exists. */
6468 file_details->Flags |= OFN_PATHMUSTEXIST;
6469 /* If we are looking for a file, require that it exists. */
6470 if (NILP (only_dir_p))
6471 file_details->Flags |= OFN_FILEMUSTEXIST;
6475 int count = SPECPDL_INDEX ();
6476 /* Prevent redisplay. */
6477 specbind (Qinhibit_redisplay, Qt);
6478 block_input ();
6479 file_details->lpfnHook = file_dialog_callback;
6481 file_opened = GUI_FN (GetOpenFileName) (file_details);
6482 unblock_input ();
6483 unbind_to (count, Qnil);
6486 if (file_opened)
6488 /* Get an Emacs string from the value Windows gave us. */
6489 #ifdef NTGUI_UNICODE
6490 filename = from_unicode_buffer (filename_buf);
6491 #else /* !NTGUI_UNICODE */
6492 dostounix_filename (filename_buf, 0);
6493 filename = DECODE_FILE (build_string (filename_buf));
6494 #endif /* NTGUI_UNICODE */
6496 #ifdef CYGWIN
6497 filename = Fcygwin_convert_file_name_from_windows (filename, Qt);
6498 #endif /* CYGWIN */
6500 /* Strip the dummy filename off the end of the string if we
6501 added it to select a directory. */
6502 if (file_details->nFilterIndex == 2)
6504 filename = Ffile_name_directory (filename);
6507 /* User canceled the dialog without making a selection. */
6508 else if (!CommDlgExtendedError ())
6509 filename = Qnil;
6510 /* An error occurred, fallback on reading from the mini-buffer. */
6511 else
6512 filename = Fcompleting_read (
6513 orig_prompt,
6514 intern ("read-file-name-internal"),
6515 orig_dir,
6516 mustmatch,
6517 orig_dir,
6518 Qfile_name_history,
6519 default_filename,
6520 Qnil);
6522 UNGCPRO;
6525 /* Make "Cancel" equivalent to C-g. */
6526 if (NILP (filename))
6527 Fsignal (Qquit, Qnil);
6529 RETURN_UNGCPRO (filename);
6533 #ifdef WINDOWSNT
6534 /* Moving files to the system recycle bin.
6535 Used by `move-file-to-trash' instead of the default moving to ~/.Trash */
6536 DEFUN ("system-move-file-to-trash", Fsystem_move_file_to_trash,
6537 Ssystem_move_file_to_trash, 1, 1, 0,
6538 doc: /* Move file or directory named FILENAME to the recycle bin. */)
6539 (Lisp_Object filename)
6541 Lisp_Object handler;
6542 Lisp_Object encoded_file;
6543 Lisp_Object operation;
6545 operation = Qdelete_file;
6546 if (!NILP (Ffile_directory_p (filename))
6547 && NILP (Ffile_symlink_p (filename)))
6549 operation = intern ("delete-directory");
6550 filename = Fdirectory_file_name (filename);
6552 filename = Fexpand_file_name (filename, Qnil);
6554 handler = Ffind_file_name_handler (filename, operation);
6555 if (!NILP (handler))
6556 return call2 (handler, operation, filename);
6558 encoded_file = ENCODE_FILE (filename);
6561 const char * path;
6562 SHFILEOPSTRUCT file_op;
6563 char tmp_path[MAX_PATH + 1];
6565 path = map_w32_filename (SDATA (encoded_file), NULL);
6567 /* On Windows, write permission is required to delete/move files. */
6568 _chmod (path, 0666);
6570 memset (tmp_path, 0, sizeof (tmp_path));
6571 strcpy (tmp_path, path);
6573 memset (&file_op, 0, sizeof (file_op));
6574 file_op.hwnd = HWND_DESKTOP;
6575 file_op.wFunc = FO_DELETE;
6576 file_op.pFrom = tmp_path;
6577 file_op.fFlags = FOF_SILENT | FOF_NOCONFIRMATION | FOF_ALLOWUNDO
6578 | FOF_NOERRORUI | FOF_NO_CONNECTED_ELEMENTS;
6579 file_op.fAnyOperationsAborted = FALSE;
6581 if (SHFileOperation (&file_op) != 0)
6582 report_file_error ("Removing old name", list1 (filename));
6584 return Qnil;
6587 #endif /* WINDOWSNT */
6590 /***********************************************************************
6591 w32 specialized functions
6592 ***********************************************************************/
6594 DEFUN ("w32-send-sys-command", Fw32_send_sys_command,
6595 Sw32_send_sys_command, 1, 2, 0,
6596 doc: /* Send frame a Windows WM_SYSCOMMAND message of type COMMAND.
6597 Some useful values for COMMAND are #xf030 to maximize frame (#xf020
6598 to minimize), #xf120 to restore frame to original size, and #xf100
6599 to activate the menubar for keyboard access. #xf140 activates the
6600 screen saver if defined.
6602 If optional parameter FRAME is not specified, use selected frame. */)
6603 (Lisp_Object command, Lisp_Object frame)
6605 struct frame *f = decode_window_system_frame (frame);
6607 CHECK_NUMBER (command);
6609 PostMessage (FRAME_W32_WINDOW (f), WM_SYSCOMMAND, XINT (command), 0);
6611 return Qnil;
6614 DEFUN ("w32-shell-execute", Fw32_shell_execute, Sw32_shell_execute, 2, 4, 0,
6615 doc: /* Get Windows to perform OPERATION on DOCUMENT.
6616 This is a wrapper around the ShellExecute system function, which
6617 invokes the application registered to handle OPERATION for DOCUMENT.
6619 OPERATION is either nil or a string that names a supported operation.
6620 What operations can be used depends on the particular DOCUMENT and its
6621 handler application, but typically it is one of the following common
6622 operations:
6624 \"open\" - open DOCUMENT, which could be a file, a directory, or an
6625 executable program. If it is an application, that
6626 application is launched in the current buffer's default
6627 directory. Otherwise, the application associated with
6628 DOCUMENT is launched in the buffer's default directory.
6629 \"print\" - print DOCUMENT, which must be a file
6630 \"explore\" - start the Windows Explorer on DOCUMENT
6631 \"edit\" - launch an editor and open DOCUMENT for editing; which
6632 editor is launched depends on the association for the
6633 specified DOCUMENT
6634 \"find\" - initiate search starting from DOCUMENT which must specify
6635 a directory
6636 nil - invoke the default OPERATION, or \"open\" if default is
6637 not defined or unavailable
6639 DOCUMENT is typically the name of a document file or a URL, but can
6640 also be a program executable to run, or a directory to open in the
6641 Windows Explorer.
6643 If DOCUMENT is a program executable, the optional third arg PARAMETERS
6644 can be a string containing command line parameters that will be passed
6645 to the program; otherwise, PARAMETERS should be nil or unspecified.
6647 Optional fourth argument SHOW-FLAG can be used to control how the
6648 application will be displayed when it is invoked. If SHOW-FLAG is nil
6649 or unspecified, the application is displayed normally, otherwise it is
6650 an integer representing a ShowWindow flag:
6652 0 - start hidden
6653 1 - start normally
6654 3 - start maximized
6655 6 - start minimized */)
6656 (Lisp_Object operation, Lisp_Object document, Lisp_Object parameters, Lisp_Object show_flag)
6658 Lisp_Object current_dir;
6659 char *errstr;
6661 CHECK_STRING (document);
6663 /* Encode filename, current directory and parameters. */
6664 current_dir = BVAR (current_buffer, directory);
6666 #ifdef CYGWIN
6667 current_dir = Fcygwin_convert_file_name_to_windows (current_dir, Qt);
6668 if (STRINGP (document))
6669 document = Fcygwin_convert_file_name_to_windows (document, Qt);
6670 #endif /* CYGWIN */
6672 current_dir = GUI_ENCODE_FILE (current_dir);
6673 if (STRINGP (document))
6674 document = GUI_ENCODE_FILE (document);
6675 if (STRINGP (parameters))
6676 parameters = GUI_ENCODE_SYSTEM (parameters);
6678 if ((int) GUI_FN (ShellExecute) (NULL,
6679 (STRINGP (operation) ?
6680 GUI_SDATA (operation) : NULL),
6681 GUI_SDATA (document),
6682 (STRINGP (parameters) ?
6683 GUI_SDATA (parameters) : NULL),
6684 GUI_SDATA (current_dir),
6685 (INTEGERP (show_flag) ?
6686 XINT (show_flag) : SW_SHOWDEFAULT))
6687 > 32)
6688 return Qt;
6689 errstr = w32_strerror (0);
6690 /* The error string might be encoded in the locale's encoding. */
6691 if (!NILP (Vlocale_coding_system))
6693 Lisp_Object decoded =
6694 code_convert_string_norecord (build_unibyte_string (errstr),
6695 Vlocale_coding_system, 0);
6696 errstr = SSDATA (decoded);
6698 error ("ShellExecute failed: %s", errstr);
6701 /* Lookup virtual keycode from string representing the name of a
6702 non-ascii keystroke into the corresponding virtual key, using
6703 lispy_function_keys. */
6704 static int
6705 lookup_vk_code (char *key)
6707 int i;
6709 for (i = 0; i < 256; i++)
6710 if (lispy_function_keys[i]
6711 && strcmp (lispy_function_keys[i], key) == 0)
6712 return i;
6714 return -1;
6717 /* Convert a one-element vector style key sequence to a hot key
6718 definition. */
6719 static Lisp_Object
6720 w32_parse_hot_key (Lisp_Object key)
6722 /* Copied from Fdefine_key and store_in_keymap. */
6723 register Lisp_Object c;
6724 int vk_code;
6725 int lisp_modifiers;
6726 int w32_modifiers;
6727 struct gcpro gcpro1;
6729 CHECK_VECTOR (key);
6731 if (ASIZE (key) != 1)
6732 return Qnil;
6734 GCPRO1 (key);
6736 c = AREF (key, 0);
6738 if (CONSP (c) && lucid_event_type_list_p (c))
6739 c = Fevent_convert_list (c);
6741 UNGCPRO;
6743 if (! INTEGERP (c) && ! SYMBOLP (c))
6744 error ("Key definition is invalid");
6746 /* Work out the base key and the modifiers. */
6747 if (SYMBOLP (c))
6749 c = parse_modifiers (c);
6750 lisp_modifiers = XINT (Fcar (Fcdr (c)));
6751 c = Fcar (c);
6752 if (!SYMBOLP (c))
6753 emacs_abort ();
6754 vk_code = lookup_vk_code (SDATA (SYMBOL_NAME (c)));
6756 else if (INTEGERP (c))
6758 lisp_modifiers = XINT (c) & ~CHARACTERBITS;
6759 /* Many ascii characters are their own virtual key code. */
6760 vk_code = XINT (c) & CHARACTERBITS;
6763 if (vk_code < 0 || vk_code > 255)
6764 return Qnil;
6766 if ((lisp_modifiers & meta_modifier) != 0
6767 && !NILP (Vw32_alt_is_meta))
6768 lisp_modifiers |= alt_modifier;
6770 /* Supply defs missing from mingw32. */
6771 #ifndef MOD_ALT
6772 #define MOD_ALT 0x0001
6773 #define MOD_CONTROL 0x0002
6774 #define MOD_SHIFT 0x0004
6775 #define MOD_WIN 0x0008
6776 #endif
6778 /* Convert lisp modifiers to Windows hot-key form. */
6779 w32_modifiers = (lisp_modifiers & hyper_modifier) ? MOD_WIN : 0;
6780 w32_modifiers |= (lisp_modifiers & alt_modifier) ? MOD_ALT : 0;
6781 w32_modifiers |= (lisp_modifiers & ctrl_modifier) ? MOD_CONTROL : 0;
6782 w32_modifiers |= (lisp_modifiers & shift_modifier) ? MOD_SHIFT : 0;
6784 return HOTKEY (vk_code, w32_modifiers);
6787 DEFUN ("w32-register-hot-key", Fw32_register_hot_key,
6788 Sw32_register_hot_key, 1, 1, 0,
6789 doc: /* Register KEY as a hot-key combination.
6790 Certain key combinations like Alt-Tab are reserved for system use on
6791 Windows, and therefore are normally intercepted by the system. However,
6792 most of these key combinations can be received by registering them as
6793 hot-keys, overriding their special meaning.
6795 KEY must be a one element key definition in vector form that would be
6796 acceptable to `define-key' (e.g. [A-tab] for Alt-Tab). The meta
6797 modifier is interpreted as Alt if `w32-alt-is-meta' is t, and hyper
6798 is always interpreted as the Windows modifier keys.
6800 The return value is the hotkey-id if registered, otherwise nil. */)
6801 (Lisp_Object key)
6803 key = w32_parse_hot_key (key);
6805 if (!NILP (key) && NILP (Fmemq (key, w32_grabbed_keys)))
6807 /* Reuse an empty slot if possible. */
6808 Lisp_Object item = Fmemq (Qnil, w32_grabbed_keys);
6810 /* Safe to add new key to list, even if we have focus. */
6811 if (NILP (item))
6812 w32_grabbed_keys = Fcons (key, w32_grabbed_keys);
6813 else
6814 XSETCAR (item, key);
6816 /* Notify input thread about new hot-key definition, so that it
6817 takes effect without needing to switch focus. */
6818 PostThreadMessage (dwWindowsThreadId, WM_EMACS_REGISTER_HOT_KEY,
6819 (WPARAM) XLI (key), 0);
6822 return key;
6825 DEFUN ("w32-unregister-hot-key", Fw32_unregister_hot_key,
6826 Sw32_unregister_hot_key, 1, 1, 0,
6827 doc: /* Unregister KEY as a hot-key combination. */)
6828 (Lisp_Object key)
6830 Lisp_Object item;
6832 if (!INTEGERP (key))
6833 key = w32_parse_hot_key (key);
6835 item = Fmemq (key, w32_grabbed_keys);
6837 if (!NILP (item))
6839 /* Notify input thread about hot-key definition being removed, so
6840 that it takes effect without needing focus switch. */
6841 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_UNREGISTER_HOT_KEY,
6842 (WPARAM) XINT (XCAR (item)), (LPARAM) XLI (item)))
6844 MSG msg;
6845 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
6847 return Qt;
6849 return Qnil;
6852 DEFUN ("w32-registered-hot-keys", Fw32_registered_hot_keys,
6853 Sw32_registered_hot_keys, 0, 0, 0,
6854 doc: /* Return list of registered hot-key IDs. */)
6855 (void)
6857 return Fdelq (Qnil, Fcopy_sequence (w32_grabbed_keys));
6860 DEFUN ("w32-reconstruct-hot-key", Fw32_reconstruct_hot_key,
6861 Sw32_reconstruct_hot_key, 1, 1, 0,
6862 doc: /* Convert hot-key ID to a lisp key combination.
6863 usage: (w32-reconstruct-hot-key ID) */)
6864 (Lisp_Object hotkeyid)
6866 int vk_code, w32_modifiers;
6867 Lisp_Object key;
6869 CHECK_NUMBER (hotkeyid);
6871 vk_code = HOTKEY_VK_CODE (hotkeyid);
6872 w32_modifiers = HOTKEY_MODIFIERS (hotkeyid);
6874 if (vk_code < 256 && lispy_function_keys[vk_code])
6875 key = intern (lispy_function_keys[vk_code]);
6876 else
6877 key = make_number (vk_code);
6879 key = Fcons (key, Qnil);
6880 if (w32_modifiers & MOD_SHIFT)
6881 key = Fcons (Qshift, key);
6882 if (w32_modifiers & MOD_CONTROL)
6883 key = Fcons (Qctrl, key);
6884 if (w32_modifiers & MOD_ALT)
6885 key = Fcons (NILP (Vw32_alt_is_meta) ? Qalt : Qmeta, key);
6886 if (w32_modifiers & MOD_WIN)
6887 key = Fcons (Qhyper, key);
6889 return key;
6892 DEFUN ("w32-toggle-lock-key", Fw32_toggle_lock_key,
6893 Sw32_toggle_lock_key, 1, 2, 0,
6894 doc: /* Toggle the state of the lock key KEY.
6895 KEY can be `capslock', `kp-numlock', or `scroll'.
6896 If the optional parameter NEW-STATE is a number, then the state of KEY
6897 is set to off if the low bit of NEW-STATE is zero, otherwise on. */)
6898 (Lisp_Object key, Lisp_Object new_state)
6900 int vk_code;
6902 if (EQ (key, intern ("capslock")))
6903 vk_code = VK_CAPITAL;
6904 else if (EQ (key, intern ("kp-numlock")))
6905 vk_code = VK_NUMLOCK;
6906 else if (EQ (key, intern ("scroll")))
6907 vk_code = VK_SCROLL;
6908 else
6909 return Qnil;
6911 if (!dwWindowsThreadId)
6912 return make_number (w32_console_toggle_lock_key (vk_code, new_state));
6914 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_TOGGLE_LOCK_KEY,
6915 (WPARAM) vk_code, (LPARAM) XLI (new_state)))
6917 MSG msg;
6918 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
6919 return make_number (msg.wParam);
6921 return Qnil;
6924 DEFUN ("w32-window-exists-p", Fw32_window_exists_p, Sw32_window_exists_p,
6925 2, 2, 0,
6926 doc: /* Return non-nil if a window exists with the specified CLASS and NAME.
6928 This is a direct interface to the Windows API FindWindow function. */)
6929 (Lisp_Object class, Lisp_Object name)
6931 HWND hnd;
6933 if (!NILP (class))
6934 CHECK_STRING (class);
6935 if (!NILP (name))
6936 CHECK_STRING (name);
6938 hnd = FindWindow (STRINGP (class) ? ((LPCTSTR) SDATA (class)) : NULL,
6939 STRINGP (name) ? ((LPCTSTR) SDATA (name)) : NULL);
6940 if (!hnd)
6941 return Qnil;
6942 return Qt;
6945 DEFUN ("w32-battery-status", Fw32_battery_status, Sw32_battery_status, 0, 0, 0,
6946 doc: /* Get power status information from Windows system.
6948 The following %-sequences are provided:
6949 %L AC line status (verbose)
6950 %B Battery status (verbose)
6951 %b Battery status, empty means high, `-' means low,
6952 `!' means critical, and `+' means charging
6953 %p Battery load percentage
6954 %s Remaining time (to charge or discharge) in seconds
6955 %m Remaining time (to charge or discharge) in minutes
6956 %h Remaining time (to charge or discharge) in hours
6957 %t Remaining time (to charge or discharge) in the form `h:min' */)
6958 (void)
6960 Lisp_Object status = Qnil;
6962 SYSTEM_POWER_STATUS system_status;
6963 if (GetSystemPowerStatus (&system_status))
6965 Lisp_Object line_status, battery_status, battery_status_symbol;
6966 Lisp_Object load_percentage, seconds, minutes, hours, remain;
6968 long seconds_left = (long) system_status.BatteryLifeTime;
6970 if (system_status.ACLineStatus == 0)
6971 line_status = build_string ("off-line");
6972 else if (system_status.ACLineStatus == 1)
6973 line_status = build_string ("on-line");
6974 else
6975 line_status = build_string ("N/A");
6977 if (system_status.BatteryFlag & 128)
6979 battery_status = build_string ("N/A");
6980 battery_status_symbol = empty_unibyte_string;
6982 else if (system_status.BatteryFlag & 8)
6984 battery_status = build_string ("charging");
6985 battery_status_symbol = build_string ("+");
6986 if (system_status.BatteryFullLifeTime != -1L)
6987 seconds_left = system_status.BatteryFullLifeTime - seconds_left;
6989 else if (system_status.BatteryFlag & 4)
6991 battery_status = build_string ("critical");
6992 battery_status_symbol = build_string ("!");
6994 else if (system_status.BatteryFlag & 2)
6996 battery_status = build_string ("low");
6997 battery_status_symbol = build_string ("-");
6999 else if (system_status.BatteryFlag & 1)
7001 battery_status = build_string ("high");
7002 battery_status_symbol = empty_unibyte_string;
7004 else
7006 battery_status = build_string ("medium");
7007 battery_status_symbol = empty_unibyte_string;
7010 if (system_status.BatteryLifePercent > 100)
7011 load_percentage = build_string ("N/A");
7012 else
7014 char buffer[16];
7015 snprintf (buffer, 16, "%d", system_status.BatteryLifePercent);
7016 load_percentage = build_string (buffer);
7019 if (seconds_left < 0)
7020 seconds = minutes = hours = remain = build_string ("N/A");
7021 else
7023 long m;
7024 float h;
7025 char buffer[16];
7026 snprintf (buffer, 16, "%ld", seconds_left);
7027 seconds = build_string (buffer);
7029 m = seconds_left / 60;
7030 snprintf (buffer, 16, "%ld", m);
7031 minutes = build_string (buffer);
7033 h = seconds_left / 3600.0;
7034 snprintf (buffer, 16, "%3.1f", h);
7035 hours = build_string (buffer);
7037 snprintf (buffer, 16, "%ld:%02ld", m / 60, m % 60);
7038 remain = build_string (buffer);
7041 status = listn (CONSTYPE_HEAP, 8,
7042 Fcons (make_number ('L'), line_status),
7043 Fcons (make_number ('B'), battery_status),
7044 Fcons (make_number ('b'), battery_status_symbol),
7045 Fcons (make_number ('p'), load_percentage),
7046 Fcons (make_number ('s'), seconds),
7047 Fcons (make_number ('m'), minutes),
7048 Fcons (make_number ('h'), hours),
7049 Fcons (make_number ('t'), remain));
7051 return status;
7055 #ifdef WINDOWSNT
7056 DEFUN ("file-system-info", Ffile_system_info, Sfile_system_info, 1, 1, 0,
7057 doc: /* Return storage information about the file system FILENAME is on.
7058 Value is a list of floats (TOTAL FREE AVAIL), where TOTAL is the total
7059 storage of the file system, FREE is the free storage, and AVAIL is the
7060 storage available to a non-superuser. All 3 numbers are in bytes.
7061 If the underlying system call fails, value is nil. */)
7062 (Lisp_Object filename)
7064 Lisp_Object encoded, value;
7066 CHECK_STRING (filename);
7067 filename = Fexpand_file_name (filename, Qnil);
7068 encoded = ENCODE_FILE (filename);
7070 value = Qnil;
7072 /* Determining the required information on Windows turns out, sadly,
7073 to be more involved than one would hope. The original Windows API
7074 call for this will return bogus information on some systems, but we
7075 must dynamically probe for the replacement api, since that was
7076 added rather late on. */
7078 HMODULE hKernel = GetModuleHandle ("kernel32");
7079 BOOL (*pfn_GetDiskFreeSpaceEx)
7080 (char *, PULARGE_INTEGER, PULARGE_INTEGER, PULARGE_INTEGER)
7081 = (void *) GetProcAddress (hKernel, "GetDiskFreeSpaceEx");
7083 /* On Windows, we may need to specify the root directory of the
7084 volume holding FILENAME. */
7085 char rootname[MAX_PATH];
7086 char *name = SDATA (encoded);
7088 /* find the root name of the volume if given */
7089 if (isalpha (name[0]) && name[1] == ':')
7091 rootname[0] = name[0];
7092 rootname[1] = name[1];
7093 rootname[2] = '\\';
7094 rootname[3] = 0;
7096 else if (IS_DIRECTORY_SEP (name[0]) && IS_DIRECTORY_SEP (name[1]))
7098 char *str = rootname;
7099 int slashes = 4;
7102 if (IS_DIRECTORY_SEP (*name) && --slashes == 0)
7103 break;
7104 *str++ = *name++;
7106 while ( *name );
7108 *str++ = '\\';
7109 *str = 0;
7112 if (pfn_GetDiskFreeSpaceEx)
7114 /* Unsigned large integers cannot be cast to double, so
7115 use signed ones instead. */
7116 LARGE_INTEGER availbytes;
7117 LARGE_INTEGER freebytes;
7118 LARGE_INTEGER totalbytes;
7120 if (pfn_GetDiskFreeSpaceEx (rootname,
7121 (ULARGE_INTEGER *)&availbytes,
7122 (ULARGE_INTEGER *)&totalbytes,
7123 (ULARGE_INTEGER *)&freebytes))
7124 value = list3 (make_float ((double) totalbytes.QuadPart),
7125 make_float ((double) freebytes.QuadPart),
7126 make_float ((double) availbytes.QuadPart));
7128 else
7130 DWORD sectors_per_cluster;
7131 DWORD bytes_per_sector;
7132 DWORD free_clusters;
7133 DWORD total_clusters;
7135 if (GetDiskFreeSpace (rootname,
7136 &sectors_per_cluster,
7137 &bytes_per_sector,
7138 &free_clusters,
7139 &total_clusters))
7140 value = list3 (make_float ((double) total_clusters
7141 * sectors_per_cluster * bytes_per_sector),
7142 make_float ((double) free_clusters
7143 * sectors_per_cluster * bytes_per_sector),
7144 make_float ((double) free_clusters
7145 * sectors_per_cluster * bytes_per_sector));
7149 return value;
7151 #endif /* WINDOWSNT */
7154 DEFUN ("default-printer-name", Fdefault_printer_name, Sdefault_printer_name,
7155 0, 0, 0, doc: /* Return the name of Windows default printer device. */)
7156 (void)
7158 static char pname_buf[256];
7159 int err;
7160 HANDLE hPrn;
7161 PRINTER_INFO_2 *ppi2 = NULL;
7162 DWORD dwNeeded = 0, dwReturned = 0;
7164 /* Retrieve the default string from Win.ini (the registry).
7165 * String will be in form "printername,drivername,portname".
7166 * This is the most portable way to get the default printer. */
7167 if (GetProfileString ("windows", "device", ",,", pname_buf, sizeof (pname_buf)) <= 0)
7168 return Qnil;
7169 /* printername precedes first "," character */
7170 strtok (pname_buf, ",");
7171 /* We want to know more than the printer name */
7172 if (!OpenPrinter (pname_buf, &hPrn, NULL))
7173 return Qnil;
7174 GetPrinter (hPrn, 2, NULL, 0, &dwNeeded);
7175 if (dwNeeded == 0)
7177 ClosePrinter (hPrn);
7178 return Qnil;
7180 /* Allocate memory for the PRINTER_INFO_2 struct */
7181 ppi2 = xmalloc (dwNeeded);
7182 if (!ppi2)
7184 ClosePrinter (hPrn);
7185 return Qnil;
7187 /* Call GetPrinter again with big enough memory block. */
7188 err = GetPrinter (hPrn, 2, (LPBYTE)ppi2, dwNeeded, &dwReturned);
7189 ClosePrinter (hPrn);
7190 if (!err)
7192 xfree (ppi2);
7193 return Qnil;
7196 if (ppi2)
7198 if (ppi2->Attributes & PRINTER_ATTRIBUTE_SHARED && ppi2->pServerName)
7200 /* a remote printer */
7201 if (*ppi2->pServerName == '\\')
7202 snprintf (pname_buf, sizeof (pname_buf), "%s\\%s", ppi2->pServerName,
7203 ppi2->pShareName);
7204 else
7205 snprintf (pname_buf, sizeof (pname_buf), "\\\\%s\\%s", ppi2->pServerName,
7206 ppi2->pShareName);
7207 pname_buf[sizeof (pname_buf) - 1] = '\0';
7209 else
7211 /* a local printer */
7212 strncpy (pname_buf, ppi2->pPortName, sizeof (pname_buf));
7213 pname_buf[sizeof (pname_buf) - 1] = '\0';
7214 /* `pPortName' can include several ports, delimited by ','.
7215 * we only use the first one. */
7216 strtok (pname_buf, ",");
7218 xfree (ppi2);
7221 return build_string (pname_buf);
7225 /* Equivalent of strerror for W32 error codes. */
7226 char *
7227 w32_strerror (int error_no)
7229 static char buf[500];
7230 DWORD ret;
7232 if (error_no == 0)
7233 error_no = GetLastError ();
7235 ret = FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM |
7236 FORMAT_MESSAGE_IGNORE_INSERTS,
7237 NULL,
7238 error_no,
7239 0, /* choose most suitable language */
7240 buf, sizeof (buf), NULL);
7242 while (ret > 0 && (buf[ret - 1] == '\n' ||
7243 buf[ret - 1] == '\r' ))
7244 --ret;
7245 buf[ret] = '\0';
7246 if (!ret)
7247 sprintf (buf, "w32 error %u", error_no);
7249 return buf;
7252 /* For convenience when debugging. (You cannot call GetLastError
7253 directly from GDB: it will crash, because it uses the __stdcall
7254 calling convention, not the _cdecl convention assumed by GDB.) */
7255 DWORD
7256 w32_last_error (void)
7258 return GetLastError ();
7261 /* Cache information describing the NT system for later use. */
7262 void
7263 cache_system_info (void)
7265 union
7267 struct info
7269 char major;
7270 char minor;
7271 short platform;
7272 } info;
7273 DWORD data;
7274 } version;
7276 /* Cache the module handle of Emacs itself. */
7277 hinst = GetModuleHandle (NULL);
7279 /* Cache the version of the operating system. */
7280 version.data = GetVersion ();
7281 w32_major_version = version.info.major;
7282 w32_minor_version = version.info.minor;
7284 if (version.info.platform & 0x8000)
7285 os_subtype = OS_9X;
7286 else
7287 os_subtype = OS_NT;
7289 /* Cache page size, allocation unit, processor type, etc. */
7290 GetSystemInfo (&sysinfo_cache);
7291 syspage_mask = (DWORD_PTR)sysinfo_cache.dwPageSize - 1;
7293 /* Cache os info. */
7294 osinfo_cache.dwOSVersionInfoSize = sizeof (OSVERSIONINFO);
7295 GetVersionEx (&osinfo_cache);
7297 w32_build_number = osinfo_cache.dwBuildNumber;
7298 if (os_subtype == OS_9X)
7299 w32_build_number &= 0xffff;
7301 w32_num_mouse_buttons = GetSystemMetrics (SM_CMOUSEBUTTONS);
7304 #ifdef EMACSDEBUG
7305 void
7306 _DebPrint (const char *fmt, ...)
7308 char buf[1024];
7309 va_list args;
7311 va_start (args, fmt);
7312 vsprintf (buf, fmt, args);
7313 va_end (args);
7314 #if CYGWIN
7315 fprintf (stderr, "%s", buf);
7316 #endif
7317 OutputDebugString (buf);
7319 #endif
7322 w32_console_toggle_lock_key (int vk_code, Lisp_Object new_state)
7324 int cur_state = (GetKeyState (vk_code) & 1);
7326 if (NILP (new_state)
7327 || (NUMBERP (new_state)
7328 && ((XUINT (new_state)) & 1) != cur_state))
7330 #ifdef WINDOWSNT
7331 faked_key = vk_code;
7332 #endif /* WINDOWSNT */
7334 keybd_event ((BYTE) vk_code,
7335 (BYTE) MapVirtualKey (vk_code, 0),
7336 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
7337 keybd_event ((BYTE) vk_code,
7338 (BYTE) MapVirtualKey (vk_code, 0),
7339 KEYEVENTF_EXTENDEDKEY | 0, 0);
7340 keybd_event ((BYTE) vk_code,
7341 (BYTE) MapVirtualKey (vk_code, 0),
7342 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
7343 cur_state = !cur_state;
7346 return cur_state;
7349 /* Translate console modifiers to emacs modifiers.
7350 German keyboard support (Kai Morgan Zeise 2/18/95). */
7352 w32_kbd_mods_to_emacs (DWORD mods, WORD key)
7354 int retval = 0;
7356 /* If we recognize right-alt and left-ctrl as AltGr, and it has been
7357 pressed, first remove those modifiers. */
7358 if (!NILP (Vw32_recognize_altgr)
7359 && (mods & (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED))
7360 == (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED))
7361 mods &= ~ (RIGHT_ALT_PRESSED | LEFT_CTRL_PRESSED);
7363 if (mods & (RIGHT_ALT_PRESSED | LEFT_ALT_PRESSED))
7364 retval = ((NILP (Vw32_alt_is_meta)) ? alt_modifier : meta_modifier);
7366 if (mods & (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
7368 retval |= ctrl_modifier;
7369 if ((mods & (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
7370 == (RIGHT_CTRL_PRESSED | LEFT_CTRL_PRESSED))
7371 retval |= meta_modifier;
7374 if (mods & LEFT_WIN_PRESSED)
7375 retval |= w32_key_to_modifier (VK_LWIN);
7376 if (mods & RIGHT_WIN_PRESSED)
7377 retval |= w32_key_to_modifier (VK_RWIN);
7378 if (mods & APPS_PRESSED)
7379 retval |= w32_key_to_modifier (VK_APPS);
7380 if (mods & SCROLLLOCK_ON)
7381 retval |= w32_key_to_modifier (VK_SCROLL);
7383 /* Just in case someone wanted the original behavior, make it
7384 optional by setting w32-capslock-is-shiftlock to t. */
7385 if (NILP (Vw32_capslock_is_shiftlock)
7386 /* Keys that should _not_ be affected by CapsLock. */
7387 && ( (key == VK_BACK)
7388 || (key == VK_TAB)
7389 || (key == VK_CLEAR)
7390 || (key == VK_RETURN)
7391 || (key == VK_ESCAPE)
7392 || ((key >= VK_SPACE) && (key <= VK_HELP))
7393 || ((key >= VK_NUMPAD0) && (key <= VK_F24))
7394 || ((key >= VK_NUMPAD_CLEAR) && (key <= VK_NUMPAD_DELETE))
7397 /* Only consider shift state. */
7398 if ((mods & SHIFT_PRESSED) != 0)
7399 retval |= shift_modifier;
7401 else
7403 /* Ignore CapsLock state if not enabled. */
7404 if (NILP (Vw32_enable_caps_lock))
7405 mods &= ~CAPSLOCK_ON;
7406 if ((mods & (SHIFT_PRESSED | CAPSLOCK_ON)) != 0)
7407 retval |= shift_modifier;
7410 return retval;
7413 /* The return code indicates key code size. cpID is the codepage to
7414 use for translation to Unicode; -1 means use the current console
7415 input codepage. */
7417 w32_kbd_patch_key (KEY_EVENT_RECORD *event, int cpId)
7419 unsigned int key_code = event->wVirtualKeyCode;
7420 unsigned int mods = event->dwControlKeyState;
7421 BYTE keystate[256];
7422 static BYTE ansi_code[4];
7423 static int isdead = 0;
7425 if (isdead == 2)
7427 event->uChar.AsciiChar = ansi_code[2];
7428 isdead = 0;
7429 return 1;
7431 if (event->uChar.AsciiChar != 0)
7432 return 1;
7434 memset (keystate, 0, sizeof (keystate));
7435 keystate[key_code] = 0x80;
7436 if (mods & SHIFT_PRESSED)
7437 keystate[VK_SHIFT] = 0x80;
7438 if (mods & CAPSLOCK_ON)
7439 keystate[VK_CAPITAL] = 1;
7440 /* If we recognize right-alt and left-ctrl as AltGr, set the key
7441 states accordingly before invoking ToAscii. */
7442 if (!NILP (Vw32_recognize_altgr)
7443 && (mods & LEFT_CTRL_PRESSED) && (mods & RIGHT_ALT_PRESSED))
7445 keystate[VK_CONTROL] = 0x80;
7446 keystate[VK_LCONTROL] = 0x80;
7447 keystate[VK_MENU] = 0x80;
7448 keystate[VK_RMENU] = 0x80;
7451 #if 0
7452 /* Because of an OS bug, ToAscii corrupts the stack when called to
7453 convert a dead key in console mode on NT4. Unfortunately, trying
7454 to check for dead keys using MapVirtualKey doesn't work either -
7455 these functions apparently use internal information about keyboard
7456 layout which doesn't get properly updated in console programs when
7457 changing layout (though apparently it gets partly updated,
7458 otherwise ToAscii wouldn't crash). */
7459 if (is_dead_key (event->wVirtualKeyCode))
7460 return 0;
7461 #endif
7463 /* On NT, call ToUnicode instead and then convert to the current
7464 console input codepage. */
7465 if (os_subtype == OS_NT)
7467 WCHAR buf[128];
7469 isdead = ToUnicode (event->wVirtualKeyCode, event->wVirtualScanCode,
7470 keystate, buf, 128, 0);
7471 if (isdead > 0)
7473 /* When we are called from the GUI message processing code,
7474 we are passed the current keyboard codepage, a positive
7475 number, to use below. */
7476 if (cpId == -1)
7477 cpId = GetConsoleCP ();
7479 event->uChar.UnicodeChar = buf[isdead - 1];
7480 isdead = WideCharToMultiByte (cpId, 0, buf, isdead,
7481 ansi_code, 4, NULL, NULL);
7483 else
7484 isdead = 0;
7486 else
7488 isdead = ToAscii (event->wVirtualKeyCode, event->wVirtualScanCode,
7489 keystate, (LPWORD) ansi_code, 0);
7492 if (isdead == 0)
7493 return 0;
7494 event->uChar.AsciiChar = ansi_code[0];
7495 return isdead;
7499 void
7500 w32_sys_ring_bell (struct frame *f)
7502 if (sound_type == 0xFFFFFFFF)
7504 Beep (666, 100);
7506 else if (sound_type == MB_EMACS_SILENT)
7508 /* Do nothing. */
7510 else
7511 MessageBeep (sound_type);
7515 /***********************************************************************
7516 Initialization
7517 ***********************************************************************/
7519 /* Keep this list in the same order as frame_parms in frame.c.
7520 Use 0 for unsupported frame parameters. */
7522 frame_parm_handler w32_frame_parm_handlers[] =
7524 x_set_autoraise,
7525 x_set_autolower,
7526 x_set_background_color,
7527 x_set_border_color,
7528 x_set_border_width,
7529 x_set_cursor_color,
7530 x_set_cursor_type,
7531 x_set_font,
7532 x_set_foreground_color,
7533 x_set_icon_name,
7534 x_set_icon_type,
7535 x_set_internal_border_width,
7536 x_set_menu_bar_lines,
7537 x_set_mouse_color,
7538 x_explicitly_set_name,
7539 x_set_scroll_bar_width,
7540 x_set_title,
7541 x_set_unsplittable,
7542 x_set_vertical_scroll_bars,
7543 x_set_visibility,
7544 x_set_tool_bar_lines,
7545 0, /* x_set_scroll_bar_foreground, */
7546 0, /* x_set_scroll_bar_background, */
7547 x_set_screen_gamma,
7548 x_set_line_spacing,
7549 x_set_fringe_width,
7550 x_set_fringe_width,
7551 0, /* x_set_wait_for_wm, */
7552 x_set_fullscreen,
7553 x_set_font_backend,
7554 x_set_alpha,
7555 0, /* x_set_sticky */
7556 0, /* x_set_tool_bar_position */
7559 void
7560 syms_of_w32fns (void)
7562 globals_of_w32fns ();
7563 track_mouse_window = NULL;
7565 w32_visible_system_caret_hwnd = NULL;
7567 DEFSYM (Qsuppress_icon, "suppress-icon");
7568 DEFSYM (Qundefined_color, "undefined-color");
7569 DEFSYM (Qcancel_timer, "cancel-timer");
7570 DEFSYM (Qhyper, "hyper");
7571 DEFSYM (Qsuper, "super");
7572 DEFSYM (Qmeta, "meta");
7573 DEFSYM (Qalt, "alt");
7574 DEFSYM (Qctrl, "ctrl");
7575 DEFSYM (Qcontrol, "control");
7576 DEFSYM (Qshift, "shift");
7577 DEFSYM (Qfont_param, "font-parameter");
7578 DEFSYM (Qgeometry, "geometry");
7579 DEFSYM (Qworkarea, "workarea");
7580 DEFSYM (Qmm_size, "mm-size");
7581 DEFSYM (Qframes, "frames");
7582 /* This is the end of symbol initialization. */
7585 Fput (Qundefined_color, Qerror_conditions,
7586 listn (CONSTYPE_PURE, 2, Qundefined_color, Qerror));
7587 Fput (Qundefined_color, Qerror_message,
7588 build_pure_c_string ("Undefined color"));
7590 staticpro (&w32_grabbed_keys);
7591 w32_grabbed_keys = Qnil;
7593 DEFVAR_LISP ("w32-color-map", Vw32_color_map,
7594 doc: /* An array of color name mappings for Windows. */);
7595 Vw32_color_map = Qnil;
7597 DEFVAR_LISP ("w32-pass-alt-to-system", Vw32_pass_alt_to_system,
7598 doc: /* Non-nil if Alt key presses are passed on to Windows.
7599 When non-nil, for example, Alt pressed and released and then space will
7600 open the System menu. When nil, Emacs processes the Alt key events, and
7601 then silently swallows them. */);
7602 Vw32_pass_alt_to_system = Qnil;
7604 DEFVAR_LISP ("w32-alt-is-meta", Vw32_alt_is_meta,
7605 doc: /* Non-nil if the Alt key is to be considered the same as the META key.
7606 When nil, Emacs will translate the Alt key to the ALT modifier, not to META. */);
7607 Vw32_alt_is_meta = Qt;
7609 DEFVAR_INT ("w32-quit-key", w32_quit_key,
7610 doc: /* If non-zero, the virtual key code for an alternative quit key. */);
7611 w32_quit_key = 0;
7613 DEFVAR_LISP ("w32-pass-lwindow-to-system",
7614 Vw32_pass_lwindow_to_system,
7615 doc: /* If non-nil, the left \"Windows\" key is passed on to Windows.
7617 When non-nil, the Start menu is opened by tapping the key.
7618 If you set this to nil, the left \"Windows\" key is processed by Emacs
7619 according to the value of `w32-lwindow-modifier', which see.
7621 Note that some combinations of the left \"Windows\" key with other keys are
7622 caught by Windows at low level, and so binding them in Emacs will have no
7623 effect. For example, <lwindow>-r always pops up the Windows Run dialog,
7624 <lwindow>-<Pause> pops up the "System Properties" dialog, etc. However, see
7625 the doc string of `w32-phantom-key-code'. */);
7626 Vw32_pass_lwindow_to_system = Qt;
7628 DEFVAR_LISP ("w32-pass-rwindow-to-system",
7629 Vw32_pass_rwindow_to_system,
7630 doc: /* If non-nil, the right \"Windows\" key is passed on to Windows.
7632 When non-nil, the Start menu is opened by tapping the key.
7633 If you set this to nil, the right \"Windows\" key is processed by Emacs
7634 according to the value of `w32-rwindow-modifier', which see.
7636 Note that some combinations of the right \"Windows\" key with other keys are
7637 caught by Windows at low level, and so binding them in Emacs will have no
7638 effect. For example, <rwindow>-r always pops up the Windows Run dialog,
7639 <rwindow>-<Pause> pops up the "System Properties" dialog, etc. However, see
7640 the doc string of `w32-phantom-key-code'. */);
7641 Vw32_pass_rwindow_to_system = Qt;
7643 DEFVAR_LISP ("w32-phantom-key-code",
7644 Vw32_phantom_key_code,
7645 doc: /* Virtual key code used to generate \"phantom\" key presses.
7646 Value is a number between 0 and 255.
7648 Phantom key presses are generated in order to stop the system from
7649 acting on \"Windows\" key events when `w32-pass-lwindow-to-system' or
7650 `w32-pass-rwindow-to-system' is nil. */);
7651 /* Although 255 is technically not a valid key code, it works and
7652 means that this hack won't interfere with any real key code. */
7653 XSETINT (Vw32_phantom_key_code, 255);
7655 DEFVAR_LISP ("w32-enable-num-lock",
7656 Vw32_enable_num_lock,
7657 doc: /* If non-nil, the Num Lock key acts normally.
7658 Set to nil to handle Num Lock as the `kp-numlock' key. */);
7659 Vw32_enable_num_lock = Qt;
7661 DEFVAR_LISP ("w32-enable-caps-lock",
7662 Vw32_enable_caps_lock,
7663 doc: /* If non-nil, the Caps Lock key acts normally.
7664 Set to nil to handle Caps Lock as the `capslock' key. */);
7665 Vw32_enable_caps_lock = Qt;
7667 DEFVAR_LISP ("w32-scroll-lock-modifier",
7668 Vw32_scroll_lock_modifier,
7669 doc: /* Modifier to use for the Scroll Lock ON state.
7670 The value can be hyper, super, meta, alt, control or shift for the
7671 respective modifier, or nil to handle Scroll Lock as the `scroll' key.
7672 Any other value will cause the Scroll Lock key to be ignored. */);
7673 Vw32_scroll_lock_modifier = Qnil;
7675 DEFVAR_LISP ("w32-lwindow-modifier",
7676 Vw32_lwindow_modifier,
7677 doc: /* Modifier to use for the left \"Windows\" key.
7678 The value can be hyper, super, meta, alt, control or shift for the
7679 respective modifier, or nil to appear as the `lwindow' key.
7680 Any other value will cause the key to be ignored. */);
7681 Vw32_lwindow_modifier = Qnil;
7683 DEFVAR_LISP ("w32-rwindow-modifier",
7684 Vw32_rwindow_modifier,
7685 doc: /* Modifier to use for the right \"Windows\" key.
7686 The value can be hyper, super, meta, alt, control or shift for the
7687 respective modifier, or nil to appear as the `rwindow' key.
7688 Any other value will cause the key to be ignored. */);
7689 Vw32_rwindow_modifier = Qnil;
7691 DEFVAR_LISP ("w32-apps-modifier",
7692 Vw32_apps_modifier,
7693 doc: /* Modifier to use for the \"Apps\" key.
7694 The value can be hyper, super, meta, alt, control or shift for the
7695 respective modifier, or nil to appear as the `apps' key.
7696 Any other value will cause the key to be ignored. */);
7697 Vw32_apps_modifier = Qnil;
7699 DEFVAR_BOOL ("w32-enable-synthesized-fonts", w32_enable_synthesized_fonts,
7700 doc: /* Non-nil enables selection of artificially italicized and bold fonts. */);
7701 w32_enable_synthesized_fonts = 0;
7703 DEFVAR_LISP ("w32-enable-palette", Vw32_enable_palette,
7704 doc: /* Non-nil enables Windows palette management to map colors exactly. */);
7705 Vw32_enable_palette = Qt;
7707 DEFVAR_INT ("w32-mouse-button-tolerance",
7708 w32_mouse_button_tolerance,
7709 doc: /* Analogue of double click interval for faking middle mouse events.
7710 The value is the minimum time in milliseconds that must elapse between
7711 left and right button down events before they are considered distinct events.
7712 If both mouse buttons are depressed within this interval, a middle mouse
7713 button down event is generated instead. */);
7714 w32_mouse_button_tolerance = GetDoubleClickTime () / 2;
7716 DEFVAR_INT ("w32-mouse-move-interval",
7717 w32_mouse_move_interval,
7718 doc: /* Minimum interval between mouse move events.
7719 The value is the minimum time in milliseconds that must elapse between
7720 successive mouse move (or scroll bar drag) events before they are
7721 reported as lisp events. */);
7722 w32_mouse_move_interval = 0;
7724 DEFVAR_BOOL ("w32-pass-extra-mouse-buttons-to-system",
7725 w32_pass_extra_mouse_buttons_to_system,
7726 doc: /* If non-nil, the fourth and fifth mouse buttons are passed to Windows.
7727 Recent versions of Windows support mice with up to five buttons.
7728 Since most applications don't support these extra buttons, most mouse
7729 drivers will allow you to map them to functions at the system level.
7730 If this variable is non-nil, Emacs will pass them on, allowing the
7731 system to handle them. */);
7732 w32_pass_extra_mouse_buttons_to_system = 0;
7734 DEFVAR_BOOL ("w32-pass-multimedia-buttons-to-system",
7735 w32_pass_multimedia_buttons_to_system,
7736 doc: /* If non-nil, media buttons are passed to Windows.
7737 Some modern keyboards contain buttons for controlling media players, web
7738 browsers and other applications. Generally these buttons are handled on a
7739 system wide basis, but by setting this to nil they are made available
7740 to Emacs for binding. Depending on your keyboard, additional keys that
7741 may be available are:
7743 browser-back, browser-forward, browser-refresh, browser-stop,
7744 browser-search, browser-favorites, browser-home,
7745 mail, mail-reply, mail-forward, mail-send,
7746 app-1, app-2,
7747 help, find, new, open, close, save, print, undo, redo, copy, cut, paste,
7748 spell-check, correction-list, toggle-dictate-command,
7749 media-next, media-previous, media-stop, media-play-pause, media-select,
7750 media-play, media-pause, media-record, media-fast-forward, media-rewind,
7751 media-channel-up, media-channel-down,
7752 volume-mute, volume-up, volume-down,
7753 mic-volume-mute, mic-volume-down, mic-volume-up, mic-toggle,
7754 bass-down, bass-boost, bass-up, treble-down, treble-up */);
7755 w32_pass_multimedia_buttons_to_system = 1;
7757 #if 0 /* TODO: Mouse cursor customization. */
7758 DEFVAR_LISP ("x-pointer-shape", Vx_pointer_shape,
7759 doc: /* The shape of the pointer when over text.
7760 Changing the value does not affect existing frames
7761 unless you set the mouse color. */);
7762 Vx_pointer_shape = Qnil;
7764 Vx_nontext_pointer_shape = Qnil;
7766 Vx_mode_pointer_shape = Qnil;
7768 DEFVAR_LISP ("x-hourglass-pointer-shape", Vx_hourglass_pointer_shape,
7769 doc: /* The shape of the pointer when Emacs is busy.
7770 This variable takes effect when you create a new frame
7771 or when you set the mouse color. */);
7772 Vx_hourglass_pointer_shape = Qnil;
7774 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
7775 Vx_sensitive_text_pointer_shape,
7776 doc: /* The shape of the pointer when over mouse-sensitive text.
7777 This variable takes effect when you create a new frame
7778 or when you set the mouse color. */);
7779 Vx_sensitive_text_pointer_shape = Qnil;
7781 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
7782 Vx_window_horizontal_drag_shape,
7783 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
7784 This variable takes effect when you create a new frame
7785 or when you set the mouse color. */);
7786 Vx_window_horizontal_drag_shape = Qnil;
7787 #endif
7789 DEFVAR_LISP ("x-cursor-fore-pixel", Vx_cursor_fore_pixel,
7790 doc: /* A string indicating the foreground color of the cursor box. */);
7791 Vx_cursor_fore_pixel = Qnil;
7793 DEFVAR_LISP ("x-max-tooltip-size", Vx_max_tooltip_size,
7794 doc: /* Maximum size for tooltips.
7795 Value is a pair (COLUMNS . ROWS). Text larger than this is clipped. */);
7796 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
7798 DEFVAR_LISP ("x-no-window-manager", Vx_no_window_manager,
7799 doc: /* Non-nil if no window manager is in use.
7800 Emacs doesn't try to figure this out; this is always nil
7801 unless you set it to something else. */);
7802 /* We don't have any way to find this out, so set it to nil
7803 and maybe the user would like to set it to t. */
7804 Vx_no_window_manager = Qnil;
7806 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
7807 Vx_pixel_size_width_font_regexp,
7808 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
7810 Since Emacs gets width of a font matching with this regexp from
7811 PIXEL_SIZE field of the name, font finding mechanism gets faster for
7812 such a font. This is especially effective for such large fonts as
7813 Chinese, Japanese, and Korean. */);
7814 Vx_pixel_size_width_font_regexp = Qnil;
7816 DEFVAR_LISP ("w32-bdf-filename-alist",
7817 Vw32_bdf_filename_alist,
7818 doc: /* List of bdf fonts and their corresponding filenames. */);
7819 Vw32_bdf_filename_alist = Qnil;
7821 DEFVAR_BOOL ("w32-strict-fontnames",
7822 w32_strict_fontnames,
7823 doc: /* Non-nil means only use fonts that are exact matches for those requested.
7824 Default is nil, which allows old fontnames that are not XLFD compliant,
7825 and allows third-party CJK display to work by specifying false charset
7826 fields to trick Emacs into translating to Big5, SJIS etc.
7827 Setting this to t will prevent wrong fonts being selected when
7828 fontsets are automatically created. */);
7829 w32_strict_fontnames = 0;
7831 DEFVAR_BOOL ("w32-strict-painting",
7832 w32_strict_painting,
7833 doc: /* Non-nil means use strict rules for repainting frames.
7834 Set this to nil to get the old behavior for repainting; this should
7835 only be necessary if the default setting causes problems. */);
7836 w32_strict_painting = 1;
7838 #if 0 /* TODO: Port to W32 */
7839 defsubr (&Sx_change_window_property);
7840 defsubr (&Sx_delete_window_property);
7841 defsubr (&Sx_window_property);
7842 #endif
7843 defsubr (&Sxw_display_color_p);
7844 defsubr (&Sx_display_grayscale_p);
7845 defsubr (&Sxw_color_defined_p);
7846 defsubr (&Sxw_color_values);
7847 defsubr (&Sx_server_max_request_size);
7848 defsubr (&Sx_server_vendor);
7849 defsubr (&Sx_server_version);
7850 defsubr (&Sx_display_pixel_width);
7851 defsubr (&Sx_display_pixel_height);
7852 defsubr (&Sx_display_mm_width);
7853 defsubr (&Sx_display_mm_height);
7854 defsubr (&Sx_display_screens);
7855 defsubr (&Sx_display_planes);
7856 defsubr (&Sx_display_color_cells);
7857 defsubr (&Sx_display_visual_class);
7858 defsubr (&Sx_display_backing_store);
7859 defsubr (&Sx_display_save_under);
7860 defsubr (&Sx_create_frame);
7861 defsubr (&Sx_open_connection);
7862 defsubr (&Sx_close_connection);
7863 defsubr (&Sx_display_list);
7864 defsubr (&Sx_synchronize);
7865 defsubr (&Sx_focus_frame);
7867 /* W32 specific functions */
7869 defsubr (&Sw32_define_rgb_color);
7870 defsubr (&Sw32_default_color_map);
7871 defsubr (&Sw32_display_monitor_attributes_list);
7872 defsubr (&Sw32_send_sys_command);
7873 defsubr (&Sw32_shell_execute);
7874 defsubr (&Sw32_register_hot_key);
7875 defsubr (&Sw32_unregister_hot_key);
7876 defsubr (&Sw32_registered_hot_keys);
7877 defsubr (&Sw32_reconstruct_hot_key);
7878 defsubr (&Sw32_toggle_lock_key);
7879 defsubr (&Sw32_window_exists_p);
7880 defsubr (&Sw32_battery_status);
7882 #ifdef WINDOWSNT
7883 defsubr (&Sfile_system_info);
7884 #endif
7886 defsubr (&Sdefault_printer_name);
7887 defsubr (&Sset_message_beep);
7889 hourglass_hwnd = NULL;
7891 defsubr (&Sx_show_tip);
7892 defsubr (&Sx_hide_tip);
7893 tip_timer = Qnil;
7894 staticpro (&tip_timer);
7895 tip_frame = Qnil;
7896 staticpro (&tip_frame);
7898 last_show_tip_args = Qnil;
7899 staticpro (&last_show_tip_args);
7901 defsubr (&Sx_file_dialog);
7902 #ifdef WINDOWSNT
7903 defsubr (&Ssystem_move_file_to_trash);
7904 #endif
7909 globals_of_w32fns is used to initialize those global variables that
7910 must always be initialized on startup even when the global variable
7911 initialized is non zero (see the function main in emacs.c).
7912 globals_of_w32fns is called from syms_of_w32fns when the global
7913 variable initialized is 0 and directly from main when initialized
7914 is non zero.
7916 void
7917 globals_of_w32fns (void)
7919 HMODULE user32_lib = GetModuleHandle ("user32.dll");
7921 TrackMouseEvent not available in all versions of Windows, so must load
7922 it dynamically. Do it once, here, instead of every time it is used.
7924 track_mouse_event_fn = (TrackMouseEvent_Proc)
7925 GetProcAddress (user32_lib, "TrackMouseEvent");
7927 monitor_from_point_fn = (MonitorFromPoint_Proc)
7928 GetProcAddress (user32_lib, "MonitorFromPoint");
7929 get_monitor_info_fn = (GetMonitorInfo_Proc)
7930 GetProcAddress (user32_lib, "GetMonitorInfoA");
7931 monitor_from_window_fn = (MonitorFromWindow_Proc)
7932 GetProcAddress (user32_lib, "MonitorFromWindow");
7933 enum_display_monitors_fn = (EnumDisplayMonitors_Proc)
7934 GetProcAddress (user32_lib, "EnumDisplayMonitors");
7937 HMODULE imm32_lib = GetModuleHandle ("imm32.dll");
7938 get_composition_string_fn = (ImmGetCompositionString_Proc)
7939 GetProcAddress (imm32_lib, "ImmGetCompositionStringW");
7940 get_ime_context_fn = (ImmGetContext_Proc)
7941 GetProcAddress (imm32_lib, "ImmGetContext");
7942 release_ime_context_fn = (ImmReleaseContext_Proc)
7943 GetProcAddress (imm32_lib, "ImmReleaseContext");
7944 set_ime_composition_window_fn = (ImmSetCompositionWindow_Proc)
7945 GetProcAddress (imm32_lib, "ImmSetCompositionWindow");
7947 DEFVAR_INT ("w32-ansi-code-page",
7948 w32_ansi_code_page,
7949 doc: /* The ANSI code page used by the system. */);
7950 w32_ansi_code_page = GetACP ();
7952 if (os_subtype == OS_NT)
7953 w32_unicode_gui = 1;
7954 else
7955 w32_unicode_gui = 0;
7957 /* MessageBox does not work without this when linked to comctl32.dll 6.0. */
7958 InitCommonControls ();
7960 syms_of_w32uniscribe ();
7963 typedef USHORT (WINAPI * CaptureStackBackTrace_proc) (ULONG, ULONG, PVOID *,
7964 PULONG);
7966 #define BACKTRACE_LIMIT_MAX 62
7969 w32_backtrace (void **buffer, int limit)
7971 static CaptureStackBackTrace_proc s_pfn_CaptureStackBackTrace = NULL;
7972 HMODULE hm_kernel32 = NULL;
7974 if (!s_pfn_CaptureStackBackTrace)
7976 hm_kernel32 = LoadLibrary ("Kernel32.dll");
7977 s_pfn_CaptureStackBackTrace =
7978 (CaptureStackBackTrace_proc) GetProcAddress (hm_kernel32,
7979 "RtlCaptureStackBackTrace");
7981 if (s_pfn_CaptureStackBackTrace)
7982 return s_pfn_CaptureStackBackTrace (0, min (BACKTRACE_LIMIT_MAX, limit),
7983 buffer, NULL);
7984 return 0;
7987 void
7988 emacs_abort (void)
7990 int button;
7991 button = MessageBox (NULL,
7992 "A fatal error has occurred!\n\n"
7993 "Would you like to attach a debugger?\n\n"
7994 "Select:\n"
7995 "YES -- to debug Emacs, or\n"
7996 "NO -- to abort Emacs and produce a backtrace\n"
7997 " (emacs_backtrace.txt in current directory)."
7998 #if __GNUC__
7999 "\n\n(type \"gdb -p <emacs-PID>\" and\n"
8000 "\"continue\" inside GDB before clicking YES.)"
8001 #endif
8002 , "Emacs Abort Dialog",
8003 MB_ICONEXCLAMATION | MB_TASKMODAL
8004 | MB_SETFOREGROUND | MB_YESNO);
8005 switch (button)
8007 case IDYES:
8008 DebugBreak ();
8009 exit (2); /* tell the compiler we will never return */
8010 case IDNO:
8011 default:
8013 void *stack[BACKTRACE_LIMIT_MAX + 1];
8014 int i = w32_backtrace (stack, BACKTRACE_LIMIT_MAX + 1);
8016 if (i)
8018 #ifdef CYGWIN
8019 int stderr_fd = 2;
8020 #else
8021 HANDLE errout = GetStdHandle (STD_ERROR_HANDLE);
8022 int stderr_fd = -1;
8023 #endif
8024 int errfile_fd = -1;
8025 int j;
8027 #ifndef CYGWIN
8028 if (errout && errout != INVALID_HANDLE_VALUE)
8029 stderr_fd = _open_osfhandle ((intptr_t)errout, O_APPEND | O_BINARY);
8030 #endif
8031 if (stderr_fd >= 0)
8032 write (stderr_fd, "\r\nBacktrace:\r\n", 14);
8033 #ifdef CYGWIN
8034 #define _open open
8035 #endif
8036 errfile_fd = _open ("emacs_backtrace.txt", O_RDWR | O_CREAT | O_BINARY, S_IREAD | S_IWRITE);
8037 if (errfile_fd >= 0)
8039 lseek (errfile_fd, 0L, SEEK_END);
8040 write (errfile_fd, "\r\nBacktrace:\r\n", 14);
8043 for (j = 0; j < i; j++)
8045 char buf[INT_BUFSIZE_BOUND (void *)];
8047 /* stack[] gives the return addresses, whereas we want
8048 the address of the call, so decrease each address
8049 by approximate size of 1 CALL instruction. */
8050 sprintf (buf, "0x%p\r\n", (char *)stack[j] - sizeof(void *));
8051 if (stderr_fd >= 0)
8052 write (stderr_fd, buf, strlen (buf));
8053 if (errfile_fd >= 0)
8054 write (errfile_fd, buf, strlen (buf));
8056 if (i == BACKTRACE_LIMIT_MAX)
8058 if (stderr_fd >= 0)
8059 write (stderr_fd, "...\r\n", 5);
8060 if (errfile_fd >= 0)
8061 write (errfile_fd, "...\r\n", 5);
8063 if (errfile_fd >= 0)
8064 close (errfile_fd);
8066 abort ();
8067 break;
8072 #ifdef NTGUI_UNICODE
8074 Lisp_Object
8075 ntgui_encode_system (Lisp_Object str)
8077 Lisp_Object encoded;
8078 to_unicode (str, &encoded);
8079 return encoded;
8082 #endif /* NTGUI_UNICODE */