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