* lisp/vc/smerge-mode.el (smerge-refine): Choose better default part to
[emacs.git] / src / w32fns.c
blob5a4f1354993180749bd7ecb09a112f020acc6cdf
1 /* Graphical user interface functions for the Microsoft W32 API.
3 Copyright (C) 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000,
4 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
5 Free Software Foundation, Inc.
7 This file is part of GNU Emacs.
9 GNU Emacs is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 /* Added by Kevin Gallo */
24 #include <config.h>
26 #include <signal.h>
27 #include <stdio.h>
28 #include <limits.h>
29 #include <errno.h>
30 #include <math.h>
31 #include <setjmp.h>
33 #include "lisp.h"
34 #include "w32term.h"
35 #include "frame.h"
36 #include "window.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 "character.h"
44 #include "charset.h"
45 #include "coding.h"
46 #include "ccl.h"
47 #include "fontset.h"
48 #include "systime.h"
49 #include "termhooks.h"
50 #include "w32heap.h"
51 #include "w32.h"
53 #include "bitmaps/gray.xbm"
55 #include <commctrl.h>
56 #include <commdlg.h>
57 #include <shellapi.h>
58 #include <ctype.h>
59 #include <winspool.h>
60 #include <objbase.h>
62 #include <dlgs.h>
63 #include <imm.h>
64 #define FILE_NAME_TEXT_FIELD edt1
66 #include "font.h"
67 #include "w32font.h"
69 #ifndef FOF_NO_CONNECTED_ELEMENTS
70 #define FOF_NO_CONNECTED_ELEMENTS 0x2000
71 #endif
73 void syms_of_w32fns (void);
74 void globals_of_w32fns (void);
76 extern void free_frame_menubar (struct frame *);
77 extern double atof (const char *);
78 extern int w32_console_toggle_lock_key (int, Lisp_Object);
79 extern void w32_menu_display_help (HWND, HMENU, UINT, UINT);
80 extern void w32_free_menu_strings (HWND);
81 extern const char *map_w32_filename (const char *, const char **);
83 extern int quit_char;
85 extern char *lispy_function_keys[];
87 /* The colormap for converting color names to RGB values */
88 Lisp_Object Vw32_color_map;
90 /* Non nil if alt key presses are passed on to Windows. */
91 Lisp_Object Vw32_pass_alt_to_system;
93 /* Non nil if alt key is translated to meta_modifier, nil if it is translated
94 to alt_modifier. */
95 Lisp_Object Vw32_alt_is_meta;
97 /* If non-zero, the windows virtual key code for an alternative quit key. */
98 int w32_quit_key;
100 /* Non nil if left window key events are passed on to Windows (this only
101 affects whether "tapping" the key opens the Start menu). */
102 Lisp_Object Vw32_pass_lwindow_to_system;
104 /* Non nil if right window key events are passed on to Windows (this
105 only affects whether "tapping" the key opens the Start menu). */
106 Lisp_Object Vw32_pass_rwindow_to_system;
108 /* Virtual key code used to generate "phantom" key presses in order
109 to stop system from acting on Windows key events. */
110 Lisp_Object Vw32_phantom_key_code;
112 /* Modifier associated with the left "Windows" key, or nil to act as a
113 normal key. */
114 Lisp_Object Vw32_lwindow_modifier;
116 /* Modifier associated with the right "Windows" key, or nil to act as a
117 normal key. */
118 Lisp_Object Vw32_rwindow_modifier;
120 /* Modifier associated with the "Apps" key, or nil to act as a normal
121 key. */
122 Lisp_Object Vw32_apps_modifier;
124 /* Value is nil if Num Lock acts as a function key. */
125 Lisp_Object Vw32_enable_num_lock;
127 /* Value is nil if Caps Lock acts as a function key. */
128 Lisp_Object Vw32_enable_caps_lock;
130 /* Modifier associated with Scroll Lock, or nil to act as a normal key. */
131 Lisp_Object Vw32_scroll_lock_modifier;
133 /* Switch to control whether we inhibit requests for synthesized bold
134 and italic versions of fonts. */
135 int w32_enable_synthesized_fonts;
137 /* Enable palette management. */
138 Lisp_Object Vw32_enable_palette;
140 /* Control how close left/right button down events must be to
141 be converted to a middle button down event. */
142 int w32_mouse_button_tolerance;
144 /* Minimum interval between mouse movement (and scroll bar drag)
145 events that are passed on to the event loop. */
146 int w32_mouse_move_interval;
148 /* Flag to indicate if XBUTTON events should be passed on to Windows. */
149 static int w32_pass_extra_mouse_buttons_to_system;
151 /* Flag to indicate if media keys should be passed on to Windows. */
152 static int w32_pass_multimedia_buttons_to_system;
154 /* Non nil if no window manager is in use. */
155 Lisp_Object Vx_no_window_manager;
157 /* If non-zero, a w32 timer that, when it expires, displays an
158 hourglass cursor on all frames. */
159 static unsigned hourglass_timer = 0;
160 static HWND hourglass_hwnd = NULL;
162 #if 0 /* TODO: Mouse cursor customization. */
163 /* The background and shape of the mouse pointer, and shape when not
164 over text or in the modeline. */
165 Lisp_Object Vx_pointer_shape, Vx_nontext_pointer_shape, Vx_mode_pointer_shape;
166 Lisp_Object Vx_hourglass_pointer_shape, Vx_window_horizontal_drag_shape;
168 /* The shape when over mouse-sensitive text. */
170 Lisp_Object Vx_sensitive_text_pointer_shape;
171 #endif
173 #ifndef IDC_HAND
174 #define IDC_HAND MAKEINTRESOURCE(32649)
175 #endif
177 /* Color of chars displayed in cursor box. */
178 Lisp_Object Vx_cursor_fore_pixel;
180 /* Nonzero if using Windows. */
182 static int w32_in_use;
184 /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'. */
186 Lisp_Object Vx_pixel_size_width_font_regexp;
188 /* Alist of bdf fonts and the files that define them. */
189 Lisp_Object Vw32_bdf_filename_alist;
191 /* A flag to control whether fonts are matched strictly or not. */
192 static int w32_strict_fontnames;
194 /* A flag to control whether we should only repaint if GetUpdateRect
195 indicates there is an update region. */
196 static int w32_strict_painting;
198 Lisp_Object Qnone;
199 Lisp_Object Qsuppress_icon;
200 Lisp_Object Qundefined_color;
201 Lisp_Object Qcancel_timer;
202 Lisp_Object Qfont_param;
203 Lisp_Object Qhyper;
204 Lisp_Object Qsuper;
205 Lisp_Object Qmeta;
206 Lisp_Object Qalt;
207 Lisp_Object Qctrl;
208 Lisp_Object Qcontrol;
209 Lisp_Object Qshift;
212 /* The ANSI codepage. */
213 int w32_ansi_code_page;
215 /* Prefix for system colors. */
216 #define SYSTEM_COLOR_PREFIX "System"
217 #define SYSTEM_COLOR_PREFIX_LEN (sizeof (SYSTEM_COLOR_PREFIX) - 1)
219 /* State variables for emulating a three button mouse. */
220 #define LMOUSE 1
221 #define MMOUSE 2
222 #define RMOUSE 4
224 static int button_state = 0;
225 static W32Msg saved_mouse_button_msg;
226 static unsigned mouse_button_timer = 0; /* non-zero when timer is active */
227 static W32Msg saved_mouse_move_msg;
228 static unsigned mouse_move_timer = 0;
230 /* Window that is tracking the mouse. */
231 static HWND track_mouse_window;
233 /* Multi-monitor API definitions that are not pulled from the headers
234 since we are compiling for NT 4. */
235 #ifndef MONITOR_DEFAULT_TO_NEAREST
236 #define MONITOR_DEFAULT_TO_NEAREST 2
237 #endif
238 /* MinGW headers define MONITORINFO unconditionally, but MSVC ones don't.
239 To avoid a compile error on one or the other, redefine with a new name. */
240 struct MONITOR_INFO
242 DWORD cbSize;
243 RECT rcMonitor;
244 RECT rcWork;
245 DWORD dwFlags;
248 /* Reportedly, VS 6 does not have this in its headers. */
249 #if defined (_MSC_VER) && _MSC_VER < 1300
250 DECLARE_HANDLE(HMONITOR);
251 #endif
253 typedef BOOL (WINAPI * TrackMouseEvent_Proc)
254 (IN OUT LPTRACKMOUSEEVENT lpEventTrack);
255 typedef LONG (WINAPI * ImmGetCompositionString_Proc)
256 (IN HIMC context, IN DWORD index, OUT LPVOID buffer, IN DWORD bufLen);
257 typedef HIMC (WINAPI * ImmGetContext_Proc) (IN HWND window);
258 typedef HWND (WINAPI * ImmReleaseContext_Proc) (IN HWND wnd, IN HIMC context);
259 typedef HWND (WINAPI * ImmSetCompositionWindow_Proc) (IN HIMC context,
260 IN COMPOSITIONFORM *form);
261 typedef HMONITOR (WINAPI * MonitorFromPoint_Proc) (IN POINT pt, IN DWORD flags);
262 typedef BOOL (WINAPI * GetMonitorInfo_Proc)
263 (IN HMONITOR monitor, OUT struct MONITOR_INFO* info);
265 TrackMouseEvent_Proc track_mouse_event_fn = NULL;
266 ImmGetCompositionString_Proc get_composition_string_fn = NULL;
267 ImmGetContext_Proc get_ime_context_fn = NULL;
268 ImmReleaseContext_Proc release_ime_context_fn = NULL;
269 ImmSetCompositionWindow_Proc set_ime_composition_window_fn = NULL;
270 MonitorFromPoint_Proc monitor_from_point_fn = NULL;
271 GetMonitorInfo_Proc get_monitor_info_fn = NULL;
273 extern AppendMenuW_Proc unicode_append_menu;
275 /* Flag to selectively ignore WM_IME_CHAR messages. */
276 static int ignore_ime_char = 0;
278 /* W95 mousewheel handler */
279 unsigned int msh_mousewheel = 0;
281 /* Timers */
282 #define MOUSE_BUTTON_ID 1
283 #define MOUSE_MOVE_ID 2
284 #define MENU_FREE_ID 3
285 #define HOURGLASS_ID 4
286 /* The delay (milliseconds) before a menu is freed after WM_EXITMENULOOP
287 is received. */
288 #define MENU_FREE_DELAY 1000
289 static unsigned menu_free_timer = 0;
291 /* In dispnew.c */
293 extern Lisp_Object Vwindow_system_version;
295 /* The below are defined in frame.c. */
297 extern Lisp_Object Vmenu_bar_mode, Vtool_bar_mode;
298 extern Lisp_Object Vwindow_system_version;
299 extern Lisp_Object Qtooltip;
301 #ifdef GLYPH_DEBUG
302 int image_cache_refcount, dpyinfo_refcount;
303 #endif
306 /* From w32term.c. */
307 extern int w32_num_mouse_buttons;
308 extern Lisp_Object Vw32_recognize_altgr;
310 extern HWND w32_system_caret_hwnd;
312 extern int w32_system_caret_height;
313 extern int w32_system_caret_x;
314 extern int w32_system_caret_y;
315 extern int w32_use_visible_system_caret;
317 static HWND w32_visible_system_caret_hwnd;
319 /* From w32menu.c */
320 extern HMENU current_popup_menu;
321 static int menubar_in_use = 0;
323 /* From w32uniscribe.c */
324 extern void syms_of_w32uniscribe (void);
325 extern int uniscribe_available;
327 /* Function prototypes for hourglass support. */
328 static void w32_show_hourglass (struct frame *);
329 static void w32_hide_hourglass (void);
333 /* Error if we are not connected to MS-Windows. */
334 void
335 check_w32 (void)
337 if (! w32_in_use)
338 error ("MS-Windows not in use or not initialized");
341 /* Nonzero if we can use mouse menus.
342 You should not call this unless HAVE_MENUS is defined. */
345 have_menus_p (void)
347 return w32_in_use;
350 /* Extract a frame as a FRAME_PTR, defaulting to the selected frame
351 and checking validity for W32. */
353 FRAME_PTR
354 check_x_frame (Lisp_Object frame)
356 FRAME_PTR f;
358 if (NILP (frame))
359 frame = selected_frame;
360 CHECK_LIVE_FRAME (frame);
361 f = XFRAME (frame);
362 if (! FRAME_W32_P (f))
363 error ("Non-W32 frame used");
364 return f;
367 /* Let the user specify a display with a frame.
368 nil stands for the selected frame--or, if that is not a w32 frame,
369 the first display on the list. */
371 struct w32_display_info *
372 check_x_display_info (Lisp_Object frame)
374 if (NILP (frame))
376 struct frame *sf = XFRAME (selected_frame);
378 if (FRAME_W32_P (sf) && FRAME_LIVE_P (sf))
379 return FRAME_W32_DISPLAY_INFO (sf);
380 else
381 return &one_w32_display_info;
383 else if (STRINGP (frame))
384 return x_display_info_for_name (frame);
385 else
387 FRAME_PTR f;
389 CHECK_LIVE_FRAME (frame);
390 f = XFRAME (frame);
391 if (! FRAME_W32_P (f))
392 error ("Non-W32 frame used");
393 return FRAME_W32_DISPLAY_INFO (f);
397 /* Return the Emacs frame-object corresponding to an w32 window.
398 It could be the frame's main window or an icon window. */
400 /* This function can be called during GC, so use GC_xxx type test macros. */
402 struct frame *
403 x_window_to_frame (struct w32_display_info *dpyinfo, HWND wdesc)
405 Lisp_Object tail, frame;
406 struct frame *f;
408 for (tail = Vframe_list; CONSP (tail); tail = XCDR (tail))
410 frame = XCAR (tail);
411 if (!FRAMEP (frame))
412 continue;
413 f = XFRAME (frame);
414 if (!FRAME_W32_P (f) || FRAME_W32_DISPLAY_INFO (f) != dpyinfo)
415 continue;
417 if (FRAME_W32_WINDOW (f) == wdesc)
418 return f;
420 return 0;
424 static Lisp_Object unwind_create_frame (Lisp_Object);
425 static Lisp_Object unwind_create_tip_frame (Lisp_Object);
426 static void my_create_window (struct frame *);
427 static void my_create_tip_window (struct frame *);
429 /* TODO: Native Input Method support; see x_create_im. */
430 void x_set_foreground_color (struct frame *, Lisp_Object, Lisp_Object);
431 void x_set_background_color (struct frame *, Lisp_Object, Lisp_Object);
432 void x_set_mouse_color (struct frame *, Lisp_Object, Lisp_Object);
433 void x_set_cursor_color (struct frame *, Lisp_Object, Lisp_Object);
434 void x_set_border_color (struct frame *, Lisp_Object, Lisp_Object);
435 void x_set_cursor_type (struct frame *, Lisp_Object, Lisp_Object);
436 void x_set_icon_type (struct frame *, Lisp_Object, Lisp_Object);
437 void x_set_icon_name (struct frame *, Lisp_Object, Lisp_Object);
438 void x_explicitly_set_name (struct frame *, Lisp_Object, Lisp_Object);
439 void x_set_menu_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
440 void x_set_title (struct frame *, Lisp_Object, Lisp_Object);
441 void x_set_tool_bar_lines (struct frame *, Lisp_Object, Lisp_Object);
446 /* Store the screen positions of frame F into XPTR and YPTR.
447 These are the positions of the containing window manager window,
448 not Emacs's own window. */
450 void
451 x_real_positions (FRAME_PTR f, int *xptr, int *yptr)
453 POINT pt;
454 RECT rect;
456 /* Get the bounds of the WM window. */
457 GetWindowRect (FRAME_W32_WINDOW (f), &rect);
459 pt.x = 0;
460 pt.y = 0;
462 /* Convert (0, 0) in the client area to screen co-ordinates. */
463 ClientToScreen (FRAME_W32_WINDOW (f), &pt);
465 /* Remember x_pixels_diff and y_pixels_diff. */
466 f->x_pixels_diff = pt.x - rect.left;
467 f->y_pixels_diff = pt.y - rect.top;
469 *xptr = rect.left;
470 *yptr = rect.top;
475 DEFUN ("w32-define-rgb-color", Fw32_define_rgb_color,
476 Sw32_define_rgb_color, 4, 4, 0,
477 doc: /* Convert RGB numbers to a Windows color reference and associate with NAME.
478 This adds or updates a named color to `w32-color-map', making it
479 available for use. The original entry's RGB ref is returned, or nil
480 if the entry is new. */)
481 (Lisp_Object red, Lisp_Object green, Lisp_Object blue, Lisp_Object name)
483 Lisp_Object rgb;
484 Lisp_Object oldrgb = Qnil;
485 Lisp_Object entry;
487 CHECK_NUMBER (red);
488 CHECK_NUMBER (green);
489 CHECK_NUMBER (blue);
490 CHECK_STRING (name);
492 XSETINT (rgb, RGB (XUINT (red), XUINT (green), XUINT (blue)));
494 BLOCK_INPUT;
496 /* replace existing entry in w32-color-map or add new entry. */
497 entry = Fassoc (name, Vw32_color_map);
498 if (NILP (entry))
500 entry = Fcons (name, rgb);
501 Vw32_color_map = Fcons (entry, Vw32_color_map);
503 else
505 oldrgb = Fcdr (entry);
506 Fsetcdr (entry, rgb);
509 UNBLOCK_INPUT;
511 return (oldrgb);
514 /* The default colors for the w32 color map */
515 typedef struct colormap_t
517 char *name;
518 COLORREF colorref;
519 } colormap_t;
521 colormap_t w32_color_map[] =
523 {"snow" , PALETTERGB (255,250,250)},
524 {"ghost white" , PALETTERGB (248,248,255)},
525 {"GhostWhite" , PALETTERGB (248,248,255)},
526 {"white smoke" , PALETTERGB (245,245,245)},
527 {"WhiteSmoke" , PALETTERGB (245,245,245)},
528 {"gainsboro" , PALETTERGB (220,220,220)},
529 {"floral white" , PALETTERGB (255,250,240)},
530 {"FloralWhite" , PALETTERGB (255,250,240)},
531 {"old lace" , PALETTERGB (253,245,230)},
532 {"OldLace" , PALETTERGB (253,245,230)},
533 {"linen" , PALETTERGB (250,240,230)},
534 {"antique white" , PALETTERGB (250,235,215)},
535 {"AntiqueWhite" , PALETTERGB (250,235,215)},
536 {"papaya whip" , PALETTERGB (255,239,213)},
537 {"PapayaWhip" , PALETTERGB (255,239,213)},
538 {"blanched almond" , PALETTERGB (255,235,205)},
539 {"BlanchedAlmond" , PALETTERGB (255,235,205)},
540 {"bisque" , PALETTERGB (255,228,196)},
541 {"peach puff" , PALETTERGB (255,218,185)},
542 {"PeachPuff" , PALETTERGB (255,218,185)},
543 {"navajo white" , PALETTERGB (255,222,173)},
544 {"NavajoWhite" , PALETTERGB (255,222,173)},
545 {"moccasin" , PALETTERGB (255,228,181)},
546 {"cornsilk" , PALETTERGB (255,248,220)},
547 {"ivory" , PALETTERGB (255,255,240)},
548 {"lemon chiffon" , PALETTERGB (255,250,205)},
549 {"LemonChiffon" , PALETTERGB (255,250,205)},
550 {"seashell" , PALETTERGB (255,245,238)},
551 {"honeydew" , PALETTERGB (240,255,240)},
552 {"mint cream" , PALETTERGB (245,255,250)},
553 {"MintCream" , PALETTERGB (245,255,250)},
554 {"azure" , PALETTERGB (240,255,255)},
555 {"alice blue" , PALETTERGB (240,248,255)},
556 {"AliceBlue" , PALETTERGB (240,248,255)},
557 {"lavender" , PALETTERGB (230,230,250)},
558 {"lavender blush" , PALETTERGB (255,240,245)},
559 {"LavenderBlush" , PALETTERGB (255,240,245)},
560 {"misty rose" , PALETTERGB (255,228,225)},
561 {"MistyRose" , PALETTERGB (255,228,225)},
562 {"white" , PALETTERGB (255,255,255)},
563 {"black" , PALETTERGB ( 0, 0, 0)},
564 {"dark slate gray" , PALETTERGB ( 47, 79, 79)},
565 {"DarkSlateGray" , PALETTERGB ( 47, 79, 79)},
566 {"dark slate grey" , PALETTERGB ( 47, 79, 79)},
567 {"DarkSlateGrey" , PALETTERGB ( 47, 79, 79)},
568 {"dim gray" , PALETTERGB (105,105,105)},
569 {"DimGray" , PALETTERGB (105,105,105)},
570 {"dim grey" , PALETTERGB (105,105,105)},
571 {"DimGrey" , PALETTERGB (105,105,105)},
572 {"slate gray" , PALETTERGB (112,128,144)},
573 {"SlateGray" , PALETTERGB (112,128,144)},
574 {"slate grey" , PALETTERGB (112,128,144)},
575 {"SlateGrey" , PALETTERGB (112,128,144)},
576 {"light slate gray" , PALETTERGB (119,136,153)},
577 {"LightSlateGray" , PALETTERGB (119,136,153)},
578 {"light slate grey" , PALETTERGB (119,136,153)},
579 {"LightSlateGrey" , PALETTERGB (119,136,153)},
580 {"gray" , PALETTERGB (190,190,190)},
581 {"grey" , PALETTERGB (190,190,190)},
582 {"light grey" , PALETTERGB (211,211,211)},
583 {"LightGrey" , PALETTERGB (211,211,211)},
584 {"light gray" , PALETTERGB (211,211,211)},
585 {"LightGray" , PALETTERGB (211,211,211)},
586 {"midnight blue" , PALETTERGB ( 25, 25,112)},
587 {"MidnightBlue" , PALETTERGB ( 25, 25,112)},
588 {"navy" , PALETTERGB ( 0, 0,128)},
589 {"navy blue" , PALETTERGB ( 0, 0,128)},
590 {"NavyBlue" , PALETTERGB ( 0, 0,128)},
591 {"cornflower blue" , PALETTERGB (100,149,237)},
592 {"CornflowerBlue" , PALETTERGB (100,149,237)},
593 {"dark slate blue" , PALETTERGB ( 72, 61,139)},
594 {"DarkSlateBlue" , PALETTERGB ( 72, 61,139)},
595 {"slate blue" , PALETTERGB (106, 90,205)},
596 {"SlateBlue" , PALETTERGB (106, 90,205)},
597 {"medium slate blue" , PALETTERGB (123,104,238)},
598 {"MediumSlateBlue" , PALETTERGB (123,104,238)},
599 {"light slate blue" , PALETTERGB (132,112,255)},
600 {"LightSlateBlue" , PALETTERGB (132,112,255)},
601 {"medium blue" , PALETTERGB ( 0, 0,205)},
602 {"MediumBlue" , PALETTERGB ( 0, 0,205)},
603 {"royal blue" , PALETTERGB ( 65,105,225)},
604 {"RoyalBlue" , PALETTERGB ( 65,105,225)},
605 {"blue" , PALETTERGB ( 0, 0,255)},
606 {"dodger blue" , PALETTERGB ( 30,144,255)},
607 {"DodgerBlue" , PALETTERGB ( 30,144,255)},
608 {"deep sky blue" , PALETTERGB ( 0,191,255)},
609 {"DeepSkyBlue" , PALETTERGB ( 0,191,255)},
610 {"sky blue" , PALETTERGB (135,206,235)},
611 {"SkyBlue" , PALETTERGB (135,206,235)},
612 {"light sky blue" , PALETTERGB (135,206,250)},
613 {"LightSkyBlue" , PALETTERGB (135,206,250)},
614 {"steel blue" , PALETTERGB ( 70,130,180)},
615 {"SteelBlue" , PALETTERGB ( 70,130,180)},
616 {"light steel blue" , PALETTERGB (176,196,222)},
617 {"LightSteelBlue" , PALETTERGB (176,196,222)},
618 {"light blue" , PALETTERGB (173,216,230)},
619 {"LightBlue" , PALETTERGB (173,216,230)},
620 {"powder blue" , PALETTERGB (176,224,230)},
621 {"PowderBlue" , PALETTERGB (176,224,230)},
622 {"pale turquoise" , PALETTERGB (175,238,238)},
623 {"PaleTurquoise" , PALETTERGB (175,238,238)},
624 {"dark turquoise" , PALETTERGB ( 0,206,209)},
625 {"DarkTurquoise" , PALETTERGB ( 0,206,209)},
626 {"medium turquoise" , PALETTERGB ( 72,209,204)},
627 {"MediumTurquoise" , PALETTERGB ( 72,209,204)},
628 {"turquoise" , PALETTERGB ( 64,224,208)},
629 {"cyan" , PALETTERGB ( 0,255,255)},
630 {"light cyan" , PALETTERGB (224,255,255)},
631 {"LightCyan" , PALETTERGB (224,255,255)},
632 {"cadet blue" , PALETTERGB ( 95,158,160)},
633 {"CadetBlue" , PALETTERGB ( 95,158,160)},
634 {"medium aquamarine" , PALETTERGB (102,205,170)},
635 {"MediumAquamarine" , PALETTERGB (102,205,170)},
636 {"aquamarine" , PALETTERGB (127,255,212)},
637 {"dark green" , PALETTERGB ( 0,100, 0)},
638 {"DarkGreen" , PALETTERGB ( 0,100, 0)},
639 {"dark olive green" , PALETTERGB ( 85,107, 47)},
640 {"DarkOliveGreen" , PALETTERGB ( 85,107, 47)},
641 {"dark sea green" , PALETTERGB (143,188,143)},
642 {"DarkSeaGreen" , PALETTERGB (143,188,143)},
643 {"sea green" , PALETTERGB ( 46,139, 87)},
644 {"SeaGreen" , PALETTERGB ( 46,139, 87)},
645 {"medium sea green" , PALETTERGB ( 60,179,113)},
646 {"MediumSeaGreen" , PALETTERGB ( 60,179,113)},
647 {"light sea green" , PALETTERGB ( 32,178,170)},
648 {"LightSeaGreen" , PALETTERGB ( 32,178,170)},
649 {"pale green" , PALETTERGB (152,251,152)},
650 {"PaleGreen" , PALETTERGB (152,251,152)},
651 {"spring green" , PALETTERGB ( 0,255,127)},
652 {"SpringGreen" , PALETTERGB ( 0,255,127)},
653 {"lawn green" , PALETTERGB (124,252, 0)},
654 {"LawnGreen" , PALETTERGB (124,252, 0)},
655 {"green" , PALETTERGB ( 0,255, 0)},
656 {"chartreuse" , PALETTERGB (127,255, 0)},
657 {"medium spring green" , PALETTERGB ( 0,250,154)},
658 {"MediumSpringGreen" , PALETTERGB ( 0,250,154)},
659 {"green yellow" , PALETTERGB (173,255, 47)},
660 {"GreenYellow" , PALETTERGB (173,255, 47)},
661 {"lime green" , PALETTERGB ( 50,205, 50)},
662 {"LimeGreen" , PALETTERGB ( 50,205, 50)},
663 {"yellow green" , PALETTERGB (154,205, 50)},
664 {"YellowGreen" , PALETTERGB (154,205, 50)},
665 {"forest green" , PALETTERGB ( 34,139, 34)},
666 {"ForestGreen" , PALETTERGB ( 34,139, 34)},
667 {"olive drab" , PALETTERGB (107,142, 35)},
668 {"OliveDrab" , PALETTERGB (107,142, 35)},
669 {"dark khaki" , PALETTERGB (189,183,107)},
670 {"DarkKhaki" , PALETTERGB (189,183,107)},
671 {"khaki" , PALETTERGB (240,230,140)},
672 {"pale goldenrod" , PALETTERGB (238,232,170)},
673 {"PaleGoldenrod" , PALETTERGB (238,232,170)},
674 {"light goldenrod yellow" , PALETTERGB (250,250,210)},
675 {"LightGoldenrodYellow" , PALETTERGB (250,250,210)},
676 {"light yellow" , PALETTERGB (255,255,224)},
677 {"LightYellow" , PALETTERGB (255,255,224)},
678 {"yellow" , PALETTERGB (255,255, 0)},
679 {"gold" , PALETTERGB (255,215, 0)},
680 {"light goldenrod" , PALETTERGB (238,221,130)},
681 {"LightGoldenrod" , PALETTERGB (238,221,130)},
682 {"goldenrod" , PALETTERGB (218,165, 32)},
683 {"dark goldenrod" , PALETTERGB (184,134, 11)},
684 {"DarkGoldenrod" , PALETTERGB (184,134, 11)},
685 {"rosy brown" , PALETTERGB (188,143,143)},
686 {"RosyBrown" , PALETTERGB (188,143,143)},
687 {"indian red" , PALETTERGB (205, 92, 92)},
688 {"IndianRed" , PALETTERGB (205, 92, 92)},
689 {"saddle brown" , PALETTERGB (139, 69, 19)},
690 {"SaddleBrown" , PALETTERGB (139, 69, 19)},
691 {"sienna" , PALETTERGB (160, 82, 45)},
692 {"peru" , PALETTERGB (205,133, 63)},
693 {"burlywood" , PALETTERGB (222,184,135)},
694 {"beige" , PALETTERGB (245,245,220)},
695 {"wheat" , PALETTERGB (245,222,179)},
696 {"sandy brown" , PALETTERGB (244,164, 96)},
697 {"SandyBrown" , PALETTERGB (244,164, 96)},
698 {"tan" , PALETTERGB (210,180,140)},
699 {"chocolate" , PALETTERGB (210,105, 30)},
700 {"firebrick" , PALETTERGB (178,34, 34)},
701 {"brown" , PALETTERGB (165,42, 42)},
702 {"dark salmon" , PALETTERGB (233,150,122)},
703 {"DarkSalmon" , PALETTERGB (233,150,122)},
704 {"salmon" , PALETTERGB (250,128,114)},
705 {"light salmon" , PALETTERGB (255,160,122)},
706 {"LightSalmon" , PALETTERGB (255,160,122)},
707 {"orange" , PALETTERGB (255,165, 0)},
708 {"dark orange" , PALETTERGB (255,140, 0)},
709 {"DarkOrange" , PALETTERGB (255,140, 0)},
710 {"coral" , PALETTERGB (255,127, 80)},
711 {"light coral" , PALETTERGB (240,128,128)},
712 {"LightCoral" , PALETTERGB (240,128,128)},
713 {"tomato" , PALETTERGB (255, 99, 71)},
714 {"orange red" , PALETTERGB (255, 69, 0)},
715 {"OrangeRed" , PALETTERGB (255, 69, 0)},
716 {"red" , PALETTERGB (255, 0, 0)},
717 {"hot pink" , PALETTERGB (255,105,180)},
718 {"HotPink" , PALETTERGB (255,105,180)},
719 {"deep pink" , PALETTERGB (255, 20,147)},
720 {"DeepPink" , PALETTERGB (255, 20,147)},
721 {"pink" , PALETTERGB (255,192,203)},
722 {"light pink" , PALETTERGB (255,182,193)},
723 {"LightPink" , PALETTERGB (255,182,193)},
724 {"pale violet red" , PALETTERGB (219,112,147)},
725 {"PaleVioletRed" , PALETTERGB (219,112,147)},
726 {"maroon" , PALETTERGB (176, 48, 96)},
727 {"medium violet red" , PALETTERGB (199, 21,133)},
728 {"MediumVioletRed" , PALETTERGB (199, 21,133)},
729 {"violet red" , PALETTERGB (208, 32,144)},
730 {"VioletRed" , PALETTERGB (208, 32,144)},
731 {"magenta" , PALETTERGB (255, 0,255)},
732 {"violet" , PALETTERGB (238,130,238)},
733 {"plum" , PALETTERGB (221,160,221)},
734 {"orchid" , PALETTERGB (218,112,214)},
735 {"medium orchid" , PALETTERGB (186, 85,211)},
736 {"MediumOrchid" , PALETTERGB (186, 85,211)},
737 {"dark orchid" , PALETTERGB (153, 50,204)},
738 {"DarkOrchid" , PALETTERGB (153, 50,204)},
739 {"dark violet" , PALETTERGB (148, 0,211)},
740 {"DarkViolet" , PALETTERGB (148, 0,211)},
741 {"blue violet" , PALETTERGB (138, 43,226)},
742 {"BlueViolet" , PALETTERGB (138, 43,226)},
743 {"purple" , PALETTERGB (160, 32,240)},
744 {"medium purple" , PALETTERGB (147,112,219)},
745 {"MediumPurple" , PALETTERGB (147,112,219)},
746 {"thistle" , PALETTERGB (216,191,216)},
747 {"gray0" , PALETTERGB ( 0, 0, 0)},
748 {"grey0" , PALETTERGB ( 0, 0, 0)},
749 {"dark grey" , PALETTERGB (169,169,169)},
750 {"DarkGrey" , PALETTERGB (169,169,169)},
751 {"dark gray" , PALETTERGB (169,169,169)},
752 {"DarkGray" , PALETTERGB (169,169,169)},
753 {"dark blue" , PALETTERGB ( 0, 0,139)},
754 {"DarkBlue" , PALETTERGB ( 0, 0,139)},
755 {"dark cyan" , PALETTERGB ( 0,139,139)},
756 {"DarkCyan" , PALETTERGB ( 0,139,139)},
757 {"dark magenta" , PALETTERGB (139, 0,139)},
758 {"DarkMagenta" , PALETTERGB (139, 0,139)},
759 {"dark red" , PALETTERGB (139, 0, 0)},
760 {"DarkRed" , PALETTERGB (139, 0, 0)},
761 {"light green" , PALETTERGB (144,238,144)},
762 {"LightGreen" , PALETTERGB (144,238,144)},
765 DEFUN ("w32-default-color-map", Fw32_default_color_map, Sw32_default_color_map,
766 0, 0, 0, doc: /* Return the default color map. */)
767 (void)
769 int i;
770 colormap_t *pc = w32_color_map;
771 Lisp_Object cmap;
773 BLOCK_INPUT;
775 cmap = Qnil;
777 for (i = 0; i < sizeof (w32_color_map) / sizeof (w32_color_map[0]);
778 pc++, i++)
779 cmap = Fcons (Fcons (build_string (pc->name),
780 make_number (pc->colorref)),
781 cmap);
783 UNBLOCK_INPUT;
785 return (cmap);
788 static Lisp_Object
789 w32_color_map_lookup (char *colorname)
791 Lisp_Object tail, ret = Qnil;
793 BLOCK_INPUT;
795 for (tail = Vw32_color_map; CONSP (tail); tail = XCDR (tail))
797 register Lisp_Object elt, tem;
799 elt = XCAR (tail);
800 if (!CONSP (elt)) continue;
802 tem = Fcar (elt);
804 if (lstrcmpi (SDATA (tem), colorname) == 0)
806 ret = Fcdr (elt);
807 break;
810 QUIT;
814 UNBLOCK_INPUT;
816 return ret;
820 static void
821 add_system_logical_colors_to_map (Lisp_Object *system_colors)
823 HKEY colors_key;
825 /* Other registry operations are done with input blocked. */
826 BLOCK_INPUT;
828 /* Look for "Control Panel/Colors" under User and Machine registry
829 settings. */
830 if (RegOpenKeyEx (HKEY_CURRENT_USER, "Control Panel\\Colors", 0,
831 KEY_READ, &colors_key) == ERROR_SUCCESS
832 || RegOpenKeyEx (HKEY_LOCAL_MACHINE, "Control Panel\\Colors", 0,
833 KEY_READ, &colors_key) == ERROR_SUCCESS)
835 /* List all keys. */
836 char color_buffer[64];
837 char full_name_buffer[MAX_PATH + SYSTEM_COLOR_PREFIX_LEN];
838 int index = 0;
839 DWORD name_size, color_size;
840 char *name_buffer = full_name_buffer + SYSTEM_COLOR_PREFIX_LEN;
842 name_size = sizeof (full_name_buffer) - SYSTEM_COLOR_PREFIX_LEN;
843 color_size = sizeof (color_buffer);
845 strcpy (full_name_buffer, SYSTEM_COLOR_PREFIX);
847 while (RegEnumValueA (colors_key, index, name_buffer, &name_size,
848 NULL, NULL, color_buffer, &color_size)
849 == ERROR_SUCCESS)
851 int r, g, b;
852 if (sscanf (color_buffer, " %u %u %u", &r, &g, &b) == 3)
853 *system_colors = Fcons (Fcons (build_string (full_name_buffer),
854 make_number (RGB (r, g, b))),
855 *system_colors);
857 name_size = sizeof (full_name_buffer) - SYSTEM_COLOR_PREFIX_LEN;
858 color_size = sizeof (color_buffer);
859 index++;
861 RegCloseKey (colors_key);
864 UNBLOCK_INPUT;
868 static Lisp_Object
869 x_to_w32_color (char * colorname)
871 register Lisp_Object ret = Qnil;
873 BLOCK_INPUT;
875 if (colorname[0] == '#')
877 /* Could be an old-style RGB Device specification. */
878 char *color;
879 int size;
880 color = colorname + 1;
882 size = strlen (color);
883 if (size == 3 || size == 6 || size == 9 || size == 12)
885 UINT colorval;
886 int i, pos;
887 pos = 0;
888 size /= 3;
889 colorval = 0;
891 for (i = 0; i < 3; i++)
893 char *end;
894 char t;
895 unsigned long value;
897 /* The check for 'x' in the following conditional takes into
898 account the fact that strtol allows a "0x" in front of
899 our numbers, and we don't. */
900 if (!isxdigit (color[0]) || color[1] == 'x')
901 break;
902 t = color[size];
903 color[size] = '\0';
904 value = strtoul (color, &end, 16);
905 color[size] = t;
906 if (errno == ERANGE || end - color != size)
907 break;
908 switch (size)
910 case 1:
911 value = value * 0x10;
912 break;
913 case 2:
914 break;
915 case 3:
916 value /= 0x10;
917 break;
918 case 4:
919 value /= 0x100;
920 break;
922 colorval |= (value << pos);
923 pos += 0x8;
924 if (i == 2)
926 UNBLOCK_INPUT;
927 XSETINT (ret, colorval);
928 return ret;
930 color = end;
934 else if (strnicmp (colorname, "rgb:", 4) == 0)
936 char *color;
937 UINT colorval;
938 int i, pos;
939 pos = 0;
941 colorval = 0;
942 color = colorname + 4;
943 for (i = 0; i < 3; i++)
945 char *end;
946 unsigned long value;
948 /* The check for 'x' in the following conditional takes into
949 account the fact that strtol allows a "0x" in front of
950 our numbers, and we don't. */
951 if (!isxdigit (color[0]) || color[1] == 'x')
952 break;
953 value = strtoul (color, &end, 16);
954 if (errno == ERANGE)
955 break;
956 switch (end - color)
958 case 1:
959 value = value * 0x10 + value;
960 break;
961 case 2:
962 break;
963 case 3:
964 value /= 0x10;
965 break;
966 case 4:
967 value /= 0x100;
968 break;
969 default:
970 value = ULONG_MAX;
972 if (value == ULONG_MAX)
973 break;
974 colorval |= (value << pos);
975 pos += 0x8;
976 if (i == 2)
978 if (*end != '\0')
979 break;
980 UNBLOCK_INPUT;
981 XSETINT (ret, colorval);
982 return ret;
984 if (*end != '/')
985 break;
986 color = end + 1;
989 else if (strnicmp (colorname, "rgbi:", 5) == 0)
991 /* This is an RGB Intensity specification. */
992 char *color;
993 UINT colorval;
994 int i, pos;
995 pos = 0;
997 colorval = 0;
998 color = colorname + 5;
999 for (i = 0; i < 3; i++)
1001 char *end;
1002 double value;
1003 UINT val;
1005 value = strtod (color, &end);
1006 if (errno == ERANGE)
1007 break;
1008 if (value < 0.0 || value > 1.0)
1009 break;
1010 val = (UINT)(0x100 * value);
1011 /* We used 0x100 instead of 0xFF to give a continuous
1012 range between 0.0 and 1.0 inclusive. The next statement
1013 fixes the 1.0 case. */
1014 if (val == 0x100)
1015 val = 0xFF;
1016 colorval |= (val << pos);
1017 pos += 0x8;
1018 if (i == 2)
1020 if (*end != '\0')
1021 break;
1022 UNBLOCK_INPUT;
1023 XSETINT (ret, colorval);
1024 return ret;
1026 if (*end != '/')
1027 break;
1028 color = end + 1;
1031 /* I am not going to attempt to handle any of the CIE color schemes
1032 or TekHVC, since I don't know the algorithms for conversion to
1033 RGB. */
1035 /* If we fail to lookup the color name in w32_color_map, then check the
1036 colorname to see if it can be crudely approximated: If the X color
1037 ends in a number (e.g., "darkseagreen2"), strip the number and
1038 return the result of looking up the base color name. */
1039 ret = w32_color_map_lookup (colorname);
1040 if (NILP (ret))
1042 int len = strlen (colorname);
1044 if (isdigit (colorname[len - 1]))
1046 char *ptr, *approx = alloca (len + 1);
1048 strcpy (approx, colorname);
1049 ptr = &approx[len - 1];
1050 while (ptr > approx && isdigit (*ptr))
1051 *ptr-- = '\0';
1053 ret = w32_color_map_lookup (approx);
1057 UNBLOCK_INPUT;
1058 return ret;
1061 void
1062 w32_regenerate_palette (FRAME_PTR f)
1064 struct w32_palette_entry * list;
1065 LOGPALETTE * log_palette;
1066 HPALETTE new_palette;
1067 int i;
1069 /* don't bother trying to create palette if not supported */
1070 if (! FRAME_W32_DISPLAY_INFO (f)->has_palette)
1071 return;
1073 log_palette = (LOGPALETTE *)
1074 alloca (sizeof (LOGPALETTE) +
1075 FRAME_W32_DISPLAY_INFO (f)->num_colors * sizeof (PALETTEENTRY));
1076 log_palette->palVersion = 0x300;
1077 log_palette->palNumEntries = FRAME_W32_DISPLAY_INFO (f)->num_colors;
1079 list = FRAME_W32_DISPLAY_INFO (f)->color_list;
1080 for (i = 0;
1081 i < FRAME_W32_DISPLAY_INFO (f)->num_colors;
1082 i++, list = list->next)
1083 log_palette->palPalEntry[i] = list->entry;
1085 new_palette = CreatePalette (log_palette);
1087 enter_crit ();
1089 if (FRAME_W32_DISPLAY_INFO (f)->palette)
1090 DeleteObject (FRAME_W32_DISPLAY_INFO (f)->palette);
1091 FRAME_W32_DISPLAY_INFO (f)->palette = new_palette;
1093 /* Realize display palette and garbage all frames. */
1094 release_frame_dc (f, get_frame_dc (f));
1096 leave_crit ();
1099 #define W32_COLOR(pe) RGB (pe.peRed, pe.peGreen, pe.peBlue)
1100 #define SET_W32_COLOR(pe, color) \
1101 do \
1103 pe.peRed = GetRValue (color); \
1104 pe.peGreen = GetGValue (color); \
1105 pe.peBlue = GetBValue (color); \
1106 pe.peFlags = 0; \
1107 } while (0)
1109 #if 0
1110 /* Keep these around in case we ever want to track color usage. */
1111 void
1112 w32_map_color (FRAME_PTR f, COLORREF color)
1114 struct w32_palette_entry * list = FRAME_W32_DISPLAY_INFO (f)->color_list;
1116 if (NILP (Vw32_enable_palette))
1117 return;
1119 /* check if color is already mapped */
1120 while (list)
1122 if (W32_COLOR (list->entry) == color)
1124 ++list->refcount;
1125 return;
1127 list = list->next;
1130 /* not already mapped, so add to list and recreate Windows palette */
1131 list = (struct w32_palette_entry *)
1132 xmalloc (sizeof (struct w32_palette_entry));
1133 SET_W32_COLOR (list->entry, color);
1134 list->refcount = 1;
1135 list->next = FRAME_W32_DISPLAY_INFO (f)->color_list;
1136 FRAME_W32_DISPLAY_INFO (f)->color_list = list;
1137 FRAME_W32_DISPLAY_INFO (f)->num_colors++;
1139 /* set flag that palette must be regenerated */
1140 FRAME_W32_DISPLAY_INFO (f)->regen_palette = TRUE;
1143 void
1144 w32_unmap_color (FRAME_PTR f, COLORREF color)
1146 struct w32_palette_entry * list = FRAME_W32_DISPLAY_INFO (f)->color_list;
1147 struct w32_palette_entry **prev = &FRAME_W32_DISPLAY_INFO (f)->color_list;
1149 if (NILP (Vw32_enable_palette))
1150 return;
1152 /* check if color is already mapped */
1153 while (list)
1155 if (W32_COLOR (list->entry) == color)
1157 if (--list->refcount == 0)
1159 *prev = list->next;
1160 xfree (list);
1161 FRAME_W32_DISPLAY_INFO (f)->num_colors--;
1162 break;
1164 else
1165 return;
1167 prev = &list->next;
1168 list = list->next;
1171 /* set flag that palette must be regenerated */
1172 FRAME_W32_DISPLAY_INFO (f)->regen_palette = TRUE;
1174 #endif
1177 /* Gamma-correct COLOR on frame F. */
1179 void
1180 gamma_correct (struct frame *f, COLORREF *color)
1182 if (f->gamma)
1184 *color = PALETTERGB (
1185 pow (GetRValue (*color) / 255.0, f->gamma) * 255.0 + 0.5,
1186 pow (GetGValue (*color) / 255.0, f->gamma) * 255.0 + 0.5,
1187 pow (GetBValue (*color) / 255.0, f->gamma) * 255.0 + 0.5);
1192 /* Decide if color named COLOR is valid for the display associated with
1193 the selected frame; if so, return the rgb values in COLOR_DEF.
1194 If ALLOC is nonzero, allocate a new colormap cell. */
1197 w32_defined_color (FRAME_PTR f, char *color, XColor *color_def, int alloc)
1199 register Lisp_Object tem;
1200 COLORREF w32_color_ref;
1202 tem = x_to_w32_color (color);
1204 if (!NILP (tem))
1206 if (f)
1208 /* Apply gamma correction. */
1209 w32_color_ref = XUINT (tem);
1210 gamma_correct (f, &w32_color_ref);
1211 XSETINT (tem, w32_color_ref);
1214 /* Map this color to the palette if it is enabled. */
1215 if (!NILP (Vw32_enable_palette))
1217 struct w32_palette_entry * entry =
1218 one_w32_display_info.color_list;
1219 struct w32_palette_entry ** prev =
1220 &one_w32_display_info.color_list;
1222 /* check if color is already mapped */
1223 while (entry)
1225 if (W32_COLOR (entry->entry) == XUINT (tem))
1226 break;
1227 prev = &entry->next;
1228 entry = entry->next;
1231 if (entry == NULL && alloc)
1233 /* not already mapped, so add to list */
1234 entry = (struct w32_palette_entry *)
1235 xmalloc (sizeof (struct w32_palette_entry));
1236 SET_W32_COLOR (entry->entry, XUINT (tem));
1237 entry->next = NULL;
1238 *prev = entry;
1239 one_w32_display_info.num_colors++;
1241 /* set flag that palette must be regenerated */
1242 one_w32_display_info.regen_palette = TRUE;
1245 /* Ensure COLORREF value is snapped to nearest color in (default)
1246 palette by simulating the PALETTERGB macro. This works whether
1247 or not the display device has a palette. */
1248 w32_color_ref = XUINT (tem) | 0x2000000;
1250 color_def->pixel = w32_color_ref;
1251 color_def->red = GetRValue (w32_color_ref) * 256;
1252 color_def->green = GetGValue (w32_color_ref) * 256;
1253 color_def->blue = GetBValue (w32_color_ref) * 256;
1255 return 1;
1257 else
1259 return 0;
1263 /* Given a string ARG naming a color, compute a pixel value from it
1264 suitable for screen F.
1265 If F is not a color screen, return DEF (default) regardless of what
1266 ARG says. */
1269 x_decode_color (FRAME_PTR f, Lisp_Object arg, int def)
1271 XColor cdef;
1273 CHECK_STRING (arg);
1275 if (strcmp (SDATA (arg), "black") == 0)
1276 return BLACK_PIX_DEFAULT (f);
1277 else if (strcmp (SDATA (arg), "white") == 0)
1278 return WHITE_PIX_DEFAULT (f);
1280 if ((FRAME_W32_DISPLAY_INFO (f)->n_planes * FRAME_W32_DISPLAY_INFO (f)->n_cbits) == 1)
1281 return def;
1283 /* w32_defined_color is responsible for coping with failures
1284 by looking for a near-miss. */
1285 if (w32_defined_color (f, SDATA (arg), &cdef, 1))
1286 return cdef.pixel;
1288 /* defined_color failed; return an ultimate default. */
1289 return def;
1294 /* Functions called only from `x_set_frame_param'
1295 to set individual parameters.
1297 If FRAME_W32_WINDOW (f) is 0,
1298 the frame is being created and its window does not exist yet.
1299 In that case, just record the parameter's new value
1300 in the standard place; do not attempt to change the window. */
1302 void
1303 x_set_foreground_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1305 struct w32_output *x = f->output_data.w32;
1306 PIX_TYPE fg, old_fg;
1308 fg = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1309 old_fg = FRAME_FOREGROUND_PIXEL (f);
1310 FRAME_FOREGROUND_PIXEL (f) = fg;
1312 if (FRAME_W32_WINDOW (f) != 0)
1314 if (x->cursor_pixel == old_fg)
1316 x->cursor_pixel = fg;
1317 x->cursor_gc->background = fg;
1320 update_face_from_frame_parameter (f, Qforeground_color, arg);
1321 if (FRAME_VISIBLE_P (f))
1322 redraw_frame (f);
1326 void
1327 x_set_background_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1329 FRAME_BACKGROUND_PIXEL (f)
1330 = x_decode_color (f, arg, WHITE_PIX_DEFAULT (f));
1332 if (FRAME_W32_WINDOW (f) != 0)
1334 SetWindowLong (FRAME_W32_WINDOW (f), WND_BACKGROUND_INDEX,
1335 FRAME_BACKGROUND_PIXEL (f));
1337 update_face_from_frame_parameter (f, Qbackground_color, arg);
1339 if (FRAME_VISIBLE_P (f))
1340 redraw_frame (f);
1344 void
1345 x_set_mouse_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1347 Cursor cursor, nontext_cursor, mode_cursor, hand_cursor;
1348 int count;
1349 int mask_color;
1351 if (!EQ (Qnil, arg))
1352 f->output_data.w32->mouse_pixel
1353 = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1354 mask_color = FRAME_BACKGROUND_PIXEL (f);
1356 /* Don't let pointers be invisible. */
1357 if (mask_color == f->output_data.w32->mouse_pixel
1358 && mask_color == FRAME_BACKGROUND_PIXEL (f))
1359 f->output_data.w32->mouse_pixel = FRAME_FOREGROUND_PIXEL (f);
1361 #if 0 /* TODO : Mouse cursor customization. */
1362 BLOCK_INPUT;
1364 /* It's not okay to crash if the user selects a screwy cursor. */
1365 count = x_catch_errors (FRAME_W32_DISPLAY (f));
1367 if (!EQ (Qnil, Vx_pointer_shape))
1369 CHECK_NUMBER (Vx_pointer_shape);
1370 cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XINT (Vx_pointer_shape));
1372 else
1373 cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_xterm);
1374 x_check_errors (FRAME_W32_DISPLAY (f), "bad text pointer cursor: %s");
1376 if (!EQ (Qnil, Vx_nontext_pointer_shape))
1378 CHECK_NUMBER (Vx_nontext_pointer_shape);
1379 nontext_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f),
1380 XINT (Vx_nontext_pointer_shape));
1382 else
1383 nontext_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_left_ptr);
1384 x_check_errors (FRAME_W32_DISPLAY (f), "bad nontext pointer cursor: %s");
1386 if (!EQ (Qnil, Vx_hourglass_pointer_shape))
1388 CHECK_NUMBER (Vx_hourglass_pointer_shape);
1389 hourglass_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f),
1390 XINT (Vx_hourglass_pointer_shape));
1392 else
1393 hourglass_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_watch);
1394 x_check_errors (FRAME_W32_DISPLAY (f), "bad busy pointer cursor: %s");
1396 x_check_errors (FRAME_W32_DISPLAY (f), "bad nontext pointer cursor: %s");
1397 if (!EQ (Qnil, Vx_mode_pointer_shape))
1399 CHECK_NUMBER (Vx_mode_pointer_shape);
1400 mode_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f),
1401 XINT (Vx_mode_pointer_shape));
1403 else
1404 mode_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_xterm);
1405 x_check_errors (FRAME_W32_DISPLAY (f), "bad modeline pointer cursor: %s");
1407 if (!EQ (Qnil, Vx_sensitive_text_pointer_shape))
1409 CHECK_NUMBER (Vx_sensitive_text_pointer_shape);
1410 hand_cursor
1411 = XCreateFontCursor (FRAME_W32_DISPLAY (f),
1412 XINT (Vx_sensitive_text_pointer_shape));
1414 else
1415 hand_cursor = XCreateFontCursor (FRAME_W32_DISPLAY (f), XC_crosshair);
1417 if (!NILP (Vx_window_horizontal_drag_shape))
1419 CHECK_NUMBER (Vx_window_horizontal_drag_shape);
1420 horizontal_drag_cursor
1421 = XCreateFontCursor (FRAME_X_DISPLAY (f),
1422 XINT (Vx_window_horizontal_drag_shape));
1424 else
1425 horizontal_drag_cursor
1426 = XCreateFontCursor (FRAME_X_DISPLAY (f), XC_sb_h_double_arrow);
1428 /* Check and report errors with the above calls. */
1429 x_check_errors (FRAME_W32_DISPLAY (f), "can't set cursor shape: %s");
1430 x_uncatch_errors (FRAME_W32_DISPLAY (f), count);
1433 XColor fore_color, back_color;
1435 fore_color.pixel = f->output_data.w32->mouse_pixel;
1436 back_color.pixel = mask_color;
1437 XQueryColor (FRAME_W32_DISPLAY (f),
1438 DefaultColormap (FRAME_W32_DISPLAY (f),
1439 DefaultScreen (FRAME_W32_DISPLAY (f))),
1440 &fore_color);
1441 XQueryColor (FRAME_W32_DISPLAY (f),
1442 DefaultColormap (FRAME_W32_DISPLAY (f),
1443 DefaultScreen (FRAME_W32_DISPLAY (f))),
1444 &back_color);
1445 XRecolorCursor (FRAME_W32_DISPLAY (f), cursor,
1446 &fore_color, &back_color);
1447 XRecolorCursor (FRAME_W32_DISPLAY (f), nontext_cursor,
1448 &fore_color, &back_color);
1449 XRecolorCursor (FRAME_W32_DISPLAY (f), mode_cursor,
1450 &fore_color, &back_color);
1451 XRecolorCursor (FRAME_W32_DISPLAY (f), hand_cursor,
1452 &fore_color, &back_color);
1453 XRecolorCursor (FRAME_W32_DISPLAY (f), hourglass_cursor,
1454 &fore_color, &back_color);
1457 if (FRAME_W32_WINDOW (f) != 0)
1458 XDefineCursor (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f), cursor);
1460 if (cursor != f->output_data.w32->text_cursor && f->output_data.w32->text_cursor != 0)
1461 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->text_cursor);
1462 f->output_data.w32->text_cursor = cursor;
1464 if (nontext_cursor != f->output_data.w32->nontext_cursor
1465 && f->output_data.w32->nontext_cursor != 0)
1466 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->nontext_cursor);
1467 f->output_data.w32->nontext_cursor = nontext_cursor;
1469 if (hourglass_cursor != f->output_data.w32->hourglass_cursor
1470 && f->output_data.w32->hourglass_cursor != 0)
1471 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->hourglass_cursor);
1472 f->output_data.w32->hourglass_cursor = hourglass_cursor;
1474 if (mode_cursor != f->output_data.w32->modeline_cursor
1475 && f->output_data.w32->modeline_cursor != 0)
1476 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->modeline_cursor);
1477 f->output_data.w32->modeline_cursor = mode_cursor;
1479 if (hand_cursor != f->output_data.w32->hand_cursor
1480 && f->output_data.w32->hand_cursor != 0)
1481 XFreeCursor (FRAME_W32_DISPLAY (f), f->output_data.w32->hand_cursor);
1482 f->output_data.w32->hand_cursor = hand_cursor;
1484 XFlush (FRAME_W32_DISPLAY (f));
1485 UNBLOCK_INPUT;
1487 update_face_from_frame_parameter (f, Qmouse_color, arg);
1488 #endif /* TODO */
1491 void
1492 x_set_cursor_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1494 unsigned long fore_pixel, pixel;
1496 if (!NILP (Vx_cursor_fore_pixel))
1497 fore_pixel = x_decode_color (f, Vx_cursor_fore_pixel,
1498 WHITE_PIX_DEFAULT (f));
1499 else
1500 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
1502 pixel = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1504 /* Make sure that the cursor color differs from the background color. */
1505 if (pixel == FRAME_BACKGROUND_PIXEL (f))
1507 pixel = f->output_data.w32->mouse_pixel;
1508 if (pixel == fore_pixel)
1509 fore_pixel = FRAME_BACKGROUND_PIXEL (f);
1512 f->output_data.w32->cursor_foreground_pixel = fore_pixel;
1513 f->output_data.w32->cursor_pixel = pixel;
1515 if (FRAME_W32_WINDOW (f) != 0)
1517 BLOCK_INPUT;
1518 /* Update frame's cursor_gc. */
1519 f->output_data.w32->cursor_gc->foreground = fore_pixel;
1520 f->output_data.w32->cursor_gc->background = pixel;
1522 UNBLOCK_INPUT;
1524 if (FRAME_VISIBLE_P (f))
1526 x_update_cursor (f, 0);
1527 x_update_cursor (f, 1);
1531 update_face_from_frame_parameter (f, Qcursor_color, arg);
1534 /* Set the border-color of frame F to pixel value PIX.
1535 Note that this does not fully take effect if done before
1536 F has a window. */
1538 void
1539 x_set_border_pixel (struct frame *f, int pix)
1542 f->output_data.w32->border_pixel = pix;
1544 if (FRAME_W32_WINDOW (f) != 0 && f->border_width > 0)
1546 if (FRAME_VISIBLE_P (f))
1547 redraw_frame (f);
1551 /* Set the border-color of frame F to value described by ARG.
1552 ARG can be a string naming a color.
1553 The border-color is used for the border that is drawn by the server.
1554 Note that this does not fully take effect if done before
1555 F has a window; it must be redone when the window is created. */
1557 void
1558 x_set_border_color (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1560 int pix;
1562 CHECK_STRING (arg);
1563 pix = x_decode_color (f, arg, BLACK_PIX_DEFAULT (f));
1564 x_set_border_pixel (f, pix);
1565 update_face_from_frame_parameter (f, Qborder_color, arg);
1569 void
1570 x_set_cursor_type (FRAME_PTR f, Lisp_Object arg, Lisp_Object oldval)
1572 set_frame_cursor_types (f, arg);
1574 /* Make sure the cursor gets redrawn. */
1575 cursor_type_changed = 1;
1578 void
1579 x_set_icon_type (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1581 int result;
1583 if (NILP (arg) && NILP (oldval))
1584 return;
1586 if (STRINGP (arg) && STRINGP (oldval)
1587 && EQ (Fstring_equal (oldval, arg), Qt))
1588 return;
1590 if (SYMBOLP (arg) && SYMBOLP (oldval) && EQ (arg, oldval))
1591 return;
1593 BLOCK_INPUT;
1595 result = x_bitmap_icon (f, arg);
1596 if (result)
1598 UNBLOCK_INPUT;
1599 error ("No icon window available");
1602 UNBLOCK_INPUT;
1605 void
1606 x_set_icon_name (struct frame *f, Lisp_Object arg, Lisp_Object oldval)
1608 if (STRINGP (arg))
1610 if (STRINGP (oldval) && EQ (Fstring_equal (oldval, arg), Qt))
1611 return;
1613 else if (!NILP (arg) || NILP (oldval))
1614 return;
1616 f->icon_name = arg;
1618 #if 0
1619 if (f->output_data.w32->icon_bitmap != 0)
1620 return;
1622 BLOCK_INPUT;
1624 result = x_text_icon (f,
1625 (char *) SDATA ((!NILP (f->icon_name)
1626 ? f->icon_name
1627 : !NILP (f->title)
1628 ? f->title
1629 : f->name)));
1631 if (result)
1633 UNBLOCK_INPUT;
1634 error ("No icon window available");
1637 /* If the window was unmapped (and its icon was mapped),
1638 the new icon is not mapped, so map the window in its stead. */
1639 if (FRAME_VISIBLE_P (f))
1641 #ifdef USE_X_TOOLKIT
1642 XtPopup (f->output_data.w32->widget, XtGrabNone);
1643 #endif
1644 XMapWindow (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f));
1647 XFlush (FRAME_W32_DISPLAY (f));
1648 UNBLOCK_INPUT;
1649 #endif
1653 void
1654 x_set_menu_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1656 int nlines;
1657 int olines = FRAME_MENU_BAR_LINES (f);
1659 /* Right now, menu bars don't work properly in minibuf-only frames;
1660 most of the commands try to apply themselves to the minibuffer
1661 frame itself, and get an error because you can't switch buffers
1662 in or split the minibuffer window. */
1663 if (FRAME_MINIBUF_ONLY_P (f))
1664 return;
1666 if (INTEGERP (value))
1667 nlines = XINT (value);
1668 else
1669 nlines = 0;
1671 FRAME_MENU_BAR_LINES (f) = 0;
1672 if (nlines)
1673 FRAME_EXTERNAL_MENU_BAR (f) = 1;
1674 else
1676 if (FRAME_EXTERNAL_MENU_BAR (f) == 1)
1677 free_frame_menubar (f);
1678 FRAME_EXTERNAL_MENU_BAR (f) = 0;
1680 /* Adjust the frame size so that the client (text) dimensions
1681 remain the same. This depends on FRAME_EXTERNAL_MENU_BAR being
1682 set correctly. */
1683 x_set_window_size (f, 0, FRAME_COLS (f), FRAME_LINES (f));
1684 do_pending_window_change (0);
1686 adjust_glyphs (f);
1690 /* Set the number of lines used for the tool bar of frame F to VALUE.
1691 VALUE not an integer, or < 0 means set the lines to zero. OLDVAL
1692 is the old number of tool bar lines. This function changes the
1693 height of all windows on frame F to match the new tool bar height.
1694 The frame's height doesn't change. */
1696 void
1697 x_set_tool_bar_lines (struct frame *f, Lisp_Object value, Lisp_Object oldval)
1699 int delta, nlines, root_height;
1700 Lisp_Object root_window;
1702 /* Treat tool bars like menu bars. */
1703 if (FRAME_MINIBUF_ONLY_P (f))
1704 return;
1706 /* Use VALUE only if an integer >= 0. */
1707 if (INTEGERP (value) && XINT (value) >= 0)
1708 nlines = XFASTINT (value);
1709 else
1710 nlines = 0;
1712 /* Make sure we redisplay all windows in this frame. */
1713 ++windows_or_buffers_changed;
1715 delta = nlines - FRAME_TOOL_BAR_LINES (f);
1717 /* Don't resize the tool-bar to more than we have room for. */
1718 root_window = FRAME_ROOT_WINDOW (f);
1719 root_height = WINDOW_TOTAL_LINES (XWINDOW (root_window));
1720 if (root_height - delta < 1)
1722 delta = root_height - 1;
1723 nlines = FRAME_TOOL_BAR_LINES (f) + delta;
1726 FRAME_TOOL_BAR_LINES (f) = nlines;
1727 change_window_heights (root_window, delta);
1728 adjust_glyphs (f);
1730 /* We also have to make sure that the internal border at the top of
1731 the frame, below the menu bar or tool bar, is redrawn when the
1732 tool bar disappears. This is so because the internal border is
1733 below the tool bar if one is displayed, but is below the menu bar
1734 if there isn't a tool bar. The tool bar draws into the area
1735 below the menu bar. */
1736 if (FRAME_W32_WINDOW (f) && FRAME_TOOL_BAR_LINES (f) == 0)
1738 clear_frame (f);
1739 clear_current_matrices (f);
1742 /* If the tool bar gets smaller, the internal border below it
1743 has to be cleared. It was formerly part of the display
1744 of the larger tool bar, and updating windows won't clear it. */
1745 if (delta < 0)
1747 int height = FRAME_INTERNAL_BORDER_WIDTH (f);
1748 int width = FRAME_PIXEL_WIDTH (f);
1749 int y = nlines * FRAME_LINE_HEIGHT (f);
1751 BLOCK_INPUT;
1753 HDC hdc = get_frame_dc (f);
1754 w32_clear_area (f, hdc, 0, y, width, height);
1755 release_frame_dc (f, hdc);
1757 UNBLOCK_INPUT;
1759 if (WINDOWP (f->tool_bar_window))
1760 clear_glyph_matrix (XWINDOW (f->tool_bar_window)->current_matrix);
1765 /* Change the name of frame F to NAME. If NAME is nil, set F's name to
1766 w32_id_name.
1768 If EXPLICIT is non-zero, that indicates that lisp code is setting the
1769 name; if NAME is a string, set F's name to NAME and set
1770 F->explicit_name; if NAME is Qnil, then clear F->explicit_name.
1772 If EXPLICIT is zero, that indicates that Emacs redisplay code is
1773 suggesting a new name, which lisp code should override; if
1774 F->explicit_name is set, ignore the new name; otherwise, set it. */
1776 void
1777 x_set_name (struct frame *f, Lisp_Object name, int explicit)
1779 /* Make sure that requests from lisp code override requests from
1780 Emacs redisplay code. */
1781 if (explicit)
1783 /* If we're switching from explicit to implicit, we had better
1784 update the mode lines and thereby update the title. */
1785 if (f->explicit_name && NILP (name))
1786 update_mode_lines = 1;
1788 f->explicit_name = ! NILP (name);
1790 else if (f->explicit_name)
1791 return;
1793 /* If NAME is nil, set the name to the w32_id_name. */
1794 if (NILP (name))
1796 /* Check for no change needed in this very common case
1797 before we do any consing. */
1798 if (!strcmp (FRAME_W32_DISPLAY_INFO (f)->w32_id_name,
1799 SDATA (f->name)))
1800 return;
1801 name = build_string (FRAME_W32_DISPLAY_INFO (f)->w32_id_name);
1803 else
1804 CHECK_STRING (name);
1806 /* Don't change the name if it's already NAME. */
1807 if (! NILP (Fstring_equal (name, f->name)))
1808 return;
1810 f->name = name;
1812 /* For setting the frame title, the title parameter should override
1813 the name parameter. */
1814 if (! NILP (f->title))
1815 name = f->title;
1817 if (FRAME_W32_WINDOW (f))
1819 if (STRING_MULTIBYTE (name))
1820 name = ENCODE_SYSTEM (name);
1822 BLOCK_INPUT;
1823 SetWindowText (FRAME_W32_WINDOW (f), SDATA (name));
1824 UNBLOCK_INPUT;
1828 /* This function should be called when the user's lisp code has
1829 specified a name for the frame; the name will override any set by the
1830 redisplay code. */
1831 void
1832 x_explicitly_set_name (FRAME_PTR f, Lisp_Object arg, Lisp_Object oldval)
1834 x_set_name (f, arg, 1);
1837 /* This function should be called by Emacs redisplay code to set the
1838 name; names set this way will never override names set by the user's
1839 lisp code. */
1840 void
1841 x_implicitly_set_name (FRAME_PTR f, Lisp_Object arg, Lisp_Object oldval)
1843 x_set_name (f, arg, 0);
1846 /* Change the title of frame F to NAME.
1847 If NAME is nil, use the frame name as the title. */
1849 void
1850 x_set_title (struct frame *f, Lisp_Object name, Lisp_Object old_name)
1852 /* Don't change the title if it's already NAME. */
1853 if (EQ (name, f->title))
1854 return;
1856 update_mode_lines = 1;
1858 f->title = name;
1860 if (NILP (name))
1861 name = f->name;
1863 if (FRAME_W32_WINDOW (f))
1865 if (STRING_MULTIBYTE (name))
1866 name = ENCODE_SYSTEM (name);
1868 BLOCK_INPUT;
1869 SetWindowText (FRAME_W32_WINDOW (f), SDATA (name));
1870 UNBLOCK_INPUT;
1874 void
1875 x_set_scroll_bar_default_width (struct frame *f)
1877 int wid = FRAME_COLUMN_WIDTH (f);
1879 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = GetSystemMetrics (SM_CXVSCROLL);
1880 FRAME_CONFIG_SCROLL_BAR_COLS (f) = (FRAME_CONFIG_SCROLL_BAR_WIDTH (f) +
1881 wid - 1) / wid;
1885 /* Subroutines for creating a frame. */
1887 Cursor
1888 w32_load_cursor (LPCTSTR name)
1890 /* Try first to load cursor from application resource. */
1891 Cursor cursor = LoadImage ((HINSTANCE) GetModuleHandle (NULL),
1892 name, IMAGE_CURSOR, 0, 0,
1893 LR_DEFAULTCOLOR | LR_DEFAULTSIZE | LR_SHARED);
1894 if (!cursor)
1896 /* Then try to load a shared predefined cursor. */
1897 cursor = LoadImage (NULL, name, IMAGE_CURSOR, 0, 0,
1898 LR_DEFAULTCOLOR | LR_DEFAULTSIZE | LR_SHARED);
1900 return cursor;
1903 static LRESULT CALLBACK w32_wnd_proc (HWND, UINT, WPARAM, LPARAM);
1905 static BOOL
1906 w32_init_class (HINSTANCE hinst)
1908 WNDCLASS wc;
1910 wc.style = CS_HREDRAW | CS_VREDRAW;
1911 wc.lpfnWndProc = (WNDPROC) w32_wnd_proc;
1912 wc.cbClsExtra = 0;
1913 wc.cbWndExtra = WND_EXTRA_BYTES;
1914 wc.hInstance = hinst;
1915 wc.hIcon = LoadIcon (hinst, EMACS_CLASS);
1916 wc.hCursor = w32_load_cursor (IDC_ARROW);
1917 wc.hbrBackground = NULL; /* GetStockObject (WHITE_BRUSH); */
1918 wc.lpszMenuName = NULL;
1919 wc.lpszClassName = EMACS_CLASS;
1921 return (RegisterClass (&wc));
1924 static HWND
1925 w32_createscrollbar (struct frame *f, struct scroll_bar * bar)
1927 return (CreateWindow ("SCROLLBAR", "", SBS_VERT | WS_CHILD | WS_VISIBLE,
1928 /* Position and size of scroll bar. */
1929 XINT (bar->left) + VERTICAL_SCROLL_BAR_WIDTH_TRIM,
1930 XINT (bar->top),
1931 XINT (bar->width) - VERTICAL_SCROLL_BAR_WIDTH_TRIM * 2,
1932 XINT (bar->height),
1933 FRAME_W32_WINDOW (f),
1934 NULL,
1935 hinst,
1936 NULL));
1939 static void
1940 w32_createwindow (struct frame *f)
1942 HWND hwnd;
1943 RECT rect;
1944 Lisp_Object top = Qunbound;
1945 Lisp_Object left = Qunbound;
1946 struct w32_display_info *dpyinfo = &one_w32_display_info;
1948 rect.left = rect.top = 0;
1949 rect.right = FRAME_PIXEL_WIDTH (f);
1950 rect.bottom = FRAME_PIXEL_HEIGHT (f);
1952 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
1953 FRAME_EXTERNAL_MENU_BAR (f));
1955 /* Do first time app init */
1957 if (!hprevinst)
1959 w32_init_class (hinst);
1962 if (f->size_hint_flags & USPosition || f->size_hint_flags & PPosition)
1964 XSETINT (left, f->left_pos);
1965 XSETINT (top, f->top_pos);
1967 else if (EQ (left, Qunbound) && EQ (top, Qunbound))
1969 /* When called with RES_TYPE_NUMBER, w32_get_arg will return zero
1970 for anything that is not a number and is not Qunbound. */
1971 left = x_get_arg (dpyinfo, Qnil, Qleft, "left", "Left", RES_TYPE_NUMBER);
1972 top = x_get_arg (dpyinfo, Qnil, Qtop, "top", "Top", RES_TYPE_NUMBER);
1975 FRAME_W32_WINDOW (f) = hwnd
1976 = CreateWindow (EMACS_CLASS,
1977 f->namebuf,
1978 f->output_data.w32->dwStyle | WS_CLIPCHILDREN,
1979 EQ (left, Qunbound) ? CW_USEDEFAULT : XINT (left),
1980 EQ (top, Qunbound) ? CW_USEDEFAULT : XINT (top),
1981 rect.right - rect.left,
1982 rect.bottom - rect.top,
1983 NULL,
1984 NULL,
1985 hinst,
1986 NULL);
1988 if (hwnd)
1990 SetWindowLong (hwnd, WND_FONTWIDTH_INDEX, FRAME_COLUMN_WIDTH (f));
1991 SetWindowLong (hwnd, WND_LINEHEIGHT_INDEX, FRAME_LINE_HEIGHT (f));
1992 SetWindowLong (hwnd, WND_BORDER_INDEX, FRAME_INTERNAL_BORDER_WIDTH (f));
1993 SetWindowLong (hwnd, WND_SCROLLBAR_INDEX, f->scroll_bar_actual_width);
1994 SetWindowLong (hwnd, WND_BACKGROUND_INDEX, FRAME_BACKGROUND_PIXEL (f));
1996 /* Enable drag-n-drop. */
1997 DragAcceptFiles (hwnd, TRUE);
1999 /* Do this to discard the default setting specified by our parent. */
2000 ShowWindow (hwnd, SW_HIDE);
2002 /* Update frame positions. */
2003 GetWindowRect (hwnd, &rect);
2004 f->left_pos = rect.left;
2005 f->top_pos = rect.top;
2009 static void
2010 my_post_msg (W32Msg * wmsg, HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
2012 wmsg->msg.hwnd = hwnd;
2013 wmsg->msg.message = msg;
2014 wmsg->msg.wParam = wParam;
2015 wmsg->msg.lParam = lParam;
2016 wmsg->msg.time = GetMessageTime ();
2018 post_msg (wmsg);
2021 /* GetKeyState and MapVirtualKey on Windows 95 do not actually distinguish
2022 between left and right keys as advertised. We test for this
2023 support dynamically, and set a flag when the support is absent. If
2024 absent, we keep track of the left and right control and alt keys
2025 ourselves. This is particularly necessary on keyboards that rely
2026 upon the AltGr key, which is represented as having the left control
2027 and right alt keys pressed. For these keyboards, we need to know
2028 when the left alt key has been pressed in addition to the AltGr key
2029 so that we can properly support M-AltGr-key sequences (such as M-@
2030 on Swedish keyboards). */
2032 #define EMACS_LCONTROL 0
2033 #define EMACS_RCONTROL 1
2034 #define EMACS_LMENU 2
2035 #define EMACS_RMENU 3
2037 static int modifiers[4];
2038 static int modifiers_recorded;
2039 static int modifier_key_support_tested;
2041 static void
2042 test_modifier_support (unsigned int wparam)
2044 unsigned int l, r;
2046 if (wparam != VK_CONTROL && wparam != VK_MENU)
2047 return;
2048 if (wparam == VK_CONTROL)
2050 l = VK_LCONTROL;
2051 r = VK_RCONTROL;
2053 else
2055 l = VK_LMENU;
2056 r = VK_RMENU;
2058 if (!(GetKeyState (l) & 0x8000) && !(GetKeyState (r) & 0x8000))
2059 modifiers_recorded = 1;
2060 else
2061 modifiers_recorded = 0;
2062 modifier_key_support_tested = 1;
2065 static void
2066 record_keydown (unsigned int wparam, unsigned int lparam)
2068 int i;
2070 if (!modifier_key_support_tested)
2071 test_modifier_support (wparam);
2073 if ((wparam != VK_CONTROL && wparam != VK_MENU) || !modifiers_recorded)
2074 return;
2076 if (wparam == VK_CONTROL)
2077 i = (lparam & 0x1000000) ? EMACS_RCONTROL : EMACS_LCONTROL;
2078 else
2079 i = (lparam & 0x1000000) ? EMACS_RMENU : EMACS_LMENU;
2081 modifiers[i] = 1;
2084 static void
2085 record_keyup (unsigned int wparam, unsigned int lparam)
2087 int i;
2089 if ((wparam != VK_CONTROL && wparam != VK_MENU) || !modifiers_recorded)
2090 return;
2092 if (wparam == VK_CONTROL)
2093 i = (lparam & 0x1000000) ? EMACS_RCONTROL : EMACS_LCONTROL;
2094 else
2095 i = (lparam & 0x1000000) ? EMACS_RMENU : EMACS_LMENU;
2097 modifiers[i] = 0;
2100 /* Emacs can lose focus while a modifier key has been pressed. When
2101 it regains focus, be conservative and clear all modifiers since
2102 we cannot reconstruct the left and right modifier state. */
2103 static void
2104 reset_modifiers (void)
2106 SHORT ctrl, alt;
2108 if (GetFocus () == NULL)
2109 /* Emacs doesn't have keyboard focus. Do nothing. */
2110 return;
2112 ctrl = GetAsyncKeyState (VK_CONTROL);
2113 alt = GetAsyncKeyState (VK_MENU);
2115 if (!(ctrl & 0x08000))
2116 /* Clear any recorded control modifier state. */
2117 modifiers[EMACS_RCONTROL] = modifiers[EMACS_LCONTROL] = 0;
2119 if (!(alt & 0x08000))
2120 /* Clear any recorded alt modifier state. */
2121 modifiers[EMACS_RMENU] = modifiers[EMACS_LMENU] = 0;
2123 /* Update the state of all modifier keys, because modifiers used in
2124 hot-key combinations can get stuck on if Emacs loses focus as a
2125 result of a hot-key being pressed. */
2127 BYTE keystate[256];
2129 #define CURRENT_STATE(key) ((GetAsyncKeyState (key) & 0x8000) >> 8)
2131 GetKeyboardState (keystate);
2132 keystate[VK_SHIFT] = CURRENT_STATE (VK_SHIFT);
2133 keystate[VK_CONTROL] = CURRENT_STATE (VK_CONTROL);
2134 keystate[VK_LCONTROL] = CURRENT_STATE (VK_LCONTROL);
2135 keystate[VK_RCONTROL] = CURRENT_STATE (VK_RCONTROL);
2136 keystate[VK_MENU] = CURRENT_STATE (VK_MENU);
2137 keystate[VK_LMENU] = CURRENT_STATE (VK_LMENU);
2138 keystate[VK_RMENU] = CURRENT_STATE (VK_RMENU);
2139 keystate[VK_LWIN] = CURRENT_STATE (VK_LWIN);
2140 keystate[VK_RWIN] = CURRENT_STATE (VK_RWIN);
2141 keystate[VK_APPS] = CURRENT_STATE (VK_APPS);
2142 SetKeyboardState (keystate);
2146 /* Synchronize modifier state with what is reported with the current
2147 keystroke. Even if we cannot distinguish between left and right
2148 modifier keys, we know that, if no modifiers are set, then neither
2149 the left or right modifier should be set. */
2150 static void
2151 sync_modifiers (void)
2153 if (!modifiers_recorded)
2154 return;
2156 if (!(GetKeyState (VK_CONTROL) & 0x8000))
2157 modifiers[EMACS_RCONTROL] = modifiers[EMACS_LCONTROL] = 0;
2159 if (!(GetKeyState (VK_MENU) & 0x8000))
2160 modifiers[EMACS_RMENU] = modifiers[EMACS_LMENU] = 0;
2163 static int
2164 modifier_set (int vkey)
2166 if (vkey == VK_CAPITAL || vkey == VK_SCROLL)
2167 return (GetKeyState (vkey) & 0x1);
2168 if (!modifiers_recorded)
2169 return (GetKeyState (vkey) & 0x8000);
2171 switch (vkey)
2173 case VK_LCONTROL:
2174 return modifiers[EMACS_LCONTROL];
2175 case VK_RCONTROL:
2176 return modifiers[EMACS_RCONTROL];
2177 case VK_LMENU:
2178 return modifiers[EMACS_LMENU];
2179 case VK_RMENU:
2180 return modifiers[EMACS_RMENU];
2182 return (GetKeyState (vkey) & 0x8000);
2185 /* Convert between the modifier bits W32 uses and the modifier bits
2186 Emacs uses. */
2188 unsigned int
2189 w32_key_to_modifier (int key)
2191 Lisp_Object key_mapping;
2193 switch (key)
2195 case VK_LWIN:
2196 key_mapping = Vw32_lwindow_modifier;
2197 break;
2198 case VK_RWIN:
2199 key_mapping = Vw32_rwindow_modifier;
2200 break;
2201 case VK_APPS:
2202 key_mapping = Vw32_apps_modifier;
2203 break;
2204 case VK_SCROLL:
2205 key_mapping = Vw32_scroll_lock_modifier;
2206 break;
2207 default:
2208 key_mapping = Qnil;
2211 /* NB. This code runs in the input thread, asychronously to the lisp
2212 thread, so we must be careful to ensure access to lisp data is
2213 thread-safe. The following code is safe because the modifier
2214 variable values are updated atomically from lisp and symbols are
2215 not relocated by GC. Also, we don't have to worry about seeing GC
2216 markbits here. */
2217 if (EQ (key_mapping, Qhyper))
2218 return hyper_modifier;
2219 if (EQ (key_mapping, Qsuper))
2220 return super_modifier;
2221 if (EQ (key_mapping, Qmeta))
2222 return meta_modifier;
2223 if (EQ (key_mapping, Qalt))
2224 return alt_modifier;
2225 if (EQ (key_mapping, Qctrl))
2226 return ctrl_modifier;
2227 if (EQ (key_mapping, Qcontrol)) /* synonym for ctrl */
2228 return ctrl_modifier;
2229 if (EQ (key_mapping, Qshift))
2230 return shift_modifier;
2232 /* Don't generate any modifier if not explicitly requested. */
2233 return 0;
2236 static unsigned int
2237 w32_get_modifiers (void)
2239 return ((modifier_set (VK_SHIFT) ? shift_modifier : 0) |
2240 (modifier_set (VK_CONTROL) ? ctrl_modifier : 0) |
2241 (modifier_set (VK_LWIN) ? w32_key_to_modifier (VK_LWIN) : 0) |
2242 (modifier_set (VK_RWIN) ? w32_key_to_modifier (VK_RWIN) : 0) |
2243 (modifier_set (VK_APPS) ? w32_key_to_modifier (VK_APPS) : 0) |
2244 (modifier_set (VK_SCROLL) ? w32_key_to_modifier (VK_SCROLL) : 0) |
2245 (modifier_set (VK_MENU) ?
2246 ((NILP (Vw32_alt_is_meta)) ? alt_modifier : meta_modifier) : 0));
2249 /* We map the VK_* modifiers into console modifier constants
2250 so that we can use the same routines to handle both console
2251 and window input. */
2253 static int
2254 construct_console_modifiers (void)
2256 int mods;
2258 mods = 0;
2259 mods |= (modifier_set (VK_SHIFT)) ? SHIFT_PRESSED : 0;
2260 mods |= (modifier_set (VK_CAPITAL)) ? CAPSLOCK_ON : 0;
2261 mods |= (modifier_set (VK_SCROLL)) ? SCROLLLOCK_ON : 0;
2262 mods |= (modifier_set (VK_NUMLOCK)) ? NUMLOCK_ON : 0;
2263 mods |= (modifier_set (VK_LCONTROL)) ? LEFT_CTRL_PRESSED : 0;
2264 mods |= (modifier_set (VK_RCONTROL)) ? RIGHT_CTRL_PRESSED : 0;
2265 mods |= (modifier_set (VK_LMENU)) ? LEFT_ALT_PRESSED : 0;
2266 mods |= (modifier_set (VK_RMENU)) ? RIGHT_ALT_PRESSED : 0;
2267 mods |= (modifier_set (VK_LWIN)) ? LEFT_WIN_PRESSED : 0;
2268 mods |= (modifier_set (VK_RWIN)) ? RIGHT_WIN_PRESSED : 0;
2269 mods |= (modifier_set (VK_APPS)) ? APPS_PRESSED : 0;
2271 return mods;
2274 static int
2275 w32_get_key_modifiers (unsigned int wparam, unsigned int lparam)
2277 int mods;
2279 /* Convert to emacs modifiers. */
2280 mods = w32_kbd_mods_to_emacs (construct_console_modifiers (), wparam);
2282 return mods;
2285 unsigned int
2286 map_keypad_keys (unsigned int virt_key, unsigned int extended)
2288 if (virt_key < VK_CLEAR || virt_key > VK_DELETE)
2289 return virt_key;
2291 if (virt_key == VK_RETURN)
2292 return (extended ? VK_NUMPAD_ENTER : VK_RETURN);
2294 if (virt_key >= VK_PRIOR && virt_key <= VK_DOWN)
2295 return (!extended ? (VK_NUMPAD_PRIOR + (virt_key - VK_PRIOR)) : virt_key);
2297 if (virt_key == VK_INSERT || virt_key == VK_DELETE)
2298 return (!extended ? (VK_NUMPAD_INSERT + (virt_key - VK_INSERT)) : virt_key);
2300 if (virt_key == VK_CLEAR)
2301 return (!extended ? VK_NUMPAD_CLEAR : virt_key);
2303 return virt_key;
2306 /* List of special key combinations which w32 would normally capture,
2307 but Emacs should grab instead. Not directly visible to lisp, to
2308 simplify synchronization. Each item is an integer encoding a virtual
2309 key code and modifier combination to capture. */
2310 static Lisp_Object w32_grabbed_keys;
2312 #define HOTKEY(vk, mods) make_number (((vk) & 255) | ((mods) << 8))
2313 #define HOTKEY_ID(k) (XFASTINT (k) & 0xbfff)
2314 #define HOTKEY_VK_CODE(k) (XFASTINT (k) & 255)
2315 #define HOTKEY_MODIFIERS(k) (XFASTINT (k) >> 8)
2317 #define RAW_HOTKEY_ID(k) ((k) & 0xbfff)
2318 #define RAW_HOTKEY_VK_CODE(k) ((k) & 255)
2319 #define RAW_HOTKEY_MODIFIERS(k) ((k) >> 8)
2321 /* Register hot-keys for reserved key combinations when Emacs has
2322 keyboard focus, since this is the only way Emacs can receive key
2323 combinations like Alt-Tab which are used by the system. */
2325 static void
2326 register_hot_keys (HWND hwnd)
2328 Lisp_Object keylist;
2330 /* Use CONSP, since we are called asynchronously. */
2331 for (keylist = w32_grabbed_keys; CONSP (keylist); keylist = XCDR (keylist))
2333 Lisp_Object key = XCAR (keylist);
2335 /* Deleted entries get set to nil. */
2336 if (!INTEGERP (key))
2337 continue;
2339 RegisterHotKey (hwnd, HOTKEY_ID (key),
2340 HOTKEY_MODIFIERS (key), HOTKEY_VK_CODE (key));
2344 static void
2345 unregister_hot_keys (HWND hwnd)
2347 Lisp_Object keylist;
2349 for (keylist = w32_grabbed_keys; CONSP (keylist); keylist = XCDR (keylist))
2351 Lisp_Object key = XCAR (keylist);
2353 if (!INTEGERP (key))
2354 continue;
2356 UnregisterHotKey (hwnd, HOTKEY_ID (key));
2360 /* Main message dispatch loop. */
2362 static void
2363 w32_msg_pump (deferred_msg * msg_buf)
2365 MSG msg;
2366 int result;
2367 HWND focus_window;
2369 msh_mousewheel = RegisterWindowMessage (MSH_MOUSEWHEEL);
2371 while (GetMessage (&msg, NULL, 0, 0))
2373 if (msg.hwnd == NULL)
2375 switch (msg.message)
2377 case WM_NULL:
2378 /* Produced by complete_deferred_msg; just ignore. */
2379 break;
2380 case WM_EMACS_CREATEWINDOW:
2381 /* Initialize COM for this window. Even though we don't use it,
2382 some third party shell extensions can cause it to be used in
2383 system dialogs, which causes a crash if it is not initialized.
2384 This is a known bug in Windows, which was fixed long ago, but
2385 the patch for XP is not publically available until XP SP3,
2386 and older versions will never be patched. */
2387 CoInitialize (NULL);
2388 w32_createwindow ((struct frame *) msg.wParam);
2389 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
2390 abort ();
2391 break;
2392 case WM_EMACS_SETLOCALE:
2393 SetThreadLocale (msg.wParam);
2394 /* Reply is not expected. */
2395 break;
2396 case WM_EMACS_SETKEYBOARDLAYOUT:
2397 result = (int) ActivateKeyboardLayout ((HKL) msg.wParam, 0);
2398 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE,
2399 result, 0))
2400 abort ();
2401 break;
2402 case WM_EMACS_REGISTER_HOT_KEY:
2403 focus_window = GetFocus ();
2404 if (focus_window != NULL)
2405 RegisterHotKey (focus_window,
2406 RAW_HOTKEY_ID (msg.wParam),
2407 RAW_HOTKEY_MODIFIERS (msg.wParam),
2408 RAW_HOTKEY_VK_CODE (msg.wParam));
2409 /* Reply is not expected. */
2410 break;
2411 case WM_EMACS_UNREGISTER_HOT_KEY:
2412 focus_window = GetFocus ();
2413 if (focus_window != NULL)
2414 UnregisterHotKey (focus_window, RAW_HOTKEY_ID (msg.wParam));
2415 /* Mark item as erased. NB: this code must be
2416 thread-safe. The next line is okay because the cons
2417 cell is never made into garbage and is not relocated by
2418 GC. */
2419 XSETCAR ((Lisp_Object) ((EMACS_INT) msg.lParam), Qnil);
2420 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
2421 abort ();
2422 break;
2423 case WM_EMACS_TOGGLE_LOCK_KEY:
2425 int vk_code = (int) msg.wParam;
2426 int cur_state = (GetKeyState (vk_code) & 1);
2427 Lisp_Object new_state = (Lisp_Object) ((EMACS_INT) msg.lParam);
2429 /* NB: This code must be thread-safe. It is safe to
2430 call NILP because symbols are not relocated by GC,
2431 and pointer here is not touched by GC (so the markbit
2432 can't be set). Numbers are safe because they are
2433 immediate values. */
2434 if (NILP (new_state)
2435 || (NUMBERP (new_state)
2436 && ((XUINT (new_state)) & 1) != cur_state))
2438 one_w32_display_info.faked_key = vk_code;
2440 keybd_event ((BYTE) vk_code,
2441 (BYTE) MapVirtualKey (vk_code, 0),
2442 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
2443 keybd_event ((BYTE) vk_code,
2444 (BYTE) MapVirtualKey (vk_code, 0),
2445 KEYEVENTF_EXTENDEDKEY | 0, 0);
2446 keybd_event ((BYTE) vk_code,
2447 (BYTE) MapVirtualKey (vk_code, 0),
2448 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
2449 cur_state = !cur_state;
2451 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE,
2452 cur_state, 0))
2453 abort ();
2455 break;
2456 #ifdef MSG_DEBUG
2457 /* Broadcast messages make it here, so you need to be looking
2458 for something in particular for this to be useful. */
2459 default:
2460 DebPrint (("msg %x not expected by w32_msg_pump\n", msg.message));
2461 #endif
2464 else
2466 DispatchMessage (&msg);
2469 /* Exit nested loop when our deferred message has completed. */
2470 if (msg_buf->completed)
2471 break;
2475 deferred_msg * deferred_msg_head;
2477 static deferred_msg *
2478 find_deferred_msg (HWND hwnd, UINT msg)
2480 deferred_msg * item;
2482 /* Don't actually need synchronization for read access, since
2483 modification of single pointer is always atomic. */
2484 /* enter_crit (); */
2486 for (item = deferred_msg_head; item != NULL; item = item->next)
2487 if (item->w32msg.msg.hwnd == hwnd
2488 && item->w32msg.msg.message == msg)
2489 break;
2491 /* leave_crit (); */
2493 return item;
2496 static LRESULT
2497 send_deferred_msg (deferred_msg * msg_buf,
2498 HWND hwnd,
2499 UINT msg,
2500 WPARAM wParam,
2501 LPARAM lParam)
2503 /* Only input thread can send deferred messages. */
2504 if (GetCurrentThreadId () != dwWindowsThreadId)
2505 abort ();
2507 /* It is an error to send a message that is already deferred. */
2508 if (find_deferred_msg (hwnd, msg) != NULL)
2509 abort ();
2511 /* Enforced synchronization is not needed because this is the only
2512 function that alters deferred_msg_head, and the following critical
2513 section is guaranteed to only be serially reentered (since only the
2514 input thread can call us). */
2516 /* enter_crit (); */
2518 msg_buf->completed = 0;
2519 msg_buf->next = deferred_msg_head;
2520 deferred_msg_head = msg_buf;
2521 my_post_msg (&msg_buf->w32msg, hwnd, msg, wParam, lParam);
2523 /* leave_crit (); */
2525 /* Start a new nested message loop to process other messages until
2526 this one is completed. */
2527 w32_msg_pump (msg_buf);
2529 deferred_msg_head = msg_buf->next;
2531 return msg_buf->result;
2534 void
2535 complete_deferred_msg (HWND hwnd, UINT msg, LRESULT result)
2537 deferred_msg * msg_buf = find_deferred_msg (hwnd, msg);
2539 if (msg_buf == NULL)
2540 /* Message may have been cancelled, so don't abort. */
2541 return;
2543 msg_buf->result = result;
2544 msg_buf->completed = 1;
2546 /* Ensure input thread is woken so it notices the completion. */
2547 PostThreadMessage (dwWindowsThreadId, WM_NULL, 0, 0);
2550 static void
2551 cancel_all_deferred_msgs (void)
2553 deferred_msg * item;
2555 /* Don't actually need synchronization for read access, since
2556 modification of single pointer is always atomic. */
2557 /* enter_crit (); */
2559 for (item = deferred_msg_head; item != NULL; item = item->next)
2561 item->result = 0;
2562 item->completed = 1;
2565 /* leave_crit (); */
2567 /* Ensure input thread is woken so it notices the completion. */
2568 PostThreadMessage (dwWindowsThreadId, WM_NULL, 0, 0);
2571 DWORD WINAPI
2572 w32_msg_worker (void *arg)
2574 MSG msg;
2575 deferred_msg dummy_buf;
2577 /* Ensure our message queue is created */
2579 PeekMessage (&msg, NULL, 0, 0, PM_NOREMOVE);
2581 if (!PostThreadMessage (dwMainThreadId, WM_EMACS_DONE, 0, 0))
2582 abort ();
2584 memset (&dummy_buf, 0, sizeof (dummy_buf));
2585 dummy_buf.w32msg.msg.hwnd = NULL;
2586 dummy_buf.w32msg.msg.message = WM_NULL;
2588 /* This is the initial message loop which should only exit when the
2589 application quits. */
2590 w32_msg_pump (&dummy_buf);
2592 return 0;
2595 static void
2596 signal_user_input (void)
2598 /* Interrupt any lisp that wants to be interrupted by input. */
2599 if (!NILP (Vthrow_on_input))
2601 Vquit_flag = Vthrow_on_input;
2602 /* If we're inside a function that wants immediate quits,
2603 do it now. */
2604 if (immediate_quit && NILP (Vinhibit_quit))
2606 immediate_quit = 0;
2607 QUIT;
2613 static void
2614 post_character_message (HWND hwnd, UINT msg,
2615 WPARAM wParam, LPARAM lParam,
2616 DWORD modifiers)
2618 W32Msg wmsg;
2620 wmsg.dwModifiers = modifiers;
2622 /* Detect quit_char and set quit-flag directly. Note that we
2623 still need to post a message to ensure the main thread will be
2624 woken up if blocked in sys_select, but we do NOT want to post
2625 the quit_char message itself (because it will usually be as if
2626 the user had typed quit_char twice). Instead, we post a dummy
2627 message that has no particular effect. */
2629 int c = wParam;
2630 if (isalpha (c) && wmsg.dwModifiers == ctrl_modifier)
2631 c = make_ctrl_char (c) & 0377;
2632 if (c == quit_char
2633 || (wmsg.dwModifiers == 0 &&
2634 w32_quit_key && wParam == w32_quit_key))
2636 Vquit_flag = Qt;
2638 /* The choice of message is somewhat arbitrary, as long as
2639 the main thread handler just ignores it. */
2640 msg = WM_NULL;
2642 /* Interrupt any blocking system calls. */
2643 signal_quit ();
2645 /* As a safety precaution, forcibly complete any deferred
2646 messages. This is a kludge, but I don't see any particularly
2647 clean way to handle the situation where a deferred message is
2648 "dropped" in the lisp thread, and will thus never be
2649 completed, eg. by the user trying to activate the menubar
2650 when the lisp thread is busy, and then typing C-g when the
2651 menubar doesn't open promptly (with the result that the
2652 menubar never responds at all because the deferred
2653 WM_INITMENU message is never completed). Another problem
2654 situation is when the lisp thread calls SendMessage (to send
2655 a window manager command) when a message has been deferred;
2656 the lisp thread gets blocked indefinitely waiting for the
2657 deferred message to be completed, which itself is waiting for
2658 the lisp thread to respond.
2660 Note that we don't want to block the input thread waiting for
2661 a reponse from the lisp thread (although that would at least
2662 solve the deadlock problem above), because we want to be able
2663 to receive C-g to interrupt the lisp thread. */
2664 cancel_all_deferred_msgs ();
2666 else
2667 signal_user_input ();
2670 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2673 /* Main window procedure */
2675 static LRESULT CALLBACK
2676 w32_wnd_proc (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
2678 struct frame *f;
2679 struct w32_display_info *dpyinfo = &one_w32_display_info;
2680 W32Msg wmsg;
2681 int windows_translate;
2682 int key;
2684 /* Note that it is okay to call x_window_to_frame, even though we are
2685 not running in the main lisp thread, because frame deletion
2686 requires the lisp thread to synchronize with this thread. Thus, if
2687 a frame struct is returned, it can be used without concern that the
2688 lisp thread might make it disappear while we are using it.
2690 NB. Walking the frame list in this thread is safe (as long as
2691 writes of Lisp_Object slots are atomic, which they are on Windows).
2692 Although delete-frame can destructively modify the frame list while
2693 we are walking it, a garbage collection cannot occur until after
2694 delete-frame has synchronized with this thread.
2696 It is also safe to use functions that make GDI calls, such as
2697 w32_clear_rect, because these functions must obtain a DC handle
2698 from the frame struct using get_frame_dc which is thread-aware. */
2700 switch (msg)
2702 case WM_ERASEBKGND:
2703 f = x_window_to_frame (dpyinfo, hwnd);
2704 if (f)
2706 HDC hdc = get_frame_dc (f);
2707 GetUpdateRect (hwnd, &wmsg.rect, FALSE);
2708 w32_clear_rect (f, hdc, &wmsg.rect);
2709 release_frame_dc (f, hdc);
2711 #if defined (W32_DEBUG_DISPLAY)
2712 DebPrint (("WM_ERASEBKGND (frame %p): erasing %d,%d-%d,%d\n",
2714 wmsg.rect.left, wmsg.rect.top,
2715 wmsg.rect.right, wmsg.rect.bottom));
2716 #endif /* W32_DEBUG_DISPLAY */
2718 return 1;
2719 case WM_PALETTECHANGED:
2720 /* ignore our own changes */
2721 if ((HWND)wParam != hwnd)
2723 f = x_window_to_frame (dpyinfo, hwnd);
2724 if (f)
2725 /* get_frame_dc will realize our palette and force all
2726 frames to be redrawn if needed. */
2727 release_frame_dc (f, get_frame_dc (f));
2729 return 0;
2730 case WM_PAINT:
2732 PAINTSTRUCT paintStruct;
2733 RECT update_rect;
2734 memset (&update_rect, 0, sizeof (update_rect));
2736 f = x_window_to_frame (dpyinfo, hwnd);
2737 if (f == 0)
2739 DebPrint (("WM_PAINT received for unknown window %p\n", hwnd));
2740 return 0;
2743 /* MSDN Docs say not to call BeginPaint if GetUpdateRect
2744 fails. Apparently this can happen under some
2745 circumstances. */
2746 if (GetUpdateRect (hwnd, &update_rect, FALSE) || !w32_strict_painting)
2748 enter_crit ();
2749 BeginPaint (hwnd, &paintStruct);
2751 /* The rectangles returned by GetUpdateRect and BeginPaint
2752 do not always match. Play it safe by assuming both areas
2753 are invalid. */
2754 UnionRect (&(wmsg.rect), &update_rect, &(paintStruct.rcPaint));
2756 #if defined (W32_DEBUG_DISPLAY)
2757 DebPrint (("WM_PAINT (frame %p): painting %d,%d-%d,%d\n",
2759 wmsg.rect.left, wmsg.rect.top,
2760 wmsg.rect.right, wmsg.rect.bottom));
2761 DebPrint ((" [update region is %d,%d-%d,%d]\n",
2762 update_rect.left, update_rect.top,
2763 update_rect.right, update_rect.bottom));
2764 #endif
2765 EndPaint (hwnd, &paintStruct);
2766 leave_crit ();
2768 /* Change the message type to prevent Windows from
2769 combining WM_PAINT messages in the Lisp thread's queue,
2770 since Windows assumes that each message queue is
2771 dedicated to one frame and does not bother checking
2772 that hwnd matches before combining them. */
2773 my_post_msg (&wmsg, hwnd, WM_EMACS_PAINT, wParam, lParam);
2775 return 0;
2778 /* If GetUpdateRect returns 0 (meaning there is no update
2779 region), assume the whole window needs to be repainted. */
2780 GetClientRect (hwnd, &wmsg.rect);
2781 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2782 return 0;
2785 case WM_INPUTLANGCHANGE:
2786 /* Inform lisp thread of keyboard layout changes. */
2787 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
2789 /* Clear dead keys in the keyboard state; for simplicity only
2790 preserve modifier key states. */
2792 int i;
2793 BYTE keystate[256];
2795 GetKeyboardState (keystate);
2796 for (i = 0; i < 256; i++)
2797 if (1
2798 && i != VK_SHIFT
2799 && i != VK_LSHIFT
2800 && i != VK_RSHIFT
2801 && i != VK_CAPITAL
2802 && i != VK_NUMLOCK
2803 && i != VK_SCROLL
2804 && i != VK_CONTROL
2805 && i != VK_LCONTROL
2806 && i != VK_RCONTROL
2807 && i != VK_MENU
2808 && i != VK_LMENU
2809 && i != VK_RMENU
2810 && i != VK_LWIN
2811 && i != VK_RWIN)
2812 keystate[i] = 0;
2813 SetKeyboardState (keystate);
2815 goto dflt;
2817 case WM_HOTKEY:
2818 /* Synchronize hot keys with normal input. */
2819 PostMessage (hwnd, WM_KEYDOWN, HIWORD (lParam), 0);
2820 return (0);
2822 case WM_KEYUP:
2823 case WM_SYSKEYUP:
2824 record_keyup (wParam, lParam);
2825 goto dflt;
2827 case WM_KEYDOWN:
2828 case WM_SYSKEYDOWN:
2829 /* Ignore keystrokes we fake ourself; see below. */
2830 if (dpyinfo->faked_key == wParam)
2832 dpyinfo->faked_key = 0;
2833 /* Make sure TranslateMessage sees them though (as long as
2834 they don't produce WM_CHAR messages). This ensures that
2835 indicator lights are toggled promptly on Windows 9x, for
2836 example. */
2837 if (wParam < 256 && lispy_function_keys[wParam])
2839 windows_translate = 1;
2840 goto translate;
2842 return 0;
2845 /* Synchronize modifiers with current keystroke. */
2846 sync_modifiers ();
2847 record_keydown (wParam, lParam);
2848 wParam = map_keypad_keys (wParam, (lParam & 0x1000000L) != 0);
2850 windows_translate = 0;
2852 switch (wParam)
2854 case VK_LWIN:
2855 if (NILP (Vw32_pass_lwindow_to_system))
2857 /* Prevent system from acting on keyup (which opens the
2858 Start menu if no other key was pressed) by simulating a
2859 press of Space which we will ignore. */
2860 if (GetAsyncKeyState (wParam) & 1)
2862 if (NUMBERP (Vw32_phantom_key_code))
2863 key = XUINT (Vw32_phantom_key_code) & 255;
2864 else
2865 key = VK_SPACE;
2866 dpyinfo->faked_key = key;
2867 keybd_event (key, (BYTE) MapVirtualKey (key, 0), 0, 0);
2870 if (!NILP (Vw32_lwindow_modifier))
2871 return 0;
2872 break;
2873 case VK_RWIN:
2874 if (NILP (Vw32_pass_rwindow_to_system))
2876 if (GetAsyncKeyState (wParam) & 1)
2878 if (NUMBERP (Vw32_phantom_key_code))
2879 key = XUINT (Vw32_phantom_key_code) & 255;
2880 else
2881 key = VK_SPACE;
2882 dpyinfo->faked_key = key;
2883 keybd_event (key, (BYTE) MapVirtualKey (key, 0), 0, 0);
2886 if (!NILP (Vw32_rwindow_modifier))
2887 return 0;
2888 break;
2889 case VK_APPS:
2890 if (!NILP (Vw32_apps_modifier))
2891 return 0;
2892 break;
2893 case VK_MENU:
2894 if (NILP (Vw32_pass_alt_to_system))
2895 /* Prevent DefWindowProc from activating the menu bar if an
2896 Alt key is pressed and released by itself. */
2897 return 0;
2898 windows_translate = 1;
2899 break;
2900 case VK_CAPITAL:
2901 /* Decide whether to treat as modifier or function key. */
2902 if (NILP (Vw32_enable_caps_lock))
2903 goto disable_lock_key;
2904 windows_translate = 1;
2905 break;
2906 case VK_NUMLOCK:
2907 /* Decide whether to treat as modifier or function key. */
2908 if (NILP (Vw32_enable_num_lock))
2909 goto disable_lock_key;
2910 windows_translate = 1;
2911 break;
2912 case VK_SCROLL:
2913 /* Decide whether to treat as modifier or function key. */
2914 if (NILP (Vw32_scroll_lock_modifier))
2915 goto disable_lock_key;
2916 windows_translate = 1;
2917 break;
2918 disable_lock_key:
2919 /* Ensure the appropriate lock key state (and indicator light)
2920 remains in the same state. We do this by faking another
2921 press of the relevant key. Apparently, this really is the
2922 only way to toggle the state of the indicator lights. */
2923 dpyinfo->faked_key = wParam;
2924 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
2925 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
2926 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
2927 KEYEVENTF_EXTENDEDKEY | 0, 0);
2928 keybd_event ((BYTE) wParam, (BYTE) MapVirtualKey (wParam, 0),
2929 KEYEVENTF_EXTENDEDKEY | KEYEVENTF_KEYUP, 0);
2930 /* Ensure indicator lights are updated promptly on Windows 9x
2931 (TranslateMessage apparently does this), after forwarding
2932 input event. */
2933 post_character_message (hwnd, msg, wParam, lParam,
2934 w32_get_key_modifiers (wParam, lParam));
2935 windows_translate = 1;
2936 break;
2937 case VK_CONTROL:
2938 case VK_SHIFT:
2939 case VK_PROCESSKEY: /* Generated by IME. */
2940 windows_translate = 1;
2941 break;
2942 case VK_CANCEL:
2943 /* Windows maps Ctrl-Pause (aka Ctrl-Break) into VK_CANCEL,
2944 which is confusing for purposes of key binding; convert
2945 VK_CANCEL events into VK_PAUSE events. */
2946 wParam = VK_PAUSE;
2947 break;
2948 case VK_PAUSE:
2949 /* Windows maps Ctrl-NumLock into VK_PAUSE, which is confusing
2950 for purposes of key binding; convert these back into
2951 VK_NUMLOCK events, at least when we want to see NumLock key
2952 presses. (Note that there is never any possibility that
2953 VK_PAUSE with Ctrl really is C-Pause as per above.) */
2954 if (NILP (Vw32_enable_num_lock) && modifier_set (VK_CONTROL))
2955 wParam = VK_NUMLOCK;
2956 break;
2957 default:
2958 /* If not defined as a function key, change it to a WM_CHAR message. */
2959 if (wParam > 255 || !lispy_function_keys[wParam])
2961 DWORD modifiers = construct_console_modifiers ();
2963 if (!NILP (Vw32_recognize_altgr)
2964 && modifier_set (VK_LCONTROL) && modifier_set (VK_RMENU))
2966 /* Always let TranslateMessage handle AltGr key chords;
2967 for some reason, ToAscii doesn't always process AltGr
2968 chords correctly. */
2969 windows_translate = 1;
2971 else if ((modifiers & (~SHIFT_PRESSED & ~CAPSLOCK_ON)) != 0)
2973 /* Handle key chords including any modifiers other
2974 than shift directly, in order to preserve as much
2975 modifier information as possible. */
2976 if ('A' <= wParam && wParam <= 'Z')
2978 /* Don't translate modified alphabetic keystrokes,
2979 so the user doesn't need to constantly switch
2980 layout to type control or meta keystrokes when
2981 the normal layout translates alphabetic
2982 characters to non-ascii characters. */
2983 if (!modifier_set (VK_SHIFT))
2984 wParam += ('a' - 'A');
2985 msg = WM_CHAR;
2987 else
2989 /* Try to handle other keystrokes by determining the
2990 base character (ie. translating the base key plus
2991 shift modifier). */
2992 int add;
2993 int isdead = 0;
2994 KEY_EVENT_RECORD key;
2996 key.bKeyDown = TRUE;
2997 key.wRepeatCount = 1;
2998 key.wVirtualKeyCode = wParam;
2999 key.wVirtualScanCode = (lParam & 0xFF0000) >> 16;
3000 key.uChar.AsciiChar = 0;
3001 key.dwControlKeyState = modifiers;
3003 add = w32_kbd_patch_key (&key);
3004 /* 0 means an unrecognised keycode, negative means
3005 dead key. Ignore both. */
3006 while (--add >= 0)
3008 /* Forward asciified character sequence. */
3009 post_character_message
3010 (hwnd, WM_CHAR,
3011 (unsigned char) key.uChar.AsciiChar, lParam,
3012 w32_get_key_modifiers (wParam, lParam));
3013 w32_kbd_patch_key (&key);
3015 return 0;
3018 else
3020 /* Let TranslateMessage handle everything else. */
3021 windows_translate = 1;
3026 translate:
3027 if (windows_translate)
3029 MSG windows_msg = { hwnd, msg, wParam, lParam, 0, {0,0} };
3030 windows_msg.time = GetMessageTime ();
3031 TranslateMessage (&windows_msg);
3032 goto dflt;
3035 /* Fall through */
3037 case WM_SYSCHAR:
3038 case WM_CHAR:
3039 post_character_message (hwnd, msg, wParam, lParam,
3040 w32_get_key_modifiers (wParam, lParam));
3041 break;
3043 case WM_UNICHAR:
3044 /* WM_UNICHAR looks promising from the docs, but the exact
3045 circumstances in which TranslateMessage sends it is one of those
3046 Microsoft secret API things that EU and US courts are supposed
3047 to have put a stop to already. Spy++ shows it being sent to Notepad
3048 and other MS apps, but never to Emacs.
3050 Some third party IMEs send it in accordance with the official
3051 documentation though, so handle it here.
3053 UNICODE_NOCHAR is used to test for support for this message.
3054 TRUE indicates that the message is supported. */
3055 if (wParam == UNICODE_NOCHAR)
3056 return TRUE;
3059 W32Msg wmsg;
3060 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3061 signal_user_input ();
3062 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3064 break;
3066 case WM_IME_CHAR:
3067 /* If we can't get the IME result as unicode, use default processing,
3068 which will at least allow characters decodable in the system locale
3069 get through. */
3070 if (!get_composition_string_fn)
3071 goto dflt;
3073 else if (!ignore_ime_char)
3075 wchar_t * buffer;
3076 int size, i;
3077 W32Msg wmsg;
3078 HIMC context = get_ime_context_fn (hwnd);
3079 wmsg.dwModifiers = w32_get_key_modifiers (wParam, lParam);
3080 /* Get buffer size. */
3081 size = get_composition_string_fn (context, GCS_RESULTSTR, buffer, 0);
3082 buffer = alloca (size);
3083 size = get_composition_string_fn (context, GCS_RESULTSTR,
3084 buffer, size);
3085 release_ime_context_fn (hwnd, context);
3087 signal_user_input ();
3088 for (i = 0; i < size / sizeof (wchar_t); i++)
3090 my_post_msg (&wmsg, hwnd, WM_UNICHAR, (WPARAM) buffer[i],
3091 lParam);
3093 /* Ignore the messages for the rest of the
3094 characters in the string that was output above. */
3095 ignore_ime_char = (size / sizeof (wchar_t)) - 1;
3097 else
3098 ignore_ime_char--;
3100 break;
3102 case WM_IME_STARTCOMPOSITION:
3103 if (!set_ime_composition_window_fn)
3104 goto dflt;
3105 else
3107 COMPOSITIONFORM form;
3108 HIMC context;
3109 struct window *w;
3111 f = x_window_to_frame (dpyinfo, hwnd);
3112 w = XWINDOW (FRAME_SELECTED_WINDOW (f));
3114 form.dwStyle = CFS_RECT;
3115 form.ptCurrentPos.x = w32_system_caret_x;
3116 form.ptCurrentPos.y = w32_system_caret_y;
3118 form.rcArea.left = WINDOW_TEXT_TO_FRAME_PIXEL_X (w, 0);
3119 form.rcArea.top = (WINDOW_TOP_EDGE_Y (w)
3120 + WINDOW_HEADER_LINE_HEIGHT (w));
3121 form.rcArea.right = (WINDOW_BOX_RIGHT_EDGE_X (w)
3122 - WINDOW_RIGHT_MARGIN_WIDTH (w)
3123 - WINDOW_RIGHT_FRINGE_WIDTH (w));
3124 form.rcArea.bottom = (WINDOW_BOTTOM_EDGE_Y (w)
3125 - WINDOW_MODE_LINE_HEIGHT (w));
3127 context = get_ime_context_fn (hwnd);
3129 if (!context)
3130 break;
3132 set_ime_composition_window_fn (context, &form);
3133 release_ime_context_fn (hwnd, context);
3135 break;
3137 case WM_IME_ENDCOMPOSITION:
3138 ignore_ime_char = 0;
3139 goto dflt;
3141 /* Simulate middle mouse button events when left and right buttons
3142 are used together, but only if user has two button mouse. */
3143 case WM_LBUTTONDOWN:
3144 case WM_RBUTTONDOWN:
3145 if (w32_num_mouse_buttons > 2)
3146 goto handle_plain_button;
3149 int this = (msg == WM_LBUTTONDOWN) ? LMOUSE : RMOUSE;
3150 int other = (msg == WM_LBUTTONDOWN) ? RMOUSE : LMOUSE;
3152 if (button_state & this)
3153 return 0;
3155 if (button_state == 0)
3156 SetCapture (hwnd);
3158 button_state |= this;
3160 if (button_state & other)
3162 if (mouse_button_timer)
3164 KillTimer (hwnd, mouse_button_timer);
3165 mouse_button_timer = 0;
3167 /* Generate middle mouse event instead. */
3168 msg = WM_MBUTTONDOWN;
3169 button_state |= MMOUSE;
3171 else if (button_state & MMOUSE)
3173 /* Ignore button event if we've already generated a
3174 middle mouse down event. This happens if the
3175 user releases and press one of the two buttons
3176 after we've faked a middle mouse event. */
3177 return 0;
3179 else
3181 /* Flush out saved message. */
3182 post_msg (&saved_mouse_button_msg);
3184 wmsg.dwModifiers = w32_get_modifiers ();
3185 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3186 signal_user_input ();
3188 /* Clear message buffer. */
3189 saved_mouse_button_msg.msg.hwnd = 0;
3191 else
3193 /* Hold onto message for now. */
3194 mouse_button_timer =
3195 SetTimer (hwnd, MOUSE_BUTTON_ID,
3196 w32_mouse_button_tolerance, NULL);
3197 saved_mouse_button_msg.msg.hwnd = hwnd;
3198 saved_mouse_button_msg.msg.message = msg;
3199 saved_mouse_button_msg.msg.wParam = wParam;
3200 saved_mouse_button_msg.msg.lParam = lParam;
3201 saved_mouse_button_msg.msg.time = GetMessageTime ();
3202 saved_mouse_button_msg.dwModifiers = w32_get_modifiers ();
3205 return 0;
3207 case WM_LBUTTONUP:
3208 case WM_RBUTTONUP:
3209 if (w32_num_mouse_buttons > 2)
3210 goto handle_plain_button;
3213 int this = (msg == WM_LBUTTONUP) ? LMOUSE : RMOUSE;
3214 int other = (msg == WM_LBUTTONUP) ? RMOUSE : LMOUSE;
3216 if ((button_state & this) == 0)
3217 return 0;
3219 button_state &= ~this;
3221 if (button_state & MMOUSE)
3223 /* Only generate event when second button is released. */
3224 if ((button_state & other) == 0)
3226 msg = WM_MBUTTONUP;
3227 button_state &= ~MMOUSE;
3229 if (button_state) abort ();
3231 else
3232 return 0;
3234 else
3236 /* Flush out saved message if necessary. */
3237 if (saved_mouse_button_msg.msg.hwnd)
3239 post_msg (&saved_mouse_button_msg);
3242 wmsg.dwModifiers = w32_get_modifiers ();
3243 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3244 signal_user_input ();
3246 /* Always clear message buffer and cancel timer. */
3247 saved_mouse_button_msg.msg.hwnd = 0;
3248 KillTimer (hwnd, mouse_button_timer);
3249 mouse_button_timer = 0;
3251 if (button_state == 0)
3252 ReleaseCapture ();
3254 return 0;
3256 case WM_XBUTTONDOWN:
3257 case WM_XBUTTONUP:
3258 if (w32_pass_extra_mouse_buttons_to_system)
3259 goto dflt;
3260 /* else fall through and process them. */
3261 case WM_MBUTTONDOWN:
3262 case WM_MBUTTONUP:
3263 handle_plain_button:
3265 BOOL up;
3266 int button;
3268 /* Ignore middle and extra buttons as long as the menu is active. */
3269 f = x_window_to_frame (dpyinfo, hwnd);
3270 if (f && f->output_data.w32->menubar_active)
3271 return 0;
3273 if (parse_button (msg, HIWORD (wParam), &button, &up))
3275 if (up) ReleaseCapture ();
3276 else SetCapture (hwnd);
3277 button = (button == 0) ? LMOUSE :
3278 ((button == 1) ? MMOUSE : RMOUSE);
3279 if (up)
3280 button_state &= ~button;
3281 else
3282 button_state |= button;
3286 wmsg.dwModifiers = w32_get_modifiers ();
3287 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3288 signal_user_input ();
3290 /* Need to return true for XBUTTON messages, false for others,
3291 to indicate that we processed the message. */
3292 return (msg == WM_XBUTTONDOWN || msg == WM_XBUTTONUP);
3294 case WM_MOUSEMOVE:
3295 /* Ignore mouse movements as long as the menu is active. These
3296 movements are processed by the window manager anyway, and
3297 it's wrong to handle them as if they happened on the
3298 underlying frame. */
3299 f = x_window_to_frame (dpyinfo, hwnd);
3300 if (f && f->output_data.w32->menubar_active)
3301 return 0;
3303 /* If the mouse has just moved into the frame, start tracking
3304 it, so we will be notified when it leaves the frame. Mouse
3305 tracking only works under W98 and NT4 and later. On earlier
3306 versions, there is no way of telling when the mouse leaves the
3307 frame, so we just have to put up with help-echo and mouse
3308 highlighting remaining while the frame is not active. */
3309 if (track_mouse_event_fn && !track_mouse_window)
3311 TRACKMOUSEEVENT tme;
3312 tme.cbSize = sizeof (tme);
3313 tme.dwFlags = TME_LEAVE;
3314 tme.hwndTrack = hwnd;
3316 track_mouse_event_fn (&tme);
3317 track_mouse_window = hwnd;
3319 case WM_VSCROLL:
3320 if (w32_mouse_move_interval <= 0
3321 || (msg == WM_MOUSEMOVE && button_state == 0))
3323 wmsg.dwModifiers = w32_get_modifiers ();
3324 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3325 return 0;
3328 /* Hang onto mouse move and scroll messages for a bit, to avoid
3329 sending such events to Emacs faster than it can process them.
3330 If we get more events before the timer from the first message
3331 expires, we just replace the first message. */
3333 if (saved_mouse_move_msg.msg.hwnd == 0)
3334 mouse_move_timer =
3335 SetTimer (hwnd, MOUSE_MOVE_ID,
3336 w32_mouse_move_interval, NULL);
3338 /* Hold onto message for now. */
3339 saved_mouse_move_msg.msg.hwnd = hwnd;
3340 saved_mouse_move_msg.msg.message = msg;
3341 saved_mouse_move_msg.msg.wParam = wParam;
3342 saved_mouse_move_msg.msg.lParam = lParam;
3343 saved_mouse_move_msg.msg.time = GetMessageTime ();
3344 saved_mouse_move_msg.dwModifiers = w32_get_modifiers ();
3346 return 0;
3348 case WM_MOUSEWHEEL:
3349 case WM_DROPFILES:
3350 wmsg.dwModifiers = w32_get_modifiers ();
3351 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3352 signal_user_input ();
3353 return 0;
3355 case WM_APPCOMMAND:
3356 if (w32_pass_multimedia_buttons_to_system)
3357 goto dflt;
3358 /* Otherwise, pass to lisp, the same way we do with mousehwheel. */
3359 case WM_MOUSEHWHEEL:
3360 wmsg.dwModifiers = w32_get_modifiers ();
3361 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3362 signal_user_input ();
3363 /* Non-zero must be returned when WM_MOUSEHWHEEL messages are
3364 handled, to prevent the system trying to handle it by faking
3365 scroll bar events. */
3366 return 1;
3368 case WM_TIMER:
3369 /* Flush out saved messages if necessary. */
3370 if (wParam == mouse_button_timer)
3372 if (saved_mouse_button_msg.msg.hwnd)
3374 post_msg (&saved_mouse_button_msg);
3375 signal_user_input ();
3376 saved_mouse_button_msg.msg.hwnd = 0;
3378 KillTimer (hwnd, mouse_button_timer);
3379 mouse_button_timer = 0;
3381 else if (wParam == mouse_move_timer)
3383 if (saved_mouse_move_msg.msg.hwnd)
3385 post_msg (&saved_mouse_move_msg);
3386 saved_mouse_move_msg.msg.hwnd = 0;
3388 KillTimer (hwnd, mouse_move_timer);
3389 mouse_move_timer = 0;
3391 else if (wParam == menu_free_timer)
3393 KillTimer (hwnd, menu_free_timer);
3394 menu_free_timer = 0;
3395 f = x_window_to_frame (dpyinfo, hwnd);
3396 /* If a popup menu is active, don't wipe its strings. */
3397 if (menubar_in_use
3398 && current_popup_menu == NULL)
3400 /* Free memory used by owner-drawn and help-echo strings. */
3401 w32_free_menu_strings (hwnd);
3402 f->output_data.w32->menubar_active = 0;
3403 menubar_in_use = 0;
3406 else if (wParam == hourglass_timer)
3408 KillTimer (hwnd, hourglass_timer);
3409 hourglass_timer = 0;
3410 w32_show_hourglass (x_window_to_frame (dpyinfo, hwnd));
3412 return 0;
3414 case WM_NCACTIVATE:
3415 /* Windows doesn't send us focus messages when putting up and
3416 taking down a system popup dialog as for Ctrl-Alt-Del on Windows 95.
3417 The only indication we get that something happened is receiving
3418 this message afterwards. So this is a good time to reset our
3419 keyboard modifiers' state. */
3420 reset_modifiers ();
3421 goto dflt;
3423 case WM_INITMENU:
3424 button_state = 0;
3425 ReleaseCapture ();
3426 /* We must ensure menu bar is fully constructed and up to date
3427 before allowing user interaction with it. To achieve this
3428 we send this message to the lisp thread and wait for a
3429 reply (whose value is not actually needed) to indicate that
3430 the menu bar is now ready for use, so we can now return.
3432 To remain responsive in the meantime, we enter a nested message
3433 loop that can process all other messages.
3435 However, we skip all this if the message results from calling
3436 TrackPopupMenu - in fact, we must NOT attempt to send the lisp
3437 thread a message because it is blocked on us at this point. We
3438 set menubar_active before calling TrackPopupMenu to indicate
3439 this (there is no possibility of confusion with real menubar
3440 being active). */
3442 f = x_window_to_frame (dpyinfo, hwnd);
3443 if (f
3444 && (f->output_data.w32->menubar_active
3445 /* We can receive this message even in the absence of a
3446 menubar (ie. when the system menu is activated) - in this
3447 case we do NOT want to forward the message, otherwise it
3448 will cause the menubar to suddenly appear when the user
3449 had requested it to be turned off! */
3450 || f->output_data.w32->menubar_widget == NULL))
3451 return 0;
3454 deferred_msg msg_buf;
3456 /* Detect if message has already been deferred; in this case
3457 we cannot return any sensible value to ignore this. */
3458 if (find_deferred_msg (hwnd, msg) != NULL)
3459 abort ();
3461 menubar_in_use = 1;
3463 return send_deferred_msg (&msg_buf, hwnd, msg, wParam, lParam);
3466 case WM_EXITMENULOOP:
3467 f = x_window_to_frame (dpyinfo, hwnd);
3469 /* If a menu is still active, check again after a short delay,
3470 since Windows often (always?) sends the WM_EXITMENULOOP
3471 before the corresponding WM_COMMAND message.
3472 Don't do this if a popup menu is active, since it is only
3473 menubar menus that require cleaning up in this way.
3475 if (f && menubar_in_use && current_popup_menu == NULL)
3476 menu_free_timer = SetTimer (hwnd, MENU_FREE_ID, MENU_FREE_DELAY, NULL);
3478 /* If hourglass cursor should be displayed, display it now. */
3479 if (f && f->output_data.w32->hourglass_p)
3480 SetCursor (f->output_data.w32->hourglass_cursor);
3482 goto dflt;
3484 case WM_MENUSELECT:
3485 /* Direct handling of help_echo in menus. Should be safe now
3486 that we generate the help_echo by placing a help event in the
3487 keyboard buffer. */
3489 HMENU menu = (HMENU) lParam;
3490 UINT menu_item = (UINT) LOWORD (wParam);
3491 UINT flags = (UINT) HIWORD (wParam);
3493 w32_menu_display_help (hwnd, menu, menu_item, flags);
3495 return 0;
3497 case WM_MEASUREITEM:
3498 f = x_window_to_frame (dpyinfo, hwnd);
3499 if (f)
3501 MEASUREITEMSTRUCT * pMis = (MEASUREITEMSTRUCT *) lParam;
3503 if (pMis->CtlType == ODT_MENU)
3505 /* Work out dimensions for popup menu titles. */
3506 char * title = (char *) pMis->itemData;
3507 HDC hdc = GetDC (hwnd);
3508 HFONT menu_font = GetCurrentObject (hdc, OBJ_FONT);
3509 LOGFONT menu_logfont;
3510 HFONT old_font;
3511 SIZE size;
3513 GetObject (menu_font, sizeof (menu_logfont), &menu_logfont);
3514 menu_logfont.lfWeight = FW_BOLD;
3515 menu_font = CreateFontIndirect (&menu_logfont);
3516 old_font = SelectObject (hdc, menu_font);
3518 pMis->itemHeight = GetSystemMetrics (SM_CYMENUSIZE);
3519 if (title)
3521 if (unicode_append_menu)
3522 GetTextExtentPoint32W (hdc, (WCHAR *) title,
3523 wcslen ((WCHAR *) title),
3524 &size);
3525 else
3526 GetTextExtentPoint32 (hdc, title, strlen (title), &size);
3528 pMis->itemWidth = size.cx;
3529 if (pMis->itemHeight < size.cy)
3530 pMis->itemHeight = size.cy;
3532 else
3533 pMis->itemWidth = 0;
3535 SelectObject (hdc, old_font);
3536 DeleteObject (menu_font);
3537 ReleaseDC (hwnd, hdc);
3538 return TRUE;
3541 return 0;
3543 case WM_DRAWITEM:
3544 f = x_window_to_frame (dpyinfo, hwnd);
3545 if (f)
3547 DRAWITEMSTRUCT * pDis = (DRAWITEMSTRUCT *) lParam;
3549 if (pDis->CtlType == ODT_MENU)
3551 /* Draw popup menu title. */
3552 char * title = (char *) pDis->itemData;
3553 if (title)
3555 HDC hdc = pDis->hDC;
3556 HFONT menu_font = GetCurrentObject (hdc, OBJ_FONT);
3557 LOGFONT menu_logfont;
3558 HFONT old_font;
3560 GetObject (menu_font, sizeof (menu_logfont), &menu_logfont);
3561 menu_logfont.lfWeight = FW_BOLD;
3562 menu_font = CreateFontIndirect (&menu_logfont);
3563 old_font = SelectObject (hdc, menu_font);
3565 /* Always draw title as if not selected. */
3566 if (unicode_append_menu)
3567 ExtTextOutW (hdc,
3568 pDis->rcItem.left
3569 + GetSystemMetrics (SM_CXMENUCHECK),
3570 pDis->rcItem.top,
3571 ETO_OPAQUE, &pDis->rcItem,
3572 (WCHAR *) title,
3573 wcslen ((WCHAR *) title), NULL);
3574 else
3575 ExtTextOut (hdc,
3576 pDis->rcItem.left
3577 + GetSystemMetrics (SM_CXMENUCHECK),
3578 pDis->rcItem.top,
3579 ETO_OPAQUE, &pDis->rcItem,
3580 title, strlen (title), NULL);
3582 SelectObject (hdc, old_font);
3583 DeleteObject (menu_font);
3585 return TRUE;
3588 return 0;
3590 #if 0
3591 /* Still not right - can't distinguish between clicks in the
3592 client area of the frame from clicks forwarded from the scroll
3593 bars - may have to hook WM_NCHITTEST to remember the mouse
3594 position and then check if it is in the client area ourselves. */
3595 case WM_MOUSEACTIVATE:
3596 /* Discard the mouse click that activates a frame, allowing the
3597 user to click anywhere without changing point (or worse!).
3598 Don't eat mouse clicks on scrollbars though!! */
3599 if (LOWORD (lParam) == HTCLIENT )
3600 return MA_ACTIVATEANDEAT;
3601 goto dflt;
3602 #endif
3604 case WM_MOUSELEAVE:
3605 /* No longer tracking mouse. */
3606 track_mouse_window = NULL;
3608 case WM_ACTIVATEAPP:
3609 case WM_ACTIVATE:
3610 case WM_WINDOWPOSCHANGED:
3611 case WM_SHOWWINDOW:
3612 /* Inform lisp thread that a frame might have just been obscured
3613 or exposed, so should recheck visibility of all frames. */
3614 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3615 goto dflt;
3617 case WM_SETFOCUS:
3618 dpyinfo->faked_key = 0;
3619 reset_modifiers ();
3620 register_hot_keys (hwnd);
3621 goto command;
3622 case WM_KILLFOCUS:
3623 unregister_hot_keys (hwnd);
3624 button_state = 0;
3625 ReleaseCapture ();
3626 /* Relinquish the system caret. */
3627 if (w32_system_caret_hwnd)
3629 w32_visible_system_caret_hwnd = NULL;
3630 w32_system_caret_hwnd = NULL;
3631 DestroyCaret ();
3633 goto command;
3634 case WM_COMMAND:
3635 menubar_in_use = 0;
3636 f = x_window_to_frame (dpyinfo, hwnd);
3637 if (f && HIWORD (wParam) == 0)
3639 if (menu_free_timer)
3641 KillTimer (hwnd, menu_free_timer);
3642 menu_free_timer = 0;
3645 case WM_MOVE:
3646 case WM_SIZE:
3647 command:
3648 wmsg.dwModifiers = w32_get_modifiers ();
3649 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3650 goto dflt;
3652 case WM_DESTROY:
3653 CoUninitialize ();
3654 return 0;
3656 case WM_CLOSE:
3657 wmsg.dwModifiers = w32_get_modifiers ();
3658 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3659 return 0;
3661 case WM_WINDOWPOSCHANGING:
3662 /* Don't restrict the sizing of tip frames. */
3663 if (hwnd == tip_window)
3664 return 0;
3666 WINDOWPLACEMENT wp;
3667 LPWINDOWPOS lppos = (WINDOWPOS *) lParam;
3669 wp.length = sizeof (WINDOWPLACEMENT);
3670 GetWindowPlacement (hwnd, &wp);
3672 if (wp.showCmd != SW_SHOWMINIMIZED && (lppos->flags & SWP_NOSIZE) == 0)
3674 RECT rect;
3675 int wdiff;
3676 int hdiff;
3677 DWORD font_width;
3678 DWORD line_height;
3679 DWORD internal_border;
3680 DWORD scrollbar_extra;
3681 RECT wr;
3683 wp.length = sizeof (wp);
3684 GetWindowRect (hwnd, &wr);
3686 enter_crit ();
3688 font_width = GetWindowLong (hwnd, WND_FONTWIDTH_INDEX);
3689 line_height = GetWindowLong (hwnd, WND_LINEHEIGHT_INDEX);
3690 internal_border = GetWindowLong (hwnd, WND_BORDER_INDEX);
3691 scrollbar_extra = GetWindowLong (hwnd, WND_SCROLLBAR_INDEX);
3693 leave_crit ();
3695 memset (&rect, 0, sizeof (rect));
3696 AdjustWindowRect (&rect, GetWindowLong (hwnd, GWL_STYLE),
3697 GetMenu (hwnd) != NULL);
3699 /* Force width and height of client area to be exact
3700 multiples of the character cell dimensions. */
3701 wdiff = (lppos->cx - (rect.right - rect.left)
3702 - 2 * internal_border - scrollbar_extra)
3703 % font_width;
3704 hdiff = (lppos->cy - (rect.bottom - rect.top)
3705 - 2 * internal_border)
3706 % line_height;
3708 if (wdiff || hdiff)
3710 /* For right/bottom sizing we can just fix the sizes.
3711 However for top/left sizing we will need to fix the X
3712 and Y positions as well. */
3714 int cx_mintrack = GetSystemMetrics (SM_CXMINTRACK);
3715 int cy_mintrack = GetSystemMetrics (SM_CYMINTRACK);
3717 lppos->cx = max (lppos->cx - wdiff, cx_mintrack);
3718 lppos->cy = max (lppos->cy - hdiff, cy_mintrack);
3720 if (wp.showCmd != SW_SHOWMAXIMIZED
3721 && (lppos->flags & SWP_NOMOVE) == 0)
3723 if (lppos->x != wr.left || lppos->y != wr.top)
3725 lppos->x += wdiff;
3726 lppos->y += hdiff;
3728 else
3730 lppos->flags |= SWP_NOMOVE;
3734 return 0;
3739 goto dflt;
3741 case WM_GETMINMAXINFO:
3742 /* Hack to allow resizing the Emacs frame above the screen size.
3743 Note that Windows 9x limits coordinates to 16-bits. */
3744 ((LPMINMAXINFO) lParam)->ptMaxTrackSize.x = 32767;
3745 ((LPMINMAXINFO) lParam)->ptMaxTrackSize.y = 32767;
3746 return 0;
3748 case WM_SETCURSOR:
3749 if (LOWORD (lParam) == HTCLIENT)
3751 f = x_window_to_frame (dpyinfo, hwnd);
3752 if (f->output_data.w32->hourglass_p && !menubar_in_use
3753 && !current_popup_menu)
3754 SetCursor (f->output_data.w32->hourglass_cursor);
3755 else
3756 SetCursor (f->output_data.w32->current_cursor);
3757 return 0;
3759 goto dflt;
3761 case WM_EMACS_SETCURSOR:
3763 Cursor cursor = (Cursor) wParam;
3764 f = x_window_to_frame (dpyinfo, hwnd);
3765 if (f && cursor)
3767 f->output_data.w32->current_cursor = cursor;
3768 if (!f->output_data.w32->hourglass_p)
3769 SetCursor (cursor);
3771 return 0;
3774 case WM_EMACS_CREATESCROLLBAR:
3775 return (LRESULT) w32_createscrollbar ((struct frame *) wParam,
3776 (struct scroll_bar *) lParam);
3778 case WM_EMACS_SHOWWINDOW:
3779 return ShowWindow ((HWND) wParam, (WPARAM) lParam);
3781 case WM_EMACS_SETFOREGROUND:
3783 HWND foreground_window;
3784 DWORD foreground_thread, retval;
3786 /* On NT 5.0, and apparently Windows 98, it is necessary to
3787 attach to the thread that currently has focus in order to
3788 pull the focus away from it. */
3789 foreground_window = GetForegroundWindow ();
3790 foreground_thread = GetWindowThreadProcessId (foreground_window, NULL);
3791 if (!foreground_window
3792 || foreground_thread == GetCurrentThreadId ()
3793 || !AttachThreadInput (GetCurrentThreadId (),
3794 foreground_thread, TRUE))
3795 foreground_thread = 0;
3797 retval = SetForegroundWindow ((HWND) wParam);
3799 /* Detach from the previous foreground thread. */
3800 if (foreground_thread)
3801 AttachThreadInput (GetCurrentThreadId (),
3802 foreground_thread, FALSE);
3804 return retval;
3807 case WM_EMACS_SETWINDOWPOS:
3809 WINDOWPOS * pos = (WINDOWPOS *) wParam;
3810 return SetWindowPos (hwnd, pos->hwndInsertAfter,
3811 pos->x, pos->y, pos->cx, pos->cy, pos->flags);
3814 case WM_EMACS_DESTROYWINDOW:
3815 DragAcceptFiles ((HWND) wParam, FALSE);
3816 return DestroyWindow ((HWND) wParam);
3818 case WM_EMACS_HIDE_CARET:
3819 return HideCaret (hwnd);
3821 case WM_EMACS_SHOW_CARET:
3822 return ShowCaret (hwnd);
3824 case WM_EMACS_DESTROY_CARET:
3825 w32_system_caret_hwnd = NULL;
3826 w32_visible_system_caret_hwnd = NULL;
3827 return DestroyCaret ();
3829 case WM_EMACS_TRACK_CARET:
3830 /* If there is currently no system caret, create one. */
3831 if (w32_system_caret_hwnd == NULL)
3833 /* Use the default caret width, and avoid changing it
3834 unneccesarily, as it confuses screen reader software. */
3835 w32_system_caret_hwnd = hwnd;
3836 CreateCaret (hwnd, NULL, 0,
3837 w32_system_caret_height);
3840 if (!SetCaretPos (w32_system_caret_x, w32_system_caret_y))
3841 return 0;
3842 /* Ensure visible caret gets turned on when requested. */
3843 else if (w32_use_visible_system_caret
3844 && w32_visible_system_caret_hwnd != hwnd)
3846 w32_visible_system_caret_hwnd = hwnd;
3847 return ShowCaret (hwnd);
3849 /* Ensure visible caret gets turned off when requested. */
3850 else if (!w32_use_visible_system_caret
3851 && w32_visible_system_caret_hwnd)
3853 w32_visible_system_caret_hwnd = NULL;
3854 return HideCaret (hwnd);
3856 else
3857 return 1;
3859 case WM_EMACS_TRACKPOPUPMENU:
3861 UINT flags;
3862 POINT *pos;
3863 int retval;
3864 pos = (POINT *)lParam;
3865 flags = TPM_CENTERALIGN;
3866 if (button_state & LMOUSE)
3867 flags |= TPM_LEFTBUTTON;
3868 else if (button_state & RMOUSE)
3869 flags |= TPM_RIGHTBUTTON;
3871 /* Remember we did a SetCapture on the initial mouse down event,
3872 so for safety, we make sure the capture is cancelled now. */
3873 ReleaseCapture ();
3874 button_state = 0;
3876 /* Use menubar_active to indicate that WM_INITMENU is from
3877 TrackPopupMenu below, and should be ignored. */
3878 f = x_window_to_frame (dpyinfo, hwnd);
3879 if (f)
3880 f->output_data.w32->menubar_active = 1;
3882 if (TrackPopupMenu ((HMENU)wParam, flags, pos->x, pos->y,
3883 0, hwnd, NULL))
3885 MSG amsg;
3886 /* Eat any mouse messages during popupmenu */
3887 while (PeekMessage (&amsg, hwnd, WM_MOUSEFIRST, WM_MOUSELAST,
3888 PM_REMOVE));
3889 /* Get the menu selection, if any */
3890 if (PeekMessage (&amsg, hwnd, WM_COMMAND, WM_COMMAND, PM_REMOVE))
3892 retval = LOWORD (amsg.wParam);
3894 else
3896 retval = 0;
3899 else
3901 retval = -1;
3904 return retval;
3907 default:
3908 /* Check for messages registered at runtime. */
3909 if (msg == msh_mousewheel)
3911 wmsg.dwModifiers = w32_get_modifiers ();
3912 my_post_msg (&wmsg, hwnd, msg, wParam, lParam);
3913 signal_user_input ();
3914 return 0;
3917 dflt:
3918 return DefWindowProc (hwnd, msg, wParam, lParam);
3921 /* The most common default return code for handled messages is 0. */
3922 return 0;
3925 static void
3926 my_create_window (struct frame * f)
3928 MSG msg;
3930 if (!PostThreadMessage (dwWindowsThreadId, WM_EMACS_CREATEWINDOW, (WPARAM)f, 0))
3931 abort ();
3932 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
3936 /* Create a tooltip window. Unlike my_create_window, we do not do this
3937 indirectly via the Window thread, as we do not need to process Window
3938 messages for the tooltip. Creating tooltips indirectly also creates
3939 deadlocks when tooltips are created for menu items. */
3940 static void
3941 my_create_tip_window (struct frame *f)
3943 RECT rect;
3945 rect.left = rect.top = 0;
3946 rect.right = FRAME_PIXEL_WIDTH (f);
3947 rect.bottom = FRAME_PIXEL_HEIGHT (f);
3949 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
3950 FRAME_EXTERNAL_MENU_BAR (f));
3952 tip_window = FRAME_W32_WINDOW (f)
3953 = CreateWindow (EMACS_CLASS,
3954 f->namebuf,
3955 f->output_data.w32->dwStyle,
3956 f->left_pos,
3957 f->top_pos,
3958 rect.right - rect.left,
3959 rect.bottom - rect.top,
3960 FRAME_W32_WINDOW (SELECTED_FRAME ()), /* owner */
3961 NULL,
3962 hinst,
3963 NULL);
3965 if (tip_window)
3967 SetWindowLong (tip_window, WND_FONTWIDTH_INDEX, FRAME_COLUMN_WIDTH (f));
3968 SetWindowLong (tip_window, WND_LINEHEIGHT_INDEX, FRAME_LINE_HEIGHT (f));
3969 SetWindowLong (tip_window, WND_BORDER_INDEX, FRAME_INTERNAL_BORDER_WIDTH (f));
3970 SetWindowLong (tip_window, WND_BACKGROUND_INDEX, FRAME_BACKGROUND_PIXEL (f));
3972 /* Tip frames have no scrollbars. */
3973 SetWindowLong (tip_window, WND_SCROLLBAR_INDEX, 0);
3975 /* Do this to discard the default setting specified by our parent. */
3976 ShowWindow (tip_window, SW_HIDE);
3981 /* Create and set up the w32 window for frame F. */
3983 static void
3984 w32_window (struct frame *f, long window_prompting, int minibuffer_only)
3986 BLOCK_INPUT;
3988 /* Use the resource name as the top-level window name
3989 for looking up resources. Make a non-Lisp copy
3990 for the window manager, so GC relocation won't bother it.
3992 Elsewhere we specify the window name for the window manager. */
3995 char *str = (char *) SDATA (Vx_resource_name);
3996 f->namebuf = (char *) xmalloc (strlen (str) + 1);
3997 strcpy (f->namebuf, str);
4000 my_create_window (f);
4002 validate_x_resource_name ();
4004 /* x_set_name normally ignores requests to set the name if the
4005 requested name is the same as the current name. This is the one
4006 place where that assumption isn't correct; f->name is set, but
4007 the server hasn't been told. */
4009 Lisp_Object name;
4010 int explicit = f->explicit_name;
4012 f->explicit_name = 0;
4013 name = f->name;
4014 f->name = Qnil;
4015 x_set_name (f, name, explicit);
4018 UNBLOCK_INPUT;
4020 if (!minibuffer_only && FRAME_EXTERNAL_MENU_BAR (f))
4021 initialize_frame_menubar (f);
4023 if (FRAME_W32_WINDOW (f) == 0)
4024 error ("Unable to create window");
4027 /* Handle the icon stuff for this window. Perhaps later we might
4028 want an x_set_icon_position which can be called interactively as
4029 well. */
4031 static void
4032 x_icon (struct frame *f, Lisp_Object parms)
4034 Lisp_Object icon_x, icon_y;
4035 struct w32_display_info *dpyinfo = &one_w32_display_info;
4037 /* Set the position of the icon. Note that Windows 95 groups all
4038 icons in the tray. */
4039 icon_x = x_get_arg (dpyinfo, parms, Qicon_left, 0, 0, RES_TYPE_NUMBER);
4040 icon_y = x_get_arg (dpyinfo, parms, Qicon_top, 0, 0, RES_TYPE_NUMBER);
4041 if (!EQ (icon_x, Qunbound) && !EQ (icon_y, Qunbound))
4043 CHECK_NUMBER (icon_x);
4044 CHECK_NUMBER (icon_y);
4046 else if (!EQ (icon_x, Qunbound) || !EQ (icon_y, Qunbound))
4047 error ("Both left and top icon corners of icon must be specified");
4049 BLOCK_INPUT;
4051 if (! EQ (icon_x, Qunbound))
4052 x_wm_set_icon_position (f, XINT (icon_x), XINT (icon_y));
4054 #if 0 /* TODO */
4055 /* Start up iconic or window? */
4056 x_wm_set_window_state
4057 (f, (EQ (x_get_arg (dpyinfo, parms, Qvisibility, 0, 0, RES_TYPE_SYMBOL), Qicon)
4058 ? IconicState
4059 : NormalState));
4061 x_text_icon (f, (char *) SDATA ((!NILP (f->icon_name)
4062 ? f->icon_name
4063 : f->name)));
4064 #endif
4066 UNBLOCK_INPUT;
4070 static void
4071 x_make_gc (struct frame *f)
4073 XGCValues gc_values;
4075 BLOCK_INPUT;
4077 /* Create the GC's of this frame.
4078 Note that many default values are used. */
4080 /* Normal video */
4081 gc_values.font = FRAME_FONT (f);
4083 /* Cursor has cursor-color background, background-color foreground. */
4084 gc_values.foreground = FRAME_BACKGROUND_PIXEL (f);
4085 gc_values.background = f->output_data.w32->cursor_pixel;
4086 f->output_data.w32->cursor_gc
4087 = XCreateGC (NULL, FRAME_W32_WINDOW (f),
4088 (GCFont | GCForeground | GCBackground),
4089 &gc_values);
4091 /* Reliefs. */
4092 f->output_data.w32->white_relief.gc = 0;
4093 f->output_data.w32->black_relief.gc = 0;
4095 UNBLOCK_INPUT;
4099 /* Handler for signals raised during x_create_frame and
4100 x_create_top_frame. FRAME is the frame which is partially
4101 constructed. */
4103 static Lisp_Object
4104 unwind_create_frame (Lisp_Object frame)
4106 struct frame *f = XFRAME (frame);
4108 /* If frame is ``official'', nothing to do. */
4109 if (!CONSP (Vframe_list) || !EQ (XCAR (Vframe_list), frame))
4111 #ifdef GLYPH_DEBUG
4112 struct w32_display_info *dpyinfo = FRAME_W32_DISPLAY_INFO (f);
4113 #endif
4115 x_free_frame_resources (f);
4117 #if GLYPH_DEBUG
4118 /* Check that reference counts are indeed correct. */
4119 xassert (dpyinfo->reference_count == dpyinfo_refcount);
4120 xassert (dpyinfo->image_cache->refcount == image_cache_refcount);
4121 #endif
4122 return Qt;
4125 return Qnil;
4128 static void
4129 x_default_font_parameter (struct frame *f, Lisp_Object parms)
4131 struct w32_display_info *dpyinfo = FRAME_W32_DISPLAY_INFO (f);
4132 Lisp_Object font_param = x_get_arg (dpyinfo, parms, Qfont, NULL, NULL,
4133 RES_TYPE_STRING);
4134 Lisp_Object font;
4135 if (EQ (font_param, Qunbound))
4136 font_param = Qnil;
4137 font = !NILP (font_param) ? font_param
4138 : x_get_arg (dpyinfo, parms, Qfont, "font", "Font", RES_TYPE_STRING);
4140 if (!STRINGP (font))
4142 int i;
4143 static char *names[]
4144 = { "Courier New-10",
4145 "-*-Courier-normal-r-*-*-13-*-*-*-c-*-iso8859-1",
4146 "-*-Fixedsys-normal-r-*-*-12-*-*-*-c-*-iso8859-1",
4147 "Fixedsys",
4148 NULL };
4150 for (i = 0; names[i]; i++)
4152 font = font_open_by_name (f, names[i]);
4153 if (! NILP (font))
4154 break;
4156 if (NILP (font))
4157 error ("No suitable font was found");
4159 else if (!NILP (font_param))
4161 /* Remember the explicit font parameter, so we can re-apply it after
4162 we've applied the `default' face settings. */
4163 x_set_frame_parameters (f, Fcons (Fcons (Qfont_param, font_param), Qnil));
4165 x_default_parameter (f, parms, Qfont, font, "font", "Font", RES_TYPE_STRING);
4168 DEFUN ("x-create-frame", Fx_create_frame, Sx_create_frame,
4169 1, 1, 0,
4170 doc: /* Make a new window, which is called a \"frame\" in Emacs terms.
4171 Return an Emacs frame object.
4172 PARAMETERS is an alist of frame parameters.
4173 If the parameters specify that the frame should not have a minibuffer,
4174 and do not specify a specific minibuffer window to use,
4175 then `default-minibuffer-frame' must be a frame whose minibuffer can
4176 be shared by the new frame.
4178 This function is an internal primitive--use `make-frame' instead. */)
4179 (Lisp_Object parameters)
4181 struct frame *f;
4182 Lisp_Object frame, tem;
4183 Lisp_Object name;
4184 int minibuffer_only = 0;
4185 long window_prompting = 0;
4186 int width, height;
4187 int count = SPECPDL_INDEX ();
4188 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4189 Lisp_Object display;
4190 struct w32_display_info *dpyinfo = NULL;
4191 Lisp_Object parent;
4192 struct kboard *kb;
4194 /* Make copy of frame parameters because the original is in pure
4195 storage now. */
4196 parameters = Fcopy_alist (parameters);
4198 /* Use this general default value to start with
4199 until we know if this frame has a specified name. */
4200 Vx_resource_name = Vinvocation_name;
4202 display = x_get_arg (dpyinfo, parameters, Qterminal, 0, 0, RES_TYPE_NUMBER);
4203 if (EQ (display, Qunbound))
4204 display = x_get_arg (dpyinfo, parameters, Qdisplay, 0, 0, RES_TYPE_STRING);
4205 if (EQ (display, Qunbound))
4206 display = Qnil;
4207 dpyinfo = check_x_display_info (display);
4208 kb = dpyinfo->terminal->kboard;
4210 if (!dpyinfo->terminal->name)
4211 error ("Terminal is not live, can't create new frames on it");
4213 name = x_get_arg (dpyinfo, parameters, Qname, "name", "Name", RES_TYPE_STRING);
4214 if (!STRINGP (name)
4215 && ! EQ (name, Qunbound)
4216 && ! NILP (name))
4217 error ("Invalid frame name--not a string or nil");
4219 if (STRINGP (name))
4220 Vx_resource_name = name;
4222 /* See if parent window is specified. */
4223 parent = x_get_arg (dpyinfo, parameters, Qparent_id, NULL, NULL, RES_TYPE_NUMBER);
4224 if (EQ (parent, Qunbound))
4225 parent = Qnil;
4226 if (! NILP (parent))
4227 CHECK_NUMBER (parent);
4229 /* make_frame_without_minibuffer can run Lisp code and garbage collect. */
4230 /* No need to protect DISPLAY because that's not used after passing
4231 it to make_frame_without_minibuffer. */
4232 frame = Qnil;
4233 GCPRO4 (parameters, parent, name, frame);
4234 tem = x_get_arg (dpyinfo, parameters, Qminibuffer, "minibuffer", "Minibuffer",
4235 RES_TYPE_SYMBOL);
4236 if (EQ (tem, Qnone) || NILP (tem))
4237 f = make_frame_without_minibuffer (Qnil, kb, display);
4238 else if (EQ (tem, Qonly))
4240 f = make_minibuffer_frame ();
4241 minibuffer_only = 1;
4243 else if (WINDOWP (tem))
4244 f = make_frame_without_minibuffer (tem, kb, display);
4245 else
4246 f = make_frame (1);
4248 XSETFRAME (frame, f);
4250 /* Note that Windows does support scroll bars. */
4251 FRAME_CAN_HAVE_SCROLL_BARS (f) = 1;
4253 /* By default, make scrollbars the system standard width. */
4254 FRAME_CONFIG_SCROLL_BAR_WIDTH (f) = GetSystemMetrics (SM_CXVSCROLL);
4256 f->terminal = dpyinfo->terminal;
4257 f->terminal->reference_count++;
4259 f->output_method = output_w32;
4260 f->output_data.w32 =
4261 (struct w32_output *) xmalloc (sizeof (struct w32_output));
4262 memset (f->output_data.w32, 0, sizeof (struct w32_output));
4263 FRAME_FONTSET (f) = -1;
4265 f->icon_name
4266 = x_get_arg (dpyinfo, parameters, Qicon_name, "iconName", "Title",
4267 RES_TYPE_STRING);
4268 if (! STRINGP (f->icon_name))
4269 f->icon_name = Qnil;
4271 /* FRAME_W32_DISPLAY_INFO (f) = dpyinfo; */
4273 /* With FRAME_X_DISPLAY_INFO set up, this unwind-protect is safe. */
4274 record_unwind_protect (unwind_create_frame, frame);
4275 #if GLYPH_DEBUG
4276 image_cache_refcount = FRAME_IMAGE_CACHE (f)->refcount;
4277 dpyinfo_refcount = dpyinfo->reference_count;
4278 #endif /* GLYPH_DEBUG */
4280 /* Specify the parent under which to make this window. */
4282 if (!NILP (parent))
4284 f->output_data.w32->parent_desc = (Window) XFASTINT (parent);
4285 f->output_data.w32->explicit_parent = 1;
4287 else
4289 f->output_data.w32->parent_desc = FRAME_W32_DISPLAY_INFO (f)->root_window;
4290 f->output_data.w32->explicit_parent = 0;
4293 /* Set the name; the functions to which we pass f expect the name to
4294 be set. */
4295 if (EQ (name, Qunbound) || NILP (name))
4297 f->name = build_string (dpyinfo->w32_id_name);
4298 f->explicit_name = 0;
4300 else
4302 f->name = name;
4303 f->explicit_name = 1;
4304 /* use the frame's title when getting resources for this frame. */
4305 specbind (Qx_resource_name, name);
4308 f->resx = dpyinfo->resx;
4309 f->resy = dpyinfo->resy;
4311 if (uniscribe_available)
4312 register_font_driver (&uniscribe_font_driver, f);
4313 register_font_driver (&w32font_driver, f);
4315 x_default_parameter (f, parameters, Qfont_backend, Qnil,
4316 "fontBackend", "FontBackend", RES_TYPE_STRING);
4317 /* Extract the window parameters from the supplied values
4318 that are needed to determine window geometry. */
4319 x_default_font_parameter (f, parameters);
4320 x_default_parameter (f, parameters, Qborder_width, make_number (2),
4321 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
4323 /* We recognize either internalBorderWidth or internalBorder
4324 (which is what xterm calls it). */
4325 if (NILP (Fassq (Qinternal_border_width, parameters)))
4327 Lisp_Object value;
4329 value = x_get_arg (dpyinfo, parameters, Qinternal_border_width,
4330 "internalBorder", "InternalBorder", RES_TYPE_NUMBER);
4331 if (! EQ (value, Qunbound))
4332 parameters = Fcons (Fcons (Qinternal_border_width, value),
4333 parameters);
4335 /* Default internalBorderWidth to 0 on Windows to match other programs. */
4336 x_default_parameter (f, parameters, Qinternal_border_width, make_number (0),
4337 "internalBorderWidth", "InternalBorder", RES_TYPE_NUMBER);
4338 x_default_parameter (f, parameters, Qvertical_scroll_bars, Qright,
4339 "verticalScrollBars", "ScrollBars", RES_TYPE_SYMBOL);
4341 /* Also do the stuff which must be set before the window exists. */
4342 x_default_parameter (f, parameters, Qforeground_color, build_string ("black"),
4343 "foreground", "Foreground", RES_TYPE_STRING);
4344 x_default_parameter (f, parameters, Qbackground_color, build_string ("white"),
4345 "background", "Background", RES_TYPE_STRING);
4346 x_default_parameter (f, parameters, Qmouse_color, build_string ("black"),
4347 "pointerColor", "Foreground", RES_TYPE_STRING);
4348 x_default_parameter (f, parameters, Qcursor_color, build_string ("black"),
4349 "cursorColor", "Foreground", RES_TYPE_STRING);
4350 x_default_parameter (f, parameters, Qborder_color, build_string ("black"),
4351 "borderColor", "BorderColor", RES_TYPE_STRING);
4352 x_default_parameter (f, parameters, Qscreen_gamma, Qnil,
4353 "screenGamma", "ScreenGamma", RES_TYPE_FLOAT);
4354 x_default_parameter (f, parameters, Qline_spacing, Qnil,
4355 "lineSpacing", "LineSpacing", RES_TYPE_NUMBER);
4356 x_default_parameter (f, parameters, Qleft_fringe, Qnil,
4357 "leftFringe", "LeftFringe", RES_TYPE_NUMBER);
4358 x_default_parameter (f, parameters, Qright_fringe, Qnil,
4359 "rightFringe", "RightFringe", RES_TYPE_NUMBER);
4361 /* Init faces before x_default_parameter is called for scroll-bar
4362 parameters because that function calls x_set_scroll_bar_width,
4363 which calls change_frame_size, which calls Fset_window_buffer,
4364 which runs hooks, which call Fvertical_motion. At the end, we
4365 end up in init_iterator with a null face cache, which should not
4366 happen. */
4367 init_frame_faces (f);
4369 /* The X resources controlling the menu-bar and tool-bar are
4370 processed specially at startup, and reflected in the mode
4371 variables; ignore them here. */
4372 x_default_parameter (f, parameters, Qmenu_bar_lines,
4373 NILP (Vmenu_bar_mode)
4374 ? make_number (0) : make_number (1),
4375 NULL, NULL, RES_TYPE_NUMBER);
4376 x_default_parameter (f, parameters, Qtool_bar_lines,
4377 NILP (Vtool_bar_mode)
4378 ? make_number (0) : make_number (1),
4379 NULL, NULL, RES_TYPE_NUMBER);
4381 x_default_parameter (f, parameters, Qbuffer_predicate, Qnil,
4382 "bufferPredicate", "BufferPredicate", RES_TYPE_SYMBOL);
4383 x_default_parameter (f, parameters, Qtitle, Qnil,
4384 "title", "Title", RES_TYPE_STRING);
4385 x_default_parameter (f, parameters, Qfullscreen, Qnil,
4386 "fullscreen", "Fullscreen", RES_TYPE_SYMBOL);
4388 f->output_data.w32->dwStyle = WS_OVERLAPPEDWINDOW;
4389 f->output_data.w32->parent_desc = FRAME_W32_DISPLAY_INFO (f)->root_window;
4391 f->output_data.w32->text_cursor = w32_load_cursor (IDC_IBEAM);
4392 f->output_data.w32->nontext_cursor = w32_load_cursor (IDC_ARROW);
4393 f->output_data.w32->modeline_cursor = w32_load_cursor (IDC_ARROW);
4394 f->output_data.w32->hand_cursor = w32_load_cursor (IDC_HAND);
4395 f->output_data.w32->hourglass_cursor = w32_load_cursor (IDC_WAIT);
4396 f->output_data.w32->horizontal_drag_cursor = w32_load_cursor (IDC_SIZEWE);
4398 f->output_data.w32->current_cursor = f->output_data.w32->nontext_cursor;
4400 window_prompting = x_figure_window_size (f, parameters, 1);
4402 tem = x_get_arg (dpyinfo, parameters, Qunsplittable, 0, 0, RES_TYPE_BOOLEAN);
4403 f->no_split = minibuffer_only || EQ (tem, Qt);
4405 w32_window (f, window_prompting, minibuffer_only);
4406 x_icon (f, parameters);
4408 x_make_gc (f);
4410 /* Now consider the frame official. */
4411 FRAME_W32_DISPLAY_INFO (f)->reference_count++;
4412 Vframe_list = Fcons (frame, Vframe_list);
4414 /* We need to do this after creating the window, so that the
4415 icon-creation functions can say whose icon they're describing. */
4416 x_default_parameter (f, parameters, Qicon_type, Qnil,
4417 "bitmapIcon", "BitmapIcon", RES_TYPE_SYMBOL);
4419 x_default_parameter (f, parameters, Qauto_raise, Qnil,
4420 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4421 x_default_parameter (f, parameters, Qauto_lower, Qnil,
4422 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
4423 x_default_parameter (f, parameters, Qcursor_type, Qbox,
4424 "cursorType", "CursorType", RES_TYPE_SYMBOL);
4425 x_default_parameter (f, parameters, Qscroll_bar_width, Qnil,
4426 "scrollBarWidth", "ScrollBarWidth", RES_TYPE_NUMBER);
4427 x_default_parameter (f, parameters, Qalpha, Qnil,
4428 "alpha", "Alpha", RES_TYPE_NUMBER);
4430 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
4431 Change will not be effected unless different from the current
4432 FRAME_LINES (f). */
4433 width = FRAME_COLS (f);
4434 height = FRAME_LINES (f);
4436 FRAME_LINES (f) = 0;
4437 SET_FRAME_COLS (f, 0);
4438 change_frame_size (f, height, width, 1, 0, 0);
4440 /* Tell the server what size and position, etc, we want, and how
4441 badly we want them. This should be done after we have the menu
4442 bar so that its size can be taken into account. */
4443 BLOCK_INPUT;
4444 x_wm_set_size_hint (f, window_prompting, 0);
4445 UNBLOCK_INPUT;
4447 /* Make the window appear on the frame and enable display, unless
4448 the caller says not to. However, with explicit parent, Emacs
4449 cannot control visibility, so don't try. */
4450 if (! f->output_data.w32->explicit_parent)
4452 Lisp_Object visibility;
4454 visibility = x_get_arg (dpyinfo, parameters, Qvisibility, 0, 0, RES_TYPE_SYMBOL);
4455 if (EQ (visibility, Qunbound))
4456 visibility = Qt;
4458 if (EQ (visibility, Qicon))
4459 x_iconify_frame (f);
4460 else if (! NILP (visibility))
4461 x_make_frame_visible (f);
4462 else
4463 /* Must have been Qnil. */
4467 /* Initialize `default-minibuffer-frame' in case this is the first
4468 frame on this terminal. */
4469 if (FRAME_HAS_MINIBUF_P (f)
4470 && (!FRAMEP (kb->Vdefault_minibuffer_frame)
4471 || !FRAME_LIVE_P (XFRAME (kb->Vdefault_minibuffer_frame))))
4472 kb->Vdefault_minibuffer_frame = frame;
4474 /* All remaining specified parameters, which have not been "used"
4475 by x_get_arg and friends, now go in the misc. alist of the frame. */
4476 for (tem = parameters; CONSP (tem); tem = XCDR (tem))
4477 if (CONSP (XCAR (tem)) && !NILP (XCAR (XCAR (tem))))
4478 f->param_alist = Fcons (XCAR (tem), f->param_alist);
4480 UNGCPRO;
4482 /* Make sure windows on this frame appear in calls to next-window
4483 and similar functions. */
4484 Vwindow_list = Qnil;
4486 return unbind_to (count, frame);
4489 /* FRAME is used only to get a handle on the X display. We don't pass the
4490 display info directly because we're called from frame.c, which doesn't
4491 know about that structure. */
4492 Lisp_Object
4493 x_get_focus_frame (struct frame *frame)
4495 struct w32_display_info *dpyinfo = FRAME_W32_DISPLAY_INFO (frame);
4496 Lisp_Object xfocus;
4497 if (! dpyinfo->w32_focus_frame)
4498 return Qnil;
4500 XSETFRAME (xfocus, dpyinfo->w32_focus_frame);
4501 return xfocus;
4504 DEFUN ("x-focus-frame", Fx_focus_frame, Sx_focus_frame, 1, 1, 0,
4505 doc: /* Give FRAME input focus, raising to foreground if necessary. */)
4506 (Lisp_Object frame)
4508 x_focus_on_frame (check_x_frame (frame));
4509 return Qnil;
4513 DEFUN ("xw-color-defined-p", Fxw_color_defined_p, Sxw_color_defined_p, 1, 2, 0,
4514 doc: /* Internal function called by `color-defined-p', which see.
4515 \(Note that the Nextstep version of this function ignores FRAME.) */)
4516 (Lisp_Object color, Lisp_Object frame)
4518 XColor foo;
4519 FRAME_PTR f = check_x_frame (frame);
4521 CHECK_STRING (color);
4523 if (w32_defined_color (f, SDATA (color), &foo, 0))
4524 return Qt;
4525 else
4526 return Qnil;
4529 DEFUN ("xw-color-values", Fxw_color_values, Sxw_color_values, 1, 2, 0,
4530 doc: /* Internal function called by `color-values', which see. */)
4531 (Lisp_Object color, Lisp_Object frame)
4533 XColor foo;
4534 FRAME_PTR f = check_x_frame (frame);
4536 CHECK_STRING (color);
4538 if (w32_defined_color (f, SDATA (color), &foo, 0))
4539 return list3 (make_number ((GetRValue (foo.pixel) << 8)
4540 | GetRValue (foo.pixel)),
4541 make_number ((GetGValue (foo.pixel) << 8)
4542 | GetGValue (foo.pixel)),
4543 make_number ((GetBValue (foo.pixel) << 8)
4544 | GetBValue (foo.pixel)));
4545 else
4546 return Qnil;
4549 DEFUN ("xw-display-color-p", Fxw_display_color_p, Sxw_display_color_p, 0, 1, 0,
4550 doc: /* Internal function called by `display-color-p', which see. */)
4551 (Lisp_Object display)
4553 struct w32_display_info *dpyinfo = check_x_display_info (display);
4555 if ((dpyinfo->n_planes * dpyinfo->n_cbits) <= 2)
4556 return Qnil;
4558 return Qt;
4561 DEFUN ("x-display-grayscale-p", Fx_display_grayscale_p,
4562 Sx_display_grayscale_p, 0, 1, 0,
4563 doc: /* Return t if DISPLAY supports shades of gray.
4564 Note that color displays do support shades of gray.
4565 The optional argument DISPLAY specifies which display to ask about.
4566 DISPLAY should be either a frame or a display name (a string).
4567 If omitted or nil, that stands for the selected frame's display. */)
4568 (Lisp_Object display)
4570 struct w32_display_info *dpyinfo = check_x_display_info (display);
4572 if ((dpyinfo->n_planes * dpyinfo->n_cbits) <= 1)
4573 return Qnil;
4575 return Qt;
4578 DEFUN ("x-display-pixel-width", Fx_display_pixel_width,
4579 Sx_display_pixel_width, 0, 1, 0,
4580 doc: /* Return the width in pixels of DISPLAY.
4581 The optional argument DISPLAY specifies which display to ask about.
4582 DISPLAY should be either a frame or a display name (a string).
4583 If omitted or nil, that stands for the selected frame's display. */)
4584 (Lisp_Object display)
4586 struct w32_display_info *dpyinfo = check_x_display_info (display);
4588 return make_number (x_display_pixel_width (dpyinfo));
4591 DEFUN ("x-display-pixel-height", Fx_display_pixel_height,
4592 Sx_display_pixel_height, 0, 1, 0,
4593 doc: /* Return the height in pixels of DISPLAY.
4594 The optional argument DISPLAY specifies which display to ask about.
4595 DISPLAY should be either a frame or a display name (a string).
4596 If omitted or nil, that stands for the selected frame's display. */)
4597 (Lisp_Object display)
4599 struct w32_display_info *dpyinfo = check_x_display_info (display);
4601 return make_number (x_display_pixel_height (dpyinfo));
4604 DEFUN ("x-display-planes", Fx_display_planes, Sx_display_planes,
4605 0, 1, 0,
4606 doc: /* Return the number of bitplanes of DISPLAY.
4607 The optional argument DISPLAY specifies which display to ask about.
4608 DISPLAY should be either a frame or a display name (a string).
4609 If omitted or nil, that stands for the selected frame's display. */)
4610 (Lisp_Object display)
4612 struct w32_display_info *dpyinfo = check_x_display_info (display);
4614 return make_number (dpyinfo->n_planes * dpyinfo->n_cbits);
4617 DEFUN ("x-display-color-cells", Fx_display_color_cells, Sx_display_color_cells,
4618 0, 1, 0,
4619 doc: /* Return the number of color cells of DISPLAY.
4620 The optional argument DISPLAY specifies which display to ask about.
4621 DISPLAY should be either a frame or a display name (a string).
4622 If omitted or nil, that stands for the selected frame's display. */)
4623 (Lisp_Object display)
4625 struct w32_display_info *dpyinfo = check_x_display_info (display);
4626 HDC hdc;
4627 int cap;
4629 hdc = GetDC (dpyinfo->root_window);
4630 if (dpyinfo->has_palette)
4631 cap = GetDeviceCaps (hdc, SIZEPALETTE);
4632 else
4633 cap = GetDeviceCaps (hdc, NUMCOLORS);
4635 /* We force 24+ bit depths to 24-bit, both to prevent an overflow
4636 and because probably is more meaningful on Windows anyway */
4637 if (cap < 0)
4638 cap = 1 << min (dpyinfo->n_planes * dpyinfo->n_cbits, 24);
4640 ReleaseDC (dpyinfo->root_window, hdc);
4642 return make_number (cap);
4645 DEFUN ("x-server-max-request-size", Fx_server_max_request_size,
4646 Sx_server_max_request_size,
4647 0, 1, 0,
4648 doc: /* Return the maximum request size of the server of DISPLAY.
4649 The optional argument DISPLAY specifies which display to ask about.
4650 DISPLAY should be either a frame or a display name (a string).
4651 If omitted or nil, that stands for the selected frame's display. */)
4652 (Lisp_Object display)
4654 struct w32_display_info *dpyinfo = check_x_display_info (display);
4656 return make_number (1);
4659 DEFUN ("x-server-vendor", Fx_server_vendor, Sx_server_vendor, 0, 1, 0,
4660 doc: /* Return the "vendor ID" string of the W32 system (Microsoft).
4661 The optional argument DISPLAY specifies which display to ask about.
4662 DISPLAY should be either a frame or a display name (a string).
4663 If omitted or nil, that stands for the selected frame's display. */)
4664 (Lisp_Object display)
4666 return build_string ("Microsoft Corp.");
4669 DEFUN ("x-server-version", Fx_server_version, Sx_server_version, 0, 1, 0,
4670 doc: /* Return the version numbers of the server of DISPLAY.
4671 The value is a list of three integers: the major and minor
4672 version numbers of the X Protocol in use, and the distributor-specific
4673 release number. See also the function `x-server-vendor'.
4675 The optional argument DISPLAY specifies which display to ask about.
4676 DISPLAY should be either a frame or a display name (a string).
4677 If omitted or nil, that stands for the selected frame's display. */)
4678 (Lisp_Object display)
4680 return Fcons (make_number (w32_major_version),
4681 Fcons (make_number (w32_minor_version),
4682 Fcons (make_number (w32_build_number), Qnil)));
4685 DEFUN ("x-display-screens", Fx_display_screens, Sx_display_screens, 0, 1, 0,
4686 doc: /* Return the number of screens on the server of DISPLAY.
4687 The optional argument DISPLAY specifies which display to ask about.
4688 DISPLAY should be either a frame or a display name (a string).
4689 If omitted or nil, that stands for the selected frame's display. */)
4690 (Lisp_Object display)
4692 return make_number (1);
4695 DEFUN ("x-display-mm-height", Fx_display_mm_height,
4696 Sx_display_mm_height, 0, 1, 0,
4697 doc: /* Return the height in millimeters of DISPLAY.
4698 The optional argument DISPLAY specifies which display to ask about.
4699 DISPLAY should be either a frame or a display name (a string).
4700 If omitted or nil, that stands for the selected frame's display. */)
4701 (Lisp_Object display)
4703 struct w32_display_info *dpyinfo = check_x_display_info (display);
4704 HDC hdc;
4705 int cap;
4707 hdc = GetDC (dpyinfo->root_window);
4709 cap = GetDeviceCaps (hdc, VERTSIZE);
4711 ReleaseDC (dpyinfo->root_window, hdc);
4713 return make_number (cap);
4716 DEFUN ("x-display-mm-width", Fx_display_mm_width, Sx_display_mm_width, 0, 1, 0,
4717 doc: /* Return the width in millimeters of DISPLAY.
4718 The optional argument DISPLAY specifies which display to ask about.
4719 DISPLAY should be either a frame or a display name (a string).
4720 If omitted or nil, that stands for the selected frame's display. */)
4721 (Lisp_Object display)
4723 struct w32_display_info *dpyinfo = check_x_display_info (display);
4725 HDC hdc;
4726 int cap;
4728 hdc = GetDC (dpyinfo->root_window);
4730 cap = GetDeviceCaps (hdc, HORZSIZE);
4732 ReleaseDC (dpyinfo->root_window, hdc);
4734 return make_number (cap);
4737 DEFUN ("x-display-backing-store", Fx_display_backing_store,
4738 Sx_display_backing_store, 0, 1, 0,
4739 doc: /* Return an indication of whether DISPLAY does backing store.
4740 The value may be `always', `when-mapped', or `not-useful'.
4741 The optional argument DISPLAY specifies which display to ask about.
4742 DISPLAY should be either a frame or a display name (a string).
4743 If omitted or nil, that stands for the selected frame's display. */)
4744 (Lisp_Object display)
4746 return intern ("not-useful");
4749 DEFUN ("x-display-visual-class", Fx_display_visual_class,
4750 Sx_display_visual_class, 0, 1, 0,
4751 doc: /* Return the visual class of DISPLAY.
4752 The value is one of the symbols `static-gray', `gray-scale',
4753 `static-color', `pseudo-color', `true-color', or `direct-color'.
4755 The optional argument DISPLAY specifies which display to ask about.
4756 DISPLAY should be either a frame or a display name (a string).
4757 If omitted or nil, that stands for the selected frame's display. */)
4758 (Lisp_Object display)
4760 struct w32_display_info *dpyinfo = check_x_display_info (display);
4761 Lisp_Object result = Qnil;
4763 if (dpyinfo->has_palette)
4764 result = intern ("pseudo-color");
4765 else if (dpyinfo->n_planes * dpyinfo->n_cbits == 1)
4766 result = intern ("static-grey");
4767 else if (dpyinfo->n_planes * dpyinfo->n_cbits == 4)
4768 result = intern ("static-color");
4769 else if (dpyinfo->n_planes * dpyinfo->n_cbits > 8)
4770 result = intern ("true-color");
4772 return result;
4775 DEFUN ("x-display-save-under", Fx_display_save_under,
4776 Sx_display_save_under, 0, 1, 0,
4777 doc: /* Return t if DISPLAY supports the save-under feature.
4778 The optional argument DISPLAY specifies which display to ask about.
4779 DISPLAY should be either a frame or a display name (a string).
4780 If omitted or nil, that stands for the selected frame's display. */)
4781 (Lisp_Object display)
4783 return Qnil;
4787 x_pixel_width (register struct frame *f)
4789 return FRAME_PIXEL_WIDTH (f);
4793 x_pixel_height (register struct frame *f)
4795 return FRAME_PIXEL_HEIGHT (f);
4799 x_char_width (register struct frame *f)
4801 return FRAME_COLUMN_WIDTH (f);
4805 x_char_height (register struct frame *f)
4807 return FRAME_LINE_HEIGHT (f);
4811 x_screen_planes (register struct frame *f)
4813 return FRAME_W32_DISPLAY_INFO (f)->n_planes;
4816 /* Return the display structure for the display named NAME.
4817 Open a new connection if necessary. */
4819 struct w32_display_info *
4820 x_display_info_for_name (Lisp_Object name)
4822 Lisp_Object names;
4823 struct w32_display_info *dpyinfo;
4825 CHECK_STRING (name);
4827 for (dpyinfo = &one_w32_display_info, names = w32_display_name_list;
4828 dpyinfo;
4829 dpyinfo = dpyinfo->next, names = XCDR (names))
4831 Lisp_Object tem;
4832 tem = Fstring_equal (XCAR (XCAR (names)), name);
4833 if (!NILP (tem))
4834 return dpyinfo;
4837 /* Use this general default value to start with. */
4838 Vx_resource_name = Vinvocation_name;
4840 validate_x_resource_name ();
4842 dpyinfo = w32_term_init (name, (unsigned char *)0,
4843 (char *) SDATA (Vx_resource_name));
4845 if (dpyinfo == 0)
4846 error ("Cannot connect to server %s", SDATA (name));
4848 w32_in_use = 1;
4849 XSETFASTINT (Vwindow_system_version, w32_major_version);
4851 return dpyinfo;
4854 DEFUN ("x-open-connection", Fx_open_connection, Sx_open_connection,
4855 1, 3, 0, doc: /* Open a connection to a display server.
4856 DISPLAY is the name of the display to connect to.
4857 Optional second arg XRM-STRING is a string of resources in xrdb format.
4858 If the optional third arg MUST-SUCCEED is non-nil,
4859 terminate Emacs if we can't open the connection.
4860 \(In the Nextstep version, the last two arguments are currently ignored.) */)
4861 (Lisp_Object display, Lisp_Object xrm_string, Lisp_Object must_succeed)
4863 unsigned char *xrm_option;
4864 struct w32_display_info *dpyinfo;
4866 /* If initialization has already been done, return now to avoid
4867 overwriting critical parts of one_w32_display_info. */
4868 if (w32_in_use)
4869 return Qnil;
4871 CHECK_STRING (display);
4872 if (! NILP (xrm_string))
4873 CHECK_STRING (xrm_string);
4875 #if 0
4876 if (! EQ (Vwindow_system, intern ("w32")))
4877 error ("Not using Microsoft Windows");
4878 #endif
4880 /* Allow color mapping to be defined externally; first look in user's
4881 HOME directory, then in Emacs etc dir for a file called rgb.txt. */
4883 Lisp_Object color_file;
4884 struct gcpro gcpro1;
4886 color_file = build_string ("~/rgb.txt");
4888 GCPRO1 (color_file);
4890 if (NILP (Ffile_readable_p (color_file)))
4891 color_file =
4892 Fexpand_file_name (build_string ("rgb.txt"),
4893 Fsymbol_value (intern ("data-directory")));
4895 Vw32_color_map = Fx_load_color_file (color_file);
4897 UNGCPRO;
4899 if (NILP (Vw32_color_map))
4900 Vw32_color_map = Fw32_default_color_map ();
4902 /* Merge in system logical colors. */
4903 add_system_logical_colors_to_map (&Vw32_color_map);
4905 if (! NILP (xrm_string))
4906 xrm_option = (unsigned char *) SDATA (xrm_string);
4907 else
4908 xrm_option = (unsigned char *) 0;
4910 /* Use this general default value to start with. */
4911 /* First remove .exe suffix from invocation-name - it looks ugly. */
4913 char basename[ MAX_PATH ], *str;
4915 strcpy (basename, SDATA (Vinvocation_name));
4916 str = strrchr (basename, '.');
4917 if (str) *str = 0;
4918 Vinvocation_name = build_string (basename);
4920 Vx_resource_name = Vinvocation_name;
4922 validate_x_resource_name ();
4924 /* This is what opens the connection and sets x_current_display.
4925 This also initializes many symbols, such as those used for input. */
4926 dpyinfo = w32_term_init (display, xrm_option,
4927 (char *) SDATA (Vx_resource_name));
4929 if (dpyinfo == 0)
4931 if (!NILP (must_succeed))
4932 fatal ("Cannot connect to server %s.\n",
4933 SDATA (display));
4934 else
4935 error ("Cannot connect to server %s", SDATA (display));
4938 w32_in_use = 1;
4940 XSETFASTINT (Vwindow_system_version, w32_major_version);
4941 return Qnil;
4944 DEFUN ("x-close-connection", Fx_close_connection,
4945 Sx_close_connection, 1, 1, 0,
4946 doc: /* Close the connection to DISPLAY's server.
4947 For DISPLAY, specify either a frame or a display name (a string).
4948 If DISPLAY is nil, that stands for the selected frame's display. */)
4949 (Lisp_Object display)
4951 struct w32_display_info *dpyinfo = check_x_display_info (display);
4952 int i;
4954 if (dpyinfo->reference_count > 0)
4955 error ("Display still has frames on it");
4957 BLOCK_INPUT;
4958 x_destroy_all_bitmaps (dpyinfo);
4960 x_delete_display (dpyinfo);
4961 UNBLOCK_INPUT;
4963 return Qnil;
4966 DEFUN ("x-display-list", Fx_display_list, Sx_display_list, 0, 0, 0,
4967 doc: /* Return the list of display names that Emacs has connections to. */)
4968 (void)
4970 Lisp_Object tail, result;
4972 result = Qnil;
4973 for (tail = w32_display_name_list; CONSP (tail); tail = XCDR (tail))
4974 result = Fcons (XCAR (XCAR (tail)), result);
4976 return result;
4979 DEFUN ("x-synchronize", Fx_synchronize, Sx_synchronize, 1, 2, 0,
4980 doc: /* If ON is non-nil, report X errors as soon as the erring request is made.
4981 This function only has an effect on X Windows. With MS Windows, it is
4982 defined but does nothing.
4984 If ON is nil, allow buffering of requests.
4985 Turning on synchronization prohibits the Xlib routines from buffering
4986 requests and seriously degrades performance, but makes debugging much
4987 easier.
4988 The optional second argument TERMINAL specifies which display to act on.
4989 TERMINAL should be a terminal object, a frame or a display name (a string).
4990 If TERMINAL is omitted or nil, that stands for the selected frame's display. */)
4991 (Lisp_Object on, Lisp_Object display)
4993 return Qnil;
4998 /***********************************************************************
4999 Window properties
5000 ***********************************************************************/
5002 DEFUN ("x-change-window-property", Fx_change_window_property,
5003 Sx_change_window_property, 2, 6, 0,
5004 doc: /* Change window property PROP to VALUE on the X window of FRAME.
5005 PROP must be a string. VALUE may be a string or a list of conses,
5006 numbers and/or strings. If an element in the list is a string, it is
5007 converted to an atom and the value of the Atom is used. If an element
5008 is a cons, it is converted to a 32 bit number where the car is the 16
5009 top bits and the cdr is the lower 16 bits.
5011 FRAME nil or omitted means use the selected frame.
5012 If TYPE is given and non-nil, it is the name of the type of VALUE.
5013 If TYPE is not given or nil, the type is STRING.
5014 FORMAT gives the size in bits of each element if VALUE is a list.
5015 It must be one of 8, 16 or 32.
5016 If VALUE is a string or FORMAT is nil or not given, FORMAT defaults to 8.
5017 If OUTER_P is non-nil, the property is changed for the outer X window of
5018 FRAME. Default is to change on the edit X window. */)
5019 (Lisp_Object prop, Lisp_Object value, Lisp_Object frame, Lisp_Object type, Lisp_Object format, Lisp_Object outer_p)
5021 #if 0 /* TODO : port window properties to W32 */
5022 struct frame *f = check_x_frame (frame);
5023 Atom prop_atom;
5025 CHECK_STRING (prop);
5026 CHECK_STRING (value);
5028 BLOCK_INPUT;
5029 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5030 XChangeProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5031 prop_atom, XA_STRING, 8, PropModeReplace,
5032 SDATA (value), SCHARS (value));
5034 /* Make sure the property is set when we return. */
5035 XFlush (FRAME_W32_DISPLAY (f));
5036 UNBLOCK_INPUT;
5038 #endif /* TODO */
5040 return value;
5044 DEFUN ("x-delete-window-property", Fx_delete_window_property,
5045 Sx_delete_window_property, 1, 2, 0,
5046 doc: /* Remove window property PROP from X window of FRAME.
5047 FRAME nil or omitted means use the selected frame. Value is PROP. */)
5048 (Lisp_Object prop, Lisp_Object frame)
5050 #if 0 /* TODO : port window properties to W32 */
5052 struct frame *f = check_x_frame (frame);
5053 Atom prop_atom;
5055 CHECK_STRING (prop);
5056 BLOCK_INPUT;
5057 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5058 XDeleteProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f), prop_atom);
5060 /* Make sure the property is removed when we return. */
5061 XFlush (FRAME_W32_DISPLAY (f));
5062 UNBLOCK_INPUT;
5063 #endif /* TODO */
5065 return prop;
5069 DEFUN ("x-window-property", Fx_window_property, Sx_window_property,
5070 1, 2, 0,
5071 doc: /* Value is the value of window property PROP on FRAME.
5072 If FRAME is nil or omitted, use the selected frame.
5074 On MS Windows, this function only accepts the PROP and FRAME arguments.
5076 On X Windows, the following optional arguments are also accepted:
5077 If TYPE is nil or omitted, get the property as a string.
5078 Otherwise TYPE is the name of the atom that denotes the type expected.
5079 If SOURCE is non-nil, get the property on that window instead of from
5080 FRAME. The number 0 denotes the root window.
5081 If DELETE_P is non-nil, delete the property after retreiving it.
5082 If VECTOR_RET_P is non-nil, don't return a string but a vector of values.
5084 Value is nil if FRAME hasn't a property with name PROP or if PROP has
5085 no value of TYPE (always string in the MS Windows case). */)
5086 (Lisp_Object prop, Lisp_Object frame)
5088 #if 0 /* TODO : port window properties to W32 */
5090 struct frame *f = check_x_frame (frame);
5091 Atom prop_atom;
5092 int rc;
5093 Lisp_Object prop_value = Qnil;
5094 char *tmp_data = NULL;
5095 Atom actual_type;
5096 int actual_format;
5097 unsigned long actual_size, bytes_remaining;
5099 CHECK_STRING (prop);
5100 BLOCK_INPUT;
5101 prop_atom = XInternAtom (FRAME_W32_DISPLAY (f), SDATA (prop), False);
5102 rc = XGetWindowProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5103 prop_atom, 0, 0, False, XA_STRING,
5104 &actual_type, &actual_format, &actual_size,
5105 &bytes_remaining, (unsigned char **) &tmp_data);
5106 if (rc == Success)
5108 int size = bytes_remaining;
5110 XFree (tmp_data);
5111 tmp_data = NULL;
5113 rc = XGetWindowProperty (FRAME_W32_DISPLAY (f), FRAME_W32_WINDOW (f),
5114 prop_atom, 0, bytes_remaining,
5115 False, XA_STRING,
5116 &actual_type, &actual_format,
5117 &actual_size, &bytes_remaining,
5118 (unsigned char **) &tmp_data);
5119 if (rc == Success)
5120 prop_value = make_string (tmp_data, size);
5122 XFree (tmp_data);
5125 UNBLOCK_INPUT;
5127 return prop_value;
5129 #endif /* TODO */
5130 return Qnil;
5135 /***********************************************************************
5136 Busy cursor
5137 ***********************************************************************/
5139 /* Default number of seconds to wait before displaying an hourglass
5140 cursor. Duplicated from xdisp.c, but cannot use the version there
5141 due to lack of atimers on w32. */
5142 #define DEFAULT_HOURGLASS_DELAY 1
5143 extern Lisp_Object Vhourglass_delay;
5145 /* Return non-zero if houglass timer has been started or hourglass is shown. */
5146 /* PENDING: if W32 can use atimers (atimer.[hc]) then the common impl in
5147 xdisp.c could be used. */
5150 hourglass_started (void)
5152 return hourglass_shown_p || hourglass_timer;
5155 /* Cancel a currently active hourglass timer, and start a new one. */
5157 void
5158 start_hourglass (void)
5160 DWORD delay;
5161 int secs, msecs = 0;
5162 struct frame * f = SELECTED_FRAME ();
5164 /* No cursors on non GUI frames. */
5165 if (!FRAME_W32_P (f))
5166 return;
5168 cancel_hourglass ();
5170 if (INTEGERP (Vhourglass_delay)
5171 && XINT (Vhourglass_delay) > 0)
5172 secs = XFASTINT (Vhourglass_delay);
5173 else if (FLOATP (Vhourglass_delay)
5174 && XFLOAT_DATA (Vhourglass_delay) > 0)
5176 Lisp_Object tem;
5177 tem = Ftruncate (Vhourglass_delay, Qnil);
5178 secs = XFASTINT (tem);
5179 msecs = (XFLOAT_DATA (Vhourglass_delay) - secs) * 1000;
5181 else
5182 secs = DEFAULT_HOURGLASS_DELAY;
5184 delay = secs * 1000 + msecs;
5185 hourglass_hwnd = FRAME_W32_WINDOW (f);
5186 hourglass_timer = SetTimer (hourglass_hwnd, HOURGLASS_ID, delay, NULL);
5190 /* Cancel the hourglass cursor timer if active, hide an hourglass
5191 cursor if shown. */
5193 void
5194 cancel_hourglass (void)
5196 if (hourglass_timer)
5198 KillTimer (hourglass_hwnd, hourglass_timer);
5199 hourglass_timer = 0;
5202 if (hourglass_shown_p)
5203 w32_hide_hourglass ();
5207 /* Timer function of hourglass_timer.
5209 Display an hourglass cursor. Set the hourglass_p flag in display info
5210 to indicate that an hourglass cursor is shown. */
5212 static void
5213 w32_show_hourglass (struct frame *f)
5215 if (!hourglass_shown_p)
5217 f->output_data.w32->hourglass_p = 1;
5218 if (!menubar_in_use && !current_popup_menu)
5219 SetCursor (f->output_data.w32->hourglass_cursor);
5220 hourglass_shown_p = 1;
5225 /* Hide the hourglass cursor on all frames, if it is currently shown. */
5227 static void
5228 w32_hide_hourglass (void)
5230 if (hourglass_shown_p)
5232 struct frame *f = x_window_to_frame (&one_w32_display_info,
5233 hourglass_hwnd);
5234 if (f)
5235 f->output_data.w32->hourglass_p = 0;
5236 else
5237 /* If frame was deleted, restore to selected frame's cursor. */
5238 f = SELECTED_FRAME ();
5240 if (FRAME_W32_P (f))
5241 SetCursor (f->output_data.w32->current_cursor);
5242 else
5243 /* No cursors on non GUI frames - restore to stock arrow cursor. */
5244 SetCursor (w32_load_cursor (IDC_ARROW));
5246 hourglass_shown_p = 0;
5252 /***********************************************************************
5253 Tool tips
5254 ***********************************************************************/
5256 static Lisp_Object x_create_tip_frame (struct w32_display_info *,
5257 Lisp_Object, Lisp_Object);
5258 static void compute_tip_xy (struct frame *, Lisp_Object, Lisp_Object,
5259 Lisp_Object, int, int, int *, int *);
5261 /* The frame of a currently visible tooltip. */
5263 Lisp_Object tip_frame;
5265 /* If non-nil, a timer started that hides the last tooltip when it
5266 fires. */
5268 Lisp_Object tip_timer;
5269 Window tip_window;
5271 /* If non-nil, a vector of 3 elements containing the last args
5272 with which x-show-tip was called. See there. */
5274 Lisp_Object last_show_tip_args;
5276 /* Maximum size for tooltips; a cons (COLUMNS . ROWS). */
5278 Lisp_Object Vx_max_tooltip_size;
5281 static Lisp_Object
5282 unwind_create_tip_frame (Lisp_Object frame)
5284 Lisp_Object deleted;
5286 deleted = unwind_create_frame (frame);
5287 if (EQ (deleted, Qt))
5289 tip_window = NULL;
5290 tip_frame = Qnil;
5293 return deleted;
5297 /* Create a frame for a tooltip on the display described by DPYINFO.
5298 PARMS is a list of frame parameters. TEXT is the string to
5299 display in the tip frame. Value is the frame.
5301 Note that functions called here, esp. x_default_parameter can
5302 signal errors, for instance when a specified color name is
5303 undefined. We have to make sure that we're in a consistent state
5304 when this happens. */
5306 static Lisp_Object
5307 x_create_tip_frame (struct w32_display_info *dpyinfo,
5308 Lisp_Object parms, Lisp_Object text)
5310 struct frame *f;
5311 Lisp_Object frame, tem;
5312 Lisp_Object name;
5313 long window_prompting = 0;
5314 int width, height;
5315 int count = SPECPDL_INDEX ();
5316 struct gcpro gcpro1, gcpro2, gcpro3;
5317 struct kboard *kb;
5318 int face_change_count_before = face_change_count;
5319 Lisp_Object buffer;
5320 struct buffer *old_buffer;
5322 check_w32 ();
5324 /* Use this general default value to start with until we know if
5325 this frame has a specified name. */
5326 Vx_resource_name = Vinvocation_name;
5328 kb = dpyinfo->terminal->kboard;
5330 /* The calls to x_get_arg remove elements from PARMS, so copy it to
5331 avoid destructive changes behind our caller's back. */
5332 parms = Fcopy_alist (parms);
5334 /* Get the name of the frame to use for resource lookup. */
5335 name = x_get_arg (dpyinfo, parms, Qname, "name", "Name", RES_TYPE_STRING);
5336 if (!STRINGP (name)
5337 && !EQ (name, Qunbound)
5338 && !NILP (name))
5339 error ("Invalid frame name--not a string or nil");
5340 Vx_resource_name = name;
5342 frame = Qnil;
5343 GCPRO3 (parms, name, frame);
5344 /* Make a frame without minibuffer nor mode-line. */
5345 f = make_frame (0);
5346 f->wants_modeline = 0;
5347 XSETFRAME (frame, f);
5349 buffer = Fget_buffer_create (build_string (" *tip*"));
5350 Fset_window_buffer (FRAME_ROOT_WINDOW (f), buffer, Qnil);
5351 old_buffer = current_buffer;
5352 set_buffer_internal_1 (XBUFFER (buffer));
5353 current_buffer->truncate_lines = Qnil;
5354 specbind (Qinhibit_read_only, Qt);
5355 specbind (Qinhibit_modification_hooks, Qt);
5356 Ferase_buffer ();
5357 Finsert (1, &text);
5358 set_buffer_internal_1 (old_buffer);
5360 FRAME_CAN_HAVE_SCROLL_BARS (f) = 0;
5361 record_unwind_protect (unwind_create_tip_frame, frame);
5363 /* By setting the output method, we're essentially saying that
5364 the frame is live, as per FRAME_LIVE_P. If we get a signal
5365 from this point on, x_destroy_window might screw up reference
5366 counts etc. */
5367 f->terminal = dpyinfo->terminal;
5368 f->terminal->reference_count++;
5369 f->output_method = output_w32;
5370 f->output_data.w32 =
5371 (struct w32_output *) xmalloc (sizeof (struct w32_output));
5372 memset (f->output_data.w32, 0, sizeof (struct w32_output));
5374 FRAME_FONTSET (f) = -1;
5375 f->icon_name = Qnil;
5377 #if GLYPH_DEBUG
5378 image_cache_refcount = FRAME_IMAGE_CACHE (f)->refcount;
5379 dpyinfo_refcount = dpyinfo->reference_count;
5380 #endif /* GLYPH_DEBUG */
5381 FRAME_KBOARD (f) = kb;
5382 f->output_data.w32->parent_desc = FRAME_W32_DISPLAY_INFO (f)->root_window;
5383 f->output_data.w32->explicit_parent = 0;
5385 /* Set the name; the functions to which we pass f expect the name to
5386 be set. */
5387 if (EQ (name, Qunbound) || NILP (name))
5389 f->name = build_string (dpyinfo->w32_id_name);
5390 f->explicit_name = 0;
5392 else
5394 f->name = name;
5395 f->explicit_name = 1;
5396 /* use the frame's title when getting resources for this frame. */
5397 specbind (Qx_resource_name, name);
5400 f->resx = dpyinfo->resx;
5401 f->resy = dpyinfo->resy;
5403 if (uniscribe_available)
5404 register_font_driver (&uniscribe_font_driver, f);
5405 register_font_driver (&w32font_driver, f);
5407 x_default_parameter (f, parms, Qfont_backend, Qnil,
5408 "fontBackend", "FontBackend", RES_TYPE_STRING);
5410 /* Extract the window parameters from the supplied values
5411 that are needed to determine window geometry. */
5412 x_default_font_parameter (f, parms);
5414 x_default_parameter (f, parms, Qborder_width, make_number (2),
5415 "borderWidth", "BorderWidth", RES_TYPE_NUMBER);
5416 /* This defaults to 2 in order to match xterm. We recognize either
5417 internalBorderWidth or internalBorder (which is what xterm calls
5418 it). */
5419 if (NILP (Fassq (Qinternal_border_width, parms)))
5421 Lisp_Object value;
5423 value = x_get_arg (dpyinfo, parms, Qinternal_border_width,
5424 "internalBorder", "internalBorder", RES_TYPE_NUMBER);
5425 if (! EQ (value, Qunbound))
5426 parms = Fcons (Fcons (Qinternal_border_width, value),
5427 parms);
5429 x_default_parameter (f, parms, Qinternal_border_width, make_number (1),
5430 "internalBorderWidth", "internalBorderWidth",
5431 RES_TYPE_NUMBER);
5433 /* Also do the stuff which must be set before the window exists. */
5434 x_default_parameter (f, parms, Qforeground_color, build_string ("black"),
5435 "foreground", "Foreground", RES_TYPE_STRING);
5436 x_default_parameter (f, parms, Qbackground_color, build_string ("white"),
5437 "background", "Background", RES_TYPE_STRING);
5438 x_default_parameter (f, parms, Qmouse_color, build_string ("black"),
5439 "pointerColor", "Foreground", RES_TYPE_STRING);
5440 x_default_parameter (f, parms, Qcursor_color, build_string ("black"),
5441 "cursorColor", "Foreground", RES_TYPE_STRING);
5442 x_default_parameter (f, parms, Qborder_color, build_string ("black"),
5443 "borderColor", "BorderColor", RES_TYPE_STRING);
5445 /* Init faces before x_default_parameter is called for scroll-bar
5446 parameters because that function calls x_set_scroll_bar_width,
5447 which calls change_frame_size, which calls Fset_window_buffer,
5448 which runs hooks, which call Fvertical_motion. At the end, we
5449 end up in init_iterator with a null face cache, which should not
5450 happen. */
5451 init_frame_faces (f);
5453 f->output_data.w32->dwStyle = WS_BORDER | WS_POPUP | WS_DISABLED;
5454 f->output_data.w32->parent_desc = FRAME_W32_DISPLAY_INFO (f)->root_window;
5456 window_prompting = x_figure_window_size (f, parms, 0);
5458 /* No fringes on tip frame. */
5459 f->fringe_cols = 0;
5460 f->left_fringe_width = 0;
5461 f->right_fringe_width = 0;
5463 BLOCK_INPUT;
5464 my_create_tip_window (f);
5465 UNBLOCK_INPUT;
5467 x_make_gc (f);
5469 x_default_parameter (f, parms, Qauto_raise, Qnil,
5470 "autoRaise", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5471 x_default_parameter (f, parms, Qauto_lower, Qnil,
5472 "autoLower", "AutoRaiseLower", RES_TYPE_BOOLEAN);
5473 x_default_parameter (f, parms, Qcursor_type, Qbox,
5474 "cursorType", "CursorType", RES_TYPE_SYMBOL);
5476 /* Dimensions, especially FRAME_LINES (f), must be done via change_frame_size.
5477 Change will not be effected unless different from the current
5478 FRAME_LINES (f). */
5479 width = FRAME_COLS (f);
5480 height = FRAME_LINES (f);
5481 FRAME_LINES (f) = 0;
5482 SET_FRAME_COLS (f, 0);
5483 change_frame_size (f, height, width, 1, 0, 0);
5485 /* Add `tooltip' frame parameter's default value. */
5486 if (NILP (Fframe_parameter (frame, Qtooltip)))
5487 Fmodify_frame_parameters (frame, Fcons (Fcons (Qtooltip, Qt), Qnil));
5489 /* Set up faces after all frame parameters are known. This call
5490 also merges in face attributes specified for new frames.
5492 Frame parameters may be changed if .Xdefaults contains
5493 specifications for the default font. For example, if there is an
5494 `Emacs.default.attributeBackground: pink', the `background-color'
5495 attribute of the frame get's set, which let's the internal border
5496 of the tooltip frame appear in pink. Prevent this. */
5498 Lisp_Object bg = Fframe_parameter (frame, Qbackground_color);
5499 Lisp_Object fg = Fframe_parameter (frame, Qforeground_color);
5500 Lisp_Object colors = Qnil;
5502 /* Set tip_frame here, so that */
5503 tip_frame = frame;
5504 call2 (Qface_set_after_frame_default, frame, Qnil);
5506 if (!EQ (bg, Fframe_parameter (frame, Qbackground_color)))
5507 colors = Fcons (Fcons (Qbackground_color, bg), colors);
5508 if (!EQ (fg, Fframe_parameter (frame, Qforeground_color)))
5509 colors = Fcons (Fcons (Qforeground_color, fg), colors);
5511 if (!NILP (colors))
5512 Fmodify_frame_parameters (frame, colors);
5515 f->no_split = 1;
5517 UNGCPRO;
5519 /* It is now ok to make the frame official even if we get an error
5520 below. And the frame needs to be on Vframe_list or making it
5521 visible won't work. */
5522 Vframe_list = Fcons (frame, Vframe_list);
5524 /* Now that the frame is official, it counts as a reference to
5525 its display. */
5526 FRAME_W32_DISPLAY_INFO (f)->reference_count++;
5528 /* Setting attributes of faces of the tooltip frame from resources
5529 and similar will increment face_change_count, which leads to the
5530 clearing of all current matrices. Since this isn't necessary
5531 here, avoid it by resetting face_change_count to the value it
5532 had before we created the tip frame. */
5533 face_change_count = face_change_count_before;
5535 /* Discard the unwind_protect. */
5536 return unbind_to (count, frame);
5540 /* Compute where to display tip frame F. PARMS is the list of frame
5541 parameters for F. DX and DY are specified offsets from the current
5542 location of the mouse. WIDTH and HEIGHT are the width and height
5543 of the tooltip. Return coordinates relative to the root window of
5544 the display in *ROOT_X, and *ROOT_Y. */
5546 static void
5547 compute_tip_xy (struct frame *f,
5548 Lisp_Object parms, Lisp_Object dx, Lisp_Object dy,
5549 int width, int height, int *root_x, int *root_y)
5551 Lisp_Object left, top;
5552 int min_x, min_y, max_x, max_y;
5554 /* User-specified position? */
5555 left = Fcdr (Fassq (Qleft, parms));
5556 top = Fcdr (Fassq (Qtop, parms));
5558 /* Move the tooltip window where the mouse pointer is. Resize and
5559 show it. */
5560 if (!INTEGERP (left) || !INTEGERP (top))
5562 POINT pt;
5564 /* Default min and max values. */
5565 min_x = 0;
5566 min_y = 0;
5567 max_x = x_display_pixel_width (FRAME_W32_DISPLAY_INFO (f));
5568 max_y = x_display_pixel_height (FRAME_W32_DISPLAY_INFO (f));
5570 BLOCK_INPUT;
5571 GetCursorPos (&pt);
5572 *root_x = pt.x;
5573 *root_y = pt.y;
5574 UNBLOCK_INPUT;
5576 /* If multiple monitor support is available, constrain the tip onto
5577 the current monitor. This improves the above by allowing negative
5578 co-ordinates if monitor positions are such that they are valid, and
5579 snaps a tooltip onto a single monitor if we are close to the edge
5580 where it would otherwise flow onto the other monitor (or into
5581 nothingness if there is a gap in the overlap). */
5582 if (monitor_from_point_fn && get_monitor_info_fn)
5584 struct MONITOR_INFO info;
5585 HMONITOR monitor
5586 = monitor_from_point_fn (pt, MONITOR_DEFAULT_TO_NEAREST);
5587 info.cbSize = sizeof (info);
5589 if (get_monitor_info_fn (monitor, &info))
5591 min_x = info.rcWork.left;
5592 min_y = info.rcWork.top;
5593 max_x = info.rcWork.right;
5594 max_y = info.rcWork.bottom;
5599 if (INTEGERP (top))
5600 *root_y = XINT (top);
5601 else if (*root_y + XINT (dy) <= min_y)
5602 *root_y = min_y; /* Can happen for negative dy */
5603 else if (*root_y + XINT (dy) + height <= max_y)
5604 /* It fits below the pointer */
5605 *root_y += XINT (dy);
5606 else if (height + XINT (dy) + min_y <= *root_y)
5607 /* It fits above the pointer. */
5608 *root_y -= height + XINT (dy);
5609 else
5610 /* Put it on the top. */
5611 *root_y = min_y;
5613 if (INTEGERP (left))
5614 *root_x = XINT (left);
5615 else if (*root_x + XINT (dx) <= min_x)
5616 *root_x = 0; /* Can happen for negative dx */
5617 else if (*root_x + XINT (dx) + width <= max_x)
5618 /* It fits to the right of the pointer. */
5619 *root_x += XINT (dx);
5620 else if (width + XINT (dx) + min_x <= *root_x)
5621 /* It fits to the left of the pointer. */
5622 *root_x -= width + XINT (dx);
5623 else
5624 /* Put it left justified on the screen -- it ought to fit that way. */
5625 *root_x = min_x;
5629 DEFUN ("x-show-tip", Fx_show_tip, Sx_show_tip, 1, 6, 0,
5630 doc: /* Show STRING in a \"tooltip\" window on frame FRAME.
5631 A tooltip window is a small window displaying a string.
5633 This is an internal function; Lisp code should call `tooltip-show'.
5635 FRAME nil or omitted means use the selected frame.
5637 PARMS is an optional list of frame parameters which can be
5638 used to change the tooltip's appearance.
5640 Automatically hide the tooltip after TIMEOUT seconds. TIMEOUT nil
5641 means use the default timeout of 5 seconds.
5643 If the list of frame parameters PARMS contains a `left' parameter,
5644 the tooltip is displayed at that x-position. Otherwise it is
5645 displayed at the mouse position, with offset DX added (default is 5 if
5646 DX isn't specified). Likewise for the y-position; if a `top' frame
5647 parameter is specified, it determines the y-position of the tooltip
5648 window, otherwise it is displayed at the mouse position, with offset
5649 DY added (default is -10).
5651 A tooltip's maximum size is specified by `x-max-tooltip-size'.
5652 Text larger than the specified size is clipped. */)
5653 (Lisp_Object string, Lisp_Object frame, Lisp_Object parms, Lisp_Object timeout, Lisp_Object dx, Lisp_Object dy)
5655 struct frame *f;
5656 struct window *w;
5657 int root_x, root_y;
5658 struct buffer *old_buffer;
5659 struct text_pos pos;
5660 int i, width, height, seen_reversed_p;
5661 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
5662 int old_windows_or_buffers_changed = windows_or_buffers_changed;
5663 int count = SPECPDL_INDEX ();
5665 specbind (Qinhibit_redisplay, Qt);
5667 GCPRO4 (string, parms, frame, timeout);
5669 CHECK_STRING (string);
5670 f = check_x_frame (frame);
5671 if (NILP (timeout))
5672 timeout = make_number (5);
5673 else
5674 CHECK_NATNUM (timeout);
5676 if (NILP (dx))
5677 dx = make_number (5);
5678 else
5679 CHECK_NUMBER (dx);
5681 if (NILP (dy))
5682 dy = make_number (-10);
5683 else
5684 CHECK_NUMBER (dy);
5686 if (NILP (last_show_tip_args))
5687 last_show_tip_args = Fmake_vector (make_number (3), Qnil);
5689 if (!NILP (tip_frame))
5691 Lisp_Object last_string = AREF (last_show_tip_args, 0);
5692 Lisp_Object last_frame = AREF (last_show_tip_args, 1);
5693 Lisp_Object last_parms = AREF (last_show_tip_args, 2);
5695 if (EQ (frame, last_frame)
5696 && !NILP (Fequal (last_string, string))
5697 && !NILP (Fequal (last_parms, parms)))
5699 struct frame *f = XFRAME (tip_frame);
5701 /* Only DX and DY have changed. */
5702 if (!NILP (tip_timer))
5704 Lisp_Object timer = tip_timer;
5705 tip_timer = Qnil;
5706 call1 (Qcancel_timer, timer);
5709 BLOCK_INPUT;
5710 compute_tip_xy (f, parms, dx, dy, FRAME_PIXEL_WIDTH (f),
5711 FRAME_PIXEL_HEIGHT (f), &root_x, &root_y);
5713 /* Put tooltip in topmost group and in position. */
5714 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOPMOST,
5715 root_x, root_y, 0, 0,
5716 SWP_NOSIZE | SWP_NOACTIVATE);
5718 /* Ensure tooltip is on top of other topmost windows (eg menus). */
5719 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOP,
5720 0, 0, 0, 0,
5721 SWP_NOMOVE | SWP_NOSIZE | SWP_NOACTIVATE);
5723 UNBLOCK_INPUT;
5724 goto start_timer;
5728 /* Hide a previous tip, if any. */
5729 Fx_hide_tip ();
5731 ASET (last_show_tip_args, 0, string);
5732 ASET (last_show_tip_args, 1, frame);
5733 ASET (last_show_tip_args, 2, parms);
5735 /* Add default values to frame parameters. */
5736 if (NILP (Fassq (Qname, parms)))
5737 parms = Fcons (Fcons (Qname, build_string ("tooltip")), parms);
5738 if (NILP (Fassq (Qinternal_border_width, parms)))
5739 parms = Fcons (Fcons (Qinternal_border_width, make_number (3)), parms);
5740 if (NILP (Fassq (Qborder_width, parms)))
5741 parms = Fcons (Fcons (Qborder_width, make_number (1)), parms);
5742 if (NILP (Fassq (Qborder_color, parms)))
5743 parms = Fcons (Fcons (Qborder_color, build_string ("lightyellow")), parms);
5744 if (NILP (Fassq (Qbackground_color, parms)))
5745 parms = Fcons (Fcons (Qbackground_color, build_string ("lightyellow")),
5746 parms);
5748 /* Block input until the tip has been fully drawn, to avoid crashes
5749 when drawing tips in menus. */
5750 BLOCK_INPUT;
5752 /* Create a frame for the tooltip, and record it in the global
5753 variable tip_frame. */
5754 frame = x_create_tip_frame (FRAME_W32_DISPLAY_INFO (f), parms, string);
5755 f = XFRAME (frame);
5757 /* Set up the frame's root window. */
5758 w = XWINDOW (FRAME_ROOT_WINDOW (f));
5759 w->left_col = w->top_line = make_number (0);
5761 if (CONSP (Vx_max_tooltip_size)
5762 && INTEGERP (XCAR (Vx_max_tooltip_size))
5763 && XINT (XCAR (Vx_max_tooltip_size)) > 0
5764 && INTEGERP (XCDR (Vx_max_tooltip_size))
5765 && XINT (XCDR (Vx_max_tooltip_size)) > 0)
5767 w->total_cols = XCAR (Vx_max_tooltip_size);
5768 w->total_lines = XCDR (Vx_max_tooltip_size);
5770 else
5772 w->total_cols = make_number (80);
5773 w->total_lines = make_number (40);
5776 FRAME_TOTAL_COLS (f) = XINT (w->total_cols);
5777 adjust_glyphs (f);
5778 w->pseudo_window_p = 1;
5780 /* Display the tooltip text in a temporary buffer. */
5781 old_buffer = current_buffer;
5782 set_buffer_internal_1 (XBUFFER (XWINDOW (FRAME_ROOT_WINDOW (f))->buffer));
5783 current_buffer->truncate_lines = Qnil;
5784 clear_glyph_matrix (w->desired_matrix);
5785 clear_glyph_matrix (w->current_matrix);
5786 SET_TEXT_POS (pos, BEGV, BEGV_BYTE);
5787 try_window (FRAME_ROOT_WINDOW (f), pos, 0);
5789 /* Compute width and height of the tooltip. */
5790 width = height = seen_reversed_p = 0;
5791 for (i = 0; i < w->desired_matrix->nrows; ++i)
5793 struct glyph_row *row = &w->desired_matrix->rows[i];
5794 struct glyph *last;
5795 int row_width;
5797 /* Stop at the first empty row at the end. */
5798 if (!row->enabled_p || !row->displays_text_p)
5799 break;
5801 /* Let the row go over the full width of the frame. */
5802 row->full_width_p = 1;
5804 row_width = row->pixel_width;
5805 if (row->used[TEXT_AREA])
5807 if (!row->reversed_p)
5809 #ifdef TODO /* Investigate why some fonts need more width than is
5810 calculated for some tooltips. */
5812 /* There's a glyph at the end of rows that is used to
5813 place the cursor there. Don't include the width of
5814 this glyph. */
5815 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5816 if (INTEGERP (last->object))
5817 row_width -= last->pixel_width;
5818 #endif
5820 else
5822 /* There could be a stretch glyph at the beginning of R2L
5823 rows that is produced by extend_face_to_end_of_line.
5824 Don't count that glyph. */
5825 struct glyph *g = row->glyphs[TEXT_AREA];
5827 if (g->type == STRETCH_GLYPH && INTEGERP (g->object))
5829 row_width -= g->pixel_width;
5830 seen_reversed_p = 1;
5835 /* TODO: find why tips do not draw along baseline as instructed. */
5836 height += row->height;
5837 width = max (width, row_width);
5840 /* If we've seen partial-length R2L rows, we need to re-adjust the
5841 tool-tip frame width and redisplay it again, to avoid over-wide
5842 tips due to the stretch glyph that extends R2L lines to full
5843 width of the frame. */
5844 if (seen_reversed_p)
5846 /* w->total_cols and FRAME_TOTAL_COLS want the width in columns,
5847 not in pixels. */
5848 width /= WINDOW_FRAME_COLUMN_WIDTH (w);
5849 w->total_cols = make_number (width);
5850 FRAME_TOTAL_COLS (f) = width;
5851 adjust_glyphs (f);
5852 clear_glyph_matrix (w->desired_matrix);
5853 clear_glyph_matrix (w->current_matrix);
5854 try_window (FRAME_ROOT_WINDOW (f), pos, 0);
5855 width = height = 0;
5856 /* Recompute width and height of the tooltip. */
5857 for (i = 0; i < w->desired_matrix->nrows; ++i)
5859 struct glyph_row *row = &w->desired_matrix->rows[i];
5860 struct glyph *last;
5861 int row_width;
5863 if (!row->enabled_p || !row->displays_text_p)
5864 break;
5865 row->full_width_p = 1;
5866 row_width = row->pixel_width;
5867 #ifdef TODO /* See above. */
5868 if (row->used[TEXT_AREA] && !row->reversed_p)
5870 last = &row->glyphs[TEXT_AREA][row->used[TEXT_AREA] - 1];
5871 if (INTEGERP (last->object))
5872 row_width -= last->pixel_width;
5874 #endif
5876 height += row->height;
5877 width = max (width, row_width);
5881 /* Add the frame's internal border to the width and height the X
5882 window should have. */
5883 height += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5884 width += 2 * FRAME_INTERNAL_BORDER_WIDTH (f);
5886 /* Move the tooltip window where the mouse pointer is. Resize and
5887 show it. */
5888 compute_tip_xy (f, parms, dx, dy, width, height, &root_x, &root_y);
5891 /* Adjust Window size to take border into account. */
5892 RECT rect;
5893 rect.left = rect.top = 0;
5894 rect.right = width;
5895 rect.bottom = height;
5896 AdjustWindowRect (&rect, f->output_data.w32->dwStyle,
5897 FRAME_EXTERNAL_MENU_BAR (f));
5899 /* Position and size tooltip, and put it in the topmost group.
5900 The add-on of 3 to the 5th argument is a kludge: without it,
5901 some fonts cause the last character of the tip to be truncated,
5902 for some obscure reason. */
5903 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOPMOST,
5904 root_x, root_y, rect.right - rect.left + 3,
5905 rect.bottom - rect.top, SWP_NOACTIVATE);
5907 /* Ensure tooltip is on top of other topmost windows (eg menus). */
5908 SetWindowPos (FRAME_W32_WINDOW (f), HWND_TOP,
5909 0, 0, 0, 0,
5910 SWP_NOMOVE | SWP_NOSIZE | SWP_NOACTIVATE);
5912 /* Let redisplay know that we have made the frame visible already. */
5913 f->async_visible = 1;
5915 ShowWindow (FRAME_W32_WINDOW (f), SW_SHOWNOACTIVATE);
5918 /* Draw into the window. */
5919 w->must_be_updated_p = 1;
5920 update_single_window (w, 1);
5922 UNBLOCK_INPUT;
5924 /* Restore original current buffer. */
5925 set_buffer_internal_1 (old_buffer);
5926 windows_or_buffers_changed = old_windows_or_buffers_changed;
5928 start_timer:
5929 /* Let the tip disappear after timeout seconds. */
5930 tip_timer = call3 (intern ("run-at-time"), timeout, Qnil,
5931 intern ("x-hide-tip"));
5933 UNGCPRO;
5934 return unbind_to (count, Qnil);
5938 DEFUN ("x-hide-tip", Fx_hide_tip, Sx_hide_tip, 0, 0, 0,
5939 doc: /* Hide the current tooltip window, if there is any.
5940 Value is t if tooltip was open, nil otherwise. */)
5941 (void)
5943 int count;
5944 Lisp_Object deleted, frame, timer;
5945 struct gcpro gcpro1, gcpro2;
5947 /* Return quickly if nothing to do. */
5948 if (NILP (tip_timer) && NILP (tip_frame))
5949 return Qnil;
5951 frame = tip_frame;
5952 timer = tip_timer;
5953 GCPRO2 (frame, timer);
5954 tip_frame = tip_timer = deleted = Qnil;
5956 count = SPECPDL_INDEX ();
5957 specbind (Qinhibit_redisplay, Qt);
5958 specbind (Qinhibit_quit, Qt);
5960 if (!NILP (timer))
5961 call1 (Qcancel_timer, timer);
5963 if (FRAMEP (frame))
5965 delete_frame (frame, Qnil);
5966 deleted = Qt;
5969 UNGCPRO;
5970 return unbind_to (count, deleted);
5975 /***********************************************************************
5976 File selection dialog
5977 ***********************************************************************/
5978 extern Lisp_Object Qfile_name_history;
5980 /* Callback for altering the behavior of the Open File dialog.
5981 Makes the Filename text field contain "Current Directory" and be
5982 read-only when "Directories" is selected in the filter. This
5983 allows us to work around the fact that the standard Open File
5984 dialog does not support directories. */
5985 static UINT CALLBACK
5986 file_dialog_callback (HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam)
5988 if (msg == WM_NOTIFY)
5990 OFNOTIFY * notify = (OFNOTIFY *)lParam;
5991 /* Detect when the Filter dropdown is changed. */
5992 if (notify->hdr.code == CDN_TYPECHANGE
5993 || notify->hdr.code == CDN_INITDONE)
5995 HWND dialog = GetParent (hwnd);
5996 HWND edit_control = GetDlgItem (dialog, FILE_NAME_TEXT_FIELD);
5998 /* Directories is in index 2. */
5999 if (notify->lpOFN->nFilterIndex == 2)
6001 CommDlg_OpenSave_SetControlText (dialog, FILE_NAME_TEXT_FIELD,
6002 "Current Directory");
6003 EnableWindow (edit_control, FALSE);
6005 else
6007 /* Don't override default filename on init done. */
6008 if (notify->hdr.code == CDN_TYPECHANGE)
6009 CommDlg_OpenSave_SetControlText (dialog,
6010 FILE_NAME_TEXT_FIELD, "");
6011 EnableWindow (edit_control, TRUE);
6015 return 0;
6018 /* Since we compile with _WIN32_WINNT set to 0x0400 (for NT4 compatibility)
6019 we end up with the old file dialogs. Define a big enough struct for the
6020 new dialog to trick GetOpenFileName into giving us the new dialogs on
6021 Windows 2000 and XP. */
6022 typedef struct
6024 OPENFILENAME real_details;
6025 void * pReserved;
6026 DWORD dwReserved;
6027 DWORD FlagsEx;
6028 } NEWOPENFILENAME;
6031 DEFUN ("x-file-dialog", Fx_file_dialog, Sx_file_dialog, 2, 5, 0,
6032 doc: /* Read file name, prompting with PROMPT in directory DIR.
6033 Use a file selection dialog. Select DEFAULT-FILENAME in the dialog's file
6034 selection box, if specified. If MUSTMATCH is non-nil, the returned file
6035 or directory must exist.
6037 This function is only defined on MS Windows, and X Windows with the
6038 Motif or Gtk toolkits. With the Motif toolkit, ONLY-DIR-P is ignored.
6039 Otherwise, if ONLY-DIR-P is non-nil, the user can only select directories. */)
6040 (Lisp_Object prompt, Lisp_Object dir, Lisp_Object default_filename, Lisp_Object mustmatch, Lisp_Object only_dir_p)
6042 struct frame *f = SELECTED_FRAME ();
6043 Lisp_Object file = Qnil;
6044 int count = SPECPDL_INDEX ();
6045 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5, gcpro6;
6046 char filename[MAX_PATH + 1];
6047 char init_dir[MAX_PATH + 1];
6048 int default_filter_index = 1; /* 1: All Files, 2: Directories only */
6050 GCPRO6 (prompt, dir, default_filename, mustmatch, only_dir_p, file);
6051 CHECK_STRING (prompt);
6052 CHECK_STRING (dir);
6054 /* Create the dialog with PROMPT as title, using DIR as initial
6055 directory and using "*" as pattern. */
6056 dir = Fexpand_file_name (dir, Qnil);
6057 strncpy (init_dir, SDATA (ENCODE_FILE (dir)), MAX_PATH);
6058 init_dir[MAX_PATH] = '\0';
6059 unixtodos_filename (init_dir);
6061 if (STRINGP (default_filename))
6063 char *file_name_only;
6064 char *full_path_name = SDATA (ENCODE_FILE (default_filename));
6066 unixtodos_filename (full_path_name);
6068 file_name_only = strrchr (full_path_name, '\\');
6069 if (!file_name_only)
6070 file_name_only = full_path_name;
6071 else
6072 file_name_only++;
6074 strncpy (filename, file_name_only, MAX_PATH);
6075 filename[MAX_PATH] = '\0';
6077 else
6078 filename[0] = '\0';
6081 NEWOPENFILENAME new_file_details;
6082 BOOL file_opened = FALSE;
6083 OPENFILENAME * file_details = &new_file_details.real_details;
6085 /* Prevent redisplay. */
6086 specbind (Qinhibit_redisplay, Qt);
6087 BLOCK_INPUT;
6089 memset (&new_file_details, 0, sizeof (new_file_details));
6090 /* Apparently NT4 crashes if you give it an unexpected size.
6091 I'm not sure about Windows 9x, so play it safe. */
6092 if (w32_major_version > 4 && w32_major_version < 95)
6093 file_details->lStructSize = sizeof (NEWOPENFILENAME);
6094 else
6095 file_details->lStructSize = sizeof (OPENFILENAME);
6097 file_details->hwndOwner = FRAME_W32_WINDOW (f);
6098 /* Undocumented Bug in Common File Dialog:
6099 If a filter is not specified, shell links are not resolved. */
6100 file_details->lpstrFilter = "All Files (*.*)\0*.*\0Directories\0*|*\0\0";
6101 file_details->lpstrFile = filename;
6102 file_details->nMaxFile = sizeof (filename);
6103 file_details->lpstrInitialDir = init_dir;
6104 file_details->lpstrTitle = SDATA (prompt);
6106 if (! NILP (only_dir_p))
6107 default_filter_index = 2;
6109 file_details->nFilterIndex = default_filter_index;
6111 file_details->Flags = (OFN_HIDEREADONLY | OFN_NOCHANGEDIR
6112 | OFN_EXPLORER | OFN_ENABLEHOOK);
6113 if (!NILP (mustmatch))
6115 /* Require that the path to the parent directory exists. */
6116 file_details->Flags |= OFN_PATHMUSTEXIST;
6117 /* If we are looking for a file, require that it exists. */
6118 if (NILP (only_dir_p))
6119 file_details->Flags |= OFN_FILEMUSTEXIST;
6122 file_details->lpfnHook = (LPOFNHOOKPROC) file_dialog_callback;
6124 file_opened = GetOpenFileName (file_details);
6126 UNBLOCK_INPUT;
6128 if (file_opened)
6130 dostounix_filename (filename);
6132 if (file_details->nFilterIndex == 2)
6134 /* "Directories" selected - strip dummy file name. */
6135 char * last = strrchr (filename, '/');
6136 *last = '\0';
6139 file = DECODE_FILE (build_string (filename));
6141 /* User cancelled the dialog without making a selection. */
6142 else if (!CommDlgExtendedError ())
6143 file = Qnil;
6144 /* An error occurred, fallback on reading from the mini-buffer. */
6145 else
6146 file = Fcompleting_read (prompt, intern ("read-file-name-internal"),
6147 dir, mustmatch, dir, Qfile_name_history,
6148 default_filename, Qnil);
6150 file = unbind_to (count, file);
6153 UNGCPRO;
6155 /* Make "Cancel" equivalent to C-g. */
6156 if (NILP (file))
6157 Fsignal (Qquit, Qnil);
6159 return unbind_to (count, file);
6163 /* Moving files to the system recycle bin.
6164 Used by `move-file-to-trash' instead of the default moving to ~/.Trash */
6165 DEFUN ("system-move-file-to-trash", Fsystem_move_file_to_trash,
6166 Ssystem_move_file_to_trash, 1, 1, 0,
6167 doc: /* Move file or directory named FILENAME to the recycle bin. */)
6168 (Lisp_Object filename)
6170 Lisp_Object handler;
6171 Lisp_Object encoded_file;
6172 Lisp_Object operation;
6174 operation = Qdelete_file;
6175 if (!NILP (Ffile_directory_p (filename))
6176 && NILP (Ffile_symlink_p (filename)))
6178 operation = intern ("delete-directory");
6179 filename = Fdirectory_file_name (filename);
6181 filename = Fexpand_file_name (filename, Qnil);
6183 handler = Ffind_file_name_handler (filename, operation);
6184 if (!NILP (handler))
6185 return call2 (handler, operation, filename);
6187 encoded_file = ENCODE_FILE (filename);
6190 const char * path;
6191 SHFILEOPSTRUCT file_op;
6192 char tmp_path[MAX_PATH + 1];
6194 path = map_w32_filename (SDATA (encoded_file), NULL);
6196 /* On Windows, write permission is required to delete/move files. */
6197 _chmod (path, 0666);
6199 memset (tmp_path, 0, sizeof (tmp_path));
6200 strcpy (tmp_path, path);
6202 memset (&file_op, 0, sizeof (file_op));
6203 file_op.hwnd = HWND_DESKTOP;
6204 file_op.wFunc = FO_DELETE;
6205 file_op.pFrom = tmp_path;
6206 file_op.fFlags = FOF_SILENT | FOF_NOCONFIRMATION | FOF_ALLOWUNDO
6207 | FOF_NOERRORUI | FOF_NO_CONNECTED_ELEMENTS;
6208 file_op.fAnyOperationsAborted = FALSE;
6210 if (SHFileOperation (&file_op) != 0)
6211 report_file_error ("Removing old name", list1 (filename));
6213 return Qnil;
6217 /***********************************************************************
6218 w32 specialized functions
6219 ***********************************************************************/
6221 DEFUN ("w32-send-sys-command", Fw32_send_sys_command,
6222 Sw32_send_sys_command, 1, 2, 0,
6223 doc: /* Send frame a Windows WM_SYSCOMMAND message of type COMMAND.
6224 Some useful values for COMMAND are #xf030 to maximize frame (#xf020
6225 to minimize), #xf120 to restore frame to original size, and #xf100
6226 to activate the menubar for keyboard access. #xf140 activates the
6227 screen saver if defined.
6229 If optional parameter FRAME is not specified, use selected frame. */)
6230 (Lisp_Object command, Lisp_Object frame)
6232 FRAME_PTR f = check_x_frame (frame);
6234 CHECK_NUMBER (command);
6236 PostMessage (FRAME_W32_WINDOW (f), WM_SYSCOMMAND, XINT (command), 0);
6238 return Qnil;
6241 DEFUN ("w32-shell-execute", Fw32_shell_execute, Sw32_shell_execute, 2, 4, 0,
6242 doc: /* Get Windows to perform OPERATION on DOCUMENT.
6243 This is a wrapper around the ShellExecute system function, which
6244 invokes the application registered to handle OPERATION for DOCUMENT.
6246 OPERATION is either nil or a string that names a supported operation.
6247 What operations can be used depends on the particular DOCUMENT and its
6248 handler application, but typically it is one of the following common
6249 operations:
6251 \"open\" - open DOCUMENT, which could be a file, a directory, or an
6252 executable program. If it is an application, that
6253 application is launched in the current buffer's default
6254 directory. Otherwise, the application associated with
6255 DOCUMENT is launched in the buffer's default directory.
6256 \"print\" - print DOCUMENT, which must be a file
6257 \"explore\" - start the Windows Explorer on DOCUMENT
6258 \"edit\" - launch an editor and open DOCUMENT for editing; which
6259 editor is launched depends on the association for the
6260 specified DOCUMENT
6261 \"find\" - initiate search starting from DOCUMENT which must specify
6262 a directory
6263 nil - invoke the default OPERATION, or \"open\" if default is
6264 not defined or unavailable
6266 DOCUMENT is typically the name of a document file or a URL, but can
6267 also be a program executable to run, or a directory to open in the
6268 Windows Explorer.
6270 If DOCUMENT is a program executable, the optional third arg PARAMETERS
6271 can be a string containing command line parameters that will be passed
6272 to the program; otherwise, PARAMETERS should be nil or unspecified.
6274 Optional fourth argument SHOW-FLAG can be used to control how the
6275 application will be displayed when it is invoked. If SHOW-FLAG is nil
6276 or unspecified, the application is displayed normally, otherwise it is
6277 an integer representing a ShowWindow flag:
6279 0 - start hidden
6280 1 - start normally
6281 3 - start maximized
6282 6 - start minimized */)
6283 (Lisp_Object operation, Lisp_Object document, Lisp_Object parameters, Lisp_Object show_flag)
6285 Lisp_Object current_dir;
6286 char *errstr;
6288 CHECK_STRING (document);
6290 /* Encode filename, current directory and parameters. */
6291 current_dir = ENCODE_FILE (current_buffer->directory);
6292 document = ENCODE_FILE (document);
6293 if (STRINGP (parameters))
6294 parameters = ENCODE_SYSTEM (parameters);
6296 if ((int) ShellExecute (NULL,
6297 (STRINGP (operation) ?
6298 SDATA (operation) : NULL),
6299 SDATA (document),
6300 (STRINGP (parameters) ?
6301 SDATA (parameters) : NULL),
6302 SDATA (current_dir),
6303 (INTEGERP (show_flag) ?
6304 XINT (show_flag) : SW_SHOWDEFAULT))
6305 > 32)
6306 return Qt;
6307 errstr = w32_strerror (0);
6308 /* The error string might be encoded in the locale's encoding. */
6309 if (!NILP (Vlocale_coding_system))
6311 Lisp_Object decoded =
6312 code_convert_string_norecord (make_unibyte_string (errstr,
6313 strlen (errstr)),
6314 Vlocale_coding_system, 0);
6315 errstr = (char *)SDATA (decoded);
6317 error ("ShellExecute failed: %s", errstr);
6320 /* Lookup virtual keycode from string representing the name of a
6321 non-ascii keystroke into the corresponding virtual key, using
6322 lispy_function_keys. */
6323 static int
6324 lookup_vk_code (char *key)
6326 int i;
6328 for (i = 0; i < 256; i++)
6329 if (lispy_function_keys[i]
6330 && strcmp (lispy_function_keys[i], key) == 0)
6331 return i;
6333 return -1;
6336 /* Convert a one-element vector style key sequence to a hot key
6337 definition. */
6338 static Lisp_Object
6339 w32_parse_hot_key (Lisp_Object key)
6341 /* Copied from Fdefine_key and store_in_keymap. */
6342 register Lisp_Object c;
6343 int vk_code;
6344 int lisp_modifiers;
6345 int w32_modifiers;
6346 struct gcpro gcpro1;
6348 CHECK_VECTOR (key);
6350 if (XFASTINT (Flength (key)) != 1)
6351 return Qnil;
6353 GCPRO1 (key);
6355 c = Faref (key, make_number (0));
6357 if (CONSP (c) && lucid_event_type_list_p (c))
6358 c = Fevent_convert_list (c);
6360 UNGCPRO;
6362 if (! INTEGERP (c) && ! SYMBOLP (c))
6363 error ("Key definition is invalid");
6365 /* Work out the base key and the modifiers. */
6366 if (SYMBOLP (c))
6368 c = parse_modifiers (c);
6369 lisp_modifiers = XINT (Fcar (Fcdr (c)));
6370 c = Fcar (c);
6371 if (!SYMBOLP (c))
6372 abort ();
6373 vk_code = lookup_vk_code (SDATA (SYMBOL_NAME (c)));
6375 else if (INTEGERP (c))
6377 lisp_modifiers = XINT (c) & ~CHARACTERBITS;
6378 /* Many ascii characters are their own virtual key code. */
6379 vk_code = XINT (c) & CHARACTERBITS;
6382 if (vk_code < 0 || vk_code > 255)
6383 return Qnil;
6385 if ((lisp_modifiers & meta_modifier) != 0
6386 && !NILP (Vw32_alt_is_meta))
6387 lisp_modifiers |= alt_modifier;
6389 /* Supply defs missing from mingw32. */
6390 #ifndef MOD_ALT
6391 #define MOD_ALT 0x0001
6392 #define MOD_CONTROL 0x0002
6393 #define MOD_SHIFT 0x0004
6394 #define MOD_WIN 0x0008
6395 #endif
6397 /* Convert lisp modifiers to Windows hot-key form. */
6398 w32_modifiers = (lisp_modifiers & hyper_modifier) ? MOD_WIN : 0;
6399 w32_modifiers |= (lisp_modifiers & alt_modifier) ? MOD_ALT : 0;
6400 w32_modifiers |= (lisp_modifiers & ctrl_modifier) ? MOD_CONTROL : 0;
6401 w32_modifiers |= (lisp_modifiers & shift_modifier) ? MOD_SHIFT : 0;
6403 return HOTKEY (vk_code, w32_modifiers);
6406 DEFUN ("w32-register-hot-key", Fw32_register_hot_key,
6407 Sw32_register_hot_key, 1, 1, 0,
6408 doc: /* Register KEY as a hot-key combination.
6409 Certain key combinations like Alt-Tab are reserved for system use on
6410 Windows, and therefore are normally intercepted by the system. However,
6411 most of these key combinations can be received by registering them as
6412 hot-keys, overriding their special meaning.
6414 KEY must be a one element key definition in vector form that would be
6415 acceptable to `define-key' (e.g. [A-tab] for Alt-Tab). The meta
6416 modifier is interpreted as Alt if `w32-alt-is-meta' is t, and hyper
6417 is always interpreted as the Windows modifier keys.
6419 The return value is the hotkey-id if registered, otherwise nil. */)
6420 (Lisp_Object key)
6422 key = w32_parse_hot_key (key);
6424 if (!NILP (key) && NILP (Fmemq (key, w32_grabbed_keys)))
6426 /* Reuse an empty slot if possible. */
6427 Lisp_Object item = Fmemq (Qnil, w32_grabbed_keys);
6429 /* Safe to add new key to list, even if we have focus. */
6430 if (NILP (item))
6431 w32_grabbed_keys = Fcons (key, w32_grabbed_keys);
6432 else
6433 XSETCAR (item, key);
6435 /* Notify input thread about new hot-key definition, so that it
6436 takes effect without needing to switch focus. */
6437 #ifdef USE_LISP_UNION_TYPE
6438 PostThreadMessage (dwWindowsThreadId, WM_EMACS_REGISTER_HOT_KEY,
6439 (WPARAM) key.i, 0);
6440 #else
6441 PostThreadMessage (dwWindowsThreadId, WM_EMACS_REGISTER_HOT_KEY,
6442 (WPARAM) key, 0);
6443 #endif
6446 return key;
6449 DEFUN ("w32-unregister-hot-key", Fw32_unregister_hot_key,
6450 Sw32_unregister_hot_key, 1, 1, 0,
6451 doc: /* Unregister KEY as a hot-key combination. */)
6452 (Lisp_Object key)
6454 Lisp_Object item;
6456 if (!INTEGERP (key))
6457 key = w32_parse_hot_key (key);
6459 item = Fmemq (key, w32_grabbed_keys);
6461 if (!NILP (item))
6463 /* Notify input thread about hot-key definition being removed, so
6464 that it takes effect without needing focus switch. */
6465 #ifdef USE_LISP_UNION_TYPE
6466 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_UNREGISTER_HOT_KEY,
6467 (WPARAM) XINT (XCAR (item)), (LPARAM) item.i))
6468 #else
6469 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_UNREGISTER_HOT_KEY,
6470 (WPARAM) XINT (XCAR (item)), (LPARAM) item))
6471 #endif
6473 MSG msg;
6474 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
6476 return Qt;
6478 return Qnil;
6481 DEFUN ("w32-registered-hot-keys", Fw32_registered_hot_keys,
6482 Sw32_registered_hot_keys, 0, 0, 0,
6483 doc: /* Return list of registered hot-key IDs. */)
6484 (void)
6486 return Fdelq (Qnil, Fcopy_sequence (w32_grabbed_keys));
6489 DEFUN ("w32-reconstruct-hot-key", Fw32_reconstruct_hot_key,
6490 Sw32_reconstruct_hot_key, 1, 1, 0,
6491 doc: /* Convert hot-key ID to a lisp key combination.
6492 usage: (w32-reconstruct-hot-key ID) */)
6493 (Lisp_Object hotkeyid)
6495 int vk_code, w32_modifiers;
6496 Lisp_Object key;
6498 CHECK_NUMBER (hotkeyid);
6500 vk_code = HOTKEY_VK_CODE (hotkeyid);
6501 w32_modifiers = HOTKEY_MODIFIERS (hotkeyid);
6503 if (vk_code < 256 && lispy_function_keys[vk_code])
6504 key = intern (lispy_function_keys[vk_code]);
6505 else
6506 key = make_number (vk_code);
6508 key = Fcons (key, Qnil);
6509 if (w32_modifiers & MOD_SHIFT)
6510 key = Fcons (Qshift, key);
6511 if (w32_modifiers & MOD_CONTROL)
6512 key = Fcons (Qctrl, key);
6513 if (w32_modifiers & MOD_ALT)
6514 key = Fcons (NILP (Vw32_alt_is_meta) ? Qalt : Qmeta, key);
6515 if (w32_modifiers & MOD_WIN)
6516 key = Fcons (Qhyper, key);
6518 return key;
6521 DEFUN ("w32-toggle-lock-key", Fw32_toggle_lock_key,
6522 Sw32_toggle_lock_key, 1, 2, 0,
6523 doc: /* Toggle the state of the lock key KEY.
6524 KEY can be `capslock', `kp-numlock', or `scroll'.
6525 If the optional parameter NEW-STATE is a number, then the state of KEY
6526 is set to off if the low bit of NEW-STATE is zero, otherwise on. */)
6527 (Lisp_Object key, Lisp_Object new_state)
6529 int vk_code;
6531 if (EQ (key, intern ("capslock")))
6532 vk_code = VK_CAPITAL;
6533 else if (EQ (key, intern ("kp-numlock")))
6534 vk_code = VK_NUMLOCK;
6535 else if (EQ (key, intern ("scroll")))
6536 vk_code = VK_SCROLL;
6537 else
6538 return Qnil;
6540 if (!dwWindowsThreadId)
6541 return make_number (w32_console_toggle_lock_key (vk_code, new_state));
6543 #ifdef USE_LISP_UNION_TYPE
6544 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_TOGGLE_LOCK_KEY,
6545 (WPARAM) vk_code, (LPARAM) new_state.i))
6546 #else
6547 if (PostThreadMessage (dwWindowsThreadId, WM_EMACS_TOGGLE_LOCK_KEY,
6548 (WPARAM) vk_code, (LPARAM) new_state))
6549 #endif
6551 MSG msg;
6552 GetMessage (&msg, NULL, WM_EMACS_DONE, WM_EMACS_DONE);
6553 return make_number (msg.wParam);
6555 return Qnil;
6558 DEFUN ("w32-window-exists-p", Fw32_window_exists_p, Sw32_window_exists_p,
6559 2, 2, 0,
6560 doc: /* Return non-nil if a window exists with the specified CLASS and NAME.
6562 This is a direct interface to the Windows API FindWindow function. */)
6563 (Lisp_Object class, Lisp_Object name)
6565 HWND hnd;
6567 if (!NILP (class))
6568 CHECK_STRING (class);
6569 if (!NILP (name))
6570 CHECK_STRING (name);
6572 hnd = FindWindow (STRINGP (class) ? ((LPCTSTR) SDATA (class)) : NULL,
6573 STRINGP (name) ? ((LPCTSTR) SDATA (name)) : NULL);
6574 if (!hnd)
6575 return Qnil;
6576 return Qt;
6579 DEFUN ("w32-battery-status", Fw32_battery_status, Sw32_battery_status, 0, 0, 0,
6580 doc: /* Get power status information from Windows system.
6582 The following %-sequences are provided:
6583 %L AC line status (verbose)
6584 %B Battery status (verbose)
6585 %b Battery status, empty means high, `-' means low,
6586 `!' means critical, and `+' means charging
6587 %p Battery load percentage
6588 %s Remaining time (to charge or discharge) in seconds
6589 %m Remaining time (to charge or discharge) in minutes
6590 %h Remaining time (to charge or discharge) in hours
6591 %t Remaining time (to charge or discharge) in the form `h:min' */)
6592 (void)
6594 Lisp_Object status = Qnil;
6596 SYSTEM_POWER_STATUS system_status;
6597 if (GetSystemPowerStatus (&system_status))
6599 Lisp_Object line_status, battery_status, battery_status_symbol;
6600 Lisp_Object load_percentage, seconds, minutes, hours, remain;
6601 Lisp_Object sequences[8];
6603 long seconds_left = (long) system_status.BatteryLifeTime;
6605 if (system_status.ACLineStatus == 0)
6606 line_status = build_string ("off-line");
6607 else if (system_status.ACLineStatus == 1)
6608 line_status = build_string ("on-line");
6609 else
6610 line_status = build_string ("N/A");
6612 if (system_status.BatteryFlag & 128)
6614 battery_status = build_string ("N/A");
6615 battery_status_symbol = empty_unibyte_string;
6617 else if (system_status.BatteryFlag & 8)
6619 battery_status = build_string ("charging");
6620 battery_status_symbol = build_string ("+");
6621 if (system_status.BatteryFullLifeTime != -1L)
6622 seconds_left = system_status.BatteryFullLifeTime - seconds_left;
6624 else if (system_status.BatteryFlag & 4)
6626 battery_status = build_string ("critical");
6627 battery_status_symbol = build_string ("!");
6629 else if (system_status.BatteryFlag & 2)
6631 battery_status = build_string ("low");
6632 battery_status_symbol = build_string ("-");
6634 else if (system_status.BatteryFlag & 1)
6636 battery_status = build_string ("high");
6637 battery_status_symbol = empty_unibyte_string;
6639 else
6641 battery_status = build_string ("medium");
6642 battery_status_symbol = empty_unibyte_string;
6645 if (system_status.BatteryLifePercent > 100)
6646 load_percentage = build_string ("N/A");
6647 else
6649 char buffer[16];
6650 _snprintf (buffer, 16, "%d", system_status.BatteryLifePercent);
6651 load_percentage = build_string (buffer);
6654 if (seconds_left < 0)
6655 seconds = minutes = hours = remain = build_string ("N/A");
6656 else
6658 long m;
6659 float h;
6660 char buffer[16];
6661 _snprintf (buffer, 16, "%ld", seconds_left);
6662 seconds = build_string (buffer);
6664 m = seconds_left / 60;
6665 _snprintf (buffer, 16, "%ld", m);
6666 minutes = build_string (buffer);
6668 h = seconds_left / 3600.0;
6669 _snprintf (buffer, 16, "%3.1f", h);
6670 hours = build_string (buffer);
6672 _snprintf (buffer, 16, "%ld:%02ld", m / 60, m % 60);
6673 remain = build_string (buffer);
6675 sequences[0] = Fcons (make_number ('L'), line_status);
6676 sequences[1] = Fcons (make_number ('B'), battery_status);
6677 sequences[2] = Fcons (make_number ('b'), battery_status_symbol);
6678 sequences[3] = Fcons (make_number ('p'), load_percentage);
6679 sequences[4] = Fcons (make_number ('s'), seconds);
6680 sequences[5] = Fcons (make_number ('m'), minutes);
6681 sequences[6] = Fcons (make_number ('h'), hours);
6682 sequences[7] = Fcons (make_number ('t'), remain);
6684 status = Flist (8, sequences);
6686 return status;
6690 DEFUN ("file-system-info", Ffile_system_info, Sfile_system_info, 1, 1, 0,
6691 doc: /* Return storage information about the file system FILENAME is on.
6692 Value is a list of floats (TOTAL FREE AVAIL), where TOTAL is the total
6693 storage of the file system, FREE is the free storage, and AVAIL is the
6694 storage available to a non-superuser. All 3 numbers are in bytes.
6695 If the underlying system call fails, value is nil. */)
6696 (Lisp_Object filename)
6698 Lisp_Object encoded, value;
6700 CHECK_STRING (filename);
6701 filename = Fexpand_file_name (filename, Qnil);
6702 encoded = ENCODE_FILE (filename);
6704 value = Qnil;
6706 /* Determining the required information on Windows turns out, sadly,
6707 to be more involved than one would hope. The original Win32 api
6708 call for this will return bogus information on some systems, but we
6709 must dynamically probe for the replacement api, since that was
6710 added rather late on. */
6712 HMODULE hKernel = GetModuleHandle ("kernel32");
6713 BOOL (*pfn_GetDiskFreeSpaceEx)
6714 (char *, PULARGE_INTEGER, PULARGE_INTEGER, PULARGE_INTEGER)
6715 = (void *) GetProcAddress (hKernel, "GetDiskFreeSpaceEx");
6717 /* On Windows, we may need to specify the root directory of the
6718 volume holding FILENAME. */
6719 char rootname[MAX_PATH];
6720 char *name = SDATA (encoded);
6722 /* find the root name of the volume if given */
6723 if (isalpha (name[0]) && name[1] == ':')
6725 rootname[0] = name[0];
6726 rootname[1] = name[1];
6727 rootname[2] = '\\';
6728 rootname[3] = 0;
6730 else if (IS_DIRECTORY_SEP (name[0]) && IS_DIRECTORY_SEP (name[1]))
6732 char *str = rootname;
6733 int slashes = 4;
6736 if (IS_DIRECTORY_SEP (*name) && --slashes == 0)
6737 break;
6738 *str++ = *name++;
6740 while ( *name );
6742 *str++ = '\\';
6743 *str = 0;
6746 if (pfn_GetDiskFreeSpaceEx)
6748 /* Unsigned large integers cannot be cast to double, so
6749 use signed ones instead. */
6750 LARGE_INTEGER availbytes;
6751 LARGE_INTEGER freebytes;
6752 LARGE_INTEGER totalbytes;
6754 if (pfn_GetDiskFreeSpaceEx (rootname,
6755 (ULARGE_INTEGER *)&availbytes,
6756 (ULARGE_INTEGER *)&totalbytes,
6757 (ULARGE_INTEGER *)&freebytes))
6758 value = list3 (make_float ((double) totalbytes.QuadPart),
6759 make_float ((double) freebytes.QuadPart),
6760 make_float ((double) availbytes.QuadPart));
6762 else
6764 DWORD sectors_per_cluster;
6765 DWORD bytes_per_sector;
6766 DWORD free_clusters;
6767 DWORD total_clusters;
6769 if (GetDiskFreeSpace (rootname,
6770 &sectors_per_cluster,
6771 &bytes_per_sector,
6772 &free_clusters,
6773 &total_clusters))
6774 value = list3 (make_float ((double) total_clusters
6775 * sectors_per_cluster * bytes_per_sector),
6776 make_float ((double) free_clusters
6777 * sectors_per_cluster * bytes_per_sector),
6778 make_float ((double) free_clusters
6779 * sectors_per_cluster * bytes_per_sector));
6783 return value;
6786 DEFUN ("default-printer-name", Fdefault_printer_name, Sdefault_printer_name,
6787 0, 0, 0, doc: /* Return the name of Windows default printer device. */)
6788 (void)
6790 static char pname_buf[256];
6791 int err;
6792 HANDLE hPrn;
6793 PRINTER_INFO_2 *ppi2 = NULL;
6794 DWORD dwNeeded = 0, dwReturned = 0;
6796 /* Retrieve the default string from Win.ini (the registry).
6797 * String will be in form "printername,drivername,portname".
6798 * This is the most portable way to get the default printer. */
6799 if (GetProfileString ("windows", "device", ",,", pname_buf, sizeof (pname_buf)) <= 0)
6800 return Qnil;
6801 /* printername precedes first "," character */
6802 strtok (pname_buf, ",");
6803 /* We want to know more than the printer name */
6804 if (!OpenPrinter (pname_buf, &hPrn, NULL))
6805 return Qnil;
6806 GetPrinter (hPrn, 2, NULL, 0, &dwNeeded);
6807 if (dwNeeded == 0)
6809 ClosePrinter (hPrn);
6810 return Qnil;
6812 /* Allocate memory for the PRINTER_INFO_2 struct */
6813 ppi2 = (PRINTER_INFO_2 *) xmalloc (dwNeeded);
6814 if (!ppi2)
6816 ClosePrinter (hPrn);
6817 return Qnil;
6819 /* Call GetPrinter again with big enouth memory block */
6820 err = GetPrinter (hPrn, 2, (LPBYTE)ppi2, dwNeeded, &dwReturned);
6821 ClosePrinter (hPrn);
6822 if (!err)
6824 xfree (ppi2);
6825 return Qnil;
6828 if (ppi2)
6830 if (ppi2->Attributes & PRINTER_ATTRIBUTE_SHARED && ppi2->pServerName)
6832 /* a remote printer */
6833 if (*ppi2->pServerName == '\\')
6834 _snprintf (pname_buf, sizeof (pname_buf), "%s\\%s", ppi2->pServerName,
6835 ppi2->pShareName);
6836 else
6837 _snprintf (pname_buf, sizeof (pname_buf), "\\\\%s\\%s", ppi2->pServerName,
6838 ppi2->pShareName);
6839 pname_buf[sizeof (pname_buf) - 1] = '\0';
6841 else
6843 /* a local printer */
6844 strncpy (pname_buf, ppi2->pPortName, sizeof (pname_buf));
6845 pname_buf[sizeof (pname_buf) - 1] = '\0';
6846 /* `pPortName' can include several ports, delimited by ','.
6847 * we only use the first one. */
6848 strtok (pname_buf, ",");
6850 xfree (ppi2);
6853 return build_string (pname_buf);
6856 /***********************************************************************
6857 Initialization
6858 ***********************************************************************/
6860 /* Keep this list in the same order as frame_parms in frame.c.
6861 Use 0 for unsupported frame parameters. */
6863 frame_parm_handler w32_frame_parm_handlers[] =
6865 x_set_autoraise,
6866 x_set_autolower,
6867 x_set_background_color,
6868 x_set_border_color,
6869 x_set_border_width,
6870 x_set_cursor_color,
6871 x_set_cursor_type,
6872 x_set_font,
6873 x_set_foreground_color,
6874 x_set_icon_name,
6875 x_set_icon_type,
6876 x_set_internal_border_width,
6877 x_set_menu_bar_lines,
6878 x_set_mouse_color,
6879 x_explicitly_set_name,
6880 x_set_scroll_bar_width,
6881 x_set_title,
6882 x_set_unsplittable,
6883 x_set_vertical_scroll_bars,
6884 x_set_visibility,
6885 x_set_tool_bar_lines,
6886 0, /* x_set_scroll_bar_foreground, */
6887 0, /* x_set_scroll_bar_background, */
6888 x_set_screen_gamma,
6889 x_set_line_spacing,
6890 x_set_fringe_width,
6891 x_set_fringe_width,
6892 0, /* x_set_wait_for_wm, */
6893 x_set_fullscreen,
6894 x_set_font_backend,
6895 x_set_alpha,
6896 0, /* x_set_sticky */
6897 0, /* x_set_tool_bar_position */
6900 void
6901 syms_of_w32fns (void)
6903 globals_of_w32fns ();
6904 /* This is zero if not using MS-Windows. */
6905 w32_in_use = 0;
6906 track_mouse_window = NULL;
6908 w32_visible_system_caret_hwnd = NULL;
6910 DEFSYM (Qnone, "none");
6911 DEFSYM (Qsuppress_icon, "suppress-icon");
6912 DEFSYM (Qundefined_color, "undefined-color");
6913 DEFSYM (Qcancel_timer, "cancel-timer");
6914 DEFSYM (Qhyper, "hyper");
6915 DEFSYM (Qsuper, "super");
6916 DEFSYM (Qmeta, "meta");
6917 DEFSYM (Qalt, "alt");
6918 DEFSYM (Qctrl, "ctrl");
6919 DEFSYM (Qcontrol, "control");
6920 DEFSYM (Qshift, "shift");
6921 DEFSYM (Qfont_param, "font-parameter");
6922 /* This is the end of symbol initialization. */
6924 /* Text property `display' should be nonsticky by default. */
6925 Vtext_property_default_nonsticky
6926 = Fcons (Fcons (Qdisplay, Qt), Vtext_property_default_nonsticky);
6929 Fput (Qundefined_color, Qerror_conditions,
6930 pure_cons (Qundefined_color, pure_cons (Qerror, Qnil)));
6931 Fput (Qundefined_color, Qerror_message,
6932 make_pure_c_string ("Undefined color"));
6934 staticpro (&w32_grabbed_keys);
6935 w32_grabbed_keys = Qnil;
6937 DEFVAR_LISP ("w32-color-map", &Vw32_color_map,
6938 doc: /* An array of color name mappings for Windows. */);
6939 Vw32_color_map = Qnil;
6941 DEFVAR_LISP ("w32-pass-alt-to-system", &Vw32_pass_alt_to_system,
6942 doc: /* Non-nil if Alt key presses are passed on to Windows.
6943 When non-nil, for example, Alt pressed and released and then space will
6944 open the System menu. When nil, Emacs processes the Alt key events, and
6945 then silently swallows them. */);
6946 Vw32_pass_alt_to_system = Qnil;
6948 DEFVAR_LISP ("w32-alt-is-meta", &Vw32_alt_is_meta,
6949 doc: /* Non-nil if the Alt key is to be considered the same as the META key.
6950 When nil, Emacs will translate the Alt key to the ALT modifier, not to META. */);
6951 Vw32_alt_is_meta = Qt;
6953 DEFVAR_INT ("w32-quit-key", &w32_quit_key,
6954 doc: /* If non-zero, the virtual key code for an alternative quit key. */);
6955 w32_quit_key = 0;
6957 DEFVAR_LISP ("w32-pass-lwindow-to-system",
6958 &Vw32_pass_lwindow_to_system,
6959 doc: /* If non-nil, the left \"Windows\" key is passed on to Windows.
6961 When non-nil, the Start menu is opened by tapping the key.
6962 If you set this to nil, the left \"Windows\" key is processed by Emacs
6963 according to the value of `w32-lwindow-modifier', which see.
6965 Note that some combinations of the left \"Windows\" key with other keys are
6966 caught by Windows at low level, and so binding them in Emacs will have no
6967 effect. For example, <lwindow>-r always pops up the Windows Run dialog,
6968 <lwindow>-<Pause> pops up the "System Properties" dialog, etc. However, see
6969 the doc string of `w32-phantom-key-code'. */);
6970 Vw32_pass_lwindow_to_system = Qt;
6972 DEFVAR_LISP ("w32-pass-rwindow-to-system",
6973 &Vw32_pass_rwindow_to_system,
6974 doc: /* If non-nil, the right \"Windows\" key is passed on to Windows.
6976 When non-nil, the Start menu is opened by tapping the key.
6977 If you set this to nil, the right \"Windows\" key is processed by Emacs
6978 according to the value of `w32-rwindow-modifier', which see.
6980 Note that some combinations of the right \"Windows\" key with other keys are
6981 caught by Windows at low level, and so binding them in Emacs will have no
6982 effect. For example, <rwindow>-r always pops up the Windows Run dialog,
6983 <rwindow>-<Pause> pops up the "System Properties" dialog, etc. However, see
6984 the doc string of `w32-phantom-key-code'. */);
6985 Vw32_pass_rwindow_to_system = Qt;
6987 DEFVAR_LISP ("w32-phantom-key-code",
6988 &Vw32_phantom_key_code,
6989 doc: /* Virtual key code used to generate \"phantom\" key presses.
6990 Value is a number between 0 and 255.
6992 Phantom key presses are generated in order to stop the system from
6993 acting on \"Windows\" key events when `w32-pass-lwindow-to-system' or
6994 `w32-pass-rwindow-to-system' is nil. */);
6995 /* Although 255 is technically not a valid key code, it works and
6996 means that this hack won't interfere with any real key code. */
6997 XSETINT (Vw32_phantom_key_code, 255);
6999 DEFVAR_LISP ("w32-enable-num-lock",
7000 &Vw32_enable_num_lock,
7001 doc: /* If non-nil, the Num Lock key acts normally.
7002 Set to nil to handle Num Lock as the `kp-numlock' key. */);
7003 Vw32_enable_num_lock = Qt;
7005 DEFVAR_LISP ("w32-enable-caps-lock",
7006 &Vw32_enable_caps_lock,
7007 doc: /* If non-nil, the Caps Lock key acts normally.
7008 Set to nil to handle Caps Lock as the `capslock' key. */);
7009 Vw32_enable_caps_lock = Qt;
7011 DEFVAR_LISP ("w32-scroll-lock-modifier",
7012 &Vw32_scroll_lock_modifier,
7013 doc: /* Modifier to use for the Scroll Lock ON state.
7014 The value can be hyper, super, meta, alt, control or shift for the
7015 respective modifier, or nil to handle Scroll Lock as the `scroll' key.
7016 Any other value will cause the Scroll Lock key to be ignored. */);
7017 Vw32_scroll_lock_modifier = Qnil;
7019 DEFVAR_LISP ("w32-lwindow-modifier",
7020 &Vw32_lwindow_modifier,
7021 doc: /* Modifier to use for the left \"Windows\" key.
7022 The value can be hyper, super, meta, alt, control or shift for the
7023 respective modifier, or nil to appear as the `lwindow' key.
7024 Any other value will cause the key to be ignored. */);
7025 Vw32_lwindow_modifier = Qnil;
7027 DEFVAR_LISP ("w32-rwindow-modifier",
7028 &Vw32_rwindow_modifier,
7029 doc: /* Modifier to use for the right \"Windows\" key.
7030 The value can be hyper, super, meta, alt, control or shift for the
7031 respective modifier, or nil to appear as the `rwindow' key.
7032 Any other value will cause the key to be ignored. */);
7033 Vw32_rwindow_modifier = Qnil;
7035 DEFVAR_LISP ("w32-apps-modifier",
7036 &Vw32_apps_modifier,
7037 doc: /* Modifier to use for the \"Apps\" key.
7038 The value can be hyper, super, meta, alt, control or shift for the
7039 respective modifier, or nil to appear as the `apps' key.
7040 Any other value will cause the key to be ignored. */);
7041 Vw32_apps_modifier = Qnil;
7043 DEFVAR_BOOL ("w32-enable-synthesized-fonts", &w32_enable_synthesized_fonts,
7044 doc: /* Non-nil enables selection of artificially italicized and bold fonts. */);
7045 w32_enable_synthesized_fonts = 0;
7047 DEFVAR_LISP ("w32-enable-palette", &Vw32_enable_palette,
7048 doc: /* Non-nil enables Windows palette management to map colors exactly. */);
7049 Vw32_enable_palette = Qt;
7051 DEFVAR_INT ("w32-mouse-button-tolerance",
7052 &w32_mouse_button_tolerance,
7053 doc: /* Analogue of double click interval for faking middle mouse events.
7054 The value is the minimum time in milliseconds that must elapse between
7055 left and right button down events before they are considered distinct events.
7056 If both mouse buttons are depressed within this interval, a middle mouse
7057 button down event is generated instead. */);
7058 w32_mouse_button_tolerance = GetDoubleClickTime () / 2;
7060 DEFVAR_INT ("w32-mouse-move-interval",
7061 &w32_mouse_move_interval,
7062 doc: /* Minimum interval between mouse move events.
7063 The value is the minimum time in milliseconds that must elapse between
7064 successive mouse move (or scroll bar drag) events before they are
7065 reported as lisp events. */);
7066 w32_mouse_move_interval = 0;
7068 DEFVAR_BOOL ("w32-pass-extra-mouse-buttons-to-system",
7069 &w32_pass_extra_mouse_buttons_to_system,
7070 doc: /* If non-nil, the fourth and fifth mouse buttons are passed to Windows.
7071 Recent versions of Windows support mice with up to five buttons.
7072 Since most applications don't support these extra buttons, most mouse
7073 drivers will allow you to map them to functions at the system level.
7074 If this variable is non-nil, Emacs will pass them on, allowing the
7075 system to handle them. */);
7076 w32_pass_extra_mouse_buttons_to_system = 0;
7078 DEFVAR_BOOL ("w32-pass-multimedia-buttons-to-system",
7079 &w32_pass_multimedia_buttons_to_system,
7080 doc: /* If non-nil, media buttons are passed to Windows.
7081 Some modern keyboards contain buttons for controlling media players, web
7082 browsers and other applications. Generally these buttons are handled on a
7083 system wide basis, but by setting this to nil they are made available
7084 to Emacs for binding. Depending on your keyboard, additional keys that
7085 may be available are:
7087 browser-back, browser-forward, browser-refresh, browser-stop,
7088 browser-search, browser-favorites, browser-home,
7089 mail, mail-reply, mail-forward, mail-send,
7090 app-1, app-2,
7091 help, find, new, open, close, save, print, undo, redo, copy, cut, paste,
7092 spell-check, correction-list, toggle-dictate-command,
7093 media-next, media-previous, media-stop, media-play-pause, media-select,
7094 media-play, media-pause, media-record, media-fast-forward, media-rewind,
7095 media-channel-up, media-channel-down,
7096 volume-mute, volume-up, volume-down,
7097 mic-volume-mute, mic-volume-down, mic-volume-up, mic-toggle,
7098 bass-down, bass-boost, bass-up, treble-down, treble-up */);
7099 w32_pass_multimedia_buttons_to_system = 1;
7101 #if 0 /* TODO: Mouse cursor customization. */
7102 DEFVAR_LISP ("x-pointer-shape", &Vx_pointer_shape,
7103 doc: /* The shape of the pointer when over text.
7104 Changing the value does not affect existing frames
7105 unless you set the mouse color. */);
7106 Vx_pointer_shape = Qnil;
7108 Vx_nontext_pointer_shape = Qnil;
7110 Vx_mode_pointer_shape = Qnil;
7112 DEFVAR_LISP ("x-hourglass-pointer-shape", &Vx_hourglass_pointer_shape,
7113 doc: /* The shape of the pointer when Emacs is busy.
7114 This variable takes effect when you create a new frame
7115 or when you set the mouse color. */);
7116 Vx_hourglass_pointer_shape = Qnil;
7118 DEFVAR_LISP ("x-sensitive-text-pointer-shape",
7119 &Vx_sensitive_text_pointer_shape,
7120 doc: /* The shape of the pointer when over mouse-sensitive text.
7121 This variable takes effect when you create a new frame
7122 or when you set the mouse color. */);
7123 Vx_sensitive_text_pointer_shape = Qnil;
7125 DEFVAR_LISP ("x-window-horizontal-drag-cursor",
7126 &Vx_window_horizontal_drag_shape,
7127 doc: /* Pointer shape to use for indicating a window can be dragged horizontally.
7128 This variable takes effect when you create a new frame
7129 or when you set the mouse color. */);
7130 Vx_window_horizontal_drag_shape = Qnil;
7131 #endif
7133 DEFVAR_LISP ("x-cursor-fore-pixel", &Vx_cursor_fore_pixel,
7134 doc: /* A string indicating the foreground color of the cursor box. */);
7135 Vx_cursor_fore_pixel = Qnil;
7137 DEFVAR_LISP ("x-max-tooltip-size", &Vx_max_tooltip_size,
7138 doc: /* Maximum size for tooltips.
7139 Value is a pair (COLUMNS . ROWS). Text larger than this is clipped. */);
7140 Vx_max_tooltip_size = Fcons (make_number (80), make_number (40));
7142 DEFVAR_LISP ("x-no-window-manager", &Vx_no_window_manager,
7143 doc: /* Non-nil if no window manager is in use.
7144 Emacs doesn't try to figure this out; this is always nil
7145 unless you set it to something else. */);
7146 /* We don't have any way to find this out, so set it to nil
7147 and maybe the user would like to set it to t. */
7148 Vx_no_window_manager = Qnil;
7150 DEFVAR_LISP ("x-pixel-size-width-font-regexp",
7151 &Vx_pixel_size_width_font_regexp,
7152 doc: /* Regexp matching a font name whose width is the same as `PIXEL_SIZE'.
7154 Since Emacs gets width of a font matching with this regexp from
7155 PIXEL_SIZE field of the name, font finding mechanism gets faster for
7156 such a font. This is especially effective for such large fonts as
7157 Chinese, Japanese, and Korean. */);
7158 Vx_pixel_size_width_font_regexp = Qnil;
7160 DEFVAR_LISP ("w32-bdf-filename-alist",
7161 &Vw32_bdf_filename_alist,
7162 doc: /* List of bdf fonts and their corresponding filenames. */);
7163 Vw32_bdf_filename_alist = Qnil;
7165 DEFVAR_BOOL ("w32-strict-fontnames",
7166 &w32_strict_fontnames,
7167 doc: /* Non-nil means only use fonts that are exact matches for those requested.
7168 Default is nil, which allows old fontnames that are not XLFD compliant,
7169 and allows third-party CJK display to work by specifying false charset
7170 fields to trick Emacs into translating to Big5, SJIS etc.
7171 Setting this to t will prevent wrong fonts being selected when
7172 fontsets are automatically created. */);
7173 w32_strict_fontnames = 0;
7175 DEFVAR_BOOL ("w32-strict-painting",
7176 &w32_strict_painting,
7177 doc: /* Non-nil means use strict rules for repainting frames.
7178 Set this to nil to get the old behavior for repainting; this should
7179 only be necessary if the default setting causes problems. */);
7180 w32_strict_painting = 1;
7182 #if 0 /* TODO: Port to W32 */
7183 defsubr (&Sx_change_window_property);
7184 defsubr (&Sx_delete_window_property);
7185 defsubr (&Sx_window_property);
7186 #endif
7187 defsubr (&Sxw_display_color_p);
7188 defsubr (&Sx_display_grayscale_p);
7189 defsubr (&Sxw_color_defined_p);
7190 defsubr (&Sxw_color_values);
7191 defsubr (&Sx_server_max_request_size);
7192 defsubr (&Sx_server_vendor);
7193 defsubr (&Sx_server_version);
7194 defsubr (&Sx_display_pixel_width);
7195 defsubr (&Sx_display_pixel_height);
7196 defsubr (&Sx_display_mm_width);
7197 defsubr (&Sx_display_mm_height);
7198 defsubr (&Sx_display_screens);
7199 defsubr (&Sx_display_planes);
7200 defsubr (&Sx_display_color_cells);
7201 defsubr (&Sx_display_visual_class);
7202 defsubr (&Sx_display_backing_store);
7203 defsubr (&Sx_display_save_under);
7204 defsubr (&Sx_create_frame);
7205 defsubr (&Sx_open_connection);
7206 defsubr (&Sx_close_connection);
7207 defsubr (&Sx_display_list);
7208 defsubr (&Sx_synchronize);
7209 defsubr (&Sx_focus_frame);
7211 /* W32 specific functions */
7213 defsubr (&Sw32_define_rgb_color);
7214 defsubr (&Sw32_default_color_map);
7215 defsubr (&Sw32_send_sys_command);
7216 defsubr (&Sw32_shell_execute);
7217 defsubr (&Sw32_register_hot_key);
7218 defsubr (&Sw32_unregister_hot_key);
7219 defsubr (&Sw32_registered_hot_keys);
7220 defsubr (&Sw32_reconstruct_hot_key);
7221 defsubr (&Sw32_toggle_lock_key);
7222 defsubr (&Sw32_window_exists_p);
7223 defsubr (&Sw32_battery_status);
7225 defsubr (&Sfile_system_info);
7226 defsubr (&Sdefault_printer_name);
7228 check_window_system_func = check_w32;
7231 hourglass_timer = 0;
7232 hourglass_hwnd = NULL;
7234 defsubr (&Sx_show_tip);
7235 defsubr (&Sx_hide_tip);
7236 tip_timer = Qnil;
7237 staticpro (&tip_timer);
7238 tip_frame = Qnil;
7239 staticpro (&tip_frame);
7241 last_show_tip_args = Qnil;
7242 staticpro (&last_show_tip_args);
7244 defsubr (&Sx_file_dialog);
7245 defsubr (&Ssystem_move_file_to_trash);
7250 globals_of_w32fns is used to initialize those global variables that
7251 must always be initialized on startup even when the global variable
7252 initialized is non zero (see the function main in emacs.c).
7253 globals_of_w32fns is called from syms_of_w32fns when the global
7254 variable initialized is 0 and directly from main when initialized
7255 is non zero.
7257 void
7258 globals_of_w32fns (void)
7260 HMODULE user32_lib = GetModuleHandle ("user32.dll");
7262 TrackMouseEvent not available in all versions of Windows, so must load
7263 it dynamically. Do it once, here, instead of every time it is used.
7265 track_mouse_event_fn = (TrackMouseEvent_Proc)
7266 GetProcAddress (user32_lib, "TrackMouseEvent");
7268 monitor_from_point_fn = (MonitorFromPoint_Proc)
7269 GetProcAddress (user32_lib, "MonitorFromPoint");
7270 get_monitor_info_fn = (GetMonitorInfo_Proc)
7271 GetProcAddress (user32_lib, "GetMonitorInfoA");
7274 HMODULE imm32_lib = GetModuleHandle ("imm32.dll");
7275 get_composition_string_fn = (ImmGetCompositionString_Proc)
7276 GetProcAddress (imm32_lib, "ImmGetCompositionStringW");
7277 get_ime_context_fn = (ImmGetContext_Proc)
7278 GetProcAddress (imm32_lib, "ImmGetContext");
7279 release_ime_context_fn = (ImmReleaseContext_Proc)
7280 GetProcAddress (imm32_lib, "ImmReleaseContext");
7281 set_ime_composition_window_fn = (ImmSetCompositionWindow_Proc)
7282 GetProcAddress (imm32_lib, "ImmSetCompositionWindow");
7284 DEFVAR_INT ("w32-ansi-code-page",
7285 &w32_ansi_code_page,
7286 doc: /* The ANSI code page used by the system. */);
7287 w32_ansi_code_page = GetACP ();
7289 /* MessageBox does not work without this when linked to comctl32.dll 6.0. */
7290 InitCommonControls ();
7292 syms_of_w32uniscribe ();
7295 #undef abort
7297 void
7298 w32_abort (void)
7300 int button;
7301 button = MessageBox (NULL,
7302 "A fatal error has occurred!\n\n"
7303 "Would you like to attach a debugger?\n\n"
7304 "Select YES to debug, NO to abort Emacs"
7305 #if __GNUC__
7306 "\n\n(type \"gdb -p <emacs-PID>\" and\n"
7307 "\"continue\" inside GDB before clicking YES.)"
7308 #endif
7309 , "Emacs Abort Dialog",
7310 MB_ICONEXCLAMATION | MB_TASKMODAL
7311 | MB_SETFOREGROUND | MB_YESNO);
7312 switch (button)
7314 case IDYES:
7315 DebugBreak ();
7316 exit (2); /* tell the compiler we will never return */
7317 case IDNO:
7318 default:
7319 abort ();
7320 break;
7324 /* For convenience when debugging. */
7326 w32_last_error (void)
7328 return GetLastError ();