Wayland support (port Red Hat libei and libportal impl) (#7449)
* Add libei and libportal
* Port libei and libportal code by Peter Hutterer and Olivier Fourdan
* Add Peter Hutterer and Olivier Fourdan to important devs list
* Improve error handling for libei and libportal builds
* Checkout libportal tags/0.7.1
* Hack out the gi-docgen clone
* Remove new submodules in favor of using ExternalProject_Add
* Remove submodule dirs
* Use ExternalProject_Add instead of submodules
* Fixed namespace
* Hack to work around type libportal causing type conflicts
* Add log helper functions
* Use original log functions
* Switch to FetchContent, use libportal a1530a9 (unreleased) and use camelCase member names for consistency
* Restore a few events (much more work required)
* Add TODOs for supporting multiple lib versions
* Revert "Switch to FetchContent, use libportal a1530a9 (unreleased) and use camelCase member names for consistency"
This reverts commit 610cebb5b6a08282eee68f4424fcdbe9eaab4bf9.
* Simplify cmake config by removing builds for libei and libportal (will do this in `install_deps.py` instead)
* Remove submodules
* Remove .gitmodules
* Use meson to build subprojects
* Update copyright with Peter Hutterer's guidance
* Use meson for installing deps
* Fixed typo in tag name
* Remove submodules
* Remove old submodules
* Fixed libei name
* Defaults for pugixml and gtest depending on whether source exists in subprojects
* Ignore some subproject dirs
* Make deps OS-specific
* Move python deps to pyproject
* Only compile and install on Linux with Meson
* Revert "Move python deps to pyproject"
This reverts commit 92c8a287b8376a4d166058c85f1d6081f6fdb423.
* Add ninja to brewfile
* Add python3-attr
* Restore original coverage config
* Add ninja for meson
* Include meson in same try-except
* Fixed ninja dep name
* Move libs to correct oS
* Fixed include for wintoast
* Disable docs for libportal
* More options for libei and libportal
* Fixed option for libei
* Use ninja directly to install
* Revert "Use ninja directly to install"
This reverts commit c926d78ba483406a55acd10fb157c39e13f90b71.
* Meson install verbose
* Prints stdout/stderr
* Remove `from None`
* Remove submodules that somehow crept back in?!
* Prepend sudo if exists
* Add libei deps for all distros
* Fixed Fedora package name
* Add more deps for other distros
* Add more libs (including pugixml)
* Fix lib name
* Drop -u from pacman
* Add vala to rhel
* Make libportal optional
* Make portal link optional
* Remove example code
* Always use system pugixml
* Disable interactive apt through install_deps.py
* Revert "Disable interactive apt through install_deps.py"
This reverts commit 5bbc8fd689182447c79b81db16c961b98361a292.
* Set DEBIAN_FRONTEND in workflows
* Set DEBIAN_FRONTEND in CodeQL workflow
* Add gtest dep
* Add bundled libei dep
* Add libei dep to Arch
* Use `googletest` on openSUSE
* Add gmock dep
* Remove gtest dep from openSUSE
* Add libei on Fedora
* Bundle libei for older Linux distros
* Disable libei dep for RPM
* Also bundle symlink to .so
* Use ${CMAKE_INSTALL_LIBDIR}
* Rename libei to fix openSUSE
* List installed files
* Add libei-devel to openSUSE
* Add googletest-devel to openSUSE
* Remove manual deps (probably resolved automatically)
* Remove googletest from openSUSE (doesn't provide google mock)
* Only add Portal* if libportal found
* WIP - Partial work on using old events system :'(
* Add deps install commands for subprojects
* Solved more compile issues related to events system, threads, etc
* Fixed bad config for adding x, ei, portal sources
* Remove redundant deps
* Remove (another) redundant dep
* Fixed pacman command
* Add Ubuntu and Linux Mint libei deps
* Fixed Ubuntu and Linux Mint libei deps aliases
* Only iterate subprojects if not None
* Add rhel, rocky, and alma for libei
* Make rhel-like deps same as fedora again
* Build libportal on rhel-like
* Re-enable meson rhel-like for libportal
* Remove dbus-python
* Make libportal optional (for rhel-like)
* Handle ei event queue results
* Re-introduce libportal
* Print libei and libportal versions
* Add ei/portal args and client screen
* Switch --use args to --no
* Don't build libei/libportal on older distros as it's pointless
* Make libei and libportal optional
* Add Debian 13 runner
* Make some packages optional
* Remove subprojects
* Improve comment
* Add comment for libportal
* Improve comment
* Add Debian 13 runner
* Make optional... optional
* Change continuation stripper to remove newline and continuation char
* Make command strip more uniform
* Fixed help var syntax
* Fixed libei linking
* Ensure `kHelpNoWayland` is always defined
* Improve help message
* Fixed Debian 13 runner name
* Include sstream and use const var
* Update ChangeLog
* Remove Wayland block
* Return new timer
* Make tray icon logging verbose
* Fixed arg parser for wayland args
* Fixed init of EI screen
* Fixed lint issues
* Update README to indicate Wayland support in GNOME 46
* Add missing word
* Fixed comment positions
* Automate CI env
* Tone down debug log messages
* Add missing comma
* Remove redundant log line
This commit is contained in:
Nick Bolton
162
src/lib/platform/EiEventQueueBuffer.cpp
Normal file
162
src/lib/platform/EiEventQueueBuffer.cpp
Normal file
@ -0,0 +1,162 @@
|
||||
/*
|
||||
* synergy -- mouse and keyboard sharing utility
|
||||
* Copyright (C) 2022 Red Hat, Inc.
|
||||
* Copyright (C) 2024 Symless Ltd.
|
||||
*
|
||||
* This package is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU General Public License
|
||||
* found in the file LICENSE that should have accompanied this file.
|
||||
*
|
||||
* This package is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
#include "platform/EiEventQueueBuffer.h"
|
||||
|
||||
#include "base/Event.h"
|
||||
#include "base/EventTypes.h"
|
||||
#include "base/IEventQueue.h"
|
||||
#include "base/Log.h"
|
||||
#include "mt/Thread.h"
|
||||
|
||||
#include <cassert>
|
||||
#include <cstdio>
|
||||
#include <fcntl.h>
|
||||
#include <poll.h>
|
||||
#include <unistd.h>
|
||||
|
||||
class EventQueueTimer {};
|
||||
|
||||
namespace synergy {
|
||||
|
||||
EiEventQueueBuffer::EiEventQueueBuffer(
|
||||
EiScreen *screen, ei *ei, IEventQueue *events)
|
||||
: ei_(ei_ref(ei)),
|
||||
events_(events) {
|
||||
// We need a pipe to signal ourselves when addEvent() is called
|
||||
int pipefd[2];
|
||||
int result = pipe(pipefd);
|
||||
assert(result == 0);
|
||||
|
||||
int pipeflags;
|
||||
pipeflags = fcntl(pipefd[0], F_GETFL);
|
||||
fcntl(pipefd[0], F_SETFL, pipeflags | O_NONBLOCK);
|
||||
pipeflags = fcntl(pipefd[1], F_GETFL);
|
||||
fcntl(pipefd[1], F_SETFL, pipeflags | O_NONBLOCK);
|
||||
|
||||
pipe_r_ = pipefd[0];
|
||||
pipe_w_ = pipefd[1];
|
||||
}
|
||||
|
||||
EiEventQueueBuffer::~EiEventQueueBuffer() {
|
||||
ei_unref(ei_);
|
||||
close(pipe_r_);
|
||||
close(pipe_w_);
|
||||
}
|
||||
|
||||
void EiEventQueueBuffer::waitForEvent(double timeout_in_ms) {
|
||||
Thread::testCancel();
|
||||
|
||||
enum {
|
||||
EIFD,
|
||||
PIPEFD,
|
||||
POLLFD_COUNT, // Last element
|
||||
};
|
||||
|
||||
struct pollfd pfds[POLLFD_COUNT];
|
||||
pfds[EIFD].fd = ei_get_fd(ei_);
|
||||
pfds[EIFD].events = POLLIN;
|
||||
pfds[PIPEFD].fd = pipe_r_;
|
||||
pfds[PIPEFD].events = POLLIN;
|
||||
|
||||
int timeout =
|
||||
(timeout_in_ms < 0.0) ? -1 : static_cast<int>(1000.0 * timeout_in_ms);
|
||||
|
||||
int retval = poll(pfds, POLLFD_COUNT, timeout);
|
||||
if (retval > 0) {
|
||||
if (pfds[EIFD].revents & POLLIN) {
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
|
||||
// libei doesn't allow ei_event_ref() because events are
|
||||
// supposed to be short-lived only. So instead, we create an NULL-data
|
||||
// kSystemEvent whenever there's data on the fd, shove that event
|
||||
// into our event queue and once we process the event (see
|
||||
// getEvent()), the EiScreen will call ei_dispatch() and process
|
||||
// all actual pending ei events. In theory this means that a
|
||||
// flood of ei events could starve the events added with
|
||||
// addEvents() but let's hope it doesn't come to that.
|
||||
queue_.push({true, 0U});
|
||||
}
|
||||
// the pipefd data doesn't matter, it only exists to wake up the thread
|
||||
// and potentially testCancel
|
||||
if (pfds[PIPEFD].revents & POLLIN) {
|
||||
char buf[64];
|
||||
auto result = read(pipe_r_, buf, sizeof(buf)); // discard
|
||||
LOG_DEBUG("event queue read result: %d", result);
|
||||
}
|
||||
}
|
||||
Thread::testCancel();
|
||||
}
|
||||
|
||||
IEventQueueBuffer::Type
|
||||
EiEventQueueBuffer::getEvent(Event &event, uint32_t &dataID) {
|
||||
// the addEvent/getEvent pair is a bit awkward for libei.
|
||||
//
|
||||
// it assumes that there's a nice queue of events sitting there that we can
|
||||
// just append to and get everything back out in the same order. We *could*
|
||||
// emulate that by taking the libei events immediately out of the event
|
||||
// queue after dispatch (see above) and putting it into the event queue,
|
||||
// intermixed with whatever addEvents() did.
|
||||
//
|
||||
// But this makes locking more awkward and libei isn't really designed to
|
||||
// keep calling ei_dispatch() while we hold a bunch of event refs. So instead
|
||||
// we just have a "something happened" event on the ei fd and the rest is
|
||||
// handled by the EiScreen.
|
||||
//
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
auto pair = queue_.front();
|
||||
queue_.pop();
|
||||
|
||||
// if this an injected special event, just return the data and exit
|
||||
if (pair.first == false) {
|
||||
dataID = pair.second;
|
||||
return kUser;
|
||||
}
|
||||
|
||||
event = Event(Event::kSystem, events_->getSystemTarget());
|
||||
|
||||
return kSystem;
|
||||
}
|
||||
|
||||
bool EiEventQueueBuffer::addEvent(uint32_t dataID) {
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
queue_.push({false, dataID});
|
||||
|
||||
// tickle the pipe so our read thread wakes up
|
||||
auto result = write(pipe_w_, "!", 1);
|
||||
LOG_DEBUG("event queue write result: %d", result);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
bool EiEventQueueBuffer::isEmpty() const {
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
|
||||
return queue_.empty();
|
||||
}
|
||||
|
||||
EventQueueTimer *
|
||||
EiEventQueueBuffer::newTimer(double duration, bool oneShot) const {
|
||||
return new EventQueueTimer;
|
||||
}
|
||||
|
||||
void EiEventQueueBuffer::deleteTimer(EventQueueTimer *timer) const {
|
||||
delete timer;
|
||||
}
|
||||
|
||||
} // namespace synergy
|
||||
Reference in New Issue
Block a user