test: add helper functions for checking proximity events

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

test: add a comment to a test device

Just so I don't have to look up the git history next time

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

tools: record: record the EV_ABS deltas along with the absolute value

It's useful to have this in the immediate recording. Example output now:

 - evdev:
    - [  2, 300309,   3,  47,       0] # EV_ABS / ABS_MT_SLOT               0
    - [  2, 300309,   3,  54,    3547] # EV_ABS / ABS_MT_POSITION_Y      3547 (+8)
    - [  2, 300309,   3,  58,      70] # EV_ABS / ABS_MT_PRESSURE          70 (-14)
    - [  2, 300309,   3,  47,       1] # EV_ABS / ABS_MT_SLOT               1
    - [  2, 300309,   3,  54,    3112] # EV_ABS / ABS_MT_POSITION_Y      3112 (+4)
    - [  2, 300309,   3,  58,      68] # EV_ABS / ABS_MT_PRESSURE          68 (-4)
    - [  2, 300309,   3,   1,    3547] # EV_ABS / ABS_Y                  3547 (+8)
    - [  2, 300309,   3,  24,      70] # EV_ABS / ABS_PRESSURE             70 (-14)
    - [  2, 300309,   0,   0,       0] # ------------ SYN_REPORT (0) ---------- +49ms

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

tools: fix typo in debug-events man page

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

timer: make the timer offset error a bit more user-friendly

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

tools: record: fix broken event time stamp recording

event->time ended up being an uninitialized field. Introduced in 5dc1a7e, the
event here isn't a struct input event but rather our internal event struct.
Fix this and reshuffle the time handling a bit so it's a bit more obvious
here.

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

tools: record: wrap the time offset handling into a helper function

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

tools: refuse to replay recordings with timestamps from the future

This indicates a bug in libinput record, might as well complain about it.

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

tools: align the tool type names on proximity nicely

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

doc/user: Fix grammar.

Signed-off-by: Jacob Kauffmann <jacob@system76.com>

touchpad: correct a wrong slot count by the kernel

alps.c hardcodes 5 slots in the kernel but some devices only provide 2 slots
plus BTN_TOOL_TRIPLETAP, etc. Fix this by counting active slots and when the
fake finger count exceeds the active slots but is still less than the number
of slots, adjust the slots themselves downwards.

And because the new test device messes with our slot count assumptions for the
various tests hardcode that one device to return 2 slots.

Fixes #408

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

test: make the custom touch override methods filter-able

Let those functions return true if they handled the event or false where they
didn't. This makes it more flexible to override touches in special cases only
and fall back to the normal litest handling otherwise.

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

test: wrap slot counting into a helper function

This is prep work for future devices that announce a wrong slot count. For the
tests this can be a problem if we rely on the correct slot count to decided
whether to run a test or not.

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

Improve git commit section

It wasn't clear about the Signed-of-by requirements, so this has been
improved with an example, and clarifies that it is a requirement, not
optional.

Signed-off-by: William Brown <william@blackhats.net.au>

Small improvements to contributing for accessibility.

This makes a small number of changes that can help improve onboarding
and diversity of contributors. Key to point out is that the code of
conduct is now one of the first items, to highlight the community
standards (rather than being at the bottom where it can be
overlooked). The use of the work "hack" often is off putting to
many people, so replaced with "work". Additionally, changed
the introduction to highlight a desire to be inclusive.

A follow up you probably could do, is have a "how to prepare the
development environment" aka "what depenedencies do I need for
my distro to build the project.

Much of this has come from experience working with outreach/diversity
experts, and my own experience on

http://www.port389.org/docs/389ds/contributing.html

Signed-off-by: William Brown <william@blackhats.net.au>

doc/user: explain the gitlab issue tags

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

doc/user: some minor improvements

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

evdev-fallback: Use input_event_init for fallback

Old-style field initialisation ignores the 64-bit time_t change in
Linux UAPI, which causes the structure to be incompletely initialised
on 32-bit systems with the 64-bit time_t kernel headers.

This patch uses the input_event_init helper from the original 64-bit
time_t enablement patch.

Signed-off-by: A. Wilcox <AWilcox@Wilcox-Tech.com>
Fixes: 5dc1a7ebd ("Adjust for 64bit time_t for 32bit architectures")
See-Also: libinput/libinput!346

gitlab CI: retry the VM jobs on script failure

Unfortunately the various VM jobs are timing sensitive and create a bunch of
false positives if the runners are under load and miss out on some of the
events (the tablet proximity handling is a particularly bad test here).
Let's retry on failure first to give the CI more opportunity to maybe succeed.

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

doc/user: expand the contributing document and make it top-level

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

tools: fix abort caused by the pointing stick integration quirk

See #400

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

test: switch from counting slot max to num_slots

