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