1#![deny(unsafe_op_in_unsafe_fn)]
2
3use std::{
4 cell::RefCell,
5 num::NonZeroIsize,
6 path::PathBuf,
7 rc::{Rc, Weak},
8 str::FromStr,
9 sync::{Arc, Once},
10 time::{Duration, Instant},
11};
12
13use ::util::ResultExt;
14use anyhow::{Context as _, Result};
15use async_task::Runnable;
16use futures::channel::oneshot::{self, Receiver};
17use raw_window_handle as rwh;
18use smallvec::SmallVec;
19use windows::{
20 Win32::{
21 Foundation::*,
22 Graphics::Gdi::*,
23 System::{Com::*, LibraryLoader::*, Ole::*, SystemServices::*},
24 UI::{Controls::*, HiDpi::*, Input::KeyboardAndMouse::*, Shell::*, WindowsAndMessaging::*},
25 },
26 core::*,
27};
28
29use crate::*;
30
31pub(crate) struct WindowsWindow(pub Rc<WindowsWindowInner>);
32
33pub struct WindowsWindowState {
34 pub origin: Point<Pixels>,
35 pub logical_size: Size<Pixels>,
36 pub min_size: Option<Size<Pixels>>,
37 pub fullscreen_restore_bounds: Bounds<Pixels>,
38 pub border_offset: WindowBorderOffset,
39 pub appearance: WindowAppearance,
40 pub scale_factor: f32,
41 pub restore_from_minimized: Option<Box<dyn FnMut(RequestFrameOptions)>>,
42
43 pub callbacks: Callbacks,
44 pub input_handler: Option<PlatformInputHandler>,
45 pub pending_surrogate: Option<u16>,
46 pub last_reported_modifiers: Option<Modifiers>,
47 pub last_reported_capslock: Option<Capslock>,
48 pub system_key_handled: bool,
49 pub hovered: bool,
50
51 pub renderer: DirectXRenderer,
52
53 pub click_state: ClickState,
54 pub system_settings: WindowsSystemSettings,
55 pub current_cursor: Option<HCURSOR>,
56 pub nc_button_pressed: Option<u32>,
57
58 pub display: WindowsDisplay,
59 fullscreen: Option<StyleAndBounds>,
60 initial_placement: Option<WindowOpenStatus>,
61 hwnd: HWND,
62}
63
64pub(crate) struct WindowsWindowInner {
65 hwnd: HWND,
66 pub(super) this: Weak<Self>,
67 drop_target_helper: IDropTargetHelper,
68 pub(crate) state: RefCell<WindowsWindowState>,
69 pub(crate) handle: AnyWindowHandle,
70 pub(crate) hide_title_bar: bool,
71 pub(crate) is_movable: bool,
72 pub(crate) executor: ForegroundExecutor,
73 pub(crate) windows_version: WindowsVersion,
74 pub(crate) validation_number: usize,
75 pub(crate) main_receiver: flume::Receiver<Runnable>,
76 pub(crate) main_thread_id_win32: u32,
77}
78
79impl WindowsWindowState {
80 fn new(
81 hwnd: HWND,
82 window_params: &CREATESTRUCTW,
83 current_cursor: Option<HCURSOR>,
84 display: WindowsDisplay,
85 min_size: Option<Size<Pixels>>,
86 appearance: WindowAppearance,
87 disable_direct_composition: bool,
88 ) -> Result<Self> {
89 let scale_factor = {
90 let monitor_dpi = unsafe { GetDpiForWindow(hwnd) } as f32;
91 monitor_dpi / USER_DEFAULT_SCREEN_DPI as f32
92 };
93 let origin = logical_point(window_params.x as f32, window_params.y as f32, scale_factor);
94 let logical_size = {
95 let physical_size = size(
96 DevicePixels(window_params.cx),
97 DevicePixels(window_params.cy),
98 );
99 physical_size.to_pixels(scale_factor)
100 };
101 let fullscreen_restore_bounds = Bounds {
102 origin,
103 size: logical_size,
104 };
105 let border_offset = WindowBorderOffset::default();
106 let restore_from_minimized = None;
107 let renderer = DirectXRenderer::new(hwnd, disable_direct_composition)
108 .context("Creating DirectX renderer")?;
109 let callbacks = Callbacks::default();
110 let input_handler = None;
111 let pending_surrogate = None;
112 let last_reported_modifiers = None;
113 let last_reported_capslock = None;
114 let system_key_handled = false;
115 let hovered = false;
116 let click_state = ClickState::new();
117 let system_settings = WindowsSystemSettings::new(display);
118 let nc_button_pressed = None;
119 let fullscreen = None;
120 let initial_placement = None;
121
122 Ok(Self {
123 origin,
124 logical_size,
125 fullscreen_restore_bounds,
126 border_offset,
127 appearance,
128 scale_factor,
129 restore_from_minimized,
130 min_size,
131 callbacks,
132 input_handler,
133 pending_surrogate,
134 last_reported_modifiers,
135 last_reported_capslock,
136 system_key_handled,
137 hovered,
138 renderer,
139 click_state,
140 system_settings,
141 current_cursor,
142 nc_button_pressed,
143 display,
144 fullscreen,
145 initial_placement,
146 hwnd,
147 })
148 }
149
150 #[inline]
151 pub(crate) fn is_fullscreen(&self) -> bool {
152 self.fullscreen.is_some()
153 }
154
155 pub(crate) fn is_maximized(&self) -> bool {
156 !self.is_fullscreen() && unsafe { IsZoomed(self.hwnd) }.as_bool()
157 }
158
159 fn bounds(&self) -> Bounds<Pixels> {
160 Bounds {
161 origin: self.origin,
162 size: self.logical_size,
163 }
164 }
165
166 // Calculate the bounds used for saving and whether the window is maximized.
167 fn calculate_window_bounds(&self) -> (Bounds<Pixels>, bool) {
168 let placement = unsafe {
169 let mut placement = WINDOWPLACEMENT {
170 length: std::mem::size_of::<WINDOWPLACEMENT>() as u32,
171 ..Default::default()
172 };
173 GetWindowPlacement(self.hwnd, &mut placement).log_err();
174 placement
175 };
176 (
177 calculate_client_rect(
178 placement.rcNormalPosition,
179 self.border_offset,
180 self.scale_factor,
181 ),
182 placement.showCmd == SW_SHOWMAXIMIZED.0 as u32,
183 )
184 }
185
186 fn window_bounds(&self) -> WindowBounds {
187 let (bounds, maximized) = self.calculate_window_bounds();
188
189 if self.is_fullscreen() {
190 WindowBounds::Fullscreen(self.fullscreen_restore_bounds)
191 } else if maximized {
192 WindowBounds::Maximized(bounds)
193 } else {
194 WindowBounds::Windowed(bounds)
195 }
196 }
197
198 /// get the logical size of the app's drawable area.
199 ///
200 /// Currently, GPUI uses the logical size of the app to handle mouse interactions (such as
201 /// whether the mouse collides with other elements of GPUI).
202 fn content_size(&self) -> Size<Pixels> {
203 self.logical_size
204 }
205}
206
207impl WindowsWindowInner {
208 fn new(context: &WindowCreateContext, hwnd: HWND, cs: &CREATESTRUCTW) -> Result<Rc<Self>> {
209 let state = RefCell::new(WindowsWindowState::new(
210 hwnd,
211 cs,
212 context.current_cursor,
213 context.display,
214 context.min_size,
215 context.appearance,
216 context.disable_direct_composition,
217 )?);
218
219 Ok(Rc::new_cyclic(|this| Self {
220 hwnd,
221 this: this.clone(),
222 drop_target_helper: context.drop_target_helper.clone(),
223 state,
224 handle: context.handle,
225 hide_title_bar: context.hide_title_bar,
226 is_movable: context.is_movable,
227 executor: context.executor.clone(),
228 windows_version: context.windows_version,
229 validation_number: context.validation_number,
230 main_receiver: context.main_receiver.clone(),
231 main_thread_id_win32: context.main_thread_id_win32,
232 }))
233 }
234
235 fn toggle_fullscreen(&self) {
236 let Some(this) = self.this.upgrade() else {
237 log::error!("Unable to toggle fullscreen: window has been dropped");
238 return;
239 };
240 self.executor
241 .spawn(async move {
242 let mut lock = this.state.borrow_mut();
243 let StyleAndBounds {
244 style,
245 x,
246 y,
247 cx,
248 cy,
249 } = if let Some(state) = lock.fullscreen.take() {
250 state
251 } else {
252 let (window_bounds, _) = lock.calculate_window_bounds();
253 lock.fullscreen_restore_bounds = window_bounds;
254 let style = WINDOW_STYLE(unsafe { get_window_long(this.hwnd, GWL_STYLE) } as _);
255 let mut rc = RECT::default();
256 unsafe { GetWindowRect(this.hwnd, &mut rc) }.log_err();
257 let _ = lock.fullscreen.insert(StyleAndBounds {
258 style,
259 x: rc.left,
260 y: rc.top,
261 cx: rc.right - rc.left,
262 cy: rc.bottom - rc.top,
263 });
264 let style = style
265 & !(WS_THICKFRAME
266 | WS_SYSMENU
267 | WS_MAXIMIZEBOX
268 | WS_MINIMIZEBOX
269 | WS_CAPTION);
270 let physical_bounds = lock.display.physical_bounds();
271 StyleAndBounds {
272 style,
273 x: physical_bounds.left().0,
274 y: physical_bounds.top().0,
275 cx: physical_bounds.size.width.0,
276 cy: physical_bounds.size.height.0,
277 }
278 };
279 drop(lock);
280 unsafe { set_window_long(this.hwnd, GWL_STYLE, style.0 as isize) };
281 unsafe {
282 SetWindowPos(
283 this.hwnd,
284 None,
285 x,
286 y,
287 cx,
288 cy,
289 SWP_FRAMECHANGED | SWP_NOACTIVATE | SWP_NOZORDER,
290 )
291 }
292 .log_err();
293 })
294 .detach();
295 }
296
297 fn set_window_placement(&self) -> Result<()> {
298 let Some(open_status) = self.state.borrow_mut().initial_placement.take() else {
299 return Ok(());
300 };
301 match open_status.state {
302 WindowOpenState::Maximized => unsafe {
303 SetWindowPlacement(self.hwnd, &open_status.placement)?;
304 ShowWindowAsync(self.hwnd, SW_MAXIMIZE).ok()?;
305 },
306 WindowOpenState::Fullscreen => {
307 unsafe { SetWindowPlacement(self.hwnd, &open_status.placement)? };
308 self.toggle_fullscreen();
309 }
310 WindowOpenState::Windowed => unsafe {
311 SetWindowPlacement(self.hwnd, &open_status.placement)?;
312 },
313 }
314 Ok(())
315 }
316}
317
318#[derive(Default)]
319pub(crate) struct Callbacks {
320 pub(crate) request_frame: Option<Box<dyn FnMut(RequestFrameOptions)>>,
321 pub(crate) input: Option<Box<dyn FnMut(crate::PlatformInput) -> DispatchEventResult>>,
322 pub(crate) active_status_change: Option<Box<dyn FnMut(bool)>>,
323 pub(crate) hovered_status_change: Option<Box<dyn FnMut(bool)>>,
324 pub(crate) resize: Option<Box<dyn FnMut(Size<Pixels>, f32)>>,
325 pub(crate) moved: Option<Box<dyn FnMut()>>,
326 pub(crate) should_close: Option<Box<dyn FnMut() -> bool>>,
327 pub(crate) close: Option<Box<dyn FnOnce()>>,
328 pub(crate) hit_test_window_control: Option<Box<dyn FnMut() -> Option<WindowControlArea>>>,
329 pub(crate) appearance_changed: Option<Box<dyn FnMut()>>,
330}
331
332struct WindowCreateContext {
333 inner: Option<Result<Rc<WindowsWindowInner>>>,
334 handle: AnyWindowHandle,
335 hide_title_bar: bool,
336 display: WindowsDisplay,
337 is_movable: bool,
338 min_size: Option<Size<Pixels>>,
339 executor: ForegroundExecutor,
340 current_cursor: Option<HCURSOR>,
341 windows_version: WindowsVersion,
342 drop_target_helper: IDropTargetHelper,
343 validation_number: usize,
344 main_receiver: flume::Receiver<Runnable>,
345 main_thread_id_win32: u32,
346 appearance: WindowAppearance,
347 disable_direct_composition: bool,
348}
349
350impl WindowsWindow {
351 pub(crate) fn new(
352 handle: AnyWindowHandle,
353 params: WindowParams,
354 creation_info: WindowCreationInfo,
355 ) -> Result<Self> {
356 let WindowCreationInfo {
357 icon,
358 executor,
359 current_cursor,
360 windows_version,
361 drop_target_helper,
362 validation_number,
363 main_receiver,
364 main_thread_id_win32,
365 disable_direct_composition,
366 } = creation_info;
367 register_window_class(icon);
368 let hide_title_bar = params
369 .titlebar
370 .as_ref()
371 .map(|titlebar| titlebar.appears_transparent)
372 .unwrap_or(true);
373 let window_name = HSTRING::from(
374 params
375 .titlebar
376 .as_ref()
377 .and_then(|titlebar| titlebar.title.as_ref())
378 .map(|title| title.as_ref())
379 .unwrap_or(""),
380 );
381
382 let (mut dwexstyle, dwstyle) = if params.kind == WindowKind::PopUp {
383 (WS_EX_TOOLWINDOW, WINDOW_STYLE(0x0))
384 } else {
385 (
386 WS_EX_APPWINDOW,
387 WS_THICKFRAME | WS_SYSMENU | WS_MAXIMIZEBOX | WS_MINIMIZEBOX,
388 )
389 };
390 if !disable_direct_composition {
391 dwexstyle |= WS_EX_NOREDIRECTIONBITMAP;
392 }
393
394 let hinstance = get_module_handle();
395 let display = if let Some(display_id) = params.display_id {
396 // if we obtain a display_id, then this ID must be valid.
397 WindowsDisplay::new(display_id).unwrap()
398 } else {
399 WindowsDisplay::primary_monitor().unwrap()
400 };
401 let appearance = system_appearance().unwrap_or_default();
402 let mut context = WindowCreateContext {
403 inner: None,
404 handle,
405 hide_title_bar,
406 display,
407 is_movable: params.is_movable,
408 min_size: params.window_min_size,
409 executor,
410 current_cursor,
411 windows_version,
412 drop_target_helper,
413 validation_number,
414 main_receiver,
415 main_thread_id_win32,
416 appearance,
417 disable_direct_composition,
418 };
419 let creation_result = unsafe {
420 CreateWindowExW(
421 dwexstyle,
422 WINDOW_CLASS_NAME,
423 &window_name,
424 dwstyle,
425 CW_USEDEFAULT,
426 CW_USEDEFAULT,
427 CW_USEDEFAULT,
428 CW_USEDEFAULT,
429 None,
430 None,
431 Some(hinstance.into()),
432 Some(&context as *const _ as *const _),
433 )
434 };
435
436 // Failure to create a `WindowsWindowState` can cause window creation to fail,
437 // so check the inner result first.
438 let this = context.inner.take().unwrap()?;
439 let hwnd = creation_result?;
440
441 register_drag_drop(&this)?;
442 configure_dwm_dark_mode(hwnd, appearance);
443 this.state.borrow_mut().border_offset.update(hwnd)?;
444 let placement = retrieve_window_placement(
445 hwnd,
446 display,
447 params.bounds,
448 this.state.borrow().scale_factor,
449 this.state.borrow().border_offset,
450 )?;
451 if params.show {
452 unsafe { SetWindowPlacement(hwnd, &placement)? };
453 } else {
454 this.state.borrow_mut().initial_placement = Some(WindowOpenStatus {
455 placement,
456 state: WindowOpenState::Windowed,
457 });
458 }
459
460 Ok(Self(this))
461 }
462}
463
464impl rwh::HasWindowHandle for WindowsWindow {
465 fn window_handle(&self) -> std::result::Result<rwh::WindowHandle<'_>, rwh::HandleError> {
466 let raw = rwh::Win32WindowHandle::new(unsafe {
467 NonZeroIsize::new_unchecked(self.0.hwnd.0 as isize)
468 })
469 .into();
470 Ok(unsafe { rwh::WindowHandle::borrow_raw(raw) })
471 }
472}
473
474// todo(windows)
475impl rwh::HasDisplayHandle for WindowsWindow {
476 fn display_handle(&self) -> std::result::Result<rwh::DisplayHandle<'_>, rwh::HandleError> {
477 unimplemented!()
478 }
479}
480
481impl Drop for WindowsWindow {
482 fn drop(&mut self) {
483 // clone this `Rc` to prevent early release of the pointer
484 let this = self.0.clone();
485 self.0
486 .executor
487 .spawn(async move {
488 let handle = this.hwnd;
489 unsafe {
490 RevokeDragDrop(handle).log_err();
491 DestroyWindow(handle).log_err();
492 }
493 })
494 .detach();
495 }
496}
497
498impl PlatformWindow for WindowsWindow {
499 fn bounds(&self) -> Bounds<Pixels> {
500 self.0.state.borrow().bounds()
501 }
502
503 fn is_maximized(&self) -> bool {
504 self.0.state.borrow().is_maximized()
505 }
506
507 fn window_bounds(&self) -> WindowBounds {
508 self.0.state.borrow().window_bounds()
509 }
510
511 /// get the logical size of the app's drawable area.
512 ///
513 /// Currently, GPUI uses the logical size of the app to handle mouse interactions (such as
514 /// whether the mouse collides with other elements of GPUI).
515 fn content_size(&self) -> Size<Pixels> {
516 self.0.state.borrow().content_size()
517 }
518
519 fn resize(&mut self, size: Size<Pixels>) {
520 let hwnd = self.0.hwnd;
521 let bounds =
522 crate::bounds(self.bounds().origin, size).to_device_pixels(self.scale_factor());
523 let rect = calculate_window_rect(bounds, self.0.state.borrow().border_offset);
524
525 self.0
526 .executor
527 .spawn(async move {
528 unsafe {
529 SetWindowPos(
530 hwnd,
531 None,
532 bounds.origin.x.0,
533 bounds.origin.y.0,
534 rect.right - rect.left,
535 rect.bottom - rect.top,
536 SWP_NOMOVE,
537 )
538 .context("unable to set window content size")
539 .log_err();
540 }
541 })
542 .detach();
543 }
544
545 fn scale_factor(&self) -> f32 {
546 self.0.state.borrow().scale_factor
547 }
548
549 fn appearance(&self) -> WindowAppearance {
550 self.0.state.borrow().appearance
551 }
552
553 fn display(&self) -> Option<Rc<dyn PlatformDisplay>> {
554 Some(Rc::new(self.0.state.borrow().display))
555 }
556
557 fn mouse_position(&self) -> Point<Pixels> {
558 let scale_factor = self.scale_factor();
559 let point = unsafe {
560 let mut point: POINT = std::mem::zeroed();
561 GetCursorPos(&mut point)
562 .context("unable to get cursor position")
563 .log_err();
564 ScreenToClient(self.0.hwnd, &mut point).ok().log_err();
565 point
566 };
567 logical_point(point.x as f32, point.y as f32, scale_factor)
568 }
569
570 fn modifiers(&self) -> Modifiers {
571 current_modifiers()
572 }
573
574 fn capslock(&self) -> Capslock {
575 current_capslock()
576 }
577
578 fn set_input_handler(&mut self, input_handler: PlatformInputHandler) {
579 self.0.state.borrow_mut().input_handler = Some(input_handler);
580 }
581
582 fn take_input_handler(&mut self) -> Option<PlatformInputHandler> {
583 self.0.state.borrow_mut().input_handler.take()
584 }
585
586 fn prompt(
587 &self,
588 level: PromptLevel,
589 msg: &str,
590 detail: Option<&str>,
591 answers: &[PromptButton],
592 ) -> Option<Receiver<usize>> {
593 let (done_tx, done_rx) = oneshot::channel();
594 let msg = msg.to_string();
595 let detail_string = match detail {
596 Some(info) => Some(info.to_string()),
597 None => None,
598 };
599 let handle = self.0.hwnd;
600 let answers = answers.to_vec();
601 self.0
602 .executor
603 .spawn(async move {
604 unsafe {
605 let mut config = TASKDIALOGCONFIG::default();
606 config.cbSize = std::mem::size_of::<TASKDIALOGCONFIG>() as _;
607 config.hwndParent = handle;
608 let title;
609 let main_icon;
610 match level {
611 crate::PromptLevel::Info => {
612 title = windows::core::w!("Info");
613 main_icon = TD_INFORMATION_ICON;
614 }
615 crate::PromptLevel::Warning => {
616 title = windows::core::w!("Warning");
617 main_icon = TD_WARNING_ICON;
618 }
619 crate::PromptLevel::Critical => {
620 title = windows::core::w!("Critical");
621 main_icon = TD_ERROR_ICON;
622 }
623 };
624 config.pszWindowTitle = title;
625 config.Anonymous1.pszMainIcon = main_icon;
626 let instruction = HSTRING::from(msg);
627 config.pszMainInstruction = PCWSTR::from_raw(instruction.as_ptr());
628 let hints_encoded;
629 if let Some(ref hints) = detail_string {
630 hints_encoded = HSTRING::from(hints);
631 config.pszContent = PCWSTR::from_raw(hints_encoded.as_ptr());
632 };
633 let mut button_id_map = Vec::with_capacity(answers.len());
634 let mut buttons = Vec::new();
635 let mut btn_encoded = Vec::new();
636 for (index, btn) in answers.iter().enumerate() {
637 let encoded = HSTRING::from(btn.label().as_ref());
638 let button_id = if btn.is_cancel() {
639 IDCANCEL.0
640 } else {
641 index as i32 - 100
642 };
643 button_id_map.push(button_id);
644 buttons.push(TASKDIALOG_BUTTON {
645 nButtonID: button_id,
646 pszButtonText: PCWSTR::from_raw(encoded.as_ptr()),
647 });
648 btn_encoded.push(encoded);
649 }
650 config.cButtons = buttons.len() as _;
651 config.pButtons = buttons.as_ptr();
652
653 config.pfCallback = None;
654 let mut res = std::mem::zeroed();
655 let _ = TaskDialogIndirect(&config, Some(&mut res), None, None)
656 .context("unable to create task dialog")
657 .log_err();
658
659 let clicked = button_id_map
660 .iter()
661 .position(|&button_id| button_id == res)
662 .unwrap();
663 let _ = done_tx.send(clicked);
664 }
665 })
666 .detach();
667
668 Some(done_rx)
669 }
670
671 fn activate(&self) {
672 let hwnd = self.0.hwnd;
673 let this = self.0.clone();
674 self.0
675 .executor
676 .spawn(async move {
677 this.set_window_placement().log_err();
678 unsafe { SetActiveWindow(hwnd).log_err() };
679 unsafe { SetFocus(Some(hwnd)).log_err() };
680
681 // premium ragebait by windows, this is needed because the window
682 // must have received an input event to be able to set itself to foreground
683 // so let's just simulate user input as that seems to be the most reliable way
684 // some more info: https://gist.github.com/Aetopia/1581b40f00cc0cadc93a0e8ccb65dc8c
685 // bonus: this bug also doesn't manifest if you have vs attached to the process
686 let inputs = [
687 INPUT {
688 r#type: INPUT_KEYBOARD,
689 Anonymous: INPUT_0 {
690 ki: KEYBDINPUT {
691 wVk: VK_MENU,
692 dwFlags: KEYBD_EVENT_FLAGS(0),
693 ..Default::default()
694 },
695 },
696 },
697 INPUT {
698 r#type: INPUT_KEYBOARD,
699 Anonymous: INPUT_0 {
700 ki: KEYBDINPUT {
701 wVk: VK_MENU,
702 dwFlags: KEYEVENTF_KEYUP,
703 ..Default::default()
704 },
705 },
706 },
707 ];
708 unsafe { SendInput(&inputs, std::mem::size_of::<INPUT>() as i32) };
709
710 // todo(windows)
711 // crate `windows 0.56` reports true as Err
712 unsafe { SetForegroundWindow(hwnd).as_bool() };
713 })
714 .detach();
715 }
716
717 fn is_active(&self) -> bool {
718 self.0.hwnd == unsafe { GetActiveWindow() }
719 }
720
721 fn is_hovered(&self) -> bool {
722 self.0.state.borrow().hovered
723 }
724
725 fn set_title(&mut self, title: &str) {
726 unsafe { SetWindowTextW(self.0.hwnd, &HSTRING::from(title)) }
727 .inspect_err(|e| log::error!("Set title failed: {e}"))
728 .ok();
729 }
730
731 fn set_background_appearance(&self, background_appearance: WindowBackgroundAppearance) {
732 let hwnd = self.0.hwnd;
733
734 match background_appearance {
735 WindowBackgroundAppearance::Opaque => {
736 // ACCENT_DISABLED
737 set_window_composition_attribute(hwnd, None, 0);
738 }
739 WindowBackgroundAppearance::Transparent => {
740 // Use ACCENT_ENABLE_TRANSPARENTGRADIENT for transparent background
741 set_window_composition_attribute(hwnd, None, 2);
742 }
743 WindowBackgroundAppearance::Blurred => {
744 // Enable acrylic blur
745 // ACCENT_ENABLE_ACRYLICBLURBEHIND
746 set_window_composition_attribute(hwnd, Some((0, 0, 0, 0)), 4);
747 }
748 }
749 }
750
751 fn minimize(&self) {
752 unsafe { ShowWindowAsync(self.0.hwnd, SW_MINIMIZE).ok().log_err() };
753 }
754
755 fn zoom(&self) {
756 unsafe {
757 if IsWindowVisible(self.0.hwnd).as_bool() {
758 ShowWindowAsync(self.0.hwnd, SW_MAXIMIZE).ok().log_err();
759 } else if let Some(status) = self.0.state.borrow_mut().initial_placement.as_mut() {
760 status.state = WindowOpenState::Maximized;
761 }
762 }
763 }
764
765 fn toggle_fullscreen(&self) {
766 if unsafe { IsWindowVisible(self.0.hwnd).as_bool() } {
767 self.0.toggle_fullscreen();
768 } else if let Some(status) = self.0.state.borrow_mut().initial_placement.as_mut() {
769 status.state = WindowOpenState::Fullscreen;
770 }
771 }
772
773 fn is_fullscreen(&self) -> bool {
774 self.0.state.borrow().is_fullscreen()
775 }
776
777 fn on_request_frame(&self, callback: Box<dyn FnMut(RequestFrameOptions)>) {
778 self.0.state.borrow_mut().callbacks.request_frame = Some(callback);
779 }
780
781 fn on_input(&self, callback: Box<dyn FnMut(PlatformInput) -> DispatchEventResult>) {
782 self.0.state.borrow_mut().callbacks.input = Some(callback);
783 }
784
785 fn on_active_status_change(&self, callback: Box<dyn FnMut(bool)>) {
786 self.0.state.borrow_mut().callbacks.active_status_change = Some(callback);
787 }
788
789 fn on_hover_status_change(&self, callback: Box<dyn FnMut(bool)>) {
790 self.0.state.borrow_mut().callbacks.hovered_status_change = Some(callback);
791 }
792
793 fn on_resize(&self, callback: Box<dyn FnMut(Size<Pixels>, f32)>) {
794 self.0.state.borrow_mut().callbacks.resize = Some(callback);
795 }
796
797 fn on_moved(&self, callback: Box<dyn FnMut()>) {
798 self.0.state.borrow_mut().callbacks.moved = Some(callback);
799 }
800
801 fn on_should_close(&self, callback: Box<dyn FnMut() -> bool>) {
802 self.0.state.borrow_mut().callbacks.should_close = Some(callback);
803 }
804
805 fn on_close(&self, callback: Box<dyn FnOnce()>) {
806 self.0.state.borrow_mut().callbacks.close = Some(callback);
807 }
808
809 fn on_hit_test_window_control(&self, callback: Box<dyn FnMut() -> Option<WindowControlArea>>) {
810 self.0.state.borrow_mut().callbacks.hit_test_window_control = Some(callback);
811 }
812
813 fn on_appearance_changed(&self, callback: Box<dyn FnMut()>) {
814 self.0.state.borrow_mut().callbacks.appearance_changed = Some(callback);
815 }
816
817 fn draw(&self, scene: &Scene) {
818 self.0.state.borrow_mut().renderer.draw(scene).log_err();
819 }
820
821 fn sprite_atlas(&self) -> Arc<dyn PlatformAtlas> {
822 self.0.state.borrow().renderer.sprite_atlas()
823 }
824
825 fn get_raw_handle(&self) -> HWND {
826 self.0.hwnd
827 }
828
829 fn gpu_specs(&self) -> Option<GpuSpecs> {
830 self.0.state.borrow().renderer.gpu_specs().log_err()
831 }
832
833 fn update_ime_position(&self, _bounds: Bounds<ScaledPixels>) {
834 // There is no such thing on Windows.
835 }
836}
837
838#[implement(IDropTarget)]
839struct WindowsDragDropHandler(pub Rc<WindowsWindowInner>);
840
841impl WindowsDragDropHandler {
842 fn handle_drag_drop(&self, input: PlatformInput) {
843 let mut lock = self.0.state.borrow_mut();
844 if let Some(mut func) = lock.callbacks.input.take() {
845 drop(lock);
846 func(input);
847 self.0.state.borrow_mut().callbacks.input = Some(func);
848 }
849 }
850}
851
852#[allow(non_snake_case)]
853impl IDropTarget_Impl for WindowsDragDropHandler_Impl {
854 fn DragEnter(
855 &self,
856 pdataobj: windows::core::Ref<IDataObject>,
857 _grfkeystate: MODIFIERKEYS_FLAGS,
858 pt: &POINTL,
859 pdweffect: *mut DROPEFFECT,
860 ) -> windows::core::Result<()> {
861 unsafe {
862 let idata_obj = pdataobj.ok()?;
863 let config = FORMATETC {
864 cfFormat: CF_HDROP.0,
865 ptd: std::ptr::null_mut() as _,
866 dwAspect: DVASPECT_CONTENT.0,
867 lindex: -1,
868 tymed: TYMED_HGLOBAL.0 as _,
869 };
870 let cursor_position = POINT { x: pt.x, y: pt.y };
871 if idata_obj.QueryGetData(&config as _) == S_OK {
872 *pdweffect = DROPEFFECT_COPY;
873 let Some(mut idata) = idata_obj.GetData(&config as _).log_err() else {
874 return Ok(());
875 };
876 if idata.u.hGlobal.is_invalid() {
877 return Ok(());
878 }
879 let hdrop = idata.u.hGlobal.0 as *mut HDROP;
880 let mut paths = SmallVec::<[PathBuf; 2]>::new();
881 with_file_names(*hdrop, |file_name| {
882 if let Some(path) = PathBuf::from_str(&file_name).log_err() {
883 paths.push(path);
884 }
885 });
886 ReleaseStgMedium(&mut idata);
887 let mut cursor_position = cursor_position;
888 ScreenToClient(self.0.hwnd, &mut cursor_position)
889 .ok()
890 .log_err();
891 let scale_factor = self.0.state.borrow().scale_factor;
892 let input = PlatformInput::FileDrop(FileDropEvent::Entered {
893 position: logical_point(
894 cursor_position.x as f32,
895 cursor_position.y as f32,
896 scale_factor,
897 ),
898 paths: ExternalPaths(paths),
899 });
900 self.handle_drag_drop(input);
901 } else {
902 *pdweffect = DROPEFFECT_NONE;
903 }
904 self.0
905 .drop_target_helper
906 .DragEnter(self.0.hwnd, idata_obj, &cursor_position, *pdweffect)
907 .log_err();
908 }
909 Ok(())
910 }
911
912 fn DragOver(
913 &self,
914 _grfkeystate: MODIFIERKEYS_FLAGS,
915 pt: &POINTL,
916 pdweffect: *mut DROPEFFECT,
917 ) -> windows::core::Result<()> {
918 let mut cursor_position = POINT { x: pt.x, y: pt.y };
919 unsafe {
920 *pdweffect = DROPEFFECT_COPY;
921 self.0
922 .drop_target_helper
923 .DragOver(&cursor_position, *pdweffect)
924 .log_err();
925 ScreenToClient(self.0.hwnd, &mut cursor_position)
926 .ok()
927 .log_err();
928 }
929 let scale_factor = self.0.state.borrow().scale_factor;
930 let input = PlatformInput::FileDrop(FileDropEvent::Pending {
931 position: logical_point(
932 cursor_position.x as f32,
933 cursor_position.y as f32,
934 scale_factor,
935 ),
936 });
937 self.handle_drag_drop(input);
938
939 Ok(())
940 }
941
942 fn DragLeave(&self) -> windows::core::Result<()> {
943 unsafe {
944 self.0.drop_target_helper.DragLeave().log_err();
945 }
946 let input = PlatformInput::FileDrop(FileDropEvent::Exited);
947 self.handle_drag_drop(input);
948
949 Ok(())
950 }
951
952 fn Drop(
953 &self,
954 pdataobj: windows::core::Ref<IDataObject>,
955 _grfkeystate: MODIFIERKEYS_FLAGS,
956 pt: &POINTL,
957 pdweffect: *mut DROPEFFECT,
958 ) -> windows::core::Result<()> {
959 let idata_obj = pdataobj.ok()?;
960 let mut cursor_position = POINT { x: pt.x, y: pt.y };
961 unsafe {
962 *pdweffect = DROPEFFECT_COPY;
963 self.0
964 .drop_target_helper
965 .Drop(idata_obj, &cursor_position, *pdweffect)
966 .log_err();
967 ScreenToClient(self.0.hwnd, &mut cursor_position)
968 .ok()
969 .log_err();
970 }
971 let scale_factor = self.0.state.borrow().scale_factor;
972 let input = PlatformInput::FileDrop(FileDropEvent::Submit {
973 position: logical_point(
974 cursor_position.x as f32,
975 cursor_position.y as f32,
976 scale_factor,
977 ),
978 });
979 self.handle_drag_drop(input);
980
981 Ok(())
982 }
983}
984
985#[derive(Debug, Clone, Copy)]
986pub(crate) struct ClickState {
987 button: MouseButton,
988 last_click: Instant,
989 last_position: Point<DevicePixels>,
990 double_click_spatial_tolerance_width: i32,
991 double_click_spatial_tolerance_height: i32,
992 double_click_interval: Duration,
993 pub(crate) current_count: usize,
994}
995
996impl ClickState {
997 pub fn new() -> Self {
998 let double_click_spatial_tolerance_width = unsafe { GetSystemMetrics(SM_CXDOUBLECLK) };
999 let double_click_spatial_tolerance_height = unsafe { GetSystemMetrics(SM_CYDOUBLECLK) };
1000 let double_click_interval = Duration::from_millis(unsafe { GetDoubleClickTime() } as u64);
1001
1002 ClickState {
1003 button: MouseButton::Left,
1004 last_click: Instant::now(),
1005 last_position: Point::default(),
1006 double_click_spatial_tolerance_width,
1007 double_click_spatial_tolerance_height,
1008 double_click_interval,
1009 current_count: 0,
1010 }
1011 }
1012
1013 /// update self and return the needed click count
1014 pub fn update(&mut self, button: MouseButton, new_position: Point<DevicePixels>) -> usize {
1015 if self.button == button && self.is_double_click(new_position) {
1016 self.current_count += 1;
1017 } else {
1018 self.current_count = 1;
1019 }
1020 self.last_click = Instant::now();
1021 self.last_position = new_position;
1022 self.button = button;
1023
1024 self.current_count
1025 }
1026
1027 pub fn system_update(&mut self, wparam: usize) {
1028 match wparam {
1029 // SPI_SETDOUBLECLKWIDTH
1030 29 => {
1031 self.double_click_spatial_tolerance_width =
1032 unsafe { GetSystemMetrics(SM_CXDOUBLECLK) }
1033 }
1034 // SPI_SETDOUBLECLKHEIGHT
1035 30 => {
1036 self.double_click_spatial_tolerance_height =
1037 unsafe { GetSystemMetrics(SM_CYDOUBLECLK) }
1038 }
1039 // SPI_SETDOUBLECLICKTIME
1040 32 => {
1041 self.double_click_interval =
1042 Duration::from_millis(unsafe { GetDoubleClickTime() } as u64)
1043 }
1044 _ => {}
1045 }
1046 }
1047
1048 #[inline]
1049 fn is_double_click(&self, new_position: Point<DevicePixels>) -> bool {
1050 let diff = self.last_position - new_position;
1051
1052 self.last_click.elapsed() < self.double_click_interval
1053 && diff.x.0.abs() <= self.double_click_spatial_tolerance_width
1054 && diff.y.0.abs() <= self.double_click_spatial_tolerance_height
1055 }
1056}
1057
1058struct StyleAndBounds {
1059 style: WINDOW_STYLE,
1060 x: i32,
1061 y: i32,
1062 cx: i32,
1063 cy: i32,
1064}
1065
1066#[repr(C)]
1067struct WINDOWCOMPOSITIONATTRIBDATA {
1068 attrib: u32,
1069 pv_data: *mut std::ffi::c_void,
1070 cb_data: usize,
1071}
1072
1073#[repr(C)]
1074struct AccentPolicy {
1075 accent_state: u32,
1076 accent_flags: u32,
1077 gradient_color: u32,
1078 animation_id: u32,
1079}
1080
1081type Color = (u8, u8, u8, u8);
1082
1083#[derive(Debug, Default, Clone, Copy)]
1084pub(crate) struct WindowBorderOffset {
1085 pub(crate) width_offset: i32,
1086 pub(crate) height_offset: i32,
1087}
1088
1089impl WindowBorderOffset {
1090 pub(crate) fn update(&mut self, hwnd: HWND) -> anyhow::Result<()> {
1091 let window_rect = unsafe {
1092 let mut rect = std::mem::zeroed();
1093 GetWindowRect(hwnd, &mut rect)?;
1094 rect
1095 };
1096 let client_rect = unsafe {
1097 let mut rect = std::mem::zeroed();
1098 GetClientRect(hwnd, &mut rect)?;
1099 rect
1100 };
1101 self.width_offset =
1102 (window_rect.right - window_rect.left) - (client_rect.right - client_rect.left);
1103 self.height_offset =
1104 (window_rect.bottom - window_rect.top) - (client_rect.bottom - client_rect.top);
1105 Ok(())
1106 }
1107}
1108
1109struct WindowOpenStatus {
1110 placement: WINDOWPLACEMENT,
1111 state: WindowOpenState,
1112}
1113
1114enum WindowOpenState {
1115 Maximized,
1116 Fullscreen,
1117 Windowed,
1118}
1119
1120const WINDOW_CLASS_NAME: PCWSTR = w!("Zed::Window");
1121
1122fn register_window_class(icon_handle: HICON) {
1123 static ONCE: Once = Once::new();
1124 ONCE.call_once(|| {
1125 let wc = WNDCLASSW {
1126 lpfnWndProc: Some(window_procedure),
1127 hIcon: icon_handle,
1128 lpszClassName: PCWSTR(WINDOW_CLASS_NAME.as_ptr()),
1129 style: CS_HREDRAW | CS_VREDRAW,
1130 hInstance: get_module_handle().into(),
1131 hbrBackground: unsafe { CreateSolidBrush(COLORREF(0x00000000)) },
1132 ..Default::default()
1133 };
1134 unsafe { RegisterClassW(&wc) };
1135 });
1136}
1137
1138unsafe extern "system" fn window_procedure(
1139 hwnd: HWND,
1140 msg: u32,
1141 wparam: WPARAM,
1142 lparam: LPARAM,
1143) -> LRESULT {
1144 if msg == WM_NCCREATE {
1145 let window_params = lparam.0 as *const CREATESTRUCTW;
1146 let window_params = unsafe { &*window_params };
1147 let window_creation_context = window_params.lpCreateParams as *mut WindowCreateContext;
1148 let window_creation_context = unsafe { &mut *window_creation_context };
1149 return match WindowsWindowInner::new(window_creation_context, hwnd, window_params) {
1150 Ok(window_state) => {
1151 let weak = Box::new(Rc::downgrade(&window_state));
1152 unsafe { set_window_long(hwnd, GWLP_USERDATA, Box::into_raw(weak) as isize) };
1153 window_creation_context.inner = Some(Ok(window_state));
1154 unsafe { DefWindowProcW(hwnd, msg, wparam, lparam) }
1155 }
1156 Err(error) => {
1157 window_creation_context.inner = Some(Err(error));
1158 LRESULT(0)
1159 }
1160 };
1161 }
1162
1163 let ptr = unsafe { get_window_long(hwnd, GWLP_USERDATA) } as *mut Weak<WindowsWindowInner>;
1164 if ptr.is_null() {
1165 return unsafe { DefWindowProcW(hwnd, msg, wparam, lparam) };
1166 }
1167 let inner = unsafe { &*ptr };
1168 let result = if let Some(inner) = inner.upgrade() {
1169 inner.handle_msg(hwnd, msg, wparam, lparam)
1170 } else {
1171 unsafe { DefWindowProcW(hwnd, msg, wparam, lparam) }
1172 };
1173
1174 if msg == WM_NCDESTROY {
1175 unsafe { set_window_long(hwnd, GWLP_USERDATA, 0) };
1176 unsafe { drop(Box::from_raw(ptr)) };
1177 }
1178
1179 result
1180}
1181
1182pub(crate) fn window_from_hwnd(hwnd: HWND) -> Option<Rc<WindowsWindowInner>> {
1183 if hwnd.is_invalid() {
1184 return None;
1185 }
1186
1187 let ptr = unsafe { get_window_long(hwnd, GWLP_USERDATA) } as *mut Weak<WindowsWindowInner>;
1188 if !ptr.is_null() {
1189 let inner = unsafe { &*ptr };
1190 inner.upgrade()
1191 } else {
1192 None
1193 }
1194}
1195
1196fn get_module_handle() -> HMODULE {
1197 unsafe {
1198 let mut h_module = std::mem::zeroed();
1199 GetModuleHandleExW(
1200 GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS | GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT,
1201 windows::core::w!("ZedModule"),
1202 &mut h_module,
1203 )
1204 .expect("Unable to get module handle"); // this should never fail
1205
1206 h_module
1207 }
1208}
1209
1210fn register_drag_drop(window: &Rc<WindowsWindowInner>) -> Result<()> {
1211 let window_handle = window.hwnd;
1212 let handler = WindowsDragDropHandler(window.clone());
1213 // The lifetime of `IDropTarget` is handled by Windows, it won't release until
1214 // we call `RevokeDragDrop`.
1215 // So, it's safe to drop it here.
1216 let drag_drop_handler: IDropTarget = handler.into();
1217 unsafe {
1218 RegisterDragDrop(window_handle, &drag_drop_handler)
1219 .context("unable to register drag-drop event")?;
1220 }
1221 Ok(())
1222}
1223
1224fn calculate_window_rect(bounds: Bounds<DevicePixels>, border_offset: WindowBorderOffset) -> RECT {
1225 // NOTE:
1226 // The reason we're not using `AdjustWindowRectEx()` here is
1227 // that the size reported by this function is incorrect.
1228 // You can test it, and there are similar discussions online.
1229 // See: https://stackoverflow.com/questions/12423584/how-to-set-exact-client-size-for-overlapped-window-winapi
1230 //
1231 // So we manually calculate these values here.
1232 let mut rect = RECT {
1233 left: bounds.left().0,
1234 top: bounds.top().0,
1235 right: bounds.right().0,
1236 bottom: bounds.bottom().0,
1237 };
1238 let left_offset = border_offset.width_offset / 2;
1239 let top_offset = border_offset.height_offset / 2;
1240 let right_offset = border_offset.width_offset - left_offset;
1241 let bottom_offset = border_offset.height_offset - top_offset;
1242 rect.left -= left_offset;
1243 rect.top -= top_offset;
1244 rect.right += right_offset;
1245 rect.bottom += bottom_offset;
1246 rect
1247}
1248
1249fn calculate_client_rect(
1250 rect: RECT,
1251 border_offset: WindowBorderOffset,
1252 scale_factor: f32,
1253) -> Bounds<Pixels> {
1254 let left_offset = border_offset.width_offset / 2;
1255 let top_offset = border_offset.height_offset / 2;
1256 let right_offset = border_offset.width_offset - left_offset;
1257 let bottom_offset = border_offset.height_offset - top_offset;
1258 let left = rect.left + left_offset;
1259 let top = rect.top + top_offset;
1260 let right = rect.right - right_offset;
1261 let bottom = rect.bottom - bottom_offset;
1262 let physical_size = size(DevicePixels(right - left), DevicePixels(bottom - top));
1263 Bounds {
1264 origin: logical_point(left as f32, top as f32, scale_factor),
1265 size: physical_size.to_pixels(scale_factor),
1266 }
1267}
1268
1269fn retrieve_window_placement(
1270 hwnd: HWND,
1271 display: WindowsDisplay,
1272 initial_bounds: Bounds<Pixels>,
1273 scale_factor: f32,
1274 border_offset: WindowBorderOffset,
1275) -> Result<WINDOWPLACEMENT> {
1276 let mut placement = WINDOWPLACEMENT {
1277 length: std::mem::size_of::<WINDOWPLACEMENT>() as u32,
1278 ..Default::default()
1279 };
1280 unsafe { GetWindowPlacement(hwnd, &mut placement)? };
1281 // the bounds may be not inside the display
1282 let bounds = if display.check_given_bounds(initial_bounds) {
1283 initial_bounds
1284 } else {
1285 display.default_bounds()
1286 };
1287 let bounds = bounds.to_device_pixels(scale_factor);
1288 placement.rcNormalPosition = calculate_window_rect(bounds, border_offset);
1289 Ok(placement)
1290}
1291
1292fn set_window_composition_attribute(hwnd: HWND, color: Option<Color>, state: u32) {
1293 let mut version = unsafe { std::mem::zeroed() };
1294 let status = unsafe { windows::Wdk::System::SystemServices::RtlGetVersion(&mut version) };
1295 if !status.is_ok() || version.dwBuildNumber < 17763 {
1296 return;
1297 }
1298
1299 unsafe {
1300 type SetWindowCompositionAttributeType =
1301 unsafe extern "system" fn(HWND, *mut WINDOWCOMPOSITIONATTRIBDATA) -> BOOL;
1302 let module_name = PCSTR::from_raw(c"user32.dll".as_ptr() as *const u8);
1303 if let Some(user32) = GetModuleHandleA(module_name)
1304 .context("Unable to get user32.dll handle")
1305 .log_err()
1306 {
1307 let func_name = PCSTR::from_raw(c"SetWindowCompositionAttribute".as_ptr() as *const u8);
1308 let set_window_composition_attribute: SetWindowCompositionAttributeType =
1309 std::mem::transmute(GetProcAddress(user32, func_name));
1310 let mut color = color.unwrap_or_default();
1311 let is_acrylic = state == 4;
1312 if is_acrylic && color.3 == 0 {
1313 color.3 = 1;
1314 }
1315 let accent = AccentPolicy {
1316 accent_state: state,
1317 accent_flags: if is_acrylic { 0 } else { 2 },
1318 gradient_color: (color.0 as u32)
1319 | ((color.1 as u32) << 8)
1320 | ((color.2 as u32) << 16)
1321 | ((color.3 as u32) << 24),
1322 animation_id: 0,
1323 };
1324 let mut data = WINDOWCOMPOSITIONATTRIBDATA {
1325 attrib: 0x13,
1326 pv_data: &accent as *const _ as *mut _,
1327 cb_data: std::mem::size_of::<AccentPolicy>(),
1328 };
1329 let _ = set_window_composition_attribute(hwnd, &mut data as *mut _ as _);
1330 }
1331 }
1332}
1333
1334#[cfg(test)]
1335mod tests {
1336 use super::ClickState;
1337 use crate::{DevicePixels, MouseButton, point};
1338 use std::time::Duration;
1339
1340 #[test]
1341 fn test_double_click_interval() {
1342 let mut state = ClickState::new();
1343 assert_eq!(
1344 state.update(MouseButton::Left, point(DevicePixels(0), DevicePixels(0))),
1345 1
1346 );
1347 assert_eq!(
1348 state.update(MouseButton::Right, point(DevicePixels(0), DevicePixels(0))),
1349 1
1350 );
1351 assert_eq!(
1352 state.update(MouseButton::Left, point(DevicePixels(0), DevicePixels(0))),
1353 1
1354 );
1355 assert_eq!(
1356 state.update(MouseButton::Left, point(DevicePixels(0), DevicePixels(0))),
1357 2
1358 );
1359 state.last_click -= Duration::from_millis(700);
1360 assert_eq!(
1361 state.update(MouseButton::Left, point(DevicePixels(0), DevicePixels(0))),
1362 1
1363 );
1364 }
1365
1366 #[test]
1367 fn test_double_click_spatial_tolerance() {
1368 let mut state = ClickState::new();
1369 assert_eq!(
1370 state.update(MouseButton::Left, point(DevicePixels(-3), DevicePixels(0))),
1371 1
1372 );
1373 assert_eq!(
1374 state.update(MouseButton::Left, point(DevicePixels(0), DevicePixels(3))),
1375 2
1376 );
1377 assert_eq!(
1378 state.update(MouseButton::Right, point(DevicePixels(3), DevicePixels(2))),
1379 1
1380 );
1381 assert_eq!(
1382 state.update(MouseButton::Right, point(DevicePixels(10), DevicePixels(0))),
1383 1
1384 );
1385 }
1386}