window.rs

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