window.rs

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