window.rs

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