[u] Add MousePressure event

Upstreams 07bf685feee40cc541b2764300815a600356188c

Author: decahedron1

crates/gpui/src/elements/div.rs

@@ -40,8 +40,8 @@ use super::ImageCacheProvider;
 use crate::{
 	Action, AnyDrag, AnyElement, AnyTooltip, AnyView, App, ClickEvent, DispatchPhase, Display, Element, ElementId, Entity, FocusHandle, Global,
 	GlobalElementId, Hitbox, HitboxBehavior, HitboxId, IntoElement, KeyContext, KeyDownEvent, KeyUpEvent, KeyboardButton, KeyboardClickEvent, LayoutId,
-	ModifiersChangedEvent, MouseButton, MouseClickEvent, MouseDownEvent, MouseMoveEvent, MouseUpEvent, Overflow, ParentElement, Render, ScrollWheelEvent,
-	Style, StyleRefinement, Styled, Task, TooltipId, Visibility, Window, WindowControlArea
+	ModifiersChangedEvent, MouseButton, MouseClickEvent, MouseDownEvent, MouseMoveEvent, MousePressureEvent, MouseUpEvent, Overflow, ParentElement, Render,
+	ScrollWheelEvent, Style, StyleRefinement, Styled, Task, TooltipId, Visibility, Window, WindowControlArea
 };
 
 const DRAG_THRESHOLD: f64 = 2.;
@@ -126,6 +126,30 @@ impl Interactivity {
 		}));
 	}
 
+	/// Bind the given callback to the mouse pressure event, during the bubble phase
+	/// the imperative API equivalent to [`InteractiveElement::on_mouse_pressure`].
+	///
+	/// See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.
+	pub fn on_mouse_pressure(&mut self, listener: impl Fn(&MousePressureEvent, &mut Window, &mut App) + 'static) {
+		self.mouse_pressure_listeners.push(Box::new(move |event, phase, hitbox, window, cx| {
+			if phase == DispatchPhase::Bubble && hitbox.is_hovered(window) {
+				(listener)(event, window, cx)
+			}
+		}));
+	}
+
+	/// Bind the given callback to the mouse pressure event, during the capture phase
+	/// the imperative API equivalent to [`InteractiveElement::on_mouse_pressure`].
+	///
+	/// See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.
+	pub fn capture_mouse_pressure(&mut self, listener: impl Fn(&MousePressureEvent, &mut Window, &mut App) + 'static) {
+		self.mouse_pressure_listeners.push(Box::new(move |event, phase, hitbox, window, cx| {
+			if phase == DispatchPhase::Capture && hitbox.is_hovered(window) {
+				(listener)(event, window, cx)
+			}
+		}));
+	}
+
 	/// Bind the given callback to the mouse up event for the given button, during the bubble phase.
 	/// The imperative API equivalent to [`InteractiveElement::on_mouse_up`].
 	///
@@ -597,6 +621,24 @@ pub trait InteractiveElement: Sized {
 		self
 	}
 
+	/// Bind the given callback to the mouse pressure event, during the bubble phase
+	/// the fluent API equivalent to [`Interactivity::on_mouse_pressure`]
+	///
+	/// See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.
+	fn on_mouse_pressure(mut self, listener: impl Fn(&MousePressureEvent, &mut Window, &mut App) + 'static) -> Self {
+		self.interactivity().on_mouse_pressure(listener);
+		self
+	}
+
+	/// Bind the given callback to the mouse pressure event, during the capture phase
+	/// the fluent API equivalent to [`Interactivity::on_mouse_pressure`]
+	///
+	/// See [`Context::listener`](crate::Context::listener) to get access to a view's state from this callback.
+	fn capture_mouse_pressure(mut self, listener: impl Fn(&MousePressureEvent, &mut Window, &mut App) + 'static) -> Self {
+		self.interactivity().capture_mouse_pressure(listener);
+		self
+	}
+
 	/// Bind the given callback to the mouse up event for the given button, during the bubble phase.
 	/// The fluent API equivalent to [`Interactivity::on_mouse_up`].
 	///
