view.rs

#![allow(clippy::unnecessary_cast)]
use std::cell::{Cell, RefCell};
use std::collections::{HashMap, VecDeque};
use std::rc::Rc;

use dpi::{LogicalPosition, LogicalSize};
use objc2::rc::Retained;
use objc2::runtime::{AnyObject, Sel};
use objc2::{AnyThread, DefinedClass, MainThreadMarker, define_class, msg_send};
use objc2_app_kit::{
    NSApplication, NSCursor, NSEvent, NSEventPhase, NSEventSubtype, NSPointingDeviceType,
    NSResponder, NSTextInputClient, NSTrackingArea, NSTrackingAreaOptions, NSView, NSWindow,
};
use objc2_core_foundation::CGRect;
use objc2_foundation::{
    NSArray, NSAttributedString, NSAttributedStringKey, NSCopying, NSMutableAttributedString,
    NSNotFound, NSObject, NSPoint, NSRange, NSRect, NSSize, NSString, NSUInteger,
};
use tracing::{debug_span, trace_span};
use winit_core::event::{
    ButtonSource, DeviceEvent, ElementState, Force, Ime, KeyEvent, Modifiers, MouseButton,
    MouseScrollDelta, PointerKind, PointerSource, TabletToolButton, TabletToolData, TabletToolKind,
    TabletToolTilt, TouchPhase, WindowEvent,
};
use winit_core::keyboard::{Key, KeyCode, KeyLocation, ModifiersState, NamedKey};
use winit_core::window::ImeCapabilities;

use super::app_state::AppState;
use super::cursor::{default_cursor, invisible_cursor};
use super::event::{
    code_to_key, code_to_location, create_key_event, event_mods, lalt_pressed, ralt_pressed,
    scancode_to_physicalkey,
};
use super::window::window_id;
use crate::OptionAsAlt;

#[derive(Debug)]
struct CursorState {
    visible: bool,
    cursor: Retained<NSCursor>,
}

impl Default for CursorState {
    fn default() -> Self {
        Self { visible: true, cursor: default_cursor() }
    }
}

#[derive(Debug, Eq, PartialEq, Clone, Copy, Default)]
enum ImeState {
    #[default]
    /// The IME events are disabled, so only `ReceivedCharacter` is being sent to the user.
    Disabled,

    /// The ground state of enabled IME input. It means that both Preedit and regular keyboard
    /// input could be start from it.
    Ground,

    /// The IME is in preedit.
    Preedit,

    /// The text was just committed, so the next input from the keyboard must be ignored.
    Committed,
}

bitflags::bitflags! {
    #[derive(Debug, Clone, Copy, PartialEq)]
    struct ModLocationMask: u8 {
        const LEFT     = 0b0001;
        const RIGHT    = 0b0010;
    }
}
impl ModLocationMask {
    fn from_location(loc: KeyLocation) -> ModLocationMask {
        match loc {
            KeyLocation::Left => ModLocationMask::LEFT,
            KeyLocation::Right => ModLocationMask::RIGHT,
            _ => unreachable!(),
        }
    }
}

fn key_to_modifier(key: &Key) -> Option<ModifiersState> {
    match key {
        Key::Named(NamedKey::Alt) => Some(ModifiersState::ALT),
        Key::Named(NamedKey::Control) => Some(ModifiersState::CONTROL),
        Key::Named(NamedKey::Meta) => Some(ModifiersState::META),
        Key::Named(NamedKey::Shift) => Some(ModifiersState::SHIFT),
        _ => None,
    }
}

fn get_right_modifier_code(key: &Key) -> KeyCode {
    match key {
        Key::Named(NamedKey::Alt) => KeyCode::AltRight,
        Key::Named(NamedKey::Control) => KeyCode::ControlRight,
        Key::Named(NamedKey::Shift) => KeyCode::ShiftRight,
        Key::Named(NamedKey::Meta) => KeyCode::MetaRight,
        _ => unreachable!(),
    }
}

fn get_left_modifier_code(key: &Key) -> KeyCode {
    match key {
        Key::Named(NamedKey::Alt) => KeyCode::AltLeft,
        Key::Named(NamedKey::Control) => KeyCode::ControlLeft,
        Key::Named(NamedKey::Shift) => KeyCode::ShiftLeft,
        Key::Named(NamedKey::Meta) => KeyCode::MetaLeft,
        _ => unreachable!(),
    }
}

#[derive(Debug)]
pub struct ViewState {
    /// Strong reference to the global application state.
    app_state: Rc<AppState>,

    cursor_state: RefCell<CursorState>,
    ime_position: Cell<NSPoint>,
    ime_size: Cell<NSSize>,
    modifiers: Cell<Modifiers>,
    phys_modifiers: RefCell<HashMap<Key, ModLocationMask>>,
    ime_state: Cell<ImeState>,
    input_source: RefCell<String>,

    /// True iff the application wants IME events.
    ///
    /// Can be set using `set_ime_allowed`
    ime_capabilities: Cell<Option<ImeCapabilities>>,

    /// True if the current key event should be forwarded
    /// to the application, even during IME
    forward_key_to_app: Cell<bool>,
    marked_text: RefCell<Retained<NSMutableAttributedString>>,
    accepts_first_mouse: bool,

    /// The state of the `Option` as `Alt`.
    option_as_alt: Cell<OptionAsAlt>,

    /// The tablet tool currently in proximity, if any.
    ///
    /// AppKit only reports the tool type on proximity events; tablet-point events always
    /// report `Unknown`, so the tool announced at proximity time is cached here for use
    /// by subsequent point and enter/exit events.
    tablet_tool: Cell<Option<TabletToolKind>>,
}

