PhosphorProfileRegistry.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorAnimation/Profile.h>
#include <PhosphorAnimation/phosphoranimation_export.h>
 
#include <QtCore/QHash>
#include <QtCore/QObject>
#include <QtCore/QString>
 
#include <atomic>
#include <mutex>
#include <optional>
 
namespace PhosphorAnimation {
 
class PHOSPHORANIMATION_EXPORT PhosphorProfileRegistry : public QObject
{
    Q_OBJECT
 
public:
    explicit PhosphorProfileRegistry(QObject* parent = nullptr);
    ~PhosphorProfileRegistry() override;
 
    PhosphorProfileRegistry(const PhosphorProfileRegistry&) = delete;
    PhosphorProfileRegistry& operator=(const PhosphorProfileRegistry&) = delete;
 
    static void setDefaultRegistry(PhosphorProfileRegistry* registry);
 
    static PhosphorProfileRegistry* defaultRegistry();
 
    std::optional<Profile> resolve(const QString& path) const;
 
    Profile resolveWithInheritance(const QString& path) const;
    Profile resolveWithInheritance(const QString& path, const QString& lowPrecedenceOwnerTag) const;
 
    void setLowPrecedenceOwnerTag(const QString& tag);
 
    void registerProfile(const QString& path, const Profile& profile);
 
    void registerProfile(const QString& path, const Profile& profile, const QString& ownerTag);
 
    void unregisterProfile(const QString& path);
 
    void reloadFromOwner(const QString& ownerTag, const QHash<QString, Profile>& profiles);
 
    void clearOwner(const QString& ownerTag);
 
    void reloadAll(const QHash<QString, Profile>& profiles);
 
    void clear();
 
    QString ownerOf(const QString& path) const;
 
    QHash<QString, Profile> snapshot() const;
 
    int profileCount() const;
 
    bool hasProfile(const QString& path) const;
 
Q_SIGNALS:
    void profileChanged(const QString& path);
 
    void profilesReloaded();
 
    void ownerReloaded(const QString& ownerTag);
 
private:
    static std::atomic<PhosphorProfileRegistry*> s_defaultRegistry;
 
    mutable std::mutex m_mutex;
    QHash<QString, Profile> m_profiles;
    QHash<QString, QString> m_owners;
    QString m_lowPrecedenceOwnerTag; 
};
 
} // namespace PhosphorAnimation