@@ -972,17 +1014,13 @@ pub trait StatefulInteractiveElement: InteractiveElement {
 
 pub(crate) type MouseDownListener = Box<dyn Fn(&MouseDownEvent, DispatchPhase, &Hitbox, &mut Window, &mut App) + 'static>;
 pub(crate) type MouseUpListener = Box<dyn Fn(&MouseUpEvent, DispatchPhase, &Hitbox, &mut Window, &mut App) + 'static>;
-
 pub(crate) type MouseMoveListener = Box<dyn Fn(&MouseMoveEvent, DispatchPhase, &Hitbox, &mut Window, &mut App) + 'static>;
-
+pub(crate) type MousePressureListener = Box<dyn Fn(&MousePressureEvent, DispatchPhase, &Hitbox, &mut Window, &mut App) + 'static>;
 pub(crate) type ScrollWheelListener = Box<dyn Fn(&ScrollWheelEvent, DispatchPhase, &Hitbox, &mut Window, &mut App) + 'static>;
-
 pub(crate) type ClickListener = Rc<dyn Fn(&ClickEvent, &mut Window, &mut App) + 'static>;
-
 pub(crate) type DragListener = Box<dyn Fn(&dyn Any, Point<Pixels>, &mut Window, &mut App) -> AnyView + 'static>;
 
 type DropListener = Box<dyn Fn(&dyn Any, &mut Window, &mut App) + 'static>;
-
 type CanDropPredicate = Box<dyn Fn(&dyn Any, &mut Window, &mut App) -> bool + 'static>;
 
 pub(crate) struct TooltipBuilder {
@@ -1227,6 +1265,7 @@ pub struct Interactivity {
 	pub(crate) group_drag_over_styles: Vec<(TypeId, GroupStyle)>,
 	pub(crate) mouse_down_listeners: Vec<MouseDownListener>,
 	pub(crate) mouse_up_listeners: Vec<MouseUpListener>,
+	pub(crate) mouse_pressure_listeners: Vec<MousePressureListener>,
 	pub(crate) mouse_move_listeners: Vec<MouseMoveListener>,
 	pub(crate) scroll_wheel_listeners: Vec<ScrollWheelListener>,
 	pub(crate) key_down_listeners: Vec<KeyDownListener>,
@@ -1369,6 +1408,7 @@ impl Interactivity {
 			|| self.hover_listener.is_some()
 			|| !self.mouse_up_listeners.is_empty()
 			|| !self.mouse_down_listeners.is_empty()
+			|| !self.mouse_pressure_listeners.is_empty()
 			|| !self.mouse_move_listeners.is_empty()
 			|| !self.click_listeners.is_empty()
 			|| !self.scroll_wheel_listeners.is_empty()
@@ -1583,6 +1623,13 @@ impl Interactivity {
 			})
 		}
 
+		for listener in self.mouse_pressure_listeners.drain(..) {
+			let hitbox = hitbox.clone();
+			window.on_mouse_event(move |event: &MousePressureEvent, phase, window, cx| {
+				listener(event, phase, &hitbox, window, cx);
+			})
+		}
+
 		for listener in self.mouse_move_listeners.drain(..) {
 			let hitbox = hitbox.clone();
 			window.on_mouse_event(move |event: &MouseMoveEvent, phase, window, cx| {

crates/gpui/src/interactive.rs

@@ -174,6 +174,40 @@ pub struct MouseClickEvent {
 	pub up: MouseUpEvent
 }
 
+/// The stage of a pressure click event.
+#[derive(Clone, Copy, Debug, Default, PartialEq)]
+pub enum PressureStage {
+	/// No pressure.
+	#[default]
+	Zero,
+	/// Normal click pressure.
+	Normal,
+	/// High pressure, enough to trigger a force click.
+	Force
+}
+
+/// A mouse pressure event from the platform. Generated when a force-sensitive trackpad is pressed hard.
+/// Currently only implemented for macOS trackpads.
+#[derive(Debug, Clone, Default)]
+pub struct MousePressureEvent {
+	/// Pressure of the current stage as a float between 0 and 1
+	pub pressure: f32,
+	/// The pressure stage of the event.
+	pub stage: PressureStage,
+	/// The position of the mouse on the window.
+	pub position: Point<Pixels>,
+	/// The modifiers that were held down when the mouse pressure changed.
+	pub modifiers: Modifiers
+}
+
+impl Sealed for MousePressureEvent {}
+impl InputEvent for MousePressureEvent {
+	fn to_platform_input(self) -> PlatformInput {
+		PlatformInput::MousePressure(self)
+	}
+}
+impl MouseEvent for MousePressureEvent {}
+
 /// A click event that was generated by a keyboard button being pressed and released.
 #[derive(Clone, Debug, Default)]
 pub struct KeyboardClickEvent {
@@ -544,6 +578,8 @@ pub enum PlatformInput {
 	MouseDown(MouseDownEvent),
 	/// The mouse was released.
 	MouseUp(MouseUpEvent),
+	/// Mouse pressure.
+	MousePressure(MousePressureEvent),
 	/// The mouse was moved.
 	MouseMove(MouseMoveEvent),
 	/// The mouse exited the window.
@@ -562,6 +598,7 @@ impl PlatformInput {
 			PlatformInput::ModifiersChanged { .. } => None,
 			PlatformInput::MouseDown(event) => Some(event),
 			PlatformInput::MouseUp(event) => Some(event),
+			PlatformInput::MousePressure(event) => Some(event),
 			PlatformInput::MouseMove(event) => Some(event),
 			PlatformInput::MouseExited(event) => Some(event),
 			PlatformInput::ScrollWheel(event) => Some(event),
@@ -576,6 +613,7 @@ impl PlatformInput {
 			PlatformInput::ModifiersChanged(event) => Some(event),
 			PlatformInput::MouseDown(_) => None,
 			PlatformInput::MouseUp(_) => None,
+			PlatformInput::MousePressure(_) => None,
 			PlatformInput::MouseMove(_) => None,
 			PlatformInput::MouseExited(_) => None,
 			PlatformInput::ScrollWheel(_) => None,

crates/gpui/src/platform/mac/events.rs

@@ -9,8 +9,8 @@ use core_graphics::event::CGKeyCode;
 use objc::{msg_send, sel, sel_impl};
 
 use crate::{
-	Capslock, KeyDownEvent, KeyUpEvent, Keystroke, Modifiers, ModifiersChangedEvent, MouseButton, MouseDownEvent, MouseExitEvent, MouseMoveEvent, MouseUpEvent,
-	NavigationDirection, Pixels, PlatformInput, ScrollDelta, ScrollWheelEvent, TouchPhase,
+	Capslock, KeyDownEvent, KeyUpEvent, Keystroke, Modifiers, ModifiersChangedEvent, MouseButton, MouseDownEvent, MouseExitEvent, MouseMoveEvent,
+	MousePressureEvent, MouseUpEvent, NavigationDirection, Pixels, PlatformInput, PressureStage, ScrollDelta, ScrollWheelEvent, TouchPhase,
 	platform::mac::{
 		LMGetKbdType, NSStringExt, TISCopyCurrentKeyboardLayoutInputSource, TISGetInputSourceProperty, UCKeyTranslate, kTISPropertyUnicodeKeyLayoutData
 	},
@@ -173,6 +173,23 @@ impl PlatformInput {
 						})
 					})
 				}
+				NSEventType::NSEventTypePressure => {
+					let stage = native_event.stage();
+					let pressure = native_event.pressure();
+
+					window_height.map(|window_height| {
+						Self::MousePressure(MousePressureEvent {
+							stage: match stage {
+								1 => PressureStage::Normal,
+								2 => PressureStage::Force,
+								_ => PressureStage::Zero
+							},
+							pressure,
+							modifiers: read_modifiers(native_event),
+							position: point(px(native_event.locationInWindow().x as f32), window_height - px(native_event.locationInWindow().y as f32))
+						})
+					})
+				}
 				// Some mice (like Logitech MX Master) send navigation buttons as swipe events
 				NSEventType::NSEventTypeSwipe => {
 					let navigation_direction = match native_event.phase() {

crates/gpui/src/platform/mac/window.rs

@@ -112,6 +112,7 @@ unsafe fn build_classes() {
 				decl.add_method(sel!(otherMouseDown:), handle_view_event as extern "C" fn(&Object, Sel, id));
 				decl.add_method(sel!(otherMouseUp:), handle_view_event as extern "C" fn(&Object, Sel, id));
 				decl.add_method(sel!(mouseMoved:), handle_view_event as extern "C" fn(&Object, Sel, id));
+				decl.add_method(sel!(pressureChangeWithEvent:), handle_view_event as extern "C" fn(&Object, Sel, id));
 				decl.add_method(sel!(mouseExited:), handle_view_event as extern "C" fn(&Object, Sel, id));
 				decl.add_method(sel!(mouseDragged:), handle_view_event as extern "C" fn(&Object, Sel, id));
 				decl.add_method(sel!(scrollWheel:), handle_view_event as extern "C" fn(&Object, Sel, id));

crates/gpui/src/window.rs

@@ -3275,6 +3275,7 @@ impl Window {
 				self.modifiers = mouse_up.modifiers;
 				PlatformInput::MouseUp(mouse_up)
 			}
+			PlatformInput::MousePressure(mouse_pressure) => PlatformInput::MousePressure(mouse_pressure),
 			PlatformInput::MouseExited(mouse_exited) => {
 				self.modifiers = mouse_exited.modifiers;
 				PlatformInput::MouseExited(mouse_exited)