define_class!(
    #[unsafe(super(NSView, NSResponder, NSObject))]
    #[ivars = ViewState]
    #[name = "WinitView"]
    pub(super) struct WinitView;

    /// This documentation attribute makes rustfmt work for some reason?
    impl WinitView {
        #[unsafe(method(isFlipped))]
        fn is_flipped(&self) -> bool {
            // `winit` uses the upper-left corner as the origin.
            true
        }

        // Not a normal method on `NSView`, it's triggered by `NSViewFrameDidChangeNotification`.
        #[unsafe(method(viewFrameDidChangeNotification:))]
        fn frame_did_change(&self, _notification: Option<&AnyObject>) {
            let _entered = debug_span!("NSViewFrameDidChangeNotification").entered();

            // Emit resize event here rather than from windowDidResize because:
            // 1. When a new window is created as a tab, the frame size may change without a window
            //    resize occurring.
            // 2. Even when a window resize does occur on a new tabbed window, it contains the wrong
            //    size (includes tab height).
            let rect = self.frame();
            let logical_size = LogicalSize::new(rect.size.width as f64, rect.size.height as f64);
            let size = logical_size.to_physical::<u32>(self.scale_factor());
            self.queue_event(WindowEvent::SurfaceResized(size));
        }

        #[unsafe(method(drawRect:))]
        fn draw_rect(&self, _rect: NSRect) {
            let _entered = debug_span!("drawRect:").entered();

            self.ivars().app_state.handle_redraw(window_id(&self.window()));

            // This is a direct subclass of NSView, no need to call superclass' drawRect:
        }

        #[unsafe(method(acceptsFirstResponder))]
        fn accepts_first_responder(&self) -> bool {
            let _entered = trace_span!("acceptsFirstResponder").entered();
            true
        }

        // This is necessary to prevent a beefy terminal error on MacBook Pros:
        // IMKInputSession [0x7fc573576ff0
        // presentFunctionRowItemTextInputViewWithEndpoint:completionHandler:] : [self
        // textInputContext]=0x7fc573558e10 *NO* NSRemoteViewController to client, NSError=Error
        // Domain=NSCocoaErrorDomain Code=4099 "The connection from pid 0 was invalidated from this
        // process." UserInfo={NSDebugDescription=The connection from pid 0 was invalidated from
        // this process.}, com.apple.inputmethod.EmojiFunctionRowItem TODO: Add an API
        // extension for using `NSTouchBar`
        #[unsafe(method_id(touchBar))]
        fn touch_bar(&self) -> Option<Retained<NSObject>> {
            let _entered = debug_span!("touchBar").entered();
            None
        }

        #[unsafe(method(resetCursorRects))]
        fn reset_cursor_rects(&self) {
            let _entered = debug_span!("resetCursorRects").entered();
            let bounds = self.bounds();
            let cursor_state = self.ivars().cursor_state.borrow();
            // We correctly invoke `addCursorRect` only from inside `resetCursorRects`
            if cursor_state.visible {
                self.addCursorRect_cursor(bounds, &cursor_state.cursor);
            } else {
                self.addCursorRect_cursor(bounds, &invisible_cursor());
            }
        }
    }

    unsafe impl NSTextInputClient for WinitView {
        #[unsafe(method(hasMarkedText))]
        fn has_marked_text(&self) -> bool {
            let _entered = debug_span!("hasMarkedText").entered();
            self.ivars().marked_text.borrow().length() > 0
        }

        #[unsafe(method(markedRange))]
        fn marked_range(&self) -> NSRange {
            let _entered = debug_span!("markedRange").entered();
            let length = self.ivars().marked_text.borrow().length();
            if length > 0 {
                NSRange::new(0, length)
            } else {
                // Documented to return `{NSNotFound, 0}` if there is no marked range.
                NSRange::new(NSNotFound as NSUInteger, 0)
            }
        }

        #[unsafe(method(selectedRange))]
        fn selected_range(&self) -> NSRange {
            let _entered = debug_span!("selectedRange").entered();
            // Documented to return `{NSNotFound, 0}` if there is no selection.
            NSRange::new(NSNotFound as NSUInteger, 0)
        }

        #[unsafe(method(setMarkedText:selectedRange:replacementRange:))]
        fn set_marked_text(
            &self,
            string: &NSObject,
            selected_range: NSRange,
            _replacement_range: NSRange,
        ) {
            // TODO: Use _replacement_range, requires changing the event to report surrounding text.
            let _entered = debug_span!("setMarkedText:selectedRange:replacementRange:").entered();

            let (marked_text, string) = if let Some(string) =
                string.downcast_ref::<NSAttributedString>()
            {
                (NSMutableAttributedString::from_attributed_nsstring(string), string.string())
            } else if let Some(string) = string.downcast_ref::<NSString>() {
                (NSMutableAttributedString::from_nsstring(string), string.copy())
            } else {
                // This method is guaranteed to get either a `NSString` or a `NSAttributedString`.
                panic!("unexpected text {string:?}")
            };

            // Update marked text.
            *self.ivars().marked_text.borrow_mut() = marked_text;

            // Notify IME is active if application still doesn't know it.
            if self.ivars().ime_state.get() == ImeState::Disabled {
                *self.ivars().input_source.borrow_mut() = self.current_input_source();
                self.queue_event(WindowEvent::Ime(Ime::Enabled));
            }

            if self.hasMarkedText() {
                self.ivars().ime_state.set(ImeState::Preedit);
            } else {
                // In case the preedit was cleared, set IME into the Ground state.
                self.ivars().ime_state.set(ImeState::Ground);
            }

            let cursor_range = if string.is_empty() {
                // An empty string basically means that there's no preedit, so indicate that by
                // sending a `None` cursor range.
                None
            } else {
                // Clamp to string length to avoid NSRangeException from out-of-bounds
                // indices sent by macOS IME (e.g. native Pinyin, see
                // https://github.com/alacritty/alacritty/issues/8791).
                let len = string.length();
                let location = selected_range.location.min(len);
                let end = selected_range.end().min(len);
                // Convert the selected range from UTF-16 indices to UTF-8 indices.
                let sub_string_a = string.substringToIndex(location);
                let sub_string_b = string.substringToIndex(end);
                let lowerbound_utf8 = sub_string_a.len();
                let upperbound_utf8 = sub_string_b.len();
                Some((lowerbound_utf8, upperbound_utf8))
            };

            // Send WindowEvent for updating marked text
            self.queue_event(WindowEvent::Ime(Ime::Preedit(string.to_string(), cursor_range)));
        }

        #[unsafe(method(unmarkText))]
        fn unmark_text(&self) {
            let _entered = debug_span!("unmarkText").entered();
            *self.ivars().marked_text.borrow_mut() = NSMutableAttributedString::new();

            let input_context = self.inputContext().expect("input context");
            input_context.discardMarkedText();

            self.queue_event(WindowEvent::Ime(Ime::Preedit(String::new(), None)));
            if self.is_ime_enabled() {
                // Leave the Preedit self.ivars()
                self.ivars().ime_state.set(ImeState::Ground);
            } else {
                tracing::warn!("Expected to have IME enabled when receiving unmarkText");
            }
        }

        #[unsafe(method_id(validAttributesForMarkedText))]
        fn valid_attributes_for_marked_text(&self) -> Retained<NSArray<NSAttributedStringKey>> {
            let _entered = trace_span!("validAttributesForMarkedText").entered();
            NSArray::new()
        }

        #[unsafe(method_id(attributedSubstringForProposedRange:actualRange:))]
        fn attributed_substring_for_proposed_range(
            &self,
            _range: NSRange,
            _actual_range: *mut NSRange,
        ) -> Option<Retained<NSAttributedString>> {
            let _entered =
                trace_span!("attributedSubstringForProposedRange:actualRange:").entered();
            None
        }

        #[unsafe(method(characterIndexForPoint:))]
        fn character_index_for_point(&self, _point: NSPoint) -> NSUInteger {
            let _entered = debug_span!("characterIndexForPoint:").entered();
            0
        }

        #[unsafe(method(firstRectForCharacterRange:actualRange:))]
        fn first_rect_for_character_range(
            &self,
            _range: NSRange,
            _actual_range: *mut NSRange,
        ) -> NSRect {
            let _entered = debug_span!("firstRectForCharacterRange:actualRange:").entered();

            // Guard when the view is no longer in a window during teardown.
            let Some(window) = (**self).window() else {
                return CGRect::ZERO;
            };

            // Return value is expected to be in screen coordinates, so we need a conversion
            let rect = NSRect::new(self.ivars().ime_position.get(), self.ivars().ime_size.get());
            let view_rect = self.convertRect_toView(rect, None);
            window.convertRectToScreen(view_rect)
        }

        #[unsafe(method(insertText:replacementRange:))]
        fn insert_text(&self, string: &NSObject, _replacement_range: NSRange) {
            // TODO: Use _replacement_range, requires changing the event to report surrounding text.
            let _entered = debug_span!("insertText:replacementRange:").entered();

            let string = if let Some(string) = string.downcast_ref::<NSAttributedString>() {
                string.string().to_string()
            } else if let Some(string) = string.downcast_ref::<NSString>() {
                string.to_string()
            } else {
                // This method is guaranteed to get either a `NSString` or a `NSAttributedString`.
                panic!("unexpected text {string:?}")
            };

            let is_control = string.chars().next().is_some_and(|c| c.is_control());

            // Commit only if we have marked text.
            if self.hasMarkedText() && self.is_ime_enabled() && !is_control {
                self.queue_event(WindowEvent::Ime(Ime::Preedit(String::new(), None)));
                self.queue_event(WindowEvent::Ime(Ime::Commit(string)));
                self.ivars().ime_state.set(ImeState::Committed);
            }
        }

        // Basically, we're sent this message whenever a keyboard event that doesn't generate a
        // "human readable" character happens, i.e. newlines, tabs, and Ctrl+C.
        #[unsafe(method(doCommandBySelector:))]
        fn do_command_by_selector(&self, command: Sel) {
            let _entered = debug_span!("doCommandBySelector:").entered();

            // We shouldn't forward any character from just committed text, since we'll end up
            // sending it twice with some IMEs like Korean one. We'll also always send
            // `Enter` in that case, which is not desired given it was used to confirm
            // IME input.
            if self.ivars().ime_state.get() == ImeState::Committed {
                return;
            }

            self.ivars().forward_key_to_app.set(true);

            if self.hasMarkedText() && self.ivars().ime_state.get() == ImeState::Preedit {
                // Leave preedit so that we also report the key-up for this key.
                self.ivars().ime_state.set(ImeState::Ground);
            }

            // Send command action to user if they requested it.
            let window_id = window_id(&self.window());
            self.ivars().app_state.maybe_queue_with_handler(move |app, event_loop| {
                if let Some(handler) = app.macos_handler() {
                    handler.standard_key_binding(
                        event_loop,
                        window_id,
                        command.name().to_str().unwrap(),
                    );
                }
            });

            // The documentation for `-[NSTextInputClient doCommandBySelector:]` clearly states that
            // we should not be forwarding this event up the responder chain, so no calling `super`
            // here either.
        }
    }

    /// This documentation attribute makes rustfmt work for some reason?
    impl WinitView {
        #[unsafe(method(keyDown:))]
        fn key_down(&self, event: &NSEvent) {
            let _entered = debug_span!("keyDown:").entered();
            {
                let mut prev_input_source = self.ivars().input_source.borrow_mut();
                let current_input_source = self.current_input_source();
                if *prev_input_source != current_input_source && self.is_ime_enabled() {
                    *prev_input_source = current_input_source;
                    drop(prev_input_source);
                    self.ivars().ime_state.set(ImeState::Disabled);
                    self.queue_event(WindowEvent::Ime(Ime::Disabled));
                }
            }

            // Get the characters from the event.
            let old_ime_state = self.ivars().ime_state.get();
            self.ivars().forward_key_to_app.set(false);
            let event = replace_event(event, self.option_as_alt());

            // The `interpretKeyEvents` function might call
            // `setMarkedText`, `insertText`, and `doCommandBySelector`.
            // It's important that we call this before queuing the KeyboardInput, because
            // we must send the `KeyboardInput` event during IME if it triggered
            // `doCommandBySelector`. (doCommandBySelector means that the keyboard input
            // is not handled by IME and should be handled by the application)
            if self.ivars().ime_capabilities.get().is_some() {
                let events_for_nsview = NSArray::from_slice(&[&*event]);
                self.interpretKeyEvents(&events_for_nsview);

                // If the text was committed we must treat the next keyboard event as IME related.
                if self.ivars().ime_state.get() == ImeState::Committed {
                    // Remove any marked text, so normal input can continue.
                    *self.ivars().marked_text.borrow_mut() = NSMutableAttributedString::new();
                }
            }

            self.update_modifiers(&event, false);

            let had_ime_input = match self.ivars().ime_state.get() {
                ImeState::Committed => {
                    // Allow normal input after the commit.
                    self.ivars().ime_state.set(ImeState::Ground);
                    true
                },
                ImeState::Preedit => true,
                // `key_down` could result in preedit clear, so compare old and current state.
                _ => old_ime_state != self.ivars().ime_state.get(),
            };

            if !had_ime_input || self.ivars().forward_key_to_app.get() {
                let key_event = create_key_event(&event, true, event.isARepeat());
                self.queue_event(WindowEvent::KeyboardInput {
                    device_id: None,
                    event: key_event,
                    is_synthetic: false,
                });
            }
        }

        #[unsafe(method(keyUp:))]
        fn key_up(&self, event: &NSEvent) {
            let _entered = debug_span!("keyUp:").entered();

            let event = replace_event(event, self.option_as_alt());
            self.update_modifiers(&event, false);

            // We want to send keyboard input when we are currently in the ground state.
            if matches!(self.ivars().ime_state.get(), ImeState::Ground | ImeState::Disabled) {
                self.queue_event(WindowEvent::KeyboardInput {
                    device_id: None,
                    event: create_key_event(&event, false, false),
                    is_synthetic: false,
                });
            }
        }

        #[unsafe(method(flagsChanged:))]
        fn flags_changed(&self, event: &NSEvent) {
            let _entered = debug_span!("flagsChanged:").entered();

            self.update_modifiers(event, true);
        }

        #[unsafe(method(insertTab:))]
        fn insert_tab(&self, _sender: Option<&AnyObject>) {
            let _entered = debug_span!("insertTab:").entered();
            let window = self.window();
            if let Some(first_responder) = window.firstResponder() {
                if *first_responder == ***self {
                    window.selectNextKeyView(Some(self))
                }
            }
        }

        #[unsafe(method(insertBackTab:))]
        fn insert_back_tab(&self, _sender: Option<&AnyObject>) {
            let _entered = debug_span!("insertBackTab:").entered();
            let window = self.window();
            if let Some(first_responder) = window.firstResponder() {
                if *first_responder == ***self {
                    window.selectPreviousKeyView(Some(self))
                }
            }
        }

        // Allows us to receive Cmd-. (the shortcut for closing a dialog)
        // https://bugs.eclipse.org/bugs/show_bug.cgi?id=300620#c6
        #[unsafe(method(cancelOperation:))]
        fn cancel_operation(&self, _sender: Option<&AnyObject>) {
            let mtm = MainThreadMarker::from(self);
            let _entered = debug_span!("cancelOperation:").entered();

            let event = NSApplication::sharedApplication(mtm)
                .currentEvent()
                .expect("could not find current event");

            self.update_modifiers(&event, false);
            let event = create_key_event(&event, true, event.isARepeat());

            self.queue_event(WindowEvent::KeyboardInput {
                device_id: None,
                event,
                is_synthetic: false,
            });
        }

        // In the past (?), `mouseMoved:` events were not generated when the
        // user hovered over a window from a separate window, and as such the
        // application might not know the location of the mouse in the event.
        //
        // To fix this, we emit `mouse_motion` inside of mouse click, mouse
        // scroll, magnify and other gesture event handlers, to ensure that
        // the application's state of where the mouse click was located is up
        // to date.
        //
        // See https://github.com/rust-windowing/winit/pull/1490 for history.

        #[unsafe(method(mouseDown:))]
        fn mouse_down(&self, event: &NSEvent) {
            let _entered = debug_span!("mouseDown:").entered();
            self.mouse_motion(event);
            self.mouse_click(event, ElementState::Pressed);
        }

        #[unsafe(method(mouseUp:))]
        fn mouse_up(&self, event: &NSEvent) {
            let _entered = debug_span!("mouseUp:").entered();
            self.mouse_motion(event);
            self.mouse_click(event, ElementState::Released);
        }

        #[unsafe(method(rightMouseDown:))]
        fn right_mouse_down(&self, event: &NSEvent) {
            let _entered = debug_span!("rightMouseDown:").entered();
            self.mouse_motion(event);
            self.mouse_click(event, ElementState::Pressed);
        }

        #[unsafe(method(rightMouseUp:))]
        fn right_mouse_up(&self, event: &NSEvent) {
            let _entered = debug_span!("rightMouseUp:").entered();
            self.mouse_motion(event);
            self.mouse_click(event, ElementState::Released);
        }

        #[unsafe(method(otherMouseDown:))]
        fn other_mouse_down(&self, event: &NSEvent) {
            let _entered = debug_span!("otherMouseDown:").entered();
            self.mouse_motion(event);
            self.mouse_click(event, ElementState::Pressed);
        }

        #[unsafe(method(otherMouseUp:))]
        fn other_mouse_up(&self, event: &NSEvent) {
            let _entered = debug_span!("otherMouseUp:").entered();
            self.mouse_motion(event);
            self.mouse_click(event, ElementState::Released);
        }

        #[unsafe(method(mouseMoved:))]
        fn mouse_moved(&self, event: &NSEvent) {
            let _entered = debug_span!("mouseMoved:").entered();
            self.mouse_motion(event);
        }

        #[unsafe(method(mouseDragged:))]
        fn mouse_dragged(&self, event: &NSEvent) {
            let _entered = debug_span!("mouseDragged:").entered();
            self.mouse_motion(event);
        }

        #[unsafe(method(rightMouseDragged:))]
        fn right_mouse_dragged(&self, event: &NSEvent) {
            let _entered = debug_span!("rightMouseDragged:").entered();
            self.mouse_motion(event);
        }

        #[unsafe(method(otherMouseDragged:))]
        fn other_mouse_dragged(&self, event: &NSEvent) {
            let _entered = debug_span!("otherMouseDragged:").entered();
            self.mouse_motion(event);
        }

        #[unsafe(method(mouseEntered:))]
        fn mouse_entered(&self, event: &NSEvent) {
            let _entered = debug_span!("mouseEntered:").entered();

            let position = self.mouse_view_point(event).to_physical(self.scale_factor());

            // Enter/exit events carry no tablet information (`NSEvent::subtype` raises on
            // them), so the device that crossed the boundary cannot be determined. Report
            // `Unknown` rather than guessing.
            // The actual tool and its data are still delivered on the subsequent move and
            // button events.
            self.queue_event(WindowEvent::PointerEntered {
                device_id: None,
                primary: true,
                position,
                kind: PointerKind::Unknown,
            });
        }

        #[unsafe(method(mouseExited:))]
        fn mouse_exited(&self, event: &NSEvent) {
            let _entered = debug_span!("mouseExited:").entered();

            let position = self.mouse_view_point(event).to_physical(self.scale_factor());

            // See `mouseEntered:` above: enter/exit events cannot identify the device, so
            // `Unknown` is reported here too.
            self.queue_event(WindowEvent::PointerLeft {
                device_id: None,
                primary: true,
                position: Some(position),
                kind: PointerKind::Unknown,
            });
        }

        #[unsafe(method(tabletProximity:))]
        fn tablet_proximity(&self, event: &NSEvent) {
            let _entered = debug_span!("tabletProximity:").entered();

            self.update_tablet_tool(event);
        }

        #[unsafe(method(scrollWheel:))]
        fn scroll_wheel(&self, event: &NSEvent) {
            let _entered = debug_span!("scrollWheel:").entered();

            self.mouse_motion(event);

            let delta = {
                let (x, y) = (event.scrollingDeltaX(), event.scrollingDeltaY());
                if event.hasPreciseScrollingDeltas() {
                    let delta = LogicalPosition::new(x, y).to_physical(self.scale_factor());
                    MouseScrollDelta::PixelDelta(delta)
                } else {
                    MouseScrollDelta::LineDelta(x as f32, y as f32)
                }
            };

            // The "momentum phase," if any, has higher priority than touch phase (the two should
            // be mutually exclusive anyhow, which is why the API is rather incoherent). If no
            // momentum phase is recorded (or rather, the started/ended cases of the
            // momentum phase) then we report the touch phase.
            #[allow(non_upper_case_globals)]
            let phase = match event.momentumPhase() {
                NSEventPhase::MayBegin | NSEventPhase::Began => TouchPhase::Started,
                NSEventPhase::Ended | NSEventPhase::Cancelled => TouchPhase::Ended,
                _ => match event.phase() {
                    NSEventPhase::MayBegin | NSEventPhase::Began => TouchPhase::Started,
                    NSEventPhase::Ended | NSEventPhase::Cancelled => TouchPhase::Ended,
                    _ => TouchPhase::Moved,
                },
            };

            self.update_modifiers(event, false);

            self.ivars().app_state.maybe_queue_with_handler(move |app, event_loop| {
                app.device_event(event_loop, None, DeviceEvent::MouseWheel { delta })
            });
            self.queue_event(WindowEvent::MouseWheel { device_id: None, delta, phase });
        }

        #[unsafe(method(magnifyWithEvent:))]
        fn magnify_with_event(&self, event: &NSEvent) {
            let _entered = debug_span!("magnifyWithEvent:").entered();

            self.mouse_motion(event);

            #[allow(non_upper_case_globals)]
            let phase = match event.phase() {
                NSEventPhase::Began => TouchPhase::Started,
                NSEventPhase::Changed => TouchPhase::Moved,
                NSEventPhase::Cancelled => TouchPhase::Cancelled,
                NSEventPhase::Ended => TouchPhase::Ended,
                _ => return,
            };

            self.queue_event(WindowEvent::PinchGesture {
                device_id: None,
                delta: event.magnification(),
                phase,
            });
        }

        #[unsafe(method(smartMagnifyWithEvent:))]
        fn smart_magnify_with_event(&self, event: &NSEvent) {
            let _entered = debug_span!("smartMagnifyWithEvent:").entered();

            self.mouse_motion(event);

            self.queue_event(WindowEvent::DoubleTapGesture { device_id: None });
        }

        #[unsafe(method(rotateWithEvent:))]
        fn rotate_with_event(&self, event: &NSEvent) {
            let _entered = debug_span!("rotateWithEvent:").entered();

            self.mouse_motion(event);

            #[allow(non_upper_case_globals)]
            let phase = match event.phase() {
                NSEventPhase::Began => TouchPhase::Started,
                NSEventPhase::Changed => TouchPhase::Moved,
                NSEventPhase::Cancelled => TouchPhase::Cancelled,
                NSEventPhase::Ended => TouchPhase::Ended,
                _ => return,
            };

            self.queue_event(WindowEvent::RotationGesture {
                device_id: None,
                delta: event.rotation(),
                phase,
            });
        }

        #[unsafe(method(pressureChangeWithEvent:))]
        fn pressure_change_with_event(&self, event: &NSEvent) {
            let _entered = debug_span!("pressureChangeWithEvent:").entered();

            self.queue_event(WindowEvent::TouchpadPressure {
                device_id: None,
                pressure: event.pressure(),
                stage: event.stage() as i64,
            });
        }

        // Allows us to receive Ctrl-Tab and Ctrl-Esc.
        // Note that this *doesn't* help with any missing Cmd inputs.
        // https://github.com/chromium/chromium/blob/a86a8a6bcfa438fa3ac2eba6f02b3ad1f8e0756f/ui/views/cocoa/bridged_content_view.mm#L816
        #[unsafe(method(_wantsKeyDownForEvent:))]
        fn wants_key_down_for_event(&self, _event: &NSEvent) -> bool {
            let _entered = debug_span!("_wantsKeyDownForEvent:").entered();
            true
        }

        #[unsafe(method(acceptsFirstMouse:))]
        fn accepts_first_mouse(&self, _event: &NSEvent) -> bool {
            let _entered = debug_span!("acceptsFirstMouse:").entered();
            self.ivars().accepts_first_mouse
        }
    }
);

