Deprecate wheel tilt as separate axis source

This has never been supported through the stack. No device ever had the
required MOUSE_WHEEL_TILT_VERTICAL/HORIZONTAL udev property set, so
libinput never set the right axis source. Neither weston nor mutter
added the code for it. Even if we added wheel tilt for devices now, it
would break those devices. And the benefit we get from having those
separate is miniscule at best.

So let's do the long-term thing and just deprecate this axis source.

The wheel tilt mouse test device remains in the test suite, with the
udev properties set just to verify that we do indeed ignore those now.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>

diff --git a/src/evdev-fallback.c b/src/evdev-fallback.c
index 99c87c87923d3086ac6b0d41dcc27f03777cda8b..d8a0e79844e0f5285f6313634adbc9422549594f 100644 (file)
--- a/src/evdev-fallback.c
+++ b/src/evdev-fallback.c
@@ -208,7 +208,6 @@ fallback_flush_wheels(struct fallback_dispatch *dispatch,
 {
        struct normalized_coords wheel_degrees = { 0.0, 0.0 };
        struct discrete_coords discrete = { 0.0, 0.0 };
-       enum libinput_pointer_axis_source source;
 
        if (!(device->seat_caps & EVDEV_DEVICE_POINTER))
                return;
@@ -233,15 +232,11 @@ fallback_flush_wheels(struct fallback_dispatch *dispatch,
                                        device->scroll.wheel_click_angle.y;
                discrete.y = -1 * dispatch->wheel.y;
 
-               source = device->scroll.is_tilt.vertical ?
-                               LIBINPUT_POINTER_AXIS_SOURCE_WHEEL_TILT:
-                               LIBINPUT_POINTER_AXIS_SOURCE_WHEEL;
-
                evdev_notify_axis(
                        device,
                        time,
                        bit(LIBINPUT_POINTER_AXIS_SCROLL_VERTICAL),
-                       source,
+                       LIBINPUT_POINTER_AXIS_SOURCE_WHEEL,
                        &wheel_degrees,
                        &discrete);
                dispatch->wheel.y = 0;
@@ -252,15 +247,11 @@ fallback_flush_wheels(struct fallback_dispatch *dispatch,
                                        device->scroll.wheel_click_angle.x;
                discrete.x = dispatch->wheel.x;
 
-               source = device->scroll.is_tilt.horizontal ?
-                               LIBINPUT_POINTER_AXIS_SOURCE_WHEEL_TILT:
-                               LIBINPUT_POINTER_AXIS_SOURCE_WHEEL;
-
                evdev_notify_axis(
                        device,
                        time,
                        bit(LIBINPUT_POINTER_AXIS_SCROLL_HORIZONTAL),
-                       source,
+                       LIBINPUT_POINTER_AXIS_SOURCE_WHEEL,
                        &wheel_degrees,
                        &discrete);
                dispatch->wheel.x = 0;

diff --git a/src/evdev.c b/src/evdev.c
index a5b1e2a94bf531cc01c4f7aaa97177939d93ea7d..6afc8623db64d4a2b448a7205378050689e0d0ac 100644 (file)
--- a/src/evdev.c
+++ b/src/evdev.c
@@ -1306,21 +1306,6 @@ evdev_read_wheel_click_props(struct evdev_device *device)
        return angles;
 }
 
-static inline struct wheel_tilt_flags
-evdev_read_wheel_tilt_props(struct evdev_device *device)
-{
-       struct wheel_tilt_flags flags;
-
-       flags.vertical = parse_udev_flag(device,
-                                        device->udev_device,
-                                        "MOUSE_WHEEL_TILT_VERTICAL");
-
-       flags.horizontal = parse_udev_flag(device,
-                                        device->udev_device,
-                                        "MOUSE_WHEEL_TILT_HORIZONTAL");
-       return flags;
-}
-
 static inline double
 evdev_get_trackpoint_multiplier(struct evdev_device *device)
 {
@@ -2232,7 +2217,6 @@ evdev_device_create(struct libinput_seat *seat,
        device->scroll.direction = 0;
        device->scroll.wheel_click_angle =
                evdev_read_wheel_click_props(device);
-       device->scroll.is_tilt = evdev_read_wheel_tilt_props(device);
        device->model_flags = evdev_read_model_flags(device);
        device->dpi = DEFAULT_MOUSE_DPI;
 

diff --git a/src/evdev.h b/src/evdev.h
index 8bc97be1218e985a3c38fdec80b4f7cc03db6d71..b0b1b8c6568bd63a728bf1303ec53e7eb74e9ec7 100644 (file)
--- a/src/evdev.h
+++ b/src/evdev.h
@@ -233,8 +233,6 @@ struct evdev_device {
                /* angle per REL_WHEEL click in degrees */
                struct wheel_angle wheel_click_angle;
 
-               struct wheel_tilt_flags is_tilt;
-
                enum evdev_button_scroll_lock_state lock_state;
                bool want_lock_enabled;
                bool lock_enabled;

diff --git a/src/libinput-private.h b/src/libinput-private.h
index 72255ff81a671f16003e5d1c66dd41b4b3caeafa..e50eb9571bdd22e8c607730cb0dc946ec1ac3fad 100644 (file)
--- a/src/libinput-private.h
+++ b/src/libinput-private.h
@@ -111,11 +111,6 @@ struct phys_ellipsis {
        double minor;
 };
 
-/* A pair of tilt flags */
-struct wheel_tilt_flags {
-       bool vertical, horizontal;
-};
-
 struct libinput_interface_backend {
        int (*resume)(struct libinput *libinput);
        void (*suspend)(struct libinput *libinput);

diff --git a/src/libinput.h b/src/libinput.h
index 5a19f79d19ac4c30a94d017265327191a9f6d809..9570648c52c17a6130b7dcc2d4eabd45bca63d86 100644 (file)
--- a/src/libinput.h
+++ b/src/libinput.h
@@ -272,6 +272,10 @@ enum libinput_pointer_axis_source {
         * The event is caused by the tilting of a mouse wheel rather than
         * its rotation. This method is commonly used on mice without
         * separate horizontal scroll wheels.
+        *
+        * @deprecated This axis source is deprecated as of libinput 1.16.
+        * It was never used by any device before libinput 1.16. All wheel
+        * tilt devices use @ref LIBINPUT_POINTER_AXIS_SOURCE_WHEEL instead.
         */
        LIBINPUT_POINTER_AXIS_SOURCE_WHEEL_TILT,
 };
@@ -1472,14 +1476,8 @@ libinput_event_pointer_get_axis_value(struct libinput_event_pointer *event,
  * The coordinate system is identical to the cursor movement, i.e. a
  * scroll value of 1 represents the equivalent relative motion of 1.
  *
- * If the source is @ref LIBINPUT_POINTER_AXIS_SOURCE_WHEEL_TILT, no
- * terminating event is guaranteed (though it may happen).
- * Scrolling is in discrete steps and there is no physical equivalent for
- * the value returned here. For backwards compatibility, the value returned
- * by this function is identical to a single mouse wheel rotation by this
- * device (see the documentation for @ref LIBINPUT_POINTER_AXIS_SOURCE_WHEEL
- * above). Callers should not use this value but instead exclusively refer
- * to the value returned by libinput_event_pointer_get_axis_value_discrete().
+ * @deprecated The source @ref LIBINPUT_POINTER_AXIS_SOURCE_WHEEL_TILT is
+ * deprecated as of libinput 1.16. No device has ever sent this source.
  *
  * For pointer events that are not of type @ref LIBINPUT_EVENT_POINTER_AXIS,
  * this function returns 0.

diff --git a/test/test-pointer.c b/test/test-pointer.c
index f148264224542397e01f0ca147f456e491231e3c..22a8bfb71664b5c0ec98acf115a7bcb65a21de42 100644 (file)
--- a/test/test-pointer.c
+++ b/test/test-pointer.c
@@ -602,33 +602,6 @@ out:
        return angle;
 }
 
-static enum libinput_pointer_axis_source
-wheel_source(struct litest_device *dev, int which)
-{
-       struct udev_device *d;
-       bool is_tilt = false;
-
-       d = libinput_device_get_udev_device(dev->libinput_device);
-       litest_assert_ptr_notnull(d);
-
-       switch(which) {
-       case REL_WHEEL:
-               is_tilt = !!udev_device_get_property_value(d, "MOUSE_WHEEL_TILT_VERTICAL");
-               break;
-       case REL_HWHEEL:
-               is_tilt = !!udev_device_get_property_value(d, "MOUSE_WHEEL_TILT_HORIZONTAL");
-               break;
-       default:
-               litest_abort_msg("Invalid source axis %d\n", which);
-               break;
-       }
-
-       udev_device_unref(d);
-       return is_tilt ?
-               LIBINPUT_POINTER_AXIS_SOURCE_WHEEL_TILT :
-               LIBINPUT_POINTER_AXIS_SOURCE_WHEEL;
-}
-
 static void
 test_wheel_event(struct litest_device *dev, int which, int amount)
 {
@@ -641,7 +614,7 @@ test_wheel_event(struct litest_device *dev, int which, int amount)
        double scroll_step, expected, discrete;
 
        scroll_step = wheel_click_angle(dev, which);
-       source = wheel_source(dev, which);
+       source = LIBINPUT_POINTER_AXIS_SOURCE_WHEEL;
        expected = amount * scroll_step;
        discrete = amount;