tools/record: rework the event printing

For historical (but not very good) reasons, libinput record printed events
from the first device to the output file (or stdout) and buffered everything
else. On ctrl+c, the other devices' descriptions and the buffered events were
appended to the output file.

This makes the printing code rather complex. Simplify it by giving each device
a separate FILE* - the first device points to the real output file, the others
to a tempfile. On Ctrl+C we just append those tempfiles to the real output
file one-by-one and done.

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

tools/record: rename the output file handling

Less confusing than having output_file, out_file, and outfile.

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

tools/record: remember the first device in the context

No functional changes since we can get this easily from the list itself, but
in the future the first device will be used more extensively.

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

tools/record: append the devices in-order

Using list_insert() here means the last device specified on the commandline is
the one that ends up in the file first - not very obvious...

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

tools/record: get rid of indent push/pop, replace with fixed indents

Our file format is static enough that we don't need to use push/pop, we know
exactly which line is going where. So let's replace it with a static
indent instead.

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

tools/record: mark the iprintf function as printf

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

tools/record: switch the output file from an fd to a FILE*

This is prep work to be more consistent with the use of tempfile later for
individual devices.

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

tools/record: deduplicate the device opening logic

With a new helper function strv_from_argv we can re-use the device opening
loop for all the use-cases we have.

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

tools/record: free the namelist when we're done

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

tools/record: localize a variable

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

tools/record: de-duplicate an error message

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

tools/record: factor out the output file collection

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

tools/code-formatting: Add EditorConfig file

EditorConfig helps maintain consistent coding styles for multiple developers
working on the same project across various editors and IDEs:
https://editorconfig.org/

Signed-off-by: José Expósito <jose.exposito89@gmail.com>

fallback: disable mouse scroll wheel while middle button is pressed

Signed-off-by: José Expósito <jose.exposito89@gmail.com>

fallback: replace fallback_dispatch->wheel with an anonymous struct

The current fallback_dispatch wheel struct, a device_coords, doesn't allow to
save extra information.
The new anonymous struct will allow to add a is_inhibited field to disable mouse
scroll while the middle button is pressed and, potentially, any required extra
state in the future.

Signed-off-by: José Expósito <jose.exposito89@gmail.com>

quirks: add wildcard to HID-over-I2C names (for FreeBSD)

The FreeBSD HID stack adds the device type to the evdev name,
so we get e.g. "ACPI0C50:00 18D1:5028 TouchPad".