impl WinitView {
    pub(super) fn new(
        app_state: &Rc<AppState>,
        accepts_first_mouse: bool,
        option_as_alt: OptionAsAlt,
        mtm: MainThreadMarker,
    ) -> Retained<Self> {
        let this = mtm.alloc().set_ivars(ViewState {
            app_state: Rc::clone(app_state),
            cursor_state: Default::default(),
            ime_position: Default::default(),
            ime_size: Default::default(),
            modifiers: Default::default(),
            phys_modifiers: Default::default(),
            ime_state: Default::default(),
            input_source: Default::default(),
            ime_capabilities: Default::default(),
            forward_key_to_app: Default::default(),
            marked_text: Default::default(),
            accepts_first_mouse,
            option_as_alt: Cell::new(option_as_alt),
            tablet_tool: Cell::new(None),
        });
        let this: Retained<Self> = unsafe { msg_send![super(this), init] };
        *this.ivars().input_source.borrow_mut() = this.current_input_source();

        // `MouseEnteredAndExited` enables receiving events through `mouseEntered:` and
        // `mouseExited:`.
        //
        // `MouseMoved` enables receiving events through `mouseMoved:`
        //
        // We do not set `CursorUpdate` because it is part of the "flexible" alternative to
        // `cursorRect` based cursor image updates, and we currently still use
        // `cursorRect`s. We also can't really switch to this approach because "The
        // cursorUpdate(with:) message is not sent when the NSTrackingCursorUpdate option is
        // specified along with [`ActiveAlways`]."
        //
        // `ActiveAlways` indicates we want to receive events when the window is not
        // focused ("key window" in Cocoa terms), which matches the behavior on other
        // platforms.
        //
        // We do not set `AssumeInside` because we want to avoid emitting `Left` events without a
        // correspondering `Entered` to our consumers, and not setting this flag tells AppKit to
        // handle this for us by synthesizing entry and exit events in some cases.
        //
        // `InVisibleRect` instructs the tracking area's `owner` (our `NSView`) to ignore the value
        // we provide in `rect` and keep the tracking area's bounds up to date with the
        // current view bounds automatically.
        //
        // We do not set `EnabledDuringMouseDrag` to match the platform behavior on Windows
        // and Wayland, since neither emit events while being dragged over with an empty
        // cursor without focus.
        //
        // See also https://developer.apple.com/documentation/appkit/nstrackingareaoptions.

        // Safety: the type of `owner` should be `NSView` and is.
        // The type of `user_info` is irrelevant because it is None.
        this.addTrackingArea(&*unsafe {
            NSTrackingArea::initWithRect_options_owner_userInfo(
                NSTrackingArea::alloc(),
                NSRect::ZERO,
                NSTrackingAreaOptions::MouseEnteredAndExited
                    | NSTrackingAreaOptions::MouseMoved
                    | NSTrackingAreaOptions::ActiveAlways
                    | NSTrackingAreaOptions::InVisibleRect,
                Some(&this),
                None,
            )
        });

        this
    }

