5#include <PhosphorRegistry/phosphorregistry_export.h>
14#include <QtCore/qtclasshelpermacros.h>
177 [[nodiscard]] QList<PluginMetadata>
plugins()
const;
178 [[nodiscard]] std::optional<PluginMetadata>
plugin(
const QString&
id)
const;
180 [[nodiscard]] QList<RefusedPlugin>
refused()
const;
189 QObject*
load(
const QString&
id, QString* errorString =
nullptr);
190 [[nodiscard]]
bool isLoaded(
const QString&
id)
const;
219 qint64 modifiedNs = 0;
220 bool operator==(
const FileIdentity&)
const =
default;
223 QStringList performScan(
const QStringList& directoriesLowestPriorityFirst);
224 void forwardScanCompleted();
225 [[nodiscard]] Vetted vet(
const QString& filePath,
PluginOrigin origin)
const;
226 [[nodiscard]]
static FileIdentity identityOf(
const QString& filePath);
227 [[nodiscard]]
bool shouldWarn(
const QString& key);
228 [[nodiscard]]
PluginOrigin originOf(
const QString& directory)
const;
231 bool m_seamValid =
false;
232 QList<PluginSearchPath> m_searchPaths;
233 bool m_liveReload =
true;
234 bool m_registered =
false;
238 int m_maxFilesPerScan = 0;
239 std::unique_ptr<ScanStrategy> m_strategy;
240 std::unique_ptr<PhosphorFsLoader::WatchedDirectorySet> m_watcher;
241 QHash<QString, PluginMetadata> m_plugins;
242 QList<RefusedPlugin> m_refused;
243 QHash<QString, std::shared_ptr<Loaded>> m_loaded;
246 QHash<QString, FileIdentity> m_offered;
249 QSet<QString> m_warned;
Watcher + debounce + rescan scaffolding for filesystem-backed loaders.
Definition WatchedDirectorySet.h:131
void setSearchPaths(const QList< PluginSearchPath > &paths)
Replace the directories to search, highest priority first.
QList< RefusedPlugin > refused() const
The plugin files refused by the last scan, sorted by path.
QList< PluginMetadata > plugins() const
Every plugin on offer, sorted by id.
QList< PluginSearchPath > searchPaths() const
static QList< PluginSearchPath > defaultSearchPaths(const QString &seamName)
The directories searched for seamName when no search paths are set, highest priority first.
PluginCatalog(PluginSeam seam, QObject *parent=nullptr)
static constexpr const char * DevelopmentPathVariable
The environment variable holding development plugin roots, colon-separated.
Definition PluginCatalog.h:145
bool isLoaded(const QString &id) const
std::optional< PluginMetadata > plugin(const QString &id) const
void setMaxFilesPerScanForTest(int cap)
Test seam: cap the number of plugin files considered per scan.
const PluginSeam & seam() const
void pluginAdded(const QString &id)
A plugin id came on offer, or the file of a plugin on offer that is not loaded changed (see the class...
void pluginRemoved(const QString &id)
A plugin id left the offer: its file is gone or now refused.
QObject * load(const QString &id, QString *errorString=nullptr)
Load the plugin id, which must be on offer, and return its root object, or nullptr with the reason in...
~PluginCatalog() override
void setLiveReload(bool enabled)
Watch the search paths and rescan when they change (on by default).
void scanCompleted()
After every scan, whether or not anything changed.
void scan()
Scan the search paths and read every plugin's metadata.
Definition ContainedFileReader.h:15
Definition IBarWidgetFactory.h:16
PluginOrigin
Where a plugin was found. Earlier origins override later ones.
Definition PluginCatalog.h:49
@ Development
A development root: a directory from PHOSPHOR_WORKS_PLUGIN_PATH, or one a host passes to setSearchPat...
Definition PluginCatalog.h:53
@ User
$XDG_DATA_HOME/phosphor-works/plugins/<seam>.
Definition PluginCatalog.h:55
@ System
A Qt plugin directory plus /phosphor-works/<seam>, where packages install.
Definition PluginCatalog.h:58
One kind of plugin the suite loads, such as bar widgets.
Definition PluginCatalog.h:37
int apiVersion
The ApiVersion this build loads.
Definition PluginCatalog.h:45
QString name
Directory name under each plugin root, for example bar-widget.
Definition PluginCatalog.h:39
QString iid
The IID every plugin of this seam declares, for example org.phosphor_works.Lambent....
Definition PluginCatalog.h:42
A directory to search and the origin its plugins get.
Definition PluginCatalog.h:63
PluginOrigin origin
Definition PluginCatalog.h:65
QString directory
Definition PluginCatalog.h:64
A plugin file the catalog found and will not offer, with the reason.
Definition PluginCatalog.h:81
QString id
The id from its metadata, or empty when the refusal came first.
Definition PluginCatalog.h:84
QString reason
Definition PluginCatalog.h:85
QString filePath
Definition PluginCatalog.h:82