Much more human-readable this way

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

test: simplify a slot count check

Smaller than 3 and greater or equal to 4 means - well, anything that's not 3.

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

test: fix some wrong touchpad slot range checks

This was excluding tests from some touchpads due to slot count confusion.

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

litest: Fix warnings about discarded qualifiers with check-0.13.0

check 0.13.0 introduced a new struct type TTest for test functions
instead of just a function. However, now the tcase_add_* functions use
`const Ttest *`, and since litest stores the test case in a `void *`,
we get warnings like the following:

../test/test-touchpad.c:7079:30: warning: passing argument 3 of '_litest_add' discards 'const' qualifier from pointer target type [-Wdiscarded-qualifiers]
  litest_add("touchpad:fuzz", touchpad_fuzz, LITEST_TOUCHPAD, LITEST_ANY);

To fix this, use `const void *`, which is compatible with both APIs.

Signed-off-by: Michael Forney <mforney@mforney.org>

libinput 1.15.0

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

test: indentation fix

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

test: add the test cases to the suite in the utils tests

oops...

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

doc/user: fix some HTML formatting

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

quirks: fix horizontal scrolling for Logitech MX Master 2S on bluetooth

It turns out that the MX Master 2S also has a different PID when connected
via bluetooth, causing horizontal scrolling to not work properly. Fix this,
by also adding it with the blueetooth PID (according to
https://github.com/libratbag/libratbag/blob/master/data/devices/logitech-MX-Master-2S.device
and in line with local testing) to the quirks file.

Signed-off-by: Björn Daase <bjoern@daase.net>

meson.build: re-add missing trailing slash to the HTTP link

Got lost in 61f81ec93e7ddfae79ce3d1e8069bfce97c6d6aa

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

gitlab CI: update to latest ci-templates

Rebuild all the images to make sure this still works fine.

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

quirks: ignore mode switch button on Madcatz R.A.T.3 mouse

Avoid stuck buttons, so window managers won't behave buggy, for example:
* You click on one window, but click is emulated in another one
* You hover cursor over button/link but see no feedback
Based on quirk for Cyborg mouse.

Signed-off-by: Anatolii Lishchynskyi <iamnotacake@protonmail.com>

gitlab CI: fix skopeo copy

skopeo doesn't handle the destination credentials correctly

See ci-templates commit 0a9bdd33a98f05af6761ab118b5074952242aab0

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

gitlab CI: use a minimal alpine image for the commit checks

This runs at the same time as the other images being created so it'll fail if
the image itself doesn't exist yet. Since we only need pip here, let's use
alpine and install the two packages we need.

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

libinput 1.14.901

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

gitlab CI: add an explanatory comment why we're hardcoding master

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

gitlab CI: add a local emulation mode to the gitlab CI script

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

gitlab CI: make the commit check errors more verbose and useful

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

gitlab CI: don't try adding the upstream remote if it exists already

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

Expand the CODING_STYLE with an explanation of commit requirements

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

pad: add LIBINPUT_EVENT_TABLET_PAD_KEY for pad keys

The Wacom Cintiq 24HD and later tablets send specific key events for
hardware/soft buttons. KEY_PROG1..KEY_PROG3 on earlier tablets,
KEY_CONTROLPANEL, KEY_ONSCREEN_DISPLAY, and KEY_BUTTONCONFIG on later tablets.
We ignore KEY_PROG1-3 because starting with kernel 5.4 older tablets will too
use the better-named #defines.

These differ from pad buttons as the key code in itself carries semantic
information, so we should pass them on as-is instead of mapping them to
meaningless 0-indexed buttons like we do on the other buttons.

So let's add a new event, LIBINPUT_EVENT_TABLET_PAD_KEY and the associated
functions to handle that case.

Pad keys have a fixed hw-defined semantic meaning and are thus not part of
a tablet mode group.

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

pad: switch the button mapping to one that can handle keys or buttons

No functional changes, we still use the same bits everywhere.

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

tools: debug-events: don't overrun the device array with too many arguments

Only the --device option was checked for argument count, not the rest so it's
easy to overrun the array by specifying too many devices.

Except: this was a theoretical bug only, more than 64 arguments trigger
an assertion in the argv processing in tools/shared.c anyway. Let's drop the
debug-events limit to 60 devices so we can at least have a test for this.

Found by coverity

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

gitlab CI: run the meson script for the VMs as well

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

gitlab CI: move the build instructions into a bash file

Extending/debugging scripts in the gitlab CI directly is a pain, the
turnaround cycle is terrible. Let's move this into a shellscript that we can
just call directly.

Bonus side-effect: if we wanted to extend the script: set somewhere, this is
now much easier to override.

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

gitlab CI: add meson to junit script

