1 /* Input event support for Emacs on the Microsoft Windows API.
2 Copyright (C) 1992-1993, 1995, 2001-2013 Free Software Foundation,
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 Adapted from ntkbd.c by Tim Fleehart
37 #include "dispextern.h"
39 #include "blockinput.h"
40 #include "termhooks.h"
46 /* stdin, from w32console.c */
47 extern HANDLE keyboard_handle
;
49 /* Info for last mouse motion */
50 static COORD movement_pos
;
51 static Time movement_time
;
54 extern unsigned int map_keypad_keys (unsigned int, unsigned int);
55 extern unsigned int w32_key_to_modifier (int key
);
58 #define EVENT_QUEUE_SIZE 50
59 static INPUT_RECORD event_queue
[EVENT_QUEUE_SIZE
];
60 static INPUT_RECORD
*queue_ptr
= event_queue
, *queue_end
= event_queue
;
62 /* Temporarily store lead byte of DBCS input sequences. */
63 static char dbcs_lead
= 0;
66 w32_read_console_input (HANDLE h
, INPUT_RECORD
*rec
, DWORD recsize
,
69 return (w32_console_unicode_input
70 ? ReadConsoleInputW (h
, rec
, recsize
, waiting
)
71 : ReadConsoleInputA (h
, rec
, recsize
, waiting
));
74 /* Set by w32_console_toggle_lock_key. */
78 fill_queue (BOOL block
)
83 if (queue_ptr
< queue_end
)
84 return queue_end
-queue_ptr
;
88 /* Check to see if there are some events to read before we try
89 because we can't block. */
90 if (!GetNumberOfConsoleInputEvents (keyboard_handle
, &events_waiting
))
92 if (events_waiting
== 0)
96 rc
= w32_read_console_input (keyboard_handle
, event_queue
, EVENT_QUEUE_SIZE
,
100 queue_ptr
= event_queue
;
101 queue_end
= event_queue
+ events_waiting
;
102 return (int) events_waiting
;
105 /* In a generic, multi-frame world this should take a console handle
106 and return the frame for it
108 Right now, there's only one frame so return it. */
112 return SELECTED_FRAME ();
115 /* Translate console modifiers to emacs modifiers.
116 German keyboard support (Kai Morgan Zeise 2/18/95). */
120 /* Return nonzero if the virtual key is a dead key. */
122 is_dead_key (int wparam
)
124 unsigned int code
= MapVirtualKey (wparam
, 2);
126 /* Windows 95 returns 0x8000, NT returns 0x80000000. */
127 return (code
& 0x80008000) ? 1 : 0;
131 /* The return code indicates key code size. cpID is the codepage to
132 use for translation to Unicode; -1 means use the current console
136 /* return code -1 means that event_queue_ptr won't be incremented.
137 In other word, this event makes two key codes. (by himi) */
139 key_event (KEY_EVENT_RECORD
*event
, struct input_event
*emacs_ev
, int *isdead
)
141 static int mod_key_state
= 0;
146 /* Skip key-up events. */
147 if (!event
->bKeyDown
)
149 switch (event
->wVirtualKeyCode
)
152 mod_key_state
&= ~LEFT_WIN_PRESSED
;
155 mod_key_state
&= ~RIGHT_WIN_PRESSED
;
158 mod_key_state
&= ~APPS_PRESSED
;
164 /* Ignore keystrokes we fake ourself; see below. */
165 if (faked_key
== event
->wVirtualKeyCode
)
171 /* To make it easier to debug this code, ignore modifier keys! */
172 switch (event
->wVirtualKeyCode
)
175 if (NILP (Vw32_pass_lwindow_to_system
))
177 /* Prevent system from acting on keyup (which opens the Start
178 menu if no other key was pressed) by simulating a press of
179 Space which we will ignore. */
180 if ((mod_key_state
& LEFT_WIN_PRESSED
) == 0)
182 if (NUMBERP (Vw32_phantom_key_code
))
183 faked_key
= XUINT (Vw32_phantom_key_code
) & 255;
185 faked_key
= VK_SPACE
;
186 keybd_event (faked_key
, (BYTE
) MapVirtualKey (faked_key
, 0), 0, 0);
189 mod_key_state
|= LEFT_WIN_PRESSED
;
190 if (!NILP (Vw32_lwindow_modifier
))
194 if (NILP (Vw32_pass_rwindow_to_system
))
196 if ((mod_key_state
& RIGHT_WIN_PRESSED
) == 0)
198 if (NUMBERP (Vw32_phantom_key_code
))
199 faked_key
= XUINT (Vw32_phantom_key_code
) & 255;
201 faked_key
= VK_SPACE
;
202 keybd_event (faked_key
, (BYTE
) MapVirtualKey (faked_key
, 0), 0, 0);
205 mod_key_state
|= RIGHT_WIN_PRESSED
;
206 if (!NILP (Vw32_rwindow_modifier
))
210 mod_key_state
|= APPS_PRESSED
;
211 if (!NILP (Vw32_apps_modifier
))
215 /* Decide whether to treat as modifier or function key. */
216 if (NILP (Vw32_enable_caps_lock
))
217 goto disable_lock_key
;
220 /* Decide whether to treat as modifier or function key. */
221 if (NILP (Vw32_enable_num_lock
))
222 goto disable_lock_key
;
225 /* Decide whether to treat as modifier or function key. */
226 if (NILP (Vw32_scroll_lock_modifier
))
227 goto disable_lock_key
;
230 /* Ensure the appropriate lock key state is off (and the
231 indicator light as well). */
232 wParam
= event
->wVirtualKeyCode
;
233 if (GetAsyncKeyState (wParam
) & 0x8000)
235 /* Fake another press of the relevant key. Apparently, this
236 really is the only way to turn off the indicator. */
238 keybd_event ((BYTE
) wParam
, (BYTE
) MapVirtualKey (wParam
, 0),
239 KEYEVENTF_EXTENDEDKEY
| KEYEVENTF_KEYUP
, 0);
240 keybd_event ((BYTE
) wParam
, (BYTE
) MapVirtualKey (wParam
, 0),
241 KEYEVENTF_EXTENDEDKEY
| 0, 0);
242 keybd_event ((BYTE
) wParam
, (BYTE
) MapVirtualKey (wParam
, 0),
243 KEYEVENTF_EXTENDEDKEY
| KEYEVENTF_KEYUP
, 0);
251 /* Windows maps Ctrl-Pause (aka Ctrl-Break) into VK_CANCEL,
252 which is confusing for purposes of key binding; convert
253 VK_CANCEL events into VK_PAUSE events. */
254 event
->wVirtualKeyCode
= VK_PAUSE
;
257 /* Windows maps Ctrl-NumLock into VK_PAUSE, which is confusing
258 for purposes of key binding; convert these back into
259 VK_NUMLOCK events, at least when we want to see NumLock key
260 presses. (Note that there is never any possibility that
261 VK_PAUSE with Ctrl really is C-Pause as per above.) */
262 if (NILP (Vw32_enable_num_lock
)
263 && (event
->dwControlKeyState
264 & (LEFT_CTRL_PRESSED
| RIGHT_CTRL_PRESSED
)) != 0)
265 event
->wVirtualKeyCode
= VK_NUMLOCK
;
269 /* Recognize state of Windows and Apps keys. */
270 event
->dwControlKeyState
|= mod_key_state
;
272 /* Distinguish numeric keypad keys from extended keys. */
273 event
->wVirtualKeyCode
=
274 map_keypad_keys (event
->wVirtualKeyCode
,
275 (event
->dwControlKeyState
& ENHANCED_KEY
));
277 if (lispy_function_keys
[event
->wVirtualKeyCode
] == 0)
279 if (!NILP (Vw32_recognize_altgr
)
280 && (event
->dwControlKeyState
& LEFT_CTRL_PRESSED
)
281 && (event
->dwControlKeyState
& RIGHT_ALT_PRESSED
))
283 /* Don't try to interpret AltGr key chords; ToAscii seems not
284 to process them correctly. */
286 /* Handle key chords including any modifiers other than shift
287 directly, in order to preserve as much modifier information as
289 else if (event
->dwControlKeyState
290 & ( RIGHT_CTRL_PRESSED
| LEFT_CTRL_PRESSED
291 | RIGHT_ALT_PRESSED
| LEFT_ALT_PRESSED
292 | (!NILP (Vw32_lwindow_modifier
) ? LEFT_WIN_PRESSED
: 0)
293 | (!NILP (Vw32_rwindow_modifier
) ? RIGHT_WIN_PRESSED
: 0)
294 | (!NILP (Vw32_apps_modifier
) ? APPS_PRESSED
: 0)
295 | (!NILP (Vw32_scroll_lock_modifier
) ? SCROLLLOCK_ON
: 0)))
297 /* Don't translate modified alphabetic keystrokes, so the user
298 doesn't need to constantly switch layout to type control or
299 meta keystrokes when the normal layout translates
300 alphabetic characters to non-ascii characters. */
301 if ('A' <= event
->wVirtualKeyCode
&& event
->wVirtualKeyCode
<= 'Z')
303 event
->uChar
.AsciiChar
= event
->wVirtualKeyCode
;
304 if ((event
->dwControlKeyState
& SHIFT_PRESSED
) == 0)
305 event
->uChar
.AsciiChar
+= ('a' - 'A');
307 /* Try to handle unrecognized keystrokes by determining the
308 base character (ie. translating the base key plus shift
310 else if (event
->uChar
.AsciiChar
== 0)
311 w32_kbd_patch_key (event
, -1);
314 if (event
->uChar
.AsciiChar
== 0)
316 emacs_ev
->kind
= NO_EVENT
;
319 else if (event
->uChar
.AsciiChar
> 0)
321 /* Pure ASCII characters < 128. */
322 emacs_ev
->kind
= ASCII_KEYSTROKE_EVENT
;
323 emacs_ev
->code
= event
->uChar
.AsciiChar
;
325 else if (event
->uChar
.UnicodeChar
> 0
326 && w32_console_unicode_input
)
328 /* Unicode codepoint; only valid if we are using Unicode
329 console input mode. */
330 emacs_ev
->kind
= MULTIBYTE_CHAR_KEYSTROKE_EVENT
;
331 emacs_ev
->code
= event
->uChar
.UnicodeChar
;
335 /* Fallback handling of non-ASCII characters for non-Unicode
336 versions of Windows, and for non-Unicode input on NT
337 family of Windows. Only characters in the current
338 console codepage are supported by this fallback. */
343 /* Get the current console input codepage to interpret this
344 key with. Note that the system defaults for the OEM
345 codepage could have been changed by calling SetConsoleCP
346 or w32-set-console-codepage, so using GetLocaleInfo to
347 get LOCALE_IDEFAULTCODEPAGE is not TRT here. */
348 cpId
= GetConsoleCP ();
351 dbcs
[1] = event
->uChar
.AsciiChar
;
355 if (!MultiByteToWideChar (cpId
, 0, dbcs
, 2, &code
, 1))
358 DebPrint (("Invalid DBCS sequence: %d %d\n",
360 emacs_ev
->kind
= NO_EVENT
;
363 else if (IsDBCSLeadByteEx (cpId
, dbcs
[1]))
366 emacs_ev
->kind
= NO_EVENT
;
370 if (!MultiByteToWideChar (cpId
, 0, &dbcs
[1], 1, &code
, 1))
373 DebPrint (("Invalid character: %d\n", dbcs
[1]));
374 emacs_ev
->kind
= NO_EVENT
;
377 emacs_ev
->kind
= MULTIBYTE_CHAR_KEYSTROKE_EVENT
;
378 emacs_ev
->code
= code
;
383 /* Function keys and other non-character keys. */
384 emacs_ev
->kind
= NON_ASCII_KEYSTROKE_EVENT
;
385 emacs_ev
->code
= event
->wVirtualKeyCode
;
388 XSETFRAME (emacs_ev
->frame_or_window
, get_frame ());
389 emacs_ev
->modifiers
= w32_kbd_mods_to_emacs (event
->dwControlKeyState
,
390 event
->wVirtualKeyCode
);
391 emacs_ev
->timestamp
= GetTickCount ();
395 /* Mouse position hook. */
397 w32_console_mouse_position (FRAME_PTR
*f
,
399 Lisp_Object
*bar_window
,
400 enum scroll_bar_part
*part
,
412 SELECTED_FRAME ()->mouse_moved
= 0;
414 XSETINT (*x
, movement_pos
.X
);
415 XSETINT (*y
, movement_pos
.Y
);
416 *time
= movement_time
;
421 /* Remember mouse motion and notify emacs. */
423 mouse_moved_to (int x
, int y
)
425 /* If we're in the same place, ignore it. */
426 if (x
!= movement_pos
.X
|| y
!= movement_pos
.Y
)
428 SELECTED_FRAME ()->mouse_moved
= 1;
431 movement_time
= GetTickCount ();
435 /* Consoles return button bits in a strange order:
436 least significant - Leftmost button
437 next - Rightmost button
441 Assume emacs likes three button mice, so
445 Others increase from there. */
447 #define NUM_TRANSLATED_MOUSE_BUTTONS 3
448 static int emacs_button_translation
[NUM_TRANSLATED_MOUSE_BUTTONS
] =
454 do_mouse_event (MOUSE_EVENT_RECORD
*event
,
455 struct input_event
*emacs_ev
)
457 static DWORD button_state
= 0;
458 static Lisp_Object last_mouse_window
;
459 DWORD but_change
, mask
;
462 if (event
->dwEventFlags
== MOUSE_MOVED
)
464 FRAME_PTR f
= SELECTED_FRAME ();
465 Mouse_HLInfo
*hlinfo
= MOUSE_HL_INFO (f
);
466 int mx
= event
->dwMousePosition
.X
, my
= event
->dwMousePosition
.Y
;
468 mouse_moved_to (mx
, my
);
472 if (hlinfo
->mouse_face_hidden
)
474 hlinfo
->mouse_face_hidden
= 0;
475 clear_mouse_face (hlinfo
);
478 /* Generate SELECT_WINDOW_EVENTs when needed. */
479 if (!NILP (Vmouse_autoselect_window
))
481 Lisp_Object mouse_window
= window_from_coordinates (f
, mx
, my
,
483 /* A window will be selected only when it is not
484 selected now, and the last mouse movement event was
485 not in it. A minibuffer window will be selected iff
487 if (WINDOWP (mouse_window
)
488 && !EQ (mouse_window
, last_mouse_window
)
489 && !EQ (mouse_window
, selected_window
))
491 struct input_event event
;
494 event
.kind
= SELECT_WINDOW_EVENT
;
495 event
.frame_or_window
= mouse_window
;
497 event
.timestamp
= movement_time
;
498 kbd_buffer_store_event (&event
);
500 last_mouse_window
= mouse_window
;
503 last_mouse_window
= Qnil
;
505 previous_help_echo_string
= help_echo_string
;
506 help_echo_string
= help_echo_object
= help_echo_window
= Qnil
;
508 note_mouse_highlight (f
, mx
, my
);
509 /* If the contents of the global variable help_echo has
510 changed (inside note_mouse_highlight), generate a HELP_EVENT. */
511 if (!NILP (help_echo_string
) || !NILP (previous_help_echo_string
))
512 gen_help_event (help_echo_string
, selected_frame
, help_echo_window
,
513 help_echo_object
, help_echo_pos
);
518 /* It looks like the console code sends us a mouse event with
519 dwButtonState == 0 when a window is activated. Ignore this case. */
520 if (event
->dwButtonState
== button_state
)
523 emacs_ev
->kind
= MOUSE_CLICK_EVENT
;
525 /* Find out what button has changed state since the last button event. */
526 but_change
= button_state
^ event
->dwButtonState
;
528 for (i
= 0; mask
; i
++, mask
<<= 1)
529 if (but_change
& mask
)
531 if (i
< NUM_TRANSLATED_MOUSE_BUTTONS
)
532 emacs_ev
->code
= emacs_button_translation
[i
];
538 button_state
= event
->dwButtonState
;
539 emacs_ev
->timestamp
= GetTickCount ();
540 emacs_ev
->modifiers
= w32_kbd_mods_to_emacs (event
->dwControlKeyState
, 0) |
541 ((event
->dwButtonState
& mask
) ? down_modifier
: up_modifier
);
543 XSETFASTINT (emacs_ev
->x
, event
->dwMousePosition
.X
);
544 XSETFASTINT (emacs_ev
->y
, event
->dwMousePosition
.Y
);
545 /* for Mule 2.2 (Based on Emacs 19.28 */
547 XSET (emacs_ev
->frame_or_window
, Lisp_Frame
, get_frame ());
549 XSETFRAME (emacs_ev
->frame_or_window
, get_frame ());
556 resize_event (WINDOW_BUFFER_SIZE_RECORD
*event
)
558 FRAME_PTR f
= get_frame ();
560 change_frame_size (f
, event
->dwSize
.Y
, event
->dwSize
.X
, 0, 1, 0);
561 SET_FRAME_GARBAGED (f
);
565 maybe_generate_resize_event (void)
567 CONSOLE_SCREEN_BUFFER_INFO info
;
568 FRAME_PTR f
= get_frame ();
570 GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE
), &info
);
572 /* It is okay to call this unconditionally, since it will do nothing
573 if the size hasn't actually changed. */
574 change_frame_size (f
,
575 1 + info
.srWindow
.Bottom
- info
.srWindow
.Top
,
576 1 + info
.srWindow
.Right
- info
.srWindow
.Left
,
581 handle_file_notifications (struct input_event
*hold_quit
)
583 BYTE
*p
= file_notifications
;
584 FILE_NOTIFY_INFORMATION
*fni
= (PFILE_NOTIFY_INFORMATION
)p
;
586 = offsetof (FILE_NOTIFY_INFORMATION
, FileName
) + sizeof(wchar_t);
587 struct input_event inev
;
590 /* We cannot process notification before Emacs is fully initialized,
591 since we need the UTF-16LE coding-system to be set up. */
594 notification_buffer_in_use
= 0;
599 if (notification_buffer_in_use
)
601 DWORD info_size
= notifications_size
;
602 Lisp_Object cs
= intern ("utf-16le");
603 Lisp_Object obj
= w32_get_watch_object (notifications_desc
);
605 /* notifications_size could be zero when the buffer of
606 notifications overflowed on the OS level, or when the
607 directory being watched was itself deleted. Do nothing in
610 && !NILP (obj
) && CONSP (obj
))
612 Lisp_Object callback
= XCDR (obj
);
616 while (info_size
>= min_size
)
618 Lisp_Object utf_16_fn
619 = make_unibyte_string ((char *)fni
->FileName
,
620 fni
->FileNameLength
);
621 /* Note: mule-conf is preloaded, so utf-16le must
622 already be defined at this point. */
624 = code_convert_string_norecord (utf_16_fn
, cs
, 0);
625 Lisp_Object action
= lispy_file_action (fni
->Action
);
627 inev
.kind
= FILE_NOTIFY_EVENT
;
628 inev
.code
= (ptrdiff_t)XINT (XIL ((EMACS_INT
)notifications_desc
));
629 inev
.timestamp
= GetTickCount ();
631 inev
.frame_or_window
= callback
;
632 inev
.arg
= Fcons (action
, fname
);
633 kbd_buffer_store_event_hold (&inev
, hold_quit
);
635 if (!fni
->NextEntryOffset
)
637 p
+= fni
->NextEntryOffset
;
638 fni
= (PFILE_NOTIFY_INFORMATION
)p
;
639 info_size
-= fni
->NextEntryOffset
;
642 notification_buffer_in_use
= 0;
648 /* Here's an overview of how Emacs input works in non-GUI sessions on
649 MS-Windows. (For description of the GUI input, see the commentary
650 before w32_msg_pump in w32fns.c.)
652 When Emacs is idle, it loops inside wait_reading_process_output,
653 calling pselect periodically to check whether any input is
654 available. On Windows, pselect is redirected to sys_select, which
655 uses MsgWaitForMultipleObjects to wait for input, either from the
656 keyboard or from any of the Emacs subprocesses. In addition,
657 MsgWaitForMultipleObjects wakes up when some Windows message is
658 posted to the input queue of the Emacs's main thread (which is the
659 thread in which sys_select runs).
661 When the Emacs's console window has focus, Windows sends input
662 events that originate from the keyboard or the mouse; these events
663 wake up MsgWaitForMultipleObjects, which reports that input is
664 available. Emacs then calls w32_console_read_socket, below, to
665 read the input. w32_console_read_socket uses
666 GetNumberOfConsoleInputEvents and ReadConsoleInput to peek at and
667 read the console input events.
669 One type of non-keyboard input event that gets reported as input
670 available is due to the Emacs's console window receiving focus.
671 When that happens, Emacs gets the FOCUS_EVENT event and sys_select
672 reports some input; however, w32_console_read_socket ignores such
673 events when called to read them.
675 Note that any other Windows message sent to the main thread will
676 also wake up MsgWaitForMultipleObjects. These messages get
677 immediately dispatched to their destinations by calling
678 drain_message_queue. */
681 w32_console_read_socket (struct terminal
*terminal
,
682 struct input_event
*hold_quit
)
691 int nfnotify
= handle_file_notifications (hold_quit
);
693 nev
= fill_queue (0);
696 /* If nev == -1, there was some kind of error
697 If nev == 0 then no events were available
706 struct input_event inev
;
709 inev
.kind
= NO_EVENT
;
712 switch (queue_ptr
->EventType
)
715 add
= key_event (&queue_ptr
->Event
.KeyEvent
, &inev
, &isdead
);
716 if (add
== -1) /* 95.7.25 by himi */
722 kbd_buffer_store_event_hold (&inev
, hold_quit
);
726 add
= do_mouse_event (&queue_ptr
->Event
.MouseEvent
, &inev
);
728 kbd_buffer_store_event_hold (&inev
, hold_quit
);
731 case WINDOW_BUFFER_SIZE_EVENT
:
732 if (w32_use_full_screen_buffer
)
733 resize_event (&queue_ptr
->Event
.WindowBufferSizeEvent
);
738 /* Internal event types, ignored. */
747 /* We don't get told about changes in the window size (only the buffer
748 size, which we no longer care about), so we have to check it
750 if (!w32_use_full_screen_buffer
)
751 maybe_generate_resize_event ();