registry.h

/*
    SPDX-FileCopyrightText: 2014 Martin Gräßlin <[email protected]>
    SPDX-FileCopyrightText: 2018 David Edmundson <[email protected]>

    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
*/
#ifndef WAYLAND_REGISTRY_H
#define WAYLAND_REGISTRY_H

#include <QHash>
#include <QObject>

#include <KWayland/Client/kwaylandclient_export.h>

struct wl_compositor;
struct wl_data_device_manager;
struct wl_display;
struct wl_output;
struct wl_registry;
struct wl_seat;
struct wl_shell;
struct wl_shm;
struct wl_subcompositor;
struct wl_text_input_manager;
struct zwp_text_input_manager_v2;
struct _wl_fullscreen_shell;
struct org_kde_kwin_appmenu_manager;
struct org_kde_kwin_outputmanagement;
struct org_kde_kwin_outputdevice;
struct org_kde_kwin_fake_input;
struct org_kde_kwin_idle;
struct org_kde_kwin_keystate;
struct org_kde_kwin_remote_access_manager;
struct org_kde_kwin_dpms_manager;
struct org_kde_kwin_shadow_manager;
struct org_kde_kwin_blur_manager;
struct org_kde_kwin_contrast_manager;
struct org_kde_kwin_slide_manager;
struct org_kde_plasma_shell;
struct org_kde_plasma_virtual_desktop_management;
struct org_kde_plasma_window_management;
struct org_kde_kwin_server_decoration_manager;
struct org_kde_kwin_server_decoration_palette_manager;
struct xdg_shell;
struct zxdg_shell_v6;
struct xdg_wm_base;
struct zwp_relative_pointer_manager_v1;
struct zwp_pointer_gestures_v1;
struct zwp_pointer_constraints_v1;
struct zxdg_exporter_v2;
struct zxdg_importer_v2;
struct zwp_idle_inhibit_manager_v1;
struct zxdg_output_manager_v1;
struct zxdg_decoration_manager_v1;

namespace KWayland
{
namespace Client
{

class AppMenuManager;
class Compositor;
class ConnectionThread;
class DataDeviceManager;
class DpmsManager;
class EventQueue;
class FakeInput;
class FullscreenShell;
class OutputManagement;
class OutputDevice;
class Idle;
class IdleInhibitManager;
class Keystate;
class RemoteAccessManager;
class Output;
class PlasmaShell;
class PlasmaVirtualDesktopManagement;
class PlasmaWindowManagement;
class PointerConstraints;
class PointerGestures;
class Seat;
class ShadowManager;
class BlurManager;
class ContrastManager;
class SlideManager;
class Shell;
class ShmPool;
class ServerSideDecorationManager;
class ServerSideDecorationPaletteManager;
class SubCompositor;
class TextInputManager;
class TextInputManagerUnstableV0;
class TextInputManagerUnstableV2;
class XdgShell;
class RelativePointerManager;
class XdgExporterUnstableV2;
class XdgImporterUnstableV2;
class XdgExporter;
class XdgImporter;
class XdgOutputManager;
class XdgDecorationManager;

class KWAYLANDCLIENT_EXPORT Registry : public QObject
{
    Q_OBJECT
public:
    enum class Interface {
        Unknown,    
        Compositor, 
        Shell,      
        Seat,       
        Shm,        
        Output,     
        FullscreenShell, 
        SubCompositor, 
        DataDeviceManager, 
        PlasmaShell, 
        PlasmaWindowManagement, 
        Idle, 
        FakeInput, 
        Shadow, 
        Blur, 
        Contrast, 
        Slide, 
        Dpms, 
        OutputManagement, 
        OutputDevice,     
        ServerSideDecorationManager, 
        TextInputManagerUnstableV0, 
        TextInputManagerUnstableV2, 
        XdgShellUnstableV5, 
        RelativePointerManagerUnstableV1, 
        PointerGesturesUnstableV1, 
        PointerConstraintsUnstableV1, 
        XdgExporterUnstableV2, 
        XdgImporterUnstableV2, 
        XdgShellUnstableV6, 
        IdleInhibitManagerUnstableV1, 
        AppMenu, 
        ServerSideDecorationPalette, 
        RemoteAccessManager, 
        PlasmaVirtualDesktopManagement, 
        XdgOutputUnstableV1, 
        XdgShellStable, 
        XdgDecorationUnstableV1, 
        Keystate,
    };
    explicit Registry(QObject *parent = nullptr);
    virtual ~Registry();

