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(device.clone(), PIXEL_FORMAT, fonts),
209                command_queue: device.new_command_queue(),
210                last_fresh_keydown: None,
211                layer,
212                traffic_light_position: options.traffic_light_position,
213            })));
214
215            (*native_window).set_ivar(
216                WINDOW_STATE_IVAR,
217                Rc::into_raw(window.0.clone()) as *const c_void,
218            );
219            native_window.setDelegate_(native_window);
220            (*native_view).set_ivar(
221                WINDOW_STATE_IVAR,
222                Rc::into_raw(window.0.clone()) as *const c_void,
223            );
224
225            if let Some(title) = options.title.as_ref() {
226                native_window.setTitle_(NSString::alloc(nil).init_str(title));
227            }
228            if options.titlebar_appears_transparent {
229                native_window.setTitlebarAppearsTransparent_(YES);
230            }
231            native_window.setAcceptsMouseMovedEvents_(YES);
232
233            native_view.setAutoresizingMask_(NSViewWidthSizable | NSViewHeightSizable);
234            native_view.setWantsBestResolutionOpenGLSurface_(YES);
235
236            // From winit crate: On Mojave, views automatically become layer-backed shortly after
237            // being added to a native_window. Changing the layer-backedness of a view breaks the
238            // association between the view and its associated OpenGL context. To work around this,
239            // on we explicitly make the view layer-backed up front so that AppKit doesn't do it
240            // itself and break the association with its context.
241            native_view.setWantsLayer(YES);
242            let _: () = msg_send![
243                native_view,
244                setLayerContentsRedrawPolicy: NSViewLayerContentsRedrawDuringViewResize
245            ];
246
247            native_window.setContentView_(native_view.autorelease());
248            native_window.makeFirstResponder_(native_view);
249
250            native_window.center();
251            native_window.makeKeyAndOrderFront_(nil);
252
253            window.0.borrow().move_traffic_light();
254            pool.drain();
255
256            window
257        }
258    }
259
260    pub fn key_window_id() -> Option<usize> {
261        unsafe {
262            let app = NSApplication::sharedApplication(nil);
263            let key_window: id = msg_send![app, keyWindow];
264            if msg_send![key_window, isKindOfClass: WINDOW_CLASS] {
265                let id = get_window_state(&*key_window).borrow().id;
266                Some(id)
267            } else {
268                None
269            }
270        }
271    }
272}
273
274impl Drop for Window {
275    fn drop(&mut self) {
276        unsafe {
277            self.0.as_ref().borrow().native_window.close();
278        }
279    }
280}
281
282impl platform::Window for Window {
283    fn as_any_mut(&mut self) -> &mut dyn Any {
284        self
285    }
286
287    fn on_event(&mut self, callback: Box<dyn FnMut(Event)>) {
288        self.0.as_ref().borrow_mut().event_callback = Some(callback);
289    }
290
291    fn on_resize(&mut self, callback: Box<dyn FnMut()>) {
292        self.0.as_ref().borrow_mut().resize_callback = Some(callback);
293    }
294
295    fn on_close(&mut self, callback: Box<dyn FnOnce()>) {
296        self.0.as_ref().borrow_mut().close_callback = Some(callback);
297    }
298
299    fn prompt(
300        &self,
301        level: platform::PromptLevel,
302        msg: &str,
303        answers: &[&str],
304        done_fn: Box<dyn FnOnce(usize)>,
305    ) {
306        unsafe {
307            let alert: id = msg_send![class!(NSAlert), alloc];
308            let alert: id = msg_send![alert, init];
309            let alert_style = match level {
310                platform::PromptLevel::Info => 1,
311                platform::PromptLevel::Warning => 0,
312                platform::PromptLevel::Critical => 2,
313            };
314            let _: () = msg_send![alert, setAlertStyle: alert_style];
315            let _: () = msg_send![alert, setMessageText: ns_string(msg)];
316            for (ix, answer) in answers.into_iter().enumerate() {
317                let button: id = msg_send![alert, addButtonWithTitle: ns_string(answer)];
318                let _: () = msg_send![button, setTag: ix as NSInteger];
319            }
320            let done_fn = Cell::new(Some(done_fn));
321            let block = ConcreteBlock::new(move |answer: NSInteger| {
322                if let Some(done_fn) = done_fn.take() {
323                    (done_fn)(answer.try_into().unwrap());
324                }
325            });
326            let block = block.copy();
327            let _: () = msg_send![
328                alert,
329                beginSheetModalForWindow: self.0.borrow().native_window
330                completionHandler: block
331            ];
332        }
333    }
334}
335
336impl platform::WindowContext for Window {
337    fn size(&self) -> Vector2F {
338        self.0.as_ref().borrow().size()
339    }
340
341    fn scale_factor(&self) -> f32 {
342        self.0.as_ref().borrow().scale_factor()
343    }
344
345    fn present_scene(&mut self, scene: Scene) {
346        self.0.as_ref().borrow_mut().present_scene(scene);
347    }
348
349    fn titlebar_height(&self) -> f32 {
350        self.0.as_ref().borrow().titlebar_height()
351    }
352}
353
354impl WindowState {
355    fn move_traffic_light(&self) {
356        if let Some(traffic_light_position) = self.traffic_light_position {
357            let titlebar_height = self.titlebar_height();
358
359            unsafe {
360                let close_button: id = msg_send![
361                    self.native_window,
362                    standardWindowButton: NSWindowButton::NSWindowCloseButton
363                ];
364                let min_button: id = msg_send![
365                    self.native_window,
366                    standardWindowButton: NSWindowButton::NSWindowMiniaturizeButton
367                ];
368                let zoom_button: id = msg_send![
369                    self.native_window,
370                    standardWindowButton: NSWindowButton::NSWindowZoomButton
371                ];
372
373                let mut close_button_frame: CGRect = msg_send![close_button, frame];
374                let mut min_button_frame: CGRect = msg_send![min_button, frame];
375                let mut zoom_button_frame: CGRect = msg_send![zoom_button, frame];
376                let mut origin = vec2f(
377                    traffic_light_position.x(),
378                    titlebar_height
379                        - traffic_light_position.y()
380                        - close_button_frame.size.height as f32,
381                );
382                let button_spacing =
383                    (min_button_frame.origin.x - close_button_frame.origin.x) as f32;
384
385                close_button_frame.origin = CGPoint::new(origin.x() as f64, origin.y() as f64);
386                let _: () = msg_send![close_button, setFrame: close_button_frame];
387                origin.set_x(origin.x() + button_spacing);
388
389                min_button_frame.origin = CGPoint::new(origin.x() as f64, origin.y() as f64);
390                let _: () = msg_send![min_button, setFrame: min_button_frame];
391                origin.set_x(origin.x() + button_spacing);
392
393                zoom_button_frame.origin = CGPoint::new(origin.x() as f64, origin.y() as f64);
394                let _: () = msg_send![zoom_button, setFrame: zoom_button_frame];
395            }
396        }
397    }
398}
399
400impl platform::WindowContext for WindowState {
401    fn size(&self) -> Vector2F {
402        let NSSize { width, height, .. } =
403            unsafe { NSView::frame(self.native_window.contentView()) }.size;
404        vec2f(width as f32, height as f32)
405    }
406
407    fn scale_factor(&self) -> f32 {
408        unsafe {
409            let screen: id = msg_send![self.native_window, screen];
410            NSScreen::backingScaleFactor(screen) as f32
411        }
412    }
413
414    fn titlebar_height(&self) -> f32 {
415        unsafe {
416            let frame = NSWindow::frame(self.native_window);
417            let content_layout_rect: CGRect = msg_send![self.native_window, contentLayoutRect];
418            (frame.size.height - content_layout_rect.size.height) as f32
419        }
420    }
421
422    fn present_scene(&mut self, scene: Scene) {
423        self.scene_to_render = Some(scene);
424        unsafe {
425            let _: () = msg_send![self.native_window.contentView(), setNeedsDisplay: YES];
426        }
427    }
428}
429
430unsafe fn get_window_state(object: &Object) -> Rc<RefCell<WindowState>> {
431    let raw: *mut c_void = *object.get_ivar(WINDOW_STATE_IVAR);
432    let rc1 = Rc::from_raw(raw as *mut RefCell<WindowState>);
433    let rc2 = rc1.clone();
434    mem::forget(rc1);
435    rc2
436}
437
438unsafe fn drop_window_state(object: &Object) {
439    let raw: *mut c_void = *object.get_ivar(WINDOW_STATE_IVAR);
440    Rc::from_raw(raw as *mut RefCell<WindowState>);
441}
442
443extern "C" fn yes(_: &Object, _: Sel) -> BOOL {
444    YES
445}
446
447extern "C" fn dealloc_window(this: &Object, _: Sel) {
448    unsafe {
449        drop_window_state(this);
450        let () = msg_send![super(this, class!(NSWindow)), dealloc];
451    }
452}
453
454extern "C" fn dealloc_view(this: &Object, _: Sel) {
455    unsafe {
456        drop_window_state(this);
457        let () = msg_send![super(this, class!(NSView)), dealloc];
458    }
459}
460
461extern "C" fn handle_view_event(this: &Object, _: Sel, native_event: id) {
462    let window_state = unsafe { get_window_state(this) };
463    let weak_window_state = Rc::downgrade(&window_state);
464    let mut window_state_borrow = window_state.as_ref().borrow_mut();
465
466    let event = unsafe { Event::from_native(native_event, Some(window_state_borrow.size().y())) };
467
468    if let Some(event) = event {
469        match &event {
470            Event::LeftMouseDragged { position } => {
471                window_state_borrow.synthetic_drag_counter += 1;
472                window_state_borrow
473                    .executor
474                    .spawn(synthetic_drag(
475                        weak_window_state,
476                        window_state_borrow.synthetic_drag_counter,
477                        *position,
478                    ))
479                    .detach();
480            }
481            Event::LeftMouseUp { .. } => {
482                window_state_borrow.synthetic_drag_counter += 1;
483            }
484
485            // Ignore events from held-down keys after some of the initially-pressed keys
486            // were released.
487            Event::KeyDown {
488                chars,
489                keystroke,
490                is_held,
491            } => {
492                let keydown = (keystroke.clone(), chars.clone());
493                if *is_held {
494                    if window_state_borrow.last_fresh_keydown.as_ref() != Some(&keydown) {
495                        return;
496                    }
497                } else {
498                    window_state_borrow.last_fresh_keydown = Some(keydown);
499                }
500            }
501
502            _ => {}
503        }
504
505        if let Some(mut callback) = window_state_borrow.event_callback.take() {
506            drop(window_state_borrow);
507            callback(event);
508            window_state.borrow_mut().event_callback = Some(callback);
509        }
510    }
511}
512
513extern "C" fn send_event(this: &Object, _: Sel, native_event: id) {
514    unsafe {
515        let () = msg_send![super(this, class!(NSWindow)), sendEvent: native_event];
516    }
517}
518
519extern "C" fn window_did_resize(this: &Object, _: Sel, _: id) {
520    let window_state = unsafe { get_window_state(this) };
521    window_state.as_ref().borrow().move_traffic_light();
522}
523
524extern "C" fn close_window(this: &Object, _: Sel) {
525    unsafe {
526        let close_callback = {
527            let window_state = get_window_state(this);
528            window_state
529                .as_ref()
530                .try_borrow_mut()
531                .ok()
532                .and_then(|mut window_state| window_state.close_callback.take())
533        };
534
535        if let Some(callback) = close_callback {
536            callback();
537        }
538
539        let () = msg_send![super(this, class!(NSWindow)), close];
540    }
541}
542
543extern "C" fn make_backing_layer(this: &Object, _: Sel) -> id {
544    let window_state = unsafe { get_window_state(this) };
545    let window_state = window_state.as_ref().borrow();
546    window_state.layer
547}
548
549extern "C" fn view_did_change_backing_properties(this: &Object, _: Sel) {
550    let window_state = unsafe { get_window_state(this) };
551    let mut window_state_borrow = window_state.as_ref().borrow_mut();
552
553    unsafe {
554        let _: () = msg_send![window_state_borrow.layer, setContentsScale: window_state_borrow.scale_factor() as f64];
555    }
556
557    if let Some(mut callback) = window_state_borrow.resize_callback.take() {
558        drop(window_state_borrow);
559        callback();
560        window_state.as_ref().borrow_mut().resize_callback = Some(callback);
561    };
562}
563
564extern "C" fn set_frame_size(this: &Object, _: Sel, size: NSSize) {
565    let window_state = unsafe { get_window_state(this) };
566    let mut window_state_borrow = window_state.as_ref().borrow_mut();
567
568    if window_state_borrow.size() == vec2f(size.width as f32, size.height as f32) {
569        return;
570    }
571
572    unsafe {
573        let _: () = msg_send![super(this, class!(NSView)), setFrameSize: size];
574    }
575
576    let scale_factor = window_state_borrow.scale_factor() as f64;
577    let drawable_size: NSSize = NSSize {
578        width: size.width * scale_factor,
579        height: size.height * scale_factor,
580    };
581
582    unsafe {
583        let _: () = msg_send![window_state_borrow.layer, setDrawableSize: drawable_size];
584    }
585
586    if let Some(mut callback) = window_state_borrow.resize_callback.take() {
587        drop(window_state_borrow);
588        callback();
589        window_state.borrow_mut().resize_callback = Some(callback);
590    };
591}
592
593extern "C" fn display_layer(this: &Object, _: Sel, _: id) {
594    unsafe {
595        let window_state = get_window_state(this);
596        let mut window_state = window_state.as_ref().borrow_mut();
597
598        if let Some(scene) = window_state.scene_to_render.take() {
599            let drawable: &metal::MetalDrawableRef = msg_send![window_state.layer, nextDrawable];
600            let command_queue = window_state.command_queue.clone();
601            let command_buffer = command_queue.new_command_buffer();
602
603            let size = window_state.size();
604            let scale_factor = window_state.scale_factor();
605
606            window_state.renderer.render(
607                &scene,
608                size * scale_factor,
609                command_buffer,
610                drawable.texture(),
611            );
612
613            command_buffer.commit();
614            command_buffer.wait_until_completed();
615            drawable.present();
616        };
617    }
618}
619
620async fn synthetic_drag(
621    window_state: Weak<RefCell<WindowState>>,
622    drag_id: usize,
623    position: Vector2F,
624) {
625    loop {
626        Timer::after(Duration::from_millis(16)).await;
627        if let Some(window_state) = window_state.upgrade() {
628            let mut window_state_borrow = window_state.borrow_mut();
629            if window_state_borrow.synthetic_drag_counter == drag_id {
630                if let Some(mut callback) = window_state_borrow.event_callback.take() {
631                    drop(window_state_borrow);
632                    callback(Event::LeftMouseDragged { position });
633                    window_state.borrow_mut().event_callback = Some(callback);
634                }
635            } else {
636                break;
637            }
638        }
639    }
640}
641
642unsafe fn ns_string(string: &str) -> id {
643    NSString::alloc(nil).init_str(string).autorelease()
644}