appkit: update DeviceEvent::Button to DeviceEvent::PointerButton

Author: elytldr

winit-appkit/src/app.rs

@@ -9,9 +9,10 @@ use objc2::runtime::{Imp, Sel};
 use objc2::sel;
 use objc2_app_kit::{NSApplication, NSEvent, NSEventModifierFlags, NSEventType};
 use objc2_foundation::MainThreadMarker;
-use winit_core::event::{DeviceEvent, ElementState};
+use winit_core::event::{DeviceButtonSource, DeviceEvent, ElementState};
 
 use super::app_state::AppState;
+use super::event::button_number_to_mouse_button;
 
 type SendEvent = extern "C-unwind" fn(&NSApplication, Sel, &NSEvent);
 
@@ -117,19 +118,23 @@ fn maybe_dispatch_device_event(app_state: &Rc<AppState>, event: &NSEvent) {
             }
         },
         NSEventType::LeftMouseDown | NSEventType::RightMouseDown | NSEventType::OtherMouseDown => {
-            let button = event.buttonNumber() as u32;
+            let button_number = event.buttonNumber();
+            let source = DeviceButtonSource::Mouse(button_number_to_mouse_button(button_number));
             app_state.maybe_queue_with_handler(move |app, event_loop| {
-                app.device_event(event_loop, None, DeviceEvent::Button {
-                    button,
+                app.device_event(event_loop, None, DeviceEvent::PointerButton {
+                    button: source,
+                    button_id: button_number as u32,
                     state: ElementState::Pressed,
                 });
             });
         },
         NSEventType::LeftMouseUp | NSEventType::RightMouseUp | NSEventType::OtherMouseUp => {
-            let button = event.buttonNumber() as u32;
+            let button_number = event.buttonNumber();
+            let source = DeviceButtonSource::Mouse(button_number_to_mouse_button(button_number));
             app_state.maybe_queue_with_handler(move |app, event_loop| {
-                app.device_event(event_loop, None, DeviceEvent::Button {
-                    button,
+                app.device_event(event_loop, None, DeviceEvent::PointerButton {
+                    button: source,
+                    button_id: button_number as u32,
                     state: ElementState::Released,
                 });
             });

winit-appkit/src/event.rs

@@ -4,9 +4,9 @@ use dispatch2::run_on_main;
 use objc2::rc::Retained;
 use objc2_app_kit::{NSEvent, NSEventModifierFlags, NSEventSubtype, NSEventType};
 use objc2_core_foundation::{CFData, CFRetained};
-use objc2_foundation::NSPoint;
+use objc2_foundation::{NSInteger, NSPoint};
 use smol_str::SmolStr;
-use winit_core::event::{ElementState, KeyEvent, Modifiers};
+use winit_core::event::{ElementState, KeyEvent, Modifiers, MouseButton};
 use winit_core::keyboard::{
     Key, KeyCode, KeyLocation, ModifiersKeys, ModifiersState, NamedKey, NativeKey, NativeKeyCode,
     PhysicalKey,
@@ -272,6 +272,22 @@ pub fn code_to_location(key: PhysicalKey) -> KeyLocation {
     }
 }
 
+pub fn button_number_to_mouse_button(button_number: NSInteger) -> MouseButton {
+    // The buttonNumber property only makes sense for the mouse events:
+    // NSLeftMouse.../NSRightMouse.../NSOtherMouse...
+    // For 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.
+    match button_number {
+        0 => MouseButton::Left,
+        1 => MouseButton::Right,
+        2 => MouseButton::Middle,
+        3 => MouseButton::Back,
+        4 => MouseButton::Forward,
+        n => MouseButton::Other(n as u16),
+    }
+}
+
 // While F1-F20 have scancodes we can match on, we have to check against UTF-16
 // constants for the rest.
 // https://developer.apple.com/documentation/appkit/1535851-function-key_unicodes?preferredLanguage=occ

winit-appkit/src/view.rs

@@ -18,17 +18,17 @@ use objc2_foundation::{
     NSNotFound, NSObject, NSPoint, NSRange, NSRect, NSSize, NSString, NSUInteger,
 };
 use winit_core::event::{
-    DeviceEvent, ElementState, Ime, KeyEvent, Modifiers, MouseButton, MouseScrollDelta,
-    PointerKind, PointerSource, TouchPhase, WindowEvent,
+    DeviceEvent, ElementState, Ime, KeyEvent, Modifiers, MouseScrollDelta, PointerKind,
+    PointerSource, 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,
+    button_number_to_mouse_button, 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;
@@ -1041,7 +1041,7 @@ impl WinitView {
 
     fn mouse_click(&self, event: &NSEvent, button_state: ElementState) {
         let position = self.mouse_view_point(event).to_physical(self.scale_factor());
-        let button = mouse_button(event);
+        let button = button_number_to_mouse_button(event.buttonNumber());
 
         self.update_modifiers(event, false);
 
@@ -1088,23 +1088,6 @@ impl WinitView {
     }
 }
 
-/// 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.
-    match event.buttonNumber() {
-        0 => MouseButton::Left,
-        1 => MouseButton::Right,
-        2 => MouseButton::Middle,
-        3 => MouseButton::Back,
-        4 => MouseButton::Forward,
-        n => MouseButton::Other(n as u16),
-    }
-}
-
 // 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`.