    void release();
    void destroy();
    void create(wl_display *display);
    void create(ConnectionThread *connection);
    void setup();

    void setEventQueue(EventQueue *queue);
    EventQueue *eventQueue();

    bool isValid() const;
    bool hasInterface(Interface interface) const;

    struct AnnouncedInterface {
        quint32 name;
        quint32 version;
    };
    AnnouncedInterface interface(Interface interface) const;
    QVector<AnnouncedInterface> interfaces(Interface interface) const;


    wl_compositor *bindCompositor(uint32_t name, uint32_t version) const;
    wl_shell *bindShell(uint32_t name, uint32_t version) const;
    wl_seat *bindSeat(uint32_t name, uint32_t version) const;
    wl_shm *bindShm(uint32_t name, uint32_t version) const;
    org_kde_kwin_outputmanagement *bindOutputManagement(uint32_t name, uint32_t version) const;
    wl_output *bindOutput(uint32_t name, uint32_t version) const;
    wl_subcompositor *bindSubCompositor(uint32_t name, uint32_t version) const;
    org_kde_kwin_outputdevice *bindOutputDevice(uint32_t name, uint32_t version) const;

    _wl_fullscreen_shell *bindFullscreenShell(uint32_t name, uint32_t version) const;
    wl_data_device_manager *bindDataDeviceManager(uint32_t name, uint32_t version) const;
    org_kde_plasma_shell *bindPlasmaShell(uint32_t name, uint32_t version) const;
    org_kde_plasma_virtual_desktop_management *bindPlasmaVirtualDesktopManagement(uint32_t name, uint32_t version) const;
    org_kde_plasma_window_management *bindPlasmaWindowManagement(uint32_t name, uint32_t version) const;
    org_kde_kwin_idle *bindIdle(uint32_t name, uint32_t version) const;
    org_kde_kwin_keystate *bindKeystate(uint32_t name, uint32_t version) const;
    org_kde_kwin_remote_access_manager *bindRemoteAccessManager(uint32_t name, uint32_t version) const;
    org_kde_kwin_fake_input *bindFakeInput(uint32_t name, uint32_t version) const;
    org_kde_kwin_shadow_manager *bindShadowManager(uint32_t name, uint32_t version) const;
    org_kde_kwin_blur_manager *bindBlurManager(uint32_t name, uint32_t version) const;
    org_kde_kwin_contrast_manager *bindContrastManager(uint32_t name, uint32_t version) const;
    org_kde_kwin_slide_manager * bindSlideManager(uint32_t name, uint32_t version) const;
    org_kde_kwin_dpms_manager *bindDpmsManager(uint32_t name, uint32_t version) const;
    org_kde_kwin_server_decoration_manager *bindServerSideDecorationManager(uint32_t name, uint32_t version) const;
    wl_text_input_manager *bindTextInputManagerUnstableV0(uint32_t name, uint32_t version) const;
    zwp_text_input_manager_v2 *bindTextInputManagerUnstableV2(uint32_t name, uint32_t version) const;
    xdg_shell *bindXdgShellUnstableV5(uint32_t name, uint32_t version) const;
    zxdg_shell_v6 *bindXdgShellUnstableV6(uint32_t name, uint32_t version) const;
    xdg_wm_base *bindXdgShellStable(uint32_t name, uint32_t version) const;
    zwp_relative_pointer_manager_v1 *bindRelativePointerManagerUnstableV1(uint32_t name, uint32_t version) const;
    zwp_pointer_gestures_v1 *bindPointerGesturesUnstableV1(uint32_t name, uint32_t version) const;
    zwp_pointer_constraints_v1 *bindPointerConstraintsUnstableV1(uint32_t name, uint32_t version) const;

    zxdg_exporter_v2 *bindXdgExporterUnstableV2(uint32_t name, uint32_t version) const;

    zxdg_importer_v2 *bindXdgImporterUnstableV2(uint32_t name, uint32_t version) const;

    zwp_idle_inhibit_manager_v1 *bindIdleInhibitManagerUnstableV1(uint32_t name, uint32_t version) const;

    org_kde_kwin_appmenu_manager *bindAppMenuManager(uint32_t name, uint32_t version) const;

    org_kde_kwin_server_decoration_palette_manager *bindServerSideDecorationPaletteManager(uint32_t name, uint32_t version) const;

    zxdg_output_manager_v1 *bindXdgOutputUnstableV1(uint32_t name, uint32_t version) const;

