AnimationShaderRegistry.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorAnimation/AnimationShaderEffect.h>
#include <PhosphorAnimation/phosphoranimation_export.h>
 
#include <PhosphorFsLoader/MetadataPackRegistryBase.h>
#include <PhosphorFsLoader/MetadataPackScanStrategy.h>
 
#include <QList>
#include <QString>
#include <QStringList>
#include <QVariantMap>
 
#include <memory>
 
namespace PhosphorAnimationShaders {
 
class PHOSPHORANIMATION_EXPORT AnimationShaderRegistry : public PhosphorFsLoader::MetadataPackRegistryBase
{
    Q_OBJECT
 
public:
    explicit AnimationShaderRegistry(QObject* parent = nullptr);
    ~AnimationShaderRegistry() override;
 
    // Lookup -------------------------------------------------------------------
 
    QList<AnimationShaderEffect> availableEffects() const;
    AnimationShaderEffect effect(const QString& id) const;
    bool hasEffect(const QString& id) const;
    QStringList effectIds() const;
 
    QVariantMap translateAnimationParams(const QString& effectId, const QVariantMap& friendlyParams) const;
 
    static QVariantMap translateAnimationParams(const AnimationShaderEffect& effect, const QVariantMap& friendlyParams);
 
Q_SIGNALS:
    void effectsChanged();
 
protected:
    void onUserPathChanged(const QString& path) override;
 
private:
    using ScanStrategy = PhosphorFsLoader::MetadataPackScanStrategy<AnimationShaderEffect>;
 
    static std::unique_ptr<PhosphorFsLoader::IScanStrategy> buildScanStrategy(AnimationShaderRegistry* self);
 
    // Non-owning typed alias for the strategy the base owns. Populated
    // in the ctor body via dynamic_cast (asserted non-null) so the
    // invariant fires BEFORE the typed pointer is committed — keeps the
    // narrow UB window between a hypothetical subclass-mismatch
    // static_cast and its diagnostic out of the field's lifetime. Named
    // distinctly from the base's private `m_strategy` to make the
    // shadowing explicit at the field declaration.
    ScanStrategy* m_typedStrategy = nullptr;
};
 
} // namespace PhosphorAnimationShaders