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