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