WatchedDirectorySet.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorFsLoader/phosphorfsloader_export.h>
 
#include <QtCore/QHash>
#include <QtCore/QObject>
#include <QtCore/QSet>
#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QtCore/QTimer>
 
QT_BEGIN_NAMESPACE
class QFileSystemWatcher;
QT_END_NAMESPACE
 
namespace PhosphorFsLoader {
 
class IScanStrategy;
 
enum class LiveReload : quint8 {
    Off,
    On,
};
 
enum class RegistrationOrder : quint8 {
    LowestPriorityFirst,
    HighestPriorityFirst,
};
 
class PHOSPHORFSLOADER_EXPORT WatchedDirectorySet : public QObject
{
    Q_OBJECT
 
public:
    explicit WatchedDirectorySet(IScanStrategy& strategy, QObject* parent = nullptr);
    ~WatchedDirectorySet() override;
 
    WatchedDirectorySet(const WatchedDirectorySet&) = delete;
    WatchedDirectorySet& operator=(const WatchedDirectorySet&) = delete;
 
    int registerDirectory(const QString& directory, LiveReload liveReload = LiveReload::Off);
 
    int registerDirectories(const QStringList& directories, LiveReload liveReload = LiveReload::Off,
                            RegistrationOrder order = RegistrationOrder::LowestPriorityFirst);
 
    int setDirectories(const QStringList& directories, LiveReload liveReload = LiveReload::Off,
                       RegistrationOrder order = RegistrationOrder::LowestPriorityFirst);
 
    void requestRescan();
 
    void rescanNow();
 
    QStringList directories() const;
 
    static QStringList filterNewSearchPaths(const QStringList& candidates, const QStringList& alreadyRegistered);
 
    void setDebounceIntervalForTest(int ms);
 
    QString watchedAncestorForTest(const QString& target) const;
 
    bool hasParentWatchForTest(const QString& path) const;
 
Q_SIGNALS:
    void rescanCompleted();
 
private Q_SLOTS:
    void rescanAll();
 
private:
    void installWatcherIfNeeded();
    void attachWatcherForDir(const QString& directory);
    void releaseAncestorWatchFor(const QString& targetKey);
    void onWatchedPathChanged();
    void syncFileWatches(const QStringList& desiredPaths);
 
    IScanStrategy* m_strategy = nullptr;
    QStringList m_directories; 
    QFileSystemWatcher* m_watcher = nullptr;
    QSet<QString> m_watchedParents; 
    QHash<QString, QString> m_parentWatchFor;
    QSet<QString> m_watchedFiles;
    QTimer m_debounceTimer;
    int m_rescanDepth = 0;
    bool m_rescanRequestedWhileRunning = false;
};
 
} // namespace PhosphorFsLoader