kstartupinfo.h

/*
    SPDX-FileCopyrightText: 2001-2003 Lubos Lunak <[email protected]>

    SPDX-License-Identifier: MIT
*/

#ifndef KSTARTUPINFO_H
#define KSTARTUPINFO_H

#include <kwindowsystem_export.h>

#include <QObject>
#include <QString>
#include <QChildEvent>
#include <QWidgetList> // for WId
#include <QWindow>

#include <sys/types.h>

typedef struct _XDisplay Display;

struct xcb_connection_t;

#ifdef Q_CC_MSVC
typedef int pid_t;
#endif

class KStartupInfoId;
class KStartupInfoData;

class KWINDOWSYSTEM_EXPORT KStartupInfo
    : public QObject
{
    Q_OBJECT
public:

    static void appStarted();

    static void appStarted(const QByteArray &startup_id);

    static QByteArray startupId();

    static void setStartupId(const QByteArray &startup_id);

    static void setNewStartupId(QWindow *window, const QByteArray &startup_id);

#if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 62)

    KWINDOWSYSTEM_DEPRECATED_VERSION(5, 62, "Use KStartupInfo::setNewStartupId(QWindow*)")
    static void setNewStartupId(QWidget *window, const QByteArray &startup_id);
#endif

    static void silenceStartup(bool silence);

    static QByteArray createNewStartupId();
    static QByteArray createNewStartupIdForTimestamp(quint32 timestamp);
    enum {
        CleanOnCantDetect       = 1 << 0,
        DisableKWinModule       = 1 << 1,
        AnnounceSilenceChanges  = 1 << 2
    };

    explicit KStartupInfo(int flags, QObject *parent = nullptr);
#if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 0)

    KWINDOWSYSTEM_DEPRECATED_VERSION(5, 0, "Use KStartupInfo(int, QObject *)")
    explicit KStartupInfo(bool clean_on_cantdetect, QObject *parent = nullptr);
#endif
    ~KStartupInfo() override;
    static bool sendStartup(const KStartupInfoId &id, const KStartupInfoData &data);

#if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 18)

    KWINDOWSYSTEM_DEPRECATED_VERSION(5, 18, "Use KStartupInfo::sendStartupXcb(xcb_connection_t *, int, const KStartupInfoId &, const KStartupInfoData &)")
    static bool sendStartupX(Display *dpy, const KStartupInfoId &id,
                             const KStartupInfoData &data);
#endif

    static bool sendStartupXcb(xcb_connection_t *conn, int screen,
                               const KStartupInfoId &id, const KStartupInfoData &data);

    static bool sendChange(const KStartupInfoId &id, const KStartupInfoData &data);

#if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 18)

    KWINDOWSYSTEM_DEPRECATED_VERSION(5, 18, "Use KStartupInfo::sendChangeXcb(xcb_connection_t *, int, const KStartupInfoId &, const KStartupInfoData &)")
    static bool sendChangeX(Display *dpy, const KStartupInfoId &id,
                            const KStartupInfoData &data);
#endif

    static bool sendChangeXcb(xcb_connection_t *conn, int screen, const KStartupInfoId &id,
                              const KStartupInfoData &data);

    static bool sendFinish(const KStartupInfoId &id);

#if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 18)

    KWINDOWSYSTEM_DEPRECATED_VERSION(5, 18, "Use KStartupInfo::sendFinishXcb(xcb_connection_t *, int, const KStartupInfoId &)")
    static bool sendFinishX(Display *dpy, const KStartupInfoId &id);
#endif

    static bool sendFinishXcb(xcb_connection_t *conn, int screen, const KStartupInfoId &id);

    static bool sendFinish(const KStartupInfoId &id, const KStartupInfoData &data);

#if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 18)

    KWINDOWSYSTEM_DEPRECATED_VERSION(5, 18, "Use KStartupInfo::sendFinishXcb(xcb_connection_t *, int, const KStartupInfoId &, const KStartupInfoData &)")
    static bool sendFinishX(Display *dpy, const KStartupInfoId &id,
                            const KStartupInfoData &data);
#endif

    static bool sendFinishXcb(xcb_connection_t *conn, int screen,
                              const KStartupInfoId &id, const KStartupInfoData &data);

    static KStartupInfoId currentStartupIdEnv();
    static void resetStartupEnv();
    enum startup_t { NoMatch, Match, CantDetect };
    startup_t checkStartup(WId w);
    startup_t checkStartup(WId w, KStartupInfoId &id);
    startup_t checkStartup(WId w, KStartupInfoData &data);
    startup_t checkStartup(WId w, KStartupInfoId &id, KStartupInfoData &data);
    void setTimeout(unsigned int secs);
    static void setWindowStartupId(WId window, const QByteArray &id);
    static QByteArray windowStartupId(WId w);
    class Data;

    class Private;
Q_SIGNALS:
    void gotNewStartup(const KStartupInfoId &id, const KStartupInfoData &data);
    void gotStartupChange(const KStartupInfoId &id, const KStartupInfoData &data);
    void gotRemoveStartup(const KStartupInfoId &id, const KStartupInfoData &data);

protected:
    void customEvent(QEvent *e_P) override;

private:
    Q_PRIVATE_SLOT(d, void startups_cleanup())
    Q_PRIVATE_SLOT(d, void startups_cleanup_no_age())
    Q_PRIVATE_SLOT(d, void got_message(const QString &msg))
    Q_PRIVATE_SLOT(d, void window_added(WId w))
    Q_PRIVATE_SLOT(d, void slot_window_added(WId w))

    Private *const d;

    Q_DISABLE_COPY(KStartupInfo)
};