This script was written by Emmanuele Bassi, copied from
https://gist.github.com/ebassi/e5296ec77ae9e0d3a33fd483b5613b09/

It converts meson test results into a junit file which we can then use to
display in the merge request GUI.

Note that as litest writes out junit files as well, some tests are reported
twice. Specifically: where litest fails the failure will be reported once
through litest itself and once by meson test. Oh well.

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

test: write our test case results out as junit xml files

libcheck has the ability to write out XML files for test results, but
converting those into junit isn't ideal, for a number of reasons:
- junit xml is different to libcheck's xml, so not all data is available or
  useful. Especially with our litest wrappers around it.
- litest forking off tests means we have to wrap around everything anyway to
  avoid multiple forks writing to the same test file.

This is the minimal implementation since it's only user is likely the CI which
we control fairly tightly. So there are a few corners we can skip:
- no filename validation is performed by litest
- we write out a lot of junit xml files (one per litest fork). Rather than
  collating those we just rely on the CI to find the files.

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

gitlab CI: apply some basic validity checks on the commit messages

Let's stop merge requests from users that don't set their git author name and
email address. Aside from it looking stange in the history it'll also make it
virtually impossible to ever find that user again should something important
arise in the future - especially if we switch off gitlab.

The rest is basic style, short subject lines, Signed-off-by lines and correct
formatting.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
[bentiss: use /usr/bin/env python3 as requested by the CI]
Signed-off-by: Benjamin Tissoires <benjamin.tissoires@gmail.com>

gitlab CI: rename the container_prep state to just "prep"

So we can shove other stuff in there without it looking strange.

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

gitlab CI: use multiple extends for the default artifact/build snippets

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

gitlab CI: use multiple extends over anchors for the upstream pull

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

gitlab CI: add a global policy snippet for retries and interruptible

We want to retry if we have a system/timeout/stuck failure. And our jobs are
all interruptible, we want to cancel them when the branch has new commits.

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

gitlab CI: split all extends into multiple lines

No functional changes, this merely prepares the file for easier multiple
extends.

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

tools: print the libinput version in debug-events

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

tools: libinput-record: drop the explicit --multiple argument

If we want to record multiple events, let's just specify multiple event nodes.
No need for a specific extra argument here.

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

tools: libinput-record: return the correct exit value on invalid usage

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

tools: libinput-record: bail out on invalid commandline arguments

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

tools: print stderr/stdout when a option test fails

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

Adjust for 64bit time_t for 32bit architectures

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

touchpad: simplify tapping state machine by eliminating the multitap states
Alternating between TAPPED and DRAGGING_OR_MULTITAP on repeated taps is enough, no need for more states.

test: fix a multitap test expecting one tap too few
The problem was masked by a missing timeout, causing one up / down pair to not yet be enqueued before reading the queue.

tools: make debug-events accept multiple device nodes

For interaction between devices it's necessary to look at more than one device
at a time.

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

tools: replay: fix wrong timestamps for multiple device replay

When multiple devices are recorded, the event times are offset from a global
baseline. Each device thus has a different offset for the first event. To
replay correctly, we must figure out the offset of the first event (across all
devices) and use that for all of them.

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

Add Palm&ThumbPressureThreshold for the Spectre x360 15-ch0xx

Without this palm rejection doesn't work properly, making typing pretty
annoying.

completion: add the new libinput debug-tablet to the zsh completion files

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

tools: print the tip state in the tablet debugging tool

tools: add stylus button support

For the evdev events only a few hand-selected ones, all other ones are ignored
for now.

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

tools: add a tablet debugging tool

Nothing sophisticated but easier to debug certain tablet oddities.
It shows a bar for each axis on the tablet (and the evdev axis) and prints
that relative to the axis range. This makes it easy to check if we do hit the
full range (especially for distance/pressure/tilt) and whether that matches
with what the device gives us.

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

tools: debug-events: expand timestamp prints to full millis

Tens of millis is not quite enough in some cases.

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

tools: debug-events: offset timestamps by the first normal event

Start counting the timestamps from the first time we get something off the
actual fd. This makes it easier to match up timestamps with the output from
libinput record.

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

tools: libinput-record: expand the evdev event value to 7 digits

MSC_TIMESTAMPS need 7 digits so let's make sure everything is nicely aligned

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

doc: remove the direct link to the various state diagrams

draw.io is playing up with old files and sending me into a redirect loop.
Duplicating files works but that changes the links. So to avoid dead links,
let's just remove the direct link and let anyone who cares enough about it ask
me.

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

test: allow for substring matching in the various --filter- arguments

A unique substring of a test/group/device should be enough to filter, even
without surrounding it with asterisks.

This allows for things like --filter-device=t440 as opposed to the previous
--filter-device="*t440*".

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

doc: updates to the tap state machine

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

touchpad: don't allow for multifinger tapping after a move

