1use super::{ns_string, renderer, MacDisplay, NSRange, NSStringExt};
2use crate::{
3 platform::PlatformInputHandler, point, px, size, AnyWindowHandle, Bounds, DisplayLink,
4 ExternalPaths, FileDropEvent, ForegroundExecutor, KeyDownEvent, Keystroke, Modifiers,
5 ModifiersChangedEvent, MouseButton, MouseDownEvent, MouseMoveEvent, MouseUpEvent, Pixels,
6 PlatformAtlas, PlatformDisplay, PlatformInput, PlatformWindow, Point, PromptLevel, Size, Timer,
7 WindowAppearance, WindowBackgroundAppearance, WindowBounds, WindowKind, WindowParams,
8};
9use block::ConcreteBlock;
10use cocoa::{
11 appkit::{
12 CGPoint, NSApplication, NSBackingStoreBuffered, NSColor, NSEvent, NSEventModifierFlags,
13 NSFilenamesPboardType, NSPasteboard, NSScreen, NSView, NSViewHeightSizable,
14 NSViewWidthSizable, NSWindow, NSWindowButton, NSWindowCollectionBehavior,
15 NSWindowOcclusionState, NSWindowStyleMask, NSWindowTitleVisibility,
16 },
17 base::{id, nil},
18 foundation::{
19 NSArray, NSAutoreleasePool, NSDictionary, NSFastEnumeration, NSInteger, NSPoint, NSRect,
20 NSSize, NSString, NSUInteger,
21 },
22};
23use core_graphics::display::{CGDirectDisplayID, CGRect};
24use ctor::ctor;
25use futures::channel::oneshot;
26use objc::{
27 class,
28 declare::ClassDecl,
29 msg_send,
30 runtime::{Class, Object, Protocol, Sel, BOOL, NO, YES},
31 sel, sel_impl,
32};
33use parking_lot::Mutex;
34use raw_window_handle as rwh;
35use smallvec::SmallVec;
36use std::{
37 cell::Cell,
38 ffi::{c_void, CStr},
39 mem,
40 ops::Range,
41 path::PathBuf,
42 ptr::{self, NonNull},
43 rc::Rc,
44 sync::{Arc, Weak},
45 time::Duration,
46};
47use util::ResultExt;
48
49const WINDOW_STATE_IVAR: &str = "windowState";
50
51static mut WINDOW_CLASS: *const Class = ptr::null();
52static mut PANEL_CLASS: *const Class = ptr::null();
53static mut VIEW_CLASS: *const Class = ptr::null();
54
55#[allow(non_upper_case_globals)]
56const NSWindowStyleMaskNonactivatingPanel: NSWindowStyleMask =
57 unsafe { NSWindowStyleMask::from_bits_unchecked(1 << 7) };
58#[allow(non_upper_case_globals)]
59const NSNormalWindowLevel: NSInteger = 0;
60#[allow(non_upper_case_globals)]
61const NSPopUpWindowLevel: NSInteger = 101;
62#[allow(non_upper_case_globals)]
63const NSTrackingMouseEnteredAndExited: NSUInteger = 0x01;
64#[allow(non_upper_case_globals)]
65const NSTrackingMouseMoved: NSUInteger = 0x02;
66#[allow(non_upper_case_globals)]
67const NSTrackingActiveAlways: NSUInteger = 0x80;
68#[allow(non_upper_case_globals)]
69const NSTrackingInVisibleRect: NSUInteger = 0x200;
70#[allow(non_upper_case_globals)]
71const NSWindowAnimationBehaviorUtilityWindow: NSInteger = 4;
72#[allow(non_upper_case_globals)]
73const NSViewLayerContentsRedrawDuringViewResize: NSInteger = 2;
74// https://developer.apple.com/documentation/appkit/nsdragoperation
75type NSDragOperation = NSUInteger;
76#[allow(non_upper_case_globals)]
77const NSDragOperationNone: NSDragOperation = 0;
78#[allow(non_upper_case_globals)]
79const NSDragOperationCopy: NSDragOperation = 1;
80
81#[link(name = "CoreGraphics", kind = "framework")]
82extern "C" {
83 // Widely used private APIs; Apple uses them for their Terminal.app.
84 fn CGSMainConnectionID() -> id;
85 fn CGSSetWindowBackgroundBlurRadius(
86 connection_id: id,
87 window_id: NSInteger,
88 radius: i64,
89 ) -> i32;
90}
91
92#[ctor]
93unsafe fn build_classes() {
94 WINDOW_CLASS = build_window_class("GPUIWindow", class!(NSWindow));
95 PANEL_CLASS = build_window_class("GPUIPanel", class!(NSPanel));
96 VIEW_CLASS = {
97 let mut decl = ClassDecl::new("GPUIView", class!(NSView)).unwrap();
98 decl.add_ivar::<*mut c_void>(WINDOW_STATE_IVAR);
99
100 decl.add_method(sel!(dealloc), dealloc_view as extern "C" fn(&Object, Sel));
101
102 decl.add_method(
103 sel!(performKeyEquivalent:),
104 handle_key_equivalent as extern "C" fn(&Object, Sel, id) -> BOOL,
105 );
106 decl.add_method(
107 sel!(keyDown:),
108 handle_key_down as extern "C" fn(&Object, Sel, id),
109 );
110 decl.add_method(
111 sel!(mouseDown:),
112 handle_view_event as extern "C" fn(&Object, Sel, id),
113 );
114 decl.add_method(
115 sel!(mouseUp:),
116 handle_view_event as extern "C" fn(&Object, Sel, id),
117 );
118 decl.add_method(
119 sel!(rightMouseDown:),
120 handle_view_event as extern "C" fn(&Object, Sel, id),
121 );
122 decl.add_method(
123 sel!(rightMouseUp:),
124 handle_view_event as extern "C" fn(&Object, Sel, id),
125 );
126 decl.add_method(
127 sel!(otherMouseDown:),
128 handle_view_event as extern "C" fn(&Object, Sel, id),
129 );
130 decl.add_method(
131 sel!(otherMouseUp:),
132 handle_view_event as extern "C" fn(&Object, Sel, id),
133 );
134 decl.add_method(
135 sel!(mouseMoved:),
136 handle_view_event as extern "C" fn(&Object, Sel, id),
137 );
138 decl.add_method(
139 sel!(mouseExited:),
140 handle_view_event as extern "C" fn(&Object, Sel, id),
141 );
142 decl.add_method(
143 sel!(mouseDragged:),
144 handle_view_event as extern "C" fn(&Object, Sel, id),
145 );
146 decl.add_method(
147 sel!(scrollWheel:),
148 handle_view_event as extern "C" fn(&Object, Sel, id),
149 );
150 decl.add_method(
151 sel!(flagsChanged:),
152 handle_view_event as extern "C" fn(&Object, Sel, id),
153 );
154 decl.add_method(
155 sel!(cancelOperation:),
156 cancel_operation as extern "C" fn(&Object, Sel, id),
157 );
158
159 decl.add_method(
160 sel!(makeBackingLayer),
161 make_backing_layer as extern "C" fn(&Object, Sel) -> id,
162 );
163
164 decl.add_protocol(Protocol::get("CALayerDelegate").unwrap());
165 decl.add_method(
166 sel!(viewDidChangeBackingProperties),
167 view_did_change_backing_properties as extern "C" fn(&Object, Sel),
168 );
169 decl.add_method(
170 sel!(setFrameSize:),
171 set_frame_size as extern "C" fn(&Object, Sel, NSSize),
172 );
173 decl.add_method(
174 sel!(displayLayer:),
175 display_layer as extern "C" fn(&Object, Sel, id),
176 );
177
178 decl.add_protocol(Protocol::get("NSTextInputClient").unwrap());
179 decl.add_method(
180 sel!(validAttributesForMarkedText),
181 valid_attributes_for_marked_text as extern "C" fn(&Object, Sel) -> id,
182 );
183 decl.add_method(
184 sel!(hasMarkedText),
185 has_marked_text as extern "C" fn(&Object, Sel) -> BOOL,
186 );
187 decl.add_method(
188 sel!(markedRange),
189 marked_range as extern "C" fn(&Object, Sel) -> NSRange,
190 );
191 decl.add_method(
192 sel!(selectedRange),
193 selected_range as extern "C" fn(&Object, Sel) -> NSRange,
194 );
195 decl.add_method(
196 sel!(firstRectForCharacterRange:actualRange:),
197 first_rect_for_character_range as extern "C" fn(&Object, Sel, NSRange, id) -> NSRect,
198 );
199 decl.add_method(
200 sel!(insertText:replacementRange:),
201 insert_text as extern "C" fn(&Object, Sel, id, NSRange),
202 );
203 decl.add_method(
204 sel!(setMarkedText:selectedRange:replacementRange:),
205 set_marked_text as extern "C" fn(&Object, Sel, id, NSRange, NSRange),
206 );
207 decl.add_method(sel!(unmarkText), unmark_text as extern "C" fn(&Object, Sel));
208 decl.add_method(
209 sel!(attributedSubstringForProposedRange:actualRange:),
210 attributed_substring_for_proposed_range
211 as extern "C" fn(&Object, Sel, NSRange, *mut c_void) -> id,
212 );
213 decl.add_method(
214 sel!(viewDidChangeEffectiveAppearance),
215 view_did_change_effective_appearance as extern "C" fn(&Object, Sel),
216 );
217
218 // Suppress beep on keystrokes with modifier keys.
219 decl.add_method(
220 sel!(doCommandBySelector:),
221 do_command_by_selector as extern "C" fn(&Object, Sel, Sel),
222 );
223
224 decl.add_method(
225 sel!(acceptsFirstMouse:),
226 accepts_first_mouse as extern "C" fn(&Object, Sel, id) -> BOOL,
227 );
228
229 decl.register()
230 };
231}
232
233pub(crate) fn convert_mouse_position(position: NSPoint, window_height: Pixels) -> Point<Pixels> {
234 point(
235 px(position.x as f32),
236 // MacOS screen coordinates are relative to bottom left
237 window_height - px(position.y as f32),
238 )
239}
240
241unsafe fn build_window_class(name: &'static str, superclass: &Class) -> *const Class {
242 let mut decl = ClassDecl::new(name, superclass).unwrap();
243 decl.add_ivar::<*mut c_void>(WINDOW_STATE_IVAR);
244 decl.add_method(sel!(dealloc), dealloc_window as extern "C" fn(&Object, Sel));
245 decl.add_method(
246 sel!(canBecomeMainWindow),
247 yes as extern "C" fn(&Object, Sel) -> BOOL,
248 );
249 decl.add_method(
250 sel!(canBecomeKeyWindow),
251 yes as extern "C" fn(&Object, Sel) -> BOOL,
252 );
253 decl.add_method(
254 sel!(windowDidResize:),
255 window_did_resize as extern "C" fn(&Object, Sel, id),
256 );
257 decl.add_method(
258 sel!(windowDidChangeOcclusionState:),
259 window_did_change_occlusion_state as extern "C" fn(&Object, Sel, id),
260 );
261 decl.add_method(
262 sel!(windowWillEnterFullScreen:),
263 window_will_enter_fullscreen as extern "C" fn(&Object, Sel, id),
264 );
265 decl.add_method(
266 sel!(windowDidMove:),
267 window_did_move as extern "C" fn(&Object, Sel, id),
268 );
269 decl.add_method(
270 sel!(windowDidChangeScreen:),
271 window_did_change_screen as extern "C" fn(&Object, Sel, id),
272 );
273 decl.add_method(
274 sel!(windowDidBecomeKey:),
275 window_did_change_key_status as extern "C" fn(&Object, Sel, id),
276 );
277 decl.add_method(
278 sel!(windowDidResignKey:),
279 window_did_change_key_status as extern "C" fn(&Object, Sel, id),
280 );
281 decl.add_method(
282 sel!(windowShouldClose:),
283 window_should_close as extern "C" fn(&Object, Sel, id) -> BOOL,
284 );
285
286 decl.add_method(sel!(close), close_window as extern "C" fn(&Object, Sel));
287
288 decl.add_method(
289 sel!(draggingEntered:),
290 dragging_entered as extern "C" fn(&Object, Sel, id) -> NSDragOperation,
291 );
292 decl.add_method(
293 sel!(draggingUpdated:),
294 dragging_updated as extern "C" fn(&Object, Sel, id) -> NSDragOperation,
295 );
296 decl.add_method(
297 sel!(draggingExited:),
298 dragging_exited as extern "C" fn(&Object, Sel, id),
299 );
300 decl.add_method(
301 sel!(performDragOperation:),
302 perform_drag_operation as extern "C" fn(&Object, Sel, id) -> BOOL,
303 );
304 decl.add_method(
305 sel!(concludeDragOperation:),
306 conclude_drag_operation as extern "C" fn(&Object, Sel, id),
307 );
308
309 decl.register()
310}
311
312#[allow(clippy::enum_variant_names)]
313#[derive(Clone, Debug)]
314enum ImeInput {
315 InsertText(String, Option<Range<usize>>),
316 SetMarkedText(String, Option<Range<usize>>, Option<Range<usize>>),
317 UnmarkText,
318}
319
320struct MacWindowState {
321 handle: AnyWindowHandle,
322 executor: ForegroundExecutor,
323 native_window: id,
324 native_view: NonNull<Object>,
325 display_link: Option<DisplayLink>,
326 renderer: renderer::Renderer,
327 request_frame_callback: Option<Box<dyn FnMut()>>,
328 event_callback: Option<Box<dyn FnMut(PlatformInput) -> crate::DispatchEventResult>>,
329 activate_callback: Option<Box<dyn FnMut(bool)>>,
330 resize_callback: Option<Box<dyn FnMut(Size<Pixels>, f32)>>,
331 moved_callback: Option<Box<dyn FnMut()>>,
332 should_close_callback: Option<Box<dyn FnMut() -> bool>>,
333 close_callback: Option<Box<dyn FnOnce()>>,
334 appearance_changed_callback: Option<Box<dyn FnMut()>>,
335 input_handler: Option<PlatformInputHandler>,
336 last_key_equivalent: Option<KeyDownEvent>,
337 synthetic_drag_counter: usize,
338 traffic_light_position: Option<Point<Pixels>>,
339 previous_modifiers_changed_event: Option<PlatformInput>,
340 // State tracking what the IME did after the last request
341 last_ime_inputs: Option<SmallVec<[(String, Option<Range<usize>>); 1]>>,
342 previous_keydown_inserted_text: Option<String>,
343 external_files_dragged: bool,
344 // Whether the next left-mouse click is also the focusing click.
345 first_mouse: bool,
346 fullscreen_restore_bounds: Bounds<Pixels>,
347 ime_composing: bool,
348}
349
350impl MacWindowState {
351 fn move_traffic_light(&self) {
352 if let Some(traffic_light_position) = self.traffic_light_position {
353 if self.is_fullscreen() {
354 // Moving traffic lights while fullscreen doesn't work,
355 // see https://github.com/zed-industries/zed/issues/4712
356 return;
357 }
358
359 let titlebar_height = self.titlebar_height();
360
361 unsafe {
362 let close_button: id = msg_send![
363 self.native_window,
364 standardWindowButton: NSWindowButton::NSWindowCloseButton
365 ];
366 let min_button: id = msg_send![
367 self.native_window,
368 standardWindowButton: NSWindowButton::NSWindowMiniaturizeButton
369 ];
370 let zoom_button: id = msg_send![
371 self.native_window,
372 standardWindowButton: NSWindowButton::NSWindowZoomButton
373 ];
374
375 let mut close_button_frame: CGRect = msg_send![close_button, frame];
376 let mut min_button_frame: CGRect = msg_send![min_button, frame];
377 let mut zoom_button_frame: CGRect = msg_send![zoom_button, frame];
378 let mut origin = point(
379 traffic_light_position.x,
380 titlebar_height
381 - traffic_light_position.y
382 - px(close_button_frame.size.height as f32),
383 );
384 let button_spacing =
385 px((min_button_frame.origin.x - close_button_frame.origin.x) as f32);
386
387 close_button_frame.origin = CGPoint::new(origin.x.into(), origin.y.into());
388 let _: () = msg_send![close_button, setFrame: close_button_frame];
389 origin.x += button_spacing;
390
391 min_button_frame.origin = CGPoint::new(origin.x.into(), origin.y.into());
392 let _: () = msg_send![min_button, setFrame: min_button_frame];
393 origin.x += button_spacing;
394
395 zoom_button_frame.origin = CGPoint::new(origin.x.into(), origin.y.into());
396 let _: () = msg_send![zoom_button, setFrame: zoom_button_frame];
397 origin.x += button_spacing;
398 }
399 }
400 }
401
402 fn start_display_link(&mut self) {
403 self.stop_display_link();
404 unsafe {
405 if !self
406 .native_window
407 .occlusionState()
408 .contains(NSWindowOcclusionState::NSWindowOcclusionStateVisible)
409 {
410 return;
411 }
412 }
413 let display_id = unsafe { display_id_for_screen(self.native_window.screen()) };
414 if let Some(mut display_link) =
415 DisplayLink::new(display_id, self.native_view.as_ptr() as *mut c_void, step).log_err()
416 {
417 display_link.start().log_err();
418 self.display_link = Some(display_link);
419 }
420 }
421
422 fn stop_display_link(&mut self) {
423 self.display_link = None;
424 }
425
426 fn is_maximized(&self) -> bool {
427 unsafe {
428 let bounds = self.bounds();
429 let screen_size = self.native_window.screen().visibleFrame().into();
430 bounds.size == screen_size
431 }
432 }
433
434 fn is_fullscreen(&self) -> bool {
435 unsafe {
436 let style_mask = self.native_window.styleMask();
437 style_mask.contains(NSWindowStyleMask::NSFullScreenWindowMask)
438 }
439 }
440
441 fn bounds(&self) -> Bounds<Pixels> {
442 let mut window_frame = unsafe { NSWindow::frame(self.native_window) };
443 let screen_frame = unsafe {
444 let screen = NSWindow::screen(self.native_window);
445 NSScreen::frame(screen)
446 };
447
448 // Flip the y coordinate to be top-left origin
449 window_frame.origin.y =
450 screen_frame.size.height - window_frame.origin.y - window_frame.size.height;
451
452 let bounds = Bounds::new(
453 point(
454 px((window_frame.origin.x - screen_frame.origin.x) as f32),
455 px((window_frame.origin.y - screen_frame.origin.y) as f32),
456 ),
457 size(
458 px(window_frame.size.width as f32),
459 px(window_frame.size.height as f32),
460 ),
461 );
462 bounds
463 }
464
465 fn content_size(&self) -> Size<Pixels> {
466 let NSSize { width, height, .. } =
467 unsafe { NSView::frame(self.native_window.contentView()) }.size;
468 size(px(width as f32), px(height as f32))
469 }
470
471 fn scale_factor(&self) -> f32 {
472 get_scale_factor(self.native_window)
473 }
474
475 fn titlebar_height(&self) -> Pixels {
476 unsafe {
477 let frame = NSWindow::frame(self.native_window);
478 let content_layout_rect: CGRect = msg_send![self.native_window, contentLayoutRect];
479 px((frame.size.height - content_layout_rect.size.height) as f32)
480 }
481 }
482
483 fn window_bounds(&self) -> WindowBounds {
484 if self.is_fullscreen() {
485 WindowBounds::Fullscreen(self.fullscreen_restore_bounds)
486 } else {
487 WindowBounds::Windowed(self.bounds())
488 }
489 }
490}
491
492unsafe impl Send for MacWindowState {}
493
494pub(crate) struct MacWindow(Arc<Mutex<MacWindowState>>);
495
496impl MacWindow {
497 pub fn open(
498 handle: AnyWindowHandle,
499 WindowParams {
500 window_background,
501 bounds,
502 titlebar,
503 kind,
504 is_movable,
505 focus,
506 show,
507 display_id,
508 window_min_size,
509 }: WindowParams,
510 executor: ForegroundExecutor,
511 renderer_context: renderer::Context,
512 ) -> Self {
513 unsafe {
514 let pool = NSAutoreleasePool::new(nil);
515
516 let mut style_mask;
517 if let Some(titlebar) = titlebar.as_ref() {
518 style_mask = NSWindowStyleMask::NSClosableWindowMask
519 | NSWindowStyleMask::NSMiniaturizableWindowMask
520 | NSWindowStyleMask::NSResizableWindowMask
521 | NSWindowStyleMask::NSTitledWindowMask;
522
523 if titlebar.appears_transparent {
524 style_mask |= NSWindowStyleMask::NSFullSizeContentViewWindowMask;
525 }
526 } else {
527 style_mask = NSWindowStyleMask::NSTitledWindowMask
528 | NSWindowStyleMask::NSFullSizeContentViewWindowMask;
529 }
530
531 let native_window: id = match kind {
532 WindowKind::Normal => msg_send![WINDOW_CLASS, alloc],
533 WindowKind::PopUp => {
534 style_mask |= NSWindowStyleMaskNonactivatingPanel;
535 msg_send![PANEL_CLASS, alloc]
536 }
537 };
538
539 let display = display_id
540 .and_then(MacDisplay::find_by_id)
541 .unwrap_or_else(|| MacDisplay::primary());
542
543 let mut target_screen = nil;
544 let mut screen_frame = None;
545
546 let screens = NSScreen::screens(nil);
547 let count: u64 = cocoa::foundation::NSArray::count(screens);
548 for i in 0..count {
549 let screen = cocoa::foundation::NSArray::objectAtIndex(screens, i);
550 let frame = NSScreen::visibleFrame(screen);
551 let display_id = display_id_for_screen(screen);
552 if display_id == display.0 {
553 screen_frame = Some(frame);
554 target_screen = screen;
555 }
556 }
557
558 let screen_frame = screen_frame.unwrap_or_else(|| {
559 let screen = NSScreen::mainScreen(nil);
560 target_screen = screen;
561 NSScreen::visibleFrame(screen)
562 });
563
564 let window_rect = NSRect::new(
565 NSPoint::new(
566 screen_frame.origin.x + bounds.origin.x.0 as f64,
567 screen_frame.origin.y
568 + (display.bounds().size.height - bounds.origin.y).0 as f64,
569 ),
570 NSSize::new(bounds.size.width.0 as f64, bounds.size.height.0 as f64),
571 );
572
573 let native_window = native_window.initWithContentRect_styleMask_backing_defer_screen_(
574 window_rect,
575 style_mask,
576 NSBackingStoreBuffered,
577 NO,
578 target_screen,
579 );
580 assert!(!native_window.is_null());
581 let () = msg_send![
582 native_window,
583 registerForDraggedTypes:
584 NSArray::arrayWithObject(nil, NSFilenamesPboardType)
585 ];
586 let () = msg_send![
587 native_window,
588 setReleasedWhenClosed: NO
589 ];
590
591 let native_view: id = msg_send![VIEW_CLASS, alloc];
592 let native_view = NSView::init(native_view);
593 assert!(!native_view.is_null());
594
595 let mut window = Self(Arc::new(Mutex::new(MacWindowState {
596 handle,
597 executor,
598 native_window,
599 native_view: NonNull::new_unchecked(native_view),
600 display_link: None,
601 renderer: renderer::new_renderer(
602 renderer_context,
603 native_window as *mut _,
604 native_view as *mut _,
605 bounds.size.map(|pixels| pixels.0),
606 window_background != WindowBackgroundAppearance::Opaque,
607 ),
608 request_frame_callback: None,
609 event_callback: None,
610 activate_callback: None,
611 resize_callback: None,
612 moved_callback: None,
613 should_close_callback: None,
614 close_callback: None,
615 appearance_changed_callback: None,
616 input_handler: None,
617 last_key_equivalent: None,
618 synthetic_drag_counter: 0,
619 traffic_light_position: titlebar
620 .as_ref()
621 .and_then(|titlebar| titlebar.traffic_light_position),
622 previous_modifiers_changed_event: None,
623 last_ime_inputs: None,
624 previous_keydown_inserted_text: None,
625 external_files_dragged: false,
626 first_mouse: false,
627 fullscreen_restore_bounds: Bounds::default(),
628 ime_composing: false,
629 })));
630
631 (*native_window).set_ivar(
632 WINDOW_STATE_IVAR,
633 Arc::into_raw(window.0.clone()) as *const c_void,
634 );
635 native_window.setDelegate_(native_window);
636 (*native_view).set_ivar(
637 WINDOW_STATE_IVAR,
638 Arc::into_raw(window.0.clone()) as *const c_void,
639 );
640
641 if let Some(title) = titlebar
642 .as_ref()
643 .and_then(|t| t.title.as_ref().map(AsRef::as_ref))
644 {
645 window.set_title(title);
646 }
647
648 native_window.setMovable_(is_movable as BOOL);
649
650 if let Some(window_min_size) = window_min_size {
651 native_window.setContentMinSize_(NSSize {
652 width: window_min_size.width.to_f64(),
653 height: window_min_size.height.to_f64(),
654 });
655 }
656
657 if titlebar.map_or(true, |titlebar| titlebar.appears_transparent) {
658 native_window.setTitlebarAppearsTransparent_(YES);
659 native_window.setTitleVisibility_(NSWindowTitleVisibility::NSWindowTitleHidden);
660 }
661
662 native_view.setAutoresizingMask_(NSViewWidthSizable | NSViewHeightSizable);
663 native_view.setWantsBestResolutionOpenGLSurface_(YES);
664
665 // From winit crate: On Mojave, views automatically become layer-backed shortly after
666 // being added to a native_window. Changing the layer-backedness of a view breaks the
667 // association between the view and its associated OpenGL context. To work around this,
668 // on we explicitly make the view layer-backed up front so that AppKit doesn't do it
669 // itself and break the association with its context.
670 native_view.setWantsLayer(YES);
671 let _: () = msg_send![
672 native_view,
673 setLayerContentsRedrawPolicy: NSViewLayerContentsRedrawDuringViewResize
674 ];
675
676 native_window.setContentView_(native_view.autorelease());
677 native_window.makeFirstResponder_(native_view);
678
679 window.set_background_appearance(window_background);
680
681 match kind {
682 WindowKind::Normal => {
683 native_window.setLevel_(NSNormalWindowLevel);
684 native_window.setAcceptsMouseMovedEvents_(YES);
685 }
686 WindowKind::PopUp => {
687 // Use a tracking area to allow receiving MouseMoved events even when
688 // the window or application aren't active, which is often the case
689 // e.g. for notification windows.
690 let tracking_area: id = msg_send![class!(NSTrackingArea), alloc];
691 let _: () = msg_send![
692 tracking_area,
693 initWithRect: NSRect::new(NSPoint::new(0., 0.), NSSize::new(0., 0.))
694 options: NSTrackingMouseEnteredAndExited | NSTrackingMouseMoved | NSTrackingActiveAlways | NSTrackingInVisibleRect
695 owner: native_view
696 userInfo: nil
697 ];
698 let _: () =
699 msg_send![native_view, addTrackingArea: tracking_area.autorelease()];
700
701 native_window.setLevel_(NSPopUpWindowLevel);
702 let _: () = msg_send![
703 native_window,
704 setAnimationBehavior: NSWindowAnimationBehaviorUtilityWindow
705 ];
706 native_window.setCollectionBehavior_(
707 NSWindowCollectionBehavior::NSWindowCollectionBehaviorCanJoinAllSpaces |
708 NSWindowCollectionBehavior::NSWindowCollectionBehaviorFullScreenAuxiliary
709 );
710 }
711 }
712
713 if focus {
714 native_window.makeKeyAndOrderFront_(nil);
715 } else if show {
716 native_window.orderFront_(nil);
717 }
718
719 // Set the initial position of the window to the specified origin.
720 // Although we already specified the position using `initWithContentRect_styleMask_backing_defer_screen_`,
721 // the window position might be incorrect if the main screen (the screen that contains the window that has focus)
722 // is different from the primary screen.
723 NSWindow::setFrameTopLeftPoint_(native_window, window_rect.origin);
724 window.0.lock().move_traffic_light();
725
726 pool.drain();
727
728 window
729 }
730 }
731
732 pub fn active_window() -> Option<AnyWindowHandle> {
733 unsafe {
734 let app = NSApplication::sharedApplication(nil);
735 let main_window: id = msg_send![app, mainWindow];
736 if msg_send![main_window, isKindOfClass: WINDOW_CLASS] {
737 let handle = get_window_state(&*main_window).lock().handle;
738 Some(handle)
739 } else {
740 None
741 }
742 }
743 }
744}
745
746impl Drop for MacWindow {
747 fn drop(&mut self) {
748 let mut this = self.0.lock();
749 this.renderer.destroy();
750 let window = this.native_window;
751 this.display_link.take();
752 unsafe {
753 this.native_window.setDelegate_(nil);
754 }
755 this.executor
756 .spawn(async move {
757 unsafe {
758 window.close();
759 window.autorelease();
760 }
761 })
762 .detach();
763 }
764}
765
766impl PlatformWindow for MacWindow {
767 fn bounds(&self) -> Bounds<Pixels> {
768 self.0.as_ref().lock().bounds()
769 }
770
771 fn window_bounds(&self) -> WindowBounds {
772 self.0.as_ref().lock().window_bounds()
773 }
774
775 fn is_maximized(&self) -> bool {
776 self.0.as_ref().lock().is_maximized()
777 }
778
779 fn content_size(&self) -> Size<Pixels> {
780 self.0.as_ref().lock().content_size()
781 }
782
783 fn scale_factor(&self) -> f32 {
784 self.0.as_ref().lock().scale_factor()
785 }
786
787 fn appearance(&self) -> WindowAppearance {
788 unsafe {
789 let appearance: id = msg_send![self.0.lock().native_window, effectiveAppearance];
790 WindowAppearance::from_native(appearance)
791 }
792 }
793
794 fn display(&self) -> Option<Rc<dyn PlatformDisplay>> {
795 unsafe {
796 let screen = self.0.lock().native_window.screen();
797 let device_description: id = msg_send![screen, deviceDescription];
798 let screen_number: id = NSDictionary::valueForKey_(
799 device_description,
800 NSString::alloc(nil).init_str("NSScreenNumber"),
801 );
802
803 let screen_number: u32 = msg_send![screen_number, unsignedIntValue];
804
805 Some(Rc::new(MacDisplay(screen_number)))
806 }
807 }
808
809 fn mouse_position(&self) -> Point<Pixels> {
810 let position = unsafe {
811 self.0
812 .lock()
813 .native_window
814 .mouseLocationOutsideOfEventStream()
815 };
816 convert_mouse_position(position, self.content_size().height)
817 }
818
819 fn modifiers(&self) -> Modifiers {
820 unsafe {
821 let modifiers: NSEventModifierFlags = msg_send![class!(NSEvent), modifierFlags];
822
823 let control = modifiers.contains(NSEventModifierFlags::NSControlKeyMask);
824 let alt = modifiers.contains(NSEventModifierFlags::NSAlternateKeyMask);
825 let shift = modifiers.contains(NSEventModifierFlags::NSShiftKeyMask);
826 let command = modifiers.contains(NSEventModifierFlags::NSCommandKeyMask);
827 let function = modifiers.contains(NSEventModifierFlags::NSFunctionKeyMask);
828
829 Modifiers {
830 control,
831 alt,
832 shift,
833 platform: command,
834 function,
835 }
836 }
837 }
838
839 fn set_input_handler(&mut self, input_handler: PlatformInputHandler) {
840 self.0.as_ref().lock().input_handler = Some(input_handler);
841 }
842
843 fn take_input_handler(&mut self) -> Option<PlatformInputHandler> {
844 self.0.as_ref().lock().input_handler.take()
845 }
846
847 fn prompt(
848 &self,
849 level: PromptLevel,
850 msg: &str,
851 detail: Option<&str>,
852 answers: &[&str],
853 ) -> Option<oneshot::Receiver<usize>> {
854 // macOs applies overrides to modal window buttons after they are added.
855 // Two most important for this logic are:
856 // * Buttons with "Cancel" title will be displayed as the last buttons in the modal
857 // * Last button added to the modal via `addButtonWithTitle` stays focused
858 // * Focused buttons react on "space"/" " keypresses
859 // * Usage of `keyEquivalent`, `makeFirstResponder` or `setInitialFirstResponder` does not change the focus
860 //
861 // See also https://developer.apple.com/documentation/appkit/nsalert/1524532-addbuttonwithtitle#discussion
862 // ```
863 // By default, the first button has a key equivalent of Return,
864 // any button with a title of “Cancel” has a key equivalent of Escape,
865 // and any button with the title “Don’t Save” has a key equivalent of Command-D (but only if it’s not the first button).
866 // ```
867 //
868 // To avoid situations when the last element added is "Cancel" and it gets the focus
869 // (hence stealing both ESC and Space shortcuts), we find and add one non-Cancel button
870 // last, so it gets focus and a Space shortcut.
871 // This way, "Save this file? Yes/No/Cancel"-ish modals will get all three buttons mapped with a key.
872 let latest_non_cancel_label = answers
873 .iter()
874 .enumerate()
875 .rev()
876 .find(|(_, &label)| label != "Cancel")
877 .filter(|&(label_index, _)| label_index > 0);
878
879 unsafe {
880 let alert: id = msg_send![class!(NSAlert), alloc];
881 let alert: id = msg_send![alert, init];
882 let alert_style = match level {
883 PromptLevel::Info => 1,
884 PromptLevel::Warning => 0,
885 PromptLevel::Critical => 2,
886 };
887 let _: () = msg_send![alert, setAlertStyle: alert_style];
888 let _: () = msg_send![alert, setMessageText: ns_string(msg)];
889 if let Some(detail) = detail {
890 let _: () = msg_send![alert, setInformativeText: ns_string(detail)];
891 }
892
893 for (ix, answer) in answers
894 .iter()
895 .enumerate()
896 .filter(|&(ix, _)| Some(ix) != latest_non_cancel_label.map(|(ix, _)| ix))
897 {
898 let button: id = msg_send![alert, addButtonWithTitle: ns_string(answer)];
899 let _: () = msg_send![button, setTag: ix as NSInteger];
900 }
901 if let Some((ix, answer)) = latest_non_cancel_label {
902 let button: id = msg_send![alert, addButtonWithTitle: ns_string(answer)];
903 let _: () = msg_send![button, setTag: ix as NSInteger];
904 }
905
906 let (done_tx, done_rx) = oneshot::channel();
907 let done_tx = Cell::new(Some(done_tx));
908 let block = ConcreteBlock::new(move |answer: NSInteger| {
909 if let Some(done_tx) = done_tx.take() {
910 let _ = done_tx.send(answer.try_into().unwrap());
911 }
912 });
913 let block = block.copy();
914 let native_window = self.0.lock().native_window;
915 let executor = self.0.lock().executor.clone();
916 executor
917 .spawn(async move {
918 let _: () = msg_send![
919 alert,
920 beginSheetModalForWindow: native_window
921 completionHandler: block
922 ];
923 })
924 .detach();
925
926 Some(done_rx)
927 }
928 }
929
930 fn activate(&self) {
931 let window = self.0.lock().native_window;
932 let executor = self.0.lock().executor.clone();
933 executor
934 .spawn(async move {
935 unsafe {
936 let _: () = msg_send![window, makeKeyAndOrderFront: nil];
937 }
938 })
939 .detach();
940 }
941
942 fn is_active(&self) -> bool {
943 unsafe { self.0.lock().native_window.isKeyWindow() == YES }
944 }
945
946 fn set_title(&mut self, title: &str) {
947 unsafe {
948 let app = NSApplication::sharedApplication(nil);
949 let window = self.0.lock().native_window;
950 let title = ns_string(title);
951 let _: () = msg_send![app, changeWindowsItem:window title:title filename:false];
952 let _: () = msg_send![window, setTitle: title];
953 self.0.lock().move_traffic_light();
954 }
955 }
956
957 fn set_app_id(&mut self, _app_id: &str) {}
958
959 fn set_background_appearance(&mut self, background_appearance: WindowBackgroundAppearance) {
960 let mut this = self.0.as_ref().lock();
961 this.renderer
962 .update_transparency(background_appearance != WindowBackgroundAppearance::Opaque);
963
964 let blur_radius = if background_appearance == WindowBackgroundAppearance::Blurred {
965 80
966 } else {
967 0
968 };
969 let opaque = if background_appearance == WindowBackgroundAppearance::Opaque {
970 YES
971 } else {
972 NO
973 };
974 unsafe {
975 this.native_window.setOpaque_(opaque);
976 // Shadows for transparent windows cause artifacts and performance issues
977 this.native_window.setHasShadow_(opaque);
978 let clear_color = if opaque == YES {
979 NSColor::colorWithSRGBRed_green_blue_alpha_(nil, 0f64, 0f64, 0f64, 1f64)
980 } else {
981 NSColor::clearColor(nil)
982 };
983 this.native_window.setBackgroundColor_(clear_color);
984 let window_number = this.native_window.windowNumber();
985 CGSSetWindowBackgroundBlurRadius(CGSMainConnectionID(), window_number, blur_radius);
986 }
987 }
988
989 fn set_edited(&mut self, edited: bool) {
990 unsafe {
991 let window = self.0.lock().native_window;
992 msg_send![window, setDocumentEdited: edited as BOOL]
993 }
994
995 // Changing the document edited state resets the traffic light position,
996 // so we have to move it again.
997 self.0.lock().move_traffic_light();
998 }
999
1000 fn show_character_palette(&self) {
1001 let this = self.0.lock();
1002 let window = this.native_window;
1003 this.executor
1004 .spawn(async move {
1005 unsafe {
1006 let app = NSApplication::sharedApplication(nil);
1007 let _: () = msg_send![app, orderFrontCharacterPalette: window];
1008 }
1009 })
1010 .detach();
1011 }
1012
1013 fn minimize(&self) {
1014 let window = self.0.lock().native_window;
1015 unsafe {
1016 window.miniaturize_(nil);
1017 }
1018 }
1019
1020 fn zoom(&self) {
1021 let this = self.0.lock();
1022 let window = this.native_window;
1023 this.executor
1024 .spawn(async move {
1025 unsafe {
1026 window.zoom_(nil);
1027 }
1028 })
1029 .detach();
1030 }
1031
1032 fn toggle_fullscreen(&self) {
1033 let this = self.0.lock();
1034 let window = this.native_window;
1035 this.executor
1036 .spawn(async move {
1037 unsafe {
1038 window.toggleFullScreen_(nil);
1039 }
1040 })
1041 .detach();
1042 }
1043
1044 fn is_fullscreen(&self) -> bool {
1045 let this = self.0.lock();
1046 let window = this.native_window;
1047
1048 unsafe {
1049 window
1050 .styleMask()
1051 .contains(NSWindowStyleMask::NSFullScreenWindowMask)
1052 }
1053 }
1054
1055 fn on_request_frame(&self, callback: Box<dyn FnMut()>) {
1056 self.0.as_ref().lock().request_frame_callback = Some(callback);
1057 }
1058
1059 fn on_input(&self, callback: Box<dyn FnMut(PlatformInput) -> crate::DispatchEventResult>) {
1060 self.0.as_ref().lock().event_callback = Some(callback);
1061 }
1062
1063 fn on_active_status_change(&self, callback: Box<dyn FnMut(bool)>) {
1064 self.0.as_ref().lock().activate_callback = Some(callback);
1065 }
1066
1067 fn on_resize(&self, callback: Box<dyn FnMut(Size<Pixels>, f32)>) {
1068 self.0.as_ref().lock().resize_callback = Some(callback);
1069 }
1070
1071 fn on_moved(&self, callback: Box<dyn FnMut()>) {
1072 self.0.as_ref().lock().moved_callback = Some(callback);
1073 }
1074
1075 fn on_should_close(&self, callback: Box<dyn FnMut() -> bool>) {
1076 self.0.as_ref().lock().should_close_callback = Some(callback);
1077 }
1078
1079 fn on_close(&self, callback: Box<dyn FnOnce()>) {
1080 self.0.as_ref().lock().close_callback = Some(callback);
1081 }
1082
1083 fn on_appearance_changed(&self, callback: Box<dyn FnMut()>) {
1084 self.0.lock().appearance_changed_callback = Some(callback);
1085 }
1086
1087 fn draw(&self, scene: &crate::Scene) {
1088 let mut this = self.0.lock();
1089 this.renderer.draw(scene);
1090 }
1091
1092 fn sprite_atlas(&self) -> Arc<dyn PlatformAtlas> {
1093 self.0.lock().renderer.sprite_atlas().clone()
1094 }
1095
1096 fn show_window_menu(&self, _position: Point<Pixels>) {}
1097
1098 fn start_system_move(&self) {}
1099
1100 fn should_render_window_controls(&self) -> bool {
1101 false
1102 }
1103}
1104
1105impl rwh::HasWindowHandle for MacWindow {
1106 fn window_handle(&self) -> Result<rwh::WindowHandle<'_>, rwh::HandleError> {
1107 // SAFETY: The AppKitWindowHandle is a wrapper around a pointer to an NSView
1108 unsafe {
1109 Ok(rwh::WindowHandle::borrow_raw(rwh::RawWindowHandle::AppKit(
1110 rwh::AppKitWindowHandle::new(self.0.lock().native_view.cast()),
1111 )))
1112 }
1113 }
1114}
1115
1116impl rwh::HasDisplayHandle for MacWindow {
1117 fn display_handle(&self) -> Result<rwh::DisplayHandle<'_>, rwh::HandleError> {
1118 // SAFETY: This is a no-op on macOS
1119 unsafe {
1120 Ok(rwh::DisplayHandle::borrow_raw(
1121 rwh::AppKitDisplayHandle::new().into(),
1122 ))
1123 }
1124 }
1125}
1126
1127fn get_scale_factor(native_window: id) -> f32 {
1128 let factor = unsafe {
1129 let screen: id = msg_send![native_window, screen];
1130 NSScreen::backingScaleFactor(screen) as f32
1131 };
1132
1133 // We are not certain what triggers this, but it seems that sometimes
1134 // this method would return 0 (https://github.com/zed-industries/zed/issues/6412)
1135 // It seems most likely that this would happen if the window has no screen
1136 // (if it is off-screen), though we'd expect to see viewDidChangeBackingProperties before
1137 // it was rendered for real.
1138 // Regardless, attempt to avoid the issue here.
1139 if factor == 0.0 {
1140 2.
1141 } else {
1142 factor
1143 }
1144}
1145
1146unsafe fn get_window_state(object: &Object) -> Arc<Mutex<MacWindowState>> {
1147 let raw: *mut c_void = *object.get_ivar(WINDOW_STATE_IVAR);
1148 let rc1 = Arc::from_raw(raw as *mut Mutex<MacWindowState>);
1149 let rc2 = rc1.clone();
1150 mem::forget(rc1);
1151 rc2
1152}
1153
1154unsafe fn drop_window_state(object: &Object) {
1155 let raw: *mut c_void = *object.get_ivar(WINDOW_STATE_IVAR);
1156 Arc::from_raw(raw as *mut Mutex<MacWindowState>);
1157}
1158
1159extern "C" fn yes(_: &Object, _: Sel) -> BOOL {
1160 YES
1161}
1162
1163extern "C" fn dealloc_window(this: &Object, _: Sel) {
1164 unsafe {
1165 drop_window_state(this);
1166 let _: () = msg_send![super(this, class!(NSWindow)), dealloc];
1167 }
1168}
1169
1170extern "C" fn dealloc_view(this: &Object, _: Sel) {
1171 unsafe {
1172 drop_window_state(this);
1173 let _: () = msg_send![super(this, class!(NSView)), dealloc];
1174 }
1175}
1176
1177extern "C" fn handle_key_equivalent(this: &Object, _: Sel, native_event: id) -> BOOL {
1178 handle_key_event(this, native_event, true)
1179}
1180
1181extern "C" fn handle_key_down(this: &Object, _: Sel, native_event: id) {
1182 handle_key_event(this, native_event, false);
1183}
1184
1185// Things to test if you're modifying this method:
1186// U.S. layout:
1187// - The IME consumes characters like 'j' and 'k', which makes paging through `less` in
1188// the terminal behave incorrectly by default. This behavior should be patched by our
1189// IME integration
1190// - `alt-t` should open the tasks menu
1191// - In vim mode, this keybinding should work:
1192// ```
1193// {
1194// "context": "Editor && vim_mode == insert",
1195// "bindings": {"j j": "vim::NormalBefore"}
1196// }
1197// ```
1198// and typing 'j k' in insert mode with this keybinding should insert the two characters
1199// Brazilian layout:
1200// - `" space` should create an unmarked quote
1201// - `" backspace` should delete the marked quote
1202// - `" up` should insert a quote, unmark it, and move up one line
1203// - `" cmd-down` should insert a quote, unmark it, and move to the end of the file
1204// - NOTE: The current implementation does not move the selection to the end of the file
1205// - `cmd-ctrl-space` and clicking on an emoji should type it
1206// Czech (QWERTY) layout:
1207// - in vim mode `option-4` should go to end of line (same as $)
1208// Japanese (Romaji) layout:
1209// - type `a i left down up enter enter` should create an unmarked text "愛"
1210extern "C" fn handle_key_event(this: &Object, native_event: id, key_equivalent: bool) -> BOOL {
1211 let window_state = unsafe { get_window_state(this) };
1212 let mut lock = window_state.as_ref().lock();
1213
1214 let window_height = lock.content_size().height;
1215 let event = unsafe { PlatformInput::from_native(native_event, Some(window_height)) };
1216
1217 if let Some(PlatformInput::KeyDown(mut event)) = event {
1218 // For certain keystrokes, macOS will first dispatch a "key equivalent" event.
1219 // If that event isn't handled, it will then dispatch a "key down" event. GPUI
1220 // makes no distinction between these two types of events, so we need to ignore
1221 // the "key down" event if we've already just processed its "key equivalent" version.
1222 if key_equivalent {
1223 lock.last_key_equivalent = Some(event.clone());
1224 } else if lock.last_key_equivalent.take().as_ref() == Some(&event) {
1225 return NO;
1226 }
1227
1228 let keydown = event.keystroke.clone();
1229 let fn_modifier = keydown.modifiers.function;
1230 lock.last_ime_inputs = Some(Default::default());
1231 drop(lock);
1232
1233 // Send the event to the input context for IME handling, unless the `fn` modifier is
1234 // being pressed.
1235 // this will call back into `insert_text`, etc.
1236 if !fn_modifier {
1237 unsafe {
1238 let input_context: id = msg_send![this, inputContext];
1239 let _: BOOL = msg_send![input_context, handleEvent: native_event];
1240 }
1241 }
1242
1243 let mut handled = false;
1244 let mut lock = window_state.lock();
1245 let previous_keydown_inserted_text = lock.previous_keydown_inserted_text.take();
1246 let mut last_inserts = lock.last_ime_inputs.take().unwrap();
1247 let ime_composing = std::mem::take(&mut lock.ime_composing);
1248
1249 let mut callback = lock.event_callback.take();
1250 drop(lock);
1251
1252 let last_insert = last_inserts.pop();
1253 // on a brazilian keyboard typing `"` and then hitting `up` will cause two IME
1254 // events, one to unmark the quote, and one to send the up arrow.
1255 for (text, range) in last_inserts {
1256 send_to_input_handler(this, ImeInput::InsertText(text, range));
1257 }
1258
1259 let is_composing =
1260 with_input_handler(this, |input_handler| input_handler.marked_text_range())
1261 .flatten()
1262 .is_some()
1263 || ime_composing;
1264
1265 if let Some((text, range)) = last_insert {
1266 if !is_composing {
1267 window_state.lock().previous_keydown_inserted_text = Some(text.clone());
1268 if let Some(callback) = callback.as_mut() {
1269 event.keystroke.ime_key = Some(text.clone());
1270 handled = !callback(PlatformInput::KeyDown(event)).propagate;
1271 }
1272 }
1273
1274 if !handled {
1275 handled = true;
1276 send_to_input_handler(this, ImeInput::InsertText(text, range));
1277 }
1278 } else if !is_composing {
1279 let is_held = event.is_held;
1280
1281 if let Some(callback) = callback.as_mut() {
1282 handled = !callback(PlatformInput::KeyDown(event)).propagate;
1283 }
1284
1285 if !handled && is_held {
1286 if let Some(text) = previous_keydown_inserted_text {
1287 // MacOS IME is a bit funky, and even when you've told it there's nothing to
1288 // enter it will still swallow certain keys (e.g. 'f', 'j') and not others
1289 // (e.g. 'n'). This is a problem for certain kinds of views, like the terminal.
1290 with_input_handler(this, |input_handler| {
1291 if input_handler.selected_text_range().is_none() {
1292 handled = true;
1293 input_handler.replace_text_in_range(None, &text)
1294 }
1295 });
1296 window_state.lock().previous_keydown_inserted_text = Some(text);
1297 }
1298 }
1299 }
1300
1301 window_state.lock().event_callback = callback;
1302
1303 handled as BOOL
1304 } else {
1305 NO
1306 }
1307}
1308
1309extern "C" fn handle_view_event(this: &Object, _: Sel, native_event: id) {
1310 let window_state = unsafe { get_window_state(this) };
1311 let weak_window_state = Arc::downgrade(&window_state);
1312 let mut lock = window_state.as_ref().lock();
1313 let window_height = lock.content_size().height;
1314 let event = unsafe { PlatformInput::from_native(native_event, Some(window_height)) };
1315
1316 if let Some(mut event) = event {
1317 match &mut event {
1318 PlatformInput::MouseDown(
1319 event @ MouseDownEvent {
1320 button: MouseButton::Left,
1321 modifiers: Modifiers { control: true, .. },
1322 ..
1323 },
1324 ) => {
1325 // On mac, a ctrl-left click should be handled as a right click.
1326 *event = MouseDownEvent {
1327 button: MouseButton::Right,
1328 modifiers: Modifiers {
1329 control: false,
1330 ..event.modifiers
1331 },
1332 click_count: 1,
1333 ..*event
1334 };
1335 }
1336
1337 // Handles focusing click.
1338 PlatformInput::MouseDown(
1339 event @ MouseDownEvent {
1340 button: MouseButton::Left,
1341 ..
1342 },
1343 ) if (lock.first_mouse) => {
1344 *event = MouseDownEvent {
1345 first_mouse: true,
1346 ..*event
1347 };
1348 lock.first_mouse = false;
1349 }
1350
1351 // Because we map a ctrl-left_down to a right_down -> right_up let's ignore
1352 // the ctrl-left_up to avoid having a mismatch in button down/up events if the
1353 // user is still holding ctrl when releasing the left mouse button
1354 PlatformInput::MouseUp(
1355 event @ MouseUpEvent {
1356 button: MouseButton::Left,
1357 modifiers: Modifiers { control: true, .. },
1358 ..
1359 },
1360 ) => {
1361 *event = MouseUpEvent {
1362 button: MouseButton::Right,
1363 modifiers: Modifiers {
1364 control: false,
1365 ..event.modifiers
1366 },
1367 click_count: 1,
1368 ..*event
1369 };
1370 }
1371
1372 _ => {}
1373 };
1374
1375 match &event {
1376 PlatformInput::MouseMove(
1377 event @ MouseMoveEvent {
1378 pressed_button: Some(_),
1379 ..
1380 },
1381 ) => {
1382 // Synthetic drag is used for selecting long buffer contents while buffer is being scrolled.
1383 // External file drag and drop is able to emit its own synthetic mouse events which will conflict
1384 // with these ones.
1385 if !lock.external_files_dragged {
1386 lock.synthetic_drag_counter += 1;
1387 let executor = lock.executor.clone();
1388 executor
1389 .spawn(synthetic_drag(
1390 weak_window_state,
1391 lock.synthetic_drag_counter,
1392 event.clone(),
1393 ))
1394 .detach();
1395 }
1396 }
1397
1398 PlatformInput::MouseUp(MouseUpEvent { .. }) => {
1399 lock.synthetic_drag_counter += 1;
1400 }
1401
1402 PlatformInput::ModifiersChanged(ModifiersChangedEvent { modifiers }) => {
1403 // Only raise modifiers changed event when they have actually changed
1404 if let Some(PlatformInput::ModifiersChanged(ModifiersChangedEvent {
1405 modifiers: prev_modifiers,
1406 })) = &lock.previous_modifiers_changed_event
1407 {
1408 if prev_modifiers == modifiers {
1409 return;
1410 }
1411 }
1412
1413 lock.previous_modifiers_changed_event = Some(event.clone());
1414 }
1415
1416 _ => {}
1417 }
1418
1419 if let Some(mut callback) = lock.event_callback.take() {
1420 drop(lock);
1421 callback(event);
1422 window_state.lock().event_callback = Some(callback);
1423 }
1424 }
1425}
1426
1427// Allows us to receive `cmd-.` (the shortcut for closing a dialog)
1428// https://bugs.eclipse.org/bugs/show_bug.cgi?id=300620#c6
1429extern "C" fn cancel_operation(this: &Object, _sel: Sel, _sender: id) {
1430 let window_state = unsafe { get_window_state(this) };
1431 let mut lock = window_state.as_ref().lock();
1432
1433 let keystroke = Keystroke {
1434 modifiers: Default::default(),
1435 key: ".".into(),
1436 ime_key: None,
1437 };
1438 let event = PlatformInput::KeyDown(KeyDownEvent {
1439 keystroke: keystroke.clone(),
1440 is_held: false,
1441 });
1442
1443 if let Some(mut callback) = lock.event_callback.take() {
1444 drop(lock);
1445 callback(event);
1446 window_state.lock().event_callback = Some(callback);
1447 }
1448}
1449
1450extern "C" fn window_did_change_occlusion_state(this: &Object, _: Sel, _: id) {
1451 let window_state = unsafe { get_window_state(this) };
1452 let lock = &mut *window_state.lock();
1453 unsafe {
1454 if lock
1455 .native_window
1456 .occlusionState()
1457 .contains(NSWindowOcclusionState::NSWindowOcclusionStateVisible)
1458 {
1459 lock.start_display_link();
1460 } else {
1461 lock.stop_display_link();
1462 }
1463 }
1464}
1465
1466extern "C" fn window_did_resize(this: &Object, _: Sel, _: id) {
1467 let window_state = unsafe { get_window_state(this) };
1468 window_state.as_ref().lock().move_traffic_light();
1469}
1470
1471extern "C" fn window_will_enter_fullscreen(this: &Object, _: Sel, _: id) {
1472 let window_state = unsafe { get_window_state(this) };
1473 let mut lock = window_state.as_ref().lock();
1474 lock.fullscreen_restore_bounds = lock.bounds();
1475}
1476
1477extern "C" fn window_did_move(this: &Object, _: Sel, _: id) {
1478 let window_state = unsafe { get_window_state(this) };
1479 let mut lock = window_state.as_ref().lock();
1480 if let Some(mut callback) = lock.moved_callback.take() {
1481 drop(lock);
1482 callback();
1483 window_state.lock().moved_callback = Some(callback);
1484 }
1485}
1486
1487extern "C" fn window_did_change_screen(this: &Object, _: Sel, _: id) {
1488 let window_state = unsafe { get_window_state(this) };
1489 let mut lock = window_state.as_ref().lock();
1490 lock.start_display_link();
1491}
1492
1493extern "C" fn window_did_change_key_status(this: &Object, selector: Sel, _: id) {
1494 let window_state = unsafe { get_window_state(this) };
1495 let lock = window_state.lock();
1496 let is_active = unsafe { lock.native_window.isKeyWindow() == YES };
1497
1498 // When opening a pop-up while the application isn't active, Cocoa sends a spurious
1499 // `windowDidBecomeKey` message to the previous key window even though that window
1500 // isn't actually key. This causes a bug if the application is later activated while
1501 // the pop-up is still open, making it impossible to activate the previous key window
1502 // even if the pop-up gets closed. The only way to activate it again is to de-activate
1503 // the app and re-activate it, which is a pretty bad UX.
1504 // The following code detects the spurious event and invokes `resignKeyWindow`:
1505 // in theory, we're not supposed to invoke this method manually but it balances out
1506 // the spurious `becomeKeyWindow` event and helps us work around that bug.
1507 if selector == sel!(windowDidBecomeKey:) && !is_active {
1508 unsafe {
1509 let _: () = msg_send![lock.native_window, resignKeyWindow];
1510 return;
1511 }
1512 }
1513
1514 let executor = lock.executor.clone();
1515 drop(lock);
1516 executor
1517 .spawn(async move {
1518 let mut lock = window_state.as_ref().lock();
1519 if let Some(mut callback) = lock.activate_callback.take() {
1520 drop(lock);
1521 callback(is_active);
1522 window_state.lock().activate_callback = Some(callback);
1523 };
1524 })
1525 .detach();
1526}
1527
1528extern "C" fn window_should_close(this: &Object, _: Sel, _: id) -> BOOL {
1529 let window_state = unsafe { get_window_state(this) };
1530 let mut lock = window_state.as_ref().lock();
1531 if let Some(mut callback) = lock.should_close_callback.take() {
1532 drop(lock);
1533 let should_close = callback();
1534 window_state.lock().should_close_callback = Some(callback);
1535 should_close as BOOL
1536 } else {
1537 YES
1538 }
1539}
1540
1541extern "C" fn close_window(this: &Object, _: Sel) {
1542 unsafe {
1543 let close_callback = {
1544 let window_state = get_window_state(this);
1545 let mut lock = window_state.as_ref().lock();
1546 lock.close_callback.take()
1547 };
1548
1549 if let Some(callback) = close_callback {
1550 callback();
1551 }
1552
1553 let _: () = msg_send![super(this, class!(NSWindow)), close];
1554 }
1555}
1556
1557extern "C" fn make_backing_layer(this: &Object, _: Sel) -> id {
1558 let window_state = unsafe { get_window_state(this) };
1559 let window_state = window_state.as_ref().lock();
1560 window_state.renderer.layer_ptr() as id
1561}
1562
1563extern "C" fn view_did_change_backing_properties(this: &Object, _: Sel) {
1564 let window_state = unsafe { get_window_state(this) };
1565 let mut lock = window_state.as_ref().lock();
1566
1567 let scale_factor = lock.scale_factor();
1568 let size = lock.content_size();
1569 let drawable_size = size.to_device_pixels(scale_factor);
1570 unsafe {
1571 let _: () = msg_send![
1572 lock.renderer.layer(),
1573 setContentsScale: scale_factor as f64
1574 ];
1575 }
1576
1577 lock.renderer.update_drawable_size(drawable_size);
1578
1579 if let Some(mut callback) = lock.resize_callback.take() {
1580 let content_size = lock.content_size();
1581 let scale_factor = lock.scale_factor();
1582 drop(lock);
1583 callback(content_size, scale_factor);
1584 window_state.as_ref().lock().resize_callback = Some(callback);
1585 };
1586}
1587
1588extern "C" fn set_frame_size(this: &Object, _: Sel, size: NSSize) {
1589 let window_state = unsafe { get_window_state(this) };
1590 let mut lock = window_state.as_ref().lock();
1591
1592 let new_size = Size::<Pixels>::from(size);
1593 if lock.content_size() == new_size {
1594 return;
1595 }
1596
1597 unsafe {
1598 let _: () = msg_send![super(this, class!(NSView)), setFrameSize: size];
1599 }
1600
1601 let scale_factor = lock.scale_factor();
1602 let drawable_size = new_size.to_device_pixels(scale_factor);
1603 lock.renderer.update_drawable_size(drawable_size);
1604
1605 if let Some(mut callback) = lock.resize_callback.take() {
1606 let content_size = lock.content_size();
1607 let scale_factor = lock.scale_factor();
1608 drop(lock);
1609 callback(content_size, scale_factor);
1610 window_state.lock().resize_callback = Some(callback);
1611 };
1612}
1613
1614extern "C" fn display_layer(this: &Object, _: Sel, _: id) {
1615 let window_state = unsafe { get_window_state(this) };
1616 let mut lock = window_state.lock();
1617 if let Some(mut callback) = lock.request_frame_callback.take() {
1618 #[cfg(not(feature = "macos-blade"))]
1619 lock.renderer.set_presents_with_transaction(true);
1620 lock.stop_display_link();
1621 drop(lock);
1622 callback();
1623
1624 let mut lock = window_state.lock();
1625 lock.request_frame_callback = Some(callback);
1626 #[cfg(not(feature = "macos-blade"))]
1627 lock.renderer.set_presents_with_transaction(false);
1628 lock.start_display_link();
1629 }
1630}
1631
1632unsafe extern "C" fn step(view: *mut c_void) {
1633 let view = view as id;
1634 let window_state = unsafe { get_window_state(&*view) };
1635 let mut lock = window_state.lock();
1636
1637 if let Some(mut callback) = lock.request_frame_callback.take() {
1638 drop(lock);
1639 callback();
1640 window_state.lock().request_frame_callback = Some(callback);
1641 }
1642}
1643
1644extern "C" fn valid_attributes_for_marked_text(_: &Object, _: Sel) -> id {
1645 unsafe { msg_send![class!(NSArray), array] }
1646}
1647
1648extern "C" fn has_marked_text(this: &Object, _: Sel) -> BOOL {
1649 let has_marked_text_result =
1650 with_input_handler(this, |input_handler| input_handler.marked_text_range()).flatten();
1651
1652 has_marked_text_result.is_some() as BOOL
1653}
1654
1655extern "C" fn marked_range(this: &Object, _: Sel) -> NSRange {
1656 let marked_range_result =
1657 with_input_handler(this, |input_handler| input_handler.marked_text_range()).flatten();
1658
1659 marked_range_result.map_or(NSRange::invalid(), |range| range.into())
1660}
1661
1662extern "C" fn selected_range(this: &Object, _: Sel) -> NSRange {
1663 let selected_range_result =
1664 with_input_handler(this, |input_handler| input_handler.selected_text_range()).flatten();
1665
1666 selected_range_result.map_or(NSRange::invalid(), |range| range.into())
1667}
1668
1669extern "C" fn first_rect_for_character_range(
1670 this: &Object,
1671 _: Sel,
1672 range: NSRange,
1673 _: id,
1674) -> NSRect {
1675 let frame: NSRect = unsafe {
1676 let state = get_window_state(this);
1677 let lock = state.lock();
1678 let mut frame = NSWindow::frame(lock.native_window);
1679 let content_layout_rect: CGRect = msg_send![lock.native_window, contentLayoutRect];
1680 frame.origin.y -= frame.size.height - content_layout_rect.size.height;
1681 frame
1682 };
1683 with_input_handler(this, |input_handler| {
1684 input_handler.bounds_for_range(range.to_range()?)
1685 })
1686 .flatten()
1687 .map_or(
1688 NSRect::new(NSPoint::new(0., 0.), NSSize::new(0., 0.)),
1689 |bounds| {
1690 NSRect::new(
1691 NSPoint::new(
1692 frame.origin.x + bounds.origin.x.0 as f64,
1693 frame.origin.y + frame.size.height
1694 - bounds.origin.y.0 as f64
1695 - bounds.size.height.0 as f64,
1696 ),
1697 NSSize::new(bounds.size.width.0 as f64, bounds.size.height.0 as f64),
1698 )
1699 },
1700 )
1701}
1702
1703extern "C" fn insert_text(this: &Object, _: Sel, text: id, replacement_range: NSRange) {
1704 unsafe {
1705 let is_attributed_string: BOOL =
1706 msg_send![text, isKindOfClass: [class!(NSAttributedString)]];
1707 let text: id = if is_attributed_string == YES {
1708 msg_send![text, string]
1709 } else {
1710 text
1711 };
1712
1713 let text = text.to_str();
1714 let replacement_range = replacement_range.to_range();
1715 send_to_input_handler(
1716 this,
1717 ImeInput::InsertText(text.to_string(), replacement_range),
1718 );
1719 }
1720}
1721
1722extern "C" fn set_marked_text(
1723 this: &Object,
1724 _: Sel,
1725 text: id,
1726 selected_range: NSRange,
1727 replacement_range: NSRange,
1728) {
1729 unsafe {
1730 let is_attributed_string: BOOL =
1731 msg_send![text, isKindOfClass: [class!(NSAttributedString)]];
1732 let text: id = if is_attributed_string == YES {
1733 msg_send![text, string]
1734 } else {
1735 text
1736 };
1737 let selected_range = selected_range.to_range();
1738 let replacement_range = replacement_range.to_range();
1739 let text = text.to_str();
1740
1741 send_to_input_handler(
1742 this,
1743 ImeInput::SetMarkedText(text.to_string(), replacement_range, selected_range),
1744 );
1745 }
1746}
1747extern "C" fn unmark_text(this: &Object, _: Sel) {
1748 send_to_input_handler(this, ImeInput::UnmarkText);
1749}
1750
1751extern "C" fn attributed_substring_for_proposed_range(
1752 this: &Object,
1753 _: Sel,
1754 range: NSRange,
1755 _actual_range: *mut c_void,
1756) -> id {
1757 with_input_handler(this, |input_handler| {
1758 let range = range.to_range()?;
1759 if range.is_empty() {
1760 return None;
1761 }
1762
1763 let selected_text = input_handler.text_for_range(range.clone())?;
1764 unsafe {
1765 let string: id = msg_send![class!(NSAttributedString), alloc];
1766 let string: id = msg_send![string, initWithString: ns_string(&selected_text)];
1767 Some(string)
1768 }
1769 })
1770 .flatten()
1771 .unwrap_or(nil)
1772}
1773
1774extern "C" fn do_command_by_selector(_: &Object, _: Sel, _: Sel) {}
1775
1776extern "C" fn view_did_change_effective_appearance(this: &Object, _: Sel) {
1777 unsafe {
1778 let state = get_window_state(this);
1779 let mut lock = state.as_ref().lock();
1780 if let Some(mut callback) = lock.appearance_changed_callback.take() {
1781 drop(lock);
1782 callback();
1783 state.lock().appearance_changed_callback = Some(callback);
1784 }
1785 }
1786}
1787
1788extern "C" fn accepts_first_mouse(this: &Object, _: Sel, _: id) -> BOOL {
1789 let window_state = unsafe { get_window_state(this) };
1790 let mut lock = window_state.as_ref().lock();
1791 lock.first_mouse = true;
1792 YES
1793}
1794
1795extern "C" fn dragging_entered(this: &Object, _: Sel, dragging_info: id) -> NSDragOperation {
1796 let window_state = unsafe { get_window_state(this) };
1797 let position = drag_event_position(&window_state, dragging_info);
1798 let paths = external_paths_from_event(dragging_info);
1799 if let Some(event) =
1800 paths.map(|paths| PlatformInput::FileDrop(FileDropEvent::Entered { position, paths }))
1801 {
1802 if send_new_event(&window_state, event) {
1803 window_state.lock().external_files_dragged = true;
1804 return NSDragOperationCopy;
1805 }
1806 }
1807 NSDragOperationNone
1808}
1809
1810extern "C" fn dragging_updated(this: &Object, _: Sel, dragging_info: id) -> NSDragOperation {
1811 let window_state = unsafe { get_window_state(this) };
1812 let position = drag_event_position(&window_state, dragging_info);
1813 if send_new_event(
1814 &window_state,
1815 PlatformInput::FileDrop(FileDropEvent::Pending { position }),
1816 ) {
1817 NSDragOperationCopy
1818 } else {
1819 NSDragOperationNone
1820 }
1821}
1822
1823extern "C" fn dragging_exited(this: &Object, _: Sel, _: id) {
1824 let window_state = unsafe { get_window_state(this) };
1825 send_new_event(
1826 &window_state,
1827 PlatformInput::FileDrop(FileDropEvent::Exited),
1828 );
1829 window_state.lock().external_files_dragged = false;
1830}
1831
1832extern "C" fn perform_drag_operation(this: &Object, _: Sel, dragging_info: id) -> BOOL {
1833 let window_state = unsafe { get_window_state(this) };
1834 let position = drag_event_position(&window_state, dragging_info);
1835 if send_new_event(
1836 &window_state,
1837 PlatformInput::FileDrop(FileDropEvent::Submit { position }),
1838 ) {
1839 YES
1840 } else {
1841 NO
1842 }
1843}
1844
1845fn external_paths_from_event(dragging_info: *mut Object) -> Option<ExternalPaths> {
1846 let mut paths = SmallVec::new();
1847 let pasteboard: id = unsafe { msg_send![dragging_info, draggingPasteboard] };
1848 let filenames = unsafe { NSPasteboard::propertyListForType(pasteboard, NSFilenamesPboardType) };
1849 if filenames == nil {
1850 return None;
1851 }
1852 for file in unsafe { filenames.iter() } {
1853 let path = unsafe {
1854 let f = NSString::UTF8String(file);
1855 CStr::from_ptr(f).to_string_lossy().into_owned()
1856 };
1857 paths.push(PathBuf::from(path))
1858 }
1859 Some(ExternalPaths(paths))
1860}
1861
1862extern "C" fn conclude_drag_operation(this: &Object, _: Sel, _: id) {
1863 let window_state = unsafe { get_window_state(this) };
1864 send_new_event(
1865 &window_state,
1866 PlatformInput::FileDrop(FileDropEvent::Exited),
1867 );
1868}
1869
1870async fn synthetic_drag(
1871 window_state: Weak<Mutex<MacWindowState>>,
1872 drag_id: usize,
1873 event: MouseMoveEvent,
1874) {
1875 loop {
1876 Timer::after(Duration::from_millis(16)).await;
1877 if let Some(window_state) = window_state.upgrade() {
1878 let mut lock = window_state.lock();
1879 if lock.synthetic_drag_counter == drag_id {
1880 if let Some(mut callback) = lock.event_callback.take() {
1881 drop(lock);
1882 callback(PlatformInput::MouseMove(event.clone()));
1883 window_state.lock().event_callback = Some(callback);
1884 }
1885 } else {
1886 break;
1887 }
1888 }
1889 }
1890}
1891
1892fn send_new_event(window_state_lock: &Mutex<MacWindowState>, e: PlatformInput) -> bool {
1893 let window_state = window_state_lock.lock().event_callback.take();
1894 if let Some(mut callback) = window_state {
1895 callback(e);
1896 window_state_lock.lock().event_callback = Some(callback);
1897 true
1898 } else {
1899 false
1900 }
1901}
1902
1903fn drag_event_position(window_state: &Mutex<MacWindowState>, dragging_info: id) -> Point<Pixels> {
1904 let drag_location: NSPoint = unsafe { msg_send![dragging_info, draggingLocation] };
1905 convert_mouse_position(drag_location, window_state.lock().content_size().height)
1906}
1907
1908fn with_input_handler<F, R>(window: &Object, f: F) -> Option<R>
1909where
1910 F: FnOnce(&mut PlatformInputHandler) -> R,
1911{
1912 let window_state = unsafe { get_window_state(window) };
1913 let mut lock = window_state.as_ref().lock();
1914 if let Some(mut input_handler) = lock.input_handler.take() {
1915 drop(lock);
1916 let result = f(&mut input_handler);
1917 window_state.lock().input_handler = Some(input_handler);
1918 Some(result)
1919 } else {
1920 None
1921 }
1922}
1923
1924fn send_to_input_handler(window: &Object, ime: ImeInput) {
1925 unsafe {
1926 let window_state = get_window_state(window);
1927 let mut lock = window_state.lock();
1928
1929 if let Some(mut input_handler) = lock.input_handler.take() {
1930 match ime {
1931 ImeInput::InsertText(text, range) => {
1932 if let Some(ime_input) = lock.last_ime_inputs.as_mut() {
1933 ime_input.push((text, range));
1934 lock.input_handler = Some(input_handler);
1935 return;
1936 }
1937 drop(lock);
1938 input_handler.replace_text_in_range(range, &text)
1939 }
1940 ImeInput::SetMarkedText(text, range, marked_range) => {
1941 lock.ime_composing = true;
1942 drop(lock);
1943 input_handler.replace_and_mark_text_in_range(range, &text, marked_range)
1944 }
1945 ImeInput::UnmarkText => {
1946 drop(lock);
1947 input_handler.unmark_text()
1948 }
1949 }
1950 window_state.lock().input_handler = Some(input_handler);
1951 } else {
1952 match ime {
1953 ImeInput::InsertText(text, range) => {
1954 if let Some(ime_input) = lock.last_ime_inputs.as_mut() {
1955 ime_input.push((text, range));
1956 }
1957 }
1958 _ => {}
1959 }
1960 }
1961 }
1962}
1963
1964unsafe fn display_id_for_screen(screen: id) -> CGDirectDisplayID {
1965 let device_description = NSScreen::deviceDescription(screen);
1966 let screen_number_key: id = NSString::alloc(nil).init_str("NSScreenNumber");
1967 let screen_number = device_description.objectForKey_(screen_number_key);
1968 let screen_number: NSUInteger = msg_send![screen_number, unsignedIntegerValue];
1969 screen_number as CGDirectDisplayID
1970}