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 bounds,
501 titlebar,
502 kind,
503 is_movable,
504 focus,
505 show,
506 display_id,
507 window_min_size,
508 }: WindowParams,
509 executor: ForegroundExecutor,
510 renderer_context: renderer::Context,
511 ) -> Self {
512 unsafe {
513 let pool = NSAutoreleasePool::new(nil);
514
515 let mut style_mask;
516 if let Some(titlebar) = titlebar.as_ref() {
517 style_mask = NSWindowStyleMask::NSClosableWindowMask
518 | NSWindowStyleMask::NSMiniaturizableWindowMask
519 | NSWindowStyleMask::NSResizableWindowMask
520 | NSWindowStyleMask::NSTitledWindowMask;
521
522 if titlebar.appears_transparent {
523 style_mask |= NSWindowStyleMask::NSFullSizeContentViewWindowMask;
524 }
525 } else {
526 style_mask = NSWindowStyleMask::NSTitledWindowMask
527 | NSWindowStyleMask::NSFullSizeContentViewWindowMask;
528 }
529
530 let native_window: id = match kind {
531 WindowKind::Normal => msg_send![WINDOW_CLASS, alloc],
532 WindowKind::PopUp => {
533 style_mask |= NSWindowStyleMaskNonactivatingPanel;
534 msg_send![PANEL_CLASS, alloc]
535 }
536 };
537
538 let display = display_id
539 .and_then(MacDisplay::find_by_id)
540 .unwrap_or_else(|| MacDisplay::primary());
541
542 let mut target_screen = nil;
543 let mut screen_frame = None;
544
545 let screens = NSScreen::screens(nil);
546 let count: u64 = cocoa::foundation::NSArray::count(screens);
547 for i in 0..count {
548 let screen = cocoa::foundation::NSArray::objectAtIndex(screens, i);
549 let frame = NSScreen::frame(screen);
550 let display_id = display_id_for_screen(screen);
551 if display_id == display.0 {
552 screen_frame = Some(frame);
553 target_screen = screen;
554 }
555 }
556
557 let screen_frame = screen_frame.unwrap_or_else(|| {
558 let screen = NSScreen::mainScreen(nil);
559 target_screen = screen;
560 NSScreen::frame(screen)
561 });
562
563 let window_rect = NSRect::new(
564 NSPoint::new(
565 screen_frame.origin.x + bounds.origin.x.0 as f64,
566 screen_frame.origin.y
567 + (display.bounds().size.height - bounds.origin.y).0 as f64,
568 ),
569 NSSize::new(bounds.size.width.0 as f64, bounds.size.height.0 as f64),
570 );
571
572 let native_window = native_window.initWithContentRect_styleMask_backing_defer_screen_(
573 window_rect,
574 style_mask,
575 NSBackingStoreBuffered,
576 NO,
577 target_screen,
578 );
579 assert!(!native_window.is_null());
580 let () = msg_send![
581 native_window,
582 registerForDraggedTypes:
583 NSArray::arrayWithObject(nil, NSFilenamesPboardType)
584 ];
585 let () = msg_send![
586 native_window,
587 setReleasedWhenClosed: NO
588 ];
589
590 let native_view: id = msg_send![VIEW_CLASS, alloc];
591 let native_view = NSView::init(native_view);
592 assert!(!native_view.is_null());
593
594 let mut window = Self(Arc::new(Mutex::new(MacWindowState {
595 handle,
596 executor,
597 native_window,
598 native_view: NonNull::new_unchecked(native_view),
599 display_link: None,
600 renderer: renderer::new_renderer(
601 renderer_context,
602 native_window as *mut _,
603 native_view as *mut _,
604 bounds.size.map(|pixels| pixels.0),
605 false,
606 ),
607 request_frame_callback: None,
608 event_callback: None,
609 activate_callback: None,
610 resize_callback: None,
611 moved_callback: None,
612 should_close_callback: None,
613 close_callback: None,
614 appearance_changed_callback: None,
615 input_handler: None,
616 last_key_equivalent: None,
617 synthetic_drag_counter: 0,
618 traffic_light_position: titlebar
619 .as_ref()
620 .and_then(|titlebar| titlebar.traffic_light_position),
621 previous_modifiers_changed_event: None,
622 last_ime_inputs: None,
623 previous_keydown_inserted_text: None,
624 external_files_dragged: false,
625 first_mouse: false,
626 fullscreen_restore_bounds: Bounds::default(),
627 ime_composing: false,
628 })));
629
630 (*native_window).set_ivar(
631 WINDOW_STATE_IVAR,
632 Arc::into_raw(window.0.clone()) as *const c_void,
633 );
634 native_window.setDelegate_(native_window);
635 (*native_view).set_ivar(
636 WINDOW_STATE_IVAR,
637 Arc::into_raw(window.0.clone()) as *const c_void,
638 );
639
640 if let Some(title) = titlebar
641 .as_ref()
642 .and_then(|t| t.title.as_ref().map(AsRef::as_ref))
643 {
644 window.set_title(title);
645 }
646
647 native_window.setMovable_(is_movable as BOOL);
648
649 if let Some(window_min_size) = window_min_size {
650 native_window.setContentMinSize_(NSSize {
651 width: window_min_size.width.to_f64(),
652 height: window_min_size.height.to_f64(),
653 });
654 }
655
656 if titlebar.map_or(true, |titlebar| titlebar.appears_transparent) {
657 native_window.setTitlebarAppearsTransparent_(YES);
658 native_window.setTitleVisibility_(NSWindowTitleVisibility::NSWindowTitleHidden);
659 }
660
661 native_view.setAutoresizingMask_(NSViewWidthSizable | NSViewHeightSizable);
662 native_view.setWantsBestResolutionOpenGLSurface_(YES);
663
664 // From winit crate: On Mojave, views automatically become layer-backed shortly after
665 // being added to a native_window. Changing the layer-backedness of a view breaks the
666 // association between the view and its associated OpenGL context. To work around this,
667 // on we explicitly make the view layer-backed up front so that AppKit doesn't do it
668 // itself and break the association with its context.
669 native_view.setWantsLayer(YES);
670 let _: () = msg_send![
671 native_view,
672 setLayerContentsRedrawPolicy: NSViewLayerContentsRedrawDuringViewResize
673 ];
674
675 native_window.setContentView_(native_view.autorelease());
676 native_window.makeFirstResponder_(native_view);
677
678 match kind {
679 WindowKind::Normal => {
680 native_window.setLevel_(NSNormalWindowLevel);
681 native_window.setAcceptsMouseMovedEvents_(YES);
682 }
683 WindowKind::PopUp => {
684 // Use a tracking area to allow receiving MouseMoved events even when
685 // the window or application aren't active, which is often the case
686 // e.g. for notification windows.
687 let tracking_area: id = msg_send![class!(NSTrackingArea), alloc];
688 let _: () = msg_send![
689 tracking_area,
690 initWithRect: NSRect::new(NSPoint::new(0., 0.), NSSize::new(0., 0.))
691 options: NSTrackingMouseEnteredAndExited | NSTrackingMouseMoved | NSTrackingActiveAlways | NSTrackingInVisibleRect
692 owner: native_view
693 userInfo: nil
694 ];
695 let _: () =
696 msg_send![native_view, addTrackingArea: tracking_area.autorelease()];
697
698 native_window.setLevel_(NSPopUpWindowLevel);
699 let _: () = msg_send![
700 native_window,
701 setAnimationBehavior: NSWindowAnimationBehaviorUtilityWindow
702 ];
703 native_window.setCollectionBehavior_(
704 NSWindowCollectionBehavior::NSWindowCollectionBehaviorCanJoinAllSpaces |
705 NSWindowCollectionBehavior::NSWindowCollectionBehaviorFullScreenAuxiliary
706 );
707 }
708 }
709
710 if focus {
711 native_window.makeKeyAndOrderFront_(nil);
712 } else if show {
713 native_window.orderFront_(nil);
714 }
715
716 // Set the initial position of the window to the specified origin.
717 // Although we already specified the position using `initWithContentRect_styleMask_backing_defer_screen_`,
718 // the window position might be incorrect if the main screen (the screen that contains the window that has focus)
719 // is different from the primary screen.
720 NSWindow::setFrameTopLeftPoint_(native_window, window_rect.origin);
721 window.0.lock().move_traffic_light();
722
723 pool.drain();
724
725 window
726 }
727 }
728
729 pub fn active_window() -> Option<AnyWindowHandle> {
730 unsafe {
731 let app = NSApplication::sharedApplication(nil);
732 let main_window: id = msg_send![app, mainWindow];
733 if msg_send![main_window, isKindOfClass: WINDOW_CLASS] {
734 let handle = get_window_state(&*main_window).lock().handle;
735 Some(handle)
736 } else {
737 None
738 }
739 }
740 }
741}
742
743impl Drop for MacWindow {
744 fn drop(&mut self) {
745 let mut this = self.0.lock();
746 this.renderer.destroy();
747 let window = this.native_window;
748 this.display_link.take();
749 unsafe {
750 this.native_window.setDelegate_(nil);
751 }
752 this.executor
753 .spawn(async move {
754 unsafe {
755 window.close();
756 window.autorelease();
757 }
758 })
759 .detach();
760 }
761}
762
763impl PlatformWindow for MacWindow {
764 fn bounds(&self) -> Bounds<Pixels> {
765 self.0.as_ref().lock().bounds()
766 }
767
768 fn window_bounds(&self) -> WindowBounds {
769 self.0.as_ref().lock().window_bounds()
770 }
771
772 fn is_maximized(&self) -> bool {
773 self.0.as_ref().lock().is_maximized()
774 }
775
776 fn content_size(&self) -> Size<Pixels> {
777 self.0.as_ref().lock().content_size()
778 }
779
780 fn scale_factor(&self) -> f32 {
781 self.0.as_ref().lock().scale_factor()
782 }
783
784 fn appearance(&self) -> WindowAppearance {
785 unsafe {
786 let appearance: id = msg_send![self.0.lock().native_window, effectiveAppearance];
787 WindowAppearance::from_native(appearance)
788 }
789 }
790
791 fn display(&self) -> Option<Rc<dyn PlatformDisplay>> {
792 unsafe {
793 let screen = self.0.lock().native_window.screen();
794 let device_description: id = msg_send![screen, deviceDescription];
795 let screen_number: id = NSDictionary::valueForKey_(
796 device_description,
797 NSString::alloc(nil).init_str("NSScreenNumber"),
798 );
799
800 let screen_number: u32 = msg_send![screen_number, unsignedIntValue];
801
802 Some(Rc::new(MacDisplay(screen_number)))
803 }
804 }
805
806 fn mouse_position(&self) -> Point<Pixels> {
807 let position = unsafe {
808 self.0
809 .lock()
810 .native_window
811 .mouseLocationOutsideOfEventStream()
812 };
813 convert_mouse_position(position, self.content_size().height)
814 }
815
816 fn modifiers(&self) -> Modifiers {
817 unsafe {
818 let modifiers: NSEventModifierFlags = msg_send![class!(NSEvent), modifierFlags];
819
820 let control = modifiers.contains(NSEventModifierFlags::NSControlKeyMask);
821 let alt = modifiers.contains(NSEventModifierFlags::NSAlternateKeyMask);
822 let shift = modifiers.contains(NSEventModifierFlags::NSShiftKeyMask);
823 let command = modifiers.contains(NSEventModifierFlags::NSCommandKeyMask);
824 let function = modifiers.contains(NSEventModifierFlags::NSFunctionKeyMask);
825
826 Modifiers {
827 control,
828 alt,
829 shift,
830 platform: command,
831 function,
832 }
833 }
834 }
835
836 fn set_input_handler(&mut self, input_handler: PlatformInputHandler) {
837 self.0.as_ref().lock().input_handler = Some(input_handler);
838 }
839
840 fn take_input_handler(&mut self) -> Option<PlatformInputHandler> {
841 self.0.as_ref().lock().input_handler.take()
842 }
843
844 fn prompt(
845 &self,
846 level: PromptLevel,
847 msg: &str,
848 detail: Option<&str>,
849 answers: &[&str],
850 ) -> Option<oneshot::Receiver<usize>> {
851 // macOs applies overrides to modal window buttons after they are added.
852 // Two most important for this logic are:
853 // * Buttons with "Cancel" title will be displayed as the last buttons in the modal
854 // * Last button added to the modal via `addButtonWithTitle` stays focused
855 // * Focused buttons react on "space"/" " keypresses
856 // * Usage of `keyEquivalent`, `makeFirstResponder` or `setInitialFirstResponder` does not change the focus
857 //
858 // See also https://developer.apple.com/documentation/appkit/nsalert/1524532-addbuttonwithtitle#discussion
859 // ```
860 // By default, the first button has a key equivalent of Return,
861 // any button with a title of “Cancel” has a key equivalent of Escape,
862 // 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).
863 // ```
864 //
865 // To avoid situations when the last element added is "Cancel" and it gets the focus
866 // (hence stealing both ESC and Space shortcuts), we find and add one non-Cancel button
867 // last, so it gets focus and a Space shortcut.
868 // This way, "Save this file? Yes/No/Cancel"-ish modals will get all three buttons mapped with a key.
869 let latest_non_cancel_label = answers
870 .iter()
871 .enumerate()
872 .rev()
873 .find(|(_, &label)| label != "Cancel")
874 .filter(|&(label_index, _)| label_index > 0);
875
876 unsafe {
877 let alert: id = msg_send![class!(NSAlert), alloc];
878 let alert: id = msg_send![alert, init];
879 let alert_style = match level {
880 PromptLevel::Info => 1,
881 PromptLevel::Warning => 0,
882 PromptLevel::Critical => 2,
883 };
884 let _: () = msg_send![alert, setAlertStyle: alert_style];
885 let _: () = msg_send![alert, setMessageText: ns_string(msg)];
886 if let Some(detail) = detail {
887 let _: () = msg_send![alert, setInformativeText: ns_string(detail)];
888 }
889
890 for (ix, answer) in answers
891 .iter()
892 .enumerate()
893 .filter(|&(ix, _)| Some(ix) != latest_non_cancel_label.map(|(ix, _)| ix))
894 {
895 let button: id = msg_send![alert, addButtonWithTitle: ns_string(answer)];
896 let _: () = msg_send![button, setTag: ix as NSInteger];
897 }
898 if let Some((ix, answer)) = latest_non_cancel_label {
899 let button: id = msg_send![alert, addButtonWithTitle: ns_string(answer)];
900 let _: () = msg_send![button, setTag: ix as NSInteger];
901 }
902
903 let (done_tx, done_rx) = oneshot::channel();
904 let done_tx = Cell::new(Some(done_tx));
905 let block = ConcreteBlock::new(move |answer: NSInteger| {
906 if let Some(done_tx) = done_tx.take() {
907 let _ = done_tx.send(answer.try_into().unwrap());
908 }
909 });
910 let block = block.copy();
911 let native_window = self.0.lock().native_window;
912 let executor = self.0.lock().executor.clone();
913 executor
914 .spawn(async move {
915 let _: () = msg_send![
916 alert,
917 beginSheetModalForWindow: native_window
918 completionHandler: block
919 ];
920 })
921 .detach();
922
923 Some(done_rx)
924 }
925 }
926
927 fn activate(&self) {
928 let window = self.0.lock().native_window;
929 let executor = self.0.lock().executor.clone();
930 executor
931 .spawn(async move {
932 unsafe {
933 let _: () = msg_send![window, makeKeyAndOrderFront: nil];
934 }
935 })
936 .detach();
937 }
938
939 fn is_active(&self) -> bool {
940 unsafe { self.0.lock().native_window.isKeyWindow() == YES }
941 }
942
943 // is_hovered is unused on macOS. See WindowContext::is_window_hovered.
944 fn is_hovered(&self) -> bool {
945 false
946 }
947
948 fn set_title(&mut self, title: &str) {
949 unsafe {
950 let app = NSApplication::sharedApplication(nil);
951 let window = self.0.lock().native_window;
952 let title = ns_string(title);
953 let _: () = msg_send![app, changeWindowsItem:window title:title filename:false];
954 let _: () = msg_send![window, setTitle: title];
955 self.0.lock().move_traffic_light();
956 }
957 }
958
959 fn set_app_id(&mut self, _app_id: &str) {}
960
961 fn set_background_appearance(&self, background_appearance: WindowBackgroundAppearance) {
962 let mut this = self.0.as_ref().lock();
963 this.renderer
964 .update_transparency(background_appearance != WindowBackgroundAppearance::Opaque);
965
966 let blur_radius = if background_appearance == WindowBackgroundAppearance::Blurred {
967 80
968 } else {
969 0
970 };
971 let opaque = if background_appearance == WindowBackgroundAppearance::Opaque {
972 YES
973 } else {
974 NO
975 };
976 unsafe {
977 this.native_window.setOpaque_(opaque);
978 // Shadows for transparent windows cause artifacts and performance issues
979 this.native_window.setHasShadow_(opaque);
980 let clear_color = if opaque == YES {
981 NSColor::colorWithSRGBRed_green_blue_alpha_(nil, 0f64, 0f64, 0f64, 1f64)
982 } else {
983 NSColor::clearColor(nil)
984 };
985 this.native_window.setBackgroundColor_(clear_color);
986 let window_number = this.native_window.windowNumber();
987 CGSSetWindowBackgroundBlurRadius(CGSMainConnectionID(), window_number, blur_radius);
988 }
989 }
990
991 fn set_edited(&mut self, edited: bool) {
992 unsafe {
993 let window = self.0.lock().native_window;
994 msg_send![window, setDocumentEdited: edited as BOOL]
995 }
996
997 // Changing the document edited state resets the traffic light position,
998 // so we have to move it again.
999 self.0.lock().move_traffic_light();
1000 }
1001
1002 fn show_character_palette(&self) {
1003 let this = self.0.lock();
1004 let window = this.native_window;
1005 this.executor
1006 .spawn(async move {
1007 unsafe {
1008 let app = NSApplication::sharedApplication(nil);
1009 let _: () = msg_send![app, orderFrontCharacterPalette: window];
1010 }
1011 })
1012 .detach();
1013 }
1014
1015 fn minimize(&self) {
1016 let window = self.0.lock().native_window;
1017 unsafe {
1018 window.miniaturize_(nil);
1019 }
1020 }
1021
1022 fn zoom(&self) {
1023 let this = self.0.lock();
1024 let window = this.native_window;
1025 this.executor
1026 .spawn(async move {
1027 unsafe {
1028 window.zoom_(nil);
1029 }
1030 })
1031 .detach();
1032 }
1033
1034 fn toggle_fullscreen(&self) {
1035 let this = self.0.lock();
1036 let window = this.native_window;
1037 this.executor
1038 .spawn(async move {
1039 unsafe {
1040 window.toggleFullScreen_(nil);
1041 }
1042 })
1043 .detach();
1044 }
1045
1046 fn is_fullscreen(&self) -> bool {
1047 let this = self.0.lock();
1048 let window = this.native_window;
1049
1050 unsafe {
1051 window
1052 .styleMask()
1053 .contains(NSWindowStyleMask::NSFullScreenWindowMask)
1054 }
1055 }
1056
1057 fn on_request_frame(&self, callback: Box<dyn FnMut()>) {
1058 self.0.as_ref().lock().request_frame_callback = Some(callback);
1059 }
1060
1061 fn on_input(&self, callback: Box<dyn FnMut(PlatformInput) -> crate::DispatchEventResult>) {
1062 self.0.as_ref().lock().event_callback = Some(callback);
1063 }
1064
1065 fn on_active_status_change(&self, callback: Box<dyn FnMut(bool)>) {
1066 self.0.as_ref().lock().activate_callback = Some(callback);
1067 }
1068
1069 fn on_hover_status_change(&self, _: Box<dyn FnMut(bool)>) {}
1070
1071 fn on_resize(&self, callback: Box<dyn FnMut(Size<Pixels>, f32)>) {
1072 self.0.as_ref().lock().resize_callback = Some(callback);
1073 }
1074
1075 fn on_moved(&self, callback: Box<dyn FnMut()>) {
1076 self.0.as_ref().lock().moved_callback = Some(callback);
1077 }
1078
1079 fn on_should_close(&self, callback: Box<dyn FnMut() -> bool>) {
1080 self.0.as_ref().lock().should_close_callback = Some(callback);
1081 }
1082
1083 fn on_close(&self, callback: Box<dyn FnOnce()>) {
1084 self.0.as_ref().lock().close_callback = Some(callback);
1085 }
1086
1087 fn on_appearance_changed(&self, callback: Box<dyn FnMut()>) {
1088 self.0.lock().appearance_changed_callback = Some(callback);
1089 }
1090
1091 fn draw(&self, scene: &crate::Scene) {
1092 let mut this = self.0.lock();
1093 this.renderer.draw(scene);
1094 }
1095
1096 fn sprite_atlas(&self) -> Arc<dyn PlatformAtlas> {
1097 self.0.lock().renderer.sprite_atlas().clone()
1098 }
1099}
1100
1101impl rwh::HasWindowHandle for MacWindow {
1102 fn window_handle(&self) -> Result<rwh::WindowHandle<'_>, rwh::HandleError> {
1103 // SAFETY: The AppKitWindowHandle is a wrapper around a pointer to an NSView
1104 unsafe {
1105 Ok(rwh::WindowHandle::borrow_raw(rwh::RawWindowHandle::AppKit(
1106 rwh::AppKitWindowHandle::new(self.0.lock().native_view.cast()),
1107 )))
1108 }
1109 }
1110}
1111
1112impl rwh::HasDisplayHandle for MacWindow {
1113 fn display_handle(&self) -> Result<rwh::DisplayHandle<'_>, rwh::HandleError> {
1114 // SAFETY: This is a no-op on macOS
1115 unsafe {
1116 Ok(rwh::DisplayHandle::borrow_raw(
1117 rwh::AppKitDisplayHandle::new().into(),
1118 ))
1119 }
1120 }
1121}
1122
1123fn get_scale_factor(native_window: id) -> f32 {
1124 let factor = unsafe {
1125 let screen: id = msg_send![native_window, screen];
1126 NSScreen::backingScaleFactor(screen) as f32
1127 };
1128
1129 // We are not certain what triggers this, but it seems that sometimes
1130 // this method would return 0 (https://github.com/zed-industries/zed/issues/6412)
1131 // It seems most likely that this would happen if the window has no screen
1132 // (if it is off-screen), though we'd expect to see viewDidChangeBackingProperties before
1133 // it was rendered for real.
1134 // Regardless, attempt to avoid the issue here.
1135 if factor == 0.0 {
1136 2.
1137 } else {
1138 factor
1139 }
1140}
1141
1142unsafe fn get_window_state(object: &Object) -> Arc<Mutex<MacWindowState>> {
1143 let raw: *mut c_void = *object.get_ivar(WINDOW_STATE_IVAR);
1144 let rc1 = Arc::from_raw(raw as *mut Mutex<MacWindowState>);
1145 let rc2 = rc1.clone();
1146 mem::forget(rc1);
1147 rc2
1148}
1149
1150unsafe fn drop_window_state(object: &Object) {
1151 let raw: *mut c_void = *object.get_ivar(WINDOW_STATE_IVAR);
1152 Arc::from_raw(raw as *mut Mutex<MacWindowState>);
1153}
1154
1155extern "C" fn yes(_: &Object, _: Sel) -> BOOL {
1156 YES
1157}
1158
1159extern "C" fn dealloc_window(this: &Object, _: Sel) {
1160 unsafe {
1161 drop_window_state(this);
1162 let _: () = msg_send![super(this, class!(NSWindow)), dealloc];
1163 }
1164}
1165
1166extern "C" fn dealloc_view(this: &Object, _: Sel) {
1167 unsafe {
1168 drop_window_state(this);
1169 let _: () = msg_send![super(this, class!(NSView)), dealloc];
1170 }
1171}
1172
1173extern "C" fn handle_key_equivalent(this: &Object, _: Sel, native_event: id) -> BOOL {
1174 handle_key_event(this, native_event, true)
1175}
1176
1177extern "C" fn handle_key_down(this: &Object, _: Sel, native_event: id) {
1178 handle_key_event(this, native_event, false);
1179}
1180
1181// Things to test if you're modifying this method:
1182// U.S. layout:
1183// - The IME consumes characters like 'j' and 'k', which makes paging through `less` in
1184// the terminal behave incorrectly by default. This behavior should be patched by our
1185// IME integration
1186// - `alt-t` should open the tasks menu
1187// - In vim mode, this keybinding should work:
1188// ```
1189// {
1190// "context": "Editor && vim_mode == insert",
1191// "bindings": {"j j": "vim::NormalBefore"}
1192// }
1193// ```
1194// and typing 'j k' in insert mode with this keybinding should insert the two characters
1195// Brazilian layout:
1196// - `" space` should create an unmarked quote
1197// - `" backspace` should delete the marked quote
1198// - `" up` should insert a quote, unmark it, and move up one line
1199// - `" cmd-down` should insert a quote, unmark it, and move to the end of the file
1200// - NOTE: The current implementation does not move the selection to the end of the file
1201// - `cmd-ctrl-space` and clicking on an emoji should type it
1202// Czech (QWERTY) layout:
1203// - in vim mode `option-4` should go to end of line (same as $)
1204// Japanese (Romaji) layout:
1205// - type `a i left down up enter enter` should create an unmarked text "愛"
1206extern "C" fn handle_key_event(this: &Object, native_event: id, key_equivalent: bool) -> BOOL {
1207 let window_state = unsafe { get_window_state(this) };
1208 let mut lock = window_state.as_ref().lock();
1209
1210 let window_height = lock.content_size().height;
1211 let event = unsafe { PlatformInput::from_native(native_event, Some(window_height)) };
1212
1213 if let Some(PlatformInput::KeyDown(mut event)) = event {
1214 // For certain keystrokes, macOS will first dispatch a "key equivalent" event.
1215 // If that event isn't handled, it will then dispatch a "key down" event. GPUI
1216 // makes no distinction between these two types of events, so we need to ignore
1217 // the "key down" event if we've already just processed its "key equivalent" version.
1218 if key_equivalent {
1219 lock.last_key_equivalent = Some(event.clone());
1220 } else if lock.last_key_equivalent.take().as_ref() == Some(&event) {
1221 return NO;
1222 }
1223
1224 let keydown = event.keystroke.clone();
1225 let fn_modifier = keydown.modifiers.function;
1226 lock.last_ime_inputs = Some(Default::default());
1227 drop(lock);
1228
1229 // Send the event to the input context for IME handling, unless the `fn` modifier is
1230 // being pressed.
1231 // this will call back into `insert_text`, etc.
1232 if !fn_modifier {
1233 unsafe {
1234 let input_context: id = msg_send![this, inputContext];
1235 let _: BOOL = msg_send![input_context, handleEvent: native_event];
1236 }
1237 }
1238
1239 let mut handled = false;
1240 let mut lock = window_state.lock();
1241 let previous_keydown_inserted_text = lock.previous_keydown_inserted_text.take();
1242 let mut last_inserts = lock.last_ime_inputs.take().unwrap();
1243 let ime_composing = std::mem::take(&mut lock.ime_composing);
1244
1245 let mut callback = lock.event_callback.take();
1246 drop(lock);
1247
1248 let last_insert = last_inserts.pop();
1249 // on a brazilian keyboard typing `"` and then hitting `up` will cause two IME
1250 // events, one to unmark the quote, and one to send the up arrow.
1251 for (text, range) in last_inserts {
1252 send_to_input_handler(this, ImeInput::InsertText(text, range));
1253 }
1254
1255 let is_composing =
1256 with_input_handler(this, |input_handler| input_handler.marked_text_range())
1257 .flatten()
1258 .is_some()
1259 || ime_composing;
1260
1261 if let Some((text, range)) = last_insert {
1262 if !is_composing {
1263 window_state.lock().previous_keydown_inserted_text = Some(text.clone());
1264 if let Some(callback) = callback.as_mut() {
1265 event.keystroke.ime_key = Some(text.clone());
1266 handled = !callback(PlatformInput::KeyDown(event)).propagate;
1267 }
1268 }
1269
1270 if !handled {
1271 handled = true;
1272 send_to_input_handler(this, ImeInput::InsertText(text, range));
1273 }
1274 } else if !is_composing {
1275 let is_held = event.is_held;
1276
1277 if let Some(callback) = callback.as_mut() {
1278 handled = !callback(PlatformInput::KeyDown(event)).propagate;
1279 }
1280
1281 if !handled && is_held {
1282 if let Some(text) = previous_keydown_inserted_text {
1283 // MacOS IME is a bit funky, and even when you've told it there's nothing to
1284 // enter it will still swallow certain keys (e.g. 'f', 'j') and not others
1285 // (e.g. 'n'). This is a problem for certain kinds of views, like the terminal.
1286 with_input_handler(this, |input_handler| {
1287 if input_handler.selected_text_range().is_none() {
1288 handled = true;
1289 input_handler.replace_text_in_range(None, &text)
1290 }
1291 });
1292 window_state.lock().previous_keydown_inserted_text = Some(text);
1293 }
1294 }
1295 }
1296
1297 window_state.lock().event_callback = callback;
1298
1299 handled as BOOL
1300 } else {
1301 NO
1302 }
1303}
1304
1305extern "C" fn handle_view_event(this: &Object, _: Sel, native_event: id) {
1306 let window_state = unsafe { get_window_state(this) };
1307 let weak_window_state = Arc::downgrade(&window_state);
1308 let mut lock = window_state.as_ref().lock();
1309 let window_height = lock.content_size().height;
1310 let event = unsafe { PlatformInput::from_native(native_event, Some(window_height)) };
1311
1312 if let Some(mut event) = event {
1313 match &mut event {
1314 PlatformInput::MouseDown(
1315 event @ MouseDownEvent {
1316 button: MouseButton::Left,
1317 modifiers: Modifiers { control: true, .. },
1318 ..
1319 },
1320 ) => {
1321 // On mac, a ctrl-left click should be handled as a right click.
1322 *event = MouseDownEvent {
1323 button: MouseButton::Right,
1324 modifiers: Modifiers {
1325 control: false,
1326 ..event.modifiers
1327 },
1328 click_count: 1,
1329 ..*event
1330 };
1331 }
1332
1333 // Handles focusing click.
1334 PlatformInput::MouseDown(
1335 event @ MouseDownEvent {
1336 button: MouseButton::Left,
1337 ..
1338 },
1339 ) if (lock.first_mouse) => {
1340 *event = MouseDownEvent {
1341 first_mouse: true,
1342 ..*event
1343 };
1344 lock.first_mouse = false;
1345 }
1346
1347 // Because we map a ctrl-left_down to a right_down -> right_up let's ignore
1348 // the ctrl-left_up to avoid having a mismatch in button down/up events if the
1349 // user is still holding ctrl when releasing the left mouse button
1350 PlatformInput::MouseUp(
1351 event @ MouseUpEvent {
1352 button: MouseButton::Left,
1353 modifiers: Modifiers { control: true, .. },
1354 ..
1355 },
1356 ) => {
1357 *event = MouseUpEvent {
1358 button: MouseButton::Right,
1359 modifiers: Modifiers {
1360 control: false,
1361 ..event.modifiers
1362 },
1363 click_count: 1,
1364 ..*event
1365 };
1366 }
1367
1368 _ => {}
1369 };
1370
1371 match &event {
1372 PlatformInput::MouseMove(
1373 event @ MouseMoveEvent {
1374 pressed_button: Some(_),
1375 ..
1376 },
1377 ) => {
1378 // Synthetic drag is used for selecting long buffer contents while buffer is being scrolled.
1379 // External file drag and drop is able to emit its own synthetic mouse events which will conflict
1380 // with these ones.
1381 if !lock.external_files_dragged {
1382 lock.synthetic_drag_counter += 1;
1383 let executor = lock.executor.clone();
1384 executor
1385 .spawn(synthetic_drag(
1386 weak_window_state,
1387 lock.synthetic_drag_counter,
1388 event.clone(),
1389 ))
1390 .detach();
1391 }
1392 }
1393
1394 PlatformInput::MouseUp(MouseUpEvent { .. }) => {
1395 lock.synthetic_drag_counter += 1;
1396 }
1397
1398 PlatformInput::ModifiersChanged(ModifiersChangedEvent { modifiers }) => {
1399 // Only raise modifiers changed event when they have actually changed
1400 if let Some(PlatformInput::ModifiersChanged(ModifiersChangedEvent {
1401 modifiers: prev_modifiers,
1402 })) = &lock.previous_modifiers_changed_event
1403 {
1404 if prev_modifiers == modifiers {
1405 return;
1406 }
1407 }
1408
1409 lock.previous_modifiers_changed_event = Some(event.clone());
1410 }
1411
1412 _ => {}
1413 }
1414
1415 if let Some(mut callback) = lock.event_callback.take() {
1416 drop(lock);
1417 callback(event);
1418 window_state.lock().event_callback = Some(callback);
1419 }
1420 }
1421}
1422
1423// Allows us to receive `cmd-.` (the shortcut for closing a dialog)
1424// https://bugs.eclipse.org/bugs/show_bug.cgi?id=300620#c6
1425extern "C" fn cancel_operation(this: &Object, _sel: Sel, _sender: id) {
1426 let window_state = unsafe { get_window_state(this) };
1427 let mut lock = window_state.as_ref().lock();
1428
1429 let keystroke = Keystroke {
1430 modifiers: Default::default(),
1431 key: ".".into(),
1432 ime_key: None,
1433 };
1434 let event = PlatformInput::KeyDown(KeyDownEvent {
1435 keystroke: keystroke.clone(),
1436 is_held: false,
1437 });
1438
1439 if let Some(mut callback) = lock.event_callback.take() {
1440 drop(lock);
1441 callback(event);
1442 window_state.lock().event_callback = Some(callback);
1443 }
1444}
1445
1446extern "C" fn window_did_change_occlusion_state(this: &Object, _: Sel, _: id) {
1447 let window_state = unsafe { get_window_state(this) };
1448 let lock = &mut *window_state.lock();
1449 unsafe {
1450 if lock
1451 .native_window
1452 .occlusionState()
1453 .contains(NSWindowOcclusionState::NSWindowOcclusionStateVisible)
1454 {
1455 lock.start_display_link();
1456 } else {
1457 lock.stop_display_link();
1458 }
1459 }
1460}
1461
1462extern "C" fn window_did_resize(this: &Object, _: Sel, _: id) {
1463 let window_state = unsafe { get_window_state(this) };
1464 window_state.as_ref().lock().move_traffic_light();
1465}
1466
1467extern "C" fn window_will_enter_fullscreen(this: &Object, _: Sel, _: id) {
1468 let window_state = unsafe { get_window_state(this) };
1469 let mut lock = window_state.as_ref().lock();
1470 lock.fullscreen_restore_bounds = lock.bounds();
1471}
1472
1473extern "C" fn window_did_move(this: &Object, _: Sel, _: id) {
1474 let window_state = unsafe { get_window_state(this) };
1475 let mut lock = window_state.as_ref().lock();
1476 if let Some(mut callback) = lock.moved_callback.take() {
1477 drop(lock);
1478 callback();
1479 window_state.lock().moved_callback = Some(callback);
1480 }
1481}
1482
1483extern "C" fn window_did_change_screen(this: &Object, _: Sel, _: id) {
1484 let window_state = unsafe { get_window_state(this) };
1485 let mut lock = window_state.as_ref().lock();
1486 lock.start_display_link();
1487}
1488
1489extern "C" fn window_did_change_key_status(this: &Object, selector: Sel, _: id) {
1490 let window_state = unsafe { get_window_state(this) };
1491 let lock = window_state.lock();
1492 let is_active = unsafe { lock.native_window.isKeyWindow() == YES };
1493
1494 // When opening a pop-up while the application isn't active, Cocoa sends a spurious
1495 // `windowDidBecomeKey` message to the previous key window even though that window
1496 // isn't actually key. This causes a bug if the application is later activated while
1497 // the pop-up is still open, making it impossible to activate the previous key window
1498 // even if the pop-up gets closed. The only way to activate it again is to de-activate
1499 // the app and re-activate it, which is a pretty bad UX.
1500 // The following code detects the spurious event and invokes `resignKeyWindow`:
1501 // in theory, we're not supposed to invoke this method manually but it balances out
1502 // the spurious `becomeKeyWindow` event and helps us work around that bug.
1503 if selector == sel!(windowDidBecomeKey:) && !is_active {
1504 unsafe {
1505 let _: () = msg_send![lock.native_window, resignKeyWindow];
1506 return;
1507 }
1508 }
1509
1510 let executor = lock.executor.clone();
1511 drop(lock);
1512 executor
1513 .spawn(async move {
1514 let mut lock = window_state.as_ref().lock();
1515 if let Some(mut callback) = lock.activate_callback.take() {
1516 drop(lock);
1517 callback(is_active);
1518 window_state.lock().activate_callback = Some(callback);
1519 };
1520 })
1521 .detach();
1522}
1523
1524extern "C" fn window_should_close(this: &Object, _: Sel, _: id) -> BOOL {
1525 let window_state = unsafe { get_window_state(this) };
1526 let mut lock = window_state.as_ref().lock();
1527 if let Some(mut callback) = lock.should_close_callback.take() {
1528 drop(lock);
1529 let should_close = callback();
1530 window_state.lock().should_close_callback = Some(callback);
1531 should_close as BOOL
1532 } else {
1533 YES
1534 }
1535}
1536
1537extern "C" fn close_window(this: &Object, _: Sel) {
1538 unsafe {
1539 let close_callback = {
1540 let window_state = get_window_state(this);
1541 let mut lock = window_state.as_ref().lock();
1542 lock.close_callback.take()
1543 };
1544
1545 if let Some(callback) = close_callback {
1546 callback();
1547 }
1548
1549 let _: () = msg_send![super(this, class!(NSWindow)), close];
1550 }
1551}
1552
1553extern "C" fn make_backing_layer(this: &Object, _: Sel) -> id {
1554 let window_state = unsafe { get_window_state(this) };
1555 let window_state = window_state.as_ref().lock();
1556 window_state.renderer.layer_ptr() as id
1557}
1558
1559extern "C" fn view_did_change_backing_properties(this: &Object, _: Sel) {
1560 let window_state = unsafe { get_window_state(this) };
1561 let mut lock = window_state.as_ref().lock();
1562
1563 let scale_factor = lock.scale_factor();
1564 let size = lock.content_size();
1565 let drawable_size = size.to_device_pixels(scale_factor);
1566 unsafe {
1567 let _: () = msg_send![
1568 lock.renderer.layer(),
1569 setContentsScale: scale_factor as f64
1570 ];
1571 }
1572
1573 lock.renderer.update_drawable_size(drawable_size);
1574
1575 if let Some(mut callback) = lock.resize_callback.take() {
1576 let content_size = lock.content_size();
1577 let scale_factor = lock.scale_factor();
1578 drop(lock);
1579 callback(content_size, scale_factor);
1580 window_state.as_ref().lock().resize_callback = Some(callback);
1581 };
1582}
1583
1584extern "C" fn set_frame_size(this: &Object, _: Sel, size: NSSize) {
1585 let window_state = unsafe { get_window_state(this) };
1586 let mut lock = window_state.as_ref().lock();
1587
1588 let new_size = Size::<Pixels>::from(size);
1589 if lock.content_size() == new_size {
1590 return;
1591 }
1592
1593 unsafe {
1594 let _: () = msg_send![super(this, class!(NSView)), setFrameSize: size];
1595 }
1596
1597 let scale_factor = lock.scale_factor();
1598 let drawable_size = new_size.to_device_pixels(scale_factor);
1599 lock.renderer.update_drawable_size(drawable_size);
1600
1601 if let Some(mut callback) = lock.resize_callback.take() {
1602 let content_size = lock.content_size();
1603 let scale_factor = lock.scale_factor();
1604 drop(lock);
1605 callback(content_size, scale_factor);
1606 window_state.lock().resize_callback = Some(callback);
1607 };
1608}
1609
1610extern "C" fn display_layer(this: &Object, _: Sel, _: id) {
1611 let window_state = unsafe { get_window_state(this) };
1612 let mut lock = window_state.lock();
1613 if let Some(mut callback) = lock.request_frame_callback.take() {
1614 #[cfg(not(feature = "macos-blade"))]
1615 lock.renderer.set_presents_with_transaction(true);
1616 lock.stop_display_link();
1617 drop(lock);
1618 callback();
1619
1620 let mut lock = window_state.lock();
1621 lock.request_frame_callback = Some(callback);
1622 #[cfg(not(feature = "macos-blade"))]
1623 lock.renderer.set_presents_with_transaction(false);
1624 lock.start_display_link();
1625 }
1626}
1627
1628unsafe extern "C" fn step(view: *mut c_void) {
1629 let view = view as id;
1630 let window_state = unsafe { get_window_state(&*view) };
1631 let mut lock = window_state.lock();
1632
1633 if let Some(mut callback) = lock.request_frame_callback.take() {
1634 drop(lock);
1635 callback();
1636 window_state.lock().request_frame_callback = Some(callback);
1637 }
1638}
1639
1640extern "C" fn valid_attributes_for_marked_text(_: &Object, _: Sel) -> id {
1641 unsafe { msg_send![class!(NSArray), array] }
1642}
1643
1644extern "C" fn has_marked_text(this: &Object, _: Sel) -> BOOL {
1645 let has_marked_text_result =
1646 with_input_handler(this, |input_handler| input_handler.marked_text_range()).flatten();
1647
1648 has_marked_text_result.is_some() as BOOL
1649}
1650
1651extern "C" fn marked_range(this: &Object, _: Sel) -> NSRange {
1652 let marked_range_result =
1653 with_input_handler(this, |input_handler| input_handler.marked_text_range()).flatten();
1654
1655 marked_range_result.map_or(NSRange::invalid(), |range| range.into())
1656}
1657
1658extern "C" fn selected_range(this: &Object, _: Sel) -> NSRange {
1659 let selected_range_result =
1660 with_input_handler(this, |input_handler| input_handler.selected_text_range()).flatten();
1661
1662 selected_range_result.map_or(NSRange::invalid(), |range| range.into())
1663}
1664
1665extern "C" fn first_rect_for_character_range(
1666 this: &Object,
1667 _: Sel,
1668 range: NSRange,
1669 _: id,
1670) -> NSRect {
1671 let frame: NSRect = unsafe {
1672 let state = get_window_state(this);
1673 let lock = state.lock();
1674 let mut frame = NSWindow::frame(lock.native_window);
1675 let content_layout_rect: CGRect = msg_send![lock.native_window, contentLayoutRect];
1676 frame.origin.y -= frame.size.height - content_layout_rect.size.height;
1677 frame
1678 };
1679 with_input_handler(this, |input_handler| {
1680 input_handler.bounds_for_range(range.to_range()?)
1681 })
1682 .flatten()
1683 .map_or(
1684 NSRect::new(NSPoint::new(0., 0.), NSSize::new(0., 0.)),
1685 |bounds| {
1686 NSRect::new(
1687 NSPoint::new(
1688 frame.origin.x + bounds.origin.x.0 as f64,
1689 frame.origin.y + frame.size.height
1690 - bounds.origin.y.0 as f64
1691 - bounds.size.height.0 as f64,
1692 ),
1693 NSSize::new(bounds.size.width.0 as f64, bounds.size.height.0 as f64),
1694 )
1695 },
1696 )
1697}
1698
1699extern "C" fn insert_text(this: &Object, _: Sel, text: id, replacement_range: NSRange) {
1700 unsafe {
1701 let is_attributed_string: BOOL =
1702 msg_send![text, isKindOfClass: [class!(NSAttributedString)]];
1703 let text: id = if is_attributed_string == YES {
1704 msg_send![text, string]
1705 } else {
1706 text
1707 };
1708
1709 let text = text.to_str();
1710 let replacement_range = replacement_range.to_range();
1711 send_to_input_handler(
1712 this,
1713 ImeInput::InsertText(text.to_string(), replacement_range),
1714 );
1715 }
1716}
1717
1718extern "C" fn set_marked_text(
1719 this: &Object,
1720 _: Sel,
1721 text: id,
1722 selected_range: NSRange,
1723 replacement_range: NSRange,
1724) {
1725 unsafe {
1726 let is_attributed_string: BOOL =
1727 msg_send![text, isKindOfClass: [class!(NSAttributedString)]];
1728 let text: id = if is_attributed_string == YES {
1729 msg_send![text, string]
1730 } else {
1731 text
1732 };
1733 let selected_range = selected_range.to_range();
1734 let replacement_range = replacement_range.to_range();
1735 let text = text.to_str();
1736
1737 send_to_input_handler(
1738 this,
1739 ImeInput::SetMarkedText(text.to_string(), replacement_range, selected_range),
1740 );
1741 }
1742}
1743extern "C" fn unmark_text(this: &Object, _: Sel) {
1744 send_to_input_handler(this, ImeInput::UnmarkText);
1745}
1746
1747extern "C" fn attributed_substring_for_proposed_range(
1748 this: &Object,
1749 _: Sel,
1750 range: NSRange,
1751 _actual_range: *mut c_void,
1752) -> id {
1753 with_input_handler(this, |input_handler| {
1754 let range = range.to_range()?;
1755 if range.is_empty() {
1756 return None;
1757 }
1758
1759 let selected_text = input_handler.text_for_range(range.clone())?;
1760 unsafe {
1761 let string: id = msg_send![class!(NSAttributedString), alloc];
1762 let string: id = msg_send![string, initWithString: ns_string(&selected_text)];
1763 Some(string)
1764 }
1765 })
1766 .flatten()
1767 .unwrap_or(nil)
1768}
1769
1770extern "C" fn do_command_by_selector(_: &Object, _: Sel, _: Sel) {}
1771
1772extern "C" fn view_did_change_effective_appearance(this: &Object, _: Sel) {
1773 unsafe {
1774 let state = get_window_state(this);
1775 let mut lock = state.as_ref().lock();
1776 if let Some(mut callback) = lock.appearance_changed_callback.take() {
1777 drop(lock);
1778 callback();
1779 state.lock().appearance_changed_callback = Some(callback);
1780 }
1781 }
1782}
1783
1784extern "C" fn accepts_first_mouse(this: &Object, _: Sel, _: id) -> BOOL {
1785 let window_state = unsafe { get_window_state(this) };
1786 let mut lock = window_state.as_ref().lock();
1787 lock.first_mouse = true;
1788 YES
1789}
1790
1791extern "C" fn dragging_entered(this: &Object, _: Sel, dragging_info: id) -> NSDragOperation {
1792 let window_state = unsafe { get_window_state(this) };
1793 let position = drag_event_position(&window_state, dragging_info);
1794 let paths = external_paths_from_event(dragging_info);
1795 if let Some(event) =
1796 paths.map(|paths| PlatformInput::FileDrop(FileDropEvent::Entered { position, paths }))
1797 {
1798 if send_new_event(&window_state, event) {
1799 window_state.lock().external_files_dragged = true;
1800 return NSDragOperationCopy;
1801 }
1802 }
1803 NSDragOperationNone
1804}
1805
1806extern "C" fn dragging_updated(this: &Object, _: Sel, dragging_info: id) -> NSDragOperation {
1807 let window_state = unsafe { get_window_state(this) };
1808 let position = drag_event_position(&window_state, dragging_info);
1809 if send_new_event(
1810 &window_state,
1811 PlatformInput::FileDrop(FileDropEvent::Pending { position }),
1812 ) {
1813 NSDragOperationCopy
1814 } else {
1815 NSDragOperationNone
1816 }
1817}
1818
1819extern "C" fn dragging_exited(this: &Object, _: Sel, _: id) {
1820 let window_state = unsafe { get_window_state(this) };
1821 send_new_event(
1822 &window_state,
1823 PlatformInput::FileDrop(FileDropEvent::Exited),
1824 );
1825 window_state.lock().external_files_dragged = false;
1826}
1827
1828extern "C" fn perform_drag_operation(this: &Object, _: Sel, dragging_info: id) -> BOOL {
1829 let window_state = unsafe { get_window_state(this) };
1830 let position = drag_event_position(&window_state, dragging_info);
1831 if send_new_event(
1832 &window_state,
1833 PlatformInput::FileDrop(FileDropEvent::Submit { position }),
1834 ) {
1835 YES
1836 } else {
1837 NO
1838 }
1839}
1840
1841fn external_paths_from_event(dragging_info: *mut Object) -> Option<ExternalPaths> {
1842 let mut paths = SmallVec::new();
1843 let pasteboard: id = unsafe { msg_send![dragging_info, draggingPasteboard] };
1844 let filenames = unsafe { NSPasteboard::propertyListForType(pasteboard, NSFilenamesPboardType) };
1845 if filenames == nil {
1846 return None;
1847 }
1848 for file in unsafe { filenames.iter() } {
1849 let path = unsafe {
1850 let f = NSString::UTF8String(file);
1851 CStr::from_ptr(f).to_string_lossy().into_owned()
1852 };
1853 paths.push(PathBuf::from(path))
1854 }
1855 Some(ExternalPaths(paths))
1856}
1857
1858extern "C" fn conclude_drag_operation(this: &Object, _: Sel, _: id) {
1859 let window_state = unsafe { get_window_state(this) };
1860 send_new_event(
1861 &window_state,
1862 PlatformInput::FileDrop(FileDropEvent::Exited),
1863 );
1864}
1865
1866async fn synthetic_drag(
1867 window_state: Weak<Mutex<MacWindowState>>,
1868 drag_id: usize,
1869 event: MouseMoveEvent,
1870) {
1871 loop {
1872 Timer::after(Duration::from_millis(16)).await;
1873 if let Some(window_state) = window_state.upgrade() {
1874 let mut lock = window_state.lock();
1875 if lock.synthetic_drag_counter == drag_id {
1876 if let Some(mut callback) = lock.event_callback.take() {
1877 drop(lock);
1878 callback(PlatformInput::MouseMove(event.clone()));
1879 window_state.lock().event_callback = Some(callback);
1880 }
1881 } else {
1882 break;
1883 }
1884 }
1885 }
1886}
1887
1888fn send_new_event(window_state_lock: &Mutex<MacWindowState>, e: PlatformInput) -> bool {
1889 let window_state = window_state_lock.lock().event_callback.take();
1890 if let Some(mut callback) = window_state {
1891 callback(e);
1892 window_state_lock.lock().event_callback = Some(callback);
1893 true
1894 } else {
1895 false
1896 }
1897}
1898
1899fn drag_event_position(window_state: &Mutex<MacWindowState>, dragging_info: id) -> Point<Pixels> {
1900 let drag_location: NSPoint = unsafe { msg_send![dragging_info, draggingLocation] };
1901 convert_mouse_position(drag_location, window_state.lock().content_size().height)
1902}
1903
1904fn with_input_handler<F, R>(window: &Object, f: F) -> Option<R>
1905where
1906 F: FnOnce(&mut PlatformInputHandler) -> R,
1907{
1908 let window_state = unsafe { get_window_state(window) };
1909 let mut lock = window_state.as_ref().lock();
1910 if let Some(mut input_handler) = lock.input_handler.take() {
1911 drop(lock);
1912 let result = f(&mut input_handler);
1913 window_state.lock().input_handler = Some(input_handler);
1914 Some(result)
1915 } else {
1916 None
1917 }
1918}
1919
1920fn send_to_input_handler(window: &Object, ime: ImeInput) {
1921 unsafe {
1922 let window_state = get_window_state(window);
1923 let mut lock = window_state.lock();
1924
1925 if let Some(mut input_handler) = lock.input_handler.take() {
1926 match ime {
1927 ImeInput::InsertText(text, range) => {
1928 if let Some(ime_input) = lock.last_ime_inputs.as_mut() {
1929 ime_input.push((text, range));
1930 lock.input_handler = Some(input_handler);
1931 return;
1932 }
1933 drop(lock);
1934 input_handler.replace_text_in_range(range, &text)
1935 }
1936 ImeInput::SetMarkedText(text, range, marked_range) => {
1937 lock.ime_composing = true;
1938 drop(lock);
1939 input_handler.replace_and_mark_text_in_range(range, &text, marked_range)
1940 }
1941 ImeInput::UnmarkText => {
1942 drop(lock);
1943 input_handler.unmark_text()
1944 }
1945 }
1946 window_state.lock().input_handler = Some(input_handler);
1947 } else {
1948 match ime {
1949 ImeInput::InsertText(text, range) => {
1950 if let Some(ime_input) = lock.last_ime_inputs.as_mut() {
1951 ime_input.push((text, range));
1952 }
1953 }
1954 _ => {}
1955 }
1956 }
1957 }
1958}
1959
1960unsafe fn display_id_for_screen(screen: id) -> CGDirectDisplayID {
1961 let device_description = NSScreen::deviceDescription(screen);
1962 let screen_number_key: id = NSString::alloc(nil).init_str("NSScreenNumber");
1963 let screen_number = device_description.objectForKey_(screen_number_key);
1964 let screen_number: NSUInteger = msg_send![screen_number, unsignedIntegerValue];
1965 screen_number as CGDirectDisplayID
1966}