    fn window(&self) -> Retained<NSWindow> {
        (**self).window().expect("view must be installed in a window")
    }

    fn queue_event(&self, event: WindowEvent) {
        let window_id = window_id(&self.window());
        self.ivars().app_state.maybe_queue_with_handler(move |app, event_loop| {
            app.window_event(event_loop, window_id, event);
        });
    }

    fn scale_factor(&self) -> f64 {
        self.window().backingScaleFactor() as f64
    }

    fn is_ime_enabled(&self) -> bool {
        !matches!(self.ivars().ime_state.get(), ImeState::Disabled)
    }

    fn current_input_source(&self) -> String {
        self.inputContext()
            .expect("input context")
            .selectedKeyboardInputSource()
            .map(|input_source| input_source.to_string())
            .unwrap_or_default()
    }

    pub(super) fn cursor_icon(&self) -> Retained<NSCursor> {
        self.ivars().cursor_state.borrow().cursor.clone()
    }

    pub(super) fn set_cursor_icon(&self, icon: Retained<NSCursor>) {
        let mut cursor_state = self.ivars().cursor_state.borrow_mut();
        cursor_state.cursor = icon;
    }

    /// Set whether the cursor should be visible or not.
    ///
    /// Returns whether the state changed.
    pub(super) fn set_cursor_visible(&self, visible: bool) -> bool {
        let mut cursor_state = self.ivars().cursor_state.borrow_mut();
        if visible != cursor_state.visible {
            cursor_state.visible = visible;
            true
        } else {
            false
        }
    }
    pub(super) fn enable_ime(&self, capabilities: ImeCapabilities) {
        // This seems reasonable but the prior behavior of `set_ime_allowed` doesn't do this
        // (it was also broken but let's not break things worse)

        // if self.ivars().ime_capabilities.get().is_none() {
        //     self.ivars().ime_state.set(ImeState::Ground);
        // }

        // why are we disabling things in an enable fn? who knows. it's what the previous one did
        // though
        if self.ivars().ime_state.get() != ImeState::Disabled {
            self.ivars().ime_state.set(ImeState::Disabled);
            self.queue_event(WindowEvent::Ime(Ime::Disabled));
        }
        self.ivars().ime_capabilities.set(Some(capabilities));
        *self.ivars().marked_text.borrow_mut() = NSMutableAttributedString::new();
    }
    pub(super) fn disable_ime(&self) {
        // see above
        self.ivars().ime_capabilities.set(None);
        if self.ivars().ime_state.get() != ImeState::Disabled {
            self.ivars().ime_state.set(ImeState::Disabled);
            self.queue_event(WindowEvent::Ime(Ime::Disabled));
        }
        // we probably don't need to do this, but again this mirrors the prior behavior of
        // `set_ime_allowed`
        *self.ivars().marked_text.borrow_mut() = NSMutableAttributedString::new();
    }

