Revision control
Copy as Markdown
// Copyright (C) 2016 The Qt Company Ltd.
// Copyright (C) 2024 Jie Liu <liujie01@kylinos.cn>
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
#ifndef QWAYLANDDISPLAY_H
#define QWAYLANDDISPLAY_H
//
// W A R N I N G
// -------------
//
// This file is not part of the Qt API. It exists purely as an
// implementation detail. This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
#include <QtCore/QList>
#include <QtCore/QObject>
#include <QtCore/QPointer>
#include <QtCore/QRect>
#include <QtCore/QMutex>
#include <QtCore/QReadWriteLock>
#include <QtCore/QWaitCondition>
#include <QtCore/QLoggingCategory>
#include <QtWaylandClient/private/qwayland-wayland.h>
#include <QtWaylandClient/private/qtwaylandclientglobal_p.h>
#include <QtWaylandClient/private/qwaylandshm_p.h>
#include <qpa/qplatforminputcontextfactory_p.h>
#if QT_CONFIG(xkbcommon)
#include <QtGui/private/qxkbcommon_p.h>
#endif
#include <memory>
struct wl_cursor_image;
struct wp_viewport;
QT_BEGIN_NAMESPACE
#define WAYLAND_IM_KEY "wayland"
class QAbstractEventDispatcher;
class QSocketNotifier;
class QPlatformScreen;
class QPlatformPlaceholderScreen;
namespace QtWayland {
class zwp_text_input_manager_v1;
class zwp_text_input_manager_v2;
class zwp_text_input_manager_v3;
class qt_text_input_method_manager_v1;
class wp_cursor_shape_manager_v1;
class wp_fractional_scale_manager_v1;
class wp_viewporter;
class xdg_session_manager_v1;
class xdg_system_bell_v1;
class xdg_toplevel_drag_manager_v1;
class wp_pointer_warp_v1;
class xx_cutouts_manager_v1;
}
namespace QtWaylandClient {
QT_DECLARE_EXPORTED_QT_LOGGING_CATEGORY(lcQpaWayland, Q_WAYLANDCLIENT_EXPORT);
class QWaylandAppMenuManager;
class QWaylandInputDevice;
class QWaylandBuffer;
class QWaylandScreen;
class QWaylandXdgOutputManagerV1;
class QWaylandClientBufferIntegration;
class QWaylandWindowManagerIntegration;
class QWaylandDataDeviceManager;
#if QT_CONFIG(clipboard)
class QWaylandDataControlManagerV1;
#endif
#if QT_CONFIG(wayland_client_primary_selection)
class QWaylandPrimarySelectionDeviceManagerV1;
#endif
#if QT_CONFIG(tabletevent)
class QWaylandTabletManagerV2;
#endif
class QWaylandPointerGestures;
class QWaylandWindow;
class QWaylandIntegration;
class QWaylandHardwareIntegration;
class QWaylandSessionManager;
class QWaylandSurface;
class QWaylandShellIntegration;
class QWaylandCursor;
class QWaylandCursorTheme;
class EventThread;
class ColorManager;
typedef void (*RegistryListener)(void *data,
struct wl_registry *registry,
uint32_t id,
const QString &interface,
uint32_t version);
class Q_WAYLANDCLIENT_EXPORT QWaylandDisplay : public QObject, public QtWayland::wl_registry {
Q_OBJECT
public:
QWaylandDisplay(QWaylandIntegration *waylandIntegration, QObject *parent = nullptr);
~QWaylandDisplay(void) override;
bool initialize();
#if QT_CONFIG(xkbcommon)
struct xkb_context *xkbContext() const { return mXkbContext.get(); }
#endif
QList<QWaylandScreen *> screens() const { return mScreens; }
QPlatformPlaceholderScreen *placeholderScreen() const { return mPlaceholderScreen; }
void ensureScreen();
QWaylandScreen *screenForOutput(struct wl_output *output) const;
void handleScreenInitialized(QWaylandScreen *screen);
struct wl_surface *createSurface(void *handle);
struct ::wl_region *createRegion(const QRegion &qregion);
struct ::wl_subsurface *createSubSurface(QWaylandWindow *window, QWaylandWindow *parent);
struct ::wp_viewport *createViewport(QWaylandWindow *window);
QWaylandShellIntegration *shellIntegration() const;
QWaylandClientBufferIntegration *clientBufferIntegration() const;
QWaylandWindowManagerIntegration *windowManagerIntegration() const;
#if QT_CONFIG(cursor)
QWaylandCursor *waylandCursor();
QWaylandCursorTheme *loadCursorTheme(const QString &name, int pixelSize);
#endif
struct wl_display *wl_display() const
{
return mDisplay;
}
struct ::wl_registry *wl_registry() { return object(); }
QtWayland::wl_compositor *compositor()
{
return mGlobals.compositor.get();
}
QList<QWaylandInputDevice *> inputDevices() const { return mInputDevices; }
QWaylandInputDevice *defaultInputDevice() const;
QWaylandInputDevice *currentInputDevice() const { return defaultInputDevice(); }
#if QT_CONFIG(wayland_datadevice)
QWaylandDataDeviceManager *dndSelectionHandler() const
{
return mGlobals.dndSelectionHandler.get();
}
#endif
#if QT_CONFIG(clipboard)
QWaylandDataControlManagerV1 *dataControlManager() const
{
return mGlobals.dataControlManager.get();
}
#endif
#if QT_CONFIG(wayland_client_primary_selection)
QWaylandPrimarySelectionDeviceManagerV1 *primarySelectionManager() const
{
return mGlobals.primarySelectionManager.get();
}
#endif
#if QT_CONFIG(tabletevent)
QWaylandTabletManagerV2 *tabletManager() const
{
return mGlobals.tabletManager.get();
}
#endif
QWaylandPointerGestures *pointerGestures() const
{
return mGlobals.pointerGestures.get();
}
QtWayland::qt_text_input_method_manager_v1 *textInputMethodManager() const
{
return mGlobals.textInputMethodManager.get();
}
QtWayland::zwp_text_input_manager_v1 *textInputManagerv1() const
{
return mGlobals.textInputManagerv1.get();
}
QtWayland::zwp_text_input_manager_v2 *textInputManagerv2() const
{
return mGlobals.textInputManagerv2.get();
}
QtWayland::zwp_text_input_manager_v3 *textInputManagerv3() const
{
return mGlobals.textInputManagerv3.get();
}
QWaylandHardwareIntegration *hardwareIntegration() const
{
return mGlobals.hardwareIntegration.get();
}
QWaylandXdgOutputManagerV1 *xdgOutputManager() const
{
return mGlobals.xdgOutputManager.get();
}
QtWayland::wp_fractional_scale_manager_v1 *fractionalScaleManager() const
{
return mGlobals.fractionalScaleManager.get();
}
QtWayland::wp_viewporter *viewporter() const
{
return mGlobals.viewporter.get();
}
QtWayland::wp_cursor_shape_manager_v1 *cursorShapeManager() const
{
return mGlobals.cursorShapeManager.get();
}
QtWayland::xdg_toplevel_drag_manager_v1 *xdgToplevelDragManager() const
{
return mGlobals.xdgToplevelDragManager.get();
}
QtWayland::xdg_session_manager_v1 *xdgSessionManager() const
{
return mGlobals.xdgSessionManager.get();
}
QtWayland::xdg_system_bell_v1 *systemBell() const
{
return mGlobals.systemBell.get();
}
QWaylandAppMenuManager *appMenuManager() const
{
return mGlobals.appMenuManager.get();
}
ColorManager *colorManager() const
{
return mGlobals.colorManager.get();
}
QtWayland::wp_pointer_warp_v1 *pointerWarp() const
{
return mGlobals.pointerWarp.get();
}
QtWayland::xx_cutouts_manager_v1 *cutoutsManager() const
{
return mGlobals.cutoutManager.get();
}
struct RegistryGlobal {
uint32_t id;
QString interface;
uint32_t version;
struct ::wl_registry *registry = nullptr;
RegistryGlobal(uint32_t id_, const QString &interface_, uint32_t version_, struct ::wl_registry *registry_)
: id(id_), interface(interface_), version(version_), registry(registry_) { }
};
QList<RegistryGlobal> globals() const
{
return mRegistryGlobals;
}
bool hasRegistryGlobal(QStringView interfaceName) const;
/* wl_registry_add_listener does not add but rather sets a listener, so this function is used
* to enable many listeners at once. */
void addRegistryListener(RegistryListener listener, void *data);
void removeListener(RegistryListener listener, void *data);
QWaylandShm *shm() const
{
return mGlobals.shm.get();
}
void forceRoundTrip();
bool supportsWindowDecoration() const;
uint32_t lastInputSerial() const { return mLastInputSerial; }
QWaylandInputDevice *lastInputDevice() const { return mLastInputDevice; }
QWaylandWindow *lastInputWindow() const;
QWaylandSurface *lastInputSurface() const;
void setLastInputDevice(QWaylandInputDevice *device, uint32_t serial, QWaylandSurface *window);
bool isWindowActivated(const QWaylandWindow *window);
void handleWindowActivated(QWaylandWindow *window);
void handleWindowDeactivated(QWaylandWindow *window);
void handleKeyboardFocusChanged(QWaylandInputDevice *inputDevice);
void handleWindowDestroyed(QWaylandWindow *window);
wl_event_queue *frameEventQueue() { return m_frameEventQueue; };
bool isKeyboardAvailable() const;
bool isWaylandInputContextRequested() const;
void initEventThread();
QWaylandWindow *activeSubSurface() const;
void setActiveSubSurface(QWaylandWindow *window);
public Q_SLOTS:
void flushRequests();
Q_SIGNALS:
void connected();
void globalAdded(const RegistryGlobal &global);
void globalRemoved(const RegistryGlobal &global);
private:
void checkWaylandError();
void reconnect();
void setupConnection();
void handleWaylandSync();
void requestWaylandSync();
void checkTextInputProtocol();
struct Listener {
Listener() = default;
Listener(RegistryListener incomingListener,
void* incomingData)
: listener(incomingListener), data(incomingData)
{}
RegistryListener listener = nullptr;
void *data = nullptr;
};
struct wl_display *mDisplay = nullptr;
std::unique_ptr<QtWayland::wl_fixes> mFixes;
std::unique_ptr<EventThread> m_eventThread;
wl_event_queue *m_frameEventQueue = nullptr;
std::unique_ptr<EventThread> m_frameEventQueueThread;
QList<QWaylandScreen *> mWaitingScreens;
QList<QWaylandScreen *> mScreens;
QPlatformPlaceholderScreen *mPlaceholderScreen = nullptr;
QList<QWaylandInputDevice *> mInputDevices;
QList<Listener> mRegistryListeners;
QWaylandIntegration *mWaylandIntegration = nullptr;
#if QT_CONFIG(cursor)
struct WaylandCursorTheme {
QString name;
int pixelSize = 0;
std::unique_ptr<QWaylandCursorTheme> theme;
};
std::vector<WaylandCursorTheme> mCursorThemes;
struct FindExistingCursorThemeResult {
std::vector<WaylandCursorTheme>::const_iterator position;
bool found = false;
QWaylandCursorTheme *theme() const noexcept
{ return found ? position->theme.get() : nullptr; }
};
FindExistingCursorThemeResult findExistingCursorTheme(const QString &name,
int pixelSize) const noexcept;
std::unique_ptr<QWaylandCursor> mCursor;
#endif
struct GlobalHolder
{
std::unique_ptr<QtWayland::wl_compositor> compositor;
std::unique_ptr<QWaylandShm> shm;
#if QT_CONFIG(wayland_datadevice)
std::unique_ptr<QWaylandDataDeviceManager> dndSelectionHandler;
#endif
std::unique_ptr<QtWayland::wl_subcompositor> subCompositor;
#if QT_CONFIG(tabletevent)
std::unique_ptr<QWaylandTabletManagerV2> tabletManager;
#endif
std::unique_ptr<QWaylandPointerGestures> pointerGestures;
#if QT_CONFIG(clipboard)
std::unique_ptr<QWaylandDataControlManagerV1> dataControlManager;
#endif
#if QT_CONFIG(wayland_client_primary_selection)
std::unique_ptr<QWaylandPrimarySelectionDeviceManagerV1> primarySelectionManager;
#endif
std::unique_ptr<QtWayland::qt_text_input_method_manager_v1> textInputMethodManager;
std::unique_ptr<QtWayland::zwp_text_input_manager_v1> textInputManagerv1;
std::unique_ptr<QtWayland::zwp_text_input_manager_v2> textInputManagerv2;
std::unique_ptr<QtWayland::zwp_text_input_manager_v3> textInputManagerv3;
std::unique_ptr<QWaylandHardwareIntegration> hardwareIntegration;
std::unique_ptr<QWaylandXdgOutputManagerV1> xdgOutputManager;
std::unique_ptr<QtWayland::wp_viewporter> viewporter;
std::unique_ptr<QtWayland::wp_fractional_scale_manager_v1> fractionalScaleManager;
std::unique_ptr<QtWayland::wp_cursor_shape_manager_v1> cursorShapeManager;
std::unique_ptr<QtWayland::xdg_session_manager_v1> xdgSessionManager;
std::unique_ptr<QtWayland::xdg_system_bell_v1> systemBell;
std::unique_ptr<QtWayland::xdg_toplevel_drag_manager_v1> xdgToplevelDragManager;
std::unique_ptr<QWaylandWindowManagerIntegration> windowManagerIntegration;
std::unique_ptr<QWaylandAppMenuManager> appMenuManager;
std::unique_ptr<ColorManager> colorManager;
std::unique_ptr<QtWayland::wp_pointer_warp_v1> pointerWarp;
std::unique_ptr<QtWayland::xx_cutouts_manager_v1> cutoutManager;
} mGlobals;
int mFd = -1;
int mWritableNotificationFd = -1;
QList<RegistryGlobal> mRegistryGlobals;
uint32_t mLastInputSerial = 0;
QWaylandInputDevice *mLastInputDevice = nullptr;
QPointer<QWaylandSurface> mLastInputSurface;
QPointer<QWaylandWindow> mLastKeyboardFocus;
QList<QWaylandWindow *> mActiveWindows;
QPointer<QWaylandWindow> mActiveSubSurface;
struct wl_callback *mSyncCallback = nullptr;
static const wl_callback_listener syncCallbackListener;
bool mWaylandTryReconnect = false;
bool mPreferWlrDataControl = false;
bool mWaylandInputContextRequested = [] () {
const auto requested = QPlatformInputContextFactory::requested();
return requested.isEmpty() || requested.contains(QLatin1String(WAYLAND_IM_KEY));
}();
QStringList mTextInputManagerList;
int mTextInputManagerIndex = INT_MAX;
void registry_global(uint32_t id, const QString &interface, uint32_t version) override;
void registry_global_remove(uint32_t id) override;
#if QT_CONFIG(xkbcommon)
QXkbCommon::ScopedXKBContext mXkbContext;
#endif
friend class QWaylandIntegration;
};
}
QT_END_NAMESPACE
#endif // QWAYLANDDISPLAY_H