In the current implementation, movements > threshold and timeouts usually move
to HOLD state and continue from there. Where a finger is lifted, we go back
up the diagram into the previous finger count's HOLD state.

The side-effect of this is that a tap of a finger can be counted as tap even
after a movement:

- two fingers down, move to scroll, hold down
- third finger down, third finger up

This sequence triggers an erroneous three-finger tap. Once the motion
threshold is hit by any touch, no finger must trigger 2/3 finger tap events
while any touch is down.

The false tap is only triggered where the new finger can execute a tap without
any other finger changing any property. This can be triggered on the
reporter's Dell Precision 5520 but on most other touchpads, a new finger down
will trigger slight movement, pressure or touch size updates and thus the bug
cannot be triggered.

Fixes #382

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

test: fix a pressure test to movement during tap

The motion event here was intended to offset the light pressure from the
extended touch down. This also causes motion past the tap threshold and won't
work with a future patch.

Make the touch "real" by simply plaing a normal movement in the current
position - the kernel will filter and we'll just update the pressure.

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

Fix typo in zsh completion

meson.build: drop the explicit -g flag

Let's rely on meson to set this for us.

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

gitlab CI: work around collapsed multiline commands in the rebuild check

Multiline commands are currently collapsed with no way of uncollapsing them
(https://gitlab.com/gitlab-org/gitlab-runner/issues/3392), so we never see the
skopeo invocations. Work around this by touching a file when scheduled and
using that to break up the conditions.

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

gitlab CI: allow the qemu-prep job to fail, runners are unreliable

The qemu jobs themselves already have this tag so let's add it to the
container prep itself too. Unfortunately the CI doesn't have a conditional
allow-failure (ideally we want retry's stuck_or_timeout_failure condition).

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

test: remove the hardcoded four-job valgrind test run

Make this dependent on the number of processes too.

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

test: drop a now-obsolete test

As of d20bbfa5cb56e8bc we handle the direct tool switch correctly so there's
no more warning. Which means testing for the warning is pointless.

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

gitlab CI: add diffutils to the Fedora RPMs

Needed for the symbols leak test.

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

tablet: handle a direct tool switch correctly

Fixes #259

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

tablet: add a helper function to get the current tool

No functional changes.

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

tools: debug-gui: show pressure/distance as vertical bar

Both of these are normalized so let's draw a bar that shows the values
accordingly. This makes it a lot easier to check whether pressure values go to
the maximum, etc.

A little extra square is shown whenever the tip is logically down.

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

gitlab CI: split the qemu test runs up into multiple jobs

The tests are split by topic but have varying runtime. Specifically, the
longest test (touchpad) takes ~170s whereas many of the others can take less
than a second. Splitting them all up into separate VMs costs too much in
startup time so here's the middle ground of some custom grouping to make the
tests roughly run the same time.

This list will need to be manually maintained but given that groups are rarely
added anyway this shouldn't be too much of a maintenance burden. And bonus:
since the kvm tests often fail due to timing issues, re-running one is
significantly faster now.

This shaves about 8min of the CI run

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

gitlab CI: fix an indentation issue

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

test: remove a useless assignment

copy/paste error that makes coverity unhappy. This is the code to correctly
release all touches and the buttons have already been processed above - no
need to reassign here.

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

test: silence a coverity warning

Coverity complains that we call libinput_event_destroy() twice on the variable
(once in and once just outside the condition). This is technically correct but
never true because we always break the loop early for the touch up/frame events.
Let's just reset the pointers so coverity is happy.

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

test: remove some useless code triggering a coverity warning

x/y assigned but never used. Dropping those few lines gets rid of the warning
and checks the coordinates correctly now too.

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

tools: drop the specific libinput measure tools from the libinput man page

libinput measure lists them all anyway.

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

tools: correct libinput measure reference to the tap man page

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

test: make the test jobs dependent on the number of processors

Let's hope the test suite is more successful on puny VMs that way.

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

libinput-list-devices: make paragraph about different settings terser

Changes are:

1. "configuration options" is same as "options"
2. The clarification "e.g. scrolling" doesn't clarify anything because a
user don't necessarily knows there're "2-finger scroll" and
"edge-scroll"; and even if they do, they can imagine the settings to be
represented by "0" and "1" values, which then begs a question: why
aren't all "Enabled/Disabled" settings are prefixed with "*" too.
   Instead, replace the vague `multiple different settings` with more
specific `more settings than "enabled/disabled"`.
3. "ones" is shorter than "settings" and makes sure a user haven't lost
context.

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

libinput-list-devices: be more explicit about only listing defaults

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

quirks: add RollerMouse Free 3 for double-click fix

gitlab CI: switch to Ubuntu 19.10

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

gitlab CI: switch to Fedora 31

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