1use crate::{
2 executor,
3 geometry::{
4 rect::RectF,
5 vector::{vec2f, Vector2F},
6 },
7 keymap::Keystroke,
8 platform::{self, Event, WindowBounds, WindowContext},
9 Scene,
10};
11use block::ConcreteBlock;
12use cocoa::{
13 appkit::{
14 CGPoint, NSApplication, NSBackingStoreBuffered, NSScreen, NSView, NSViewHeightSizable,
15 NSViewWidthSizable, NSWindow, NSWindowButton, NSWindowStyleMask,
16 },
17 base::{id, nil},
18 foundation::{NSAutoreleasePool, NSInteger, NSSize, NSString},
19 quartzcore::AutoresizingMask,
20};
21use core_graphics::display::CGRect;
22use ctor::ctor;
23use foreign_types::ForeignType as _;
24use objc::{
25 class,
26 declare::ClassDecl,
27 msg_send,
28 runtime::{Class, Object, Protocol, Sel, BOOL, NO, YES},
29 sel, sel_impl,
30};
31use postage::oneshot;
32use smol::Timer;
33use std::{
34 any::Any,
35 cell::{Cell, RefCell},
36 convert::TryInto,
37 ffi::c_void,
38 mem, ptr,
39 rc::{Rc, Weak},
40 sync::Arc,
41 time::Duration,
42};
43
44use super::{geometry::RectFExt, renderer::Renderer};
45
46const WINDOW_STATE_IVAR: &'static str = "windowState";
47
48static mut WINDOW_CLASS: *const Class = ptr::null();
49static mut VIEW_CLASS: *const Class = ptr::null();
50
51#[allow(non_upper_case_globals)]
52const NSViewLayerContentsRedrawDuringViewResize: NSInteger = 2;
53
54#[ctor]
55unsafe fn build_classes() {
56 WINDOW_CLASS = {
57 let mut decl = ClassDecl::new("GPUIWindow", class!(NSWindow)).unwrap();
58 decl.add_ivar::<*mut c_void>(WINDOW_STATE_IVAR);
59 decl.add_method(sel!(dealloc), dealloc_window as extern "C" fn(&Object, Sel));
60 decl.add_method(
61 sel!(canBecomeMainWindow),
62 yes as extern "C" fn(&Object, Sel) -> BOOL,
63 );
64 decl.add_method(
65 sel!(canBecomeKeyWindow),
66 yes as extern "C" fn(&Object, Sel) -> BOOL,
67 );
68 decl.add_method(
69 sel!(sendEvent:),
70 send_event as extern "C" fn(&Object, Sel, id),
71 );
72 decl.add_method(
73 sel!(windowDidResize:),
74 window_did_resize as extern "C" fn(&Object, Sel, id),
75 );
76 decl.add_method(sel!(close), close_window as extern "C" fn(&Object, Sel));
77 decl.register()
78 };
79
80 VIEW_CLASS = {
81 let mut decl = ClassDecl::new("GPUIView", class!(NSView)).unwrap();
82 decl.add_ivar::<*mut c_void>(WINDOW_STATE_IVAR);
83
84 decl.add_method(sel!(dealloc), dealloc_view as extern "C" fn(&Object, Sel));
85
86 decl.add_method(
87 sel!(keyDown:),
88 handle_view_event as extern "C" fn(&Object, Sel, id),
89 );
90 decl.add_method(
91 sel!(mouseDown:),
92 handle_view_event as extern "C" fn(&Object, Sel, id),
93 );
94 decl.add_method(
95 sel!(mouseUp:),
96 handle_view_event as extern "C" fn(&Object, Sel, id),
97 );
98 decl.add_method(
99 sel!(mouseMoved:),
100 handle_view_event as extern "C" fn(&Object, Sel, id),
101 );
102 decl.add_method(
103 sel!(mouseDragged:),
104 handle_view_event as extern "C" fn(&Object, Sel, id),
105 );
106 decl.add_method(
107 sel!(scrollWheel:),
108 handle_view_event as extern "C" fn(&Object, Sel, id),
109 );
110 decl.add_method(
111 sel!(cancelOperation:),
112 cancel_operation as extern "C" fn(&Object, Sel, id),
113 );
114
115 decl.add_method(
116 sel!(makeBackingLayer),
117 make_backing_layer as extern "C" fn(&Object, Sel) -> id,
118 );
119
120 decl.add_protocol(Protocol::get("CALayerDelegate").unwrap());
121 decl.add_method(
122 sel!(viewDidChangeBackingProperties),
123 view_did_change_backing_properties as extern "C" fn(&Object, Sel),
124 );
125 decl.add_method(
126 sel!(setFrameSize:),
127 set_frame_size as extern "C" fn(&Object, Sel, NSSize),
128 );
129 decl.add_method(
130 sel!(displayLayer:),
131 display_layer as extern "C" fn(&Object, Sel, id),
132 );
133
134 decl.register()
135 };
136}
137
138pub struct Window(Rc<RefCell<WindowState>>);
139
140struct WindowState {
141 id: usize,
142 native_window: id,
143 event_callback: Option<Box<dyn FnMut(Event)>>,
144 resize_callback: Option<Box<dyn FnMut()>>,
145 close_callback: Option<Box<dyn FnOnce()>>,
146 synthetic_drag_counter: usize,
147 executor: Rc<executor::Foreground>,
148 scene_to_render: Option<Scene>,
149 renderer: Renderer,
150 command_queue: metal::CommandQueue,
151 last_fresh_keydown: Option<(Keystroke, Option<String>)>,
152 layer: id,
153 traffic_light_position: Option<Vector2F>,
154}
155
156impl Window {
157 pub fn open(
158 id: usize,
159 options: platform::WindowOptions,
160 executor: Rc<executor::Foreground>,
161 fonts: Arc<dyn platform::FontSystem>,
162 ) -> Self {
163 const PIXEL_FORMAT: metal::MTLPixelFormat = metal::MTLPixelFormat::BGRA8Unorm;
164
165 unsafe {
166 let pool = NSAutoreleasePool::new(nil);
167
168 let frame = match options.bounds {
169 WindowBounds::Maximized => RectF::new(Default::default(), vec2f(1024., 768.)),
170 WindowBounds::Fixed(rect) => rect,
171 }
172 .to_ns_rect();
173 let mut style_mask = NSWindowStyleMask::NSClosableWindowMask
174 | NSWindowStyleMask::NSMiniaturizableWindowMask
175 | NSWindowStyleMask::NSResizableWindowMask
176 | NSWindowStyleMask::NSTitledWindowMask;
177
178 if options.titlebar_appears_transparent {
179 style_mask |= NSWindowStyleMask::NSFullSizeContentViewWindowMask;
180 }
181
182 let native_window: id = msg_send![WINDOW_CLASS, alloc];
183 let native_window = native_window.initWithContentRect_styleMask_backing_defer_(
184 frame,
185 style_mask,
186 NSBackingStoreBuffered,
187 NO,
188 );
189 assert!(!native_window.is_null());
190
191 if matches!(options.bounds, WindowBounds::Maximized) {
192 let screen = native_window.screen();
193 native_window.setFrame_display_(screen.visibleFrame(), YES);
194 }
195
196 let device =
197 metal::Device::system_default().expect("could not find default metal device");
198
199 let layer: id = msg_send![class!(CAMetalLayer), layer];
200 let _: () = msg_send![layer, setDevice: device.as_ptr()];
201 let _: () = msg_send![layer, setPixelFormat: PIXEL_FORMAT];
202 let _: () = msg_send![layer, setAllowsNextDrawableTimeout: NO];
203 let _: () = msg_send![layer, setNeedsDisplayOnBoundsChange: YES];
204 let _: () = msg_send![layer, setPresentsWithTransaction: YES];
205 let _: () = msg_send![
206 layer,
207 setAutoresizingMask: AutoresizingMask::WIDTH_SIZABLE
208 | AutoresizingMask::HEIGHT_SIZABLE
209 ];
210
211 let native_view: id = msg_send![VIEW_CLASS, alloc];
212 let native_view = NSView::init(native_view);
213 assert!(!native_view.is_null());
214
215 let window = Self(Rc::new(RefCell::new(WindowState {
216 id,
217 native_window,
218 event_callback: None,
219 resize_callback: None,
220 close_callback: None,
221 synthetic_drag_counter: 0,
222 executor,
223 scene_to_render: Default::default(),
224 renderer: Renderer::new(
225 device.clone(),
226 PIXEL_FORMAT,
227 get_scale_factor(native_window),
228 fonts,
229 ),
230 command_queue: device.new_command_queue(),
231 last_fresh_keydown: None,
232 layer,
233 traffic_light_position: options.traffic_light_position,
234 })));
235
236 (*native_window).set_ivar(
237 WINDOW_STATE_IVAR,
238 Rc::into_raw(window.0.clone()) as *const c_void,
239 );
240 native_window.setDelegate_(native_window);
241 (*native_view).set_ivar(
242 WINDOW_STATE_IVAR,
243 Rc::into_raw(window.0.clone()) as *const c_void,
244 );
245
246 if let Some(title) = options.title.as_ref() {
247 native_window.setTitle_(NSString::alloc(nil).init_str(title));
248 }
249 if options.titlebar_appears_transparent {
250 native_window.setTitlebarAppearsTransparent_(YES);
251 }
252 native_window.setAcceptsMouseMovedEvents_(YES);
253
254 native_view.setAutoresizingMask_(NSViewWidthSizable | NSViewHeightSizable);
255 native_view.setWantsBestResolutionOpenGLSurface_(YES);
256
257 // From winit crate: On Mojave, views automatically become layer-backed shortly after
258 // being added to a native_window. Changing the layer-backedness of a view breaks the
259 // association between the view and its associated OpenGL context. To work around this,
260 // on we explicitly make the view layer-backed up front so that AppKit doesn't do it
261 // itself and break the association with its context.
262 native_view.setWantsLayer(YES);
263 let _: () = msg_send![
264 native_view,
265 setLayerContentsRedrawPolicy: NSViewLayerContentsRedrawDuringViewResize
266 ];
267
268 native_window.setContentView_(native_view.autorelease());
269 native_window.makeFirstResponder_(native_view);
270
271 native_window.center();
272 native_window.makeKeyAndOrderFront_(nil);
273
274 window.0.borrow().move_traffic_light();
275 pool.drain();
276
277 window
278 }
279 }
280
281 pub fn key_window_id() -> Option<usize> {
282 unsafe {
283 let app = NSApplication::sharedApplication(nil);
284 let key_window: id = msg_send![app, keyWindow];
285 if msg_send![key_window, isKindOfClass: WINDOW_CLASS] {
286 let id = get_window_state(&*key_window).borrow().id;
287 Some(id)
288 } else {
289 None
290 }
291 }
292 }
293}
294
295impl Drop for Window {
296 fn drop(&mut self) {
297 unsafe {
298 self.0.as_ref().borrow().native_window.close();
299 }
300 }
301}
302
303impl platform::Window for Window {
304 fn as_any_mut(&mut self) -> &mut dyn Any {
305 self
306 }
307
308 fn on_event(&mut self, callback: Box<dyn FnMut(Event)>) {
309 self.0.as_ref().borrow_mut().event_callback = Some(callback);
310 }
311
312 fn on_resize(&mut self, callback: Box<dyn FnMut()>) {
313 self.0.as_ref().borrow_mut().resize_callback = Some(callback);
314 }
315
316 fn on_close(&mut self, callback: Box<dyn FnOnce()>) {
317 self.0.as_ref().borrow_mut().close_callback = Some(callback);
318 }
319
320 fn prompt(
321 &self,
322 level: platform::PromptLevel,
323 msg: &str,
324 answers: &[&str],
325 ) -> oneshot::Receiver<usize> {
326 unsafe {
327 let alert: id = msg_send![class!(NSAlert), alloc];
328 let alert: id = msg_send![alert, init];
329 let alert_style = match level {
330 platform::PromptLevel::Info => 1,
331 platform::PromptLevel::Warning => 0,
332 platform::PromptLevel::Critical => 2,
333 };
334 let _: () = msg_send![alert, setAlertStyle: alert_style];
335 let _: () = msg_send![alert, setMessageText: ns_string(msg)];
336 for (ix, answer) in answers.into_iter().enumerate() {
337 let button: id = msg_send![alert, addButtonWithTitle: ns_string(answer)];
338 let _: () = msg_send![button, setTag: ix as NSInteger];
339 }
340 let (done_tx, done_rx) = oneshot::channel();
341 let done_tx = Cell::new(Some(done_tx));
342 let block = ConcreteBlock::new(move |answer: NSInteger| {
343 if let Some(mut done_tx) = done_tx.take() {
344 let _ = postage::sink::Sink::try_send(&mut done_tx, answer.try_into().unwrap());
345 }
346 });
347 let block = block.copy();
348 let _: () = msg_send![
349 alert,
350 beginSheetModalForWindow: self.0.borrow().native_window
351 completionHandler: block
352 ];
353 done_rx
354 }
355 }
356
357 fn activate(&self) {
358 unsafe {
359 let _: () = msg_send![self.0.borrow().native_window, makeKeyAndOrderFront: nil];
360 }
361 }
362}
363
364impl platform::WindowContext for Window {
365 fn size(&self) -> Vector2F {
366 self.0.as_ref().borrow().size()
367 }
368
369 fn scale_factor(&self) -> f32 {
370 self.0.as_ref().borrow().scale_factor()
371 }
372
373 fn present_scene(&mut self, scene: Scene) {
374 self.0.as_ref().borrow_mut().present_scene(scene);
375 }
376
377 fn titlebar_height(&self) -> f32 {
378 self.0.as_ref().borrow().titlebar_height()
379 }
380}
381
382impl WindowState {
383 fn move_traffic_light(&self) {
384 if let Some(traffic_light_position) = self.traffic_light_position {
385 let titlebar_height = self.titlebar_height();
386
387 unsafe {
388 let close_button: id = msg_send![
389 self.native_window,
390 standardWindowButton: NSWindowButton::NSWindowCloseButton
391 ];
392 let min_button: id = msg_send![
393 self.native_window,
394 standardWindowButton: NSWindowButton::NSWindowMiniaturizeButton
395 ];
396 let zoom_button: id = msg_send![
397 self.native_window,
398 standardWindowButton: NSWindowButton::NSWindowZoomButton
399 ];
400
401 let mut close_button_frame: CGRect = msg_send![close_button, frame];
402 let mut min_button_frame: CGRect = msg_send![min_button, frame];
403 let mut zoom_button_frame: CGRect = msg_send![zoom_button, frame];
404 let mut origin = vec2f(
405 traffic_light_position.x(),
406 titlebar_height
407 - traffic_light_position.y()
408 - close_button_frame.size.height as f32,
409 );
410 let button_spacing =
411 (min_button_frame.origin.x - close_button_frame.origin.x) as f32;
412
413 close_button_frame.origin = CGPoint::new(origin.x() as f64, origin.y() as f64);
414 let _: () = msg_send![close_button, setFrame: close_button_frame];
415 origin.set_x(origin.x() + button_spacing);
416
417 min_button_frame.origin = CGPoint::new(origin.x() as f64, origin.y() as f64);
418 let _: () = msg_send![min_button, setFrame: min_button_frame];
419 origin.set_x(origin.x() + button_spacing);
420
421 zoom_button_frame.origin = CGPoint::new(origin.x() as f64, origin.y() as f64);
422 let _: () = msg_send![zoom_button, setFrame: zoom_button_frame];
423 }
424 }
425 }
426}
427
428impl platform::WindowContext for WindowState {
429 fn size(&self) -> Vector2F {
430 let NSSize { width, height, .. } =
431 unsafe { NSView::frame(self.native_window.contentView()) }.size;
432 vec2f(width as f32, height as f32)
433 }
434
435 fn scale_factor(&self) -> f32 {
436 get_scale_factor(self.native_window)
437 }
438
439 fn titlebar_height(&self) -> f32 {
440 unsafe {
441 let frame = NSWindow::frame(self.native_window);
442 let content_layout_rect: CGRect = msg_send![self.native_window, contentLayoutRect];
443 (frame.size.height - content_layout_rect.size.height) as f32
444 }
445 }
446
447 fn present_scene(&mut self, scene: Scene) {
448 self.scene_to_render = Some(scene);
449 unsafe {
450 let _: () = msg_send![self.native_window.contentView(), setNeedsDisplay: YES];
451 }
452 }
453}
454
455fn get_scale_factor(native_window: id) -> f32 {
456 unsafe {
457 let screen: id = msg_send![native_window, screen];
458 NSScreen::backingScaleFactor(screen) as f32
459 }
460}
461
462unsafe fn get_window_state(object: &Object) -> Rc<RefCell<WindowState>> {
463 let raw: *mut c_void = *object.get_ivar(WINDOW_STATE_IVAR);
464 let rc1 = Rc::from_raw(raw as *mut RefCell<WindowState>);
465 let rc2 = rc1.clone();
466 mem::forget(rc1);
467 rc2
468}
469
470unsafe fn drop_window_state(object: &Object) {
471 let raw: *mut c_void = *object.get_ivar(WINDOW_STATE_IVAR);
472 Rc::from_raw(raw as *mut RefCell<WindowState>);
473}
474
475extern "C" fn yes(_: &Object, _: Sel) -> BOOL {
476 YES
477}
478
479extern "C" fn dealloc_window(this: &Object, _: Sel) {
480 unsafe {
481 drop_window_state(this);
482 let () = msg_send![super(this, class!(NSWindow)), dealloc];
483 }
484}
485
486extern "C" fn dealloc_view(this: &Object, _: Sel) {
487 unsafe {
488 drop_window_state(this);
489 let () = msg_send![super(this, class!(NSView)), dealloc];
490 }
491}
492
493extern "C" fn handle_view_event(this: &Object, _: Sel, native_event: id) {
494 let window_state = unsafe { get_window_state(this) };
495 let weak_window_state = Rc::downgrade(&window_state);
496 let mut window_state_borrow = window_state.as_ref().borrow_mut();
497
498 let event = unsafe { Event::from_native(native_event, Some(window_state_borrow.size().y())) };
499
500 if let Some(event) = event {
501 match &event {
502 Event::LeftMouseDragged { position } => {
503 window_state_borrow.synthetic_drag_counter += 1;
504 window_state_borrow
505 .executor
506 .spawn(synthetic_drag(
507 weak_window_state,
508 window_state_borrow.synthetic_drag_counter,
509 *position,
510 ))
511 .detach();
512 }
513 Event::LeftMouseUp { .. } => {
514 window_state_borrow.synthetic_drag_counter += 1;
515 }
516
517 // Ignore events from held-down keys after some of the initially-pressed keys
518 // were released.
519 Event::KeyDown {
520 input,
521 keystroke,
522 is_held,
523 } => {
524 let keydown = (keystroke.clone(), input.clone());
525 if *is_held {
526 if window_state_borrow.last_fresh_keydown.as_ref() != Some(&keydown) {
527 return;
528 }
529 } else {
530 window_state_borrow.last_fresh_keydown = Some(keydown);
531 }
532 }
533
534 _ => {}
535 }
536
537 if let Some(mut callback) = window_state_borrow.event_callback.take() {
538 drop(window_state_borrow);
539 callback(event);
540 window_state.borrow_mut().event_callback = Some(callback);
541 }
542 }
543}
544
545// Allows us to receive `cmd-.` (the shortcut for closing a dialog)
546// https://bugs.eclipse.org/bugs/show_bug.cgi?id=300620#c6
547extern "C" fn cancel_operation(this: &Object, _sel: Sel, _sender: id) {
548 let window_state = unsafe { get_window_state(this) };
549 let mut window_state_borrow = window_state.as_ref().borrow_mut();
550
551 let chars = ".".to_string();
552 let keystroke = Keystroke {
553 cmd: true,
554 ctrl: false,
555 alt: false,
556 shift: false,
557 key: chars.clone(),
558 };
559 let event = Event::KeyDown {
560 keystroke: keystroke.clone(),
561 input: Some(chars.clone()),
562 is_held: false,
563 };
564
565 window_state_borrow.last_fresh_keydown = Some((keystroke, Some(chars)));
566 if let Some(mut callback) = window_state_borrow.event_callback.take() {
567 drop(window_state_borrow);
568 callback(event);
569 window_state.borrow_mut().event_callback = Some(callback);
570 }
571}
572
573extern "C" fn send_event(this: &Object, _: Sel, native_event: id) {
574 unsafe {
575 let () = msg_send![super(this, class!(NSWindow)), sendEvent: native_event];
576 }
577}
578
579extern "C" fn window_did_resize(this: &Object, _: Sel, _: id) {
580 let window_state = unsafe { get_window_state(this) };
581 window_state.as_ref().borrow().move_traffic_light();
582}
583
584extern "C" fn close_window(this: &Object, _: Sel) {
585 unsafe {
586 let close_callback = {
587 let window_state = get_window_state(this);
588 window_state
589 .as_ref()
590 .try_borrow_mut()
591 .ok()
592 .and_then(|mut window_state| window_state.close_callback.take())
593 };
594
595 if let Some(callback) = close_callback {
596 callback();
597 }
598
599 let () = msg_send![super(this, class!(NSWindow)), close];
600 }
601}
602
603extern "C" fn make_backing_layer(this: &Object, _: Sel) -> id {
604 let window_state = unsafe { get_window_state(this) };
605 let window_state = window_state.as_ref().borrow();
606 window_state.layer
607}
608
609extern "C" fn view_did_change_backing_properties(this: &Object, _: Sel) {
610 let window_state = unsafe { get_window_state(this) };
611 let mut window_state_borrow = window_state.as_ref().borrow_mut();
612
613 unsafe {
614 let _: () = msg_send![window_state_borrow.layer, setContentsScale: window_state_borrow.scale_factor() as f64];
615 }
616
617 if let Some(mut callback) = window_state_borrow.resize_callback.take() {
618 drop(window_state_borrow);
619 callback();
620 window_state.as_ref().borrow_mut().resize_callback = Some(callback);
621 };
622}
623
624extern "C" fn set_frame_size(this: &Object, _: Sel, size: NSSize) {
625 let window_state = unsafe { get_window_state(this) };
626 let mut window_state_borrow = window_state.as_ref().borrow_mut();
627
628 if window_state_borrow.size() == vec2f(size.width as f32, size.height as f32) {
629 return;
630 }
631
632 unsafe {
633 let _: () = msg_send![super(this, class!(NSView)), setFrameSize: size];
634 }
635
636 let scale_factor = window_state_borrow.scale_factor() as f64;
637 let drawable_size: NSSize = NSSize {
638 width: size.width * scale_factor,
639 height: size.height * scale_factor,
640 };
641
642 unsafe {
643 let _: () = msg_send![window_state_borrow.layer, setDrawableSize: drawable_size];
644 }
645
646 if let Some(mut callback) = window_state_borrow.resize_callback.take() {
647 drop(window_state_borrow);
648 callback();
649 window_state.borrow_mut().resize_callback = Some(callback);
650 };
651}
652
653extern "C" fn display_layer(this: &Object, _: Sel, _: id) {
654 unsafe {
655 let window_state = get_window_state(this);
656 let mut window_state = window_state.as_ref().borrow_mut();
657
658 if let Some(scene) = window_state.scene_to_render.take() {
659 let drawable: &metal::MetalDrawableRef = msg_send![window_state.layer, nextDrawable];
660 let command_queue = window_state.command_queue.clone();
661 let command_buffer = command_queue.new_command_buffer();
662
663 let size = window_state.size();
664 let scale_factor = window_state.scale_factor();
665
666 window_state.renderer.render(
667 &scene,
668 size * scale_factor,
669 command_buffer,
670 drawable.texture(),
671 );
672
673 command_buffer.commit();
674 command_buffer.wait_until_completed();
675 drawable.present();
676 };
677 }
678}
679
680async fn synthetic_drag(
681 window_state: Weak<RefCell<WindowState>>,
682 drag_id: usize,
683 position: Vector2F,
684) {
685 loop {
686 Timer::after(Duration::from_millis(16)).await;
687 if let Some(window_state) = window_state.upgrade() {
688 let mut window_state_borrow = window_state.borrow_mut();
689 if window_state_borrow.synthetic_drag_counter == drag_id {
690 if let Some(mut callback) = window_state_borrow.event_callback.take() {
691 drop(window_state_borrow);
692 callback(Event::LeftMouseDragged { position });
693 window_state.borrow_mut().event_callback = Some(callback);
694 }
695 } else {
696 break;
697 }
698 }
699 }
700}
701
702unsafe fn ns_string(string: &str) -> id {
703 NSString::alloc(nil).init_str(string).autorelease()
704}