AnimationAppRule.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorAnimation/phosphoranimation_export.h>
 
#include <QList>
#include <QString>
#include <QVariantMap>
 
#include <optional>
 
class QJsonArray;
class QJsonObject;
 
namespace PhosphorAnimationShaders {
 
struct PHOSPHORANIMATION_EXPORT AnimationAppRule
{
    enum class Kind {
        Shader, 
        Timing, 
    };
 
    QString classPattern;
 
    QString eventPath;
 
    Kind kind = Kind::Shader;
 
    // ─── Shader-kind payload (kind == Shader only) ────────────────
    QString effectId;
    QVariantMap shaderParams;
 
    // ─── Timing-kind payload (kind == Timing only) ────────────────
    QString curve;
    int durationMs = 0;
 
    bool operator==(const AnimationAppRule& other) const noexcept;
    bool operator!=(const AnimationAppRule& other) const noexcept
    {
        return !(*this == other);
    }
 
    QJsonObject toJson() const;
 
    static std::optional<AnimationAppRule> fromJson(const QJsonObject& obj);
};
 
class PHOSPHORANIMATION_EXPORT AnimationAppRuleList
{
public:
    AnimationAppRuleList() = default;
 
    int size() const noexcept
    {
        return m_rules.size();
    }
    bool isEmpty() const noexcept
    {
        return m_rules.isEmpty();
    }
    AnimationAppRule at(int index) const;
    QList<AnimationAppRule> entries() const
    {
        return m_rules;
    }
 
    bool append(const AnimationAppRule& rule);
    void removeAt(int index);
    void move(int from, int to);
    void clear() noexcept
    {
        m_rules.clear();
    }
    int setEntries(const QList<AnimationAppRule>& rules);
 
    std::optional<AnimationAppRule> resolveShader(const QString& windowClass, const QString& eventPath) const;
 
    std::optional<AnimationAppRule> resolveTiming(const QString& windowClass, const QString& eventPath) const;
 
    QJsonArray toJson() const;
    static AnimationAppRuleList fromJson(const QJsonArray& arr);
 
    bool operator==(const AnimationAppRuleList& other) const noexcept
    {
        return m_rules == other.m_rules;
    }
    bool operator!=(const AnimationAppRuleList& other) const noexcept
    {
        return !(*this == other);
    }
 
private:
    std::optional<AnimationAppRule> firstMatchOfKind(AnimationAppRule::Kind kind, const QString& windowClass,
                                                     const QString& eventPath) const;
 
    QList<AnimationAppRule> m_rules;
};
 
} // namespace PhosphorAnimationShaders