(Maybe this shouldn't be matched by name at all though...)

Signed-off-by: Greg V <greg@unrelenting.technology>

quirks: implement DMI support on FreeBSD

FreeBSD does not use Linux modaliases, so we have to generate these strings.
Unfortunately for us, the data in kenv has the chassis type pre-parsed into
a nice string, so we have to match these strings back into numbers.
Only relevant types are included to avoid bloating the code.

Signed-off-by: Greg V <greg@unrelenting.technology>

quirks: add quirks for Apple SPI input devices

The Linux applespi driver currently uses the Synaptics vendor ID
on the trackpad for some reason (even though, at least from bcm5974
we only know that Broadcom is involved..) but my upcoming FreeBSD driver
uses the Apple vendor ID everywhere, so add two quirks.

Signed-off-by: Greg V <greg@unrelenting.technology>

quirks: recognize SPI bus

Apple MacBooks (Broadwell/Skylake/Kaby Lake and Apple Silicon)
use SPI to communicate with the keyboard and trackpad.

Signed-off-by: Greg V <greg@unrelenting.technology>

tests: add a gesture test to ensure our unaccel deltas are in a sane range

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

gestures: Filter unaccelerated deltas for gestures

Make sure the unaccelerated deltas are comparable to scroll deltas.

edit by whot:
The original intention of the unaccelerated motion data here was to provide
both accelerated and unaccelerated motion for gestures so it was possible to
have 1:1 mapping from gesture motion to screen activity.

Normalizing to 1000dpi this way would've worked for mice but touchpad
acceleration also includes the TP_MAGIC_SLOWDOWN (amongst other tricks) which
slows down motion to around 27% *before* applying the acceleration function.
On a 1000dpi touchpad (~40 units/mm) simply normalizing touchpad motion to
1000dpi results in pointer motion that is way too fast, it's lacking that
slowdown to 27% of original speed.

This results in the accelerated and unaccelerated gesture data being in
effectively two different coordinate systems with the caller having no ability
to relate the two.

Switching to the special constant acceleration applies that slowdown and
matches the data to the part of the acceleration curve where no (additional)
acceleration is applied.

It makes the gesture unaccelerated data comparable to the accelerated data
and to scroll data which uses the same process.

Fixes #582

Signed-off-by: Alexander Mikhaylenko <alexm@gnome.org>
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>

test: push/pop event frames around three-touch movements

Without this, each finger movement happens in a different evdev event frame.
Since we average deltas for gestures, this messes with the expected data.

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

test: simplify the helper for moving three touches at the same time

There's no test case where we need to do something immediately after the last
event so we might as well do everything in the same loop.

This also fixes a bug where the first movement would usually get swallowed.
Test cases in general put the finger down at x/y, then move them to some other
position. We'd expect the first event in a loop to happen at x+n/y+n, not at
x/y again.

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

test: fix debugging messages for gesture begin event

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

doc/user: explain why we are doing motion normalization

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

filter: correct comments about the threshold's unit

See d6e531349745ff38ae457169d5089ea61297accf for confirmation that the
threshold is intended to be in mm/s, the comment here is simply a leftover from
earlier times when the acceleration method was using device-units only.

Fixes #585

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

test: update a few tests for more modern helpers

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

test: localize a few variables

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

touchpad: always push a touch's current point to the motion history

The way touchpads (generally) work is that they get the position of each
finger on each scanout. The kernel filters touches that haven't moved to
reduce bandwidth so any touch that is logically down that we don't see an
update for is in the same position as during the last scanout.

Previously, touches that didn't sent events were effectively ignored, causing
our jump detection to fail:
- time t0: touch moves to position x/y, motion history time is set to t0
- time t1..t5: touch remains at position for several frames, no updates to the
  motion history
- time t6: touch jumps to position x+a/y+b
  - tp_detect_jumps() sees the last update time is t0 which is too long ago
    and exits without detecting a jump

This is fixed by pushing to the motion history any time we have *any* update -
if the touchpad notices a state change on any touch update all touches with
their current position, whether it changed or not.

This obsoletes the `time` field in the tp_touch struct, most of this patch is
passing down the current time to the few users of t->time.

Fixes #578

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

test: add a comment to the thumb speed test

Incorrect comment, the purpose of this test was to ensure that an unused slot
doesn't affect how other touches are treated, see commit 928bad9.

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

test: fix two inadvertent pointer jumps in a test

Got papered over by bugs in the implementation and didn't trigger the jump
detection or movement detection otherwise.

Related to #578

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

tools/debug-gui: draw a sprite for the unaccelerated pointer as well

Add a second grey v-shaped (upside down triangle) pointer that moves around
with the unaccelerated deltas. This makes it easier to visualize how the
unaccelerated pointer moves around, the snake helps for some use-cases but not
all of them.

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

tools/debug-gui: move the abs pointer position into a struct point

No functional changes

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

tools/debug-gui: move the pointer position into a struct point

No functional change

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

tools/debug-gui: start the unaccelerated motion deltas in the screen center

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

util: document our list interface

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

tools/per-slot-delta: handle KeyboardInterrupts nicely

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

tools/per-slot-delta: print the button state too while analyzing

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

completion: add missing libinput analyze subtools to the zsh completions

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

replace strncmp with strneq for safety-check

Signed-off-by: weizhixiang <weizhixiang@uniontech.com>

Add Lenovo Legion 5 keyboard to 50-system-lenovo.quirks

Signed-off-by: Pedro Ribeiro <pedrib@gmail.com>

treewide: get rid of `tmp` argument in list_for_each_safe

Signed-off-by: Konstantin Kharlamov <Hi-Angel@yandex.ru>

util-list.h: simplify code by removing an excess initialization

The assignment of zero is done to work around false-positives of
coverity about uninitialized variable usage. Getting rid of it inside
the macro will allow in later commit to declare a variable inside
`for-loop` rather than outside of it.

Do it by declaring a new list_first_entry_by_type helper which accepts a
type rather than a variable.

Signed-off-by: Konstantin Kharlamov <Hi-Angel@yandex.ru>

libinput 1.17.0

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

tools/record: fix two coverity complaints

In both cases we only read to drain the fd, we don't care about the return
value.

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

tools: add a tool to print a libinput recording as a table

This makes it easier to visualize changes in various axes or key states that
should not be there, doubly so for long recordings.

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

meson.build: build libinput replay as well

Just like the other python-based tools it's just a basename copy, so let's be
consistent here and have all tools perform that way.

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

tools/record: use a helper function to get the next event for a device

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

tools/record: switch record over to using epoll

Using poll means more difficult fd management, epoll (together with am
modified version of the libinput_sources) makes this a lot easier by simply
using dispatch.

This means we are no longer reliant on a specific file descriptor order in the
poll array.

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

tools/record: reword parts of the man page

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

tools/record: use safe_basename() to get to the hid report descriptor

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

utils: add a safe version of basename

So we don't need to worry about the libgen.h include game.
And we can switch trunkname over to that, making it a bit simpler.

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

tools/record: simplify the behavior to emulate Python's join()

Instead of a boolean "is_first", just change the separator.

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

tools/replay: Enter quits if there are no events

If we have no events in any of the recorded devices, state that this is the
case and make Enter simply quit instead of a pointless while loop.

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

tools/replay: search for the first event with a timestamp

When running with --with-libinput, the first event is the DEVICE_ADDED event
for our device. Those events do not have a timestamp.

We have to find the first event in the recording with a timestamp instead.

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

tools/record: print a header as first line

To make the file format easier to detect

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

Fix worng quirk name in doc

The doc mentioned 'AttrTouchPressureRange' quirk but `src/quirks.c` defines
'AttrPressureRange' instead. This led to unknown quirk name errors.

Signed-off-by: yuri1969 <1969yuri1969@gmail.com>

tools/record: fix outdated comment

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

tools/record: de-inline our functions

Let's leave this up to the compiler, the usual side-effect of inline (compiler
doesn't complain about an unused static function) doesn't apply here.

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

tools/record: correct the evdev data format in the man page

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

meson.build: consolidate all man pages

They all use the same configure_file() process, so let's do them all in a
loop.

Exceptions are the test-suite man page.

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

meson.build: drop the dummy config data and use copy: true instead

We require the meson version this was introduced in, so let's use it.

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

test: add test cases for 2/3 finger movement after drag-lock

Same as after a tap, just with a short drag between tap and 2/3 finger movement.
Also fixes a finger coord typo in one of the previously added test cases.

Signed-off-by: satrmb <10471-satrmb@users.noreply.gitlab.freedesktop.org>

libinput 1.16.902

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

test: add test cases for 2/3 finger movement after tap

We have two behaviors here:
- tap + 2fg -> scrolling
- tap + 1fg move + 2f down -> dragging

Let's document this. The 3fg case only has one situation, so let's test that.

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

test: drop the needless base event conversion

This was just there to avoid unused variable warnings but the simpler approach
to that is to just not assign a variable in the first place.

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

test: print the event type on mismatch

We already have a helper function for this, let's use it.

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

doc: update the docs with a note regarding multifinger dragging

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

gitlab CI: move the no-libwacom test suite into its own stage

Easier to spot visually in the GUI that way

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

test: fix a few missing or wrong drag-lock timeouts

These had no consequences apart from occasional "system is too slow" messages,
because the test suite's shorter tap timeout is just barely long enough
for drag-lock, and/or because litest_assert_button_event waits for an event
anyway.

Signed-off-by: satrmb <10471-satrmb@users.noreply.gitlab.freedesktop.org>

touchpad: permit only one finger on the touchpad at the start of a tap-drag

This only affects the actual dragging part of the tap-and-drag interaction;
n-finger tap-and-drag is supposed to be performed with a n-finger tap
followed by a 1-finger drag.
Allowing a second finger in the middle of a drag is still necessary for a
finger swap, which users may need in long-distance drags, especially when
drag-lock is disabled.

Signed-off-by: satrmb <10471-satrmb@users.noreply.gitlab.freedesktop.org>

touchpad: stretch the tap-and-drag timeout a bit depending on finger count

Some users reported problems triggering multi-finger tap-and-drag,
with reliability decreasing as the finger count increased.
This is plausible because they may shift towards moving the whole hand
up and down, which obviously takes more time than just a finger.

Signed-off-by: satrmb <10471-satrmb@users.noreply.gitlab.freedesktop.org>

doc/user: generate the required package list for the CI distributions

Use yq to extract the package list from the CI configuration, then dump that
into the user docs. This provides the long-requested commands to install all
dependencies without the maintenance effort or risk of going stale.

Note that we are *not* building this in the CI, it's just not needed.

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

gitlab CI: add a job to make sure we're running all test suites

Only needs to run when meson.build or the CI script update

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

test: drop the custom group names

The group names are forced by check (they are called suite names there) but
for our test suite they provide very little benefit. Much easier to just
use the filename a test is in as group name.

This removes the pure substring match for --filter-group, it's now fnmatch
only. group names are short enough that the typing isn't an issue and we don't
want to run tests twice (e.g. 'pad' is also in 'touchpad').

This patch caused #574 until it got fixed in d838e3a3a4c

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

utils: add a trunkname() function to extract the trunk of a filename

/path/to/foo.bar returns "foo"

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

gitlab CI: make the test suite names a list

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

test: use motion events to check the "system is too slow" message

Using buttons for this test can trigger debounce warnings instead (in
addition?) to the warning we actually check for. Let's use motion events
instead and double the loop while we're at it so we have double the chance of
triggering at least one warning.

Fixes #574 for unknown reasons

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

test: wrap the litest user data into a struct

litest itself requires the libinput user_data to be set to its own context
struct (see close_restricted). A test that needs its own user_data must not
override this struct - if the context is accessed during libinput_dispatch()
we'll get memory corruption.

See #574

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

test: move a helper function close to its caller

This is a custom log function for one single test, let's move it next to that
test.

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

gitlab CI: run the scan-build analysis jobs in script

after_script ignores any exit status so we can't actually fail the job here

Fixes #573

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

tools/record: remove a useless assignment

It's overwritten a few lines south of here.

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

test: init an array to zero to silence scan-build

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

tools/record: add some curly braces

list_for_each is just a fancy for loop but it looks weird without braces.

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

tests: drop the duplicate test for pointer event conversion

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

test: don't set the log handler 10 times

Once is enough, we don't need to set it inside the loop.

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

gitlab CI: rename the VM stage "test-suite"

A much more sensible name than "vm"

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

totem: separate X/Y resolution from touch size in discriminator

Ref: https://gitlab.freedesktop.org/libinput/libinput/-/commit/bf4277623f7c24286b9f1e4b3ace51fbb5bb6a98#note_793589
Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>

totem: fix suspension-as-addition and resumption-as-removal in interface

Ref: https://gitlab.freedesktop.org/libinput/libinput/-/commit/bf4277623f7c24286b9f1e4b3ace51fbb5bb6a98#note_793592
Signed-off-by: Ahelenia Ziemiańska <nabijaczleweli@nabijaczleweli.xyz>

quirks: add pressure ranges for the Dell Latitude E5510 TouchPad

The default setting makes the "Dell Latitude E5510 TouchPad" too sensitive and
consequently difficult to use.

Note that the the size of the TouchPad is detected to be higher than it is
(the side-bars are half out of the TouchPad), see
https://github.com/systemd/systemd/pull/18493 for the hwdb overrides for this
device.

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

Create /etc/libinput on install

Users that need to create the local-overrides.quirks are sometimes hesitant to
do so because /etc/libinput doesn't exist by default. Let's create it on
install.

Related #568

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

touchpad: disable the pressure axes wherever the resolution is nonzero

The kernel/udev set the pressure resolution to nonzero to indicate the value
is in a known scale (units/g). We use that information to disable the
pressure axis on such devices - real pressure cannot be translated to
contact size.

For the kernel patch see:
https://www.spinics.net/lists/linux-input/msg71237.html

Fixes #569

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

test: don't require root to list tests

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

quirks: reword the requirements section in the quirks README

Change the wording from "these will fail" to "this must be followed" which is
easier to understand. And add the requirement for uppercase hex numbers as
enforced since c412924003b3154.

Related #568

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

doc/user: expand the explanations on how to submit a merge request

I keep answering this in bug reports, much easier to just have a link to
copy/paste.

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

doc/user: some whitespace fixes

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

quirks: improve the README

Make the headers valid markdown and reword/reformat a few other things
to make it clearer and easier to read.

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

libinput 1.16.901

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

Dell touchpad was too sensitive with default settings

The touchpad for the Dell Inspiron 15R N5110 was too sensitive with default settings, leading to excessive movement when lifting finger.

Fixes #565

Signed-off-by: Gary Wolfe <avidgamefan@yahoo.com>

tools: add a tool to analyze the finger count from a recording

Given a libinput recording, print the timestamps of any finger changes, i.e.
which slots are currently logically down. For example:

Timestamp | Rel time |     Slots     |
--------------------------------------
 0.000000 |  +0.000s | + |   |   |   |
 0.454631 |  +0.454s |   |   |   |   |
 5.065401 |  +4.610s | + |   |   |   |
 6.140281 |  +1.074s | + | + |   |   |
 7.410377 |  +1.270s |   | + |   |   |
 7.420200 |  +0.009s |   |   |   |   |
11.233108 |  +3.812s | + | + |   |   |
11.850206 |  +0.617s |   |   |   |   |
13.827740 |  +1.977s | + |   |   |   |
14.704027 |  +0.876s | + | + |   |   |
16.050577 |  +1.346s | + |   |   |   |
16.905186 |  +0.854s |   |   |   |   |

This data is available with the per-slot-delta tool but the output here is
more compressed, making it easier to detect stuck fingers. Pressure
thresholds are not currently supported.

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