Registry.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <QHash>
#include <QKeySequence>
#include <QObject>
#include <QPointer>
#include <QString>
#include <QVector>
 
#include <functional>
 
#include "phosphorshortcuts_export.h"
 
namespace Phosphor::Shortcuts {
 
class IBackend;
 
class PHOSPHORSHORTCUTS_EXPORT Registry : public QObject
{
    Q_OBJECT
public:
    struct Binding
    {
        QString id;
        QKeySequence defaultSeq;
        QKeySequence currentSeq;
        QString description;
    };
 
    explicit Registry(IBackend* backend, QObject* parent = nullptr);
    ~Registry() override;
 
    void bind(const QString& id, const QKeySequence& defaultSeq, const QString& description = {},
              std::function<void()> callback = {}, bool persistent = true);
 
    void rebind(const QString& id, const QKeySequence& seq);
 
    void unbind(const QString& id);
 
    void flush();
 
    QKeySequence shortcut(const QString& id) const;
 
    QVector<Binding> bindings(bool persistentOnly = false) const;
 
Q_SIGNALS:
    void triggered(QString id);
 
    void ready();
 
private Q_SLOTS:
    void onBackendActivated(QString id);
    void onBackendReady();
 
private:
    struct Entry
    {
        Binding binding;
        std::function<void()> callback;
        // Last values successfully pushed to the backend. Used to decide
        // whether flush() should re-register (default changed) or update-only
        // (current changed), and to short-circuit no-op flushes.
        QKeySequence lastSentDefault;
        QKeySequence lastSentCurrent;
        bool registered = false; // has registerShortcut been sent yet?
        // Persistent flag last forwarded to the backend. flush() re-registers
        // when this drifts from `persistent` so a re-bind() that flips the flag
        // without changing the key still reaches the backend — the backend's
        // crash-purge decision (KGlobalAccelBackend) depends on the latest
        // value. Only meaningful once `registered` is true.
        bool lastSentPersistent = true;
        bool persistent = true; // surfaces in bindings(persistentOnly=true)
    };
 
    QPointer<IBackend> m_backend;
    QHash<QString, Entry> m_entries;
};
 
} // namespace Phosphor::Shortcuts