    zxdg_decoration_manager_v1 *bindXdgDecorationUnstableV1(uint32_t name, uint32_t version) const;



    Compositor *createCompositor(quint32 name, quint32 version, QObject *parent = nullptr);
    Shell *createShell(quint32 name, quint32 version, QObject *parent = nullptr);
    Seat *createSeat(quint32 name, quint32 version, QObject *parent = nullptr);
    ShmPool *createShmPool(quint32 name, quint32 version, QObject *parent = nullptr);
    SubCompositor *createSubCompositor(quint32 name, quint32 version, QObject *parent = nullptr);
    Output *createOutput(quint32 name, quint32 version, QObject *parent = nullptr);
    OutputManagement *createOutputManagement(quint32 name, quint32 version, QObject *parent = nullptr);
    OutputDevice *createOutputDevice(quint32 name, quint32 version, QObject *parent = nullptr);
    FullscreenShell *createFullscreenShell(quint32 name, quint32 version, QObject *parent = nullptr);
    DataDeviceManager *createDataDeviceManager(quint32 name, quint32 version, QObject *parent = nullptr);
    PlasmaShell *createPlasmaShell(quint32 name, quint32 version, QObject *parent = nullptr);
    PlasmaVirtualDesktopManagement *createPlasmaVirtualDesktopManagement(quint32 name, quint32 version, QObject *parent = nullptr);
    PlasmaWindowManagement *createPlasmaWindowManagement(quint32 name, quint32 version, QObject *parent = nullptr);
    Idle *createIdle(quint32 name, quint32 version, QObject *parent = nullptr);
    Keystate *createKeystate(quint32 name, quint32 version, QObject *parent = nullptr);
    RemoteAccessManager *createRemoteAccessManager(quint32 name, quint32 version, QObject *parent = nullptr);
    FakeInput *createFakeInput(quint32 name, quint32 version, QObject *parent = nullptr);
    ShadowManager *createShadowManager(quint32 name, quint32 version, QObject *parent = nullptr);
    BlurManager *createBlurManager(quint32 name, quint32 version, QObject *parent = nullptr);
    ContrastManager *createContrastManager(quint32 name, quint32 version, QObject *parent = nullptr);
    SlideManager *createSlideManager(quint32 name, quint32 version, QObject *parent = nullptr);
    DpmsManager *createDpmsManager(quint32 name, quint32 version, QObject *parent = nullptr);
    ServerSideDecorationManager *createServerSideDecorationManager(quint32 name, quint32 version, QObject *parent = nullptr);
    TextInputManager *createTextInputManager(quint32 name, quint32 version, QObject *parent = nullptr);
    XdgShell *createXdgShell(quint32 name, quint32 version, QObject *parent = nullptr);
    RelativePointerManager *createRelativePointerManager(quint32 name, quint32 version, QObject *parent = nullptr);
    PointerGestures *createPointerGestures(quint32 name, quint32 version, QObject *parent = nullptr);
    PointerConstraints *createPointerConstraints(quint32 name, quint32 version, QObject *parent = nullptr);

    XdgExporter *createXdgExporter(quint32 name, quint32 version, QObject *parent = nullptr);

    XdgImporter *createXdgImporter(quint32 name, quint32 version, QObject *parent = nullptr);

    IdleInhibitManager *createIdleInhibitManager(quint32 name, quint32 version, QObject *parent = nullptr);

    AppMenuManager *createAppMenuManager(quint32 name, quint32 version, QObject *parent = nullptr);

    ServerSideDecorationPaletteManager *createServerSideDecorationPaletteManager(quint32 name, quint32 version, QObject *parent = nullptr);

    XdgOutputManager *createXdgOutputManager(quint32 name, quint32 version, QObject *parent = nullptr);

    XdgDecorationManager *createXdgDecorationManager(quint32 name, quint32 version, QObject *parent = nullptr);



    operator wl_registry*();
    operator wl_registry*() const;
    wl_registry *registry();

Q_SIGNALS:

    void compositorAnnounced(quint32 name, quint32 version);
    void shellAnnounced(quint32 name, quint32 version);
    void seatAnnounced(quint32 name, quint32 version);
    void shmAnnounced(quint32 name, quint32 version);
    void subCompositorAnnounced(quint32 name, quint32 version);
    void outputAnnounced(quint32 name, quint32 version);
    void fullscreenShellAnnounced(quint32 name, quint32 version);
    void dataDeviceManagerAnnounced(quint32 name, quint32 version);

