Find a file
Peter Hutterer 9e37bc0cfa plugins: add support for lua plugins to change evdev event streams
This patch adds support for Lua scripts to modify evdev devices and
event frames before libinput sees those events.

Plugins in Lua are sandboxed and restricted in what they can do: no IO,
no network, not much of anything else.

A plugin is notified about a new device before libinput handles it and
it can thus modify that device (changes are passed through to our libevdev
context). A plugin can then also connect an evdev frame handler which
gives it access to the evdev frames before libinput processes them. The
example plugin included shows how to swap left/right mouse buttons:

    libinput:register({1})

    function frame(device, frame)
        for _, v in ipairs(frame.events) do
            if v.usage == evdev.BTN_RIGHT then
                v.usage = evdev.BTN_LEFT
            elseif v.usage == evdev.BTN_LEFT then
                v.usage = evdev.BTN_RIGHT
            end
        end
        return frame
    end

    function device_new(plugin, device)
        local usages = device:usages()
        if usages[evdev.BTN_LEFT] and usages[evdev.BTN_RIGHT] then
            device:connect("evdev-frame", frame)
        end
    end

    libinput:connect("new-evdev-device", device_new)

A few other example plugins are included in this patch

Part-of: <https://gitlab.freedesktop.org/libinput/libinput/-/merge_requests/1192>
2025-08-01 16:04:09 +10:00
.gitlab/issue_templates gitlab: make the bug template the default template 2023-11-23 09:53:09 +10:00
.gitlab-ci plugins: add support for lua plugins to change evdev event streams 2025-08-01 16:04:09 +10:00
completion/zsh Add a public plugin system to libinput 2025-08-01 15:38:39 +10:00
doc plugins: add support for lua plugins to change evdev event streams 2025-08-01 16:04:09 +10:00
include Remove trailing whitespaces in the tree 2022-11-25 10:08:20 +10:00
plugins plugins: add support for lua plugins to change evdev event streams 2025-08-01 16:04:09 +10:00
quirks plugins: restore the wheel plugin specifically for the MX Master 3 2025-07-10 01:33:24 +00:00
src plugins: add support for lua plugins to change evdev event streams 2025-08-01 16:04:09 +10:00
test plugins: add support for lua plugins to change evdev event streams 2025-08-01 16:04:09 +10:00
tools Add a public plugin system to libinput 2025-08-01 15:38:39 +10:00
udev meson.build: change from config.set10() and #if to config.set() and #ifdef 2025-07-28 12:04:09 +10:00
.clang-format clang-format: add litest_with_logcapture to foreach macros 2025-08-01 04:02:56 +00:00
.clang-format-ignore Add a clang-format file for consistent code formatting 2025-07-01 16:42:44 +10:00
.clang-tidy util: add various helper functions to use __attribute__(cleanup) 2025-04-16 17:04:58 +10:00
.clang-tidy-ignore Add a clang-tidy file 2025-04-07 08:43:36 +00:00
.dir-locals.el indentation: add .dir-locals.el for emacs 2018-02-26 18:44:00 +10:00
.editorconfig editorconfig: add settings for sym files 2024-11-04 10:31:30 +00:00
.git-blame-ignore-revs git: add git-blame-ignore-revs to ignore the clang-format commits 2025-07-02 12:43:13 +10:00
.gitignore gitignore: ignore gnuplot files 2018-05-10 16:25:40 +10:00
.gitlab-ci.yml plugins: add support for lua plugins to change evdev event streams 2025-08-01 16:04:09 +10:00
.pre-commit-config.yaml pre-commit: update the name for the ruff check 2025-07-15 16:24:27 +10:00
.triage-policies.yml triage-policies: update to handle a few more things in MRs as well 2025-02-03 09:16:02 +10:00
.vimdir Add .vimdir for libinput-specific settings 2015-05-25 09:17:29 +10:00
CODING_STYLE.md Drop the Signed-off-by requirement 2023-07-21 09:08:46 +10:00
CONTRIBUTING.md CONTRIBUTING: Add CONTRIBUTING.md 2024-02-28 17:07:45 +01:00
COPYING Change various references to the master branch to main 2021-04-29 01:31:03 +00:00
meson.build plugins: add support for lua plugins to change evdev event streams 2025-08-01 16:04:09 +10:00
meson_options.txt plugins: add support for lua plugins to change evdev event streams 2025-08-01 16:04:09 +10:00
README.md Change various references to the master branch to main 2021-04-29 01:31:03 +00:00

libinput

libinput is a library that provides a full input stack for display servers and other applications that need to handle input devices provided by the kernel.

libinput provides device detection, event handling and abstraction to minimize the amount of custom input code the user of libinput needs to provide the common set of functionality that users expect. Input event processing includes scaling touch coordinates, generating relative pointer events from touchpads, pointer acceleration, etc.

User documentation

Documentation explaining features available in libinput is available here.

This includes the FAQ and the instructions on reporting bugs.

Source code

The source code of libinput can be found at: https://gitlab.freedesktop.org/libinput/libinput

For a list of current and past releases visit: https://www.freedesktop.org/wiki/Software/libinput/

Build instructions: https://wayland.freedesktop.org/libinput/doc/latest/building.html

Reporting Bugs

Bugs can be filed on freedesktop.org GitLab: https://gitlab.freedesktop.org/libinput/libinput/issues/

Where possible, please provide the libinput record output of the input device and/or the event sequence in question.

See https://wayland.freedesktop.org/libinput/doc/latest/reporting-bugs.html for more info.

Documentation

Examples of how to use libinput are the debugging tools in the libinput repository. Developers are encouraged to look at those tools for a real-world (yet simple) example on how to use libinput.

License

libinput is licensed under the MIT license.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: [...]

See the COPYING file for the full license information.

About

Documentation generated from git commit GIT_VERSION