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