1use std::rc::Rc;
2
3use ::util::ResultExt;
4use anyhow::Context as _;
5use windows::{
6 Win32::{
7 Foundation::*,
8 Graphics::Gdi::*,
9 System::SystemServices::*,
10 UI::{
11 Controls::*,
12 HiDpi::*,
13 Input::{Ime::*, KeyboardAndMouse::*},
14 WindowsAndMessaging::*,
15 },
16 },
17 core::PCWSTR,
18};
19
20use crate::*;
21
22pub(crate) const WM_GPUI_CURSOR_STYLE_CHANGED: u32 = WM_USER + 1;
23pub(crate) const WM_GPUI_CLOSE_ONE_WINDOW: u32 = WM_USER + 2;
24pub(crate) const WM_GPUI_TASK_DISPATCHED_ON_MAIN_THREAD: u32 = WM_USER + 3;
25pub(crate) const WM_GPUI_DOCK_MENU_ACTION: u32 = WM_USER + 4;
26pub(crate) const WM_GPUI_FORCE_UPDATE_WINDOW: u32 = WM_USER + 5;
27pub(crate) const WM_GPUI_KEYBOARD_LAYOUT_CHANGED: u32 = WM_USER + 6;
28pub(crate) const WM_GPUI_GPU_DEVICE_LOST: u32 = WM_USER + 7;
29pub(crate) const WM_GPUI_KEYDOWN: u32 = WM_USER + 8;
30
31const SIZE_MOVE_LOOP_TIMER_ID: usize = 1;
32const AUTO_HIDE_TASKBAR_THICKNESS_PX: i32 = 1;
33
34impl WindowsWindowInner {
35 pub(crate) fn handle_msg(
36 self: &Rc<Self>,
37 handle: HWND,
38 msg: u32,
39 wparam: WPARAM,
40 lparam: LPARAM,
41 ) -> LRESULT {
42 let handled = match msg {
43 WM_ACTIVATE => self.handle_activate_msg(wparam),
44 WM_CREATE => self.handle_create_msg(handle),
45 WM_MOVE => self.handle_move_msg(handle, lparam),
46 WM_SIZE => self.handle_size_msg(wparam, lparam),
47 WM_GETMINMAXINFO => self.handle_get_min_max_info_msg(lparam),
48 WM_ENTERSIZEMOVE | WM_ENTERMENULOOP => self.handle_size_move_loop(handle),
49 WM_EXITSIZEMOVE | WM_EXITMENULOOP => self.handle_size_move_loop_exit(handle),
50 WM_TIMER => self.handle_timer_msg(handle, wparam),
51 WM_NCCALCSIZE => self.handle_calc_client_size(handle, wparam, lparam),
52 WM_DPICHANGED => self.handle_dpi_changed_msg(handle, wparam, lparam),
53 WM_DISPLAYCHANGE => self.handle_display_change_msg(handle),
54 WM_NCHITTEST => self.handle_hit_test_msg(handle, lparam),
55 WM_PAINT => self.handle_paint_msg(handle),
56 WM_CLOSE => self.handle_close_msg(),
57 WM_DESTROY => self.handle_destroy_msg(handle),
58 WM_MOUSEMOVE => self.handle_mouse_move_msg(handle, lparam, wparam),
59 WM_MOUSELEAVE | WM_NCMOUSELEAVE => self.handle_mouse_leave_msg(),
60 WM_NCMOUSEMOVE => self.handle_nc_mouse_move_msg(handle, lparam),
61 // Treat double click as a second single click, since we track the double clicks ourselves.
62 // If you don't interact with any elements, this will fall through to the windows default
63 // behavior of toggling whether the window is maximized.
64 WM_NCLBUTTONDBLCLK | WM_NCLBUTTONDOWN => {
65 self.handle_nc_mouse_down_msg(handle, MouseButton::Left, wparam, lparam)
66 }
67 WM_NCRBUTTONDOWN => {
68 self.handle_nc_mouse_down_msg(handle, MouseButton::Right, wparam, lparam)
69 }
70 WM_NCMBUTTONDOWN => {
71 self.handle_nc_mouse_down_msg(handle, MouseButton::Middle, wparam, lparam)
72 }
73 WM_NCLBUTTONUP => {
74 self.handle_nc_mouse_up_msg(handle, MouseButton::Left, wparam, lparam)
75 }
76 WM_NCRBUTTONUP => {
77 self.handle_nc_mouse_up_msg(handle, MouseButton::Right, wparam, lparam)
78 }
79 WM_NCMBUTTONUP => {
80 self.handle_nc_mouse_up_msg(handle, MouseButton::Middle, wparam, lparam)
81 }
82 WM_LBUTTONDOWN => self.handle_mouse_down_msg(handle, MouseButton::Left, lparam),
83 WM_RBUTTONDOWN => self.handle_mouse_down_msg(handle, MouseButton::Right, lparam),
84 WM_MBUTTONDOWN => self.handle_mouse_down_msg(handle, MouseButton::Middle, lparam),
85 WM_XBUTTONDOWN => {
86 self.handle_xbutton_msg(handle, wparam, lparam, Self::handle_mouse_down_msg)
87 }
88 WM_LBUTTONUP => self.handle_mouse_up_msg(handle, MouseButton::Left, lparam),
89 WM_RBUTTONUP => self.handle_mouse_up_msg(handle, MouseButton::Right, lparam),
90 WM_MBUTTONUP => self.handle_mouse_up_msg(handle, MouseButton::Middle, lparam),
91 WM_XBUTTONUP => {
92 self.handle_xbutton_msg(handle, wparam, lparam, Self::handle_mouse_up_msg)
93 }
94 WM_MOUSEWHEEL => self.handle_mouse_wheel_msg(handle, wparam, lparam),
95 WM_MOUSEHWHEEL => self.handle_mouse_horizontal_wheel_msg(handle, wparam, lparam),
96 WM_SYSKEYUP => self.handle_syskeyup_msg(wparam, lparam),
97 WM_KEYUP => self.handle_keyup_msg(wparam, lparam),
98 WM_GPUI_KEYDOWN => self.handle_keydown_msg(wparam, lparam),
99 WM_CHAR => self.handle_char_msg(wparam),
100 WM_IME_STARTCOMPOSITION => self.handle_ime_position(handle),
101 WM_IME_COMPOSITION => self.handle_ime_composition(handle, lparam),
102 WM_SETCURSOR => self.handle_set_cursor(handle, lparam),
103 WM_SETTINGCHANGE => self.handle_system_settings_changed(handle, wparam, lparam),
104 WM_INPUTLANGCHANGE => self.handle_input_language_changed(),
105 WM_SHOWWINDOW => self.handle_window_visibility_changed(handle, wparam),
106 WM_GPUI_CURSOR_STYLE_CHANGED => self.handle_cursor_changed(lparam),
107 WM_GPUI_FORCE_UPDATE_WINDOW => self.draw_window(handle, true),
108 WM_GPUI_GPU_DEVICE_LOST => self.handle_device_lost(lparam),
109 _ => None,
110 };
111 if let Some(n) = handled {
112 LRESULT(n)
113 } else {
114 unsafe { DefWindowProcW(handle, msg, wparam, lparam) }
115 }
116 }
117
118 fn handle_move_msg(&self, handle: HWND, lparam: LPARAM) -> Option<isize> {
119 let origin = logical_point(
120 lparam.signed_loword() as f32,
121 lparam.signed_hiword() as f32,
122 self.state.scale_factor.get(),
123 );
124 self.state.origin.set(origin);
125 let size = self.state.logical_size.get();
126 let center_x = origin.x.0 + size.width.0 / 2.;
127 let center_y = origin.y.0 + size.height.0 / 2.;
128 let monitor_bounds = self.state.display.get().bounds();
129 if center_x < monitor_bounds.left().0
130 || center_x > monitor_bounds.right().0
131 || center_y < monitor_bounds.top().0
132 || center_y > monitor_bounds.bottom().0
133 {
134 // center of the window may have moved to another monitor
135 let monitor = unsafe { MonitorFromWindow(handle, MONITOR_DEFAULTTONULL) };
136 // minimize the window can trigger this event too, in this case,
137 // monitor is invalid, we do nothing.
138 if !monitor.is_invalid() && self.state.display.get().handle != monitor {
139 // we will get the same monitor if we only have one
140 self.state
141 .display
142 .set(WindowsDisplay::new_with_handle(monitor).log_err()?);
143 }
144 }
145 if let Some(mut callback) = self.state.callbacks.moved.take() {
146 callback();
147 self.state.callbacks.moved.set(Some(callback));
148 }
149 Some(0)
150 }
151
152 fn handle_get_min_max_info_msg(&self, lparam: LPARAM) -> Option<isize> {
153 let min_size = self.state.min_size?;
154 let scale_factor = self.state.scale_factor.get();
155 let boarder_offset = &self.state.border_offset;
156
157 unsafe {
158 let minmax_info = &mut *(lparam.0 as *mut MINMAXINFO);
159 minmax_info.ptMinTrackSize.x =
160 min_size.width.scale(scale_factor).0 as i32 + boarder_offset.width_offset.get();
161 minmax_info.ptMinTrackSize.y =
162 min_size.height.scale(scale_factor).0 as i32 + boarder_offset.height_offset.get();
163 }
164 Some(0)
165 }
166
167 fn handle_size_msg(&self, wparam: WPARAM, lparam: LPARAM) -> Option<isize> {
168 // Don't resize the renderer when the window is minimized, but record that it was minimized so
169 // that on restore the swap chain can be recreated via `update_drawable_size_even_if_unchanged`.
170 if wparam.0 == SIZE_MINIMIZED as usize {
171 self.state
172 .restore_from_minimized
173 .set(self.state.callbacks.request_frame.take());
174 return Some(0);
175 }
176
177 let width = lparam.loword().max(1) as i32;
178 let height = lparam.hiword().max(1) as i32;
179 let new_size = size(DevicePixels(width), DevicePixels(height));
180
181 let scale_factor = self.state.scale_factor.get();
182 let mut should_resize_renderer = false;
183 if let Some(restore_from_minimized) = self.state.restore_from_minimized.take() {
184 self.state
185 .callbacks
186 .request_frame
187 .set(Some(restore_from_minimized));
188 } else {
189 should_resize_renderer = true;
190 }
191
192 self.handle_size_change(new_size, scale_factor, should_resize_renderer);
193 Some(0)
194 }
195
196 fn handle_size_change(
197 &self,
198 device_size: Size<DevicePixels>,
199 scale_factor: f32,
200 should_resize_renderer: bool,
201 ) {
202 let new_logical_size = device_size.to_pixels(scale_factor);
203
204 self.state.logical_size.set(new_logical_size);
205 if should_resize_renderer
206 && let Err(e) = self.state.renderer.borrow_mut().resize(device_size)
207 {
208 log::error!("Failed to resize renderer, invalidating devices: {}", e);
209 self.state
210 .invalidate_devices
211 .store(true, std::sync::atomic::Ordering::Release);
212 }
213 if let Some(mut callback) = self.state.callbacks.resize.take() {
214 callback(new_logical_size, scale_factor);
215 self.state.callbacks.resize.set(Some(callback));
216 }
217 }
218
219 fn handle_size_move_loop(&self, handle: HWND) -> Option<isize> {
220 unsafe {
221 let ret = SetTimer(
222 Some(handle),
223 SIZE_MOVE_LOOP_TIMER_ID,
224 USER_TIMER_MINIMUM,
225 None,
226 );
227 if ret == 0 {
228 log::error!(
229 "unable to create timer: {}",
230 std::io::Error::last_os_error()
231 );
232 }
233 }
234 None
235 }
236
237 fn handle_size_move_loop_exit(&self, handle: HWND) -> Option<isize> {
238 unsafe {
239 KillTimer(Some(handle), SIZE_MOVE_LOOP_TIMER_ID).log_err();
240 }
241 None
242 }
243
244 fn handle_timer_msg(&self, handle: HWND, wparam: WPARAM) -> Option<isize> {
245 if wparam.0 == SIZE_MOVE_LOOP_TIMER_ID {
246 let mut runnables = self.main_receiver.clone().try_iter();
247 while let Some(Ok(runnable)) = runnables.next() {
248 WindowsDispatcher::execute_runnable(runnable);
249 }
250 self.handle_paint_msg(handle)
251 } else {
252 None
253 }
254 }
255
256 fn handle_paint_msg(&self, handle: HWND) -> Option<isize> {
257 self.draw_window(handle, false)
258 }
259
260 fn handle_close_msg(&self) -> Option<isize> {
261 let mut callback = self.state.callbacks.should_close.take()?;
262 let should_close = callback();
263 self.state.callbacks.should_close.set(Some(callback));
264 if should_close { None } else { Some(0) }
265 }
266
267 fn handle_destroy_msg(&self, handle: HWND) -> Option<isize> {
268 let callback = { self.state.callbacks.close.take() };
269 if let Some(callback) = callback {
270 callback();
271 }
272 unsafe {
273 PostMessageW(
274 Some(self.platform_window_handle),
275 WM_GPUI_CLOSE_ONE_WINDOW,
276 WPARAM(self.validation_number),
277 LPARAM(handle.0 as isize),
278 )
279 .log_err();
280 }
281 Some(0)
282 }
283
284 fn handle_mouse_move_msg(&self, handle: HWND, lparam: LPARAM, wparam: WPARAM) -> Option<isize> {
285 self.start_tracking_mouse(handle, TME_LEAVE);
286
287 let Some(mut func) = self.state.callbacks.input.take() else {
288 return Some(1);
289 };
290 let scale_factor = self.state.scale_factor.get();
291
292 let pressed_button = match MODIFIERKEYS_FLAGS(wparam.loword() as u32) {
293 flags if flags.contains(MK_LBUTTON) => Some(MouseButton::Left),
294 flags if flags.contains(MK_RBUTTON) => Some(MouseButton::Right),
295 flags if flags.contains(MK_MBUTTON) => Some(MouseButton::Middle),
296 flags if flags.contains(MK_XBUTTON1) => {
297 Some(MouseButton::Navigate(NavigationDirection::Back))
298 }
299 flags if flags.contains(MK_XBUTTON2) => {
300 Some(MouseButton::Navigate(NavigationDirection::Forward))
301 }
302 _ => None,
303 };
304 let x = lparam.signed_loword() as f32;
305 let y = lparam.signed_hiword() as f32;
306 let input = PlatformInput::MouseMove(MouseMoveEvent {
307 position: logical_point(x, y, scale_factor),
308 pressed_button,
309 modifiers: current_modifiers(),
310 });
311 let handled = !func(input).propagate;
312 self.state.callbacks.input.set(Some(func));
313
314 if handled { Some(0) } else { Some(1) }
315 }
316
317 fn handle_mouse_leave_msg(&self) -> Option<isize> {
318 self.state.hovered.set(false);
319 if let Some(mut callback) = self.state.callbacks.hovered_status_change.take() {
320 callback(false);
321 self.state
322 .callbacks
323 .hovered_status_change
324 .set(Some(callback));
325 }
326
327 Some(0)
328 }
329
330 fn handle_syskeyup_msg(&self, wparam: WPARAM, lparam: LPARAM) -> Option<isize> {
331 let input = handle_key_event(wparam, lparam, &self.state, |keystroke, _| {
332 PlatformInput::KeyUp(KeyUpEvent { keystroke })
333 })?;
334 let mut func = self.state.callbacks.input.take()?;
335
336 func(input);
337 self.state.callbacks.input.set(Some(func));
338
339 // Always return 0 to indicate that the message was handled, so we could properly handle `ModifiersChanged` event.
340 Some(0)
341 }
342
343 // It's a known bug that you can't trigger `ctrl-shift-0`. See:
344 // https://superuser.com/questions/1455762/ctrl-shift-number-key-combination-has-stopped-working-for-a-few-numbers
345 fn handle_keydown_msg(&self, wparam: WPARAM, lparam: LPARAM) -> Option<isize> {
346 let Some(input) = handle_key_event(
347 wparam,
348 lparam,
349 &self.state,
350 |keystroke, prefer_character_input| {
351 PlatformInput::KeyDown(KeyDownEvent {
352 keystroke,
353 is_held: lparam.0 & (0x1 << 30) > 0,
354 prefer_character_input,
355 })
356 },
357 ) else {
358 return Some(1);
359 };
360
361 let Some(mut func) = self.state.callbacks.input.take() else {
362 return Some(1);
363 };
364
365 let handled = !func(input).propagate;
366
367 self.state.callbacks.input.set(Some(func));
368
369 if handled { Some(0) } else { Some(1) }
370 }
371
372 fn handle_keyup_msg(&self, wparam: WPARAM, lparam: LPARAM) -> Option<isize> {
373 let Some(input) = handle_key_event(wparam, lparam, &self.state, |keystroke, _| {
374 PlatformInput::KeyUp(KeyUpEvent { keystroke })
375 }) else {
376 return Some(1);
377 };
378
379 let Some(mut func) = self.state.callbacks.input.take() else {
380 return Some(1);
381 };
382
383 let handled = !func(input).propagate;
384 self.state.callbacks.input.set(Some(func));
385
386 if handled { Some(0) } else { Some(1) }
387 }
388
389 fn handle_char_msg(&self, wparam: WPARAM) -> Option<isize> {
390 let input = self.parse_char_message(wparam)?;
391 self.with_input_handler(|input_handler| {
392 input_handler.replace_text_in_range(None, &input);
393 });
394
395 Some(0)
396 }
397
398 fn handle_mouse_down_msg(
399 &self,
400 handle: HWND,
401 button: MouseButton,
402 lparam: LPARAM,
403 ) -> Option<isize> {
404 unsafe { SetCapture(handle) };
405
406 let Some(mut func) = self.state.callbacks.input.take() else {
407 return Some(1);
408 };
409 let x = lparam.signed_loword();
410 let y = lparam.signed_hiword();
411 let physical_point = point(DevicePixels(x as i32), DevicePixels(y as i32));
412 let click_count = self.state.click_state.update(button, physical_point);
413 let scale_factor = self.state.scale_factor.get();
414
415 let input = PlatformInput::MouseDown(MouseDownEvent {
416 button,
417 position: logical_point(x as f32, y as f32, scale_factor),
418 modifiers: current_modifiers(),
419 click_count,
420 first_mouse: false,
421 });
422 let handled = !func(input).propagate;
423 self.state.callbacks.input.set(Some(func));
424
425 if handled { Some(0) } else { Some(1) }
426 }
427
428 fn handle_mouse_up_msg(
429 &self,
430 _handle: HWND,
431 button: MouseButton,
432 lparam: LPARAM,
433 ) -> Option<isize> {
434 unsafe { ReleaseCapture().log_err() };
435
436 let Some(mut func) = self.state.callbacks.input.take() else {
437 return Some(1);
438 };
439 let x = lparam.signed_loword() as f32;
440 let y = lparam.signed_hiword() as f32;
441 let click_count = self.state.click_state.current_count.get();
442 let scale_factor = self.state.scale_factor.get();
443
444 let input = PlatformInput::MouseUp(MouseUpEvent {
445 button,
446 position: logical_point(x, y, scale_factor),
447 modifiers: current_modifiers(),
448 click_count,
449 });
450 let handled = !func(input).propagate;
451 self.state.callbacks.input.set(Some(func));
452
453 if handled { Some(0) } else { Some(1) }
454 }
455
456 fn handle_xbutton_msg(
457 &self,
458 handle: HWND,
459 wparam: WPARAM,
460 lparam: LPARAM,
461 handler: impl Fn(&Self, HWND, MouseButton, LPARAM) -> Option<isize>,
462 ) -> Option<isize> {
463 let nav_dir = match wparam.hiword() {
464 XBUTTON1 => NavigationDirection::Back,
465 XBUTTON2 => NavigationDirection::Forward,
466 _ => return Some(1),
467 };
468 handler(self, handle, MouseButton::Navigate(nav_dir), lparam)
469 }
470
471 fn handle_mouse_wheel_msg(
472 &self,
473 handle: HWND,
474 wparam: WPARAM,
475 lparam: LPARAM,
476 ) -> Option<isize> {
477 let modifiers = current_modifiers();
478
479 let Some(mut func) = self.state.callbacks.input.take() else {
480 return Some(1);
481 };
482 let scale_factor = self.state.scale_factor.get();
483 let wheel_scroll_amount = match modifiers.shift {
484 true => self
485 .system_settings()
486 .mouse_wheel_settings
487 .wheel_scroll_chars
488 .get(),
489 false => self
490 .system_settings()
491 .mouse_wheel_settings
492 .wheel_scroll_lines
493 .get(),
494 };
495
496 let wheel_distance =
497 (wparam.signed_hiword() as f32 / WHEEL_DELTA as f32) * wheel_scroll_amount as f32;
498 let mut cursor_point = POINT {
499 x: lparam.signed_loword().into(),
500 y: lparam.signed_hiword().into(),
501 };
502 unsafe { ScreenToClient(handle, &mut cursor_point).ok().log_err() };
503 let input = PlatformInput::ScrollWheel(ScrollWheelEvent {
504 position: logical_point(cursor_point.x as f32, cursor_point.y as f32, scale_factor),
505 delta: ScrollDelta::Lines(match modifiers.shift {
506 true => Point {
507 x: wheel_distance,
508 y: 0.0,
509 },
510 false => Point {
511 y: wheel_distance,
512 x: 0.0,
513 },
514 }),
515 modifiers,
516 touch_phase: TouchPhase::Moved,
517 });
518 let handled = !func(input).propagate;
519 self.state.callbacks.input.set(Some(func));
520
521 if handled { Some(0) } else { Some(1) }
522 }
523
524 fn handle_mouse_horizontal_wheel_msg(
525 &self,
526 handle: HWND,
527 wparam: WPARAM,
528 lparam: LPARAM,
529 ) -> Option<isize> {
530 let Some(mut func) = self.state.callbacks.input.take() else {
531 return Some(1);
532 };
533 let scale_factor = self.state.scale_factor.get();
534 let wheel_scroll_chars = self
535 .system_settings()
536 .mouse_wheel_settings
537 .wheel_scroll_chars
538 .get();
539
540 let wheel_distance =
541 (-wparam.signed_hiword() as f32 / WHEEL_DELTA as f32) * wheel_scroll_chars as f32;
542 let mut cursor_point = POINT {
543 x: lparam.signed_loword().into(),
544 y: lparam.signed_hiword().into(),
545 };
546 unsafe { ScreenToClient(handle, &mut cursor_point).ok().log_err() };
547 let event = PlatformInput::ScrollWheel(ScrollWheelEvent {
548 position: logical_point(cursor_point.x as f32, cursor_point.y as f32, scale_factor),
549 delta: ScrollDelta::Lines(Point {
550 x: wheel_distance,
551 y: 0.0,
552 }),
553 modifiers: current_modifiers(),
554 touch_phase: TouchPhase::Moved,
555 });
556 let handled = !func(event).propagate;
557 self.state.callbacks.input.set(Some(func));
558
559 if handled { Some(0) } else { Some(1) }
560 }
561
562 fn retrieve_caret_position(&self) -> Option<POINT> {
563 self.with_input_handler_and_scale_factor(|input_handler, scale_factor| {
564 let caret_range = input_handler.selected_text_range(false)?;
565 let caret_position = input_handler.bounds_for_range(caret_range.range)?;
566 Some(POINT {
567 // logical to physical
568 x: (caret_position.origin.x.0 * scale_factor) as i32,
569 y: (caret_position.origin.y.0 * scale_factor) as i32
570 + ((caret_position.size.height.0 * scale_factor) as i32 / 2),
571 })
572 })
573 }
574
575 fn handle_ime_position(&self, handle: HWND) -> Option<isize> {
576 unsafe {
577 let ctx = ImmGetContext(handle);
578
579 let Some(caret_position) = self.retrieve_caret_position() else {
580 return Some(0);
581 };
582 {
583 let config = COMPOSITIONFORM {
584 dwStyle: CFS_POINT,
585 ptCurrentPos: caret_position,
586 ..Default::default()
587 };
588 ImmSetCompositionWindow(ctx, &config as _).ok().log_err();
589 }
590 {
591 let config = CANDIDATEFORM {
592 dwStyle: CFS_CANDIDATEPOS,
593 ptCurrentPos: caret_position,
594 ..Default::default()
595 };
596 ImmSetCandidateWindow(ctx, &config as _).ok().log_err();
597 }
598 ImmReleaseContext(handle, ctx).ok().log_err();
599 Some(0)
600 }
601 }
602
603 fn handle_ime_composition(&self, handle: HWND, lparam: LPARAM) -> Option<isize> {
604 let ctx = unsafe { ImmGetContext(handle) };
605 let result = self.handle_ime_composition_inner(ctx, lparam);
606 unsafe { ImmReleaseContext(handle, ctx).ok().log_err() };
607 result
608 }
609
610 fn handle_ime_composition_inner(&self, ctx: HIMC, lparam: LPARAM) -> Option<isize> {
611 let lparam = lparam.0 as u32;
612 if lparam == 0 {
613 // Japanese IME may send this message with lparam = 0, which indicates that
614 // there is no composition string.
615 self.with_input_handler(|input_handler| {
616 input_handler.replace_text_in_range(None, "");
617 })?;
618 Some(0)
619 } else {
620 if lparam & GCS_COMPSTR.0 > 0 {
621 let comp_string = parse_ime_composition_string(ctx, GCS_COMPSTR)?;
622 let caret_pos =
623 (!comp_string.is_empty() && lparam & GCS_CURSORPOS.0 > 0).then(|| {
624 let pos = retrieve_composition_cursor_position(ctx);
625 pos..pos
626 });
627 self.with_input_handler(|input_handler| {
628 input_handler.replace_and_mark_text_in_range(None, &comp_string, caret_pos);
629 })?;
630 }
631 if lparam & GCS_RESULTSTR.0 > 0 {
632 let comp_result = parse_ime_composition_string(ctx, GCS_RESULTSTR)?;
633 self.with_input_handler(|input_handler| {
634 input_handler.replace_text_in_range(None, &comp_result);
635 })?;
636 return Some(0);
637 }
638
639 // currently, we don't care other stuff
640 None
641 }
642 }
643
644 /// SEE: https://learn.microsoft.com/en-us/windows/win32/winmsg/wm-nccalcsize
645 fn handle_calc_client_size(
646 &self,
647 handle: HWND,
648 wparam: WPARAM,
649 lparam: LPARAM,
650 ) -> Option<isize> {
651 if !self.hide_title_bar || self.state.is_fullscreen() || wparam.0 == 0 {
652 return None;
653 }
654
655 let is_maximized = self.state.is_maximized();
656 let insets = get_client_area_insets(handle, is_maximized, self.windows_version);
657 // wparam is TRUE so lparam points to an NCCALCSIZE_PARAMS structure
658 let mut params = lparam.0 as *mut NCCALCSIZE_PARAMS;
659 let mut requested_client_rect = unsafe { &mut ((*params).rgrc) };
660
661 requested_client_rect[0].left += insets.left;
662 requested_client_rect[0].top += insets.top;
663 requested_client_rect[0].right -= insets.right;
664 requested_client_rect[0].bottom -= insets.bottom;
665
666 // Fix auto hide taskbar not showing. This solution is based on the approach
667 // used by Chrome. However, it may result in one row of pixels being obscured
668 // in our client area. But as Chrome says, "there seems to be no better solution."
669 if is_maximized
670 && let Some(taskbar_position) = self.system_settings().auto_hide_taskbar_position.get()
671 {
672 // For the auto-hide taskbar, adjust in by 1 pixel on taskbar edge,
673 // so the window isn't treated as a "fullscreen app", which would cause
674 // the taskbar to disappear.
675 match taskbar_position {
676 AutoHideTaskbarPosition::Left => {
677 requested_client_rect[0].left += AUTO_HIDE_TASKBAR_THICKNESS_PX
678 }
679 AutoHideTaskbarPosition::Top => {
680 requested_client_rect[0].top += AUTO_HIDE_TASKBAR_THICKNESS_PX
681 }
682 AutoHideTaskbarPosition::Right => {
683 requested_client_rect[0].right -= AUTO_HIDE_TASKBAR_THICKNESS_PX
684 }
685 AutoHideTaskbarPosition::Bottom => {
686 requested_client_rect[0].bottom -= AUTO_HIDE_TASKBAR_THICKNESS_PX
687 }
688 }
689 }
690
691 Some(0)
692 }
693
694 fn handle_activate_msg(self: &Rc<Self>, wparam: WPARAM) -> Option<isize> {
695 let activated = wparam.loword() > 0;
696 let this = self.clone();
697 self.executor
698 .spawn(async move {
699 if let Some(mut func) = this.state.callbacks.active_status_change.take() {
700 func(activated);
701 this.state.callbacks.active_status_change.set(Some(func));
702 }
703 })
704 .detach();
705
706 None
707 }
708
709 fn handle_create_msg(&self, handle: HWND) -> Option<isize> {
710 if self.hide_title_bar {
711 notify_frame_changed(handle);
712 Some(0)
713 } else {
714 None
715 }
716 }
717
718 fn handle_dpi_changed_msg(
719 &self,
720 handle: HWND,
721 wparam: WPARAM,
722 lparam: LPARAM,
723 ) -> Option<isize> {
724 let new_dpi = wparam.loword() as f32;
725
726 let is_maximized = self.state.is_maximized();
727 let new_scale_factor = new_dpi / USER_DEFAULT_SCREEN_DPI as f32;
728 self.state.scale_factor.set(new_scale_factor);
729 self.state.border_offset.update(handle).log_err();
730
731 if is_maximized {
732 // Get the monitor and its work area at the new DPI
733 let monitor = unsafe { MonitorFromWindow(handle, MONITOR_DEFAULTTONEAREST) };
734 let mut monitor_info: MONITORINFO = unsafe { std::mem::zeroed() };
735 monitor_info.cbSize = std::mem::size_of::<MONITORINFO>() as u32;
736 if unsafe { GetMonitorInfoW(monitor, &mut monitor_info) }.as_bool() {
737 let work_area = monitor_info.rcWork;
738 let width = work_area.right - work_area.left;
739 let height = work_area.bottom - work_area.top;
740
741 // Update the window size to match the new monitor work area
742 // This will trigger WM_SIZE which will handle the size change
743 unsafe {
744 SetWindowPos(
745 handle,
746 None,
747 work_area.left,
748 work_area.top,
749 width,
750 height,
751 SWP_NOZORDER | SWP_NOACTIVATE | SWP_FRAMECHANGED,
752 )
753 .context("unable to set maximized window position after dpi has changed")
754 .log_err();
755 }
756
757 // SetWindowPos may not send WM_SIZE for maximized windows in some cases,
758 // so we manually update the size to ensure proper rendering
759 let device_size = size(DevicePixels(width), DevicePixels(height));
760 self.handle_size_change(device_size, new_scale_factor, true);
761 }
762 } else {
763 // For non-maximized windows, use the suggested RECT from the system
764 let rect = unsafe { &*(lparam.0 as *const RECT) };
765 let width = rect.right - rect.left;
766 let height = rect.bottom - rect.top;
767 // this will emit `WM_SIZE` and `WM_MOVE` right here
768 // even before this function returns
769 // the new size is handled in `WM_SIZE`
770 unsafe {
771 SetWindowPos(
772 handle,
773 None,
774 rect.left,
775 rect.top,
776 width,
777 height,
778 SWP_NOZORDER | SWP_NOACTIVATE,
779 )
780 .context("unable to set window position after dpi has changed")
781 .log_err();
782 }
783 }
784
785 Some(0)
786 }
787
788 /// The following conditions will trigger this event:
789 /// 1. The monitor on which the window is located goes offline or changes resolution.
790 /// 2. Another monitor goes offline, is plugged in, or changes resolution.
791 ///
792 /// In either case, the window will only receive information from the monitor on which
793 /// it is located.
794 ///
795 /// For example, in the case of condition 2, where the monitor on which the window is
796 /// located has actually changed nothing, it will still receive this event.
797 fn handle_display_change_msg(&self, handle: HWND) -> Option<isize> {
798 // NOTE:
799 // Even the `lParam` holds the resolution of the screen, we just ignore it.
800 // Because WM_DPICHANGED, WM_MOVE, WM_SIZE will come first, window reposition and resize
801 // are handled there.
802 // So we only care about if monitor is disconnected.
803 let previous_monitor = self.state.display.get();
804 if WindowsDisplay::is_connected(previous_monitor.handle) {
805 // we are fine, other display changed
806 return None;
807 }
808 // display disconnected
809 // in this case, the OS will move our window to another monitor, and minimize it.
810 // we deminimize the window and query the monitor after moving
811 unsafe {
812 let _ = ShowWindow(handle, SW_SHOWNORMAL);
813 };
814 let new_monitor = unsafe { MonitorFromWindow(handle, MONITOR_DEFAULTTONULL) };
815 // all monitors disconnected
816 if new_monitor.is_invalid() {
817 log::error!("No monitor detected!");
818 return None;
819 }
820 let new_display = WindowsDisplay::new_with_handle(new_monitor).log_err()?;
821 self.state.display.set(new_display);
822 Some(0)
823 }
824
825 fn handle_hit_test_msg(&self, handle: HWND, lparam: LPARAM) -> Option<isize> {
826 if !self.is_movable || self.state.is_fullscreen() {
827 return None;
828 }
829
830 let callback = self.state.callbacks.hit_test_window_control.take();
831 let drag_area = if let Some(mut callback) = callback {
832 let area = callback();
833 self.state
834 .callbacks
835 .hit_test_window_control
836 .set(Some(callback));
837 if let Some(area) = area {
838 match area {
839 WindowControlArea::Drag => Some(HTCAPTION as _),
840 WindowControlArea::Close => return Some(HTCLOSE as _),
841 WindowControlArea::Max => return Some(HTMAXBUTTON as _),
842 WindowControlArea::Min => return Some(HTMINBUTTON as _),
843 }
844 } else {
845 None
846 }
847 } else {
848 None
849 };
850
851 if !self.hide_title_bar {
852 // If the OS draws the title bar, we don't need to handle hit test messages.
853 return drag_area;
854 }
855
856 let dpi = unsafe { GetDpiForWindow(handle) };
857 // We do not use the OS title bar, so the default `DefWindowProcW` will only register a 1px edge for resizes
858 // We need to calculate the frame thickness ourselves and do the hit test manually.
859 let frame_y = get_frame_thicknessx(dpi);
860 let frame_x = get_frame_thicknessy(dpi);
861 let mut cursor_point = POINT {
862 x: lparam.signed_loword().into(),
863 y: lparam.signed_hiword().into(),
864 };
865
866 unsafe { ScreenToClient(handle, &mut cursor_point).ok().log_err() };
867 if !self.state.is_maximized() && 0 <= cursor_point.y && cursor_point.y <= frame_y {
868 // x-axis actually goes from -frame_x to 0
869 return Some(if cursor_point.x <= 0 {
870 HTTOPLEFT
871 } else {
872 let mut rect = Default::default();
873 unsafe { GetWindowRect(handle, &mut rect) }.log_err();
874 // right and bottom bounds of RECT are exclusive, thus `-1`
875 let right = rect.right - rect.left - 1;
876 // the bounds include the padding frames, so accomodate for both of them
877 if right - 2 * frame_x <= cursor_point.x {
878 HTTOPRIGHT
879 } else {
880 HTTOP
881 }
882 } as _);
883 }
884
885 drag_area
886 }
887
888 fn handle_nc_mouse_move_msg(&self, handle: HWND, lparam: LPARAM) -> Option<isize> {
889 self.start_tracking_mouse(handle, TME_LEAVE | TME_NONCLIENT);
890
891 let mut func = self.state.callbacks.input.take()?;
892 let scale_factor = self.state.scale_factor.get();
893
894 let mut cursor_point = POINT {
895 x: lparam.signed_loword().into(),
896 y: lparam.signed_hiword().into(),
897 };
898 unsafe { ScreenToClient(handle, &mut cursor_point).ok().log_err() };
899 let input = PlatformInput::MouseMove(MouseMoveEvent {
900 position: logical_point(cursor_point.x as f32, cursor_point.y as f32, scale_factor),
901 pressed_button: None,
902 modifiers: current_modifiers(),
903 });
904 let handled = !func(input).propagate;
905 self.state.callbacks.input.set(Some(func));
906
907 if handled { Some(0) } else { None }
908 }
909
910 fn handle_nc_mouse_down_msg(
911 &self,
912 handle: HWND,
913 button: MouseButton,
914 wparam: WPARAM,
915 lparam: LPARAM,
916 ) -> Option<isize> {
917 if let Some(mut func) = self.state.callbacks.input.take() {
918 let scale_factor = self.state.scale_factor.get();
919 let mut cursor_point = POINT {
920 x: lparam.signed_loword().into(),
921 y: lparam.signed_hiword().into(),
922 };
923 unsafe { ScreenToClient(handle, &mut cursor_point).ok().log_err() };
924 let physical_point = point(DevicePixels(cursor_point.x), DevicePixels(cursor_point.y));
925 let click_count = self.state.click_state.update(button, physical_point);
926
927 let input = PlatformInput::MouseDown(MouseDownEvent {
928 button,
929 position: logical_point(cursor_point.x as f32, cursor_point.y as f32, scale_factor),
930 modifiers: current_modifiers(),
931 click_count,
932 first_mouse: false,
933 });
934 let result = func(input);
935 let handled = !result.propagate || result.default_prevented;
936 self.state.callbacks.input.set(Some(func));
937
938 if handled {
939 return Some(0);
940 }
941 } else {
942 };
943
944 // Since these are handled in handle_nc_mouse_up_msg we must prevent the default window proc
945 if button == MouseButton::Left {
946 match wparam.0 as u32 {
947 HTMINBUTTON => self.state.nc_button_pressed.set(Some(HTMINBUTTON)),
948 HTMAXBUTTON => self.state.nc_button_pressed.set(Some(HTMAXBUTTON)),
949 HTCLOSE => self.state.nc_button_pressed.set(Some(HTCLOSE)),
950 _ => return None,
951 };
952 Some(0)
953 } else {
954 None
955 }
956 }
957
958 fn handle_nc_mouse_up_msg(
959 &self,
960 handle: HWND,
961 button: MouseButton,
962 wparam: WPARAM,
963 lparam: LPARAM,
964 ) -> Option<isize> {
965 if let Some(mut func) = self.state.callbacks.input.take() {
966 let scale_factor = self.state.scale_factor.get();
967
968 let mut cursor_point = POINT {
969 x: lparam.signed_loword().into(),
970 y: lparam.signed_hiword().into(),
971 };
972 unsafe { ScreenToClient(handle, &mut cursor_point).ok().log_err() };
973 let input = PlatformInput::MouseUp(MouseUpEvent {
974 button,
975 position: logical_point(cursor_point.x as f32, cursor_point.y as f32, scale_factor),
976 modifiers: current_modifiers(),
977 click_count: 1,
978 });
979 let handled = !func(input).propagate;
980 self.state.callbacks.input.set(Some(func));
981
982 if handled {
983 return Some(0);
984 }
985 } else {
986 }
987
988 let last_pressed = self.state.nc_button_pressed.take();
989 if button == MouseButton::Left
990 && let Some(last_pressed) = last_pressed
991 {
992 let handled = match (wparam.0 as u32, last_pressed) {
993 (HTMINBUTTON, HTMINBUTTON) => {
994 unsafe { ShowWindowAsync(handle, SW_MINIMIZE).ok().log_err() };
995 true
996 }
997 (HTMAXBUTTON, HTMAXBUTTON) => {
998 if self.state.is_maximized() {
999 unsafe { ShowWindowAsync(handle, SW_NORMAL).ok().log_err() };
1000 } else {
1001 unsafe { ShowWindowAsync(handle, SW_MAXIMIZE).ok().log_err() };
1002 }
1003 true
1004 }
1005 (HTCLOSE, HTCLOSE) => {
1006 unsafe {
1007 PostMessageW(Some(handle), WM_CLOSE, WPARAM::default(), LPARAM::default())
1008 .log_err()
1009 };
1010 true
1011 }
1012 _ => false,
1013 };
1014 if handled {
1015 return Some(0);
1016 }
1017 }
1018
1019 None
1020 }
1021
1022 fn handle_cursor_changed(&self, lparam: LPARAM) -> Option<isize> {
1023 let had_cursor = self.state.current_cursor.get().is_some();
1024
1025 self.state.current_cursor.set(if lparam.0 == 0 {
1026 None
1027 } else {
1028 Some(HCURSOR(lparam.0 as _))
1029 });
1030
1031 if had_cursor != self.state.current_cursor.get().is_some() {
1032 unsafe { SetCursor(self.state.current_cursor.get()) };
1033 }
1034
1035 Some(0)
1036 }
1037
1038 fn handle_set_cursor(&self, handle: HWND, lparam: LPARAM) -> Option<isize> {
1039 if unsafe { !IsWindowEnabled(handle).as_bool() }
1040 || matches!(
1041 lparam.loword() as u32,
1042 HTLEFT
1043 | HTRIGHT
1044 | HTTOP
1045 | HTTOPLEFT
1046 | HTTOPRIGHT
1047 | HTBOTTOM
1048 | HTBOTTOMLEFT
1049 | HTBOTTOMRIGHT
1050 )
1051 {
1052 return None;
1053 }
1054 unsafe {
1055 SetCursor(self.state.current_cursor.get());
1056 };
1057 Some(0)
1058 }
1059
1060 fn handle_system_settings_changed(
1061 &self,
1062 handle: HWND,
1063 wparam: WPARAM,
1064 lparam: LPARAM,
1065 ) -> Option<isize> {
1066 if wparam.0 != 0 {
1067 let display = self.state.display.get();
1068 self.state.click_state.system_update(wparam.0);
1069 self.state.border_offset.update(handle).log_err();
1070 // system settings may emit a window message which wants to take the refcell self.state, so drop it
1071
1072 self.system_settings().update(display, wparam.0);
1073 } else {
1074 self.handle_system_theme_changed(handle, lparam)?;
1075 };
1076 // Force to trigger WM_NCCALCSIZE event to ensure that we handle auto hide
1077 // taskbar correctly.
1078 notify_frame_changed(handle);
1079
1080 Some(0)
1081 }
1082
1083 fn handle_system_theme_changed(&self, handle: HWND, lparam: LPARAM) -> Option<isize> {
1084 // lParam is a pointer to a string that indicates the area containing the system parameter
1085 // that was changed.
1086 let parameter = PCWSTR::from_raw(lparam.0 as _);
1087 if unsafe { !parameter.is_null() && !parameter.is_empty() }
1088 && let Some(parameter_string) = unsafe { parameter.to_string() }.log_err()
1089 {
1090 log::info!("System settings changed: {}", parameter_string);
1091 if parameter_string.as_str() == "ImmersiveColorSet" {
1092 let new_appearance = system_appearance()
1093 .context("unable to get system appearance when handling ImmersiveColorSet")
1094 .log_err()?;
1095
1096 if new_appearance != self.state.appearance.get() {
1097 self.state.appearance.set(new_appearance);
1098 let mut callback = self.state.callbacks.appearance_changed.take()?;
1099
1100 callback();
1101 self.state.callbacks.appearance_changed.set(Some(callback));
1102 configure_dwm_dark_mode(handle, new_appearance);
1103 }
1104 }
1105 }
1106 Some(0)
1107 }
1108
1109 fn handle_input_language_changed(&self) -> Option<isize> {
1110 unsafe {
1111 PostMessageW(
1112 Some(self.platform_window_handle),
1113 WM_GPUI_KEYBOARD_LAYOUT_CHANGED,
1114 WPARAM(self.validation_number),
1115 LPARAM(0),
1116 )
1117 .log_err();
1118 }
1119 Some(0)
1120 }
1121
1122 fn handle_window_visibility_changed(&self, handle: HWND, wparam: WPARAM) -> Option<isize> {
1123 if wparam.0 == 1 {
1124 self.draw_window(handle, false);
1125 }
1126 None
1127 }
1128
1129 fn handle_device_lost(&self, lparam: LPARAM) -> Option<isize> {
1130 let devices = lparam.0 as *const DirectXDevices;
1131 let devices = unsafe { &*devices };
1132 if let Err(err) = self
1133 .state
1134 .renderer
1135 .borrow_mut()
1136 .handle_device_lost(&devices)
1137 {
1138 panic!("Device lost: {err}");
1139 }
1140 Some(0)
1141 }
1142
1143 #[inline]
1144 fn draw_window(&self, handle: HWND, force_render: bool) -> Option<isize> {
1145 let mut request_frame = self.state.callbacks.request_frame.take()?;
1146
1147 // we are instructing gpui to force render a frame, this will
1148 // re-populate all the gpu textures for us so we can resume drawing in
1149 // case we disabled drawing earlier due to a device loss
1150 self.state.renderer.borrow_mut().mark_drawable();
1151 request_frame(RequestFrameOptions {
1152 require_presentation: false,
1153 force_render,
1154 });
1155
1156 self.state.callbacks.request_frame.set(Some(request_frame));
1157 unsafe { ValidateRect(Some(handle), None).ok().log_err() };
1158
1159 Some(0)
1160 }
1161
1162 #[inline]
1163 fn parse_char_message(&self, wparam: WPARAM) -> Option<String> {
1164 let code_point = wparam.loword();
1165
1166 // https://www.unicode.org/versions/Unicode16.0.0/core-spec/chapter-3/#G2630
1167 match code_point {
1168 0xD800..=0xDBFF => {
1169 // High surrogate, wait for low surrogate
1170 self.state.pending_surrogate.set(Some(code_point));
1171 None
1172 }
1173 0xDC00..=0xDFFF => {
1174 if let Some(high_surrogate) = self.state.pending_surrogate.take() {
1175 // Low surrogate, combine with pending high surrogate
1176 String::from_utf16(&[high_surrogate, code_point]).ok()
1177 } else {
1178 // Invalid low surrogate without a preceding high surrogate
1179 log::warn!(
1180 "Received low surrogate without a preceding high surrogate: {code_point:x}"
1181 );
1182 None
1183 }
1184 }
1185 _ => {
1186 self.state.pending_surrogate.set(None);
1187 char::from_u32(code_point as u32)
1188 .filter(|c| !c.is_control())
1189 .map(|c| c.to_string())
1190 }
1191 }
1192 }
1193
1194 fn start_tracking_mouse(&self, handle: HWND, flags: TRACKMOUSEEVENT_FLAGS) {
1195 if !self.state.hovered.get() {
1196 self.state.hovered.set(true);
1197 unsafe {
1198 TrackMouseEvent(&mut TRACKMOUSEEVENT {
1199 cbSize: std::mem::size_of::<TRACKMOUSEEVENT>() as u32,
1200 dwFlags: flags,
1201 hwndTrack: handle,
1202 dwHoverTime: HOVER_DEFAULT,
1203 })
1204 .log_err()
1205 };
1206 if let Some(mut callback) = self.state.callbacks.hovered_status_change.take() {
1207 callback(true);
1208 self.state
1209 .callbacks
1210 .hovered_status_change
1211 .set(Some(callback));
1212 }
1213 }
1214 }
1215
1216 fn with_input_handler<F, R>(&self, f: F) -> Option<R>
1217 where
1218 F: FnOnce(&mut PlatformInputHandler) -> R,
1219 {
1220 let mut input_handler = self.state.input_handler.take()?;
1221 let result = f(&mut input_handler);
1222 self.state.input_handler.set(Some(input_handler));
1223 Some(result)
1224 }
1225
1226 fn with_input_handler_and_scale_factor<F, R>(&self, f: F) -> Option<R>
1227 where
1228 F: FnOnce(&mut PlatformInputHandler, f32) -> Option<R>,
1229 {
1230 let mut input_handler = self.state.input_handler.take()?;
1231 let scale_factor = self.state.scale_factor.get();
1232
1233 let result = f(&mut input_handler, scale_factor);
1234 self.state.input_handler.set(Some(input_handler));
1235 result
1236 }
1237}
1238
1239fn handle_key_event<F>(
1240 wparam: WPARAM,
1241 lparam: LPARAM,
1242 state: &WindowsWindowState,
1243 f: F,
1244) -> Option<PlatformInput>
1245where
1246 F: FnOnce(Keystroke, bool) -> PlatformInput,
1247{
1248 let virtual_key = VIRTUAL_KEY(wparam.loword());
1249 let modifiers = current_modifiers();
1250
1251 match virtual_key {
1252 VK_SHIFT | VK_CONTROL | VK_MENU | VK_LMENU | VK_RMENU | VK_LWIN | VK_RWIN => {
1253 if state
1254 .last_reported_modifiers
1255 .get()
1256 .is_some_and(|prev_modifiers| prev_modifiers == modifiers)
1257 {
1258 return None;
1259 }
1260 state.last_reported_modifiers.set(Some(modifiers));
1261 Some(PlatformInput::ModifiersChanged(ModifiersChangedEvent {
1262 modifiers,
1263 capslock: current_capslock(),
1264 }))
1265 }
1266 VK_PACKET => None,
1267 VK_CAPITAL => {
1268 let capslock = current_capslock();
1269 if state
1270 .last_reported_capslock
1271 .get()
1272 .is_some_and(|prev_capslock| prev_capslock == capslock)
1273 {
1274 return None;
1275 }
1276 state.last_reported_capslock.set(Some(capslock));
1277 Some(PlatformInput::ModifiersChanged(ModifiersChangedEvent {
1278 modifiers,
1279 capslock,
1280 }))
1281 }
1282 vkey => {
1283 let keystroke = parse_normal_key(vkey, lparam, modifiers)?;
1284 Some(f(keystroke.0, keystroke.1))
1285 }
1286 }
1287}
1288
1289fn parse_immutable(vkey: VIRTUAL_KEY) -> Option<String> {
1290 Some(
1291 match vkey {
1292 VK_SPACE => "space",
1293 VK_BACK => "backspace",
1294 VK_RETURN => "enter",
1295 VK_TAB => "tab",
1296 VK_UP => "up",
1297 VK_DOWN => "down",
1298 VK_RIGHT => "right",
1299 VK_LEFT => "left",
1300 VK_HOME => "home",
1301 VK_END => "end",
1302 VK_PRIOR => "pageup",
1303 VK_NEXT => "pagedown",
1304 VK_BROWSER_BACK => "back",
1305 VK_BROWSER_FORWARD => "forward",
1306 VK_ESCAPE => "escape",
1307 VK_INSERT => "insert",
1308 VK_DELETE => "delete",
1309 VK_APPS => "menu",
1310 VK_F1 => "f1",
1311 VK_F2 => "f2",
1312 VK_F3 => "f3",
1313 VK_F4 => "f4",
1314 VK_F5 => "f5",
1315 VK_F6 => "f6",
1316 VK_F7 => "f7",
1317 VK_F8 => "f8",
1318 VK_F9 => "f9",
1319 VK_F10 => "f10",
1320 VK_F11 => "f11",
1321 VK_F12 => "f12",
1322 VK_F13 => "f13",
1323 VK_F14 => "f14",
1324 VK_F15 => "f15",
1325 VK_F16 => "f16",
1326 VK_F17 => "f17",
1327 VK_F18 => "f18",
1328 VK_F19 => "f19",
1329 VK_F20 => "f20",
1330 VK_F21 => "f21",
1331 VK_F22 => "f22",
1332 VK_F23 => "f23",
1333 VK_F24 => "f24",
1334 _ => return None,
1335 }
1336 .to_string(),
1337 )
1338}
1339
1340fn parse_normal_key(
1341 vkey: VIRTUAL_KEY,
1342 lparam: LPARAM,
1343 mut modifiers: Modifiers,
1344) -> Option<(Keystroke, bool)> {
1345 let (key_char, prefer_character_input) = process_key(vkey, lparam.hiword());
1346
1347 let key = parse_immutable(vkey).or_else(|| {
1348 let scan_code = lparam.hiword() & 0xFF;
1349 get_keystroke_key(vkey, scan_code as u32, &mut modifiers)
1350 })?;
1351
1352 Some((
1353 Keystroke {
1354 modifiers,
1355 key,
1356 key_char,
1357 },
1358 prefer_character_input,
1359 ))
1360}
1361
1362fn process_key(vkey: VIRTUAL_KEY, scan_code: u16) -> (Option<String>, bool) {
1363 let mut keyboard_state = [0u8; 256];
1364 unsafe {
1365 if GetKeyboardState(&mut keyboard_state).is_err() {
1366 return (None, false);
1367 }
1368 }
1369
1370 let mut buffer_c = [0u16; 8];
1371 let result_c = unsafe {
1372 ToUnicode(
1373 vkey.0 as u32,
1374 scan_code as u32,
1375 Some(&keyboard_state),
1376 &mut buffer_c,
1377 0x4,
1378 )
1379 };
1380
1381 if result_c == 0 {
1382 return (None, false);
1383 }
1384
1385 let c = &buffer_c[..result_c.unsigned_abs() as usize];
1386 let key_char = String::from_utf16(c)
1387 .ok()
1388 .filter(|s| !s.is_empty() && !s.chars().next().unwrap().is_control());
1389
1390 if result_c < 0 {
1391 return (key_char, true);
1392 }
1393
1394 if key_char.is_none() {
1395 return (None, false);
1396 }
1397
1398 // Workaround for some bug that makes the compiler think keyboard_state is still zeroed out
1399 let keyboard_state = std::hint::black_box(keyboard_state);
1400 let ctrl_down = (keyboard_state[VK_CONTROL.0 as usize] & 0x80) != 0;
1401 let alt_down = (keyboard_state[VK_MENU.0 as usize] & 0x80) != 0;
1402 let win_down = (keyboard_state[VK_LWIN.0 as usize] & 0x80) != 0
1403 || (keyboard_state[VK_RWIN.0 as usize] & 0x80) != 0;
1404
1405 let has_modifiers = ctrl_down || alt_down || win_down;
1406 if !has_modifiers {
1407 return (key_char, false);
1408 }
1409
1410 let mut state_no_modifiers = keyboard_state;
1411 state_no_modifiers[VK_CONTROL.0 as usize] = 0;
1412 state_no_modifiers[VK_LCONTROL.0 as usize] = 0;
1413 state_no_modifiers[VK_RCONTROL.0 as usize] = 0;
1414 state_no_modifiers[VK_MENU.0 as usize] = 0;
1415 state_no_modifiers[VK_LMENU.0 as usize] = 0;
1416 state_no_modifiers[VK_RMENU.0 as usize] = 0;
1417 state_no_modifiers[VK_LWIN.0 as usize] = 0;
1418 state_no_modifiers[VK_RWIN.0 as usize] = 0;
1419
1420 let mut buffer_c_no_modifiers = [0u16; 8];
1421 let result_c_no_modifiers = unsafe {
1422 ToUnicode(
1423 vkey.0 as u32,
1424 scan_code as u32,
1425 Some(&state_no_modifiers),
1426 &mut buffer_c_no_modifiers,
1427 0x4,
1428 )
1429 };
1430
1431 let c_no_modifiers = &buffer_c_no_modifiers[..result_c_no_modifiers.unsigned_abs() as usize];
1432 (
1433 key_char,
1434 result_c != result_c_no_modifiers || c != c_no_modifiers,
1435 )
1436}
1437
1438fn parse_ime_composition_string(ctx: HIMC, comp_type: IME_COMPOSITION_STRING) -> Option<String> {
1439 unsafe {
1440 let string_len = ImmGetCompositionStringW(ctx, comp_type, None, 0);
1441 if string_len >= 0 {
1442 let mut buffer = vec![0u8; string_len as usize + 2];
1443 ImmGetCompositionStringW(
1444 ctx,
1445 comp_type,
1446 Some(buffer.as_mut_ptr() as _),
1447 string_len as _,
1448 );
1449 let wstring = std::slice::from_raw_parts::<u16>(
1450 buffer.as_mut_ptr().cast::<u16>(),
1451 string_len as usize / 2,
1452 );
1453 Some(String::from_utf16_lossy(wstring))
1454 } else {
1455 None
1456 }
1457 }
1458}
1459
1460#[inline]
1461fn retrieve_composition_cursor_position(ctx: HIMC) -> usize {
1462 unsafe { ImmGetCompositionStringW(ctx, GCS_CURSORPOS, None, 0) as usize }
1463}
1464
1465#[inline]
1466fn is_virtual_key_pressed(vkey: VIRTUAL_KEY) -> bool {
1467 unsafe { GetKeyState(vkey.0 as i32) < 0 }
1468}
1469
1470#[inline]
1471pub(crate) fn current_modifiers() -> Modifiers {
1472 Modifiers {
1473 control: is_virtual_key_pressed(VK_CONTROL),
1474 alt: is_virtual_key_pressed(VK_MENU),
1475 shift: is_virtual_key_pressed(VK_SHIFT),
1476 platform: is_virtual_key_pressed(VK_LWIN) || is_virtual_key_pressed(VK_RWIN),
1477 function: false,
1478 }
1479}
1480
1481#[inline]
1482pub(crate) fn current_capslock() -> Capslock {
1483 let on = unsafe { GetKeyState(VK_CAPITAL.0 as i32) & 1 } > 0;
1484 Capslock { on }
1485}
1486
1487fn get_client_area_insets(
1488 handle: HWND,
1489 is_maximized: bool,
1490 windows_version: WindowsVersion,
1491) -> RECT {
1492 // For maximized windows, Windows outdents the window rect from the screen's client rect
1493 // by `frame_thickness` on each edge, meaning `insets` must contain `frame_thickness`
1494 // on all sides (including the top) to avoid the client area extending onto adjacent
1495 // monitors.
1496 //
1497 // For non-maximized windows, things become complicated:
1498 //
1499 // - On Windows 10
1500 // The top inset must be zero, since if there is any nonclient area, Windows will draw
1501 // a full native titlebar outside the client area. (This doesn't occur in the maximized
1502 // case.)
1503 //
1504 // - On Windows 11
1505 // The top inset is calculated using an empirical formula that I derived through various
1506 // tests. Without this, the top 1-2 rows of pixels in our window would be obscured.
1507 let dpi = unsafe { GetDpiForWindow(handle) };
1508 let frame_thickness = get_frame_thicknessx(dpi);
1509 let top_insets = if is_maximized {
1510 frame_thickness
1511 } else {
1512 match windows_version {
1513 WindowsVersion::Win10 => 0,
1514 WindowsVersion::Win11 => (dpi as f32 / USER_DEFAULT_SCREEN_DPI as f32).round() as i32,
1515 }
1516 };
1517 RECT {
1518 left: frame_thickness,
1519 top: top_insets,
1520 right: frame_thickness,
1521 bottom: frame_thickness,
1522 }
1523}
1524
1525// there is some additional non-visible space when talking about window
1526// borders on Windows:
1527// - SM_CXSIZEFRAME: The resize handle.
1528// - SM_CXPADDEDBORDER: Additional border space that isn't part of the resize handle.
1529fn get_frame_thicknessx(dpi: u32) -> i32 {
1530 let resize_frame_thickness = unsafe { GetSystemMetricsForDpi(SM_CXSIZEFRAME, dpi) };
1531 let padding_thickness = unsafe { GetSystemMetricsForDpi(SM_CXPADDEDBORDER, dpi) };
1532 resize_frame_thickness + padding_thickness
1533}
1534
1535fn get_frame_thicknessy(dpi: u32) -> i32 {
1536 let resize_frame_thickness = unsafe { GetSystemMetricsForDpi(SM_CYSIZEFRAME, dpi) };
1537 let padding_thickness = unsafe { GetSystemMetricsForDpi(SM_CXPADDEDBORDER, dpi) };
1538 resize_frame_thickness + padding_thickness
1539}
1540
1541fn notify_frame_changed(handle: HWND) {
1542 unsafe {
1543 SetWindowPos(
1544 handle,
1545 None,
1546 0,
1547 0,
1548 0,
1549 0,
1550 SWP_FRAMECHANGED
1551 | SWP_NOACTIVATE
1552 | SWP_NOCOPYBITS
1553 | SWP_NOMOVE
1554 | SWP_NOOWNERZORDER
1555 | SWP_NOREPOSITION
1556 | SWP_NOSENDCHANGING
1557 | SWP_NOSIZE
1558 | SWP_NOZORDER,
1559 )
1560 .log_err();
1561 }
1562}