MetadataPackRegistryBase.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 fuddlesworth
// SPDX-License-Identifier: LGPL-2.1-or-later
 
#pragma once
 
#include <PhosphorFsLoader/WatchedDirectorySet.h>
#include <PhosphorFsLoader/phosphorfsloader_export.h>
 
#include <QtCore/QObject>
#include <QtCore/QString>
#include <QtCore/QStringList>
 
#include <memory>
 
QT_BEGIN_NAMESPACE
class QLoggingCategory;
QT_END_NAMESPACE
 
namespace PhosphorFsLoader {
 
class IScanStrategy;
 
class PHOSPHORFSLOADER_EXPORT MetadataPackRegistryBase : public QObject
{
    Q_OBJECT
    Q_DISABLE_COPY_MOVE(MetadataPackRegistryBase)
 
public:
    ~MetadataPackRegistryBase() override;
 
    void addSearchPath(const QString& path, LiveReload liveReload = LiveReload::On);
 
    void addSearchPaths(const QStringList& paths, LiveReload liveReload = LiveReload::On,
                        RegistrationOrder order = RegistrationOrder::LowestPriorityFirst);
 
    QStringList searchPaths() const;
 
    void setUserPath(const QString& path);
 
    Q_INVOKABLE void refresh();
 
protected:
    MetadataPackRegistryBase(const QLoggingCategory& logCat, std::unique_ptr<IScanStrategy> strategy,
                             QObject* parent = nullptr);
 
    virtual void onUserPathChanged(const QString& path) = 0;
 
    IScanStrategy* strategy() const
    {
        return m_strategy.get();
    }
 
    WatchedDirectorySet* watcher() const
    {
        return m_watcher.get();
    }
 
private:
    // Declaration order is load-bearing for destruction safety: members
    // are torn down in reverse declaration order, so `m_watcher` (which
    // holds a borrowed reference into `*m_strategy`) MUST be declared
    // AFTER `m_strategy`. Without this ordering, the strategy reference
    // inside the watcher would dangle during base teardown.
    std::unique_ptr<IScanStrategy> m_strategy;
    std::unique_ptr<WatchedDirectorySet> m_watcher;
    QString m_userPath;
    const QLoggingCategory* m_logCat;
};
 
} // namespace PhosphorFsLoader