    void outputManagementAnnounced(quint32 name, quint32 version);
    void outputDeviceAnnounced(quint32 name, quint32 version);
    void plasmaShellAnnounced(quint32 name, quint32 version);
    void plasmaVirtualDesktopManagementAnnounced(quint32 name, quint32 version);
    void plasmaWindowManagementAnnounced(quint32 name, quint32 version);
    void idleAnnounced(quint32 name, quint32 version);
    void remoteAccessManagerAnnounced(quint32 name, quint32 version);
    void fakeInputAnnounced(quint32 name, quint32 version);
    void shadowAnnounced(quint32 name, quint32 version);
    void blurAnnounced(quint32 name, quint32 version);
    void contrastAnnounced(quint32 name, quint32 version);
    void slideAnnounced(quint32 name, quint32 version);
    void dpmsAnnounced(quint32 name, quint32 version);
    void serverSideDecorationManagerAnnounced(quint32 name, quint32 version);
    void textInputManagerUnstableV0Announced(quint32 name, quint32 version);
    void textInputManagerUnstableV2Announced(quint32 name, quint32 version);
    void xdgShellUnstableV5Announced(quint32 name, quint32 version);
    void xdgShellUnstableV6Announced(quint32 name, quint32 version);

    void relativePointerManagerUnstableV1Announced(quint32 name, quint32 version);
    void pointerGesturesUnstableV1Announced(quint32 name, quint32 version);
    void pointerConstraintsUnstableV1Announced(quint32 name, quint32 version);

    void exporterUnstableV2Announced(quint32 name, quint32 version);

    void importerUnstableV2Announced(quint32 name, quint32 version);

    void idleInhibitManagerUnstableV1Announced(quint32 name, quint32 version);

    void appMenuAnnounced(quint32 name, quint32 version);

    void serverSideDecorationPaletteManagerAnnounced(quint32 name, quint32 version);

    void xdgOutputAnnounced(quint32 name, quint32 version);

    void xdgShellStableAnnounced(quint32 name, quint32 version);

    void xdgDecorationAnnounced(quint32 name, quint32 version);



    void compositorRemoved(quint32 name);
    void shellRemoved(quint32 name);
    void seatRemoved(quint32 name);
    void shmRemoved(quint32 name);
    void subCompositorRemoved(quint32 name);
    void outputRemoved(quint32 name);
    void fullscreenShellRemoved(quint32 name);
    void dataDeviceManagerRemoved(quint32 name);
    void outputManagementRemoved(quint32 name);
    void outputDeviceRemoved(quint32 name);
    void plasmaShellRemoved(quint32 name);
    void plasmaVirtualDesktopManagementRemoved(quint32 name);
    void plasmaWindowManagementRemoved(quint32 name);
    void idleRemoved(quint32 name);
    void remoteAccessManagerRemoved(quint32 name);
    void fakeInputRemoved(quint32 name);
    void shadowRemoved(quint32 name);
    void blurRemoved(quint32 name);
    void contrastRemoved(quint32 name);
    void slideRemoved(quint32 name);
    void dpmsRemoved(quint32 name);
    void serverSideDecorationManagerRemoved(quint32 name);
    void textInputManagerUnstableV0Removed(quint32 name);
    void textInputManagerUnstableV2Removed(quint32 name);
    void xdgShellUnstableV5Removed(quint32 name);
    void xdgShellUnstableV6Removed(quint32 name);
    void relativePointerManagerUnstableV1Removed(quint32 name);
    void pointerGesturesUnstableV1Removed(quint32 name);
    void pointerConstraintsUnstableV1Removed(quint32 name);

    void exporterUnstableV2Removed(quint32 name);

    void importerUnstableV2Removed(quint32 name);

    void idleInhibitManagerUnstableV1Removed(quint32 name);

    void appMenuRemoved(quint32 name);

    void serverSideDecorationPaletteManagerRemoved(quint32 name);

    void xdgOutputRemoved(quint32 name);
    void xdgShellStableRemoved(quint32 name);

    void xdgDecorationRemoved(quint32 name);

    void keystateAnnounced(quint32 name, quint32 version);
    void keystateRemoved(quint32 name);


    void interfaceAnnounced(QByteArray interface, quint32 name, quint32 version);
    void interfaceRemoved(quint32 name);
    void interfacesAnnounced();

Q_SIGNALS:
    /*
     * Emitted when the registry has been destroyed rather than released
     */
    void registryDestroyed();

private:
    class Private;
    QScopedPointer<Private> d;
};

}
}

#endif