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 style_mask = NSWindowStyleMask::NSClosableWindowMask
157 | NSWindowStyleMask::NSMiniaturizableWindowMask
158 | NSWindowStyleMask::NSResizableWindowMask
159 | NSWindowStyleMask::NSTitledWindowMask;
160
161 let native_window: id = msg_send![WINDOW_CLASS, alloc];
162 let native_window = native_window.initWithContentRect_styleMask_backing_defer_(
163 frame,
164 style_mask,
165 NSBackingStoreBuffered,
166 NO,
167 );
168 assert!(!native_window.is_null());
169
170 let device =
171 metal::Device::system_default().expect("could not find default metal device");
172
173 let layer: id = msg_send![class!(CAMetalLayer), layer];
174 let _: () = msg_send![layer, setDevice: device.as_ptr()];
175 let _: () = msg_send![layer, setPixelFormat: PIXEL_FORMAT];
176 let _: () = msg_send![layer, setAllowsNextDrawableTimeout: NO];
177 let _: () = msg_send![layer, setNeedsDisplayOnBoundsChange: YES];
178 let _: () = msg_send![layer, setPresentsWithTransaction: YES];
179 let _: () = msg_send![
180 layer,
181 setAutoresizingMask: AutoresizingMask::WIDTH_SIZABLE
182 | AutoresizingMask::HEIGHT_SIZABLE
183 ];
184
185 let native_view: id = msg_send![VIEW_CLASS, alloc];
186 let native_view = NSView::init(native_view);
187 assert!(!native_view.is_null());
188
189 let window = Self(Rc::new(RefCell::new(WindowState {
190 id,
191 native_window,
192 event_callback: None,
193 resize_callback: None,
194 close_callback: None,
195 synthetic_drag_counter: 0,
196 executor,
197 scene_to_render: Default::default(),
198 renderer: Renderer::new(device.clone(), PIXEL_FORMAT, fonts),
199 command_queue: device.new_command_queue(),
200 last_fresh_keydown: None,
201 layer,
202 })));
203
204 (*native_window).set_ivar(
205 WINDOW_STATE_IVAR,
206 Rc::into_raw(window.0.clone()) as *const c_void,
207 );
208 (*native_view).set_ivar(
209 WINDOW_STATE_IVAR,
210 Rc::into_raw(window.0.clone()) as *const c_void,
211 );
212
213 if let Some(title) = options.title.as_ref() {
214 native_window.setTitle_(NSString::alloc(nil).init_str(title));
215 }
216 native_window.setAcceptsMouseMovedEvents_(YES);
217
218 native_view.setAutoresizingMask_(NSViewWidthSizable | NSViewHeightSizable);
219 native_view.setWantsBestResolutionOpenGLSurface_(YES);
220
221 // From winit crate: On Mojave, views automatically become layer-backed shortly after
222 // being added to a native_window. Changing the layer-backedness of a view breaks the
223 // association between the view and its associated OpenGL context. To work around this,
224 // on we explicitly make the view layer-backed up front so that AppKit doesn't do it
225 // itself and break the association with its context.
226 native_view.setWantsLayer(YES);
227 let _: () = msg_send![
228 native_view,
229 setLayerContentsRedrawPolicy: NSViewLayerContentsRedrawDuringViewResize
230 ];
231
232 native_window.setContentView_(native_view.autorelease());
233 native_window.makeFirstResponder_(native_view);
234
235 native_window.center();
236 native_window.makeKeyAndOrderFront_(nil);
237
238 pool.drain();
239
240 window
241 }
242 }
243
244 pub fn key_window_id() -> Option<usize> {
245 unsafe {
246 let app = NSApplication::sharedApplication(nil);
247 let key_window: id = msg_send![app, keyWindow];
248 if key_window.is_null() {
249 None
250 } else {
251 let id = get_window_state(&*key_window).borrow().id;
252 Some(id)
253 }
254 }
255 }
256}
257
258impl Drop for Window {
259 fn drop(&mut self) {
260 unsafe {
261 self.0.as_ref().borrow().native_window.close();
262 }
263 }
264}
265
266impl platform::Window for Window {
267 fn as_any_mut(&mut self) -> &mut dyn Any {
268 self
269 }
270
271 fn on_event(&mut self, callback: Box<dyn FnMut(Event)>) {
272 self.0.as_ref().borrow_mut().event_callback = Some(callback);
273 }
274
275 fn on_resize(&mut self, callback: Box<dyn FnMut(&mut dyn platform::WindowContext)>) {
276 self.0.as_ref().borrow_mut().resize_callback = Some(callback);
277 }
278
279 fn on_close(&mut self, callback: Box<dyn FnOnce()>) {
280 self.0.as_ref().borrow_mut().close_callback = Some(callback);
281 }
282
283 fn prompt(
284 &self,
285 level: platform::PromptLevel,
286 msg: &str,
287 answers: &[&str],
288 done_fn: Box<dyn FnOnce(usize)>,
289 ) {
290 unsafe {
291 let alert: id = msg_send![class!(NSAlert), alloc];
292 let alert: id = msg_send![alert, init];
293 let alert_style = match level {
294 platform::PromptLevel::Info => 1,
295 platform::PromptLevel::Warning => 0,
296 platform::PromptLevel::Critical => 2,
297 };
298 let _: () = msg_send![alert, setAlertStyle: alert_style];
299 let _: () = msg_send![alert, setMessageText: ns_string(msg)];
300 for (ix, answer) in answers.into_iter().enumerate() {
301 let button: id = msg_send![alert, addButtonWithTitle: ns_string(answer)];
302 let _: () = msg_send![button, setTag: ix as NSInteger];
303 }
304 let done_fn = Cell::new(Some(done_fn));
305 let block = ConcreteBlock::new(move |answer: NSInteger| {
306 if let Some(done_fn) = done_fn.take() {
307 (done_fn)(answer.try_into().unwrap());
308 }
309 });
310 let block = block.copy();
311 let _: () = msg_send![
312 alert,
313 beginSheetModalForWindow: self.0.borrow().native_window
314 completionHandler: block
315 ];
316 }
317 }
318}
319
320impl platform::WindowContext for Window {
321 fn size(&self) -> Vector2F {
322 self.0.as_ref().borrow().size()
323 }
324
325 fn scale_factor(&self) -> f32 {
326 self.0.as_ref().borrow().scale_factor()
327 }
328
329 fn present_scene(&mut self, scene: Scene) {
330 self.0.as_ref().borrow_mut().present_scene(scene);
331 }
332}
333
334impl platform::WindowContext for WindowState {
335 fn size(&self) -> Vector2F {
336 let NSSize { width, height, .. } =
337 unsafe { NSView::frame(self.native_window.contentView()) }.size;
338 vec2f(width as f32, height as f32)
339 }
340
341 fn scale_factor(&self) -> f32 {
342 unsafe {
343 let screen: id = msg_send![self.native_window, screen];
344 NSScreen::backingScaleFactor(screen) as f32
345 }
346 }
347
348 fn present_scene(&mut self, scene: Scene) {
349 self.scene_to_render = Some(scene);
350 unsafe {
351 let _: () = msg_send![self.native_window.contentView(), setNeedsDisplay: YES];
352 }
353 }
354}
355
356unsafe fn get_window_state(object: &Object) -> Rc<RefCell<WindowState>> {
357 let raw: *mut c_void = *object.get_ivar(WINDOW_STATE_IVAR);
358 let rc1 = Rc::from_raw(raw as *mut RefCell<WindowState>);
359 let rc2 = rc1.clone();
360 mem::forget(rc1);
361 rc2
362}
363
364unsafe fn drop_window_state(object: &Object) {
365 let raw: *mut c_void = *object.get_ivar(WINDOW_STATE_IVAR);
366 Rc::from_raw(raw as *mut RefCell<WindowState>);
367}
368
369extern "C" fn yes(_: &Object, _: Sel) -> BOOL {
370 YES
371}
372
373extern "C" fn dealloc_window(this: &Object, _: Sel) {
374 unsafe {
375 drop_window_state(this);
376 let () = msg_send![super(this, class!(NSWindow)), dealloc];
377 }
378}
379
380extern "C" fn dealloc_view(this: &Object, _: Sel) {
381 unsafe {
382 drop_window_state(this);
383 let () = msg_send![super(this, class!(NSView)), dealloc];
384 }
385}
386
387extern "C" fn handle_view_event(this: &Object, _: Sel, native_event: id) {
388 let window_state = unsafe { get_window_state(this) };
389 let weak_window_state = Rc::downgrade(&window_state);
390 let mut window_state_borrow = window_state.as_ref().borrow_mut();
391
392 let event = unsafe { Event::from_native(native_event, Some(window_state_borrow.size().y())) };
393
394 if let Some(event) = event {
395 match &event {
396 Event::LeftMouseDragged { position } => {
397 window_state_borrow.synthetic_drag_counter += 1;
398 window_state_borrow
399 .executor
400 .spawn(synthetic_drag(
401 weak_window_state,
402 window_state_borrow.synthetic_drag_counter,
403 *position,
404 ))
405 .detach();
406 }
407 Event::LeftMouseUp { .. } => {
408 window_state_borrow.synthetic_drag_counter += 1;
409 }
410
411 // Ignore events from held-down keys after some of the initially-pressed keys
412 // were released.
413 Event::KeyDown {
414 chars,
415 keystroke,
416 is_held,
417 } => {
418 let keydown = (keystroke.clone(), chars.clone());
419 if *is_held {
420 if window_state_borrow.last_fresh_keydown.as_ref() != Some(&keydown) {
421 return;
422 }
423 } else {
424 window_state_borrow.last_fresh_keydown = Some(keydown);
425 }
426 }
427
428 _ => {}
429 }
430
431 if let Some(mut callback) = window_state_borrow.event_callback.take() {
432 drop(window_state_borrow);
433 callback(event);
434 window_state.borrow_mut().event_callback = Some(callback);
435 }
436 }
437}
438
439extern "C" fn send_event(this: &Object, _: Sel, native_event: id) {
440 unsafe {
441 let () = msg_send![super(this, class!(NSWindow)), sendEvent: native_event];
442 }
443}
444
445extern "C" fn close_window(this: &Object, _: Sel) {
446 unsafe {
447 let close_callback = {
448 let window_state = get_window_state(this);
449 window_state
450 .as_ref()
451 .try_borrow_mut()
452 .ok()
453 .and_then(|mut window_state| window_state.close_callback.take())
454 };
455
456 if let Some(callback) = close_callback {
457 callback();
458 }
459
460 let () = msg_send![super(this, class!(NSWindow)), close];
461 }
462}
463
464extern "C" fn make_backing_layer(this: &Object, _: Sel) -> id {
465 let window_state = unsafe { get_window_state(this) };
466 let window_state = window_state.as_ref().borrow();
467 window_state.layer
468}
469
470extern "C" fn view_did_change_backing_properties(this: &Object, _: Sel) {
471 let window_state = unsafe { get_window_state(this) };
472 let mut window_state = window_state.as_ref().borrow_mut();
473
474 unsafe {
475 let _: () =
476 msg_send![window_state.layer, setContentsScale: window_state.scale_factor() as f64];
477 }
478
479 if let Some(mut callback) = window_state.resize_callback.take() {
480 callback(&mut *window_state);
481 window_state.resize_callback = Some(callback);
482 };
483}
484
485extern "C" fn set_frame_size(this: &Object, _: Sel, size: NSSize) {
486 let window_state = unsafe { get_window_state(this) };
487 let mut window_state = window_state.as_ref().borrow_mut();
488
489 if window_state.size() == vec2f(size.width as f32, size.height as f32) {
490 return;
491 }
492
493 unsafe {
494 let _: () = msg_send![super(this, class!(NSView)), setFrameSize: size];
495 }
496
497 let scale_factor = window_state.scale_factor() as f64;
498 let drawable_size: NSSize = NSSize {
499 width: size.width * scale_factor,
500 height: size.height * scale_factor,
501 };
502
503 unsafe {
504 let _: () = msg_send![window_state.layer, setDrawableSize: drawable_size];
505 }
506
507 if let Some(mut callback) = window_state.resize_callback.take() {
508 callback(&mut *window_state);
509 window_state.resize_callback = Some(callback);
510 };
511}
512
513extern "C" fn display_layer(this: &Object, _: Sel, _: id) {
514 unsafe {
515 let window_state = get_window_state(this);
516 let mut window_state = window_state.as_ref().borrow_mut();
517
518 if let Some(scene) = window_state.scene_to_render.take() {
519 let drawable: &metal::MetalDrawableRef = msg_send![window_state.layer, nextDrawable];
520 let command_queue = window_state.command_queue.clone();
521 let command_buffer = command_queue.new_command_buffer();
522
523 let size = window_state.size();
524 let scale_factor = window_state.scale_factor();
525
526 window_state.renderer.render(
527 &scene,
528 size * scale_factor,
529 command_buffer,
530 drawable.texture(),
531 );
532
533 command_buffer.commit();
534 command_buffer.wait_until_completed();
535 drawable.present();
536 };
537 }
538}
539
540async fn synthetic_drag(
541 window_state: Weak<RefCell<WindowState>>,
542 drag_id: usize,
543 position: Vector2F,
544) {
545 loop {
546 Timer::after(Duration::from_millis(16)).await;
547 if let Some(window_state) = window_state.upgrade() {
548 let mut window_state_borrow = window_state.borrow_mut();
549 if window_state_borrow.synthetic_drag_counter == drag_id {
550 if let Some(mut callback) = window_state_borrow.event_callback.take() {
551 drop(window_state_borrow);
552 callback(Event::LeftMouseDragged { position });
553 window_state.borrow_mut().event_callback = Some(callback);
554 }
555 } else {
556 break;
557 }
558 }
559 }
560}
561
562unsafe fn ns_string(string: &str) -> id {
563 NSString::alloc(nil).init_str(string).autorelease()
564}