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::visibleFrame(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::visibleFrame(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 fn set_title(&mut self, title: &str) {
944 unsafe {
945 let app = NSApplication::sharedApplication(nil);
946 let window = self.0.lock().native_window;
947 let title = ns_string(title);
948 let _: () = msg_send![app, changeWindowsItem:window title:title filename:false];
949 let _: () = msg_send![window, setTitle: title];
950 self.0.lock().move_traffic_light();
951 }
952 }
953
954 fn set_app_id(&mut self, _app_id: &str) {}
955
956 fn set_background_appearance(&self, background_appearance: WindowBackgroundAppearance) {
957 let mut this = self.0.as_ref().lock();
958 this.renderer
959 .update_transparency(background_appearance != WindowBackgroundAppearance::Opaque);
960
961 let blur_radius = if background_appearance == WindowBackgroundAppearance::Blurred {
962 80
963 } else {
964 0
965 };
966 let opaque = if background_appearance == WindowBackgroundAppearance::Opaque {
967 YES
968 } else {
969 NO
970 };
971 unsafe {
972 this.native_window.setOpaque_(opaque);
973 // Shadows for transparent windows cause artifacts and performance issues
974 this.native_window.setHasShadow_(opaque);
975 let clear_color = if opaque == YES {
976 NSColor::colorWithSRGBRed_green_blue_alpha_(nil, 0f64, 0f64, 0f64, 1f64)
977 } else {
978 NSColor::clearColor(nil)
979 };
980 this.native_window.setBackgroundColor_(clear_color);
981 let window_number = this.native_window.windowNumber();
982 CGSSetWindowBackgroundBlurRadius(CGSMainConnectionID(), window_number, blur_radius);
983 }
984 }
985
986 fn set_edited(&mut self, edited: bool) {
987 unsafe {
988 let window = self.0.lock().native_window;
989 msg_send![window, setDocumentEdited: edited as BOOL]
990 }
991
992 // Changing the document edited state resets the traffic light position,
993 // so we have to move it again.
994 self.0.lock().move_traffic_light();
995 }
996
997 fn show_character_palette(&self) {
998 let this = self.0.lock();
999 let window = this.native_window;
1000 this.executor
1001 .spawn(async move {
1002 unsafe {
1003 let app = NSApplication::sharedApplication(nil);
1004 let _: () = msg_send![app, orderFrontCharacterPalette: window];
1005 }
1006 })
1007 .detach();
1008 }
1009
1010 fn minimize(&self) {
1011 let window = self.0.lock().native_window;
1012 unsafe {
1013 window.miniaturize_(nil);
1014 }
1015 }
1016
1017 fn zoom(&self) {
1018 let this = self.0.lock();
1019 let window = this.native_window;
1020 this.executor
1021 .spawn(async move {
1022 unsafe {
1023 window.zoom_(nil);
1024 }
1025 })
1026 .detach();
1027 }
1028
1029 fn toggle_fullscreen(&self) {
1030 let this = self.0.lock();
1031 let window = this.native_window;
1032 this.executor
1033 .spawn(async move {
1034 unsafe {
1035 window.toggleFullScreen_(nil);
1036 }
1037 })
1038 .detach();
1039 }
1040
1041 fn is_fullscreen(&self) -> bool {
1042 let this = self.0.lock();
1043 let window = this.native_window;
1044
1045 unsafe {
1046 window
1047 .styleMask()
1048 .contains(NSWindowStyleMask::NSFullScreenWindowMask)
1049 }
1050 }
1051
1052 fn on_request_frame(&self, callback: Box<dyn FnMut()>) {
1053 self.0.as_ref().lock().request_frame_callback = Some(callback);
1054 }
1055
1056 fn on_input(&self, callback: Box<dyn FnMut(PlatformInput) -> crate::DispatchEventResult>) {
1057 self.0.as_ref().lock().event_callback = Some(callback);
1058 }
1059
1060 fn on_active_status_change(&self, callback: Box<dyn FnMut(bool)>) {
1061 self.0.as_ref().lock().activate_callback = Some(callback);
1062 }
1063
1064 fn on_resize(&self, callback: Box<dyn FnMut(Size<Pixels>, f32)>) {
1065 self.0.as_ref().lock().resize_callback = Some(callback);
1066 }
1067
1068 fn on_moved(&self, callback: Box<dyn FnMut()>) {
1069 self.0.as_ref().lock().moved_callback = Some(callback);
1070 }
1071
1072 fn on_should_close(&self, callback: Box<dyn FnMut() -> bool>) {
1073 self.0.as_ref().lock().should_close_callback = Some(callback);
1074 }
1075
1076 fn on_close(&self, callback: Box<dyn FnOnce()>) {
1077 self.0.as_ref().lock().close_callback = Some(callback);
1078 }
1079
1080 fn on_appearance_changed(&self, callback: Box<dyn FnMut()>) {
1081 self.0.lock().appearance_changed_callback = Some(callback);
1082 }
1083
1084 fn draw(&self, scene: &crate::Scene) {
1085 let mut this = self.0.lock();
1086 this.renderer.draw(scene);
1087 }
1088
1089 fn sprite_atlas(&self) -> Arc<dyn PlatformAtlas> {
1090 self.0.lock().renderer.sprite_atlas().clone()
1091 }
1092}
1093
1094impl rwh::HasWindowHandle for MacWindow {
1095 fn window_handle(&self) -> Result<rwh::WindowHandle<'_>, rwh::HandleError> {
1096 // SAFETY: The AppKitWindowHandle is a wrapper around a pointer to an NSView
1097 unsafe {
1098 Ok(rwh::WindowHandle::borrow_raw(rwh::RawWindowHandle::AppKit(
1099 rwh::AppKitWindowHandle::new(self.0.lock().native_view.cast()),
1100 )))
1101 }
1102 }
1103}
1104
1105impl rwh::HasDisplayHandle for MacWindow {
1106 fn display_handle(&self) -> Result<rwh::DisplayHandle<'_>, rwh::HandleError> {
1107 // SAFETY: This is a no-op on macOS
1108 unsafe {
1109 Ok(rwh::DisplayHandle::borrow_raw(
1110 rwh::AppKitDisplayHandle::new().into(),
1111 ))
1112 }
1113 }
1114}
1115
1116fn get_scale_factor(native_window: id) -> f32 {
1117 let factor = unsafe {
1118 let screen: id = msg_send![native_window, screen];
1119 NSScreen::backingScaleFactor(screen) as f32
1120 };
1121
1122 // We are not certain what triggers this, but it seems that sometimes
1123 // this method would return 0 (https://github.com/zed-industries/zed/issues/6412)
1124 // It seems most likely that this would happen if the window has no screen
1125 // (if it is off-screen), though we'd expect to see viewDidChangeBackingProperties before
1126 // it was rendered for real.
1127 // Regardless, attempt to avoid the issue here.
1128 if factor == 0.0 {
1129 2.
1130 } else {
1131 factor
1132 }
1133}
1134
1135unsafe fn get_window_state(object: &Object) -> Arc<Mutex<MacWindowState>> {
1136 let raw: *mut c_void = *object.get_ivar(WINDOW_STATE_IVAR);
1137 let rc1 = Arc::from_raw(raw as *mut Mutex<MacWindowState>);
1138 let rc2 = rc1.clone();
1139 mem::forget(rc1);
1140 rc2
1141}
1142
1143unsafe fn drop_window_state(object: &Object) {
1144 let raw: *mut c_void = *object.get_ivar(WINDOW_STATE_IVAR);
1145 Arc::from_raw(raw as *mut Mutex<MacWindowState>);
1146}
1147
1148extern "C" fn yes(_: &Object, _: Sel) -> BOOL {
1149 YES
1150}
1151
1152extern "C" fn dealloc_window(this: &Object, _: Sel) {
1153 unsafe {
1154 drop_window_state(this);
1155 let _: () = msg_send![super(this, class!(NSWindow)), dealloc];
1156 }
1157}
1158
1159extern "C" fn dealloc_view(this: &Object, _: Sel) {
1160 unsafe {
1161 drop_window_state(this);
1162 let _: () = msg_send![super(this, class!(NSView)), dealloc];
1163 }
1164}
1165
1166extern "C" fn handle_key_equivalent(this: &Object, _: Sel, native_event: id) -> BOOL {
1167 handle_key_event(this, native_event, true)
1168}
1169
1170extern "C" fn handle_key_down(this: &Object, _: Sel, native_event: id) {
1171 handle_key_event(this, native_event, false);
1172}
1173
1174// Things to test if you're modifying this method:
1175// U.S. layout:
1176// - The IME consumes characters like 'j' and 'k', which makes paging through `less` in
1177// the terminal behave incorrectly by default. This behavior should be patched by our
1178// IME integration
1179// - `alt-t` should open the tasks menu
1180// - In vim mode, this keybinding should work:
1181// ```
1182// {
1183// "context": "Editor && vim_mode == insert",
1184// "bindings": {"j j": "vim::NormalBefore"}
1185// }
1186// ```
1187// and typing 'j k' in insert mode with this keybinding should insert the two characters
1188// Brazilian layout:
1189// - `" space` should create an unmarked quote
1190// - `" backspace` should delete the marked quote
1191// - `" up` should insert a quote, unmark it, and move up one line
1192// - `" cmd-down` should insert a quote, unmark it, and move to the end of the file
1193// - NOTE: The current implementation does not move the selection to the end of the file
1194// - `cmd-ctrl-space` and clicking on an emoji should type it
1195// Czech (QWERTY) layout:
1196// - in vim mode `option-4` should go to end of line (same as $)
1197// Japanese (Romaji) layout:
1198// - type `a i left down up enter enter` should create an unmarked text "愛"
1199extern "C" fn handle_key_event(this: &Object, native_event: id, key_equivalent: bool) -> BOOL {
1200 let window_state = unsafe { get_window_state(this) };
1201 let mut lock = window_state.as_ref().lock();
1202
1203 let window_height = lock.content_size().height;
1204 let event = unsafe { PlatformInput::from_native(native_event, Some(window_height)) };
1205
1206 if let Some(PlatformInput::KeyDown(mut event)) = event {
1207 // For certain keystrokes, macOS will first dispatch a "key equivalent" event.
1208 // If that event isn't handled, it will then dispatch a "key down" event. GPUI
1209 // makes no distinction between these two types of events, so we need to ignore
1210 // the "key down" event if we've already just processed its "key equivalent" version.
1211 if key_equivalent {
1212 lock.last_key_equivalent = Some(event.clone());
1213 } else if lock.last_key_equivalent.take().as_ref() == Some(&event) {
1214 return NO;
1215 }
1216
1217 let keydown = event.keystroke.clone();
1218 let fn_modifier = keydown.modifiers.function;
1219 lock.last_ime_inputs = Some(Default::default());
1220 drop(lock);
1221
1222 // Send the event to the input context for IME handling, unless the `fn` modifier is
1223 // being pressed.
1224 // this will call back into `insert_text`, etc.
1225 if !fn_modifier {
1226 unsafe {
1227 let input_context: id = msg_send![this, inputContext];
1228 let _: BOOL = msg_send![input_context, handleEvent: native_event];
1229 }
1230 }
1231
1232 let mut handled = false;
1233 let mut lock = window_state.lock();
1234 let previous_keydown_inserted_text = lock.previous_keydown_inserted_text.take();
1235 let mut last_inserts = lock.last_ime_inputs.take().unwrap();
1236 let ime_composing = std::mem::take(&mut lock.ime_composing);
1237
1238 let mut callback = lock.event_callback.take();
1239 drop(lock);
1240
1241 let last_insert = last_inserts.pop();
1242 // on a brazilian keyboard typing `"` and then hitting `up` will cause two IME
1243 // events, one to unmark the quote, and one to send the up arrow.
1244 for (text, range) in last_inserts {
1245 send_to_input_handler(this, ImeInput::InsertText(text, range));
1246 }
1247
1248 let is_composing =
1249 with_input_handler(this, |input_handler| input_handler.marked_text_range())
1250 .flatten()
1251 .is_some()
1252 || ime_composing;
1253
1254 if let Some((text, range)) = last_insert {
1255 if !is_composing {
1256 window_state.lock().previous_keydown_inserted_text = Some(text.clone());
1257 if let Some(callback) = callback.as_mut() {
1258 event.keystroke.ime_key = Some(text.clone());
1259 handled = !callback(PlatformInput::KeyDown(event)).propagate;
1260 }
1261 }
1262
1263 if !handled {
1264 handled = true;
1265 send_to_input_handler(this, ImeInput::InsertText(text, range));
1266 }
1267 } else if !is_composing {
1268 let is_held = event.is_held;
1269
1270 if let Some(callback) = callback.as_mut() {
1271 handled = !callback(PlatformInput::KeyDown(event)).propagate;
1272 }
1273
1274 if !handled && is_held {
1275 if let Some(text) = previous_keydown_inserted_text {
1276 // MacOS IME is a bit funky, and even when you've told it there's nothing to
1277 // enter it will still swallow certain keys (e.g. 'f', 'j') and not others
1278 // (e.g. 'n'). This is a problem for certain kinds of views, like the terminal.
1279 with_input_handler(this, |input_handler| {
1280 if input_handler.selected_text_range().is_none() {
1281 handled = true;
1282 input_handler.replace_text_in_range(None, &text)
1283 }
1284 });
1285 window_state.lock().previous_keydown_inserted_text = Some(text);
1286 }
1287 }
1288 }
1289
1290 window_state.lock().event_callback = callback;
1291
1292 handled as BOOL
1293 } else {
1294 NO
1295 }
1296}
1297
1298extern "C" fn handle_view_event(this: &Object, _: Sel, native_event: id) {
1299 let window_state = unsafe { get_window_state(this) };
1300 let weak_window_state = Arc::downgrade(&window_state);
1301 let mut lock = window_state.as_ref().lock();
1302 let window_height = lock.content_size().height;
1303 let event = unsafe { PlatformInput::from_native(native_event, Some(window_height)) };
1304
1305 if let Some(mut event) = event {
1306 match &mut event {
1307 PlatformInput::MouseDown(
1308 event @ MouseDownEvent {
1309 button: MouseButton::Left,
1310 modifiers: Modifiers { control: true, .. },
1311 ..
1312 },
1313 ) => {
1314 // On mac, a ctrl-left click should be handled as a right click.
1315 *event = MouseDownEvent {
1316 button: MouseButton::Right,
1317 modifiers: Modifiers {
1318 control: false,
1319 ..event.modifiers
1320 },
1321 click_count: 1,
1322 ..*event
1323 };
1324 }
1325
1326 // Handles focusing click.
1327 PlatformInput::MouseDown(
1328 event @ MouseDownEvent {
1329 button: MouseButton::Left,
1330 ..
1331 },
1332 ) if (lock.first_mouse) => {
1333 *event = MouseDownEvent {
1334 first_mouse: true,
1335 ..*event
1336 };
1337 lock.first_mouse = false;
1338 }
1339
1340 // Because we map a ctrl-left_down to a right_down -> right_up let's ignore
1341 // the ctrl-left_up to avoid having a mismatch in button down/up events if the
1342 // user is still holding ctrl when releasing the left mouse button
1343 PlatformInput::MouseUp(
1344 event @ MouseUpEvent {
1345 button: MouseButton::Left,
1346 modifiers: Modifiers { control: true, .. },
1347 ..
1348 },
1349 ) => {
1350 *event = MouseUpEvent {
1351 button: MouseButton::Right,
1352 modifiers: Modifiers {
1353 control: false,
1354 ..event.modifiers
1355 },
1356 click_count: 1,
1357 ..*event
1358 };
1359 }
1360
1361 _ => {}
1362 };
1363
1364 match &event {
1365 PlatformInput::MouseMove(
1366 event @ MouseMoveEvent {
1367 pressed_button: Some(_),
1368 ..
1369 },
1370 ) => {
1371 // Synthetic drag is used for selecting long buffer contents while buffer is being scrolled.
1372 // External file drag and drop is able to emit its own synthetic mouse events which will conflict
1373 // with these ones.
1374 if !lock.external_files_dragged {
1375 lock.synthetic_drag_counter += 1;
1376 let executor = lock.executor.clone();
1377 executor
1378 .spawn(synthetic_drag(
1379 weak_window_state,
1380 lock.synthetic_drag_counter,
1381 event.clone(),
1382 ))
1383 .detach();
1384 }
1385 }
1386
1387 PlatformInput::MouseUp(MouseUpEvent { .. }) => {
1388 lock.synthetic_drag_counter += 1;
1389 }
1390
1391 PlatformInput::ModifiersChanged(ModifiersChangedEvent { modifiers }) => {
1392 // Only raise modifiers changed event when they have actually changed
1393 if let Some(PlatformInput::ModifiersChanged(ModifiersChangedEvent {
1394 modifiers: prev_modifiers,
1395 })) = &lock.previous_modifiers_changed_event
1396 {
1397 if prev_modifiers == modifiers {
1398 return;
1399 }
1400 }
1401
1402 lock.previous_modifiers_changed_event = Some(event.clone());
1403 }
1404
1405 _ => {}
1406 }
1407
1408 if let Some(mut callback) = lock.event_callback.take() {
1409 drop(lock);
1410 callback(event);
1411 window_state.lock().event_callback = Some(callback);
1412 }
1413 }
1414}
1415
1416// Allows us to receive `cmd-.` (the shortcut for closing a dialog)
1417// https://bugs.eclipse.org/bugs/show_bug.cgi?id=300620#c6
1418extern "C" fn cancel_operation(this: &Object, _sel: Sel, _sender: id) {
1419 let window_state = unsafe { get_window_state(this) };
1420 let mut lock = window_state.as_ref().lock();
1421
1422 let keystroke = Keystroke {
1423 modifiers: Default::default(),
1424 key: ".".into(),
1425 ime_key: None,
1426 };
1427 let event = PlatformInput::KeyDown(KeyDownEvent {
1428 keystroke: keystroke.clone(),
1429 is_held: false,
1430 });
1431
1432 if let Some(mut callback) = lock.event_callback.take() {
1433 drop(lock);
1434 callback(event);
1435 window_state.lock().event_callback = Some(callback);
1436 }
1437}
1438
1439extern "C" fn window_did_change_occlusion_state(this: &Object, _: Sel, _: id) {
1440 let window_state = unsafe { get_window_state(this) };
1441 let lock = &mut *window_state.lock();
1442 unsafe {
1443 if lock
1444 .native_window
1445 .occlusionState()
1446 .contains(NSWindowOcclusionState::NSWindowOcclusionStateVisible)
1447 {
1448 lock.start_display_link();
1449 } else {
1450 lock.stop_display_link();
1451 }
1452 }
1453}
1454
1455extern "C" fn window_did_resize(this: &Object, _: Sel, _: id) {
1456 let window_state = unsafe { get_window_state(this) };
1457 window_state.as_ref().lock().move_traffic_light();
1458}
1459
1460extern "C" fn window_will_enter_fullscreen(this: &Object, _: Sel, _: id) {
1461 let window_state = unsafe { get_window_state(this) };
1462 let mut lock = window_state.as_ref().lock();
1463 lock.fullscreen_restore_bounds = lock.bounds();
1464}
1465
1466extern "C" fn window_did_move(this: &Object, _: Sel, _: id) {
1467 let window_state = unsafe { get_window_state(this) };
1468 let mut lock = window_state.as_ref().lock();
1469 if let Some(mut callback) = lock.moved_callback.take() {
1470 drop(lock);
1471 callback();
1472 window_state.lock().moved_callback = Some(callback);
1473 }
1474}
1475
1476extern "C" fn window_did_change_screen(this: &Object, _: Sel, _: id) {
1477 let window_state = unsafe { get_window_state(this) };
1478 let mut lock = window_state.as_ref().lock();
1479 lock.start_display_link();
1480}
1481
1482extern "C" fn window_did_change_key_status(this: &Object, selector: Sel, _: id) {
1483 let window_state = unsafe { get_window_state(this) };
1484 let lock = window_state.lock();
1485 let is_active = unsafe { lock.native_window.isKeyWindow() == YES };
1486
1487 // When opening a pop-up while the application isn't active, Cocoa sends a spurious
1488 // `windowDidBecomeKey` message to the previous key window even though that window
1489 // isn't actually key. This causes a bug if the application is later activated while
1490 // the pop-up is still open, making it impossible to activate the previous key window
1491 // even if the pop-up gets closed. The only way to activate it again is to de-activate
1492 // the app and re-activate it, which is a pretty bad UX.
1493 // The following code detects the spurious event and invokes `resignKeyWindow`:
1494 // in theory, we're not supposed to invoke this method manually but it balances out
1495 // the spurious `becomeKeyWindow` event and helps us work around that bug.
1496 if selector == sel!(windowDidBecomeKey:) && !is_active {
1497 unsafe {
1498 let _: () = msg_send![lock.native_window, resignKeyWindow];
1499 return;
1500 }
1501 }
1502
1503 let executor = lock.executor.clone();
1504 drop(lock);
1505 executor
1506 .spawn(async move {
1507 let mut lock = window_state.as_ref().lock();
1508 if let Some(mut callback) = lock.activate_callback.take() {
1509 drop(lock);
1510 callback(is_active);
1511 window_state.lock().activate_callback = Some(callback);
1512 };
1513 })
1514 .detach();
1515}
1516
1517extern "C" fn window_should_close(this: &Object, _: Sel, _: id) -> BOOL {
1518 let window_state = unsafe { get_window_state(this) };
1519 let mut lock = window_state.as_ref().lock();
1520 if let Some(mut callback) = lock.should_close_callback.take() {
1521 drop(lock);
1522 let should_close = callback();
1523 window_state.lock().should_close_callback = Some(callback);
1524 should_close as BOOL
1525 } else {
1526 YES
1527 }
1528}
1529
1530extern "C" fn close_window(this: &Object, _: Sel) {
1531 unsafe {
1532 let close_callback = {
1533 let window_state = get_window_state(this);
1534 let mut lock = window_state.as_ref().lock();
1535 lock.close_callback.take()
1536 };
1537
1538 if let Some(callback) = close_callback {
1539 callback();
1540 }
1541
1542 let _: () = msg_send![super(this, class!(NSWindow)), close];
1543 }
1544}
1545
1546extern "C" fn make_backing_layer(this: &Object, _: Sel) -> id {
1547 let window_state = unsafe { get_window_state(this) };
1548 let window_state = window_state.as_ref().lock();
1549 window_state.renderer.layer_ptr() as id
1550}
1551
1552extern "C" fn view_did_change_backing_properties(this: &Object, _: Sel) {
1553 let window_state = unsafe { get_window_state(this) };
1554 let mut lock = window_state.as_ref().lock();
1555
1556 let scale_factor = lock.scale_factor();
1557 let size = lock.content_size();
1558 let drawable_size = size.to_device_pixels(scale_factor);
1559 unsafe {
1560 let _: () = msg_send![
1561 lock.renderer.layer(),
1562 setContentsScale: scale_factor as f64
1563 ];
1564 }
1565
1566 lock.renderer.update_drawable_size(drawable_size);
1567
1568 if let Some(mut callback) = lock.resize_callback.take() {
1569 let content_size = lock.content_size();
1570 let scale_factor = lock.scale_factor();
1571 drop(lock);
1572 callback(content_size, scale_factor);
1573 window_state.as_ref().lock().resize_callback = Some(callback);
1574 };
1575}
1576
1577extern "C" fn set_frame_size(this: &Object, _: Sel, size: NSSize) {
1578 let window_state = unsafe { get_window_state(this) };
1579 let mut lock = window_state.as_ref().lock();
1580
1581 let new_size = Size::<Pixels>::from(size);
1582 if lock.content_size() == new_size {
1583 return;
1584 }
1585
1586 unsafe {
1587 let _: () = msg_send![super(this, class!(NSView)), setFrameSize: size];
1588 }
1589
1590 let scale_factor = lock.scale_factor();
1591 let drawable_size = new_size.to_device_pixels(scale_factor);
1592 lock.renderer.update_drawable_size(drawable_size);
1593
1594 if let Some(mut callback) = lock.resize_callback.take() {
1595 let content_size = lock.content_size();
1596 let scale_factor = lock.scale_factor();
1597 drop(lock);
1598 callback(content_size, scale_factor);
1599 window_state.lock().resize_callback = Some(callback);
1600 };
1601}
1602
1603extern "C" fn display_layer(this: &Object, _: Sel, _: id) {
1604 let window_state = unsafe { get_window_state(this) };
1605 let mut lock = window_state.lock();
1606 if let Some(mut callback) = lock.request_frame_callback.take() {
1607 #[cfg(not(feature = "macos-blade"))]
1608 lock.renderer.set_presents_with_transaction(true);
1609 lock.stop_display_link();
1610 drop(lock);
1611 callback();
1612
1613 let mut lock = window_state.lock();
1614 lock.request_frame_callback = Some(callback);
1615 #[cfg(not(feature = "macos-blade"))]
1616 lock.renderer.set_presents_with_transaction(false);
1617 lock.start_display_link();
1618 }
1619}
1620
1621unsafe extern "C" fn step(view: *mut c_void) {
1622 let view = view as id;
1623 let window_state = unsafe { get_window_state(&*view) };
1624 let mut lock = window_state.lock();
1625
1626 if let Some(mut callback) = lock.request_frame_callback.take() {
1627 drop(lock);
1628 callback();
1629 window_state.lock().request_frame_callback = Some(callback);
1630 }
1631}
1632
1633extern "C" fn valid_attributes_for_marked_text(_: &Object, _: Sel) -> id {
1634 unsafe { msg_send![class!(NSArray), array] }
1635}
1636
1637extern "C" fn has_marked_text(this: &Object, _: Sel) -> BOOL {
1638 let has_marked_text_result =
1639 with_input_handler(this, |input_handler| input_handler.marked_text_range()).flatten();
1640
1641 has_marked_text_result.is_some() as BOOL
1642}
1643
1644extern "C" fn marked_range(this: &Object, _: Sel) -> NSRange {
1645 let marked_range_result =
1646 with_input_handler(this, |input_handler| input_handler.marked_text_range()).flatten();
1647
1648 marked_range_result.map_or(NSRange::invalid(), |range| range.into())
1649}
1650
1651extern "C" fn selected_range(this: &Object, _: Sel) -> NSRange {
1652 let selected_range_result =
1653 with_input_handler(this, |input_handler| input_handler.selected_text_range()).flatten();
1654
1655 selected_range_result.map_or(NSRange::invalid(), |range| range.into())
1656}
1657
1658extern "C" fn first_rect_for_character_range(
1659 this: &Object,
1660 _: Sel,
1661 range: NSRange,
1662 _: id,
1663) -> NSRect {
1664 let frame: NSRect = unsafe {
1665 let state = get_window_state(this);
1666 let lock = state.lock();
1667 let mut frame = NSWindow::frame(lock.native_window);
1668 let content_layout_rect: CGRect = msg_send![lock.native_window, contentLayoutRect];
1669 frame.origin.y -= frame.size.height - content_layout_rect.size.height;
1670 frame
1671 };
1672 with_input_handler(this, |input_handler| {
1673 input_handler.bounds_for_range(range.to_range()?)
1674 })
1675 .flatten()
1676 .map_or(
1677 NSRect::new(NSPoint::new(0., 0.), NSSize::new(0., 0.)),
1678 |bounds| {
1679 NSRect::new(
1680 NSPoint::new(
1681 frame.origin.x + bounds.origin.x.0 as f64,
1682 frame.origin.y + frame.size.height
1683 - bounds.origin.y.0 as f64
1684 - bounds.size.height.0 as f64,
1685 ),
1686 NSSize::new(bounds.size.width.0 as f64, bounds.size.height.0 as f64),
1687 )
1688 },
1689 )
1690}
1691
1692extern "C" fn insert_text(this: &Object, _: Sel, text: id, replacement_range: NSRange) {
1693 unsafe {
1694 let is_attributed_string: BOOL =
1695 msg_send![text, isKindOfClass: [class!(NSAttributedString)]];
1696 let text: id = if is_attributed_string == YES {
1697 msg_send![text, string]
1698 } else {
1699 text
1700 };
1701
1702 let text = text.to_str();
1703 let replacement_range = replacement_range.to_range();
1704 send_to_input_handler(
1705 this,
1706 ImeInput::InsertText(text.to_string(), replacement_range),
1707 );
1708 }
1709}
1710
1711extern "C" fn set_marked_text(
1712 this: &Object,
1713 _: Sel,
1714 text: id,
1715 selected_range: NSRange,
1716 replacement_range: NSRange,
1717) {
1718 unsafe {
1719 let is_attributed_string: BOOL =
1720 msg_send![text, isKindOfClass: [class!(NSAttributedString)]];
1721 let text: id = if is_attributed_string == YES {
1722 msg_send![text, string]
1723 } else {
1724 text
1725 };
1726 let selected_range = selected_range.to_range();
1727 let replacement_range = replacement_range.to_range();
1728 let text = text.to_str();
1729
1730 send_to_input_handler(
1731 this,
1732 ImeInput::SetMarkedText(text.to_string(), replacement_range, selected_range),
1733 );
1734 }
1735}
1736extern "C" fn unmark_text(this: &Object, _: Sel) {
1737 send_to_input_handler(this, ImeInput::UnmarkText);
1738}
1739
1740extern "C" fn attributed_substring_for_proposed_range(
1741 this: &Object,
1742 _: Sel,
1743 range: NSRange,
1744 _actual_range: *mut c_void,
1745) -> id {
1746 with_input_handler(this, |input_handler| {
1747 let range = range.to_range()?;
1748 if range.is_empty() {
1749 return None;
1750 }
1751
1752 let selected_text = input_handler.text_for_range(range.clone())?;
1753 unsafe {
1754 let string: id = msg_send![class!(NSAttributedString), alloc];
1755 let string: id = msg_send![string, initWithString: ns_string(&selected_text)];
1756 Some(string)
1757 }
1758 })
1759 .flatten()
1760 .unwrap_or(nil)
1761}
1762
1763extern "C" fn do_command_by_selector(_: &Object, _: Sel, _: Sel) {}
1764
1765extern "C" fn view_did_change_effective_appearance(this: &Object, _: Sel) {
1766 unsafe {
1767 let state = get_window_state(this);
1768 let mut lock = state.as_ref().lock();
1769 if let Some(mut callback) = lock.appearance_changed_callback.take() {
1770 drop(lock);
1771 callback();
1772 state.lock().appearance_changed_callback = Some(callback);
1773 }
1774 }
1775}
1776
1777extern "C" fn accepts_first_mouse(this: &Object, _: Sel, _: id) -> BOOL {
1778 let window_state = unsafe { get_window_state(this) };
1779 let mut lock = window_state.as_ref().lock();
1780 lock.first_mouse = true;
1781 YES
1782}
1783
1784extern "C" fn dragging_entered(this: &Object, _: Sel, dragging_info: id) -> NSDragOperation {
1785 let window_state = unsafe { get_window_state(this) };
1786 let position = drag_event_position(&window_state, dragging_info);
1787 let paths = external_paths_from_event(dragging_info);
1788 if let Some(event) =
1789 paths.map(|paths| PlatformInput::FileDrop(FileDropEvent::Entered { position, paths }))
1790 {
1791 if send_new_event(&window_state, event) {
1792 window_state.lock().external_files_dragged = true;
1793 return NSDragOperationCopy;
1794 }
1795 }
1796 NSDragOperationNone
1797}
1798
1799extern "C" fn dragging_updated(this: &Object, _: Sel, dragging_info: id) -> NSDragOperation {
1800 let window_state = unsafe { get_window_state(this) };
1801 let position = drag_event_position(&window_state, dragging_info);
1802 if send_new_event(
1803 &window_state,
1804 PlatformInput::FileDrop(FileDropEvent::Pending { position }),
1805 ) {
1806 NSDragOperationCopy
1807 } else {
1808 NSDragOperationNone
1809 }
1810}
1811
1812extern "C" fn dragging_exited(this: &Object, _: Sel, _: id) {
1813 let window_state = unsafe { get_window_state(this) };
1814 send_new_event(
1815 &window_state,
1816 PlatformInput::FileDrop(FileDropEvent::Exited),
1817 );
1818 window_state.lock().external_files_dragged = false;
1819}
1820
1821extern "C" fn perform_drag_operation(this: &Object, _: Sel, dragging_info: id) -> BOOL {
1822 let window_state = unsafe { get_window_state(this) };
1823 let position = drag_event_position(&window_state, dragging_info);
1824 if send_new_event(
1825 &window_state,
1826 PlatformInput::FileDrop(FileDropEvent::Submit { position }),
1827 ) {
1828 YES
1829 } else {
1830 NO
1831 }
1832}
1833
1834fn external_paths_from_event(dragging_info: *mut Object) -> Option<ExternalPaths> {
1835 let mut paths = SmallVec::new();
1836 let pasteboard: id = unsafe { msg_send![dragging_info, draggingPasteboard] };
1837 let filenames = unsafe { NSPasteboard::propertyListForType(pasteboard, NSFilenamesPboardType) };
1838 if filenames == nil {
1839 return None;
1840 }
1841 for file in unsafe { filenames.iter() } {
1842 let path = unsafe {
1843 let f = NSString::UTF8String(file);
1844 CStr::from_ptr(f).to_string_lossy().into_owned()
1845 };
1846 paths.push(PathBuf::from(path))
1847 }
1848 Some(ExternalPaths(paths))
1849}
1850
1851extern "C" fn conclude_drag_operation(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}
1858
1859async fn synthetic_drag(
1860 window_state: Weak<Mutex<MacWindowState>>,
1861 drag_id: usize,
1862 event: MouseMoveEvent,
1863) {
1864 loop {
1865 Timer::after(Duration::from_millis(16)).await;
1866 if let Some(window_state) = window_state.upgrade() {
1867 let mut lock = window_state.lock();
1868 if lock.synthetic_drag_counter == drag_id {
1869 if let Some(mut callback) = lock.event_callback.take() {
1870 drop(lock);
1871 callback(PlatformInput::MouseMove(event.clone()));
1872 window_state.lock().event_callback = Some(callback);
1873 }
1874 } else {
1875 break;
1876 }
1877 }
1878 }
1879}
1880
1881fn send_new_event(window_state_lock: &Mutex<MacWindowState>, e: PlatformInput) -> bool {
1882 let window_state = window_state_lock.lock().event_callback.take();
1883 if let Some(mut callback) = window_state {
1884 callback(e);
1885 window_state_lock.lock().event_callback = Some(callback);
1886 true
1887 } else {
1888 false
1889 }
1890}
1891
1892fn drag_event_position(window_state: &Mutex<MacWindowState>, dragging_info: id) -> Point<Pixels> {
1893 let drag_location: NSPoint = unsafe { msg_send![dragging_info, draggingLocation] };
1894 convert_mouse_position(drag_location, window_state.lock().content_size().height)
1895}
1896
1897fn with_input_handler<F, R>(window: &Object, f: F) -> Option<R>
1898where
1899 F: FnOnce(&mut PlatformInputHandler) -> R,
1900{
1901 let window_state = unsafe { get_window_state(window) };
1902 let mut lock = window_state.as_ref().lock();
1903 if let Some(mut input_handler) = lock.input_handler.take() {
1904 drop(lock);
1905 let result = f(&mut input_handler);
1906 window_state.lock().input_handler = Some(input_handler);
1907 Some(result)
1908 } else {
1909 None
1910 }
1911}
1912
1913fn send_to_input_handler(window: &Object, ime: ImeInput) {
1914 unsafe {
1915 let window_state = get_window_state(window);
1916 let mut lock = window_state.lock();
1917
1918 if let Some(mut input_handler) = lock.input_handler.take() {
1919 match ime {
1920 ImeInput::InsertText(text, range) => {
1921 if let Some(ime_input) = lock.last_ime_inputs.as_mut() {
1922 ime_input.push((text, range));
1923 lock.input_handler = Some(input_handler);
1924 return;
1925 }
1926 drop(lock);
1927 input_handler.replace_text_in_range(range, &text)
1928 }
1929 ImeInput::SetMarkedText(text, range, marked_range) => {
1930 lock.ime_composing = true;
1931 drop(lock);
1932 input_handler.replace_and_mark_text_in_range(range, &text, marked_range)
1933 }
1934 ImeInput::UnmarkText => {
1935 drop(lock);
1936 input_handler.unmark_text()
1937 }
1938 }
1939 window_state.lock().input_handler = Some(input_handler);
1940 } else {
1941 match ime {
1942 ImeInput::InsertText(text, range) => {
1943 if let Some(ime_input) = lock.last_ime_inputs.as_mut() {
1944 ime_input.push((text, range));
1945 }
1946 }
1947 _ => {}
1948 }
1949 }
1950 }
1951}
1952
1953unsafe fn display_id_for_screen(screen: id) -> CGDirectDisplayID {
1954 let device_description = NSScreen::deviceDescription(screen);
1955 let screen_number_key: id = NSString::alloc(nil).init_str("NSScreenNumber");
1956 let screen_number = device_description.objectForKey_(screen_number_key);
1957 let screen_number: NSUInteger = msg_send![screen_number, unsignedIntegerValue];
1958 screen_number as CGDirectDisplayID
1959}