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