    pub(super) fn ime_capabilities(&self) -> Option<ImeCapabilities> {
        self.ivars().ime_capabilities.get()
    }

    pub(super) fn set_ime_cursor_area(&self, position: NSPoint, size: NSSize) {
        self.ivars().ime_position.set(position);
        self.ivars().ime_size.set(size);
        let input_context = self.inputContext().expect("input context");
        input_context.invalidateCharacterCoordinates();
    }

    /// Reset modifiers and emit a synthetic ModifiersChanged event if deemed necessary.
    pub(super) fn reset_modifiers(&self) {
        if !self.ivars().modifiers.get().state().is_empty() {
            self.ivars().modifiers.set(Modifiers::default());
            self.queue_event(WindowEvent::ModifiersChanged(self.ivars().modifiers.get()));
        }
    }

    pub(super) fn set_option_as_alt(&self, value: OptionAsAlt) {
        self.ivars().option_as_alt.set(value)
    }

    pub(super) fn option_as_alt(&self) -> OptionAsAlt {
        self.ivars().option_as_alt.get()
    }

    /// Update modifiers if `event` has something different
    fn update_modifiers(&self, ns_event: &NSEvent, is_flags_changed_event: bool) {
        use ElementState::{Pressed, Released};

        let current_modifiers = event_mods(ns_event);
        let prev_modifiers = self.ivars().modifiers.get();
        self.ivars().modifiers.set(current_modifiers);

        // This function was called form the flagsChanged event, which is triggered
        // when the user presses/releases a modifier even if the same kind of modifier
        // has already been pressed.
        //
        // When flags changed event has key code of zero it means that event doesn't carry any key
        // event, thus we can't generate regular presses based on that. The `ModifiersChanged`
        // later will work though, since the flags are attached to the event and contain valid
        // information.
        'send_event: {
            if is_flags_changed_event && ns_event.keyCode() != 0 {
                let scancode = ns_event.keyCode();
                let physical_key = scancode_to_physicalkey(scancode as u32);

                let logical_key = code_to_key(physical_key, scancode);
                // Ignore processing of unknown modifiers because we can't determine whether
                // it was pressed or release reliably.
                //
                // Furthermore, sometimes normal keys are reported inside flagsChanged:, such as
                // when holding Caps Lock while pressing another key, see:
                // https://github.com/alacritty/alacritty/issues/8268
                let Some(event_modifier) = key_to_modifier(&logical_key) else {
                    break 'send_event;
                };

                let mut event = KeyEvent {
                    location: code_to_location(physical_key),
                    logical_key: logical_key.clone(),
                    physical_key,
                    repeat: false,
                    // We'll correct this later.
                    state: Pressed,
                    text: None,
                    text_with_all_modifiers: None,
                    key_without_modifiers: logical_key.clone(),
                };

                let location_mask = ModLocationMask::from_location(event.location);

                let mut phys_mod_state = self.ivars().phys_modifiers.borrow_mut();
                let phys_mod =
                    phys_mod_state.entry(logical_key).or_insert(ModLocationMask::empty());

                let is_active = current_modifiers.state().contains(event_modifier);
                let mut events = VecDeque::with_capacity(2);

                // There is no API for getting whether the button was pressed or released
                // during this event. For this reason we have to do a bit of magic below
                // to come up with a good guess whether this key was pressed or released.
                // (This is not trivial because there are multiple buttons that may affect
                // the same modifier)
                if !is_active {
                    event.state = Released;
                    if phys_mod.contains(ModLocationMask::LEFT) {
                        let mut event = event.clone();
                        event.location = KeyLocation::Left;
                        event.physical_key = get_left_modifier_code(&event.logical_key).into();
                        events.push_back(WindowEvent::KeyboardInput {
                            device_id: None,
                            event,
                            is_synthetic: false,
                        });
                    }
                    if phys_mod.contains(ModLocationMask::RIGHT) {
                        event.location = KeyLocation::Right;
                        event.physical_key = get_right_modifier_code(&event.logical_key).into();
                        events.push_back(WindowEvent::KeyboardInput {
                            device_id: None,
                            event,
                            is_synthetic: false,
                        });
                    }
                    *phys_mod = ModLocationMask::empty();
                } else {
                    if *phys_mod == location_mask {
                        // Here we hit a contradiction:
                        // The modifier state was "changed" to active,
                        // yet the only pressed modifier key was the one that we
                        // just got a change event for.
                        // This seemingly means that the only pressed modifier is now released,
                        // but at the same time the modifier became active.
                        //
                        // But this scenario is possible if we released modifiers
                        // while the application was not in focus. (Because we don't
                        // get informed of modifier key events while the application
                        // is not focused)

                        // In this case we prioritize the information
                        // about the current modifier state which means
                        // that the button was pressed.
                        event.state = Pressed;
                    } else {
                        phys_mod.toggle(location_mask);
                        let is_pressed = phys_mod.contains(location_mask);
                        event.state = if is_pressed { Pressed } else { Released };
                    }

                    events.push_back(WindowEvent::KeyboardInput {
                        device_id: None,
                        event,
                        is_synthetic: false,
                    });
                }

                drop(phys_mod_state);

                for event in events {
                    self.queue_event(event);
                }
            }
        }

