DirectoryLoader.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorFsLoader/FileLimits.h>
#include <PhosphorFsLoader/IDirectoryLoaderSink.h>
#include <PhosphorFsLoader/ParsedEntry.h>
#include <PhosphorFsLoader/WatchedDirectorySet.h>
#include <PhosphorFsLoader/phosphorfsloader_export.h>
 
#include <QtCore/QList>
#include <QtCore/QObject>
#include <QtCore/QString>
#include <QtCore/QStringList>
 
#include <memory>
 
namespace PhosphorFsLoader {
 
class PHOSPHORFSLOADER_EXPORT DirectoryLoader : public QObject
{
    Q_OBJECT
 
public:
    struct Entry
    {
        QString key;
        QString sourcePath;
        QString systemSourcePath;
    };
 
    explicit DirectoryLoader(IDirectoryLoaderSink& sink, QObject* parent = nullptr);
    ~DirectoryLoader() override;
 
    DirectoryLoader(const DirectoryLoader&) = delete;
    DirectoryLoader& operator=(const DirectoryLoader&) = delete;
 
    int loadFromDirectory(const QString& directory, LiveReload liveReload = LiveReload::Off);
 
    int loadFromDirectories(const QStringList& directories, LiveReload liveReload = LiveReload::Off,
                            RegistrationOrder order = RegistrationOrder::LowestPriorityFirst);
 
    void requestRescan();
 
    void rescanNow();
 
    int registeredCount() const;
 
    QList<Entry> entries() const;
 
    static constexpr qint64 kMaxFileBytes = kMaxJsonFileBytes;
 
    static constexpr int kMaxEntries = 10'000;
 
    void setDebounceIntervalForTest(int ms);
 
    void setMaxEntriesForTest(int cap);
 
    QString watchedAncestorForTest(const QString& target) const;
 
    bool hasParentWatchForTest(const QString& path) const;
 
Q_SIGNALS:
    void entriesChanged();
 
private:
    class JsonScanStrategy;
    std::unique_ptr<JsonScanStrategy> m_strategy;
    std::unique_ptr<WatchedDirectorySet> m_watcher;
};
 
} // namespace PhosphorFsLoader