class KWINDOWSYSTEM_EXPORT KStartupInfoId
{
public:
    bool operator==(const KStartupInfoId &id) const;
    bool operator!=(const KStartupInfoId &id) const;
    bool isNull() const;
#if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 0)
    KWINDOWSYSTEM_DEPRECATED_VERSION(5, 0, "Use KStartupInfoId::isNull()")
    bool none() const { return isNull(); }
#endif

    void initId(const QByteArray &id = "");
    const QByteArray &id() const;
    unsigned long timestamp() const;
    bool setupStartupEnv() const;
    KStartupInfoId();
    KStartupInfoId(const KStartupInfoId &data);
    ~KStartupInfoId();
    KStartupInfoId &operator=(const KStartupInfoId &data);
    bool operator<(const KStartupInfoId &id) const;
private:
    explicit KStartupInfoId(const QString &txt);
    friend class KStartupInfo;
    friend class KStartupInfo::Private;
    struct Private;
    Private *const d;
};

class KWINDOWSYSTEM_EXPORT KStartupInfoData
{
public:
    void setBin(const QString &bin);
    const QString &bin() const;
    void setName(const QString &name);
    const QString &findName() const;
    const QString &name() const;
    void setDescription(const QString &descr);
    const QString &findDescription() const;
    const QString &description() const;
    void setIcon(const QString &icon);
    const QString &findIcon() const;
    const QString &icon() const;
    void setDesktop(int desktop);
    int desktop() const;
    void setWMClass(const QByteArray &wmclass);
    const QByteArray findWMClass() const;
    QByteArray WMClass() const;
    void addPid(pid_t pid);
    QList< pid_t > pids() const;
    bool is_pid(pid_t pid) const;
    void setHostname(const QByteArray &hostname = QByteArray());
    QByteArray hostname() const;

    enum TriState { Yes, No, Unknown };

    void setSilent(TriState state);

    TriState silent() const;

    int screen() const;

    void setScreen(int screen);

    int xinerama() const;

    void setXinerama(int xinerama);

#if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 69)

    KWINDOWSYSTEM_DEPRECATED_VERSION(5, 69, "Deprecated because not used anywhere. Tell [email protected] if you disagree")
    WId launchedBy() const;
#endif

#if KWINDOWSYSTEM_ENABLE_DEPRECATED_SINCE(5, 69)

    KWINDOWSYSTEM_DEPRECATED_VERSION(5, 69, "Deprecated because launchedBy() is not used anywhere. Tell [email protected] if you disagree")
    void setLaunchedBy(WId window);
#endif

    QString applicationId() const;

    void setApplicationId(const QString &desktop);

    void update(const KStartupInfoData &data);

    KStartupInfoData();

    KStartupInfoData(const KStartupInfoData &data);
    ~KStartupInfoData();
    KStartupInfoData &operator=(const KStartupInfoData &data);
private:
    explicit KStartupInfoData(const QString &txt);
    friend class KStartupInfo;
    friend class KStartupInfo::Data;
    friend class KStartupInfo::Private;
    struct Private;
    Private *const d;
};

#endif