ScriptedAlgorithmLoader.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 <PhosphorFsLoader/WatchedDirectorySet.h>
 
#include <QByteArray>
#include <QHash>
#include <QObject>
#include <QSet>
#include <QString>
#include <QStringList>
 
#include <memory>
 
namespace PhosphorScripting {
class LuauEngine;
class LuauWatchdog;
}
 
namespace PhosphorTiles {
 
class ITileAlgorithmRegistry;
 
class PHOSPHORTILES_EXPORT ScriptedAlgorithmLoader : public QObject
{
    Q_OBJECT
 
public:
    static constexpr int MaxWatchedFilesPerDir = 100;
 
    static constexpr int MaxScripts = 10'000;
 
    explicit ScriptedAlgorithmLoader(const QString& subdirectory, ITileAlgorithmRegistry* registry,
                                     QObject* parent = nullptr);
    ~ScriptedAlgorithmLoader() override;
 
    void scanAndRegister(PhosphorFsLoader::LiveReload liveReload = PhosphorFsLoader::LiveReload::On);
 
    void ensureUserDirectoryExists();
 
    QString userAlgorithmDir() const;
 
Q_SIGNALS:
    void algorithmsChanged();
 
private:
    class LuauScanStrategy;
    QStringList performScan(const QStringList& directoriesInScanOrder);
 
    struct ScriptStamp
    {
        QString id; 
        qint64 size = -1;
        qint64 mtimeMs = -1;
        bool isUser = false;
    };
 
    void loadFromDirectory(const QString& dir, bool isUserDir, const QString& canonicalUserDir,
                           const QHash<QString, ScriptStamp>& prevStamps);
    QStringList algorithmDirectories() const;
    QStringList validatedLuauFiles(const QString& dirPath, int maxFiles) const;
 
    std::shared_ptr<PhosphorScripting::LuauEngine> ensureSharedEngine();
 
    QString m_subdirectory; 
    ITileAlgorithmRegistry* m_registry = nullptr; 
    std::shared_ptr<PhosphorScripting::LuauWatchdog> m_watchdog;
    std::shared_ptr<PhosphorScripting::LuauEngine> m_sharedEngine;
    bool m_sharedEngineFailed = false; 
    std::unique_ptr<LuauScanStrategy> m_strategy;
    std::unique_ptr<PhosphorFsLoader::WatchedDirectorySet> m_watcher;
    QHash<QString, QString> m_scriptIdToPath; 
    QSet<QString> m_refusedFilePaths;
    QHash<QString, ScriptStamp> m_scriptStamps;
    QByteArray m_lastScriptSignature;
};
 
} // namespace PhosphorTiles