AlgorithmRegistry.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <phosphortiles_export.h>
#include "AlgorithmPreviewParams.h"
#include "AutotileConstants.h"
#include "ITileAlgorithmRegistry.h"
#include <QLatin1String>
#include <QList>
#include <QMutex>
#include <QMutexLocker>
#include <QObject>
#include <QString>
#include <QStringList>
#include <QVariantList>
#include <QVariantMap>
#include <functional>
#include <memory>
 
namespace PhosphorTiles {
 
class TilingAlgorithm;
 
class PHOSPHORTILES_EXPORT AlgorithmRegistry : public ITileAlgorithmRegistry
{
    Q_OBJECT
    Q_DISABLE_COPY_MOVE(AlgorithmRegistry)
 
public:
    void cleanup();
 
    // ─── ITileAlgorithmRegistry implementation ─────────────────────────────
 
    void registerAlgorithm(const QString& id, TilingAlgorithm* algorithm) override;
    bool unregisterAlgorithm(const QString& id) override;
    TilingAlgorithm* algorithm(const QString& id) const override;
    QStringList availableAlgorithms() const override;
    QList<TilingAlgorithm*> allAlgorithms() const override;
    bool hasAlgorithm(const QString& id) const override;
    TilingAlgorithm* defaultAlgorithm() const override;
 
    QString defaultAlgorithmId() const override
    {
        return staticDefaultAlgorithmId();
    }
 
    static QString staticDefaultAlgorithmId();
 
    // ═══════════════════════════════════════════════════════════════════════════
    // Preview utilities for unified layout model (shared by zone selector,
    // overlay service, daemon OSD, and KCM algorithm preview)
    // ═══════════════════════════════════════════════════════════════════════════
 
    static constexpr int PreviewCanvasSize = 1000;
 
    // ─── Preview params (ITileAlgorithmRegistry overrides) ─────────────────
 
    void setPreviewParams(const AlgorithmPreviewParams& params) override;
    const AlgorithmPreviewParams& previewParams() const noexcept override;
 
    explicit AlgorithmRegistry(QObject* parent = nullptr);
    ~AlgorithmRegistry() override;
 
private:
    void registerBuiltInAlgorithms();
 
    class Impl;
    std::unique_ptr<Impl> m_impl;
};
 
struct PHOSPHORTILES_EXPORT PendingAlgorithmRegistration
{
    QString id;
    int priority;
    std::function<TilingAlgorithm*()> factory;
};
 
PHOSPHORTILES_EXPORT QList<PendingAlgorithmRegistration>& pendingAlgorithmRegistrations();
 
PHOSPHORTILES_EXPORT class QMutex& pendingAlgorithmRegistrationsMutex();
 
template<typename T>
class AlgorithmRegistrar
{
public:
    explicit AlgorithmRegistrar(const QString& id, int priority = 100)
    {
        // Store in the global (non-template) pending list. Locked so
        // multiple algorithm libraries' static-init can run concurrently
        // (Qt plugin loader on a worker thread, parallel test binaries
        // sharing a process) without corrupting the QList.
        QMutexLocker locker(&pendingAlgorithmRegistrationsMutex());
        pendingAlgorithmRegistrations().append({id, priority, []() {
                                                    return new T();
                                                }});
    }
};
 
} // namespace PhosphorTiles