window.rs

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