        if prev_modifiers == current_modifiers {
            return;
        }

        self.queue_event(WindowEvent::ModifiersChanged(self.ivars().modifiers.get()));
    }

    fn mouse_click(&self, event: &NSEvent, button_state: ElementState) {
        let tablet = self.tablet_event_data(event);
        let position = self.mouse_view_point(event).to_physical(self.scale_factor());
        let button = mouse_button(event);

        self.update_modifiers(event, false);

        self.queue_event(WindowEvent::PointerButton {
            device_id: None,
            primary: true,
            state: button_state,
            position,
            button: match tablet {
                Some((kind, data)) => {
                    ButtonSource::TabletTool { kind, button: tablet_button(button), data }
                },
                None => button.into(),
            },
        });
    }

    fn mouse_motion(&self, event: &NSEvent) {
        let tablet = self.tablet_event_data(event);
        let view_point = self.mouse_view_point(event);
        let frame = self.frame();

        if view_point.x.is_sign_negative()
            || view_point.y.is_sign_negative()
            || view_point.x > frame.size.width
            || view_point.y > frame.size.height
        {
            let mouse_buttons_down = NSEvent::pressedMouseButtons();
            if mouse_buttons_down == 0 {
                // Point is outside of the client area (view) and no buttons are pressed
                return;
            }
        }

        self.update_modifiers(event, false);

        self.queue_event(WindowEvent::PointerMoved {
            device_id: None,
            primary: true,
            position: view_point.to_physical(self.scale_factor()),
            source: match tablet {
                Some((kind, data)) => PointerSource::TabletTool { kind, data },
                None => PointerSource::Mouse,
            },
        });
    }

    /// Update the cached tablet tool from a proximity event.
    ///
    /// The caller must ensure `event` is a `TabletProximity` event or a mouse event with
    /// the `TabletProximity` subtype: the proximity accessors (`pointingDeviceType`,
    /// `isEnteringProximity`) raise on other events.
    fn update_tablet_tool(&self, event: &NSEvent) {
        let tool = event.isEnteringProximity().then(|| tablet_tool_kind(event));
        self.ivars().tablet_tool.set(tool);
    }

    /// Handle the tablet parts of a mouse event: update the cached tool on proximity
    /// transitions and return the tool and its data for tablet-point events.
    fn tablet_event_data(&self, event: &NSEvent) -> Option<(TabletToolKind, TabletToolData)> {
        match event.subtype() {
            NSEventSubtype::TabletPoint => {
                // The tool kind is only announced at proximity time; if no proximity event
                // was seen (e.g. the tool was already on the tablet at startup), assume the
                // most common tool, a pen.
                let kind = self.ivars().tablet_tool.get().unwrap_or(TabletToolKind::Pen);
                Some((kind, tablet_tool_data(event)))
            },
            NSEventSubtype::TabletProximity => {
                self.update_tablet_tool(event);
                None
            },
            _ => None,
        }
    }

    fn mouse_view_point(&self, event: &NSEvent) -> LogicalPosition<f64> {
        let window_point = event.locationInWindow();
        let view_point = self.convertPoint_fromView(window_point, None);

        LogicalPosition::new(view_point.x, view_point.y)
    }
}

/// Get the mouse button from the NSEvent.
fn mouse_button(event: &NSEvent) -> MouseButton {
    // The buttonNumber property only makes sense for the mouse events:
    // NSLeftMouse.../NSRightMouse.../NSOtherMouse...
    // For the other events, it's always set to 0.
    // MacOS only defines the left, right and middle buttons, 3..=31 are left as generic buttons,
    // but 3 and 4 are very commonly used as Back and Forward by hardware vendors and applications.
    let b: isize = event.buttonNumber();
    b.try_into()
        .ok()
        .and_then(MouseButton::try_from_u8)
        .expect("expected MacOS button number in the range 0..=31")
}

/// Map a [`MouseButton`] reported by a tablet event to its [`TabletToolButton`].
///
/// Mirrors winit-core's `TabletToolButton` to `MouseButton` conversion table.
fn tablet_button(button: MouseButton) -> TabletToolButton {
    match button {
        MouseButton::Left => TabletToolButton::Contact,
        MouseButton::Right => TabletToolButton::Barrel,
        MouseButton::Middle => TabletToolButton::Other(1),
        MouseButton::Back => TabletToolButton::Other(3),
        MouseButton::Forward => TabletToolButton::Other(4),
        other => TabletToolButton::Other(other as u16),
    }
}

/// Map a tablet proximity `NSEvent`'s pointing device type to a [`TabletToolKind`].
///
/// The caller must ensure `event` is a proximity event (type `TabletProximity` or a mouse
/// event with that subtype): the device type is only reported at proximity time —
/// tablet-point events always report `Unknown`.
fn tablet_tool_kind(event: &NSEvent) -> TabletToolKind {
    match event.pointingDeviceType() {
        NSPointingDeviceType::Eraser => TabletToolKind::Eraser,
        // AppKit's `Cursor` is the tablet puck; winit's closest tool kind is `Mouse`.
        NSPointingDeviceType::Cursor => TabletToolKind::Mouse,
        // `Pen` and `Unknown` both map to a pen; it is the most common tool and a
        // reasonable default for hardware that does not report a specific type.
        _ => TabletToolKind::Pen,
    }
}

/// Collect tablet tool data (pressure, barrel pressure, twist, tilt) from a tablet `NSEvent`.
///
/// The caller must ensure `event` originates from a tablet (subtype `TabletPoint`): the
/// tablet-specific accessors (`tilt`, `rotation`, `tangentialPressure`) raise on
/// non-tablet events.
fn tablet_tool_data(event: &NSEvent) -> TabletToolData {
    // `NSEvent::tilt` reports each axis in [-1, 1]; winit expects degrees in [-90, 90].
    // AppKit's y-up orientation means positive y tilts away from the user, while winit
    // documents positive y as towards the user, so negate y.
    let tilt = event.tilt();
    TabletToolData {
        force: Some(Force::Normalized(event.pressure() as f64)),
        tangential_force: Some(event.tangentialPressure()),
        twist: Some(event.rotation().rem_euclid(360.0) as u16),
        tilt: Some(TabletToolTilt { x: (tilt.x * 90.0) as i8, y: (-tilt.y * 90.0) as i8 }),
        angle: None,
    }
}

// NOTE: to get option as alt working we need to rewrite events
// we're getting from the operating system, which makes it
// impossible to provide such events as extra in `KeyEvent`.
fn replace_event(event: &NSEvent, option_as_alt: OptionAsAlt) -> Retained<NSEvent> {
    let ev_mods = event_mods(event).state();
    let ignore_alt_characters = match option_as_alt {
        OptionAsAlt::OnlyLeft if lalt_pressed(event) => true,
        OptionAsAlt::OnlyRight if ralt_pressed(event) => true,
        OptionAsAlt::Both if ev_mods.alt_key() => true,
        _ => false,
    } && !ev_mods.control_key()
        && !ev_mods.meta_key();

    if ignore_alt_characters {
        let ns_chars =
            event.charactersIgnoringModifiers().expect("expected characters to be non-null");

        NSEvent::keyEventWithType_location_modifierFlags_timestamp_windowNumber_context_characters_charactersIgnoringModifiers_isARepeat_keyCode(
                event.r#type(),
                event.locationInWindow(),
                event.modifierFlags(),
                event.timestamp(),
                event.windowNumber(),
                None,
                &ns_chars,
                &ns_chars,
                event.isARepeat(),
                event.keyCode(),
            )
            .unwrap()
    } else {
        event.copy()
    }
}